aboutsummaryrefslogtreecommitdiffstats
path: root/index.html
blob: 90bef898f33d72655fbc79f25fd359216bcc9b7d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"
   "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta http-equiv="Content-type" 
      content="text/html;charset=us-ascii">
    <title>archivemail &ndash; a tool for archiving and compressing old email</title>
    <link title="archivemail style" rel=stylesheet href="style.css" 
    type="text/css">
<style type="text/css">
/*<![CDATA[*/
.command {font-weight: bold;}
.example {
    /*background-color: #e0e0e0;*/
    padding: 0 2em; 
}
#status {
    float: right; 
    width: 10em
    margin-left: 4em; 
    margin-top: 1.3em;
    padding: 3ex; 
    border: 1px solid #777777; 
    line-height: 160%; 
}
/*span.mail {text-decoration: underline;}*/
/*]]>*/
</style>
</head>
<body>
   
<h1>archivemail</h1>

<hr>
<div id="status">
    <strong>Latest version: 0.9.0</strong><br>
    Released on 2011-07-09
</div>
<h2>What is it?</h2>
<p>
<span class="command">archivemail</span> is a tool for archiving and compressing
old email in mailboxes. 
It moves messages older than the specified number of
days to a separate <a title="mbox(5) man page" 
href="http://www.qmail.org/man/man5/mbox.html">mbox format</a> mailbox that is 
compressed with <span class="command">gzip</span>.
It can also just delete old email rather than archive it. 

<h2>What can it do for me?</h2>
<p>
Maybe some of your mailboxes are quite large (eg, over 10,000 messages) and
they are taking a while to load in your mail reader. Perhaps they are taking
up too much space on your disk. Archiving old messages to a separate,
compressed mailbox will mean: 
<ol>
<li>Your mail reader will get a huge performance boost loading and reading
    your mail.
<li>You will be taking up less disk space, since old mail will be compressed.
    (Mail usually compresses quite nicely.)
<li>You won't be confronted with semi-obsolete mail all the time.
</ol>
<p>
You can also use <span class="command">archivemail</span> as a simple backup
tool. 

<h2>Features overview</h2>
<ul>
<li>Supports archiving 
    <a title="about IMAP" href="http://www.imap.org/">IMAP</a>,
    <a title="mbox(5) man page" href="http://www.qmail.org/man/man5/mbox.html">mbox</a>,
    <a title="MH FAQ" href="http://www.faqs.org/faqs/mail/mh-faq/">MH</a> and 
    <a title="maildir(5) man page" 
        href="http://www.qmail.org/man/man5/maildir.html">Maildir</a> format 
    mailboxes.
<li>Old mail can be either archived or just deleted. 
<li>The age in days that is considered old is configurable &ndash; it defaults
    to 180 days.
    You can also set an absolute limit date. 
<li>Messages that are flagged important are not archived or deleted unless
    explicitely requested.
<!--<li>You can specify an option so that unread mail is never archived.-->
<li>Can be configured to preserve unread mail. 
<li>Can be configured to only archive messages over a given byte size.
<li>Stores the compressed archive mailboxes in a directory of
    your choice, with an extension of your choice.
<li>Easy read-only testing, not touching your valuable data. 
<li>Supports IMAPS/SSL.
<li>When archiving IMAP mailboxes, the message selection can be refined by
    extending the underlying IMAP <code>SEARCH</code> command with arbitrary
    search keys (you will have to cope with the raw IMAP protocol, though).
</ul>

<h2>Documentation</h2>
<p>
The <a href="manpage.html">archivemail manpage</a> is the primary documentation
for <span class="command">archivemail</span>.
To see what has changed in the latest version, check the <a
    href="RELNOTES">release notes</a>. 
