summaryrefslogtreecommitdiffstats
path: root/Doc/library/email.policy.rst
Commit message (Collapse)AuthorAgeFilesLines
* #18891: Complete new provisional email API.R David Murray2013-10-171-10/+24
| | | | | | | | | | | | This adds EmailMessage and, MIMEPart subclasses of Message with new API methods, and a ContentManager class used by the new methods. Also a new policy setting, content_manager. Patch was reviewed by Stephen J. Turnbull and Serhiy Storchaka, and reflects their feedback. I will ideally add some examples of using the new API to the documentation before the final release.
* Issue #18761: Improved cross-references in email documentation.Serhiy Storchaka2013-08-191-4/+5
|\
| * Issue #18761: Improved cross-references in email documentation.Serhiy Storchaka2013-08-191-4/+5
| |
| * #18600: In 3.3, as_string does not accept a policy keyword.R David Murray2013-08-091-10/+0
| | | | | | | | Also, document the policy keyword that was added to Message in 3.3.
* | #18600: add policy to add_string, and as_bytes and __bytes__ methods.R David Murray2013-08-091-1/+2
|/ | | | | | | This was triggered by wanting to make the doctest in email.policy.rst pass; as_bytes and __bytes__ are clearly useful now that we have BytesGenerator. Also updated the Message docs to document the policy keyword that was added in 3.3.
* #18584: s/testcleanup/testsetup/ until we switch to Sphinx 1.1.R David Murray2013-07-301-1/+1
| | | | | | testcleanup directive is new as of 1.1, and we are currently running 1.0.7. But using testsetup works just as well, and avoids the unknown directive error when building the docs.
* #18584: make doctest examples in email documentation pass.R David Murray2013-07-291-11/+34
| | | | | | | | | | | With the exception of the 'as_string' call in the policy docs. That one is a separate issue. Note that when building the docs sphinx is complaining about .. testcleanup:: being an invalid directive. I don't know why this is, as I'm following the sphinx docs...but fortunately the action is to omit the text in the body, so the generated documentation is correct.
* Closes #4159: add LaTeX tabular column specifications to tables that ↵Georg Brandl2013-03-281-0/+2
| | | | otherwise are cut off or have overlapping text.
* Issue #17047: remove doubled words added in 3.3Terry Jan Reedy2013-03-111-1/+1
| | | | as reported by Serhiy Storchaka and Matthew Barnett.
* #10839: raise an error on add of duplicate unique headers in new email policiesR David Murray2012-05-291-0/+25
| | | | | | | | | | | This feature was supposed to be part of the initial email6 checkin, but it got lost in my big refactoring. In this patch I'm not providing an easy way to turn off the errors, but they only happen when a header is added programmatically, and it is almost never the right thing to do to allow the duplicate to be added. An application that needs to add duplicates of unique headers can create a policy subclass to allow it.
* #11785: fix the :mod: references in email package submodule titles.R David Murray2012-05-271-2/+5
| | | | Also adds the TOC entry for headerregistry.
* Make headerregistry fully part of the provisional api.R David Murray2012-05-271-174/+12
| | | | | | | | | | | | | When I made the checkin of the provisional email policy, I knew that Address and Group needed to be made accessible from somewhere. The more I looked at it, though, the more it became clear that since this is a provisional API anyway, there's no good reason to hide headerregistry as a private API. It was designed to ultimately be part of the public API, and so it should be part of the provisional API. This patch fully documents the headerregistry API, and deletes the abbreviated version of those docs I had added to the provisional policy docs.
* Fix markup.Georg Brandl2012-05-271-1/+1
|
* #12586: add provisional email policy with new header parsing and folding.R David Murray2012-05-251-0/+323
| | | | | | | | | | | | | | When the new policies are used (and only when the new policies are explicitly used) headers turn into objects that have attributes based on their parsed values, and can be set using objects that encapsulate the values, as well as set directly from unicode strings. The folding algorithm then takes care of encoding unicode where needed, and folding according to the highest level syntactic objects. With this patch only date and time headers are parsed as anything other than unstructured, but that is all the helper methods in the existing API handle. I do plan to add more parsers, and complete the set specified in the RFC before the package becomes stable.
* #14731: refactor email policy framework.R David Murray2012-05-251-83/+207
| | | | | | | | | | | | | | | | | This patch primarily does two things: (1) it adds some internal-interface methods to Policy that allow for Policy to control the parsing and folding of headers in such a way that we can construct a backward compatibility policy that is 100% compatible with the 3.2 API, while allowing a new policy to implement the email6 API. (2) it adds that backward compatibility policy and refactors the test suite so that the only differences between the 3.2 test_email.py file and the 3.3 test_email.py file is some small changes in test framework and the addition of tests for bugs fixed that apply to the 3.2 API. There are some additional teaks, such as moving just the code needed for the compatibility policy into _policybase, so that the library code can import only _policybase. That way the new code that will be added for email6 will only get imported when a non-compatibility policy is imported.
* Fix glitches in email.policy docs (#12208)Éric Araujo2011-12-031-2/+4
|
* Fix directive markupÉric Araujo2011-08-101-1/+1
|
* Add new email.policy document to the toctree and fix markup glitch.Georg Brandl2011-04-191-1/+1
|
* Markup and text fixes from Georg Brandl's review.R David Murray2011-04-181-23/+26
|
* #11731: simplify/enhance parser/generator API by introducing policy objects.R David Murray2011-04-181-0/+179
This new interface will also allow for future planned enhancements in control over the parser/generator without requiring any additional complexity in the parser/generator API. Patch reviewed by Éric Araujo and Barry Warsaw.