| blob | 3d55674b87e11159ed843250c0b7a7171bd1064d |
1 WMpop3LB2.4
2 =================================
4 Written by Louis-Benoit JOURDAIN (lb@jourdain.org)
6 This software is based on Wmpop3-0.5.6 by Scott Holden ( scotth@thezone.net )
8 WARNING!!! WMPop3LB is to be used at your own risk. I will not be held
9 responsible for any damages this application may cause to your system.
11 1) WHAT IS THIS
12 WMPop3LB is a multi POP3 mail box checker. It will connect to up to 6
13 POP3 servers to check if you have mail, get the "From:" and "Subject:"
14 header fields of each mail and display them in a 7 lines window.
15 If there are more than 7 mails, they can be read by scrolling the window
16 up and down.
17 Messages can be deleted directly off the servers by selecting the mails
18 to delete and clicking the "delete" button.
19 A command to spawn can be specified for each new received message, for
20 selected messages (by clicking on the "open" button) or to launch a
21 mailclient.
23 2) How do I configure WMPop3LB
24 WMPop3LB when first executed will check if there is a .wmpop3rc file in
25 the user's home directory, it will create it if it can not be located.
26 This file must be edited and the following fields must be changed :
28 -- before any [server] section:
29 1) autochecking: This allows to disable or enable auto mail checking.
30 1 enables, 0 disables
31 2) displaydelay: this will determine how long error messages show up
32 before the screen is cleaned up.
33 3) scrollspeed: this is a percentage of the original scrolling speed.
34 Higher than 100, the text will scroll faster, lower than 100, the
35 text will scroll more slowly.
36 4) tempdir: directory to put temporary mails retrieved when using %c, %C or
37 %m wildcards (default: /tmp).
38 5) viewallmessages: This allows for alternating mail views upon startup,
39 0 shows the From: and Subject: header fields of each mail, (message
40 view mode)
41 1 shows the total number of messages or the number of unread
42 messages, per domain, and the number of selected messages (summary view
43 mode).
45 -- for each [server] section (you can list up to 6 [server] sections):
47 1) popserver: this is the name of the pop3 server to contact.
48 2) port: this is the port the pop3 server is on ( default 110).
49 3) username: user's pop3 login name.
50 4) password: user's pop3 login password.
51 5) alias: 3 alphanum characters server alias name, to
52 differentiate servers in the display window.
53 6) mailcheckdelay: Number of minutes, before checking mail on this server.
54 (default = 10 minutes)
55 7) countunreadonly: in the counter view, 0 displays the total number of
56 messages on the server, 1 displays only the number of unread
57 messages.
58 8) mailclient: command to launch when clicking on the server alias name in
59 summary view mode.
60 The command, if it contains spaces or special characters
61 must be written between double quotes (`"').
62 See "template substitution" for more options.
63 9) newmailcommand: command to launch when a new mail has arrived on the
64 server.
65 See "template substitution" for more options.
66 10) selectedmesgcommand: command to launch on selected messages.
67 See "template substitution" for more options.
68 11) mailseparator: specify a separator to include between each mail when
69 using %c or %C template substitutions.
70 12) maxdlsize: in the case of the %c, %C and %m template substitutions, will
71 not download messages bigger than this value (-1: no limit).
74 3) Using WMPop3.
76 1) If you have no mail, WMPop3LB will show "No mesg" and will count down
77 the time before the next cheking.
78 If none of the configured server can be contacted, WMPop3LB will
79 show "ERROR" and will count down the time before the next checking.
81 2) If you have mails, WMPop3LB will display a line for each mail, and will
82 start scrolling the display, showing the server alias identifier, the
83 "From:" and "Subject:" header fields in the following format:
84 "alias:<from field>/<subject field> * "
86 * each time a new mail is received, wmpop3lb will try to launch the
87 newmailcommand if it is specified in the configuration file.
89 3) Depending on the option chosen for viewallmessages, it will display
90 either:
92 a) the alias, The From: and Subject: fields of each mail as
93 described above.
94 b) The total number of messages or the number of unread messages
95 (depending on the configuration parameter "countunreadonly") on
96 the POP3 server (if the server has been contacted successfully)
97 as well as the number of messages selected.
98 Switching between number of unread messages and total number of
99 messages can be done by clicking on the right side of each server
100 line (':' means total number, '-' means total number of unread).
101 If the server cannot be contacted, it will show one of the
102 following error message:
103 - alias: C*ER --> connection error
104 - alias: L*ER --> login error (wrong login or passwd)
105 - alias: M*ER --> can't get mails.
107 * The far most right button is used to toggle both views.
109 4) To delete one or more messages directly off one or more servers,
110 select the messages you want to delete and then click on the bottom
111 left "DEL" button.
113 You can check how many messages are selected by switching view
114 mode.
116 A status per server will show up during "displaydelay" seconds with the
117 following error codes:
118 - OK: messages were deleted successfully from the server
119 - NONE: no message was selected for this server
120 - D:nb: nb messages failed to be deleted.
121 - Err: an error has occured (connection or else).
123 WMPop3LB will not allow you to delete messages if the content of the
124 mailbox on the server has changed since last checking.
125 It will instead display an error message ("mailbox content has
126 changed between updates del can.") and reload the content of the
127 mailbox from the server.
129 5) If a message is selected in the message view mode, the "reload" button
130 will change to represent an "open" button.
131 Clicking on this button will launch the command specified in the
132 configuration file by the selectedmesgcommand parameter.
134 6) to select all the messages, go to the summary view mode and click on
135 "sel:" (left side of the last displayed line).
136 to unselect all the messages, click on the right side of that line.
138 7) To manually check for mail at any time, mouse click on the
139 2nd button from the left, with a round arrow, if no message is selected.
141 8) To turn off auto mail checking, mouse click on the "ch" button (second
142 from the right).
144 9) If you have more than 7 messages on all your servers you can scroll the
145 window up and down using the up and down arrows or by using the
146 scrollbar.
149 4) known problems / TODO
151 1) wmpop3lb was built on the existing source code of wmpop3, written by
152 Scott Holden (scotth@thezone.net).
153 I didn't touch a lot the network functions, which are still using
154 blocking sockets and connections.
155 Because of that, if there is any network problem while waiting for some
156 data, wmpop3lb will hang forever.
157 The only solution, for the moment, is to restart wmpop3lb.
159 Next version will use non-blocking sockets.