Go to file
Nikolaus Schulz 39e6a532d0 Makefile: remove obsolete rules
* docbook2{man,html} used to generate temporary files; the new XML tool
  xsltproc does not, so we can drop the corresponding cleanup rule.
* The `bdist_rpm' rule for building rpm packages was broken for a long
  time, and therefore commented out.  The distutils bug that broke the
  rule is now fixed, but I'm removing the rule nevertheless because it's
  useless.
* The `upload' rule no longer works; drop it.
* Update .PHONY
2011-03-28 23:55:22 +02: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 Update changelog 2011-03-28 23:17:50 +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 Port man page from SGML to XML 2010-12-29 02:49:08 +01:00
Makefile Makefile: remove obsolete rules 2011-03-28 23:55:22 +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 IMAP: don't collect statistics data when run with --quiet option 2010-12-26 15:18:36 +01:00
archivemail.xml Manpage: lots of cleanup and fixes in the XML and formatting 2011-03-28 23:06:07 +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 Update changelog and prepare 0.8.2 release 2010-10-16 18:58:04 +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 setup.py: install manpage into share/man/man1 instead of man/man1 2010-11-28 02:02:51 +01:00
style.css Manpage & webpage CSS: drop font selections 2011-03-28 23:07:03 +02:00
test_archivemail IMAP: correctly handle IMAP `literal' and unquoted `astring' in LIST reply 2010-09-26 21:28:54 +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