josh/pygtk-imap-chk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

add documentation for 'mouse' configuration item

Browse Source
This commit is contained in:
Josh Holtrop 2011-07-19 11:20:11 -04:00
parent 5c714a69c4
commit 0e27e17597
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README
View File

@ -38,6 +38,23 @@ Available configuration parameters:
This value will be updated by the program when it closes. This value will be updated by the program when it closes.
'mailbox': String giving the name of the mailbox directory to search for 'mailbox': String giving the name of the mailbox directory to search for
the unread message count (if unspecified, uses "Inbox"). the unread message count (if unspecified, uses "Inbox").
'mouse': A hash which configures the actions for the program to take
in response to a mouse click. The keys of this hash can be
'left', 'middle', or 'right'. The values of the hash can take
the following forms:
'exit' - the program will terminate
'reconnect' - the program will reconnect to the IMAP server
'cmd:COMMAND' - the command COMMAND will be executed
The cmd:COMMAND form can be used to execute arbitrary processes
in response to a mouse click. This can be used to raise a mail
client window, for example:
mouse = {
'middle': 'reconnect',
'right': 'exit',
'left': 'cmd:"C:\\Program Files\\Microsoft Office\\'
'Office12\\OUTLOOK.EXE" /recycle '
'/select "outlook:Sent Items"'
}
'password': String containing the password to use to connect to the server 'password': String containing the password to use to connect to the server
'port': String containing the port number of the IMAP SSL port on 'port': String containing the port number of the IMAP SSL port on
the mail server. the mail server.