aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/README.getmail
blob: 237889cd86d5ffda44646eaa36e5dbbc34464ac1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
-------------------------------------------------------------------------------

                         - GetMail - GotMail -

             1999 by Thomas Nesges <ThomaNesges@TNT-Computer.de>

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

-------------------------------------------------------------------------------
Installation:
-------------------------------------------------------------------------------
The Installation is as simple as it could be.  Just create the directory
/usr/local/gotmail and copy all files to it. Ready.

If you decide to choose an other directory to copy the files to, don't forget
to change the path in the scripts.

-------------------------------------------------------------------------------
Usage:
-------------------------------------------------------------------------------
GetMail starts with: getmail <option>

options:
 clear  - stops fetchmail and kills the logfile
 fetch  - starts fetchmail
 got    - starts gotmail
 goth   - starts gotmail html
 send   - sends all mail from the mailqueue
 status - tails the logfile
 start  - starts fetchmail and tails the logfile
 stop   - stops fetchmail
 -v     - prints GetMails version number

GotMail can be startet without any parameters. It then prints a statistic
on the console. The only parameters so far are:

 html   - prints the output to an html file specified in gotmail.conf
 -v     - prints GotMails version number

-------------------------------------------------------------------------------
Configuration
-------------------------------------------------------------------------------
GotMail is configured by a file named gotmail.conf either in the user's home
dir, in /etc or in /usr/local/gotmail. gotmail.conf itself is a shell script.
It just exports some variables to the environment. So it's syntax is like this:

 export <OPTION>=<VALUE>

Remember not to put spaces between <OPTION>=<VALUE> !!
You have the folllowing options:
 
  GOTM_ERR	yes|no		print error messages?
  GOTM_MSG	yes|no		print mail stats?
  GOTM_TIM	yes|no		print start/stop stats?
  GOTM_HED	yes|no		print a header?

 Special HTML options:
  GOTM_BGCOL	hex color	backgroundcolor
  GOTM_TXCOL	hex color	textcolor
  GOTM_ERRCOL	hex color	color of error messages
  GOTM_TIMCOL	hex color	color of start/stop stats
  GOTM_MSGCOL	hex color	color of mail stats
  GOTM_HTMLFILE	filename	filename for html output
-------------------------------------------------------------------------------
~esr/sitemap.html">Site Map</a> <td width="30%" align=right>Mon Jan 12 15:52:14 EST 2004 </tr></table> <hr /> <h1>Fetchmail's Test List</h1> <p>Here are the server types on my regression-test list:</p> <table border=1 width=80% align=center summary="Server list"> <tr> <td><strong>Protocol &amp; Version:</strong></td> <td><strong>Special Options:</strong></td> </tr> <tr><td>IMAP: CommuniGate IMAP server</td><td>IMAPrev1 STARTTLS AUTH=CRAM-MD5 AUTH=DIGEST-MD5</td> <tr><td>POP3: CommuniGate POP3 server</td><td>CAPA LAST APOP CRAM-MD5</td> <tr><td>POP3: IntraStore POP3 mail server</td><td>!CAPA LAST</td> <tr><td>APOP: IntraStore POP3 mail server</td><td>!CAPA LAST APOP</td> <tr><td>IMAP: IntraStore IMAP mail server</td><td>IMAPrev1 IDLE AUTH=CRAM-MD5 AUTH=SKEY AUTH=ANONYMOUS</td> <tr><td>POP3: Eudora EIMS</td><td>CAPA LAST APOP SASL CRAM-MD5 NTLM</td> <tr><td>POP3: gmx.de pop server</td><td>!CAPA UIDL</td> <tr><td>IMAP: IMail IMAP server</td><td>IMAP4rev1 AUTH=CRAM-MD5</td> <tr><td>IMAP: Microsoft Exchange</td><td>IDLE AUTH=NTLM</td> <tr><td>POP3: qpopper 3.1.2 (Eudora) patched with mysql</td><td>CAPA UIDL</td> <tr><td>IMAP: Courier IMAP</td><td>IMAP4rev1</td> <tr><td>POP3: Courier POP3</td><td>CAPA UIDL</td> <tr><td>APOP: Qpopper using APOP</td><td>!CAPA</td> <tr><td>IMAP: UW IMAP</td><td>IMAPrev1</td> <tr><td>IMAP: Courier IMAP</td><td>IMAP4rev1</td> <tr><td>POP3: Qpopper 4.0.5</td><td>CAPA UIDL</td> </tr></table> <p>If you control a post-office server that is not one of the types listed here, please consider lending me a test account. Note that I do <em>not</em> need shell access, just the permissions to send mail to a mailbox the server looks at and to fetch mail off of it.</p> <p>I'd like to have weird things like a POP2 server on here. Also more closed-source servers because they tend to be broken in odd ways. These are the real robustness tests.</p> <hr /> <table width="100%" cellpadding=0 summary="Canned page header"><tr> <td width="30%">Back to <a href="/~esr">Eric's Home Page</a> <td width="30%" align=center>Up to <a href="/~esr/sitemap.html">Site Map</a> <td width="30%" align=right>Mon Jan 12 15:52:14 EST 2004 </tr></table> <br clear="left" /> <ADDRESS>Eric S. Raymond <A HREF="mailto:esr@thyrsus.com">&lt;esr@thyrsus.com&gt;</A></ADDRESS> </BODY> </HTML>