Go to file
Nikolaus Schulz e1a6028332 test suite: bail out on python versions << 2.4
The test suite uses function that were introduced in Python 2.4 (e.g.
set(), sorted()).
2012-11-04 23:29:08 +01:00
examples Added a lot more documentation, fixed up usage messages and expanded a lot 2002-04-13 11:36:32 +00:00
.gitignore Add .gitignore, ignoring auto-generated files 2011-03-28 23:29:51 +02:00
CHANGELOG Prepare release of archivemail v0.9.0 2011-07-09 19:17:21 +02:00
COPYING Initial revision 2002-03-26 03:53:09 +00:00
FAQ FAQ: update note about missing bzip2 support 2011-07-09 18:41:20 +02:00
MANIFEST.in MANIFEST: distribute db2man.xsl 2011-07-09 20:32:29 +02:00
Makefile Makefile: remove obsolete rules 2011-03-28 23:55:22 +02:00
NEWS NEWS: note support for international IMAP mailbox names 2011-07-09 19:15:57 +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 Bump year in copyright notes 2011-07-09 19:58:36 +02:00
archivemail.xml manpage: minor grammar fix "allows to" -> "allows you to" 2011-07-10 00:18:05 +02:00
db2html.xsl Manpage: lots of cleanup and fixes in the XML and formatting 2011-03-28 23:06:07 +02:00
db2man.xsl Manpage: lots of cleanup and fixes in the XML and formatting 2011-03-28 23:06:07 +02:00
index.html Prepare release of archivemail v0.9.0 2011-07-09 19:17:21 +02:00
manpage.css Manpage: lots of cleanup and fixes in the XML and formatting 2011-03-28 23:06:07 +02:00
setup.py Prepare release of archivemail v0.9.0 2011-07-09 19:17:21 +02:00
style.css Manpage & webpage CSS: drop font selections 2011-03-28 23:07:03 +02:00
test_archivemail test suite: bail out on python versions << 2.4 2012-11-04 23:29:08 +01: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