neulab/docprompting-conala huggingface dataset:
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_maintype() == ‘multipart’” will return the True. For example, is_multipart will return True when the Message is of type message/rfc822.)
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.
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 adding a new one with the new boundary via add_header(), because set_boundary() preserves the order of the Content-Type header in the list of headers. However, it does not preserve any continuation lines which may have been present in the original Content-Type header.
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 header (the message will not be otherwise modified). Anything else will generate a TypeError. If there is no existing MIME-Version header one will be added. If there is no existing Content-Type header, one will be added with a value of text/plain. Whether the Content-Type header already exists or not, its charset parameter will be set to charset.output_charset. If charset.input_charset and charset.output_charset differ, the payload will be re-encoded to the output_charset. If there is no existing Content-Transfer-Encoding header, then the payload will be transfer-encoded, if needed, using the specified Charset, and a header with the appropriate value will be added. If a Content-Transfer-Encoding header already exists, the payload is assumed to already be correctly encoded using that Content-Transfer-Encoding and is not modified. This is a legacy method. On the EmailMessage class its functionality is replaced by the charset parameter of the email.emailmessage.EmailMessage.set_content() method.
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.
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 to text/plain and the new parameter value will be appended as per RFC 2045. Optional header specifies an alternative header to Content-Type, and all parameters will be quoted as necessary unless optional requote is False (the default is True). If optional 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. If replace is False (the default) the header is moved to the end of the list of headers. If replace is True, the header will be updated in place.  Changed in version 3.4: replace keyword was added.
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 replaced by set_content().
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 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 a MIME-Version header is also added. This is a legacy method. On the EmailMessage class its functionality is replaced by the make_ and add_ methods.
set_unixfrom(unixfrom)  
Set the message’s envelope header to unixfrom, which should be a string.
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 of every part of a multipart message structure: >>> for part in msg.walk():
...     print(part.get_content_type())
multipart/report
text/plain
message/delivery-status
text/plain
text/plain
message/rfc822
text/plain
 walk iterates over the subparts of any part where is_multipart() returns True, even though msg.get_content_maintype() == 'multipart' may return False. We can see this in our example by making use of the _structure debug helper function: >>> for part in msg.walk():
...     print(part.get_content_maintype() == 'multipart',
...           part.is_multipart())
True True
False False
False True
False False
False False
False True
False False
>>> _structure(msg)
multipart/report
    text/plain
    message/delivery-status
        text/plain
        text/plain
    message/rfc822
        text/plain
 Here the message parts are not multiparts, but they do contain subparts. is_multipart() returns True and walk descends into the subparts.
