-------------------------------------------------------------------------------

  Check Mail Docklet v0.1 for Object Dock v1.99a+
  by Fedro Ponce de Leon                              Thursday, Oct 31th, 2008 
  www.feterspace.com.mx
  
-------------------------------------------------------------------------------

Table of Contents
-----------------
      
    * Revision History
    * Description
    * Requirements 
    * Installation 
    * Cofiguration
    * Considerations
    * Uninstallation 
    * Terms of Use
    * Additional references & licences
    * Contact


Revision History
----------------
    +  First Release

Description
------------
This docklet lets monitor your email accounts periodically for messages in your
inbox. This Docklet was inspired on PopWatch application by PJNaughter 
(http://www.naughter.com/popwatch.html), which I initially tried to port it to 
the objectdock docklet environment, but I faced too many problems, so I finally 
decided to re-write it from scrath, but I adopted many ideas from it.

The docklet will monitor mutiple configured accounts, reporting the total number
of mails available at all accounts, it will let you cycle through the configured
accounts to display the number of mails available at each account. It supports 
accessing your mailbox though either POP3, IMAP4 and Gmail accounts (through HTTPS)
protocols.

The docklet supports SSL/TLS access by using OpenSSL (statically linked, so no 
additional downloads or setup is needed).

The docklet let you configue a default mail application to be launched when 
clicking on the docklet icon, you may also configure an application per each 
account, or let it use the default application. The application may be automatically 
launched when mails are detected to be available at your mailbox.

You may also configure a default audio file (windows wave format - .wav) to be 
played upon mails are available at your mailbox. You may also configure an audio
file on a per account basis.

There are multiple options to tune the docklet display. You may configure the 
background, animation, attention & context menu icons used by the docklet. You may
also enable/disable animation used while checking your mail accounts. You can also
configure the docklet font, color & rotation shown for the mail count.

The docklet contains portions of code from Littleboy's TodoList docklet (included 
here is the proper copyright notice).
    
The docklet icons are an original art-work by John Riddle (Ghostwalker) and Roman 
Schmerold (Schmrom). The icons sets were created and contributed by them for this 
project. Thank you both!

Warning: This program is still beta and it is buggy! Use it for testing purposes
only. 


Installation
------------
  1. Exract the ZIP file inside your Object Dock 'Docklets' folder 
  2. Right click the dock and select "Add" then "CheckMail Docklet"
  

Configuration
-------------
   
  On the Check Mail Docklet icon click with the right mouse button and select 
  the "Check Mail Docklet Setting..." item,  from there you might control the 
  display elements & behaviour of the docklet:
  
  + General Setting Window: Configure the general behaviour and settings of 
  													the docklet. It also provide access to the icon 
                            configuration and to the accounts settings
                            windows (via the Add/Edit/Delete buttons).
  + Icons Settings Window: You can set the icons used as background, new mail 
  												 icon (used as frame for the mail count), animation 
  												 icon (you can also disable the animation here) and, 
  												 the icons used for the accounts context menu.
  + Account Settings Window: Though this window you may add/edit your account
                             configuration data.
                             Settings here include:
                             + Unique Name: The name given to the account, shown
                                            at the docklet label.
                             + Account type: Support for POP3, IMAP & Gmail 
                                             accounts. This settings affects the
                                             behaviour of other elements of the
                                             account settings. When you select
                                             each account type some elments may
                                             get enabled/disabled (as different
                                             protocols require different 
                                             configuration settings, and some of
                                             them do not apply or their default 
                                             values are different).
														+ Server: fully qualified name or IP Address of your 
																			mail server.
														+ Port: network port used to access your mail server.
														        By default the port changes as you select the 
														        proper account type and/or SSL access.
														+ Use SSL: Uses OpenSSL to securely communicate to
														           your mail server.
														+ Username/Password: credentials used to authenticate
														                     with the mail server.
														+ Mailbox: When IMAP is selected will let you configure
														           the mailbox being queried (shows INBOX by
														           default).
														+ When Emails are received: Will manage the actions
														  fired by the docklet, they include:
														  - Program to run: full path & parameters sent to an
														    optionally configured application that may be run
														    when mails are available at your inbox. Check Use
														    default application to use the application configured
														    in the Gerenal Settings Window.
														  - Limit program to one instance: Will prevent the 
														    configured application from running multiple times
														    whenever the docklet is clicked (or context menu is 
														    selected). If the application is running but minimized, 
														    it should simply restore it's window.
														  - Run program automatically: will launch the program
														  	as soon as new mail is available in your inbox.
														  - Run program even when there are no mails: Will let
														    you run the configured application even when there
														    are no mails available at your inbox.
														  - Wave File to play: sound file in wav format that 
														    will be played when mail is available at your inbox.
														  - Do not Check this account for emails: will prevent 
														    the docklet from checking the configured account. 
														    Use this setting to temporarily disable an account.
														    
  For more information on the docklet configuration settings and options visit
  the docklet posts at http://www.aqua-soft.org/board/showthread.php?t=50110.
  
Considerations
--------------

  The docklet has no way to distinguish between available mails in your inbox and
  "unread" or "new" mail. Neither protocol actually reports this figures so please,
  do not contact asking me to fix the docklet or update it to support unread or new
  mails, under the current RFC for POP3 & IMAP it is simply not possible. 

