Update README file
[imap-fix-internaldate] / README
CommitLineData
d927792b
TJ
1Small tool to fix the IMAP internaldate
2in case it's too much off compared to the last date
3stored in the received lines.
4
5F.e. some IMAP clients tend to reset the imap internaldate
6when you move a message between folders.
7
8Features:
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
002533ab
TJ
15Important note: Only the -first- received line is interpreted.
16This was the lastest date on our server. We don't interpret
17all received lines because spam messages tend to contain bogus dates.
91aca3c4
TJ
18
19If no recieved line is found, you can enable a fallback
20mechanism to the "Date:" header in the configuration file.
21This is useful for correcting "Sent" items.
002533ab
TJ
22
23Prerequisites:
24Python version 3 or later
25
8a36cfd2
TJ
26 Linux: Should be part of any modern linux distribution
27 Windows: Get it from http://www.python.org/getit/windows/
28
97bd6bea
PD
29Necessary files:
30- userdata.csv: Contains information necessary for the user session with format:
1007fa6d
TJ
31 username,password
32 testuser1,testpass1
33 testuser2,testpass2
34
35 Note: The first line are the column names and gets ignored.
002533ab 36
97bd6bea 37Produced files:
1007fa6d
TJ
38- fix_imap_internaldate.cfg: Configuration of the script - created on first run.
39- fix_imap_internaldate.log: Log file. Will be truncated on script invocation.
91aca3c4 40- statistics.txt: Final report on statistics about detected date conflicts and missing dates.
1007fa6d 41- message_cache.dat: Cache file used for performance improvements
97bd6bea 42
002533ab 43For more information please contact opensource@intra2net.com