Go to file
Nikolaus Schulz b7091e90ea Releasing 0.8.0: fix release date in the changelog, and update the project web page 2010-08-09 13:25:41 +02:00
examples Added a lot more documentation, fixed up usage messages and expanded a lot 2002-04-13 11:36:32 +00:00
CHANGELOG Releasing 0.8.0: fix release date in the changelog, and update the project web page 2010-08-09 13:25:41 +02:00
COPYING Initial revision 2002-03-26 03:53:09 +00:00
FAQ Fixed a bug where mailbox locking would fail under Solaris, also fixed 2002-09-15 06:14:57 +00:00
MANIFEST.in MANIFEST.in: distribute NEWS 2010-08-09 13:16:14 +02:00
Makefile Rename archivemail.py to archivemail 2010-07-29 21:35:58 +02:00
NEWS Add new file NEWS, gathering noteworthy changes from the changelog 2010-08-09 13:14:23 +02:00
README Rename archivemail.py to archivemail 2010-07-29 21:35:58 +02:00
TODO Manpage, TODO, CHANGELOG: document and record wildcard expansion in IMAP mailbox names 2010-08-09 11:43:10 +02:00
archivemail Expand wildcards in IMAP mailbox names 2010-08-09 11:32:01 +02:00
archivemail.1 Regenerate manpage from sgml source 2010-08-09 11:43:30 +02:00
archivemail.sgml Manpage, TODO, CHANGELOG: document and record wildcard expansion in IMAP mailbox names 2010-08-09 11:43:10 +02:00
db2html.dsl db2html.dsl: override $refentry-body$ from dbrfntry.dsl to add a <hr> after the 2007-11-06 23:33:33 +00:00
index.html Releasing 0.8.0: fix release date in the changelog, and update the project web page 2010-08-09 13:25:41 +02:00
manpage.css manpage.css, style.css: 2007-11-06 23:38:05 +00:00
setup.py Bump version to 0.8.0 2010-07-29 21:02:07 +02:00
style.css manpage.css, style.css: 2007-11-06 23:38:05 +00:00
test_archivemail New option --archive-name, alias -a, to hard-code the archive filename 2010-07-31 20:49:30 +02:00

README

-----------------------------------------------------------
archivemail - archive and compress old mail in your mailbox
-----------------------------------------------------------

OVERVIEW:

archivemail is a tool written in python(1) for archiving and compressing old
email in mailboxes. 

It can move messages older than the specified number of days to a separate
'archive' mbox-format mailbox that is compressed with 'gzip'.

For example, have you been subscribing to the 'linux-kernel' mailing list
for the last 6 years and ended up with an 160-meg mailbox that 'mutt' is
taking a long time to load?  'archivemail' can move all messages that are
older than 6 months to a separate compressed mailbox, and leave you with
just the most recent messages. 

'archivemail' can save a lot of disk space and will significantly reduce
overhead on your mail reader. The number of days before mail is considered
'old' is up to you, but the default is 180 days. You can also archive messages
by an absolute date or only archive unread messages.


REQUIREMENTS:

archivemail requires python version 2.3. It also uses some optional python
modules, but these should be pretty much standard; if you get an ImportError
nonetheless, please report it, thanks. (For contact addresses see below.)

Python is available from http://www.python.org/


INSTALLATION:

If you want to test archivemail:
    python test_archivemail

To install archivemail, run:
    python setup.py install


USE:

For more detailed information and examples, look at the archivemail man page.

The best way to run archivemail is from cron, giving the '-q' option to
archivemail to make it quiet, only printing messages if something went wrong.
Check out the 'examples' directory for an example shell script to be run from
cron.

The archivemail website is at: http://archivemail.sourceforge.net/

If you have any feedback or bug reports about archivemail, you are very
welcome to email the maintainers; as of November 2006, these are:

Nikolaus Schulz <microschulz@web.de>
Peter Poeml <poeml@suse.de>


-- Paul Rodger <paul at paulrodger dot com>, archivemail author
   Updated by: Nikolaus Schulz, maintainer