Uninstallation
--------------
   Remove all instances of the Check Mail Docklet from all dock windows and 
   delete the CheckMail folder form the docklets folder.


Terms of Use
------------
This software may be used free of charge and may be freely re-distributed in its 
original form or in a modified form provided it is offered free of charge. It is 
offered as-is and the user accepts all responsibility for consequences arising fom 
it's use. I accept no liability for consequences arising from the use of this 
software.

Additional references & licences
--------------------------------
Check Mail Docklet contains portions of code from Littleboy's TodoList Docklet

Copyright (c) 2004-2008, Julien Templier
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, 
are permitted provided that the following conditions are met:
 1. Redistributions of source code must retain the above copyright notice, this 
    list of conditions and the following disclaimer. 
 2. Redistributions in binary form must reproduce the above copyright notice, 
    this list of conditions and the following disclaimer in the documentation 
    and/or other materials provided with the distribution. 
 3. The name of the author may not be used to endorse or promote products derived 
    from this software without specific prior written permission. 

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 
OF THE POSSIBILITY OF SUCH DAMAGE.

----------------------------------
This software is derived from the RSA Data Security, Inc. MD5 Message-Digest Algorithm. 
Incorporation of this statement is a condition of use; please see the RSA
Data Security Inc copyright notice below:-

Copyright (C) 1990-2, RSA Data Security, Inc. Created 1990. All
rights reserved.

RSA Data Security, Inc. makes no representations concerning either
the merchantability of this software or the suitability of this
software for any particular purpose. It is provided "as is"
without express or implied warranty of any kind.

These notices must be retained in any copies of any part of this
documentation and/or software.

Copyright (C) 1991-2, RSA Data Security, Inc. Created 1991. All
rights reserved.
License to copy and use this software is granted provided that it
is identified as the "RSA Data Security, Inc. MD5 Message-Digest
Algorithm" in all material mentioning or referencing this software
or this function.
License is also granted to make and use derivative works provided
that such works are identified as "derived from the RSA Data
Security, Inc. MD5 Message-Digest Algorithm" in all material
mentioning or referencing the derived work.
RSA Data Security, Inc. makes no representations concerning either
the merchantability of this software or the suitability of this
software for any particular purpose. It is provided "as is"
without express or implied warranty of any kind.

These notices must be retained in any copies of any part of this
documentation and/or software.

----------------------------------
This product includes software developed by the OpenSSL Project for use in the 
OpenSSL Toolkit (http://www.openssl.org/)

  LICENSE ISSUES
  ==============

  The OpenSSL toolkit stays under a dual license, i.e. both the conditions of
  the OpenSSL License and the original SSLeay license apply to the toolkit.
  See below for the actual license texts. Actually both licenses are BSD-style
  Open Source licenses. In case of any license issues related to OpenSSL
  please contact openssl-core@openssl.org.

  OpenSSL License
  ---------------

/* ====================================================================
 * Copyright (c) 1998-2008 The OpenSSL Project.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. All advertising materials mentioning features or use of this
 *    software must display the following acknowledgment:
 *    "This product includes software developed by the OpenSSL Project
 *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
 *
 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
 *    endorse or promote products derived from this software without
 *    prior written permission. For written permission, please contact
 *    openssl-core@openssl.org.
 *
 * 5. Products derived from this software may not be called "OpenSSL"
 *    nor may "OpenSSL" appear in their names without prior written
 *    permission of the OpenSSL Project.
 *
 * 6. Redistributions of any form whatsoever must retain the following
 *    acknowledgment:
 *    "This product includes software developed by the OpenSSL Project
 *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
 *
 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 * ====================================================================
 *
 * This product includes cryptographic software written by Eric Young
 * (eay@cryptsoft.com).  This product includes software written by Tim
 * Hudson (tjh@cryptsoft.com).
 *
 */

 Original SSLeay License
 -----------------------

/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
 * All rights reserved.
 *
 * This package is an SSL implementation written
 * by Eric Young (eay@cryptsoft.com).
 * The implementation was written so as to conform with Netscapes SSL.
 *
 * This library is free for commercial and non-commercial use as long as
 * the following conditions are aheared to.  The following conditions
 * apply to all code found in this distribution, be it the RC4, RSA,
 * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
 * included with this distribution is covered by the same copyright terms
 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
 *
 * Copyright remains Eric Young's, and as such any Copyright notices in
 * the code are not to be removed.
 * If this package is used in a product, Eric Young should be given attribution
 * as the author of the parts of the library used.
 * This can be in the form of a textual message at program startup or
 * in documentation (online or textual) provided with the package.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *    "This product includes cryptographic software written by
 *     Eric Young (eay@cryptsoft.com)"
 *    The word 'cryptographic' can be left out if the rouines from the library
 *    being used are not cryptographic related :-).
 * 4. If you include any Windows specific code (or a derivative thereof) from
 *    the apps directory (application code) you must include an acknowledgement:
 *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
 *
 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * The licence and distribution terms for any publically available version or
 * derivative of this code cannot be changed.  i.e. this code cannot simply be
 * copied and put under another distribution licence
 * [including the GNU Public Licence.]
 */

Contact
-------
Comments/Suggestions/Problems, Please email me at fedroponce@feterspace.com.mx

-------------------------------------------------------------------------------

  http://www.feterspace.com.mx/
  Copyright  2008 Fedro Ponce de Leon <fedroponce@feterspace.com.mx> 

-------------------------------------------------------------------------------