These are scripts or configuration snippets to help you running
fetchmail in special situations.

Note: you're on your own using these -- the fetchmail team undertakes no
efforts in understanding them, they are just passing them along.
								--esr, ma

This file is currently unsorted. Use your pager's search function when
looking for the description of a particular file in this directory.  --ma

### 0*.html:
Messages from the archives of the old fetchmail-friends mailing list,
for off-line reading.

### maildaemon:
Larry Fahnoe wrote this for driving fetchmail from cron.  It may be useful if
you want to force a PPP link up and then poll for mail at specified times.
I have rearranged it slightly to make it easier to configure.

### novell:

Some mail from Dan Newcombe describing how to write a procmail rule that
will domainify Novell server names.

### login & logout:

These are intended to help if you typically have multiple logins active.
Here's the script composer's original README:

	Please find attached 2 files, ~/.bash_login & ~/.bash_logout
	What these do is try to keep track of WHO is the process/tty
	that ran fetchmail in daemon mode.  I tried to use the bash
	Variable PPID, but when using xterm the PPID is set to the
	xterm's pid not the bash shell's pid so....

	They have been lightly tested.

	Any comments...

 				Hth, JimL <babydr@nwrain.net>

Doug Carter <dougc@canus.com> suggests this instead:

Add the following to your login script. (.ie .bash_profile, .profile, etc)

LOGINS=`who | grep $USER | wc -l`
if [ $LOGINS = 1 ]; then
    /usr/bin/fetchmail > /dev/null 2>&1
fi

Then add the following to your logout script. (.ie .bash_logout, etc)

LOGINS=`who | grep $USER | wc -l`
if [ $LOGINS = 1 ]; then
    /usr/bin/fetchmail -q > /dev/null 2>&1
fi

### ip-up:

A note from James Stevens about using fetchmail in an ip-up script without
disabling timeouts.

### runfetchmail:

A shellscript front end for fetchmail that mails you various statistics on
the downloaded mail and the state of your folders.  A good example of what
you can do with your own front end.

### fetchspool:

If you find that the speed of forwarding to port 25 is limited by the
SMTP listener's speed, it may make sense to locally spool all the mail
first and feed it to sendmail after you hang up the network link.
This shellscript aims to do exactly that.  It would be smarter to
figure out why sendmail is slow, however.

### fetchsetup:

This is a shell script for creating a $HOME/.fetchmailrc file, it will ask
you some questions and based on your answers it will create a .fetchmailrc
file. fetchsetup is linux specific so it may not work on another operating
system.

### mailqueue.pl:

This script will connect to your ISP (if not already connected),
send any outgoing mail and retrieve any incoming mail.  If this
program made the connection, it will also break the connection
when it is done.  By Bill Adams, <bill@evil.inetarena.com>.  The
latest version is carried at <http://evil.inetarena.com/>.

### redhat_rc:

A fetchmail boot-time init file compatible with RedHat 5.1.  It leaves
fetchmail in background to get messages when you connect to your ISP.
The invoked fetchmail expects to find its configuration in
/etc/fetchmailrc, and must include the proper "interface" directive.

### debian_rc:

A fetchmail boot-time init file compatible with Debian.  It leaves
fetchmail in background to get messages when you connect to your ISP.
The invoked fetchmail expects to find its configuration in
/root/.fetchmailrc, and must include the proper "interface" directive.

Matthias Andree adds: note that current Debian packages (as of January
2007) ship with their own init files.

### start_dynamic_ppp:

An admittedly scratchy ip-up script that Ryan Murray wrote to cope with
dynamic PPP addressing.  Will need some customizing.

	http://www.inetarena.com/~badams/linux/programs/mailqueue.pl

### getfetchmail:

