From 24e144986f8aa4335a097545371621e6759b5c6e Mon Sep 17 00:00:00 2001 From: Josh Holtrop Date: Thu, 7 Jul 2011 16:08:28 -0400 Subject: [PATCH] add README --- README | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100755 README diff --git a/README b/README new file mode 100755 index 0000000..d0e6733 --- /dev/null +++ b/README @@ -0,0 +1,51 @@ +PyGTK IMAP Checker v1.0 +By Josh Holtrop + +This script creates an undecorated window containing a number which tracks +the unread message count obtained for a particular mailbox folder via IMAP. +Only IMAP SSL is used. + +Usage: pygtk-imap-chk.exe + +The config-file argument is required and should be the name of a configuration +file using python syntax. The file will be written to on application exit +to update parameters such as the window size and position. + +The configuration file must set a few required parameters. +The required parameters are: 'server', 'port', 'user', and 'password'. +Here is an example barebones configuration file to get started with: +server = 'mailserver.domain.local' +port = '993' +user = 'JohnDoe' +password = 'j0hnnyb0y' + +Available configuration parameters: + +'bgcolor': 3-tuple of floats specifying the background color in (r, g, b) + format. Each component can range from 0.0 to 1.0. +'bgcolor2': Same format as 'bgcolor'. Specifies the secondary background + color to be used when "flashing" the window. +'fgcolor': Same format as 'bgcolor'. Specifies the foreground color + for the unread message count text. +'flash_rate': An integer specifying the number of milliseconds to use as + the flash period. +'font_size': Float specifying the font point size (ex: 18) +'height': Integer specifying the height of the window. + This value will be updated by the program when it closes. +'mailbox': String giving the name of the mailbox directory to search for + the unread message count (if unspecified, uses "Inbox"). +'password': String containing the password to use to connect to the server +'port': String containing the port number of the IMAP SSL port on + the mail server. +'server': String containing the host name of the IMAP server +'updaterate': Integer specifying the number of milliseconds between checks + to the mail server for the unread message count. +'user': String containing the user name to connect to the mail server +'width': Integer specifying the width of the window. + This value will be updated by the program when it closes. +'x': Integer specifying the x coordinate of the top, left corner + of the window. + This value will be updated by the program when it closes. +'y': Integer specifying the y coordinate of the top, left corner + of the window. + This value will be updated by the program when it closes.