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