Added socket timeout so that stuck servers won't hang the applet (5 seconds)
[rox-postal.git] / Help / README
blob3800af099587493fb77f1125f40cd3ac312c871b
1 Postal
2 A mail check applet for the ROX panel.
3 by Ken Hayber
5 Brief
6 ~~~~~
7 Postal simply reports the unseen and total message counts for each requested
8 account in a tooltip.  It changes its icon when any unseen messages are found.
10 If dbus, notification-daemon and pynotify are installed, you get nice popup 
11 messages when new mail arrives.
13 Currently three account types are supported: IMAP4, POP3 and MBOX (local file)
14 The accounts are stored in an INI file (see Accounts.ini for an example).
17 See the TODO file for possible future additions.
20 Conditions
21 ~~~~~~~~~~
22 This program is free software; you can redistribute it and/or modify
23 it under the terms of the GNU General Public License as published by
24 the Free Software Foundation; either version 2 of the License, or
25 (at your option) any later version.
27 This program is distributed in the hope that it will be useful,
28 but WITHOUT ANY WARRANTY; without even the implied warranty of
29 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
30 GNU General Public License for more details.
32 You should have received a copy of the GNU General Public License
33 along with this program; if not, write to the Free Software
34 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
36 Please report any bugs to me, Ken Hayber <ken@hayber.us>
39 Requirements
40 ~~~~~~~~~~~~
41 ROX 2.1.0 or higher
42 ROX-Lib2 2.0.0 or higher
43 Pygtk 2.0.0 or better
44 Python 2.3 or better
47 Instructions
48 ~~~~~~~~~~~~
49 Drag the AppIcon to the Panel to run as an applet.
50 Left click to launch your preferred Mail client application.
51 Middle click + drag to position the applet.
52 Right click for the options menu.
54 Email the authors for help :)
55     Ken Hayber <ken@hayber.us>