README
1Gotmail
2=======
3
4For the most up to date information, please visit http://gotmail.sf.net/
5
6Original by Peter Hawkins <peter@hawkins.emu.id.au>
7First maintainer Paul Cannon <pik@debian.org>
8Second Maintainer: John Fruetel <jfruetel@hotmail.com>
9Current Maintainer: James Turnbull <james@lovedthanlost.net>
10
11
12Description
13===========
14
15This is Gotmail, a perl script to fetch mail out of your Hotmail
16or MSN account. This is especially useful if you want to move from
17Hotmail into one of the other free mail services - one command can
18do it all. Gotmail also supports getting any new mail only from your
19Hotmail or MSN account - perfect for using a Hotmail account as a
20redirect address into another account.
21
22
23Requirements
24============
25
26* UNIX/LINUX
27 * Perl 5
28 * curl 7.9.8 or better
29 * curl-ssl 7.9 or later (ssl is _required_ to use hotmail... )
30 It's debian package "curl-ssl" for those who are running
31 debian. You can get it from http://curl.haxx.se/ if you aren't.
32 * The URI cpan module (liburi-perl debian package, or
33 http://search.cpan.org/search?dist=URI)
34 * The libnet cpan module (libnet-perl debian package, or
35 http://search.cpan.org/search?dist=libnet)
36* Windows (WIN32)
37 * Download and Install ActiveState Perl (www.activestate.com)
38 * Downlod and Install the latest curl package for WIN32 from
39 http://curl.haxx.se/
40 * Download and Install the latests OpenSSL for WIN32
41 from http://curl.haxx.se/, or an installer from
42 http://www.shininglightpro.com/products/Win32OpenSSL.html
43 * If either or both of the previous packages are simply binaries and
44 not installers, then copy the .exe and .dll files from the
45 uncompressed packages to C:\WINDOWS\system32
46 * Open a commandline and navigate to where the gotmail script is
47 located.
48 * Run the gotmail script like so:
49
50 perl gotmail
51
52 NOTE: Support for Windows is new so please file any bugs or requests
53 at http://gotmail.sf.net/
54
55 NOTE: The .tar.gz distribution of gotmail does not include the gotmail
56 program itself - it's generated from gotmail.in using the "sed" editor.
57 Since most Windows users won't have "sed", the .zip distribution of
58 gotmail includes the already-generated gotmail program.
59
60Usage
61=====
62
63If your perl interpreter is not in /usr/bin, you will need to edit the
64first line of the script to make it point to the correct place, or
65start the script using /path/to/perl gotmail.
66
67If you have your perl modules in an unusual place, you'll need to add
68the line:
69
70 use lib 'path/to/my/perl/modules';
71
72to the gotmail script, somewhere near the top.
73
74Read the included manpage (gotmail(1)) or try "gotmail --help" for
75usage instructions.
76
77A sample rc file is included called "sample.gotmailrc". Options from
78the command line will override those from the rc file.
79
80NOTE: Windows users, activestate perl has the required perl modules already
81installed, however if there are any errors, please report as a bug.
82
83
84Notes
85=====
86
87* Mail in the Trash Can will not be downloaded. This is to avoid
88 downloading two times any mail which is deleted by the script.
89* If the page structure of HotMail is changed, this script may stop
90 working. If that happens, file a bug so that I'm sure to know about it.
91
92
93Known Issues
94============
95
96* Currently, one must include their password inside the configuration file
97 in cleartext for usage with one's hotmail account. This is up to the user
98 to decide on how to use this feature. It is recommended to NOT place a
99 password in cleartext unless this folder is ONLY readable by the user.
100 Another solution is to use an encrypted filesystem. If anyone has a better
101 solution to this issue, please submit a patch.
102
103
104How to report a bug
105===================
106
107* Go to: http://sourceforge.net/projects/gotmail
108* Click the bugs menu
109* File the bug while either logged in or anonymous
110* Please explain in depth and provide attachments if possible
111* Include these things:
112 - A brief description of your problem.
113 - Run the script with --debug and send me the output ALONG WITH
114 the "/tmp/gotmail_log" file generated by the script.
115 - Your ~/.gotmailrc file, if you use one.
116
117
118Authors
119=======
120
121* Please see the man page to see all the people that have
122 contributed to Gotmail over the years.
123
124