Gotmail
=======

For the most up to date information, please visit http://gotmail.sf.net/

Original by Peter Hawkins <peter@hawkins.emu.id.au>
First maintainer Paul Cannon <pik@debian.org>
Second Maintainer: John Fruetel <jfruetel@hotmail.com>
Current Maintainer: James Turnbull <james@lovedthanlost.net>


Description
===========

This is Gotmail, a perl script to fetch mail out of your Hotmail
or MSN account. This is especially useful if you want to move from
Hotmail into one of the other free mail services - one command can
do it all. Gotmail also supports getting any new mail only from your
Hotmail or MSN account - perfect for using a Hotmail account as a
redirect address into another account.


Requirements
============

* UNIX/LINUX
	* Perl 5
	* curl 7.9.8 or better
	* curl-ssl 7.9 or later (ssl is _required_ to use hotmail... )
         It's debian package "curl-ssl" for those who are running
         debian. You can get it from http://curl.haxx.se/ if you aren't.
	* The URI cpan module (liburi-perl debian package, or
                       http://search.cpan.org/search?dist=URI)
	* The libnet cpan module (libnet-perl debian package, or
                          http://search.cpan.org/search?dist=libnet)
* Windows (WIN32)
	* Download and Install ActiveState Perl (www.activestate.com)
	* Downlod and Install the latest curl package for WIN32 from
	  http://curl.haxx.se/
	* Download and Install the latests OpenSSL for WIN32 
	  from http://curl.haxx.se/, or an installer from 
	  http://www.shininglightpro.com/products/Win32OpenSSL.html
	* If either or both of the previous packages are simply binaries and
	  not installers, then copy the .exe and .dll files from the 
	  uncompressed packages to C:\WINDOWS\system32
	* Open a commandline and navigate to where the gotmail script is 
	  located.
	* Run the gotmail script like so:

		perl gotmail

	NOTE: Support for Windows is new so please file any bugs or requests
	at http://gotmail.sf.net/

	NOTE: The .tar.gz distribution of gotmail does not include the gotmail
	program itself - it's generated from gotmail.in using the "sed" editor.
	Since most Windows users won't have "sed", the .zip distribution of
	gotmail includes the already-generated gotmail program.

Usage
=====

If your perl interpreter is not in /usr/bin, you will need to edit the
first line of the script to make it point to the correct place, or
start the script using /path/to/perl gotmail.

If you have your perl modules in an unusual place, you'll need to add
the line:

  use lib 'path/to/my/perl/modules';

to the gotmail script, somewhere near the top.

Read the included manpage (gotmail(1)) or try "gotmail --help" for
usage instructions.

A sample rc file is included called "sample.gotmailrc". Options from
the command line will override those from the rc file.

NOTE: Windows users, activestate perl has the required perl modules already
installed, however if there are any errors, please report as a bug.


Notes
=====

* Mail in the Trash Can will not be downloaded. This is to avoid
  downloading two times any mail which is deleted by the script.
* If the page structure of HotMail is changed, this script may stop
  working. If that happens, file a bug so that I'm sure to know about it.


Known Issues
============

* Currently, one must include their password inside the configuration file
  in cleartext for usage with one's hotmail account. This is up to the user
  to decide on how to use this feature. It is recommended to NOT place a 
  password in cleartext unless this folder is ONLY readable by the user. 
  Another solution is to use an encrypted filesystem. If anyone has a better
  solution to this issue, please submit a patch.


How to report a bug
===================

* Go to: http://sourceforge.net/projects/gotmail
* Click the bugs menu
* File the bug while either logged in or anonymous
* Please explain in depth and provide attachments if possible
* Include these things:
  - A brief description of your problem.
  - Run the script with --debug and send me the output ALONG WITH
    the "/tmp/gotmail_log" file generated by the script.
  - Your ~/.gotmailrc file, if you use one.


Authors
=======

* Please see the man page to see all the people that have 
  contributed to Gotmail over the years.

