Skip to content
17 changes: 16 additions & 1 deletion Doc/library/mailbox.rst
Original file line number Diff line number Diff line change
Expand Up @@ -587,12 +587,27 @@ Supported mailbox formats are Maildir, mbox, MH, Babyl, and MMDF.
remarks:


.. method:: get_file(key)
.. method:: get_bytes(key, from_=False)

Note: This method has an extra parameter (*from_*) compared with other classes.
The first line of an mbox file entry is the Unix "From " line.
If *from_* is False, the first line of the file is dropped.

.. method:: get_file(key, from_=False)

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

Note: This method has an extra parameter (*from_*) compared with other classes.
The first line of an mbox file entry is the Unix "From " line.
If *from_* is False, the first line of the file is dropped.

.. method:: get_string(key, from_=False)

Note: This method has an extra parameter (*from_*) compared with other classes.
The first line of an mbox file entry is the Unix "From " line.
If *from_* is False, the first line of the file is dropped.

.. method:: lock()
unlock()
Expand Down
Loading