Pileus Git - ~andy/fetchmail/blob - 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 ### fetchspool:
  70
  71 If you find that the speed of forwarding to port 25 is limited by the
  72 SMTP listener's speed, it may make sense to locally spool all the mail
  73 first and feed it to sendmail after you hang up the network link.
  74 This shellscript aims to do exactly that.  It would be smarter to
  75 figure out why sendmail is slow, however.
  76
  77 ### fetchsetup:
  78
  79 This is a shell script for creating a $HOME/.fetchmailrc file, it will ask
  80 you some questions and based on your answers it will create a .fetchmailrc
  81 file. fetchsetup is linux specific so it may not work on another operating
  82 system.
  83
  84 ### mailqueue.pl:
  85
  86 This script will connect to your ISP (if not already connected),
  87 send any outgoing mail and retrieve any incoming mail.  If this
  88 program made the connection, it will also break the connection
  89 when it is done.  By Bill Adams, <bill@evil.inetarena.com>.  The
  90 latest version is carried at <http://evil.inetarena.com/>.
  91
  92 ### redhat_rc:
  93
  94 A fetchmail boot-time init file compatible with RedHat 5.1.  It leaves
  95 fetchmail in background to get messages when you connect to your ISP.
  96 The invoked fetchmail expects to find its configuration in
  97 /etc/fetchmailrc, and must include the proper "interface" directive.
  98
  99 ### debian_rc:
 100
 101 A fetchmail boot-time init file compatible with Debian.  It leaves
 102 fetchmail in background to get messages when you connect to your ISP.
 103 The invoked fetchmail expects to find its configuration in
 104 /root/.fetchmailrc, and must include the proper "interface" directive.
 105
 106 Matthias Andree adds: note that current Debian packages (as of January
 107 2007) ship with their own init files.
 108
 109 ### start_dynamic_ppp:
 110
 111 An admittedly scratchy ip-up script that Ryan Murray wrote to cope with
 112 dynamic PPP addressing.  Will need some customizing.
 113
 114         http://www.inetarena.com/~badams/linux/programs/mailqueue.pl
 115
 116 ### getfetchmail:
 117
 118 Here's a script that gets Eric's most recent fetchmail source rpm,
 119 downloads it and (if the rpm's not broken) rebuilds it.
 120
 121 With fairly simple changes it can be used to download the latest i386 rpm
 122 or tar.gz.
 123
 124 Those who are addicted to having the latest of everything could filter mail
 125 from fetchmail announce through it and get new versions as they're
 126 announced. However, if we all did that, Eric's ftp server might feel a
 127 little stressed.
 128
 129 The script as written works on bash 2.  By John Summerfield
 130 <summer@os2.ami.com.au>.
 131
 132 ### zsh-completion:
 133
 134 These commands set up command completion for fetchmail under zsh.
 135 Jay Kominek <jay.kominek@colorado.edu>.
 136
 137 ### getmail/gotmail:
 138
 139 These scripts are front ends for fetchmail in daemon mode that can gather
 140 log statistics and generate text or HTML reports.  See README.getmail for
 141 details.  Scripts by Thomas Nesges <ThomaNesges@TNT-Computer.de>.
 142
 143 ### fetchmaildistrib:
 144
 145 This script resolves the issue where the sysadmin polls for mail with fetchmail
 146 only at set intervals, but where a user wishes to see his email right
 147 away. The duplication in /etc/fetchmailrc and ~/.fetchmailrc files is
 148 automated with this script; whenever /etc/fetchmailrc is changed, this
 149 script is run to distribute the stuff into all user's ~/.fetchmailrc
 150 files.
 151
 152 ### multidrop:
 153
 154 Martijn Lievaart's sendmail hacks to make multidrop reliable.
 155
 156 ### domino:
 157
 158 Gustavo Chaves <gustavo@cpqd.com.br> wrote this script to deal with
 159 the boundary-mismatch bug in Domino (see FAQ item X5).  If you use
 160 this with --mda, the broken boundaries will be fixed and the result
 161 passed to procmail.
 162
 163 ### toprocmail:
 164
 165 John Lim Eng Hooi <jleh@mail.com> wrote this script, yet another
 166 mda plugin, to be used with fetchmail in foreground mode.  It displays
 167 some header lines to stdout in color, passing them (and the rest of the
 168 message content) to procmail.
 169
 170 ### preauth-harness:
 171
 172 Emmanuel Dreyfus's Perl test script for exercising IMAP PREAUTH
 173 connections.  You'll have to patch in your username and password.
 174
 175 ### sm-hybrid:
 176
 177 Peter 'Rattacresh' Backes sent this patch to improve the behavior of
 178 sendmail 8.11.0 with multidrop.
 179
 180 ### fetchmailnochda.pl
 181
 182 Watchdog script to check whether fetchmail is working in daemon mode.
 183
 184 ### mold-remover.py
 185
 186 A short python script to remove old read mail from a pop3 mailserver.
 187 Dovetails with fetchmail with keep option.  Run it as a cron job.
 188
 189 ### PopDel.py
 190
 191 PopDel stands for Pop Delete; this program deletes selected email from a
 192 pop mail server. (By Richard Harris, improved by Joshua Crawford.)
 193
 194 ### fetchmail.logrotate (added 2007-01-14, --ma)
 195
 196 A logrotate configuration file developped by Daniel Leidert for Debian,
 197 when he wanted to use /var/log/fetchmail instead of the usual syslog.
 198 It probably needs to be adjusted for use on other systems.
 199
 200 ### delete-later (added 2007-03-17, --ma)
 201
 202 A MySQL/Tcl/Expect-based client-side script to remove messages at a
 203 certain age.  See delete-later.README for details.
 204 (By Carsten Ralle, Yoo GmbH, Germany.)
 205
 206 ### gai (added 2013-02-03, --ma)
 207
 208 A trivial getaddrinfo() program to check the getaddrinfo() call from the
 209 system, as a research tool for the fetchmail developers.