Initial commit
[imapreorder.git] / README
1 Copyright © 2014 Iain Nicol
2 See the end of the file for license conditions.
3
4
5 imapreorder is a command line program. It will reorder the emails of an
6 IMAP folder. The postcondition is that if your emails are then sorted
7 by UID, they will also be sorted by their received date. In IMAP
8 jargon, the received date is also called the ``internal date'' or
9 ``INTERNALDATE''.
10
11 imapreorder is useful because the K-9 email client for Android sorts
12 messages by UID, not by their internal date.[1] In other words, running
13 imapreorder will ensure that K-9 displays your messages in the correct
14 order.
15
16 The program imapreorder is designed to operate safely. In particular,
17 consider the effect of it being interrupted, for example by a network
18 failure. You would then have to delete an obviously-named temporary
19 email-subfolder. Additionally, you would need to use a program such as
20 imapsync[2] to safely remove duplicated messages from your email folder.
21 However, you should not lose any emails.
22
23 imapreorder is free software; see the file COPYING.
24
25 For compilation instructions, see the file INSTALL.
26
27
28 [1] See <https://code.google.com/p/k9mail/issues/detail?id=1072>.
29
30 [2] See <http://imapsync.lamiral.info/>.
31
32
33 \f
34 This program is free software: you can redistribute it and/or modify
35 it under the terms of the GNU Affero General Public License as published by
36 the Free Software Foundation, either version 3 of the License, or
37 (at your option) any lather version.
38
39 This program is distributed in the hope that it will be useful,
40 but WITHOUT ANY WARRANTY; without even the implied warranty of
41 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
42 GNU Affero General Public License for more details.
43
44 You should have received a copy of the GNU Affero General Public License
45 along with this program. If not, see <http://www.gnu.org/licenses/>.