Ability to enable the update mode via the config file
[imap-fix-internaldate] / README
1 Small tool to fix the IMAP internaldate
2 in case it's too much off compared to the last date
3 stored in the received lines.
4
5 F.e. some IMAP clients tend to reset the imap internaldate
6 when you move a message between folders.
7
8 Features:
9 - Configurable tolerance
10 - Test mode: Show only what would be done
11 - Statistics: How many messages it would modify per user / folder
12 - Log file with all actions
13 - Caching
14
15 Note: Only the -first- received line is interpreted.
16 This was the lastest date on our server. We don't interpret
17 all received lines because spam messages tend to contain bogus dates.
18
19 If no recieved line is found, you can enable a fallback
20 mechanism to the "Date:" header in the configuration file.
21 This is useful for correcting "Sent" items.
22
23
24 By default the script runs in test mode and does not modify any messages.
25 See the output of the "--help" command line switch
26 how to activate the real update mode.
27
28 Prerequisites:
29 Python version 3 or later
30
31     Linux: Should be part of any modern linux distribution
32     Windows: Get it from http://www.python.org/getit/windows/
33
34 Necessary files:
35 - userdata.csv: Contains information necessary for the user session with format:
36         username,password
37         testuser1,testpass1
38         testuser2,testpass2
39
40   Note: The first line are the column names and gets ignored.
41
42 Produced files:
43 - fix_imap_internaldate.cfg: Configuration of the script - created on first run.
44 - fix_imap_internaldate.log: Log file. Will be truncated on script invocation.
45 - statistics.txt: Final report on statistics about detected date conflicts and missing dates.
46 - message_cache.dat: Cache file used for performance improvements
47
48 For more information please contact opensource@intra2net.com