(wmdrawer pop3eye and wmppthin)
Docked 2 accounts.
Non-dock with custom image.
Non-dock regular window.
Showing popup buttons.
Note: Pop3eye does not display graphics when using compiz or beryl.
This page refers only to version 0.7.0. For earlier releases, Go here.
What is Pop3eye?
Pop3eye is a pop3 email notifier
plus previewer, retriever and spam deleter. It can be run in a dock, a regular
window or a window with a custom background. Pop3eye is multi-threaded, any number
of accounts can be checked simultaneously.
Tip: A scrollwheel vastly improves Pop3eye's usability by allowing you to quickly
scroll through messages.
- Notify you of email from specific people, with certain subjects, or with information in any other header
line by using regular expressions as filters.
- Display up to 20 partial lines of the email body in a tooltip window.
- Retrieve marked emails to a local file.
- Delete marked emails from the server.
- Monitor any number of accounts each with its own color scheme.
A portion of the "From:" and "Subject:" lines are displayed as they are retrieved. Afterward,
only those marked "show" will be seen. Mouse actions affect only the account under the mouse. Right
click on an account to retrieve headers, retrieve and save emails marked "retrieve" or delete those marked
"delete". Emails marked both "to-be-retrieved" and "to-be-deleted" will be first retrieved
and then deleted ONLY if successfully retrieved. Right click again to abort.
Note: Your pop3 server must support UIDL for actions on marked emails to function.
To get a quick look, just type:
./pop3eye -C sample.pop3eyerc
Note: A precompiled binary without apop support is included. Compiled under Fedora Core 2.
Extract the archive, cd into the pop3eye directory and type "make".
Then as root, "make install". Or, you may the copy the pop3eye executable to
any location in your path.
Required libraries: X11 ImLib png pthread. For apop support, libgcrypt and libgcrypt-devel.
To compile with apop capabilities, edit the Makefile to include -DHAVE_GCRYPT.
You must have gcrypt and gcrypt-devel installed. If your linux box has polling (poll function defined in
include/sys/poll.h) compile with -DHAVE_POLLING.
All settings are done in the ~/.pop3eye/rc file. Most have reasonable defaults. Edit the
supplied sample.pop3eyerc file with your own settings.
You must set these:
|account||any name you want
For more accounts, simply repeat.
To set the number of accounts displayed at one time:
Some items (like accounts-shown) must be set just once before the first account name. See below.
If an account specific item is set before the first account name, it will affect all accounts. But,
that can be over-ridden in each account.
One of Pop3eye's most useful features is the ability to filter emails using regular expressions.
Filter by subject, sender or any other header line, like X-Priority:, CC:,
Date: or Return-Path:.
Regular expression examples:
To show emails from certain people, you might use:
To conceal, use hide:
This will not show emails whose subject line contain OCLUG, viagra,
"nocase" may be used for case insensitive matching:
This allows matches for CC: sawfish, Cc: sawfish, CC: Sawfish etc.
To automatically mark "to-be-deleted" emails with objectionable subject lines:
This will mark "to-be-deleted" (from the server) emails with the above words in the subject line, unless they have been marked
as "show" or "hide".
You can also mark or unmark emails to delete by clicking on the "D" button.
You can show/hide emails marked "to-be-deleted" by setting "show-to-be-deleted yes/no" in the config file
They will be displayed with a red line drawn through the From line in the main window and in the
You may find it useful to select to show emails from people or with subjects
you want to receive, and mark "to-be-deleted" all others:
Again, emails will not be deleted until you right-click on the account.
Matching can be inverted:
This is similar to using "hide". The difference is that inverted "show" emails become
unmarked and can be marked "to-be-deleted", but emails marked "hide" cannot.
You can use multiple lines of patterns:
If your email client marks mail as read by setting "Status: R" in the header, you can have these
not shown with this:
Pattern matching works like this:
Each header line is compared to all your "show" patterns, then your "hide" patterns and then,
if it is not marked show or hide, your "delete" patterns. Comparisions for each show, hide or delete stop
on an inverted match.
This means that an email with "From: email@example.com" and these patterns:
show From:.*(att.com) <-- Matching stops here.
will not be shown.
Each header line is compared to your regular expressions. In the case where more than one expression matches a single
header line, comparing continues to the end or until there is an inverted match. No email that has matched as "show"
or "hide" will be marked "to-be-deleted".
Note: Filtering occurs even if "use-patterns no". This is only for displaying emails.
For more on regular expressions use "info regex" or try the Regex Tutorial at
The tooltip window is displayed when new mail arrives or when the mouse enters the main window. It will display
account information, next check time, error messages and emails. The default colors for the "From:" and
"Subject:" lines are green if marked "show", blue if "hidden", red if
"to-be-deleted", and brown if not marked.
Tooltip popup settings:
tooltips 0 No tooltips
tooltips 1 Allow tooltips on mouse entry
tooltips 2 Popup tooltip when new mail arrives
tooltips 4 Popup tooltip when receiving new mail
tooltips 7 All tooltip conditions
The default marking colors can be changed with the keywords:
The default tooltip colors can be changed with these keywords:
Note: Each account can have its own popup and color settings. One account can have a grey background
while another has cornsilk. One can have "tooltips 1" and another "tooltips 2".
The tooltip can have a background image.
Note: If there is no transparency in the image, it will be used as a pattern.
The tooltip can have a shadow. (Only useful if no background image is used.)
Up to 20 partial lines of the email can be displayed. Since many emails contain HTML code, a "body" regular
expression can be used to filter out some of this. This default will eliminate most of it:
invert false <-- So any following expressions are not inverted.
The font used in the tooltip is set with the tooltip-font keyword. You can decrease the font size down to 8px
(and thus increase the amount of email body displayed) with either control-scrollwheel or the control-< popup button.
More detailed connection errors are also displayed in the tooltip.
||run email client
||clear messages in the account under mouse
||check account under mouse now, or, abort checking if currently retrieving
||re-read configuration file
||quick reply (see below)
||force download of all emails
||decrease/increase tooltip font size
||decrease/increase display interval
Five buttons appear when the mouse is over the upper-right portion of an account.
||Toggle show headers - show headers only or headers and partial message body.
||Mark all "to-be-deleted"
||Unmark all "to-be-deleted"
||Mark all "to-be-retrieved"
||Unmark all "to-be-retrieved"
||Decrease/increase tooltip font size
||Decrease/increase display interval
Deleting and Retrieving Emails
Select the email you wish to delete or retrieve by clicking on the < or > buttons or using the
scrollwheel and click on the D or R button. Mark all emails you want and Right-Click to logon.
The marked emails will be deleted or retrieved, or both. Emails marked both "to-be-retrieved"
and "to-be-deleted" will be first retrieved and then deleted ONLY if successfully retrieved.
Pop3eye can monitor any number of accounts and can display all at once or cycle through them. For example, you
could have 6 accounts and display them one at a time. Or, display 2 accounts at a time showing accounts 1 and 2,
then 3 and 4, then 5 and 6, then repeat. Or, display 3 and show 1, 2, and 3, then 4, 5
and 6. The scrollwheel is very useful for cycling the multiple accounts.
Pop3eye automatically cycles through all accounts and messages at a speed set by "display-interval".
This stops when you start scrolling or clicking through messages and resumes when you leave the window. If the
buttons are displayed, it will not switch accounts.
Text in Display
Set the main window font with "font font-description". Set the font to use when the mouse is over
an account with "mouse-over-font font-description". Set the tooltip font with
The colors of the texts "messages", "info", "hide", "show",
"delete", and "retrieve" may also be set. See the Configuration File
If you are using a custom image, you may need to adjust the position of the text in both the main window and
in the tooltip. Use "xoffset x" and "yoffset y" for the main window and "tt-xoffset x"
and "tt-yoffset y" for the tooltip.
The x y values are relative to the top left corner of Pop3eye or the tooltip.
New Mail Image
An image can be displayed when new mail arrives. Each account can have its own image and location. Use
"new-mail-image filename" and "new-mail-xoffset x coord" and
"new-mail-yoffset y coord". The x y values are relative to the top left corner of Pop3eye.
Sending SIGUSR1 will raise/lower the window.
Sending SIGUSR2 will re-read the configuration file.
You can do a "quick reply" to the currently displayed email, but you
must supply the email client and a format string. Pop3eye will insert the
"To:" address and "Subject:" line where there is a "%s". For example, in replying to
"firstname.lastname@example.org" with a subject of "hey there", "email@example.com"
will be passed to the first "%s" and "hey there" to the second.
In the following, Xterm will execute mysmtp script and
pass those values to it. mysmtp will execute smtpclient which does the actual
reply xterm -geometry 70x20+360+230 -e mysmtp "%s" "firstname.lastname@example.org" "%s"
See the script "mysmtp" for more information.
Smtpclient can be found here.
- Almost all options are the same as the config file keywords. Some have short form alternatives.
- "server pop.mail.com" would be "--server pop.mail.com" on the command line.
- Command line options will override the config file.
- -C path/file
- Configure filename. Default ~/.pop3eye/rc.
- -D display ie :0.0
- The target display. Defaults to $DISPLAY.
- -h --help
- Help screen.
Configuration File ~/.pop3eye/rc
- Blank lines and lines beginning with # are ignored.
- Most items can be overridden on the command line.
- The first items are general and pertain to all accounts.
- Individual accounts follow the line: "account account-name".
- Regular expressions apply only to the account they are in.
- All other account specific items are global if they precede the first account.
- # pop3eye configuration file ~/.pop3eye/rc
Note: yes/no options may also be 1/0 or true/false.
- # General settings
- accounts-shown number
- Number of accounts displayed
- display-interval milliseconds
- Delay between displaying each email. 2000 = 2 seconds.
- withdrawn yes/no
- Put into the dock or slit?
- buttons yes/no
- Allow <>DRH buttons?
- no-win-decor yes/no
- Window decorations?
- border-color color name
- Color of border when no-win-decor is true.
- border-width number
- Width of border when no-win-decor is true.
- popup yes/no
- Popup main window when checking?
- body (^\W?\W?$|MIME|Content-|^--|<.*>|charset)
- Pattern for the tooltip body text. Inverted, this is the default regular expression.
- tooltip-bg background image filename.
- Tooltip background image filename.
- tooltip-shadow yes/no
- Use a tooltip shadow?
- font font-description
- Main font. Default -*-fixed-*-r-*-*-12
- mouse-over-font font-description
- Font to use when mouse is over an account. Default -*-fixed-bold-r-*-*-15.
- An oblique or italic version of your main font may be a good choice.
- tooltip-font font-description
- Tooltip font. Default -*-fixed-*-r-*-*-14
- This font size can be changed with control-scrollwheel or
- the popup buttons control-< and control->.
- # Account specific items. Each account must have a name.
- account Account Name
- Name to be displayed in window.
- show From:.*(damny|jones|Teresa)
- Filter out all but these people
- hide Subject:.*(openbox)
- Don't display emails with subject line containing "openbox".
- delete (mortgage|viagra)
- Mark "to-be-deleted" emails with mortgage or viagra in the subject line.
- # If any of these precede the first account, they affect all accounts.
- server mail.your-isp.com
- Your pop3 email server
- user your username
- Your username
- password your password
- Your password
- port port number
- Optional. 110 default
- mbox /var/spool/mail/brian
- Example of mbox account
- check-interval minutes
- Time between checking accounts
- mail-client mozilla -mail
- Your email client
- reply command-used-to-reply
- reply xterm -geometry 70x20+360+230 -e mysmtp "%s" "your-isp.com" "%s"
- tooltips any combination of the numbers 0 - 7
- 0 = No tooltips
- 1 = Allow tooltip on mouse entry
- 2 = Popup tooltip when new mail arrives
- 4 = Popup tooltip when receiving new mail
- 7 = All tooltip conditions
- use-patterns yes/no
- Use patterns when displaying emails?
- nocase yes/no
- Do case insensitive pattern matching? May be set for each pattern.
- invert yes/no
- Invert pattern matching? May be set for each pattern.
- show-to-be-deleted yes/no
- Show "to-be-deleted" emails?
- delete-log Log filename
- Record deleted emails here. Each account can have its
- own log. Use delete-log with no filename for no log.
- background sky blue
- Color of background.
- text-color blue4
- Color of from and subject lines.
- info-color blue4
- Color of informative text. eg "Checking account".
- delete-color red
- Color of line through "to-be-deleted" emails (if show-deleted true).
- retrieve-color green
- Color of line through "to-be-retrieved" emails.
- hide-color blue
- Color of hidden emails (if ignoring patterns).
- show-color green
- Color of emails marked "show".
- mouse-over-color green
- Color when mouse is over an account.
- tooltip-bg-color cornsilk1
- Color of tooltip background, if no image supplied.
- tooltip-fg1-color black
- Color of tooltip pen 1.
- tooltip-fg2-color brown
- Color of tooltip pen 2.
- new-mail-image image filename
- Image to display when new mail arrives.
- new-mail-xoffset number
- X offset relative to main window.
- new-mail-yoffset number
- Y offset relative to main window.
- tt-xoffset number
- X offset relative to tooltip top/left for text.
- tt-yoffset number
- Y offset relative to tooltip top/left for text.
- xoffset number
- X offset relative to main top/left for text.
- yoffset number
- Y offset relative to main top/left for text.
- total-only yes/no
- Display total message count - do not download headers?
Add Imap support. (I do not have access to an Imap server)