wmckgmail/README

   1 wmckgmail 1.1 : A dockapp to monitor the number of unread mails in a gmail inbox
   2 written by    : Sylvain Tremblay <stremblay@gmail.com>
   3 release date  : September 09, 2006
   4
   5 *******************
   6 *** DESCRIPTION ***
   7 *******************
   8
   9 wmckgmail is a very simple program used to monitor the number of unread mails
  10 in a gmail inbox. It uses the wget command to get the gmail atom feed and reads
  11 the number of new mails from this feed. It is a dockapp that is supported by X
  12 window managers such as Window Maker, AfterStep, BlackBox, Fluxbox and
  13 Enlightenment.
  14
  15 This dockapp is quite simple. It contains the gmail M icon and a small counter.
  16 When the program is unable to access gmail, the counter shows the "ERR" string
  17 and the M icon is greyed. When gmail is accessible and your configuration file
  18 contains a valid username/password combo, the counter indicate the number of
  19 new mails in the gmail inbox. If there is no unread mails in the gmail inbox,
  20 the M icon stays greyed. If there is unread mails in the gmail inbox, the M iconthen takes its real colors and the counter indicates the number of unread mails.
  21
  22 ***************
  23 *** OPTIONS ***
  24 ***************
  25
  26 This program has no command line options.
  27
  28 *********************
  29 *** CONFIGURATION ***
  30 *********************
  31
  32 This program needs a configuration file to work. This file must be found as:
  33
  34     $HOME/.wmckgmail/config
  35
  36 This configuration file contains "<key> <value>" parameters. There is some
  37 mandatory parameters that requires to be defined in this file in order to make
  38 the program work:
  39
  40     uname <gmail username>
  41            Set the username of the gmail mailbox to monitor
  42
  43     pass <gmail password>
  44            Set the password of the gmail mailbox to monitor
  45
  46 There is also optional parameters:
  47
  48     pollinterval <seconds between each new mail verification>
  49            Used to define the interval between each verification of new incoming mails. If you do
  50            not define this parameter, it will be set to a default value of 300 seconds (5 minutes).
  51
  52     browsercmd1 <command to launch when clicking on the 'big M'>
  53            Used to define the command to launch when clicking on the 'big M'.
  54            Example configuration line: 'browsercmd1 mozilla -remote "openURL(http://www.gmail.com)"'
  55
  56     browsercmd2 <command to launch when clicking on the 'big M' if 'browsercmd1' failed>
  57            Used to define the command to launch when clicking on the 'big M'  IF the execution
  58            of 'browsercmd1' failed.
  59            Example configuration line: 'browsercmd2 mozilla http://www.gmail.com &'
  60
  61 -- WARNINGS --
  62
  63 - It is very recommended to set the configuration file permissions to "600" or
  64 "400" as your mailbox password is clearly written in this file.
  65
  66 - When defining 'browsercmd1' or 'browsercmd2', verify if the command you launch returns immediately
  67 to the shell or not. If the command does NOT returns to the shell, you have to put an ampersand (&)
  68 to launch the command in background like in the 'browsercmd2' example configuration line.
  69
  70 **************
  71 *** THANKS ***
  72 **************
  73
  74 Thanks to the author of the wmgeneral code, it has been a really good starting
  75 base to develop this little application.
  76
  77 **************
  78 *** AUTHOR ***
  79 **************
  80
  81 wmckgmail has been written by Sylvain Tremblay <stremblay@gmail.com>
  82 All comments are welcome.