Lost?

Pop3eye-0.6.2.tar.gz  Get the source here.

Pop3eye-0.6.1.tar.gz Older versions.
Pop3eye-0.6.tar.gz
Pop3eye-0.5.1.tar.gz
Pop3eye-0.5.tar.gz   
Pop3eye-0.4.tar.gz

(wmdrawer pop3eye and wmppthin) Dock Pop3eye
Docked 2 accounts.
Non dock Pop3eye
Non-dock with 5 accounts.
Decor Pop3eye
Non-dock with decorations.
Pop3eye with buttons
Non-dock with buttons.

Mighty Popeye
Account info in tooltip.           Email in tooltip.

What is Pop3eye?

Pop3eye is a pop3 email notifier, previewer and spam deleternew. It can be run as a dockapp or as a regular or undecorated window that pops up when checking email. Pop3eye can notify you of email from specific people, with certain subjects, or with information in any other header line by using regular expressions as filters. It can display up to 20 partial lines of the email body in a tooltip window. Any number of accounts can be monitored and each can have its own color and font scheme.

Pop3eye 0.6 has undergone heavy reworking of regular expression pattern matching. You can setup expressions to match on any header line and then show or hide the email, or delete emails from the server without downloading them. A log of deleted emails can be kept. You can set "test-delete" until satisfied with its operation.

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 clicking on one account retrieves only for that account. Right clicking during retrieval will abort.

If your pop3 server supports UIDL, already downloaded headers and body text will not be downloaded again unless some emails have been deleted. You can force it to download with "shift-right-click".

new .pop3eyerc keywords:

show
keep
hide
delete
nocase
invert
buttons
show-deleted
test-delete
delete-log
highlight
output-level
delete-color
hide-color
show-color
border-color
border-width
tooltip-bg-pattern
tooltip-shadow
tooltip-bg-color
tooltip-fg1-color
tooltip-fg2-color
New in 0.6.1: border-color, border-width, tooltip-bg-pattern now holds an xpm filename and 2 minor bug fixes.
New in 0.6.2: Minor bug fix. It would falsely show there were deleted emails when there were none.

Installing

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: libXpm libX11 libpthread.

For apop libgcrypt, for line editing in popdelete libreadline libncurses.

To compile with apop capabilities, edit the Makefile to include -DHAVE_GCRYPT. You must have libgcrypt and libgcrypt-devel installed. If your linux box has polling (poll function defined in include/sys/poll.h) compile with -DHAVE_POLLING.

Filtering

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:

show From:.*(Bob|John|TLeary)

To reject, use hide:

hide Subject:.*(OCLUG|viagra|prescription|mortgage)

This will not show emails whose subject line contain OCLUG, viagra, prescription, mortgage.

"nocase" may be used for case insensitive matching:

nocase yes
show CC:.*(sawfish)

This allows matches for CC: sawfish, Cc: sawfish, CC: Sawfish etc.

To delete emails with objectionable subject lines:

delete Subject:.*(medication|prescr|pharma|viagra|valium|xanax|vicodin)

This will delete (from the server) emails with the above words in the subject line, unless they have been marked as "show" or "hide".

You can see which emails were deleted by setting "show-deleted yes" in the config file or by clicking on the "D" button to toggle this switch. They will be displayed in red in the main window and with a red X in the tooltip.

A useful (but possibly risky) technique is to select to show emails from people or with subjects you want to receive, and delete all others:

show From:.*(JKerry|JEdwards|BClinton)
show Subject:.*(Election|campaign|2004)
delete From:.*

As said above, this can be risky. A better way is to use the included "popdelete" program which gives you the opportunity to review and revise your deletions. See below.

Matching can be inverted:

invert yes
show From:.*(Bush|Cheney|Rove)
show Subject:.*(iraq|afghanistan)
invert no

This is similar to using "hide". The difference is that inverted "show" emails become unmarked and can be deleted, but emails marked "hide" cannot.

You can use multiple lines of patterns:

show From:.*(rumpole|damny|Jensen|Teresa|china|efn|linux)
show From:.*(c21super|ziprealty|patk|jimmacre)
show CC:.*(sawfish)
delete Subject:.*(medication|prescr|viagra|valium|xanax|ambien|vicodin)
delete Subject:.*(fetish|penis|gamble|mortgage|diet|weightloss)
delete Subject:.*(ISO-8859|Application|approved)

If your email client marks mail as read by setting "Status: R" in the header, you can have these not shown with this:

hide ^Status:.*R

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: rnader@att.com" and these patterns:

invert yes
show From:.*(att.com)   <-- Matching stops here.
invert no
show From:.*(rnader)

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 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 www.silverstones.com/thebat/Regex.html.

Tooltips

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, and emails. The default colors for the from and subject lines are green if marked "show", blue if "hidden", red if "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 colors can be changed with the keywords:

delete-color red
hide-color    blue
show-color   green

The default tooltip colors can be changed with these keywords:

tooltip-bg-color  cornsilk1
tooltip-fg1-color black
tooltip-fg2-color brown

The tooltip can have a background pattern. There is one pattern compiled in (tooltip.xpm). You can modify it and re-compile, if you like.

tooltip-bg-pattern yes

The tooltip can have a shadow.

tooltip-shadow yes

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 this out. This default will eliminate most of it:

invert true
body (^\W?\W?$|^--|<.*>|MIME|Content-|charset)

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.

Mouse Controls

