Python Library Reference

Previous: 7.3.2.1 MaildirMessage Up: 7.3.2 Message objects Next: 7.3.2.3 MHMessage

---

7.3.2.2 mboxMessage

class mboxMessage(

[message])

A message with mbox-specific behaviors. Parameter message has the same meaning as with the Message constructor.

Messages in an mbox mailbox are stored together in a single file. The sender's envelope address and the time of delivery are typically stored in a line beginning with "From " that is used to indicate the start of a message, though there is considerable variation in the exact format of this data among mbox implementations. Flags that indicate the state of the message, such as whether it has been read or marked as important, are typically stored in Status: and X-Status: headers.

Conventional flags for mbox messages are as follows:

The "R" and "O" flags are stored in the Status: header, and the "D", "F", and "A" flags are stored in the X-Status: header. The flags and headers typically appear in the order mentioned.

mboxMessage instances offer the following methods:

get_from(

)

Return a string representing the "From " line that marks the start of the message in an mbox mailbox. The leading "From " and the trailing newline are excluded.

set_from(

from_[, time_=None])

Set the "From " line to from_, which should be specified without a leading "From " or trailing newline. For convenience, time_ may be specified and will be formatted appropriately and appended to from_. If time_ is specified, it should be a struct_time instance, a tuple suitable for passing to time.strftime(), or True (to use time.gmtime()).

get_flags(

)

Return a string specifying the flags that are currently set. If the message complies with the conventional format, the result is the concatenation in the following order of zero or one occurrence of each of "R", "O", "D", "F", and "A".

set_flags(

flags)

Set the flags specified by flags and unset all others. Parameter flags should be the concatenation in any order of zero or more occurrences of each of "R", "O", "D", "F", and "A".

add_flag(

flag)

Set the flag(s) specified by flag without changing other flags. To add more than one flag at a time, flag may be a string of more than one character.

remove_flag(

flag)

Unset the flag(s) specified by flag without changing other flags. To remove more than one flag at a time, flag maybe a string of more than one character.

When an mboxMessage instance is created based upon a MaildirMessage instance, a "From " line is generated based upon the MaildirMessage instance's delivery date, and the following conversions take place:

When an mboxMessage instance is created based upon an MHMessage instance, the following conversions take place:

When an mboxMessage instance is created based upon a BabylMessage instance, the following conversions take place:

When a Message instance is created based upon an MMDFMessage instance, the "From " line is copied and all flags directly correspond:

---

Python Library Reference

Previous: 7.3.2.1 MaildirMessage Up: 7.3.2 Message objects Next: 7.3.2.3 MHMessage

---

Release 2.5, documentation updated on 19th September, 2006.