__bytes__()  
Equivalent to as_bytes(). Allows bytes(msg) to produce a bytes object containing the formatted message.  New in version 3.4.
__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'])
__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 undefined. Use the get_all() method to get the values of all the extant named headers.
__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 with field name name, delete the field first, e.g.: del msg['subject']
msg['subject'] = 'Python roolz!'
__str__()  
Equivalent to as_string(). Allows str(msg) to produce a string containing the formatted message.
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.
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: Removed the strict argument. Added the policy keyword.
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: Removed the strict argument. Added the policy keyword.
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 keyword.   Changed in version 3.6: _class defaults to the policy message_factory.
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.
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 string containing the raw byte data. Optional _subtype specifies the MIME subtype and defaults to octet-stream. Optional _encoder is a callable (i.e. function) which will perform the actual encoding of the data for transport. This callable takes one argument, which is the MIMEApplication instance. It should use get_payload() and set_payload() to change the payload to encoded form. It should also add any Content-Transfer-Encoding or other headers to the message object as necessary. The default encoding is base64. See the email.encoders module for a list of the built-in encoders. Optional policy argument defaults to compat32. _params are passed straight through to the base class constructor.  Changed in version 3.6: Added policy keyword-only parameter.
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 data. If this data can be decoded by the standard Python module sndhdr, then the subtype will be automatically included in the Content-Type header. Otherwise you can explicitly specify the audio subtype via the _subtype argument. If the minor type could not be guessed and _subtype was not given, then TypeError is raised. Optional _encoder is a callable (i.e. function) which will perform the actual encoding of the audio data for transport. This callable takes one argument, which is the MIMEAudio instance. It should use get_payload() and set_payload() to change the payload to encoded form. It should also add any Content-Transfer-Encoding or other headers to the message object as necessary. The default encoding is base64. See the email.encoders module for a list of the built-in encoders. Optional policy argument defaults to compat32. _params are passed straight through to the base class constructor.  Changed in version 3.6: Added policy keyword-only parameter.
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 class for more specific MIME-aware subclasses. _maintype is the Content-Type major type (e.g. text or image), and _subtype is the Content-Type minor type (e.g. plain or gif). _params is a parameter key/value dictionary and is passed directly to Message.add_header. If policy is specified, (defaults to the compat32 policy) it will be passed to Message. The MIMEBase class always adds a Content-Type header (based on _maintype, _subtype, and _params), and a MIME-Version header (always set to 1.0).  Changed in version 3.6: Added policy keyword-only parameter.
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 data. If this data can be decoded by the standard Python module imghdr, then the subtype will be automatically included in the Content-Type header. Otherwise you can explicitly specify the image subtype via the _subtype argument. If the minor type could not be guessed and _subtype was not given, then TypeError is raised. Optional _encoder is a callable (i.e. function) which will perform the actual encoding of the image data for transport. This callable takes one argument, which is the MIMEImage instance. It should use get_payload() and set_payload() to change the payload to encoded form. It should also add any Content-Transfer-Encoding or other headers to the message object as necessary. The default encoding is base64. See the email.encoders module for a list of the built-in encoders. Optional policy argument defaults to compat32. _params are passed straight through to the MIMEBase constructor.  Changed in version 3.6: Added policy keyword-only parameter.
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), otherwise a TypeError is raised. Optional _subtype sets the subtype of the message; it defaults to rfc822. Optional policy argument defaults to compat32.  Changed in version 3.6: Added policy keyword-only parameter.
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 subtype of the message. A Content-Type header of multipart/_subtype will be added to the message object. A MIME-Version header will also be added. Optional boundary is the multipart boundary string. When None (the default), the boundary is calculated when needed (for example, when the message is serialized). _subparts is a sequence of initial subparts for the payload. It must be possible to convert this sequence to a list. You can always attach new subparts to the message by using the Message.attach method. Optional policy argument defaults to compat32. Additional parameters for the Content-Type header are taken from the keyword arguments, or passed into the _params argument, which is a keyword dictionary.  Changed in version 3.6: Added policy keyword-only parameter.
class email.mime.nonmultipart.MIMENonMultipart  
Module: email.mime.nonmultipart A subclass of MIMEBase, this is an intermediate base class for MIME messages that are not multipart. The primary purpose of this class is to prevent the use of the attach() method, which only makes sense for multipart messages. If attach() is called, a MultipartConversionError exception is raised.
class email.mime.text.MIMEText(_text, _subtype='plain', _charset=None, *, policy=compat32)  
Module: email.mime.text A subclass of MIMENonMultipart, the MIMEText class is used to create MIME objects of major type text. _text is the string for the payload. _subtype is the minor type and defaults to plain. _charset is the character set of the text and is passed as an argument to the MIMENonMultipart constructor; it defaults to us-ascii if the string contains only ascii code points, and utf-8 otherwise. The _charset parameter accepts either a string or a Charset instance. Unless the _charset argument is explicitly set to None, the MIMEText object created will have both a Content-Type header with a charset parameter, and a Content-Transfer-Encoding header. This means that a subsequent set_payload call will not result in an encoded payload, even if a charset is passed in the set_payload command. You can “reset” this behavior by deleting the Content-Transfer-Encoding header, after which a set_payload call will automatically encode the new payload (and add a new Content-Transfer-Encoding header). Optional policy argument defaults to compat32.  Changed in version 3.5: _charset also accepts Charset instances.   Changed in version 3.6: Added policy keyword-only parameter.
class email.parser.BytesFeedParser(_factory=None, *, policy=policy.compat32)  
Create a BytesFeedParser instance. Optional _factory is a no-argument callable; if not specified use the message_factory from the policy. Call _factory whenever a new message object is needed. If policy is specified use the rules it specifies to update 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 email package and provides Message as the default factory. All other policies provide EmailMessage as the default _factory. For more information on what else policy controls, see the policy documentation. Note: The policy keyword should always be specified; The default will change to email.policy.default in a future version of Python.  New in version 3.2.   Changed in version 3.3: Added the policy keyword.   Changed in version 3.6: _factory defaults to the policy message_factory.   
feed(data)  
Feed the parser some more data. data should be a bytes-like object containing one or more lines. The lines can be partial and the parser will stitch such partial lines together properly. The lines can have any of the three common line endings: carriage return, newline, or carriage return and newline (they can even be mixed). 
  
