doc_content
stringlengths
1
386k
doc_id
stringlengths
5
188
clear() Remove the payload and all of the headers.
python.library.email.message#email.message.EmailMessage.clear
clear_content() Remove the payload and all of the Content- headers, leaving all other headers intact and in their original order.
python.library.email.message#email.message.EmailMessage.clear_content
defects The defects attribute contains a list of all the problems found when parsing this message. See email.errors for a detailed description of the possible parsing defects.
python.library.email.message#email.message.EmailMessage.defects
del_param(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. Optional header specifies an alternative to Content-Type. Use of the requote parameter with EmailMessage objects is depre...
python.library.email.message#email.message.EmailMessage.del_param
epilogue The epilogue attribute acts the same way as the preamble attribute, except that it contains text that appears between the last boundary and the end of the message. As with the preamble, if there is no epilog text this attribute will be None.
python.library.email.message#email.message.EmailMessage.epilogue
get(name, failobj=None) Return the value of the named header field. This is identical to __getitem__() except that optional failobj is returned if the named header is missing (failobj defaults to None).
python.library.email.message#email.message.EmailMessage.get
get_all(name, failobj=None) Return a list of all the values for the field named name. If there are no such named headers in the message, failobj is returned (defaults to None).
python.library.email.message#email.message.EmailMessage.get_all
get_body(preferencelist=('related', 'html', 'plain')) Return the MIME part that is the best candidate to be the “body” of the message. preferencelist must be a sequence of strings from the set related, html, and plain, and indicates the order of preference for the content type of the part returned. Start looking for ...
python.library.email.message#email.message.EmailMessage.get_body
get_boundary(failobj=None) Return the value of the boundary parameter of the Content-Type header of the message, or failobj if either the header is missing, or has no boundary parameter. The returned string will always be unquoted as per email.utils.unquote().
python.library.email.message#email.message.EmailMessage.get_boundary
get_charsets(failobj=None) Return a list containing the character set names in the message. If the message is a multipart, then the list will contain one element for each subpart in the payload, otherwise, it will be a list of length 1. Each item in the list will be a string which is the value of the charset paramete...
python.library.email.message#email.message.EmailMessage.get_charsets
get_content(*args, content_manager=None, **kw) Call the get_content() method of the content_manager, passing self as the message object, and passing along any other arguments or keywords as additional arguments. If content_manager is not specified, use the content_manager specified by the current policy.
python.library.email.message#email.message.EmailMessage.get_content
get_content_charset(failobj=None) Return the charset parameter of the Content-Type header, coerced to lower case. If there is no Content-Type header, or if that header has no charset parameter, failobj is returned.
python.library.email.message#email.message.EmailMessage.get_content_charset
get_content_disposition() Return the lowercased value (without parameters) of the message’s Content-Disposition header if it has one, or None. The possible values for this method are inline, attachment or None if the message follows RFC 2183. New in version 3.5.
python.library.email.message#email.message.EmailMessage.get_content_disposition
get_content_maintype() Return the message’s main content type. This is the maintype part of the string returned by get_content_type().
python.library.email.message#email.message.EmailMessage.get_content_maintype
get_content_subtype() Return the message’s sub-content type. This is the subtype part of the string returned by get_content_type().
python.library.email.message#email.message.EmailMessage.get_content_subtype
get_content_type() Return the message’s content type, coerced to lower case of the form maintype/subtype. If there is no Content-Type header in the message return the value returned by get_default_type(). If the Content-Type header is invalid, return text/plain. (According to RFC 2045, messages always have a default ...
python.library.email.message#email.message.EmailMessage.get_content_type
get_default_type() 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.
python.library.email.message#email.message.EmailMessage.get_default_type
get_filename(failobj=None) Return the value of the filename parameter of the Content-Disposition header of the message. If the header does not have a filename parameter, this method falls back to looking for the name parameter on the Content-Type header. If neither is found, or the header is missing, then failobj is ...
python.library.email.message#email.message.EmailMessage.get_filename
get_unixfrom() Return the message’s envelope header. Defaults to None if the envelope header was never set.
python.library.email.message#email.message.EmailMessage.get_unixfrom
is_attachment() Return True if there is a Content-Disposition header and its (case insensitive) value is attachment, False otherwise. Changed in version 3.4.2: is_attachment is now a method instead of a property, for consistency with is_multipart().
python.library.email.message#email.message.EmailMessage.is_attachment
is_multipart() Return True if the message’s payload is a list of sub-EmailMessage objects, otherwise return False. When is_multipart() returns False, the payload should be a string object (which might be a CTE encoded binary payload). Note that is_multipart() returning True does not necessarily mean that “msg.get_con...
python.library.email.message#email.message.EmailMessage.is_multipart
items() Return a list of 2-tuples containing all the message’s field headers and values.
python.library.email.message#email.message.EmailMessage.items
iter_attachments() Return an iterator over all of the immediate sub-parts of the message that are not candidate “body” parts. That is, skip the first occurrence of each of text/plain, text/html, multipart/related, or multipart/alternative (unless they are explicitly marked as attachments via Content-Disposition: atta...
python.library.email.message#email.message.EmailMessage.iter_attachments
iter_parts() Return an iterator over all of the immediate sub-parts of the message, which will be empty for a non-multipart. (See also walk().)
python.library.email.message#email.message.EmailMessage.iter_parts
keys() Return a list of all the message’s header field names.
python.library.email.message#email.message.EmailMessage.keys
make_alternative(boundary=None) Convert a non-multipart or a multipart/related into a multipart/alternative, moving any existing Content- headers and payload into a (new) first part of the multipart. If boundary is specified, use it as the boundary string in the multipart, otherwise leave the boundary to be automatic...
python.library.email.message#email.message.EmailMessage.make_alternative
make_mixed(boundary=None) Convert a non-multipart, a multipart/related, or a multipart-alternative into a multipart/mixed, moving any existing Content- headers and payload into a (new) first part of the multipart. If boundary is specified, use it as the boundary string in the multipart, otherwise leave the boundary t...
python.library.email.message#email.message.EmailMessage.make_mixed
make_related(boundary=None) Convert a non-multipart message into a multipart/related message, moving any existing Content- headers and payload into a (new) first part of the multipart. If boundary is specified, use it as the boundary string in the multipart, otherwise leave the boundary to be automatically created wh...
python.library.email.message#email.message.EmailMessage.make_related
preamble The format of a MIME document allows for some text between the blank line following the headers, and the first multipart boundary string. Normally, this text is never visible in a MIME-aware mail reader because it falls outside the standard MIME armor. However, when viewing the raw text of the message, or wh...
python.library.email.message#email.message.EmailMessage.preamble
replace_header(_name, _value) Replace a header. Replace the first header found in the message that matches _name, retaining header order and field name case of the original header. If no matching header is found, raise a KeyError.
python.library.email.message#email.message.EmailMessage.replace_header
set_boundary(boundary) Set the boundary parameter of the Content-Type header to boundary. set_boundary() will always quote boundary if necessary. A HeaderParseError is raised if the message object has no Content-Type header. Note that using this method is subtly different from deleting the old Content-Type header and...
python.library.email.message#email.message.EmailMessage.set_boundary
set_content(*args, content_manager=None, **kw) Call the set_content() method of the content_manager, passing self as the message object, and passing along any other arguments or keywords as additional arguments. If content_manager is not specified, use the content_manager specified by the current policy.
python.library.email.message#email.message.EmailMessage.set_content
set_default_type(ctype) Set the default content type. ctype should either be text/plain or message/rfc822, although this is not enforced. The default content type is not stored in the Content-Type header, so it only affects the return value of the get_content_type methods when no Content-Type header is present in the...
python.library.email.message#email.message.EmailMessage.set_default_type
set_param(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, replace its value with value. When header is Content-Type (the default) and the header does not yet exist in the message, ad...
python.library.email.message#email.message.EmailMessage.set_param
set_unixfrom(unixfrom) Set the message’s envelope header to unixfrom, which should be a string. (See mboxMessage for a brief description of this header.)
python.library.email.message#email.message.EmailMessage.set_unixfrom
values() Return a list of all the message’s field values.
python.library.email.message#email.message.EmailMessage.values
walk() The walk() method is an all-purpose generator which can be used to iterate over all the parts and subparts of a message object tree, in depth-first traversal order. You will typically use walk() as the iterator in a for loop; each iteration returns the next subpart. Here’s an example that prints the MIME type ...
python.library.email.message#email.message.EmailMessage.walk
__bytes__() Equivalent to as_bytes(). Allows bytes(msg) to produce a bytes object containing the serialized message.
python.library.email.message#email.message.EmailMessage.__bytes__
__contains__(name) Return True if the message object has a field named name. Matching is done without regard to case and name does not include the trailing colon. Used for the in operator. For example: if 'message-id' in myMessage: print('Message-ID:', myMessage['message-id'])
python.library.email.message#email.message.EmailMessage.__contains__
__delitem__(name) Delete all occurrences of the field with name name from the message’s headers. No exception is raised if the named field isn’t present in the headers.
python.library.email.message#email.message.EmailMessage.__delitem__
__getitem__(name) Return the value of the named header field. name does not include the colon field separator. If the header is missing, None is returned; a KeyError is never raised. Note that if the named field appears more than once in the message’s headers, exactly which of those field values will be returned is u...
python.library.email.message#email.message.EmailMessage.__getitem__
__len__() Return the total number of headers, including duplicates.
python.library.email.message#email.message.EmailMessage.__len__
__setitem__(name, val) Add a header to the message with field name name and value val. The field is appended to the end of the message’s existing headers. Note that this does not overwrite or delete any existing header with the same name. If you want to ensure that the new header is the only one present in the messag...
python.library.email.message#email.message.EmailMessage.__setitem__
__str__() Equivalent to as_string(policy=self.policy.clone(utf8=True)). Allows str(msg) to produce a string containing the serialized message in a readable format. Changed in version 3.4: the method was changed to use utf8=True, thus producing an RFC 6531-like message representation, instead of being a direct alias ...
python.library.email.message#email.message.EmailMessage.__str__
class email.message.Message(policy=compat32) If policy is specified (it must be an instance of a policy class) use the rules it specifies to update and serialize the representation of the message. If policy is not set, use the compat32 policy, which maintains backward compatibility with the Python 3.2 version of the ...
python.library.email.compat32-message#email.message.Message
add_header(_name, _value, **_params) Extended header setting. This method is similar to __setitem__() except that additional header parameters can be provided as keyword arguments. _name is the header field to add and _value is the primary value for the header. For each item in the keyword argument dictionary _params...
python.library.email.compat32-message#email.message.Message.add_header
as_bytes(unixfrom=False, policy=None) Return the entire message flattened as a bytes object. When optional unixfrom is true, the envelope header is included in the returned string. unixfrom defaults to False. The policy argument may be used to override the default policy obtained from the message instance. This can b...
python.library.email.compat32-message#email.message.Message.as_bytes
as_string(unixfrom=False, maxheaderlen=0, policy=None) Return the entire message flattened as a string. When optional unixfrom is true, the envelope header is included in the returned string. unixfrom defaults to False. For backward compatibility reasons, maxheaderlen defaults to 0, so if you want a different value y...
python.library.email.compat32-message#email.message.Message.as_string
attach(payload) Add the given payload to the current payload, which must be None or a list of Message objects before the call. After the call, the payload will always be a list of Message objects. If you want to set the payload to a scalar object (e.g. a string), use set_payload() instead. This is a legacy method. On...
python.library.email.compat32-message#email.message.Message.attach
defects The defects attribute contains a list of all the problems found when parsing this message. See email.errors for a detailed description of the possible parsing defects.
python.library.email.compat32-message#email.message.Message.defects
del_param(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 (the default is True). Optional header specifies an altern...
python.library.email.compat32-message#email.message.Message.del_param
epilogue The epilogue attribute acts the same way as the preamble attribute, except that it contains text that appears between the last boundary and the end of the message. You do not need to set the epilogue to the empty string in order for the Generator to print a newline at the end of the file.
python.library.email.compat32-message#email.message.Message.epilogue
get(name, failobj=None) Return the value of the named header field. This is identical to __getitem__() except that optional failobj is returned if the named header is missing (defaults to None).
python.library.email.compat32-message#email.message.Message.get
get_all(name, failobj=None) Return a list of all the values for the field named name. If there are no such named headers in the message, failobj is returned (defaults to None).
python.library.email.compat32-message#email.message.Message.get_all
get_boundary(failobj=None) Return the value of the boundary parameter of the Content-Type header of the message, or failobj if either the header is missing, or has no boundary parameter. The returned string will always be unquoted as per email.utils.unquote().
python.library.email.compat32-message#email.message.Message.get_boundary
get_charset() Return the Charset instance associated with the message’s payload. This is a legacy method. On the EmailMessage class it always returns None.
python.library.email.compat32-message#email.message.Message.get_charset
get_charsets(failobj=None) Return a list containing the character set names in the message. If the message is a multipart, then the list will contain one element for each subpart in the payload, otherwise, it will be a list of length 1. Each item in the list will be a string which is the value of the charset paramete...
python.library.email.compat32-message#email.message.Message.get_charsets
get_content_charset(failobj=None) Return the charset parameter of the Content-Type header, coerced to lower case. If there is no Content-Type header, or if that header has no charset parameter, failobj is returned. Note that this method differs from get_charset() which returns the Charset instance for the default enc...
python.library.email.compat32-message#email.message.Message.get_content_charset
get_content_disposition() Return the lowercased value (without parameters) of the message’s Content-Disposition header if it has one, or None. The possible values for this method are inline, attachment or None if the message follows RFC 2183. New in version 3.5.
python.library.email.compat32-message#email.message.Message.get_content_disposition
get_content_maintype() Return the message’s main content type. This is the maintype part of the string returned by get_content_type().
python.library.email.compat32-message#email.message.Message.get_content_maintype
get_content_subtype() Return the message’s sub-content type. This is the subtype part of the string returned by get_content_type().
python.library.email.compat32-message#email.message.Message.get_content_subtype
get_content_type() 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, get_co...
python.library.email.compat32-message#email.message.Message.get_content_type
get_default_type() 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.
python.library.email.compat32-message#email.message.Message.get_default_type
get_filename(failobj=None) Return the value of the filename parameter of the Content-Disposition header of the message. If the header does not have a filename parameter, this method falls back to looking for the name parameter on the Content-Type header. If neither is found, or the header is missing, then failobj is ...
python.library.email.compat32-message#email.message.Message.get_filename
get_param(param, failobj=None, header='content-type', unquote=True) Return the value of the Content-Type header’s parameter param as a string. If the message has no Content-Type header or if there is no such parameter, then failobj is returned (defaults to None). Optional header if given, specifies the message header...
python.library.email.compat32-message#email.message.Message.get_param
get_params(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 ...
python.library.email.compat32-message#email.message.Message.get_params
get_payload(i=None, decode=False) Return the current payload, which will be a list of Message objects when is_multipart() is True, or a string when is_multipart() is False. If the payload is a list and you mutate the list object, you modify the message’s payload in place. With optional argument i, get_payload() will ...
python.library.email.compat32-message#email.message.Message.get_payload
get_unixfrom() Return the message’s envelope header. Defaults to None if the envelope header was never set.
python.library.email.compat32-message#email.message.Message.get_unixfrom
is_multipart() Return True if the message’s payload is a list of sub-Message objects, otherwise return False. When is_multipart() returns False, the payload should be a string object (which might be a CTE encoded binary payload). (Note that is_multipart() returning True does not necessarily mean that “msg.get_content...
python.library.email.compat32-message#email.message.Message.is_multipart
items() Return a list of 2-tuples containing all the message’s field headers and values.
python.library.email.compat32-message#email.message.Message.items
keys() Return a list of all the message’s header field names.
python.library.email.compat32-message#email.message.Message.keys
preamble The format of a MIME document allows for some text between the blank line following the headers, and the first multipart boundary string. Normally, this text is never visible in a MIME-aware mail reader because it falls outside the standard MIME armor. However, when viewing the raw text of the message, or wh...
python.library.email.compat32-message#email.message.Message.preamble
replace_header(_name, _value) Replace a header. Replace the first header found in the message that matches _name, retaining header order and field name case. If no matching header was found, a KeyError is raised.
python.library.email.compat32-message#email.message.Message.replace_header
set_boundary(boundary) Set the boundary parameter of the Content-Type header to boundary. set_boundary() will always quote boundary if necessary. A HeaderParseError is raised if the message object has no Content-Type header. Note that using this method is subtly different than deleting the old Content-Type header and...
python.library.email.compat32-message#email.message.Message.set_boundary
set_charset(charset) Set the character set of the payload to charset, which can either be a Charset instance (see email.charset), 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 hea...
python.library.email.compat32-message#email.message.Message.set_charset
set_default_type(ctype) Set the default content type. ctype should either be text/plain or message/rfc822, although this is not enforced. The default content type is not stored in the Content-Type header.
python.library.email.compat32-message#email.message.Message.set_default_type
set_param(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 value. If the Content-Type header as not yet been defined for this message, it will be set t...
python.library.email.compat32-message#email.message.Message.set_param
set_payload(payload, charset=None) Set the entire message object’s payload to payload. It is the client’s responsibility to ensure the payload invariants. Optional charset sets the message’s default character set; see set_charset() for details. This is a legacy method. On the EmailMessage class its functionality is r...
python.library.email.compat32-message#email.message.Message.set_payload
set_type(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 e...
python.library.email.compat32-message#email.message.Message.set_type
set_unixfrom(unixfrom) Set the message’s envelope header to unixfrom, which should be a string.
python.library.email.compat32-message#email.message.Message.set_unixfrom
values() Return a list of all the message’s field values.
python.library.email.compat32-message#email.message.Message.values
walk() The walk() method is an all-purpose generator which can be used to iterate over all the parts and subparts of a message object tree, in depth-first traversal order. You will typically use walk() as the iterator in a for loop; each iteration returns the next subpart. Here’s an example that prints the MIME type ...
python.library.email.compat32-message#email.message.Message.walk
__bytes__() Equivalent to as_bytes(). Allows bytes(msg) to produce a bytes object containing the formatted message. New in version 3.4.
python.library.email.compat32-message#email.message.Message.__bytes__
__contains__(name) Return True if the message object has a field named name. Matching is done case-insensitively and name should not include the trailing colon. Used for the in operator, e.g.: if 'message-id' in myMessage: print('Message-ID:', myMessage['message-id'])
python.library.email.compat32-message#email.message.Message.__contains__
__delitem__(name) Delete all occurrences of the field with name name from the message’s headers. No exception is raised if the named field isn’t present in the headers.
python.library.email.compat32-message#email.message.Message.__delitem__
__getitem__(name) Return the value of the named header field. name should not include the colon field separator. If the header is missing, None is returned; a KeyError is never raised. Note that if the named field appears more than once in the message’s headers, exactly which of those field values will be returned is...
python.library.email.compat32-message#email.message.Message.__getitem__
__len__() Return the total number of headers, including duplicates.
python.library.email.compat32-message#email.message.Message.__len__
__setitem__(name, val) Add a header to the message with field name name and value val. The field is appended to the end of the message’s existing fields. Note that this does not overwrite or delete any existing header with the same name. If you want to ensure that the new header is the only one present in the message...
python.library.email.compat32-message#email.message.Message.__setitem__
__str__() Equivalent to as_string(). Allows str(msg) to produce a string containing the formatted message.
python.library.email.compat32-message#email.message.Message.__str__
class email.message.MIMEPart(policy=default) This class represents a subpart of a MIME message. It is identical to EmailMessage, except that no MIME-Version headers are added when set_content() is called, since sub-parts do not need their own MIME-Version headers.
python.library.email.message#email.message.MIMEPart
email.message_from_binary_file(fp, _class=None, *, policy=policy.compat32) Return a message object structure tree from an open binary file object. This is equivalent to BytesParser().parse(fp). _class and policy are interpreted as with the BytesParser class constructor. New in version 3.2. Changed in version 3.3: ...
python.library.email.parser#email.message_from_binary_file
email.message_from_bytes(s, _class=None, *, policy=policy.compat32) Return a message object structure from a bytes-like object. This is equivalent to BytesParser().parsebytes(s). Optional _class and policy are interpreted as with the BytesParser class constructor. New in version 3.2. Changed in version 3.3: Remove...
python.library.email.parser#email.message_from_bytes
email.message_from_file(fp, _class=None, *, policy=policy.compat32) Return a message object structure tree from an open file object. This is equivalent to Parser().parse(fp). _class and policy are interpreted as with the Parser class constructor. Changed in version 3.3: Removed the strict argument. Added the policy ...
python.library.email.parser#email.message_from_file
email.message_from_string(s, _class=None, *, policy=policy.compat32) Return a message object structure from a string. This is equivalent to Parser().parsestr(s). _class and policy are interpreted as with the Parser class constructor. Changed in version 3.3: Removed the strict argument. Added the policy keyword.
python.library.email.parser#email.message_from_string
class email.mime.application.MIMEApplication(_data, _subtype='octet-stream', _encoder=email.encoders.encode_base64, *, policy=compat32, **_params) Module: email.mime.application A subclass of MIMENonMultipart, the MIMEApplication class is used to represent MIME message objects of major type application. _data is a st...
python.library.email.mime#email.mime.application.MIMEApplication
class email.mime.audio.MIMEAudio(_audiodata, _subtype=None, _encoder=email.encoders.encode_base64, *, policy=compat32, **_params) Module: email.mime.audio A subclass of MIMENonMultipart, the MIMEAudio class is used to create MIME message objects of major type audio. _audiodata is a string containing the raw audio dat...
python.library.email.mime#email.mime.audio.MIMEAudio
class email.mime.base.MIMEBase(_maintype, _subtype, *, policy=compat32, **_params) Module: email.mime.base This is the base class for all the MIME-specific subclasses of Message. Ordinarily you won’t create instances specifically of MIMEBase, although you could. MIMEBase is provided primarily as a convenient base cla...
python.library.email.mime#email.mime.base.MIMEBase
class email.mime.image.MIMEImage(_imagedata, _subtype=None, _encoder=email.encoders.encode_base64, *, policy=compat32, **_params) Module: email.mime.image A subclass of MIMENonMultipart, the MIMEImage class is used to create MIME message objects of major type image. _imagedata is a string containing the raw image dat...
python.library.email.mime#email.mime.image.MIMEImage
class email.mime.message.MIMEMessage(_msg, _subtype='rfc822', *, policy=compat32) Module: email.mime.message A subclass of MIMENonMultipart, the MIMEMessage class is used to create MIME objects of main type message. _msg is used as the payload, and must be an instance of class Message (or a subclass thereof), otherwi...
python.library.email.mime#email.mime.message.MIMEMessage
class email.mime.multipart.MIMEMultipart(_subtype='mixed', boundary=None, _subparts=None, *, policy=compat32, **_params) Module: email.mime.multipart A subclass of MIMEBase, this is an intermediate base class for MIME messages that are multipart. Optional _subtype defaults to mixed, but can be used to specify the sub...
python.library.email.mime#email.mime.multipart.MIMEMultipart