If you want to have a closer look at the current development status, here's the 
<a title="changelog in git HEAD" href=
"http://archivemail.git.sourceforge.net/git/gitweb.cgi?p=archivemail/archivemail;a=blob;f=CHANGELOG;hb=HEAD">
CHANGELOG</a> and the <a title="TODO list in git HEAD" href=
"http://archivemail.git.sourceforge.net/git/gitweb.cgi?p=archivemail/archivemail;a=blob;f=TODO;hb=HEAD">
TODO list</a>, fresh from the repository. 

<h2>Where can I get it?</h2>
<p>
You can grab the latest version of <span class="command">archivemail</span>
directly from the <a
href="http://sourceforge.net/project/showfiles.php?group_id=49630">archivemail
download area</a> at Sourceforge. 
There should be up-to-date binary RPM packages at the
<a href="http://software.opensuse.org/download/server:/mail/">OpenSUSE build
service</a> for SUSE Linux and Fedora Core.
Also, many Linux distributions provide packages; e.g. there is a 
<a href="http://packages.debian.org/unstable/archivemail">Debian
package</a>.

<p>
<span class="command">archivemail</span> is written in Python, and hacking it is
easy and fun; you can check out the source from the git repository with
the following command: 
<div class="example">
<kbd>git clone git://archivemail.git.sourceforge.net/gitroot/archivemail/archivemail</kbd>
</div>
<p>
See also the short <a href="http://sourceforge.net/scm/?type=git&amp;group_id=49630">
introduction to git access</a> at sourceforge.

<!-- 2007-11-06: this site has problems, and I cannot read the mentioned article. 
    <h3>Articles</h3>
    <p>
    Emmanuel Seyman wrote an 
    <a href="http://muttfr.org/gen.php3/2002/11/20/108,1,0,0,1.php3">article
    about archivemail</a> for <a href="http://www.muttfr.org/">muttfr.org</a>, a
    French website about <a href="http://www.mutt.org/">mutt</a>.
-->

<h2>Getting involved</h2>
<ul> 
    <li>Visit the <a
        href="http://sourceforge.net/tracker/?group_id=49630">archivemail
        tracker</a> to browse and/or submit bug reports and feature requests.
    <li>You can subscribe to the <a
        href="http://lists.sourceforge.net/lists/listinfo/archivemail-user">archivemail-user
        mailing list</a>.  
    This is a low traffic, subscribers-only list.  
<li>Check out the <a href="http://sourceforge.net/projects/archivemail/">project page
    for archivemail</a> at Sourceforge for a general overview.
</ul>

<h2>Requirements</h2>
<p>
<span class="command">archivemail</span> requires Python 2.3 or newer. 
It also uses some optional python modules, but these should be pretty much
standard; if you get an ImportError nonetheless, please 
<a title="jump to the archivemail tracker" 
href="http://sourceforge.net/tracker/?group_id=49630">report it</a>, thanks. 

<h2>License</h2>
<p>
This software is licensed under the terms of the 
<a href="http://www.gnu.org/licenses/licenses.html#GPL">GNU GPL</a>, either
version 2 of the license, or any later version. 

<h2>Credits</h2>
<p>
<span class="command">archivemail</span> was written by Paul Rodger
<code>&lt;paul <em>at</em> paulrodger <em>dot</em>
    com&gt;</code>
and is currently maintained by Peter Poeml <code>&lt;poeml
    <em>at</em> suse <em>dot</em> de&gt;</code>, Nikolaus Schulz <code><a href=
"mailto:microschulz@web.de">&lt;microschulz@web.de&gt;</a></code>
and Brandon Knitter.

<hr>
<p>
<!-- sourceforge logo start --> 
<a href="http://sourceforge.net">
<!-- white: -->
    <img src="http://sflogo.sourceforge.net/sflogo.php?group_id=49630&amp;type=2"
    width="125" height="37" 
    alt="SourceForge.net Logo">
<!-- blue: 
    <img src="http://sflogo.sourceforge.net/sflogo.php?group_id=49630&amp;type=4"
    width="125" height="37" 
    alt="SourceForge.net Logo">
-->
</a>
<!-- sourceforge logo end --> 
</body>
</html>