close()  
Complete the parsing of all previously fed data and return the root message object. It is undefined what happens if feed() is called after this method has been called.
close()  
Complete the parsing of all previously fed data and return the root message object. It is undefined what happens if feed() is called after this method has been called.
feed(data)  
Feed the parser some more data. data should be a bytes-like object containing one or more lines. The lines can be partial and the parser will stitch such partial lines together properly. The lines can have any of the three common line endings: carriage return, newline, or carriage return and newline (they can even be mixed).
class email.parser.BytesHeaderParser(_class=None, *, policy=policy.compat32)  
Exactly like BytesParser, except that headersonly defaults to True.  New in version 3.3.
class email.parser.BytesParser(_class=None, *, policy=policy.compat32)  
Create a BytesParser instance. The _class and policy arguments have the same meaning and semantics as the _factory and policy arguments of BytesFeedParser. Note: The policy keyword should always be specified; The default will change to email.policy.default in a future version of Python.  Changed in version 3.3: Removed the strict argument that was deprecated in 2.4. Added the policy keyword.   Changed in version 3.6: _class defaults to the policy message_factory.   
parse(fp, headersonly=False)  
Read all the data from the binary file-like object fp, parse the resulting bytes, and return the message object. fp must support both the readline() and the read() methods. The bytes contained in fp must be formatted as a block of RFC 5322 (or, if utf8 is True, RFC 6532) style headers and header continuation lines, optionally preceded by an envelope header. The header block is terminated either by the end of the data or by a blank line. Following the header block is the body of the message (which may contain MIME-encoded subparts, including subparts with a Content-Transfer-Encoding of 8bit). Optional headersonly is a flag specifying whether to stop parsing after reading the headers or not. The default is False, meaning it parses the entire contents of the file. 
  
parsebytes(bytes, headersonly=False)  
Similar to the parse() method, except it takes a bytes-like object instead of a file-like object. Calling this method on a bytes-like object is equivalent to wrapping bytes in a BytesIO instance first and calling parse(). Optional headersonly is as with the parse() method. 
  New in version 3.2.
parse(fp, headersonly=False)  
Read all the data from the binary file-like object fp, parse the resulting bytes, and return the message object. fp must support both the readline() and the read() methods. The bytes contained in fp must be formatted as a block of RFC 5322 (or, if utf8 is True, RFC 6532) style headers and header continuation lines, optionally preceded by an envelope header. The header block is terminated either by the end of the data or by a blank line. Following the header block is the body of the message (which may contain MIME-encoded subparts, including subparts with a Content-Transfer-Encoding of 8bit). Optional headersonly is a flag specifying whether to stop parsing after reading the headers or not. The default is False, meaning it parses the entire contents of the file.
parsebytes(bytes, headersonly=False)  
Similar to the parse() method, except it takes a bytes-like object instead of a file-like object. Calling this method on a bytes-like object is equivalent to wrapping bytes in a BytesIO instance first and calling parse(). Optional headersonly is as with the parse() method.
class email.parser.FeedParser(_factory=None, *, policy=policy.compat32)  
Works like BytesFeedParser except that the input to the feed() method must be a string. This is of limited utility, since the only way for such a message to be valid is for it to contain only ASCII text or, if utf8 is True, no binary attachments.  Changed in version 3.3: Added the policy keyword.
class email.parser.HeaderParser(_class=None, *, policy=policy.compat32)  
Exactly like Parser, except that headersonly defaults to True.
class email.parser.Parser(_class=None, *, policy=policy.compat32)  
This class is parallel to BytesParser, but handles string input.  Changed in version 3.3: Removed the strict argument. Added the policy keyword.   Changed in version 3.6: _class defaults to the policy message_factory.   
parse(fp, headersonly=False)  
Read all the data from the text-mode file-like object fp, parse the resulting text, and return the root message object. fp must support both the readline() and the read() methods on file-like objects. Other than the text mode requirement, this method operates like BytesParser.parse(). 
  
parsestr(text, headersonly=False)  
Similar to the parse() method, except it takes a string object instead of a file-like object. Calling this method on a string is equivalent to wrapping text in a StringIO instance first and calling parse(). Optional headersonly is as with the parse() method.
parse(fp, headersonly=False)  
Read all the data from the text-mode file-like object fp, parse the resulting text, and return the root message object. fp must support both the readline() and the read() methods on file-like objects. Other than the text mode requirement, this method operates like BytesParser.parse().
parsestr(text, headersonly=False)  
Similar to the parse() method, except it takes a string object instead of a file-like object. Calling this method on a string is equivalent to wrapping text in a StringIO instance first and calling parse(). Optional headersonly is as with the parse() method.
email.policy.compat32  
An instance of Compat32, providing backward compatibility with the behavior of the email package in Python 3.2.