Skip to content

Commit 8886cc0

Browse files
committed
Document mbox-from
1 parent bf8686e commit 8886cc0

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

Doc/library/mailbox.rst

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -587,12 +587,27 @@ Supported mailbox formats are Maildir, mbox, MH, Babyl, and MMDF.
587587
remarks:
588588

589589

590-
.. method:: get_file(key)
590+
.. method:: get_bytes(key, from_=False)
591+
592+
Note: This method has an extra parameter (from_) compared with other classes.
593+
The first line of an mbox file entry is the unix 'From ' line.
594+
If from_ is False, the first line of the file is dropped.
595+
596+
.. method:: get_file(key, from_=False)
591597

592598
Using the file after calling :meth:`~Mailbox.flush` or
593599
:meth:`~Mailbox.close` on the :class:`!mbox` instance may yield
594600
unpredictable results or raise an exception.
595601

602+
Note: This method has an extra parameter (from_) compared with other classes.
603+
The first line of an mbox file entry is the unix 'From ' line.
604+
If from_ is False, the first line of the file is dropped.
605+
606+
.. method:: get_string(key, from_=False)
607+
608+
Note: This method has an extra parameter (from_) compared with other classes.
609+
The first line of an mbox file entry is the unix 'From ' line.
610+
If from_ is False, the first line of the file is dropped.
596611

597612
.. method:: lock()
598613
unlock()

0 commit comments

Comments
 (0)