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 ### start_dynamic_ppp:
 100
 101 An admittedly scratchy ip-up script that Ryan Murray wrote to cope with
 102 dynamic PPP addressing.  Will need some customizing.
 103
 104         http://www.inetarena.com/~badams/linux/programs/mailqueue.pl
 105
 106 ### getfetchmail:
 107
 108 Here's a script that gets Eric's most recent fetchmail source rpm,
 109 downloads it and (if the rpm's not broken) rebuilds it.
 110
 111 With fairly simple changes it can be used to download the latest i386 rpm
 112 or tar.gz.
 113
 114 Those who are addicted to having the latest of everything could filter mail
 115 from fetchmail announce through it and get new versions as they're
 116 announced. However, if we all did that, Eric's ftp server might feel a
 117 little stressed.
 118
 119 The script as written works on bash 2.  By John Summerfield
 120 <summer@os2.ami.com.au>.
 121
 122 ### zsh-completion:
 123
 124 These commands set up command completion for fetchmail under zsh.
 125 Jay Kominek <jay.kominek@colorado.edu>.
 126
 127 ### getmail/gotmail:
 128
 129 These scripts are front ends for fetchmail in daemon mode that can gather
 130 log statistics and generate text or HTML reports.  See README.getmail for
 131 details.  Scripts by Thomas Nesges <ThomaNesges@TNT-Computer.de>.
 132
 133 ### fetchmaildistrib:
 134
 135 This script resolves the issue where the sysadmin polls for mail with fetchmail
 136 only at set intervals, but where a user wishes to see his email right
 137 away. The duplication in /etc/fetchmailrc and ~/.fetchmailrc files is
 138 automated with this script; whenever /etc/fetchmailrc is changed, this
 139 script is run to distribute the stuff into all user's ~/.fetchmailrc
 140 files.
 141
 142 ### multidrop:
 143
 144 Martijn Lievaart's sendmail hacks to make multidrop reliable.
 145
 146 ### domino:
 147
 148 Gustavo Chaves <gustavo@cpqd.com.br> wrote this script to deal with
 149 the boundary-mismatch bug in Domino (see FAQ item X5).  If you use
 150 this with --mda, the broken boundaries will be fixed and the result
 151 passed to procmail.
 152
 153 ### toprocmail:
 154
 155 John Lim Eng Hooi <jleh@mail.com> wrote this script, yet another
 156 mda plugin, to be used with fetchmail in foreground mode.  It displays
 157 some header lines to stdout in color, passing them (and the rest of the
 158 message content) to procmail.
 159
 160 ### preauth-harness:
 161
 162 Emmanuel Dreyfus's Perl test script for exercising IMAP PREAUTH
 163 connections.  You'll have to patch in your username and password.
 164
 165 ### sm-hybrid:
 166
 167 Peter 'Rattacresh' Backes sent this patch to improve the behavior of
 168 sendmail 8.11.0 with multidrop.
 169
 170 ### fetchmailnochda.pl
 171
 172 Watchdog script to check whether fetchmail is working in daemon mode.
 173
 174 ### mold-remover.py
 175
 176 A short python script to remove old read mail from a pop3 mailserver.
 177 Dovetails with fetchmail with keep option.  Run it as a cron job.
 178
 179 ### PopDel.py
 180
 181 PopDel stands for Pop Delete; this program deletes selected email from a
 182 pop mail server. (By Richard Harris, improved by Joshua Crawford.)
 183
 184 ### fetchmail.logrotate (added 2007-01-14, --ma)
 185
 186 A logrotate configuration file developped by Daniel Leidert for Debian,
 187 when he wanted to use /var/log/fetchmail instead of the usual syslog.
 188 It probably needs to be adjusted for use on other systems.
 189
 190 ### rawlog.patch (added 2011-06-17, --ma)
 191
 192 A patch against fetchmail 6.3.20 to allow creating a raw socket log if
 193 configured through an environment variable, to assist debugging and
 194 troubleshooting.  Documentation at the beginning of the file.