Go to file
Nikolaus Schulz 5b72c8287c Updated and edited manpage:
* drop prominent note about being a python program; 
* extended description a bit;
* Document issue with slashes in IMAP mailbox paths.
2007-11-07 22:32:07 +00:00
examples Added a lot more documentation, fixed up usage messages and expanded a lot 2002-04-13 11:36:32 +00:00
CHANGELOG When converting from other formats to mbox, don't preserve existing 'Status' and 2007-11-02 23:35:50 +00: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 Fixed a bug where we would throw an exception if a message was dated 2002-08-18 12:17:56 +00:00
Makefile Makefile: run HTML tidy on the autogenerated HTML manpage. This spews quite 2007-11-06 23:49:47 +00:00
README README: Updated python dependency, removed note about the required zlib module 2006-11-02 23:04:14 +00:00
RELNOTES Added new file RELNOTES (release notes for v0.7.0) and linked to it in 2006-11-03 00:36:00 +00:00
TODO TODO: update for the upcoming release. Added new item: 2007-11-07 19:59:18 +00:00
archivemail.1 Updated and edited manpage: 2007-11-07 22:32:07 +00:00
archivemail.py IMAP: if selecting a mailbox fails with both the original path name and with 2007-11-07 21:10:08 +00:00
archivemail.sgml Updated and edited manpage: 2007-11-07 22:32:07 +00: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 index.html: major overhaul: re-edited and partly rewritten. 2007-11-06 23:24:48 +00:00
manpage.css manpage.css, style.css: 2007-11-06 23:38:05 +00:00
setup.py archivemail.py, setup.py, test_archivemail.py: 2007-11-07 00:57:44 +00:00
style.css manpage.css, style.css: 2007-11-06 23:38:05 +00:00
test_archivemail.py archivemail.py, setup.py, test_archivemail.py: 2007-11-07 00:57:44 +00: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:
    cp archivemail archivemail.py
    python test_archivemail.py
    (NOTE: This could take over 90 seconds on slower systems)

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