CHANGELOG: Document this branch's atomic saves
[rss2email.git] / CHANGELOG
1 v3.7 (unreleased)
2     * Fix atomic saves to avoid garbling config and data files if the disk is full.
3
4 v3.6 (2013-09-09)
5     * Fix missing port argument for IMAPAuthenticationError.
6     * Fix `<div id="entry>` syntax error in HTML mail.
7
8 v3.5 (2013-06-05)
9     * Added digest generation and post-processing hooks.
10     * Fix html2text configuration (ignored since 2012-10-04).
11     * Fix opmlexport crash due to orphaned feed data.
12     * Use feed names in OPML 'text' attributes.
13
14 v3.4 (2013-05-14)
15     * Added post-processing hooks for user-specified message manipulation.
16     * Added settings for IMAP delivery.  The old `use-smtp` boolean has been replaced by a new `email-protocol` setting.  Non-IMAP users should adjust their configuration to set `email-protocol` to either `sendmail` or `smtp`.
17
18 v3.3 (2013-04-13)
19     * Fix SMTP message submission logic.
20     * Fix error inheritence (super() calls).
21     * Convert html2text parsing errors to `ProcessingError`s.
22     * Cleanup html2text error handling.
23     * Drop Google Reader rel-via manipulation.
24     * Drop the wrapping <table> elements from HTML mail
25
26 v3.2 (2013-03-13)
27     * Use extended interpolation in configuration files, to allow percent signs (%).
28     * Added .as_string() fallback to email flattening (only used if `use-smtp = False` and `use-8bit = True`).
29     * Added sendmail configuration option.  Change this if you want to use an alternative, sendmail-compatible mailer.
30
31 v3.1 (2013-02-14)
32     * Import __url__, __author__, and __email__ in rss2email.error, which fixes bugs in formatting a number of errors.
33
34 v3.0 (2013-02-13)
35     * Changed project email (rss2email@tremily.us) and homepage (http://github.com/wking/rss2email).
36     * Split static configuration parameters into a ConfigParser-read config file (rss2email.cfg).  Data that depends on the feed state is recorded using JSON (rss2email.json).
37     * Use the XDG Base Directory Specification for standardized configuration and data file locations.
38     * Converted the command line interface to argparse, with some restructuring along the way.
39     * Added the r2e.1 man page (based on one from the Debian package).
40     * Added setup.py and a PyPI page for simpler installation (http://pypi.python.org/pypi/rss2email).
41     * Added Message-ID headers to outgoing email.
42     * Added a test suite.
43     * Upgraded to Python 3.2 to take advantage of cleaner Unicode handling and argparse.
44     * Require Signed-off-by lines in new commit messages, following the Linux and Git projects.
45
46 v2.71 (2011-03-04)
47     * Upgraded to feedparser v5.01! (http://code.google.com/p/feedparser/)
48     * Upgrade to html2text v3.01! (https://github.com/aaronsw/html2text)
49     * Potentialy safer method for writing feeds.dat on UNIX
50     * Handle via links with no title attribute
51     * Handle attributes more cleanly with OVERRIDE_EMAIL and DEFAULT_EMAIL
52
53 v2.70 (2010-12-21)
54     * Improved handling of given feed email addresses to prevent mail servers rejecting poorly formed Froms
55     * Added X-RSS-TAGS header that lists any tags provided by an entry, which will be helpful in filtering incoming messages
56
57 v2.69 (2010-11-12)
58     * Added support for connecting to SMTP server via SSL, see SMTP_SSL option
59     * Improved backwards compatibility by fixing issue with listing feeds when run with older Python versions
60     * Added selective feed email overrides through OVERRIDE_EMAIL and DEFAULT_EMAIL options
61     * Added NO_FRIENDLY_NAME to from from address only without the friendly name
62     * Added X-RSS-URL header in each message with the link to the original item
63
64 v2.68 (2010-10-01)
65     * Added ability to pause/resume checking of individual feeds through pause and unpause commands
66     * Added ability to import and export OPML feed lists through importopml and exportopml commands
67
68 v2.67 (2010-09-21)
69     * Fixed entries that include an id which is blank (i.e., an empty string) were being resent
70     * Fixed some entries not being sent by email because they had bad From headers
71     * Fixed From headers with HTML entities encoded twice
72     * Compatibility changes to support most recent development versions of feedparser
73     * Compatibility changes to support Google Reader feeds
74
75 v2.66 (2009-12-21)
76     * Complete packaging of all necessary source files (rss2email, html2text, feedparser, r2e, etc.) into one bundle
77         o Included a more complete config.py with all options
78         o Default to HTML mail and CSS results
79     * Added 'reset' command to erase history of already seen entries
80     * Changed project email to 'lindsey@allthingsrss.com' and project homepage to 'http://www.allthingsrss.com/rss2email/'
81     * Made exception and error output text more useful
82     * Added X-RSS-Feed and X-RSS-ID headers to each email for easier filtering
83     * Improved enclosure handling
84     * Fixed MacOS compatibility issues
85
86 v2.65 (2009-01-05)
87     * Fixed warnings caused by Python v2.6 (using hashlib, removing mimify, etc.)
88     * Deprecated QP_REQUIRED option as this is more than likely no longer needed and part of what triggered Python warnings
89     * Fixed unicode errors in certain post headers
90     * Attempted to incorporate Debian/Ubuntu patches into the mainstream release
91     * Support img type enclosures
92     * No file locking for SunOS
93
94 v2.64 (2008-10-21)
95     * Bug-fix version
96         o Gracefully handle missing charsets
97         o Friendlier and more useful message if sendmail isn't installed
98         o SunOS locking fix
99
100 v2.63 (2008-06-13)
101     * Bug-fix version and license change:
102         o Licensed under GPL 2 & 3 now
103         o Display feed number in warning and error message lines
104         o Fix for unicode handling problem with certain entry titles
105
106 v2.62 (2008-01-14)
107     * Bug-fix version:
108         o Simplified SunOS fix
109         o Local feeds (/home/user/file.xml) should work
110
111 v2.61 (2007-12-07)
112     * Bug-fix version:
113         o Now really compatible with SunOS
114         o Don't wrap long subject headers
115         o New parameter CHARSET_LIST to override or supplement the order in which charsets are tried against an entry
116         o Don't use blank content to generate id
117         o Using GMail as mail server should work
118
119 v2.60 (2006-08-25)
120     * Small bug-fix version:
121         o Now compatible with SunOS
122         o Correctly handle international character sets in email From
123
124 v2.59 (2006-06-09)
125     * Finally added oft-requested support for enclosures. Any enclosures, such as a podcast MP3, will be listed under the entry URL
126     * Made feed timeout compatible with Python versions 2.2 and higher, instead of v2.4 only
127     * Added optional, configurable CSS styling to HTML mail. Set USE_CSS_STYLING=1 in your config.py to enable this. If you want to tweak the look, modify STYLE_SHEET.
128     * Improved empty feed checking
129     * Improved invalid feed messages
130     * Unfortunately, rss2email is no longer compatible with Python v2.1. Two of the most serious lingering issues with rss2email were waiting forever for non-responsive feeds and its inablility to properly handle feeds with international characters. To properly fix these once and for all, rss2email now depends on functionality that was not available until Python v2.2. Hopefully this does not unduly inconvenience anyone that has not yet upgraded to a more current version of Python.
131
132 v2.58 (2006-05-11)
133     * Total rewrite of email code that should fix encoding problems
134     * Added configurable timeout for nonresponsive feeds
135     * Fixed incorrectly using text summary_detail instead of html content
136     * Fixed bug with deleting feed 0 if no default email was set
137     * Print name of feed that is being deleted
138
139 v2.57 (2006-04-07)
140     * Integrated Joey Hess's patches
141        o First, a patch that makes delete more reliable, so it no longer allows you to remove the default email address ('feed' 0) and thereby hose your feed file, or 'remove' entries that don't exist without warning; and so it only says IDs have changed when they really have. Originally from http://bugs.debian.org/313101
142        o Next a patch that avoids a backtrace if there's no email address defined, and outputs a less scary error message.
143        o Next, a simple change to the usage; since the "email" subcommand always needs a parameter, don't mark it as optional.
144        o And, avoid a backtrace if the email subcommand does get run w/o a parameter.
145        o And also avoid backtraces if delete is run w/o a parameter. Also adds support for --help.
146        o Simple change, make a comment match reality (/usr/sbin/sendmail)
147        o This avoids another backtrace, this time if there's no feed file yet. [load()]
148        o Add a handler for the AttributeError exception, which feedparser can throw. Beats crashing..
149        o Next, four hunks that make it more robust if no default email address is set and feeds are added w/o an email address. This patch originally comes from http://bugs.debian.org/310485 which has some examples.
150        o Finally, this works around a bug in mimify that causes it to add a newline to the subject header if it contains very long words. Details at http://bugs.debian.org/320185. Note that Tatsuya Kinoshita has a larger patch torard the end of that bug report that deals with some other problems in this area, Aaron has seen that patch before and said it "looks pretty reasonable".
151     * add() catches error case on first feed add and no email address is set
152     * Made "emailaddress" consistent param label throughout
153     * Error message improvements
154     * Deleted problematic "if title" line
155     * Deleted space in front of SMTP_USER
156     * Only logs into SMTP server once
157     * Added exception handling around SMTP server connect and login attempt
158     * Broke contributors across multiple lines
159
160 v2.56 (2006-04-04)
161     * SMTP AUTH support added
162     * Windows support
163     * Fixed bug with HTML in titles