Here's a script that gets Eric's most recent fetchmail source rpm,
downloads it and (if the rpm's not broken) rebuilds it.

With fairly simple changes it can be used to download the latest i386 rpm
or tar.gz.

Those who are addicted to having the latest of everything could filter mail
from fetchmail announce through it and get new versions as they're
announced. However, if we all did that, Eric's ftp server might feel a
little stressed.

The script as written works on bash 2.  By John Summerfield
<summer@os2.ami.com.au>.

### zsh-completion:

These commands set up command completion for fetchmail under zsh.
Jay Kominek <jay.kominek@colorado.edu>.

### getmail/gotmail:

These scripts are front ends for fetchmail in daemon mode that can gather
log statistics and generate text or HTML reports.  See README.getmail for
details.  Scripts by Thomas Nesges <ThomaNesges@TNT-Computer.de>.

### fetchmaildistrib:

This script resolves the issue where the sysadmin polls for mail with fetchmail
only at set intervals, but where a user wishes to see his email right
away. The duplication in /etc/fetchmailrc and ~/.fetchmailrc files is
automated with this script; whenever /etc/fetchmailrc is changed, this
script is run to distribute the stuff into all user's ~/.fetchmailrc
files.

### multidrop:

Martijn Lievaart's sendmail hacks to make multidrop reliable.

### domino:

Gustavo Chaves <gustavo@cpqd.com.br> wrote this script to deal with
the boundary-mismatch bug in Domino (see FAQ item X5).  If you use
this with --mda, the broken boundaries will be fixed and the result
passed to procmail.

### toprocmail:

John Lim Eng Hooi <jleh@mail.com> wrote this script, yet another
mda plugin, to be used with fetchmail in foreground mode.  It displays
some header lines to stdout in color, passing them (and the rest of the
message content) to procmail.

### preauth-harness:

Emmanuel Dreyfus's Perl test script for exercising IMAP PREAUTH
connections.  You'll have to patch in your username and password.

### sm-hybrid:

Peter 'Rattacresh' Backes sent this patch to improve the behavior of
sendmail 8.11.0 with multidrop.

### fetchmailnochda.pl

Watchdog script to check whether fetchmail is working in daemon mode.

### mold-remover.py

A short python script to remove old read mail from a pop3 mailserver.
Dovetails with fetchmail with keep option.  Run it as a cron job.

### PopDel.py

PopDel stands for Pop Delete; this program deletes selected email from a
pop mail server. (By Richard Harris, improved by Joshua Crawford.)

### fetchmail.logrotate (added 2007-01-14, --ma)

A logrotate configuration file developped by Daniel Leidert for Debian,
when he wanted to use /var/log/fetchmail instead of the usual syslog.
It probably needs to be adjusted for use on other systems.

### delete-later (added 2007-03-17, --ma)

A MySQL/Tcl/Expect-based client-side script to remove messages at a
certain age.  See delete-later.README for details.
(By Carsten Ralle, Yoo GmbH, Germany.)

### gai (added 2013-02-03, --ma)

A trivial getaddrinfo() program to check the getaddrinfo() call from the
system, as a research tool for the fetchmail developers.

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

                         - 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
-------------------------------------------------------------------------------

Mold Remover

Mold Remover is a short python script which integrates with fetchmail
<http://fetchmail.sourceforge.net/> and allows the user to specify the
number of days that mail should remain on the pop3 server before being
deleted.

It is released under the GNU GPL <http://www.gnu.org/copyleft/gpl.html>.

Usage:
Set up fetchmail to run with keep and uidl options.
Edit the mold_remover.py file to specify the mailserver address
and login/password details. Also specify the UIDL file created by
fetchmail (this is created automatically by fetchmail when uidl option
is selected in the fetchmailrc file usually at
/var/mail/.fetchmail-UIDL-cache). Remember to chmod the moldremover
script to 700 so that passwords cannot be read. Next, edit the field to
set how many days you want the mail to be left on the server. Lastly
create a script to run moldremover.py with python which can either be
run as a cron job or as part of your connection script. It is advisable
to stop fetchmail before mold remover is run and then to restart
fetchmail afterwards. Here is an example /etc/cron.daily/ script:

#!/bin/bash
/etc/init.d/fetchmail stop >> /var/log/messages
/usr/bin/python /usr/local/bin/mold_remover.py >> /var/log/messages
/etc/init.d/fetchmail start >> /var/log/messages

Please feel free to email me (jmstone@dsl.pipex.com) if you have any questions or bugfixes!

James Stone

*******************  DELETE - LATER ********************

    version 0.11  2007-02-06


    A tool for deleting email messages on POP3 accounts
    after a given period of time (in days)

    E.g. if you want to keep the messages 30 days to
    have webmail access while on the road

********************************************************

  The script queries the current contents of a POP3 mailbox,
  stores the message IDs of that run and saves them to a
  MySQL database.

  On each run, it compares the date on which the message was
  first seen with the current date and deletes the message,
  if that difference is greater than the value of the column
  "retaindays".

  The script stores account settings in a separate MySQL
  table for easy maintenance each email account needs an
  unique ID.

  The script scales well on large installations with several
  thousands of messages a day if you run it at a time of low
  email volume (e.g. at 4 am).



REQUIREMENTS
------------

- MySQL database server and client software (v4.x or later,
  www.mysql.com)

  MySQL sources (for compiling mysqltcl only)

- mysqltcl script (www.xdobry.de/mysqltcl/)

- libexpect (v5 or later)



INSTALLATION
------------

1. create the tables "fetchmail" and "fetchmail_users" on a
   MySQL server by running

   CREATE TABLE `fetchmail` ( `UserID` BIGINT UNSIGNED NOT NULL DEFAULT 0, `UID` VARCHAR(255) NOT NULL DEFAULT '',  `Fetchdate` DATE NOT NULL DEFAULT 0,  PRIMARY KEY(`UserID`, `UID`));

   CREATE TABLE `fetchmail_user` ( `UserID` BIGINT UNSIGNED NOT NULL AUTO_INCREMENT, `server` VARCHAR(255) NOT NULL DEFAULT '', `username` VARCHAR(63) NOT NULL DEFAULT '', `password` VARCHAR(63) NOT NULL DEFAULT '',  `retaindays` INTEGER UNSIGNED NOT NULL DEFAULT 0, PRIMARY KEY(`UserID`));

2. Fill the table "fetchmail_users" with the settings of the
   email accounts you wish to handle

3. copy the script "delete-later" to a safe place, (on
   Linux/Unix: make it executable) and edit the first lines to
   match your MySQL setup

4. run "delete-later" via cron AFTER you fetched your emails
   with settings that keep the messages on the server (e.g. via
   fetchmail --keep)



KNOWN ISSUES
------------

The mysqltcl libraries sometimes don't compile against
earlier versions of MySQL 4.x.

If you are experiencing any problems with compiling
mysqltcl, please look for pre-compiled binaries for your
distribution (or contact mail@xdobry.de), the win32 binaries
work out of the box on most M$ systems.

As most linux distributions don't include mysqltcl, get the
latest precompiled 5.x series MySQL binariesand the matching
source code from www.mysql.com, install them onto a separate
location and run "configure && make && make install" to
compile mysqltcl yourself.



NOTES
-----

The age of an email message is calculated by the difference
in days between the run of "delete-later" it was first seen
on and the current date, not the actual date the message was
sent. So if you run the script every week, the period after
which a message is delete may vary up to 14 days.

This was implemented that way, because of the common
practice of spammers to change the message date to some date
in the far future to place the message first in your inbox.



COPYRIGHT
---------

Copyright (c) 2007 Yoo GmbH
                   Zellwaldring 51
                   09603 GROSSVOIGTSBERG
                   GERMANY

Permission to use, copy, modify, distribute, and sell this software
and its documentation for any purpose is hereby granted without fee,
provided that the content of this README file appears in all copies
of the software and related documentation.



DISCLAIMER
----------

THE SCRIPT IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND.

WE (YOO) HEREBY DISCLAIM ALL WARRANTIES AND CONDITIONS WITH REGARD
TO THIS README AND SCRIPT, INCLUDING ALL WARRANTIES AND CONDITIONS
OF MERCHANTABILITY, WHETHER EXPRESS, IMPLIED OR STATUTORY, FITNESS
FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT.

IN NO EVENT SHALL YOO AND/OR ITS REPRESENTATIVES AND/OR RESPECTIVE
SUPPLIERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA
OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS README OR SCRIPT.



CONTACT
-------

For help, bug reports or other request regarding "delete-later" please
contact Carsten Ralle (English/German) by writing an e-mail to

                   cr <at> i4yoo <dot> de

with a subject starting with "DELETE-LATER: "

Please note that messages containing HTML or images will be
automatically deleted.



********************************************************************************
Yoo GmbH, Zellwaldring 51, D-09603 Grossvoigtsberg, Germany

                                                                  www.yoogmbh.de
********************************************************************************