2026-06-02 05:14 @216.73.216.198 CrawledBy Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; ClaudeBot/1.0; +claudebot@anthropic.com)
Markdown Format | JSON API | MCP Server Tool
Help on module mailbox: NAME mailbox - Read/write support for Maildir, mbox, MH, Babyl, and MMDF mailboxes. MODULE REFERENCE https://docs.python.org/3.10/library/mailbox.html The following documentation is automatically generated from the Python source files. It may be incomplete, incorrect or include features that are considered implementation detail and may vary between Python implementations. When in doubt, consult the module reference at the location listed above. CLASSES builtins.Exception(builtins.BaseException) Error ExternalClashError FormatError NoSuchMailboxError NotEmptyError builtins.object Mailbox MH Maildir email.message.Message(builtins.object) Message BabylMessage MHMessage MaildirMessage _mboxMMDF(_singlefileMailbox) MMDF mbox _mboxMMDFMessage(Message) MMDFMessage mboxMessage _singlefileMailbox(Mailbox) Babyl class Babyl(_singlefileMailbox) | Babyl(path, factory=None, create=True) | | An Rmail-style Babyl mailbox. | | Method resolution order: | Babyl | _singlefileMailbox | Mailbox | builtins.object | | Methods defined here: | | __init__(self, path, factory=None, create=True) | Initialize a Babyl mailbox. | | __setitem__(self, key, message) | Replace the keyed message; raise KeyError if it doesn't exist. | | add(self, message) | Add message and return assigned key. | | get_bytes(self, key) | Return a string representation or raise a KeyError. | | get_file(self, key) | Return a file-like representation or raise a KeyError. | | get_labels(self) | Return a list of user-defined labels in the mailbox. | | get_message(self, key) | Return a Message representation or raise a KeyError. | | remove(self, key) | Remove the keyed message; raise KeyError if it doesn't exist. | | ---------------------------------------------------------------------- | Methods inherited from _singlefileMailbox: | | __contains__(self, key) | Return True if the keyed message exists, False otherwise. | | __len__(self) | Return a count of messages in the mailbox. | | close(self) | Flush and close the mailbox. | | flush(self) | Write any pending changes to disk. | | iterkeys(self) | Return an iterator over keys. | | lock(self) | Lock the mailbox. | | unlock(self) | Unlock the mailbox if it is locked. | | ---------------------------------------------------------------------- | Methods inherited from Mailbox: | | __delitem__(self, key) | | __getitem__(self, key) | Return the keyed message; raise KeyError if it doesn't exist. | | __iter__(self) | | clear(self) | Delete all messages. | | discard(self, key) | If the keyed message exists, remove it. | | get(self, key, default=None) | Return the keyed message, or default if it doesn't exist. | | get_string(self, key) | Return a string representation or raise a KeyError. | | Uses email.message.Message to create a 7bit clean string | representation of the message. | | items(self) | Return a list of (key, message) tuples. Memory intensive. | | iteritems(self) | Return an iterator over (key, message) tuples. | | itervalues(self) | Return an iterator over all messages. | | keys(self) | Return a list of keys. | | pop(self, key, default=None) | Delete the keyed message and return it, or default. | | popitem(self) | Delete an arbitrary (key, message) pair and return it. | | update(self, arg=None) | Change the messages that correspond to certain keys. | | values(self) | Return a list of messages. Memory intensive. | | ---------------------------------------------------------------------- | Class methods inherited from Mailbox: | | __class_getitem__ = GenericAlias(...) from builtins.type | Represent a PEP 585 generic type | | E.g. for t = list[int], t.__origin__ is list and t.__args__ is (int,). | | ---------------------------------------------------------------------- | Data descriptors inherited from Mailbox: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) class BabylMessage(Message) | BabylMessage(message=None) | | Message with Babyl-specific properties. | | Method resolution order: | BabylMessage | Message | email.message.Message | builtins.object | | Methods defined here: | | __init__(self, message=None) | Initialize a BabylMessage instance. | | add_label(self, label) | Add label to list of labels on the message. | | get_labels(self) | Return a list of labels on the message. | | get_visible(self) | Return a Message representation of visible headers. | | remove_label(self, label) | Remove label from the list of labels on the message. | | set_labels(self, labels) | Set the list of labels on the message. | | set_visible(self, visible) | Set the Message representation of visible headers. | | update_visible(self) | Update and/or sensibly generate a set of visible headers. | | ---------------------------------------------------------------------- | Methods inherited from email.message.Message: | | __bytes__(self) | Return the entire formatted message as a bytes object. | | __contains__(self, name) | | __delitem__(self, name) | Delete all occurrences of a header, if present. | | Does not raise an exception if the header is missing. | | __getitem__(self, name) | Get a header value. | | Return None if the header is missing instead of raising an exception. | | Note that if the header appeared multiple times, exactly which | occurrence gets returned is undefined. Use get_all() to get all | the values matching a header field name. | | __iter__(self) | | __len__(self) | Return the total number of headers, including duplicates. | | __setitem__(self, name, val) | Set the value of a header. | | Note: this does not overwrite an existing header with the same field | name. Use __delitem__() first to delete any existing headers. | | __str__(self) | Return the entire formatted message as a string. | | add_header(self, _name, _value, **_params) | Extended header setting. | | name is the header field to add. keyword arguments can be used to set | additional parameters for the header field, with underscores converted | to dashes. Normally the parameter will be added as key="value" unless | value is None, in which case only the key will be added. If a | parameter value contains non-ASCII characters it can be specified as a | three-tuple of (charset, language, value), in which case it will be | encoded according to RFC2231 rules. Otherwise it will be encoded using | the utf-8 charset and a language of ''. | | Examples: | | msg.add_header('content-disposition', 'attachment', filename='bud.gif') | msg.add_header('content-disposition', 'attachment', | filename=('utf-8', '', Fußballer.ppt')) | msg.add_header('content-disposition', 'attachment', | filename='Fußballer.ppt')) | | as_bytes(self, unixfrom=False, policy=None) | Return the entire formatted message as a bytes object. | | Optional 'unixfrom', when true, means include the Unix From_ envelope | header. 'policy' is passed to the BytesGenerator instance used to | serialize the message; if not specified the policy associated with | the message instance is used. | | as_string(self, unixfrom=False, maxheaderlen=0, policy=None) | Return the entire formatted message as a string. | | Optional 'unixfrom', when true, means include the Unix From_ envelope | header. For backward compatibility reasons, if maxheaderlen is | not specified it defaults to 0, so you must override it explicitly | if you want a different maxheaderlen. 'policy' is passed to the | Generator instance used to serialize the message; if it is not | specified the policy associated with the message instance is used. | | If the message object contains binary data that is not encoded | according to RFC standards, the non-compliant data will be replaced by | unicode "unknown character" code points. | | attach(self, payload) | Add the given payload to the current payload. | | The current payload will always be a list of objects after this method | is called. If you want to set the payload to a scalar object, use | set_payload() instead. | | del_param(self, param, header='content-type', requote=True) | Remove the given parameter completely from the Content-Type header. | | The header will be re-written in place without the parameter or its | value. All values will be quoted as necessary unless requote is | False. Optional header specifies an alternative to the Content-Type | header. | | get(self, name, failobj=None) | Get a header value. | | Like __getitem__() but return failobj instead of None when the field | is missing. | | get_all(self, name, failobj=None) | Return a list of all the values for the named field. | | These will be sorted in the order they appeared in the original | message, and may contain duplicates. Any fields deleted and | re-inserted are always appended to the header list. | | If no such fields exist, failobj is returned (defaults to None). | | get_boundary(self, failobj=None) | Return the boundary associated with the payload if present. | | The boundary is extracted from the Content-Type header's `boundary' | parameter, and it is unquoted. | | get_charset(self) | Return the Charset instance associated with the message's payload. | | get_charsets(self, failobj=None) | Return a list containing the charset(s) used in this message. | | The returned list of items describes the Content-Type headers' | charset parameter for this message and all the subparts in its | payload. | | Each item will either be a string (the value of the charset parameter | in the Content-Type header of that part) or the value of the | 'failobj' parameter (defaults to None), if the part does not have a | main MIME type of "text", or the charset is not defined. | | The list will contain one string for each part of the message, plus | one for the container message (i.e. self), so that a non-multipart | message will still return a list of length 1. | | get_content_charset(self, failobj=None) | Return the charset parameter of the Content-Type header. | | The returned string is always coerced to lower case. If there is no | Content-Type header, or if that header has no charset parameter, | failobj is returned. | | get_content_disposition(self) | Return the message's content-disposition if it exists, or None. | | The return values can be either 'inline', 'attachment' or None | according to the rfc2183. | | get_content_maintype(self) | Return the message's main content type. | | This is the `maintype' part of the string returned by | get_content_type(). | | get_content_subtype(self) | Returns the message's sub-content type. | | This is the `subtype' part of the string returned by | get_content_type(). | | get_content_type(self) | Return the message's content type. | | The returned string is coerced to lower case of the form | `maintype/subtype'. If there was no Content-Type header in the | message, the default type as given by get_default_type() will be | returned. Since according to RFC 2045, messages always have a default | type this will always return a value. | | RFC 2045 defines a message's default type to be text/plain unless it | appears inside a multipart/digest container, in which case it would be | message/rfc822. | | get_default_type(self) | Return the `default' content type. | | Most messages have a default content type of text/plain, except for | messages that are subparts of multipart/digest containers. Such | subparts have a default content type of message/rfc822. | | get_filename(self, failobj=None) | Return the filename associated with the payload if present. | | The filename is extracted from the Content-Disposition header's | `filename' parameter, and it is unquoted. If that header is missing | the `filename' parameter, this method falls back to looking for the | `name' parameter. | | get_param(self, param, failobj=None, header='content-type', unquote=True) | Return the parameter value if found in the Content-Type header. | | Optional failobj is the object to return if there is no Content-Type | header, or the Content-Type header has no such parameter. Optional | header is the header to search instead of Content-Type. | | Parameter keys are always compared case insensitively. The return | value can either be a string, or a 3-tuple if the parameter was RFC | 2231 encoded. When it's a 3-tuple, the elements of the value are of | the form (CHARSET, LANGUAGE, VALUE). Note that both CHARSET and | LANGUAGE can be None, in which case you should consider VALUE to be | encoded in the us-ascii charset. You can usually ignore LANGUAGE. | The parameter value (either the returned string, or the VALUE item in | the 3-tuple) is always unquoted, unless unquote is set to False. | | If your application doesn't care whether the parameter was RFC 2231 | encoded, it can turn the return value into a string as follows: | | rawparam = msg.get_param('foo') | param = email.utils.collapse_rfc2231_value(rawparam) | | get_params(self, failobj=None, header='content-type', unquote=True) | Return the message's Content-Type parameters, as a list. | | The elements of the returned list are 2-tuples of key/value pairs, as | split on the `=' sign. The left hand side of the `=' is the key, | while the right hand side is the value. If there is no `=' sign in | the parameter the value is the empty string. The value is as | described in the get_param() method. | | Optional failobj is the object to return if there is no Content-Type | header. Optional header is the header to search instead of | Content-Type. If unquote is True, the value is unquoted. | | get_payload(self, i=None, decode=False) | Return a reference to the payload. | | The payload will either be a list object or a string. If you mutate | the list object, you modify the message's payload in place. Optional | i returns that index into the payload. | | Optional decode is a flag indicating whether the payload should be | decoded or not, according to the Content-Transfer-Encoding header | (default is False). | | When True and the message is not a multipart, the payload will be | decoded if this header's value is `quoted-printable' or `base64'. If | some other encoding is used, or the header is missing, or if the | payload has bogus data (i.e. bogus base64 or uuencoded data), the | payload is returned as-is. | | If the message is a multipart and the decode flag is True, then None | is returned. | | get_unixfrom(self) | | is_multipart(self) | Return True if the message consists of multiple parts. | | items(self) | Get all the message's header fields and values. | | These will be sorted in the order they appeared in the original | message, or were added to the message, and may contain duplicates. | Any fields deleted and re-inserted are always appended to the header | list. | | keys(self) | Return a list of all the message's header field names. | | These will be sorted in the order they appeared in the original | message, or were added to the message, and may contain duplicates. | Any fields deleted and re-inserted are always appended to the header | list. | | raw_items(self) | Return the (name, value) header pairs without modification. | | This is an "internal" API, intended only for use by a generator. | | replace_header(self, _name, _value) | Replace a header. | | Replace the first matching header found in the message, retaining | header order and case. If no matching header was found, a KeyError is | raised. | | set_boundary(self, boundary) | Set the boundary parameter in Content-Type to 'boundary'. | | This is subtly different than deleting the Content-Type header and | adding a new one with a new boundary parameter via add_header(). The | main difference is that using the set_boundary() method preserves the | order of the Content-Type header in the original message. | | HeaderParseError is raised if the message has no Content-Type header. | | set_charset(self, charset) | Set the charset of the payload to a given character set. | | charset can be a Charset instance, a string naming a character set, or | None. If it is a string it will be converted to a Charset instance. | If charset is None, the charset parameter will be removed from the | Content-Type field. Anything else will generate a TypeError. | | The message will be assumed to be of type text/* encoded with | charset.input_charset. It will be converted to charset.output_charset | and encoded properly, if needed, when generating the plain text | representation of the message. MIME headers (MIME-Version, | Content-Type, Content-Transfer-Encoding) will be added as needed. | | set_default_type(self, ctype) | Set the `default' content type. | | ctype should be either "text/plain" or "message/rfc822", although this | is not enforced. The default content type is not stored in the | Content-Type header. | | set_param(self, param, value, header='Content-Type', requote=True, charset=None, language='', replace=False) | Set a parameter in the Content-Type header. | | If the parameter already exists in the header, its value will be | replaced with the new value. | | If header is Content-Type and has not yet been defined for this | message, it will be set to "text/plain" and the new parameter and | value will be appended as per RFC 2045. | | An alternate header can be specified in the header argument, and all | parameters will be quoted as necessary unless requote is False. | | If charset is specified, the parameter will be encoded according to RFC | 2231. Optional language specifies the RFC 2231 language, defaulting | to the empty string. Both charset and language should be strings. | | set_payload(self, payload, charset=None) | Set the payload to the given value. | | Optional charset sets the message's default character set. See | set_charset() for details. | | set_raw(self, name, value) | Store name and value in the model without modification. | | This is an "internal" API, intended only for use by a parser. | | set_type(self, type, header='Content-Type', requote=True) | Set the main type and subtype for the Content-Type header. | | type must be a string in the form "maintype/subtype", otherwise a | ValueError is raised. | | This method replaces the Content-Type header, keeping all the | parameters in place. If requote is False, this leaves the existing | header's quoting as is. Otherwise, the parameters will be quoted (the | default). | | An alternative header can be specified in the header argument. When | the Content-Type header is set, we'll always also add a MIME-Version | header. | | set_unixfrom(self, unixfrom) | # Unix From_ line | | values(self) | Return a list of all the message's header values. | | These will be sorted in the order they appeared in the original | message, or were added to the message, and may contain duplicates. | Any fields deleted and re-inserted are always appended to the header | list. | | walk(self) | Walk over the message tree, yielding each subpart. | | The walk is performed in depth-first order. This method is a | generator. | | ---------------------------------------------------------------------- | Data descriptors inherited from email.message.Message: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) class Error(builtins.Exception) | Raised for module-specific errors. | | Method resolution order: | Error | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors defined here: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Methods inherited from builtins.Exception: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args class ExternalClashError(Error) | Another process caused an action to fail. | | Method resolution order: | ExternalClashError | Error | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors inherited from Error: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Methods inherited from builtins.Exception: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args class FormatError(Error) | A file appears to have an invalid format. | | Method resolution order: | FormatError | Error | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors inherited from Error: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Methods inherited from builtins.Exception: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args class MH(Mailbox) | MH(path, factory=None, create=True) | | An MH mailbox. | | Method resolution order: | MH | Mailbox | builtins.object | | Methods defined here: | | __contains__(self, key) | Return True if the keyed message exists, False otherwise. | | __init__(self, path, factory=None, create=True) | Initialize an MH instance. | | __len__(self) | Return a count of messages in the mailbox. | | __setitem__(self, key, message) | Replace the keyed message; raise KeyError if it doesn't exist. | | add(self, message) | Add message and return assigned key. | | add_folder(self, folder) | Create a folder and return an MH instance representing it. | | close(self) | Flush and close the mailbox. | | flush(self) | Write any pending changes to the disk. | | get_bytes(self, key) | Return a bytes representation or raise a KeyError. | | get_file(self, key) | Return a file-like representation or raise a KeyError. | | get_folder(self, folder) | Return an MH instance for the named folder. | | get_message(self, key) | Return a Message representation or raise a KeyError. | | get_sequences(self) | Return a name-to-key-list dictionary to define each sequence. | | iterkeys(self) | Return an iterator over keys. | | list_folders(self) | Return a list of folder names. | | lock(self) | Lock the mailbox. | | pack(self) | Re-name messages to eliminate numbering gaps. Invalidates keys. | | remove(self, key) | Remove the keyed message; raise KeyError if it doesn't exist. | | remove_folder(self, folder) | Delete the named folder, which must be empty. | | set_sequences(self, sequences) | Set sequences using the given name-to-key-list dictionary. | | unlock(self) | Unlock the mailbox if it is locked. | | ---------------------------------------------------------------------- | Methods inherited from Mailbox: | | __delitem__(self, key) | | __getitem__(self, key) | Return the keyed message; raise KeyError if it doesn't exist. | | __iter__(self) | | clear(self) | Delete all messages. | | discard(self, key) | If the keyed message exists, remove it. | | get(self, key, default=None) | Return the keyed message, or default if it doesn't exist. | | get_string(self, key) | Return a string representation or raise a KeyError. | | Uses email.message.Message to create a 7bit clean string | representation of the message. | | items(self) | Return a list of (key, message) tuples. Memory intensive. | | iteritems(self) | Return an iterator over (key, message) tuples. | | itervalues(self) | Return an iterator over all messages. | | keys(self) | Return a list of keys. | | pop(self, key, default=None) | Delete the keyed message and return it, or default. | | popitem(self) | Delete an arbitrary (key, message) pair and return it. | | update(self, arg=None) | Change the messages that correspond to certain keys. | | values(self) | Return a list of messages. Memory intensive. | | ---------------------------------------------------------------------- | Class methods inherited from Mailbox: | | __class_getitem__ = GenericAlias(...) from builtins.type | Represent a PEP 585 generic type | | E.g. for t = list[int], t.__origin__ is list and t.__args__ is (int,). | | ---------------------------------------------------------------------- | Data descriptors inherited from Mailbox: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) class MHMessage(Message) | MHMessage(message=None) | | Message with MH-specific properties. | | Method resolution order: | MHMessage | Message | email.message.Message | builtins.object | | Methods defined here: | | __init__(self, message=None) | Initialize an MHMessage instance. | | add_sequence(self, sequence) | Add sequence to list of sequences including the message. | | get_sequences(self) | Return a list of sequences that include the message. | | remove_sequence(self, sequence) | Remove sequence from the list of sequences including the message. | | set_sequences(self, sequences) | Set the list of sequences that include the message. | | ---------------------------------------------------------------------- | Methods inherited from email.message.Message: | | __bytes__(self) | Return the entire formatted message as a bytes object. | | __contains__(self, name) | | __delitem__(self, name) | Delete all occurrences of a header, if present. | | Does not raise an exception if the header is missing. | | __getitem__(self, name) | Get a header value. | | Return None if the header is missing instead of raising an exception. | | Note that if the header appeared multiple times, exactly which | occurrence gets returned is undefined. Use get_all() to get all | the values matching a header field name. | | __iter__(self) | | __len__(self) | Return the total number of headers, including duplicates. | | __setitem__(self, name, val) | Set the value of a header. | | Note: this does not overwrite an existing header with the same field | name. Use __delitem__() first to delete any existing headers. | | __str__(self) | Return the entire formatted message as a string. | | add_header(self, _name, _value, **_params) | Extended header setting. | | name is the header field to add. keyword arguments can be used to set | additional parameters for the header field, with underscores converted | to dashes. Normally the parameter will be added as key="value" unless | value is None, in which case only the key will be added. If a | parameter value contains non-ASCII characters it can be specified as a | three-tuple of (charset, language, value), in which case it will be | encoded according to RFC2231 rules. Otherwise it will be encoded using | the utf-8 charset and a language of ''. | | Examples: | | msg.add_header('content-disposition', 'attachment', filename='bud.gif') | msg.add_header('content-disposition', 'attachment', | filename=('utf-8', '', Fußballer.ppt')) | msg.add_header('content-disposition', 'attachment', | filename='Fußballer.ppt')) | | as_bytes(self, unixfrom=False, policy=None) | Return the entire formatted message as a bytes object. | | Optional 'unixfrom', when true, means include the Unix From_ envelope | header. 'policy' is passed to the BytesGenerator instance used to | serialize the message; if not specified the policy associated with | the message instance is used. | | as_string(self, unixfrom=False, maxheaderlen=0, policy=None) | Return the entire formatted message as a string. | | Optional 'unixfrom', when true, means include the Unix From_ envelope | header. For backward compatibility reasons, if maxheaderlen is | not specified it defaults to 0, so you must override it explicitly | if you want a different maxheaderlen. 'policy' is passed to the | Generator instance used to serialize the message; if it is not | specified the policy associated with the message instance is used. | | If the message object contains binary data that is not encoded | according to RFC standards, the non-compliant data will be replaced by | unicode "unknown character" code points. | | attach(self, payload) | Add the given payload to the current payload. | | The current payload will always be a list of objects after this method | is called. If you want to set the payload to a scalar object, use | set_payload() instead. | | del_param(self, param, header='content-type', requote=True) | Remove the given parameter completely from the Content-Type header. | | The header will be re-written in place without the parameter or its | value. All values will be quoted as necessary unless requote is | False. Optional header specifies an alternative to the Content-Type | header. | | get(self, name, failobj=None) | Get a header value. | | Like __getitem__() but return failobj instead of None when the field | is missing. | | get_all(self, name, failobj=None) | Return a list of all the values for the named field. | | These will be sorted in the order they appeared in the original | message, and may contain duplicates. Any fields deleted and | re-inserted are always appended to the header list. | | If no such fields exist, failobj is returned (defaults to None). | | get_boundary(self, failobj=None) | Return the boundary associated with the payload if present. | | The boundary is extracted from the Content-Type header's `boundary' | parameter, and it is unquoted. | | get_charset(self) | Return the Charset instance associated with the message's payload. | | get_charsets(self, failobj=None) | Return a list containing the charset(s) used in this message. | | The returned list of items describes the Content-Type headers' | charset parameter for this message and all the subparts in its | payload. | | Each item will either be a string (the value of the charset parameter | in the Content-Type header of that part) or the value of the | 'failobj' parameter (defaults to None), if the part does not have a | main MIME type of "text", or the charset is not defined. | | The list will contain one string for each part of the message, plus | one for the container message (i.e. self), so that a non-multipart | message will still return a list of length 1. | | get_content_charset(self, failobj=None) | Return the charset parameter of the Content-Type header. | | The returned string is always coerced to lower case. If there is no | Content-Type header, or if that header has no charset parameter, | failobj is returned. | | get_content_disposition(self) | Return the message's content-disposition if it exists, or None. | | The return values can be either 'inline', 'attachment' or None | according to the rfc2183. | | get_content_maintype(self) | Return the message's main content type. | | This is the `maintype' part of the string returned by | get_content_type(). | | get_content_subtype(self) | Returns the message's sub-content type. | | This is the `subtype' part of the string returned by | get_content_type(). | | get_content_type(self) | Return the message's content type. | | The returned string is coerced to lower case of the form | `maintype/subtype'. If there was no Content-Type header in the | message, the default type as given by get_default_type() will be | returned. Since according to RFC 2045, messages always have a default | type this will always return a value. | | RFC 2045 defines a message's default type to be text/plain unless it | appears inside a multipart/digest container, in which case it would be | message/rfc822. | | get_default_type(self) | Return the `default' content type. | | Most messages have a default content type of text/plain, except for | messages that are subparts of multipart/digest containers. Such | subparts have a default content type of message/rfc822. | | get_filename(self, failobj=None) | Return the filename associated with the payload if present. | | The filename is extracted from the Content-Disposition header's | `filename' parameter, and it is unquoted. If that header is missing | the `filename' parameter, this method falls back to looking for the | `name' parameter. | | get_param(self, param, failobj=None, header='content-type', unquote=True) | Return the parameter value if found in the Content-Type header. | | Optional failobj is the object to return if there is no Content-Type | header, or the Content-Type header has no such parameter. Optional | header is the header to search instead of Content-Type. | | Parameter keys are always compared case insensitively. The return | value can either be a string, or a 3-tuple if the parameter was RFC | 2231 encoded. When it's a 3-tuple, the elements of the value are of | the form (CHARSET, LANGUAGE, VALUE). Note that both CHARSET and | LANGUAGE can be None, in which case you should consider VALUE to be | encoded in the us-ascii charset. You can usually ignore LANGUAGE. | The parameter value (either the returned string, or the VALUE item in | the 3-tuple) is always unquoted, unless unquote is set to False. | | If your application doesn't care whether the parameter was RFC 2231 | encoded, it can turn the return value into a string as follows: | | rawparam = msg.get_param('foo') | param = email.utils.collapse_rfc2231_value(rawparam) | | get_params(self, failobj=None, header='content-type', unquote=True) | Return the message's Content-Type parameters, as a list. | | The elements of the returned list are 2-tuples of key/value pairs, as | split on the `=' sign. The left hand side of the `=' is the key, | while the right hand side is the value. If there is no `=' sign in | the parameter the value is the empty string. The value is as | described in the get_param() method. | | Optional failobj is the object to return if there is no Content-Type | header. Optional header is the header to search instead of | Content-Type. If unquote is True, the value is unquoted. | | get_payload(self, i=None, decode=False) | Return a reference to the payload. | | The payload will either be a list object or a string. If you mutate | the list object, you modify the message's payload in place. Optional | i returns that index into the payload. | | Optional decode is a flag indicating whether the payload should be | decoded or not, according to the Content-Transfer-Encoding header | (default is False). | | When True and the message is not a multipart, the payload will be | decoded if this header's value is `quoted-printable' or `base64'. If | some other encoding is used, or the header is missing, or if the | payload has bogus data (i.e. bogus base64 or uuencoded data), the | payload is returned as-is. | | If the message is a multipart and the decode flag is True, then None | is returned. | | get_unixfrom(self) | | is_multipart(self) | Return True if the message consists of multiple parts. | | items(self) | Get all the message's header fields and values. | | These will be sorted in the order they appeared in the original | message, or were added to the message, and may contain duplicates. | Any fields deleted and re-inserted are always appended to the header | list. | | keys(self) | Return a list of all the message's header field names. | | These will be sorted in the order they appeared in the original | message, or were added to the message, and may contain duplicates. | Any fields deleted and re-inserted are always appended to the header | list. | | raw_items(self) | Return the (name, value) header pairs without modification. | | This is an "internal" API, intended only for use by a generator. | | replace_header(self, _name, _value) | Replace a header. | | Replace the first matching header found in the message, retaining | header order and case. If no matching header was found, a KeyError is | raised. | | set_boundary(self, boundary) | Set the boundary parameter in Content-Type to 'boundary'. | | This is subtly different than deleting the Content-Type header and | adding a new one with a new boundary parameter via add_header(). The | main difference is that using the set_boundary() method preserves the | order of the Content-Type header in the original message. | | HeaderParseError is raised if the message has no Content-Type header. | | set_charset(self, charset) | Set the charset of the payload to a given character set. | | charset can be a Charset instance, a string naming a character set, or | None. If it is a string it will be converted to a Charset instance. | If charset is None, the charset parameter will be removed from the | Content-Type field. Anything else will generate a TypeError. | | The message will be assumed to be of type text/* encoded with | charset.input_charset. It will be converted to charset.output_charset | and encoded properly, if needed, when generating the plain text | representation of the message. MIME headers (MIME-Version, | Content-Type, Content-Transfer-Encoding) will be added as needed. | | set_default_type(self, ctype) | Set the `default' content type. | | ctype should be either "text/plain" or "message/rfc822", although this | is not enforced. The default content type is not stored in the | Content-Type header. | | set_param(self, param, value, header='Content-Type', requote=True, charset=None, language='', replace=False) | Set a parameter in the Content-Type header. | | If the parameter already exists in the header, its value will be | replaced with the new value. | | If header is Content-Type and has not yet been defined for this | message, it will be set to "text/plain" and the new parameter and | value will be appended as per RFC 2045. | | An alternate header can be specified in the header argument, and all | parameters will be quoted as necessary unless requote is False. | | If charset is specified, the parameter will be encoded according to RFC | 2231. Optional language specifies the RFC 2231 language, defaulting | to the empty string. Both charset and language should be strings. | | set_payload(self, payload, charset=None) | Set the payload to the given value. | | Optional charset sets the message's default character set. See | set_charset() for details. | | set_raw(self, name, value) | Store name and value in the model without modification. | | This is an "internal" API, intended only for use by a parser. | | set_type(self, type, header='Content-Type', requote=True) | Set the main type and subtype for the Content-Type header. | | type must be a string in the form "maintype/subtype", otherwise a | ValueError is raised. | | This method replaces the Content-Type header, keeping all the | parameters in place. If requote is False, this leaves the existing | header's quoting as is. Otherwise, the parameters will be quoted (the | default). | | An alternative header can be specified in the header argument. When | the Content-Type header is set, we'll always also add a MIME-Version | header. | | set_unixfrom(self, unixfrom) | # Unix From_ line | | values(self) | Return a list of all the message's header values. | | These will be sorted in the order they appeared in the original | message, or were added to the message, and may contain duplicates. | Any fields deleted and re-inserted are always appended to the header | list. | | walk(self) | Walk over the message tree, yielding each subpart. | | The walk is performed in depth-first order. This method is a | generator. | | ---------------------------------------------------------------------- | Data descriptors inherited from email.message.Message: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) class MMDF(_mboxMMDF) | MMDF(path, factory=None, create=True) | | An MMDF mailbox. | | Method resolution order: | MMDF | _mboxMMDF | _singlefileMailbox | Mailbox | builtins.object | | Methods defined here: | | __init__(self, path, factory=None, create=True) | Initialize an MMDF mailbox. | | ---------------------------------------------------------------------- | Methods inherited from _mboxMMDF: | | get_bytes(self, key, from_=False) | Return a string representation or raise a KeyError. | | get_file(self, key, from_=False) | Return a file-like representation or raise a KeyError. | | get_message(self, key) | Return a Message representation or raise a KeyError. | | get_string(self, key, from_=False) | Return a string representation or raise a KeyError. | | ---------------------------------------------------------------------- | Methods inherited from _singlefileMailbox: | | __contains__(self, key) | Return True if the keyed message exists, False otherwise. | | __len__(self) | Return a count of messages in the mailbox. | | __setitem__(self, key, message) | Replace the keyed message; raise KeyError if it doesn't exist. | | add(self, message) | Add message and return assigned key. | | close(self) | Flush and close the mailbox. | | flush(self) | Write any pending changes to disk. | | iterkeys(self) | Return an iterator over keys. | | lock(self) | Lock the mailbox. | | remove(self, key) | Remove the keyed message; raise KeyError if it doesn't exist. | | unlock(self) | Unlock the mailbox if it is locked. | | ---------------------------------------------------------------------- | Methods inherited from Mailbox: | | __delitem__(self, key) | | __getitem__(self, key) | Return the keyed message; raise KeyError if it doesn't exist. | | __iter__(self) | | clear(self) | Delete all messages. | | discard(self, key) | If the keyed message exists, remove it. | | get(self, key, default=None) | Return the keyed message, or default if it doesn't exist. | | items(self) | Return a list of (key, message) tuples. Memory intensive. | | iteritems(self) | Return an iterator over (key, message) tuples. | | itervalues(self) | Return an iterator over all messages. | | keys(self) | Return a list of keys. | | pop(self, key, default=None) | Delete the keyed message and return it, or default. | | popitem(self) | Delete an arbitrary (key, message) pair and return it. | | update(self, arg=None) | Change the messages that correspond to certain keys. | | values(self) | Return a list of messages. Memory intensive. | | ---------------------------------------------------------------------- | Class methods inherited from Mailbox: | | __class_getitem__ = GenericAlias(...) from builtins.type | Represent a PEP 585 generic type | | E.g. for t = list[int], t.__origin__ is list and t.__args__ is (int,). | | ---------------------------------------------------------------------- | Data descriptors inherited from Mailbox: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) class MMDFMessage(_mboxMMDFMessage) | MMDFMessage(message=None) | | Message with MMDF-specific properties. | | Method resolution order: | MMDFMessage | _mboxMMDFMessage | Message | email.message.Message | builtins.object | | Methods inherited from _mboxMMDFMessage: | | __init__(self, message=None) | Initialize an mboxMMDFMessage instance. | | add_flag(self, flag) | Set the given flag(s) without changing others. | | get_flags(self) | Return as a string the flags that are set. | | get_from(self) | Return contents of "From " line. | | remove_flag(self, flag) | Unset the given string flag(s) without changing others. | | set_flags(self, flags) | Set the given flags and unset all others. | | set_from(self, from_, time_=None) | Set "From " line, formatting and appending time_ if specified. | | ---------------------------------------------------------------------- | Methods inherited from email.message.Message: | | __bytes__(self) | Return the entire formatted message as a bytes object. | | __contains__(self, name) | | __delitem__(self, name) | Delete all occurrences of a header, if present. | | Does not raise an exception if the header is missing. | | __getitem__(self, name) | Get a header value. | | Return None if the header is missing instead of raising an exception. | | Note that if the header appeared multiple times, exactly which | occurrence gets returned is undefined. Use get_all() to get all | the values matching a header field name. | | __iter__(self) | | __len__(self) | Return the total number of headers, including duplicates. | | __setitem__(self, name, val) | Set the value of a header. | | Note: this does not overwrite an existing header with the same field | name. Use __delitem__() first to delete any existing headers. | | __str__(self) | Return the entire formatted message as a string. | | add_header(self, _name, _value, **_params) | Extended header setting. | | name is the header field to add. keyword arguments can be used to set | additional parameters for the header field, with underscores converted | to dashes. Normally the parameter will be added as key="value" unless | value is None, in which case only the key will be added. If a | parameter value contains non-ASCII characters it can be specified as a | three-tuple of (charset, language, value), in which case it will be | encoded according to RFC2231 rules. Otherwise it will be encoded using | the utf-8 charset and a language of ''. | | Examples: | | msg.add_header('content-disposition', 'attachment', filename='bud.gif') | msg.add_header('content-disposition', 'attachment', | filename=('utf-8', '', Fußballer.ppt')) | msg.add_header('content-disposition', 'attachment', | filename='Fußballer.ppt')) | | as_bytes(self, unixfrom=False, policy=None) | Return the entire formatted message as a bytes object. | | Optional 'unixfrom', when true, means include the Unix From_ envelope | header. 'policy' is passed to the BytesGenerator instance used to | serialize the message; if not specified the policy associated with | the message instance is used. | | as_string(self, unixfrom=False, maxheaderlen=0, policy=None) | Return the entire formatted message as a string. | | Optional 'unixfrom', when true, means include the Unix From_ envelope | header. For backward compatibility reasons, if maxheaderlen is | not specified it defaults to 0, so you must override it explicitly | if you want a different maxheaderlen. 'policy' is passed to the | Generator instance used to serialize the message; if it is not | specified the policy associated with the message instance is used. | | If the message object contains binary data that is not encoded | according to RFC standards, the non-compliant data will be replaced by | unicode "unknown character" code points. | | attach(self, payload) | Add the given payload to the current payload. | | The current payload will always be a list of objects after this method | is called. If you want to set the payload to a scalar object, use | set_payload() instead. | | del_param(self, param, header='content-type', requote=True) | Remove the given parameter completely from the Content-Type header. | | The header will be re-written in place without the parameter or its | value. All values will be quoted as necessary unless requote is | False. Optional header specifies an alternative to the Content-Type | header. | | get(self, name, failobj=None) | Get a header value. | | Like __getitem__() but return failobj instead of None when the field | is missing. | | get_all(self, name, failobj=None) | Return a list of all the values for the named field. | | These will be sorted in the order they appeared in the original | message, and may contain duplicates. Any fields deleted and | re-inserted are always appended to the header list. | | If no such fields exist, failobj is returned (defaults to None). | | get_boundary(self, failobj=None) | Return the boundary associated with the payload if present. | | The boundary is extracted from the Content-Type header's `boundary' | parameter, and it is unquoted. | | get_charset(self) | Return the Charset instance associated with the message's payload. | | get_charsets(self, failobj=None) | Return a list containing the charset(s) used in this message. | | The returned list of items describes the Content-Type headers' | charset parameter for this message and all the subparts in its | payload. | | Each item will either be a string (the value of the charset parameter | in the Content-Type header of that part) or the value of the | 'failobj' parameter (defaults to None), if the part does not have a | main MIME type of "text", or the charset is not defined. | | The list will contain one string for each part of the message, plus | one for the container message (i.e. self), so that a non-multipart | message will still return a list of length 1. | | get_content_charset(self, failobj=None) | Return the charset parameter of the Content-Type header. | | The returned string is always coerced to lower case. If there is no | Content-Type header, or if that header has no charset parameter, | failobj is returned. | | get_content_disposition(self) | Return the message's content-disposition if it exists, or None. | | The return values can be either 'inline', 'attachment' or None | according to the rfc2183. | | get_content_maintype(self) | Return the message's main content type. | | This is the `maintype' part of the string returned by | get_content_type(). | | get_content_subtype(self) | Returns the message's sub-content type. | | This is the `subtype' part of the string returned by | get_content_type(). | | get_content_type(self) | Return the message's content type. | | The returned string is coerced to lower case of the form | `maintype/subtype'. If there was no Content-Type header in the | message, the default type as given by get_default_type() will be | returned. Since according to RFC 2045, messages always have a default | type this will always return a value. | | RFC 2045 defines a message's default type to be text/plain unless it | appears inside a multipart/digest container, in which case it would be | message/rfc822. | | get_default_type(self) | Return the `default' content type. | | Most messages have a default content type of text/plain, except for | messages that are subparts of multipart/digest containers. Such | subparts have a default content type of message/rfc822. | | get_filename(self, failobj=None) | Return the filename associated with the payload if present. | | The filename is extracted from the Content-Disposition header's | `filename' parameter, and it is unquoted. If that header is missing | the `filename' parameter, this method falls back to looking for the | `name' parameter. | | get_param(self, param, failobj=None, header='content-type', unquote=True) | Return the parameter value if found in the Content-Type header. | | Optional failobj is the object to return if there is no Content-Type | header, or the Content-Type header has no such parameter. Optional | header is the header to search instead of Content-Type. | | Parameter keys are always compared case insensitively. The return | value can either be a string, or a 3-tuple if the parameter was RFC | 2231 encoded. When it's a 3-tuple, the elements of the value are of | the form (CHARSET, LANGUAGE, VALUE). Note that both CHARSET and | LANGUAGE can be None, in which case you should consider VALUE to be | encoded in the us-ascii charset. You can usually ignore LANGUAGE. | The parameter value (either the returned string, or the VALUE item in | the 3-tuple) is always unquoted, unless unquote is set to False. | | If your application doesn't care whether the parameter was RFC 2231 | encoded, it can turn the return value into a string as follows: | | rawparam = msg.get_param('foo') | param = email.utils.collapse_rfc2231_value(rawparam) | | get_params(self, failobj=None, header='content-type', unquote=True) | Return the message's Content-Type parameters, as a list. | | The elements of the returned list are 2-tuples of key/value pairs, as | split on the `=' sign. The left hand side of the `=' is the key, | while the right hand side is the value. If there is no `=' sign in | the parameter the value is the empty string. The value is as | described in the get_param() method. | | Optional failobj is the object to return if there is no Content-Type | header. Optional header is the header to search instead of | Content-Type. If unquote is True, the value is unquoted. | | get_payload(self, i=None, decode=False) | Return a reference to the payload. | | The payload will either be a list object or a string. If you mutate | the list object, you modify the message's payload in place. Optional | i returns that index into the payload. | | Optional decode is a flag indicating whether the payload should be | decoded or not, according to the Content-Transfer-Encoding header | (default is False). | | When True and the message is not a multipart, the payload will be | decoded if this header's value is `quoted-printable' or `base64'. If | some other encoding is used, or the header is missing, or if the | payload has bogus data (i.e. bogus base64 or uuencoded data), the | payload is returned as-is. | | If the message is a multipart and the decode flag is True, then None | is returned. | | get_unixfrom(self) | | is_multipart(self) | Return True if the message consists of multiple parts. | | items(self) | Get all the message's header fields and values. | | These will be sorted in the order they appeared in the original | message, or were added to the message, and may contain duplicates. | Any fields deleted and re-inserted are always appended to the header | list. | | keys(self) | Return a list of all the message's header field names. | | These will be sorted in the order they appeared in the original | message, or were added to the message, and may contain duplicates. | Any fields deleted and re-inserted are always appended to the header | list. | | raw_items(self) | Return the (name, value) header pairs without modification. | | This is an "internal" API, intended only for use by a generator. | | replace_header(self, _name, _value) | Replace a header. | | Replace the first matching header found in the message, retaining | header order and case. If no matching header was found, a KeyError is | raised. | | set_boundary(self, boundary) | Set the boundary parameter in Content-Type to 'boundary'. | | This is subtly different than deleting the Content-Type header and | adding a new one with a new boundary parameter via add_header(). The | main difference is that using the set_boundary() method preserves the | order of the Content-Type header in the original message. | | HeaderParseError is raised if the message has no Content-Type header. | | set_charset(self, charset) | Set the charset of the payload to a given character set. | | charset can be a Charset instance, a string naming a character set, or | None. If it is a string it will be converted to a Charset instance. | If charset is None, the charset parameter will be removed from the | Content-Type field. Anything else will generate a TypeError. | | The message will be assumed to be of type text/* encoded with | charset.input_charset. It will be converted to charset.output_charset | and encoded properly, if needed, when generating the plain text | representation of the message. MIME headers (MIME-Version, | Content-Type, Content-Transfer-Encoding) will be added as needed. | | set_default_type(self, ctype) | Set the `default' content type. | | ctype should be either "text/plain" or "message/rfc822", although this | is not enforced. The default content type is not stored in the | Content-Type header. | | set_param(self, param, value, header='Content-Type', requote=True, charset=None, language='', replace=False) | Set a parameter in the Content-Type header. | | If the parameter already exists in the header, its value will be | replaced with the new value. | | If header is Content-Type and has not yet been defined for this | message, it will be set to "text/plain" and the new parameter and | value will be appended as per RFC 2045. | | An alternate header can be specified in the header argument, and all | parameters will be quoted as necessary unless requote is False. | | If charset is specified, the parameter will be encoded according to RFC | 2231. Optional language specifies the RFC 2231 language, defaulting | to the empty string. Both charset and language should be strings. | | set_payload(self, payload, charset=None) | Set the payload to the given value. | | Optional charset sets the message's default character set. See | set_charset() for details. | | set_raw(self, name, value) | Store name and value in the model without modification. | | This is an "internal" API, intended only for use by a parser. | | set_type(self, type, header='Content-Type', requote=True) | Set the main type and subtype for the Content-Type header. | | type must be a string in the form "maintype/subtype", otherwise a | ValueError is raised. | | This method replaces the Content-Type header, keeping all the | parameters in place. If requote is False, this leaves the existing | header's quoting as is. Otherwise, the parameters will be quoted (the | default). | | An alternative header can be specified in the header argument. When | the Content-Type header is set, we'll always also add a MIME-Version | header. | | set_unixfrom(self, unixfrom) | # Unix From_ line | | values(self) | Return a list of all the message's header values. | | These will be sorted in the order they appeared in the original | message, or were added to the message, and may contain duplicates. | Any fields deleted and re-inserted are always appended to the header | list. | | walk(self) | Walk over the message tree, yielding each subpart. | | The walk is performed in depth-first order. This method is a | generator. | | ---------------------------------------------------------------------- | Data descriptors inherited from email.message.Message: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) class Mailbox(builtins.object) | Mailbox(path, factory=None, create=True) | | A group of messages in a particular place. | | Methods defined here: | | __contains__(self, key) | Return True if the keyed message exists, False otherwise. | | __delitem__(self, key) | | __getitem__(self, key) | Return the keyed message; raise KeyError if it doesn't exist. | | __init__(self, path, factory=None, create=True) | Initialize a Mailbox instance. | | __iter__(self) | | __len__(self) | Return a count of messages in the mailbox. | | __setitem__(self, key, message) | Replace the keyed message; raise KeyError if it doesn't exist. | | add(self, message) | Add message and return assigned key. | | clear(self) | Delete all messages. | | close(self) | Flush and close the mailbox. | | discard(self, key) | If the keyed message exists, remove it. | | flush(self) | Write any pending changes to the disk. | | get(self, key, default=None) | Return the keyed message, or default if it doesn't exist. | | get_bytes(self, key) | Return a byte string representation or raise a KeyError. | | get_file(self, key) | Return a file-like representation or raise a KeyError. | | get_message(self, key) | Return a Message representation or raise a KeyError. | | get_string(self, key) | Return a string representation or raise a KeyError. | | Uses email.message.Message to create a 7bit clean string | representation of the message. | | items(self) | Return a list of (key, message) tuples. Memory intensive. | | iteritems(self) | Return an iterator over (key, message) tuples. | | iterkeys(self) | Return an iterator over keys. | | itervalues(self) | Return an iterator over all messages. | | keys(self) | Return a list of keys. | | lock(self) | Lock the mailbox. | | pop(self, key, default=None) | Delete the keyed message and return it, or default. | | popitem(self) | Delete an arbitrary (key, message) pair and return it. | | remove(self, key) | Remove the keyed message; raise KeyError if it doesn't exist. | | unlock(self) | Unlock the mailbox if it is locked. | | update(self, arg=None) | Change the messages that correspond to certain keys. | | values(self) | Return a list of messages. Memory intensive. | | ---------------------------------------------------------------------- | Class methods defined here: | | __class_getitem__ = GenericAlias(...) from builtins.type | Represent a PEP 585 generic type | | E.g. for t = list[int], t.__origin__ is list and t.__args__ is (int,). | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) class Maildir(Mailbox) | Maildir(dirname, factory=None, create=True) | | A qmail-style Maildir mailbox. | | Method resolution order: | Maildir | Mailbox | builtins.object | | Methods defined here: | | __contains__(self, key) | Return True if the keyed message exists, False otherwise. | | __init__(self, dirname, factory=None, create=True) | Initialize a Maildir instance. | | __len__(self) | Return a count of messages in the mailbox. | | __setitem__(self, key, message) | Replace the keyed message; raise KeyError if it doesn't exist. | | add(self, message) | Add message and return assigned key. | | add_folder(self, folder) | Create a folder and return a Maildir instance representing it. | | clean(self) | Delete old files in "tmp". | | close(self) | Flush and close the mailbox. | | discard(self, key) | If the keyed message exists, remove it. | | flush(self) | Write any pending changes to disk. | | get_bytes(self, key) | Return a bytes representation or raise a KeyError. | | get_file(self, key) | Return a file-like representation or raise a KeyError. | | get_folder(self, folder) | Return a Maildir instance for the named folder. | | get_message(self, key) | Return a Message representation or raise a KeyError. | | iterkeys(self) | Return an iterator over keys. | | list_folders(self) | Return a list of folder names. | | lock(self) | Lock the mailbox. | | next(self) | Return the next message in a one-time iteration. | | remove(self, key) | Remove the keyed message; raise KeyError if it doesn't exist. | | remove_folder(self, folder) | Delete the named folder, which must be empty. | | unlock(self) | Unlock the mailbox if it is locked. | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | colon = ':' | | ---------------------------------------------------------------------- | Methods inherited from Mailbox: | | __delitem__(self, key) | | __getitem__(self, key) | Return the keyed message; raise KeyError if it doesn't exist. | | __iter__(self) | | clear(self) | Delete all messages. | | get(self, key, default=None) | Return the keyed message, or default if it doesn't exist. | | get_string(self, key) | Return a string representation or raise a KeyError. | | Uses email.message.Message to create a 7bit clean string | representation of the message. | | items(self) | Return a list of (key, message) tuples. Memory intensive. | | iteritems(self) | Return an iterator over (key, message) tuples. | | itervalues(self) | Return an iterator over all messages. | | keys(self) | Return a list of keys. | | pop(self, key, default=None) | Delete the keyed message and return it, or default. | | popitem(self) | Delete an arbitrary (key, message) pair and return it. | | update(self, arg=None) | Change the messages that correspond to certain keys. | | values(self) | Return a list of messages. Memory intensive. | | ---------------------------------------------------------------------- | Class methods inherited from Mailbox: | | __class_getitem__ = GenericAlias(...) from builtins.type | Represent a PEP 585 generic type | | E.g. for t = list[int], t.__origin__ is list and t.__args__ is (int,). | | ---------------------------------------------------------------------- | Data descriptors inherited from Mailbox: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) class MaildirMessage(Message) | MaildirMessage(message=None) | | Message with Maildir-specific properties. | | Method resolution order: | MaildirMessage | Message | email.message.Message | builtins.object | | Methods defined here: | | __init__(self, message=None) | Initialize a MaildirMessage instance. | | add_flag(self, flag) | Set the given flag(s) without changing others. | | get_date(self) | Return delivery date of message, in seconds since the epoch. | | get_flags(self) | Return as a string the flags that are set. | | get_info(self) | Get the message's "info" as a string. | | get_subdir(self) | Return 'new' or 'cur'. | | remove_flag(self, flag) | Unset the given string flag(s) without changing others. | | set_date(self, date) | Set delivery date of message, in seconds since the epoch. | | set_flags(self, flags) | Set the given flags and unset all others. | | set_info(self, info) | Set the message's "info" string. | | set_subdir(self, subdir) | Set subdir to 'new' or 'cur'. | | ---------------------------------------------------------------------- | Methods inherited from email.message.Message: | | __bytes__(self) | Return the entire formatted message as a bytes object. | | __contains__(self, name) | | __delitem__(self, name) | Delete all occurrences of a header, if present. | | Does not raise an exception if the header is missing. | | __getitem__(self, name) | Get a header value. | | Return None if the header is missing instead of raising an exception. | | Note that if the header appeared multiple times, exactly which | occurrence gets returned is undefined. Use get_all() to get all | the values matching a header field name. | | __iter__(self) | | __len__(self) | Return the total number of headers, including duplicates. | | __setitem__(self, name, val) | Set the value of a header. | | Note: this does not overwrite an existing header with the same field | name. Use __delitem__() first to delete any existing headers. | | __str__(self) | Return the entire formatted message as a string. | | add_header(self, _name, _value, **_params) | Extended header setting. | | name is the header field to add. keyword arguments can be used to set | additional parameters for the header field, with underscores converted | to dashes. Normally the parameter will be added as key="value" unless | value is None, in which case only the key will be added. If a | parameter value contains non-ASCII characters it can be specified as a | three-tuple of (charset, language, value), in which case it will be | encoded according to RFC2231 rules. Otherwise it will be encoded using | the utf-8 charset and a language of ''. | | Examples: | | msg.add_header('content-disposition', 'attachment', filename='bud.gif') | msg.add_header('content-disposition', 'attachment', | filename=('utf-8', '', Fußballer.ppt')) | msg.add_header('content-disposition', 'attachment', | filename='Fußballer.ppt')) | | as_bytes(self, unixfrom=False, policy=None) | Return the entire formatted message as a bytes object. | | Optional 'unixfrom', when true, means include the Unix From_ envelope | header. 'policy' is passed to the BytesGenerator instance used to | serialize the message; if not specified the policy associated with | the message instance is used. | | as_string(self, unixfrom=False, maxheaderlen=0, policy=None) | Return the entire formatted message as a string. | | Optional 'unixfrom', when true, means include the Unix From_ envelope | header. For backward compatibility reasons, if maxheaderlen is | not specified it defaults to 0, so you must override it explicitly | if you want a different maxheaderlen. 'policy' is passed to the | Generator instance used to serialize the message; if it is not | specified the policy associated with the message instance is used. | | If the message object contains binary data that is not encoded | according to RFC standards, the non-compliant data will be replaced by | unicode "unknown character" code points. | | attach(self, payload) | Add the given payload to the current payload. | | The current payload will always be a list of objects after this method | is called. If you want to set the payload to a scalar object, use | set_payload() instead. | | del_param(self, param, header='content-type', requote=True) | Remove the given parameter completely from the Content-Type header. | | The header will be re-written in place without the parameter or its | value. All values will be quoted as necessary unless requote is | False. Optional header specifies an alternative to the Content-Type | header. | | get(self, name, failobj=None) | Get a header value. | | Like __getitem__() but return failobj instead of None when the field | is missing. | | get_all(self, name, failobj=None) | Return a list of all the values for the named field. | | These will be sorted in the order they appeared in the original | message, and may contain duplicates. Any fields deleted and | re-inserted are always appended to the header list. | | If no such fields exist, failobj is returned (defaults to None). | | get_boundary(self, failobj=None) | Return the boundary associated with the payload if present. | | The boundary is extracted from the Content-Type header's `boundary' | parameter, and it is unquoted. | | get_charset(self) | Return the Charset instance associated with the message's payload. | | get_charsets(self, failobj=None) | Return a list containing the charset(s) used in this message. | | The returned list of items describes the Content-Type headers' | charset parameter for this message and all the subparts in its | payload. | | Each item will either be a string (the value of the charset parameter | in the Content-Type header of that part) or the value of the | 'failobj' parameter (defaults to None), if the part does not have a | main MIME type of "text", or the charset is not defined. | | The list will contain one string for each part of the message, plus | one for the container message (i.e. self), so that a non-multipart | message will still return a list of length 1. | | get_content_charset(self, failobj=None) | Return the charset parameter of the Content-Type header. | | The returned string is always coerced to lower case. If there is no | Content-Type header, or if that header has no charset parameter, | failobj is returned. | | get_content_disposition(self) | Return the message's content-disposition if it exists, or None. | | The return values can be either 'inline', 'attachment' or None | according to the rfc2183. | | get_content_maintype(self) | Return the message's main content type. | | This is the `maintype' part of the string returned by | get_content_type(). | | get_content_subtype(self) | Returns the message's sub-content type. | | This is the `subtype' part of the string returned by | get_content_type(). | | get_content_type(self) | Return the message's content type. | | The returned string is coerced to lower case of the form | `maintype/subtype'. If there was no Content-Type header in the | message, the default type as given by get_default_type() will be | returned. Since according to RFC 2045, messages always have a default | type this will always return a value. | | RFC 2045 defines a message's default type to be text/plain unless it | appears inside a multipart/digest container, in which case it would be | message/rfc822. | | get_default_type(self) | Return the `default' content type. | | Most messages have a default content type of text/plain, except for | messages that are subparts of multipart/digest containers. Such | subparts have a default content type of message/rfc822. | | get_filename(self, failobj=None) | Return the filename associated with the payload if present. | | The filename is extracted from the Content-Disposition header's | `filename' parameter, and it is unquoted. If that header is missing | the `filename' parameter, this method falls back to looking for the | `name' parameter. | | get_param(self, param, failobj=None, header='content-type', unquote=True) | Return the parameter value if found in the Content-Type header. | | Optional failobj is the object to return if there is no Content-Type | header, or the Content-Type header has no such parameter. Optional | header is the header to search instead of Content-Type. | | Parameter keys are always compared case insensitively. The return | value can either be a string, or a 3-tuple if the parameter was RFC | 2231 encoded. When it's a 3-tuple, the elements of the value are of | the form (CHARSET, LANGUAGE, VALUE). Note that both CHARSET and | LANGUAGE can be None, in which case you should consider VALUE to be | encoded in the us-ascii charset. You can usually ignore LANGUAGE. | The parameter value (either the returned string, or the VALUE item in | the 3-tuple) is always unquoted, unless unquote is set to False. | | If your application doesn't care whether the parameter was RFC 2231 | encoded, it can turn the return value into a string as follows: | | rawparam = msg.get_param('foo') | param = email.utils.collapse_rfc2231_value(rawparam) | | get_params(self, failobj=None, header='content-type', unquote=True) | Return the message's Content-Type parameters, as a list. | | The elements of the returned list are 2-tuples of key/value pairs, as | split on the `=' sign. The left hand side of the `=' is the key, | while the right hand side is the value. If there is no `=' sign in | the parameter the value is the empty string. The value is as | described in the get_param() method. | | Optional failobj is the object to return if there is no Content-Type | header. Optional header is the header to search instead of | Content-Type. If unquote is True, the value is unquoted. | | get_payload(self, i=None, decode=False) | Return a reference to the payload. | | The payload will either be a list object or a string. If you mutate | the list object, you modify the message's payload in place. Optional | i returns that index into the payload. | | Optional decode is a flag indicating whether the payload should be | decoded or not, according to the Content-Transfer-Encoding header | (default is False). | | When True and the message is not a multipart, the payload will be | decoded if this header's value is `quoted-printable' or `base64'. If | some other encoding is used, or the header is missing, or if the | payload has bogus data (i.e. bogus base64 or uuencoded data), the | payload is returned as-is. | | If the message is a multipart and the decode flag is True, then None | is returned. | | get_unixfrom(self) | | is_multipart(self) | Return True if the message consists of multiple parts. | | items(self) | Get all the message's header fields and values. | | These will be sorted in the order they appeared in the original | message, or were added to the message, and may contain duplicates. | Any fields deleted and re-inserted are always appended to the header | list. | | keys(self) | Return a list of all the message's header field names. | | These will be sorted in the order they appeared in the original | message, or were added to the message, and may contain duplicates. | Any fields deleted and re-inserted are always appended to the header | list. | | raw_items(self) | Return the (name, value) header pairs without modification. | | This is an "internal" API, intended only for use by a generator. | | replace_header(self, _name, _value) | Replace a header. | | Replace the first matching header found in the message, retaining | header order and case. If no matching header was found, a KeyError is | raised. | | set_boundary(self, boundary) | Set the boundary parameter in Content-Type to 'boundary'. | | This is subtly different than deleting the Content-Type header and | adding a new one with a new boundary parameter via add_header(). The | main difference is that using the set_boundary() method preserves the | order of the Content-Type header in the original message. | | HeaderParseError is raised if the message has no Content-Type header. | | set_charset(self, charset) | Set the charset of the payload to a given character set. | | charset can be a Charset instance, a string naming a character set, or | None. If it is a string it will be converted to a Charset instance. | If charset is None, the charset parameter will be removed from the | Content-Type field. Anything else will generate a TypeError. | | The message will be assumed to be of type text/* encoded with | charset.input_charset. It will be converted to charset.output_charset | and encoded properly, if needed, when generating the plain text | representation of the message. MIME headers (MIME-Version, | Content-Type, Content-Transfer-Encoding) will be added as needed. | | set_default_type(self, ctype) | Set the `default' content type. | | ctype should be either "text/plain" or "message/rfc822", although this | is not enforced. The default content type is not stored in the | Content-Type header. | | set_param(self, param, value, header='Content-Type', requote=True, charset=None, language='', replace=False) | Set a parameter in the Content-Type header. | | If the parameter already exists in the header, its value will be | replaced with the new value. | | If header is Content-Type and has not yet been defined for this | message, it will be set to "text/plain" and the new parameter and | value will be appended as per RFC 2045. | | An alternate header can be specified in the header argument, and all | parameters will be quoted as necessary unless requote is False. | | If charset is specified, the parameter will be encoded according to RFC | 2231. Optional language specifies the RFC 2231 language, defaulting | to the empty string. Both charset and language should be strings. | | set_payload(self, payload, charset=None) | Set the payload to the given value. | | Optional charset sets the message's default character set. See | set_charset() for details. | | set_raw(self, name, value) | Store name and value in the model without modification. | | This is an "internal" API, intended only for use by a parser. | | set_type(self, type, header='Content-Type', requote=True) | Set the main type and subtype for the Content-Type header. | | type must be a string in the form "maintype/subtype", otherwise a | ValueError is raised. | | This method replaces the Content-Type header, keeping all the | parameters in place. If requote is False, this leaves the existing | header's quoting as is. Otherwise, the parameters will be quoted (the | default). | | An alternative header can be specified in the header argument. When | the Content-Type header is set, we'll always also add a MIME-Version | header. | | set_unixfrom(self, unixfrom) | # Unix From_ line | | values(self) | Return a list of all the message's header values. | | These will be sorted in the order they appeared in the original | message, or were added to the message, and may contain duplicates. | Any fields deleted and re-inserted are always appended to the header | list. | | walk(self) | Walk over the message tree, yielding each subpart. | | The walk is performed in depth-first order. This method is a | generator. | | ---------------------------------------------------------------------- | Data descriptors inherited from email.message.Message: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) class Message(email.message.Message) | Message(message=None) | | Message with mailbox-format-specific properties. | | Method resolution order: | Message | email.message.Message | builtins.object | | Methods defined here: | | __init__(self, message=None) | Initialize a Message instance. | | ---------------------------------------------------------------------- | Methods inherited from email.message.Message: | | __bytes__(self) | Return the entire formatted message as a bytes object. | | __contains__(self, name) | | __delitem__(self, name) | Delete all occurrences of a header, if present. | | Does not raise an exception if the header is missing. | | __getitem__(self, name) | Get a header value. | | Return None if the header is missing instead of raising an exception. | | Note that if the header appeared multiple times, exactly which | occurrence gets returned is undefined. Use get_all() to get all | the values matching a header field name. | | __iter__(self) | | __len__(self) | Return the total number of headers, including duplicates. | | __setitem__(self, name, val) | Set the value of a header. | | Note: this does not overwrite an existing header with the same field | name. Use __delitem__() first to delete any existing headers. | | __str__(self) | Return the entire formatted message as a string. | | add_header(self, _name, _value, **_params) | Extended header setting. | | name is the header field to add. keyword arguments can be used to set | additional parameters for the header field, with underscores converted | to dashes. Normally the parameter will be added as key="value" unless | value is None, in which case only the key will be added. If a | parameter value contains non-ASCII characters it can be specified as a | three-tuple of (charset, language, value), in which case it will be | encoded according to RFC2231 rules. Otherwise it will be encoded using | the utf-8 charset and a language of ''. | | Examples: | | msg.add_header('content-disposition', 'attachment', filename='bud.gif') | msg.add_header('content-disposition', 'attachment', | filename=('utf-8', '', Fußballer.ppt')) | msg.add_header('content-disposition', 'attachment', | filename='Fußballer.ppt')) | | as_bytes(self, unixfrom=False, policy=None) | Return the entire formatted message as a bytes object. | | Optional 'unixfrom', when true, means include the Unix From_ envelope | header. 'policy' is passed to the BytesGenerator instance used to | serialize the message; if not specified the policy associated with | the message instance is used. | | as_string(self, unixfrom=False, maxheaderlen=0, policy=None) | Return the entire formatted message as a string. | | Optional 'unixfrom', when true, means include the Unix From_ envelope | header. For backward compatibility reasons, if maxheaderlen is | not specified it defaults to 0, so you must override it explicitly | if you want a different maxheaderlen. 'policy' is passed to the | Generator instance used to serialize the message; if it is not | specified the policy associated with the message instance is used. | | If the message object contains binary data that is not encoded | according to RFC standards, the non-compliant data will be replaced by | unicode "unknown character" code points. | | attach(self, payload) | Add the given payload to the current payload. | | The current payload will always be a list of objects after this method | is called. If you want to set the payload to a scalar object, use | set_payload() instead. | | del_param(self, param, header='content-type', requote=True) | Remove the given parameter completely from the Content-Type header. | | The header will be re-written in place without the parameter or its | value. All values will be quoted as necessary unless requote is | False. Optional header specifies an alternative to the Content-Type | header. | | get(self, name, failobj=None) | Get a header value. | | Like __getitem__() but return failobj instead of None when the field | is missing. | | get_all(self, name, failobj=None) | Return a list of all the values for the named field. | | These will be sorted in the order they appeared in the original | message, and may contain duplicates. Any fields deleted and | re-inserted are always appended to the header list. | | If no such fields exist, failobj is returned (defaults to None). | | get_boundary(self, failobj=None) | Return the boundary associated with the payload if present. | | The boundary is extracted from the Content-Type header's `boundary' | parameter, and it is unquoted. | | get_charset(self) | Return the Charset instance associated with the message's payload. | | get_charsets(self, failobj=None) | Return a list containing the charset(s) used in this message. | | The returned list of items describes the Content-Type headers' | charset parameter for this message and all the subparts in its | payload. | | Each item will either be a string (the value of the charset parameter | in the Content-Type header of that part) or the value of the | 'failobj' parameter (defaults to None), if the part does not have a | main MIME type of "text", or the charset is not defined. | | The list will contain one string for each part of the message, plus | one for the container message (i.e. self), so that a non-multipart | message will still return a list of length 1. | | get_content_charset(self, failobj=None) | Return the charset parameter of the Content-Type header. | | The returned string is always coerced to lower case. If there is no | Content-Type header, or if that header has no charset parameter, | failobj is returned. | | get_content_disposition(self) | Return the message's content-disposition if it exists, or None. | | The return values can be either 'inline', 'attachment' or None | according to the rfc2183. | | get_content_maintype(self) | Return the message's main content type. | | This is the `maintype' part of the string returned by | get_content_type(). | | get_content_subtype(self) | Returns the message's sub-content type. | | This is the `subtype' part of the string returned by | get_content_type(). | | get_content_type(self) | Return the message's content type. | | The returned string is coerced to lower case of the form | `maintype/subtype'. If there was no Content-Type header in the | message, the default type as given by get_default_type() will be | returned. Since according to RFC 2045, messages always have a default | type this will always return a value. | | RFC 2045 defines a message's default type to be text/plain unless it | appears inside a multipart/digest container, in which case it would be | message/rfc822. | | get_default_type(self) | Return the `default' content type. | | Most messages have a default content type of text/plain, except for | messages that are subparts of multipart/digest containers. Such | subparts have a default content type of message/rfc822. | | get_filename(self, failobj=None) | Return the filename associated with the payload if present. | | The filename is extracted from the Content-Disposition header's | `filename' parameter, and it is unquoted. If that header is missing | the `filename' parameter, this method falls back to looking for the | `name' parameter. | | get_param(self, param, failobj=None, header='content-type', unquote=True) | Return the parameter value if found in the Content-Type header. | | Optional failobj is the object to return if there is no Content-Type | header, or the Content-Type header has no such parameter. Optional | header is the header to search instead of Content-Type. | | Parameter keys are always compared case insensitively. The return | value can either be a string, or a 3-tuple if the parameter was RFC | 2231 encoded. When it's a 3-tuple, the elements of the value are of | the form (CHARSET, LANGUAGE, VALUE). Note that both CHARSET and | LANGUAGE can be None, in which case you should consider VALUE to be | encoded in the us-ascii charset. You can usually ignore LANGUAGE. | The parameter value (either the returned string, or the VALUE item in | the 3-tuple) is always unquoted, unless unquote is set to False. | | If your application doesn't care whether the parameter was RFC 2231 | encoded, it can turn the return value into a string as follows: | | rawparam = msg.get_param('foo') | param = email.utils.collapse_rfc2231_value(rawparam) | | get_params(self, failobj=None, header='content-type', unquote=True) | Return the message's Content-Type parameters, as a list. | | The elements of the returned list are 2-tuples of key/value pairs, as | split on the `=' sign. The left hand side of the `=' is the key, | while the right hand side is the value. If there is no `=' sign in | the parameter the value is the empty string. The value is as | described in the get_param() method. | | Optional failobj is the object to return if there is no Content-Type | header. Optional header is the header to search instead of | Content-Type. If unquote is True, the value is unquoted. | | get_payload(self, i=None, decode=False) | Return a reference to the payload. | | The payload will either be a list object or a string. If you mutate | the list object, you modify the message's payload in place. Optional | i returns that index into the payload. | | Optional decode is a flag indicating whether the payload should be | decoded or not, according to the Content-Transfer-Encoding header | (default is False). | | When True and the message is not a multipart, the payload will be | decoded if this header's value is `quoted-printable' or `base64'. If | some other encoding is used, or the header is missing, or if the | payload has bogus data (i.e. bogus base64 or uuencoded data), the | payload is returned as-is. | | If the message is a multipart and the decode flag is True, then None | is returned. | | get_unixfrom(self) | | is_multipart(self) | Return True if the message consists of multiple parts. | | items(self) | Get all the message's header fields and values. | | These will be sorted in the order they appeared in the original | message, or were added to the message, and may contain duplicates. | Any fields deleted and re-inserted are always appended to the header | list. | | keys(self) | Return a list of all the message's header field names. | | These will be sorted in the order they appeared in the original | message, or were added to the message, and may contain duplicates. | Any fields deleted and re-inserted are always appended to the header | list. | | raw_items(self) | Return the (name, value) header pairs without modification. | | This is an "internal" API, intended only for use by a generator. | | replace_header(self, _name, _value) | Replace a header. | | Replace the first matching header found in the message, retaining | header order and case. If no matching header was found, a KeyError is | raised. | | set_boundary(self, boundary) | Set the boundary parameter in Content-Type to 'boundary'. | | This is subtly different than deleting the Content-Type header and | adding a new one with a new boundary parameter via add_header(). The | main difference is that using the set_boundary() method preserves the | order of the Content-Type header in the original message. | | HeaderParseError is raised if the message has no Content-Type header. | | set_charset(self, charset) | Set the charset of the payload to a given character set. | | charset can be a Charset instance, a string naming a character set, or | None. If it is a string it will be converted to a Charset instance. | If charset is None, the charset parameter will be removed from the | Content-Type field. Anything else will generate a TypeError. | | The message will be assumed to be of type text/* encoded with | charset.input_charset. It will be converted to charset.output_charset | and encoded properly, if needed, when generating the plain text | representation of the message. MIME headers (MIME-Version, | Content-Type, Content-Transfer-Encoding) will be added as needed. | | set_default_type(self, ctype) | Set the `default' content type. | | ctype should be either "text/plain" or "message/rfc822", although this | is not enforced. The default content type is not stored in the | Content-Type header. | | set_param(self, param, value, header='Content-Type', requote=True, charset=None, language='', replace=False) | Set a parameter in the Content-Type header. | | If the parameter already exists in the header, its value will be | replaced with the new value. | | If header is Content-Type and has not yet been defined for this | message, it will be set to "text/plain" and the new parameter and | value will be appended as per RFC 2045. | | An alternate header can be specified in the header argument, and all | parameters will be quoted as necessary unless requote is False. | | If charset is specified, the parameter will be encoded according to RFC | 2231. Optional language specifies the RFC 2231 language, defaulting | to the empty string. Both charset and language should be strings. | | set_payload(self, payload, charset=None) | Set the payload to the given value. | | Optional charset sets the message's default character set. See | set_charset() for details. | | set_raw(self, name, value) | Store name and value in the model without modification. | | This is an "internal" API, intended only for use by a parser. | | set_type(self, type, header='Content-Type', requote=True) | Set the main type and subtype for the Content-Type header. | | type must be a string in the form "maintype/subtype", otherwise a | ValueError is raised. | | This method replaces the Content-Type header, keeping all the | parameters in place. If requote is False, this leaves the existing | header's quoting as is. Otherwise, the parameters will be quoted (the | default). | | An alternative header can be specified in the header argument. When | the Content-Type header is set, we'll always also add a MIME-Version | header. | | set_unixfrom(self, unixfrom) | # Unix From_ line | | values(self) | Return a list of all the message's header values. | | These will be sorted in the order they appeared in the original | message, or were added to the message, and may contain duplicates. | Any fields deleted and re-inserted are always appended to the header | list. | | walk(self) | Walk over the message tree, yielding each subpart. | | The walk is performed in depth-first order. This method is a | generator. | | ---------------------------------------------------------------------- | Data descriptors inherited from email.message.Message: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) class NoSuchMailboxError(Error) | The specified mailbox does not exist and won't be created. | | Method resolution order: | NoSuchMailboxError | Error | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors inherited from Error: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Methods inherited from builtins.Exception: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args class NotEmptyError(Error) | The specified mailbox is not empty and deletion was requested. | | Method resolution order: | NotEmptyError | Error | builtins.Exception | builtins.BaseException | builtins.object | | Data descriptors inherited from Error: | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Methods inherited from builtins.Exception: | | __init__(self, /, *args, **kwargs) | Initialize self. See help(type(self)) for accurate signature. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.Exception: | | __new__(*args, **kwargs) from builtins.type | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.BaseException: | | __delattr__(self, name, /) | Implement delattr(self, name). | | __getattribute__(self, name, /) | Return getattr(self, name). | | __reduce__(...) | Helper for pickle. | | __repr__(self, /) | Return repr(self). | | __setattr__(self, name, value, /) | Implement setattr(self, name, value). | | __setstate__(...) | | __str__(self, /) | Return str(self). | | with_traceback(...) | Exception.with_traceback(tb) -- | set self.__traceback__ to tb and return self. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.BaseException: | | __cause__ | exception cause | | __context__ | exception context | | __dict__ | | __suppress_context__ | | __traceback__ | | args class mbox(_mboxMMDF) | mbox(path, factory=None, create=True) | | A classic mbox mailbox. | | Method resolution order: | mbox | _mboxMMDF | _singlefileMailbox | Mailbox | builtins.object | | Methods defined here: | | __init__(self, path, factory=None, create=True) | Initialize an mbox mailbox. | | ---------------------------------------------------------------------- | Methods inherited from _mboxMMDF: | | get_bytes(self, key, from_=False) | Return a string representation or raise a KeyError. | | get_file(self, key, from_=False) | Return a file-like representation or raise a KeyError. | | get_message(self, key) | Return a Message representation or raise a KeyError. | | get_string(self, key, from_=False) | Return a string representation or raise a KeyError. | | ---------------------------------------------------------------------- | Methods inherited from _singlefileMailbox: | | __contains__(self, key) | Return True if the keyed message exists, False otherwise. | | __len__(self) | Return a count of messages in the mailbox. | | __setitem__(self, key, message) | Replace the keyed message; raise KeyError if it doesn't exist. | | add(self, message) | Add message and return assigned key. | | close(self) | Flush and close the mailbox. | | flush(self) | Write any pending changes to disk. | | iterkeys(self) | Return an iterator over keys. | | lock(self) | Lock the mailbox. | | remove(self, key) | Remove the keyed message; raise KeyError if it doesn't exist. | | unlock(self) | Unlock the mailbox if it is locked. | | ---------------------------------------------------------------------- | Methods inherited from Mailbox: | | __delitem__(self, key) | | __getitem__(self, key) | Return the keyed message; raise KeyError if it doesn't exist. | | __iter__(self) | | clear(self) | Delete all messages. | | discard(self, key) | If the keyed message exists, remove it. | | get(self, key, default=None) | Return the keyed message, or default if it doesn't exist. | | items(self) | Return a list of (key, message) tuples. Memory intensive. | | iteritems(self) | Return an iterator over (key, message) tuples. | | itervalues(self) | Return an iterator over all messages. | | keys(self) | Return a list of keys. | | pop(self, key, default=None) | Delete the keyed message and return it, or default. | | popitem(self) | Delete an arbitrary (key, message) pair and return it. | | update(self, arg=None) | Change the messages that correspond to certain keys. | | values(self) | Return a list of messages. Memory intensive. | | ---------------------------------------------------------------------- | Class methods inherited from Mailbox: | | __class_getitem__ = GenericAlias(...) from builtins.type | Represent a PEP 585 generic type | | E.g. for t = list[int], t.__origin__ is list and t.__args__ is (int,). | | ---------------------------------------------------------------------- | Data descriptors inherited from Mailbox: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) class mboxMessage(_mboxMMDFMessage) | mboxMessage(message=None) | | Message with mbox-specific properties. | | Method resolution order: | mboxMessage | _mboxMMDFMessage | Message | email.message.Message | builtins.object | | Methods inherited from _mboxMMDFMessage: | | __init__(self, message=None) | Initialize an mboxMMDFMessage instance. | | add_flag(self, flag) | Set the given flag(s) without changing others. | | get_flags(self) | Return as a string the flags that are set. | | get_from(self) | Return contents of "From " line. | | remove_flag(self, flag) | Unset the given string flag(s) without changing others. | | set_flags(self, flags) | Set the given flags and unset all others. | | set_from(self, from_, time_=None) | Set "From " line, formatting and appending time_ if specified. | | ---------------------------------------------------------------------- | Methods inherited from email.message.Message: | | __bytes__(self) | Return the entire formatted message as a bytes object. | | __contains__(self, name) | | __delitem__(self, name) | Delete all occurrences of a header, if present. | | Does not raise an exception if the header is missing. | | __getitem__(self, name) | Get a header value. | | Return None if the header is missing instead of raising an exception. | | Note that if the header appeared multiple times, exactly which | occurrence gets returned is undefined. Use get_all() to get all | the values matching a header field name. | | __iter__(self) | | __len__(self) | Return the total number of headers, including duplicates. | | __setitem__(self, name, val) | Set the value of a header. | | Note: this does not overwrite an existing header with the same field | name. Use __delitem__() first to delete any existing headers. | | __str__(self) | Return the entire formatted message as a string. | | add_header(self, _name, _value, **_params) | Extended header setting. | | name is the header field to add. keyword arguments can be used to set | additional parameters for the header field, with underscores converted | to dashes. Normally the parameter will be added as key="value" unless | value is None, in which case only the key will be added. If a | parameter value contains non-ASCII characters it can be specified as a | three-tuple of (charset, language, value), in which case it will be | encoded according to RFC2231 rules. Otherwise it will be encoded using | the utf-8 charset and a language of ''. | | Examples: | | msg.add_header('content-disposition', 'attachment', filename='bud.gif') | msg.add_header('content-disposition', 'attachment', | filename=('utf-8', '', Fußballer.ppt')) | msg.add_header('content-disposition', 'attachment', | filename='Fußballer.ppt')) | | as_bytes(self, unixfrom=False, policy=None) | Return the entire formatted message as a bytes object. | | Optional 'unixfrom', when true, means include the Unix From_ envelope | header. 'policy' is passed to the BytesGenerator instance used to | serialize the message; if not specified the policy associated with | the message instance is used. | | as_string(self, unixfrom=False, maxheaderlen=0, policy=None) | Return the entire formatted message as a string. | | Optional 'unixfrom', when true, means include the Unix From_ envelope | header. For backward compatibility reasons, if maxheaderlen is | not specified it defaults to 0, so you must override it explicitly | if you want a different maxheaderlen. 'policy' is passed to the | Generator instance used to serialize the message; if it is not | specified the policy associated with the message instance is used. | | If the message object contains binary data that is not encoded | according to RFC standards, the non-compliant data will be replaced by | unicode "unknown character" code points. | | attach(self, payload) | Add the given payload to the current payload. | | The current payload will always be a list of objects after this method | is called. If you want to set the payload to a scalar object, use | set_payload() instead. | | del_param(self, param, header='content-type', requote=True) | Remove the given parameter completely from the Content-Type header. | | The header will be re-written in place without the parameter or its | value. All values will be quoted as necessary unless requote is | False. Optional header specifies an alternative to the Content-Type | header. | | get(self, name, failobj=None) | Get a header value. | | Like __getitem__() but return failobj instead of None when the field | is missing. | | get_all(self, name, failobj=None) | Return a list of all the values for the named field. | | These will be sorted in the order they appeared in the original | message, and may contain duplicates. Any fields deleted and | re-inserted are always appended to the header list. | | If no such fields exist, failobj is returned (defaults to None). | | get_boundary(self, failobj=None) | Return the boundary associated with the payload if present. | | The boundary is extracted from the Content-Type header's `boundary' | parameter, and it is unquoted. | | get_charset(self) | Return the Charset instance associated with the message's payload. | | get_charsets(self, failobj=None) | Return a list containing the charset(s) used in this message. | | The returned list of items describes the Content-Type headers' | charset parameter for this message and all the subparts in its | payload. | | Each item will either be a string (the value of the charset parameter | in the Content-Type header of that part) or the value of the | 'failobj' parameter (defaults to None), if the part does not have a | main MIME type of "text", or the charset is not defined. | | The list will contain one string for each part of the message, plus | one for the container message (i.e. self), so that a non-multipart | message will still return a list of length 1. | | get_content_charset(self, failobj=None) | Return the charset parameter of the Content-Type header. | | The returned string is always coerced to lower case. If there is no | Content-Type header, or if that header has no charset parameter, | failobj is returned. | | get_content_disposition(self) | Return the message's content-disposition if it exists, or None. | | The return values can be either 'inline', 'attachment' or None | according to the rfc2183. | | get_content_maintype(self) | Return the message's main content type. | | This is the `maintype' part of the string returned by | get_content_type(). | | get_content_subtype(self) | Returns the message's sub-content type. | | This is the `subtype' part of the string returned by | get_content_type(). | | get_content_type(self) | Return the message's content type. | | The returned string is coerced to lower case of the form | `maintype/subtype'. If there was no Content-Type header in the | message, the default type as given by get_default_type() will be | returned. Since according to RFC 2045, messages always have a default | type this will always return a value. | | RFC 2045 defines a message's default type to be text/plain unless it | appears inside a multipart/digest container, in which case it would be | message/rfc822. | | get_default_type(self) | Return the `default' content type. | | Most messages have a default content type of text/plain, except for | messages that are subparts of multipart/digest containers. Such | subparts have a default content type of message/rfc822. | | get_filename(self, failobj=None) | Return the filename associated with the payload if present. | | The filename is extracted from the Content-Disposition header's | `filename' parameter, and it is unquoted. If that header is missing | the `filename' parameter, this method falls back to looking for the | `name' parameter. | | get_param(self, param, failobj=None, header='content-type', unquote=True) | Return the parameter value if found in the Content-Type header. | | Optional failobj is the object to return if there is no Content-Type | header, or the Content-Type header has no such parameter. Optional | header is the header to search instead of Content-Type. | | Parameter keys are always compared case insensitively. The return | value can either be a string, or a 3-tuple if the parameter was RFC | 2231 encoded. When it's a 3-tuple, the elements of the value are of | the form (CHARSET, LANGUAGE, VALUE). Note that both CHARSET and | LANGUAGE can be None, in which case you should consider VALUE to be | encoded in the us-ascii charset. You can usually ignore LANGUAGE. | The parameter value (either the returned string, or the VALUE item in | the 3-tuple) is always unquoted, unless unquote is set to False. | | If your application doesn't care whether the parameter was RFC 2231 | encoded, it can turn the return value into a string as follows: | | rawparam = msg.get_param('foo') | param = email.utils.collapse_rfc2231_value(rawparam) | | get_params(self, failobj=None, header='content-type', unquote=True) | Return the message's Content-Type parameters, as a list. | | The elements of the returned list are 2-tuples of key/value pairs, as | split on the `=' sign. The left hand side of the `=' is the key, | while the right hand side is the value. If there is no `=' sign in | the parameter the value is the empty string. The value is as | described in the get_param() method. | | Optional failobj is the object to return if there is no Content-Type | header. Optional header is the header to search instead of | Content-Type. If unquote is True, the value is unquoted. | | get_payload(self, i=None, decode=False) | Return a reference to the payload. | | The payload will either be a list object or a string. If you mutate | the list object, you modify the message's payload in place. Optional | i returns that index into the payload. | | Optional decode is a flag indicating whether the payload should be | decoded or not, according to the Content-Transfer-Encoding header | (default is False). | | When True and the message is not a multipart, the payload will be | decoded if this header's value is `quoted-printable' or `base64'. If | some other encoding is used, or the header is missing, or if the | payload has bogus data (i.e. bogus base64 or uuencoded data), the | payload is returned as-is. | | If the message is a multipart and the decode flag is True, then None | is returned. | | get_unixfrom(self) | | is_multipart(self) | Return True if the message consists of multiple parts. | | items(self) | Get all the message's header fields and values. | | These will be sorted in the order they appeared in the original | message, or were added to the message, and may contain duplicates. | Any fields deleted and re-inserted are always appended to the header | list. | | keys(self) | Return a list of all the message's header field names. | | These will be sorted in the order they appeared in the original | message, or were added to the message, and may contain duplicates. | Any fields deleted and re-inserted are always appended to the header | list. | | raw_items(self) | Return the (name, value) header pairs without modification. | | This is an "internal" API, intended only for use by a generator. | | replace_header(self, _name, _value) | Replace a header. | | Replace the first matching header found in the message, retaining | header order and case. If no matching header was found, a KeyError is | raised. | | set_boundary(self, boundary) | Set the boundary parameter in Content-Type to 'boundary'. | | This is subtly different than deleting the Content-Type header and | adding a new one with a new boundary parameter via add_header(). The | main difference is that using the set_boundary() method preserves the | order of the Content-Type header in the original message. | | HeaderParseError is raised if the message has no Content-Type header. | | set_charset(self, charset) | Set the charset of the payload to a given character set. | | charset can be a Charset instance, a string naming a character set, or | None. If it is a string it will be converted to a Charset instance. | If charset is None, the charset parameter will be removed from the | Content-Type field. Anything else will generate a TypeError. | | The message will be assumed to be of type text/* encoded with | charset.input_charset. It will be converted to charset.output_charset | and encoded properly, if needed, when generating the plain text | representation of the message. MIME headers (MIME-Version, | Content-Type, Content-Transfer-Encoding) will be added as needed. | | set_default_type(self, ctype) | Set the `default' content type. | | ctype should be either "text/plain" or "message/rfc822", although this | is not enforced. The default content type is not stored in the | Content-Type header. | | set_param(self, param, value, header='Content-Type', requote=True, charset=None, language='', replace=False) | Set a parameter in the Content-Type header. | | If the parameter already exists in the header, its value will be | replaced with the new value. | | If header is Content-Type and has not yet been defined for this | message, it will be set to "text/plain" and the new parameter and | value will be appended as per RFC 2045. | | An alternate header can be specified in the header argument, and all | parameters will be quoted as necessary unless requote is False. | | If charset is specified, the parameter will be encoded according to RFC | 2231. Optional language specifies the RFC 2231 language, defaulting | to the empty string. Both charset and language should be strings. | | set_payload(self, payload, charset=None) | Set the payload to the given value. | | Optional charset sets the message's default character set. See | set_charset() for details. | | set_raw(self, name, value) | Store name and value in the model without modification. | | This is an "internal" API, intended only for use by a parser. | | set_type(self, type, header='Content-Type', requote=True) | Set the main type and subtype for the Content-Type header. | | type must be a string in the form "maintype/subtype", otherwise a | ValueError is raised. | | This method replaces the Content-Type header, keeping all the | parameters in place. If requote is False, this leaves the existing | header's quoting as is. Otherwise, the parameters will be quoted (the | default). | | An alternative header can be specified in the header argument. When | the Content-Type header is set, we'll always also add a MIME-Version | header. | | set_unixfrom(self, unixfrom) | # Unix From_ line | | values(self) | Return a list of all the message's header values. | | These will be sorted in the order they appeared in the original | message, or were added to the message, and may contain duplicates. | Any fields deleted and re-inserted are always appended to the header | list. | | walk(self) | Walk over the message tree, yielding each subpart. | | The walk is performed in depth-first order. This method is a | generator. | | ---------------------------------------------------------------------- | Data descriptors inherited from email.message.Message: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) DATA __all__ = ['Mailbox', 'Maildir', 'mbox', 'MH', 'Babyl', 'MMDF', 'Messa... FILE /usr/lib/python3.10/mailbox.py
Generated by phpMan Author: Che Dong Under GNU General Public License
2026-06-02 05:14 @216.73.216.198 CrawledBy Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; ClaudeBot/1.0; +claudebot@anthropic.com)