Commit Graph

34 Commits

Author SHA1 Message Date
Andrew M. Kuchling 564c9f5fb0 Strengthen warning about using lock() 2007-01-24 20:08:13 +00:00
Andrew M. Kuchling dfad614321 [Part of bug #1599254] Add suggestion to Mailbox docs to use Maildir, and warn user to lock/unlock mailboxes when modifying them 2007-01-17 19:56:06 +00:00
Andrew M. Kuchling 4b6d53780d Reword paragraph 2006-07-27 22:40:05 +00:00
Andrew M. Kuchling 0901965134 Minor language edit 2006-05-07 17:14:53 +00:00
Andrew M. Kuchling 1da4a94719 Add Gregory K. Johnson's revised version of mailbox.py (funded by
the 2005 Summer of Code).

The revision adds a number of new mailbox classes that support adding
and removing messages; these classes also support mailbox locking and
default to using email.Message instead of rfc822.Message.

The old mailbox classes are largely left alone for backward compatibility.
The exception is the Maildir class, which was present in the old module
and now inherits from the new classes.  The Maildir class's interface
is pretty simple, though, so I think it'll be compatible with existing
code.

(The change to the NEWS file also adds a missing word to a different
news item, which unfortunately required rewrapping the line.)
2006-04-22 02:32:43 +00:00
Fred Drake 0d73621cb2 markup adjustment 2004-05-11 05:29:34 +00:00
Barry Warsaw dd69b0ab6c Added a note describing how fp should be opened in binary mode, especially on
Windows.  Closes SF # 586899.
2004-05-10 23:12:52 +00:00
Raymond Hettinger 999b57c872 Fix double word typos. 2003-08-25 04:28:05 +00:00
Barry Warsaw 47db252786 Add some documentation which describes how to use the email package
instead of rfc822 as the Message factory.
2003-06-20 22:04:03 +00:00
Greg Ward 02669a35bc Tweak description of PortableUnixMailbox: "From " lines are actually
quoted (or mangled) *at* delivery-time, not "well before" it.  (At least
that's how Exim and qmail work.)
2002-09-23 19:32:42 +00:00
Fred Drake c37b65ee10 Clean up some markup cruft. A number of the macros that take no
parameters (like \UNIX) are commonly entered using an empty group to
separate the markup from a following inter-word space; this is not
needed when the next character is punctuation, or the markup is the
last thing in the enclosing group.  These cases were marked
inconsistently; the empty group is now *only* used when needed.
2001-11-28 07:26:15 +00:00
Fred Drake e9ba525c2b Clarify comments about mailbox objects being iterable. 2001-10-01 15:49:56 +00:00
Skip Montanaro bb5a465ca9 typo... 2001-09-05 19:27:13 +00:00
Fred Drake d86038d1be Apply the new \mailheader macro where appropriate, and fix a few small
markup inconsistencies.
2001-08-03 18:39:36 +00:00
Fred Drake 1400baa5d6 Add a "See also" section with useful links. More should be added giving
pointers to information about the other mailbox formats; if anyone can
provide the information needed, please let me know!
2001-05-21 21:23:01 +00:00
Fred Drake 287c4cb43a State that Mailbox objects are iterator objects. 2001-05-02 20:22:12 +00:00
Barry Warsaw c3cbbaf513 Added some additional documentation describing how BabylMailbox
actually works (it returns a message containing the visible headers,
not the original headers).  Doc change approved by Fred; closes SF bug
#412230.
2001-04-11 20:12:33 +00:00
Fred Drake 6270031f4e Adjustments to the text of the UnixMailbox description. Added
PortableUnixMailbox as a separate class as well (this also generates
the right index entry).
2001-02-02 03:51:05 +00:00
Barry Warsaw 30dbd1429a Document the two changes to the mailbox.py module:
- All constructors grow an optional argument `factory' which is a
  callable used when new message instances are created by the next()
  methods.  Defaults to the rfc822.Message class.

- A new subclass of UnixMailbox is added, called PortableUnixMailbox.
  It's identical to UnixMailbox, but uses a more portable test for
  From_ delimiter lines.  With PortableUnixMailbox, any line that
  starts with "From " is considered a delimiter (this should really
  check for two newlines before the F, but it doesn't.
2001-01-31 22:14:01 +00:00
Fred Drake 2c4f554b78 Fixed a large number of small problems, mostly noted by Detlef Lannert
<lannert@lannert.rz.uni-duesseldorf.de>.
2000-10-10 22:00:03 +00:00
Fred Drake 806a467fbf Where rfc822.Message is mentioned, add a link to the rfc822 module. 1999-03-27 05:45:46 +00:00
Fred Drake fab41f1788 BabylMailbox description: Properly escape the backslashes in the
string representations.
1999-02-22 14:26:16 +00:00
Fred Drake 180b68b3cf More reasonable section titles. 1999-02-22 13:45:09 +00:00
Fred Drake 199b79c37b Added descriptions for BabylMailbox and Maildir (Qmail) mailbox
objects.
1999-02-20 05:04:59 +00:00
Fred Drake 295da24eaf New section header style.
Fix up a few synopses.
1998-08-10 19:42:37 +00:00
Fred Drake b91e934cf1 Adjusted to use the new module synopsis support macros. 1998-07-23 17:59:49 +00:00
Fred Drake 3a0351cf85 Remove all uses of \sectcode; we can now use logical markup everywhere. 1998-04-04 07:23:21 +00:00
Fred Drake 182bd2d176 Use methoddesc instead of funcdesc to describe the only method. 1998-04-02 18:50:21 +00:00
Fred Drake 2e495c93b0 Logical markup, using {classdesc} as appropriate. 1998-03-14 06:48:33 +00:00
Fred Drake 6e99adb1c9 Don't capitalize identifiers at the beginning of the sentence; re-write to
place them elsewhere so they get the right capitalization.
1998-02-13 22:17:21 +00:00
Fred Drake 1947991c2f Remove all \bcode / \ecode cruft; this is no longer needed. See previous
checkin of myformat.sty.

Change "\renewcommand{\indexsubitem}{(...)}" to "\setindexsubitem{(...)}"
everywhere.

Some other minor nits that I happened to come across.
1998-02-13 06:58:54 +00:00
Fred Drake c9dc5151b6 Consistency: "unix" ==> "\UNIX{}"
Added \label{} for referring to the module.
1998-01-13 19:01:57 +00:00
Guido van Rossum e229d8636d Misc Mac mods by Jack. Added libmacic.tex, and these patches:
libmacfs.tex	Document NewAliasMinimalFromFullPath
libmacos.tex	Document SetEventHandler and SchedParams
libmacui.tex	Document asynchronous event handling
libmailbox.tex	Removed mime-turds that somehow got in here
1997-08-18 15:14:26 +00:00
Guido van Rossum 39a23cc1e3 Doc for mailbox.tex (Jack) 1997-06-02 21:04:41 +00:00