left button run email client
middle button clear messages in the account under mouse
right button check account under mouse now, or, abort checking if currently retrieving
alt-left re-read configuration file
alt-right quick reply (see below)
shift-right force download of all emails
scroll back/forward previous/next email
control-scroll back/forward decrease/increase tooltip font sizenew
shift-scroll back/forward decrease/increase display interval

Buttons

Five buttons appear when the mouse is over the upper-right portion of an account.
H toggle get headers - get total only or download headers
D toggle show-deletednew
P toggle "use patterns" for displaying emails
< > previous/next email
control-< control-> decrease/increase tooltip font sizenew
shift-< shift-> decrease/increase display interval

Signaling

You can abort retrieval by sending SIGALRM. Sending SIGUSR1 will raise/lower the window. Sending SIGUSR2 will re-read the configuration file.

Quick Reply

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 "sam@hell.com" with a subject of "hey there", "sam@hell.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 mail transmission.

reply xterm -geometry 70x20+360+230 -e mysmtp "%s" "whoknows@frys.com" "%s"

See the script "mysmtp" for more information.

Smtpclient can be found here.

Also

The program popdelete is included. With it you may delete mail on your pop account before retrieval based on regular expressions. Usage:

popdelete [ -C config file -s server-name -u username -p password --confirm=yes/no --highlight ansi ]

Popdelete can read the same config file as pop3eye, but you probably will want to use a separate one with different regular expressions. In this file, "keep" is a synonym for and is clearer than "show".

Popdelete will list emails it will not delete, followed by highlighted emails it will delete and (if "confirm yes") let you review them. At this point, you may delete them or select individual emails to keep. If "confirm no", then deletion will be automatic (although you will be warned and you can abort with Control-C).

This ANSI string will highlight emails to be deleted in red.
Note that you do not need to include the leading ^[.

highlight [1;31m

Sometimes there will be emails marked for deletion that you want to keep or there may be ones you wish to delete. For this, there is 'K'eep and 'D'elete. When asked to confirm, press 'K' or 'D' and Enter or Space. Then enter the email numbers or range of numbers (like 3-7) and press enter. A new list of emails to delete will be displayed.

Type popdelete -h for more info.

Included also is popretrieve which can be used to retrieve selected emails and send output to stdout.

Options

-C  path/file
Configure filename. Default ~/.pop3eyerc.
-D  display ie :0.0
The target display. Will use $DISPLAY if not provided.
-h --help
Help screen.

Configuration File .pop3eyerc

# pop3eye configuration file ~/.pop3eyerc

# General settings

accounts-shown   number
Number of accounts displayed
display-interval   milliseconds
Delay between displaying each email. 2000 = 2 seconds.
check-interval   minutes
Time between checking all accounts
withdrawn   [1/0 yes/no true/false]
Put into the dock or slit?
buttons   [1/0 yes/no true/false]new
Allow <>PDH buttons?
no-win-decor   [1/0 yes/no true/false]
Window decorations?
border-color   color namenew
Color of border when no-win-decor is true.
border-width   numbernew
Width of border when no-win-decor is true.
popup   [1/0 yes/no true/false]
Popup when checking?
body   (^\W?\W?$|MIME|Content-|^--|<.*>|charset)
Pattern for the tooltip body text. Inverted, this is the default regular expression.
tooltips   [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
tooltip-shadow   [1/0 yes/no true/false]
Use a tooltip shadow?
font   font-description
Main font. Default -*-fixed-*-r-*-*-12
tooltip-font   font-description
Tooltip font. Default -*-fixed-*-r-*-*-14
This font can be decreased in size with the
scrollwheel or the popup buttons < and >.

# Account specific items

account   Account Name
Name to be displayed in window.
show   From:.*(damny|jones|Teresa)new
Filter out all but these people
keep   From:.*(damny|jones|Teresa)new
Synonym for "show". Use in popdelete.
hide   Subject:.*(openbox)new
Don't display emails with subject line containing "openbox".
delete   (mortgage|viagra)new
Delete 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
mail-client   mozilla -mail
Your email client
reply   command-used-to-reply
Example:
reply xterm -geometry 70x20+360+230 -e mysmtp "%s" "your-isp.com" "%s"
use-patterns   [1/0 yes/no true/false]
Use patterns when displaying emails?
show-deleted   [1/0 yes/no true/false]new
Show deleted emails?
test-delete   [1/0 yes/no true/false]new
If yes, DO NOT delete matching emails?
delete-log   Log filenamenew
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   rednew
Color of deleted emails (if show-deleted true).
hide-color   bluenew
Color of hidden emails (if ignoring patterns).
show-color   greennew
Color of emails marked "show".
tooltip-bg-pattern   xpm filename.new
Tooltip background pattern filename.
tooltip-bg-color   cornsilk1new
Color of tooltip background.
tooltip-fg1-color   blacknew
Color of tooltip pen 1.
tooltip-fg2-color   brownnew
Color of tooltip pen 2.
nocase   [1/0 yes/no true/false]new
Do case insensitive pattern matching?
invert   [1/0 yes/no true/false]new
Invert pattern matching?
skip-check   [1/0 yes/no true/false]
Skip automatic checking of this account?
total-only   [1/0 yes/no true/false]
Display total message count - do not download headers?

To Do

Add Imap support. (I do not have access to an Imap server)

Add email deletion on server. Done!

Comments?

Your name (Optional)

Your email address (Optional)

Write to me below: (Manditory ;-) )


Valid HTML 4.01! Valid CSS! Created with emacs freshmeat.net Get Firefox Linux inside