]> Pileus Git - ~andy/fetchmail/blob - contrib/README
Merge branch 'legacy_63'
[~andy/fetchmail] / contrib / README
1 These are scripts or configuration snippets to help you running
2 fetchmail in special situations.
3
4 Note: you're on your own using these -- the fetchmail team undertakes no
5 efforts in understanding them, they are just passing them along.
6                                                                 --esr, ma
7
8 This file is currently unsorted. Use your pager's search function when
9 looking for the description of a particular file in this directory.  --ma
10
11 ### 0*.html:
12 Messages from the archives of the old fetchmail-friends mailing list,
13 for off-line reading.
14
15 ### maildaemon:
16 Larry Fahnoe wrote this for driving fetchmail from cron.  It may be useful if
17 you want to force a PPP link up and then poll for mail at specified times.
18 I have rearranged it slightly to make it easier to configure.
19
20 ### novell:
21
22 Some mail from Dan Newcombe describing how to write a procmail rule that
23 will domainify Novell server names.
24
25 ### login & logout:
26
27 These are intended to help if you typically have multiple logins active.
28 Here's the script composer's original README:
29
30         Please find attached 2 files, ~/.bash_login & ~/.bash_logout
31         What these do is try to keep track of WHO is the process/tty
32         that ran fetchmail in daemon mode.  I tried to use the bash
33         Variable PPID, but when using xterm the PPID is set to the
34         xterm's pid not the bash shell's pid so....
35
36         They have been lightly tested.
37
38         Any comments...
39
40                                 Hth, JimL <babydr@nwrain.net>
41
42 Doug Carter <dougc@canus.com> suggests this instead:
43
44 Add the following to your login script. (.ie .bash_profile, .profile, etc)
45
46 LOGINS=`who | grep $USER | wc -l`
47 if [ $LOGINS = 1 ]; then
48     /usr/bin/fetchmail > /dev/null 2>&1
49 fi
50
51 Then add the following to your logout script. (.ie .bash_logout, etc)
52
53 LOGINS=`who | grep $USER | wc -l`
54 if [ $LOGINS = 1 ]; then
55     /usr/bin/fetchmail -q > /dev/null 2>&1
56 fi
57
58 ### ip-up:
59
60 A note from James Stevens about using fetchmail in an ip-up script without
61 disabling timeouts.
62
63 ### runfetchmail:
64
65 A shellscript front end for fetchmail that mails you various statistics on
66 the downloaded mail and the state of your folders.  A good example of what
67 you can do with your own front end.
68
69 ### mailqueue.pl:
70
71 This script will connect to your ISP (if not already connected),
72 send any outgoing mail and retrieve any incoming mail.  If this
73 program made the connection, it will also break the connection
74 when it is done.  By Bill Adams, <bill@evil.inetarena.com>.  The
75 latest version is carried at <http://evil.inetarena.com/>.
76
77 ### getmail/gotmail:
78
79 These scripts are front ends for fetchmail in daemon mode that can gather
80 log statistics and generate text or HTML reports.  See README.getmail for
81 details.  Scripts by Thomas Nesges <ThomaNesges@TNT-Computer.de>.
82
83 ### mold-remover.py
84
85 A short python script to remove old read mail from a pop3 mailserver.
86 Dovetails with fetchmail with keep option.  Run it as a cron job.
87
88 ### PopDel.py
89
90 PopDel stands for Pop Delete; this program deletes selected email from a
91 pop mail server. (By Richard Harris, improved by Joshua Crawford.)
92
93 ### fetchmail.logrotate (added 2007-01-14, --ma)
94
95 A logrotate configuration file developped by Daniel Leidert for Debian,
96 when he wanted to use /var/log/fetchmail instead of the usual syslog.
97 It probably needs to be adjusted for use on other systems.
98
99 ### rawlog.patch (added 2011-06-17, --ma)
100
101 A patch against fetchmail 6.3.20 to allow creating a raw socket log if
102 configured through an environment variable, to assist debugging and
103 troubleshooting.  Documentation at the beginning of the file.
104
105 ### gai (added 2013-02-03, --ma)
106
107 A trivial getaddrinfo() program to check the getaddrinfo() call from the
108 system, as a research tool for the fetchmail developers.