e fN @ sO d Z d g Z d d l Z d d l Z d d l Z d d l Z d d l m Z m Z d d l m
Z
d d l m Z d d l m
Z
d d l m Z d d l m Z e j Z d
Z e j d Z d d
Z d d d d Z d d Z d d Z Gd d d Z Gd d d Z Gd d d e Z Gd d d e Z d S) z8Basic message object for the email package object model.Message N)BytesIOStringIO)utils)errors)compat32)charset)decode_bz; z[ \(\)<>@,;:\\"/\[\]\?=]c C sJ t | j d \ } } } | s4 | j d f S| j | j f S)N;)str partitionstrip)paramasepb r 2/opt/alt/python34/lib64/python3.4/email/message.py _splitparam s r Tc C s | d k r t | d k r t | t rf | d 7} t j | d | d | d } d | | f Sy | j d Wn? t k
r | d 7} t j | d d } d | | f SYn X| s t j | r d
| t j | f Sd | | f Sn | Sd S) a~ Convenience function to format and return a key=value pair.
This will quote the value if needed or if quote is true. If value is a
three tuple (charset, language, value), it will be encoded according
to RFC2231 rules. If it contains non-ascii characters it will likewise
be encoded according to RFC2231 rules, using the utf-8 charset and
a null language.
Nr * z%s=%sasciizutf-8 z%s="%s")
len
isinstancetupler Zencode_rfc2231encodeUnicodeEncodeError tspecialssearchquote)r valuer! r r r _formatparam( s
!
r# c C sO d t | } g } x2| d d d k rJ| d d } | j d } xR | d k r | j d d | | j d d | d r | j d | d } qQ W| d k r t | } n | d | } d | k r$| j d } | d | j j d | | d d j } n | j | j | | d } q W| S)Nr
r r "z\"r =)r findcountr indexr
lowerappend)sZplistendfir r r _parseparamJ s ; ;r/ c C sB t | t r1 | d | d t j | d f St j | Sd S)Nr r r )r r r unquote)r" r r r
_unquotevalue^ s "r1 c @ s e Z d Z d Z e d d Z d d Z d d d d d
Z d d Z d d d
d Z d d Z
d d Z d d Z d d Z
d d d d Z d d d Z d d Z d d Z d d Z d! d" Z d# d$ Z d% d& Z d' d( Z d) d* Z d+ d, Z d- d. Z d/ d0 Z d d1 d2 Z d3 d4 Z d5 d6 Z d d7 d8 Z d9 d: Z d; d< Z d= d> Z! d? d@ Z" dA dB Z# dC dD Z$ dE dF Z% dG dH Z& d dI dJ dK dL Z' d dI dJ dM dN Z( dO dJ d dP d dQ dR Z) dI dJ dS dT Z* dO dJ dU dV Z+ d dW dX Z, d dY dZ Z- d[ d\ Z. d d] d^ Z/ d d_ d` Z0 d da l1 m2 Z2 d S)br a Basic message object.
A message object is defined as something that has a bunch of RFC 2822
headers and a payload. It may optionally have an envelope header
(a.k.a. Unix-From or From_ header). If the message is a container (i.e. a
multipart or a message/rfc822), then the payload is a list of Message
objects, otherwise it is a string.
Message objects implement part of the `mapping' interface, which assumes
there is exactly one occurrence of the header per message. Some headers
do in fact appear multiple times (e.g. Received) and for those headers,
you must use the explicit API to set or get all the headers. Not all of
the mapping methods are implemented.
c C sS | | _ g | _ d | _ d | _ d | _ d | _ | _ g | _ d | _ d S)Nz
text/plain) policy_headers _unixfrom_payload_charsetZpreambleZepiloguedefects
_default_type)selfr2 r r r __init__y s zMessage.__init__c C s
| j S)z9Return the entire formatted message as a string.
) as_string)r9 r r r __str__ s zMessage.__str__Fr Nc C so d d l m } | d k r% | j n | } t } | | d d d | d | } | j | d | | j S) a 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 mesasge; 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.
r ) GeneratorN mangle_from_F maxheaderlenr2 unixfrom)email.generatorr= r2 r flattengetvalue)r9 r@ r? r2 r= fpgr r r r; s zMessage.as_stringc C s
| j S)z?Return the entire formatted message as a bytes object.
)as_bytes)r9 r r r __bytes__ s zMessage.__bytes__c C si d d l m } | d k r% | j n | } t } | | d d d | } | j | d | | j S)aJ 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.
r )BytesGeneratorNr> Fr2 r@ )rA rH r2 r rB rC )r9 r@ r2 rH rD rE r r r rF s zMessage.as_bytesc C s t | j t S)z6Return True if the message consists of multiple parts.)r r5 list)r9 r r r is_multipart s zMessage.is_multipartc C s
| | _ d S)N)r4 )r9 r@ r r r set_unixfrom s zMessage.set_unixfromc C s | j S)N)r4 )r9 r r r get_unixfrom s zMessage.get_unixfromc C sW | j d k r | g | _ n5 y | j j | Wn t k
rR t d Yn Xd S)zAdd 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.
Nz=Attach is not valid on a message with a non-multipart payload)r5 r* AttributeError TypeError)r9 payloadr r r attach s
zMessage.attachc C sT | j r7 | r d S| d k r) | j S| j | Sn | d k rr t | j t rr t d t | j n | j } t | j d d j } t | t rat j
| r | j d d } | s^y" | j | j
d d d } Wqt k
r| j d d } YqXq^qa| ray | j d } Wq^t k
rZ| j d } Yq^Xqan | sk| S| d
k rt j | S| d k rt d j | j \ } } x! | D] } | j j | | qW| S| d k r=t | } t }
y$ t j | |
d d |
j SWq=t j k
r9| SYq=Xn t | t rP| S| S)aZ 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.
NzExpected list, got %szcontent-transfer-encodingr r surrogateescaper replacezraw-unicode-escapezquoted-printablebase64
x-uuencodeuuencodeuuex-uuequietT)rU rV rW rX )rJ r5 r rI rN typer getr) r Z_has_surrogatesr decode get_param LookupError UnicodeErrorquopriZ decodestringr join
splitlinesr2 Z
handle_defectr uurC Error) r9 r. r\ rO cteZbpayloadr" r7 ZdefectZin_fileZout_filer r r get_payload sV " "
!
zMessage.get_payloadc C s t | d r[ | d k r( | | _ d St | t sF t | } n | j | j } n t | d r | j d d | _ n | | _ | d k r | j | n d S)zSet the payload to the given value.
Optional charset sets the message's default character set. See
set_charset() for details.
r Nr\ r rQ )hasattrr5 r Charsetr output_charsetr\ set_charset)r9 rO r r r r set_payload0 s zMessage.set_payloadc C s | d k r& | j d d | _ d St | t sD t | } n | | _ d | k rl | j d d n d | k r | j d d d | j n | j d | j | | j k r | j | j | _ n d | k r| j } y | | Wqt
k
r| j } | r\y | j d d } Wq\t k
rX| j | j
} Yq\Xn | j | | _ | j d | YqXn d S)
a 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.
Nr z MIME-Versionz1.0z Content-Typez
text/plainzContent-Transfer-Encodingr rQ ) del_paramr6 r rh
add_headerZget_output_charset set_paramZ body_encoder5 Zget_body_encodingrN r r_ ri )r9 r re rO r r r rj D s8
zMessage.set_charsetc C s | j S)zKReturn the Charset instance associated with the message's payload.
)r6 )r9 r r r get_charsets s zMessage.get_charsetc C s
t | j S)z9Return the total number of headers, including duplicates.)r r3 )r9 r r r __len__{ s zMessage.__len__c C s
| j | S)a- 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.
)r[ )r9 namer r r __getitem__ s zMessage.__getitem__c C s | j j | } | r | j } d } x` | j D]R \ } } | j | k r4 | d 7} | | k r t d j | | q q4 q4 Wn | j j | j j | | d S)zSet 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.
r r z/There may be at most {} {} headers in a messageN)r2 Zheader_max_countr) r3
ValueErrorformatr* header_store_parse)r9 rq valZ max_countZlnamefoundkvr r r __setitem__ s
zMessage.__setitem__c C sa | j } g } x? | j D]4 \ } } | j | k r | j | | f q q W| | _ d S)zwDelete all occurrences of a header, if present.
Does not raise an exception if the header is missing.
N)r) r3 r* )r9 rq
newheadersrx ry r r r __delitem__ s zMessage.__delitem__c C s | j d d | j D k S)Nc S s" g | ] \ } } | j q Sr )r) ).0rx ry r r r
s z(Message.__contains__..)r) r3 )r9 rq r r r __contains__ s zMessage.__contains__c c s# x | j D] \ } } | Vq
Wd S)N)r3 )r9 Zfieldr" r r r __iter__ s zMessage.__iter__c C s d d | j D S)a. 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.
c S s g | ] \ } } | q Sr r )r} rx ry r r r r~ s z Message.keys..)r3 )r9 r r r keys s z Message.keysc s f d d j D S)a) 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.
c s+ g | ]! \ } } j j | | q Sr )r2 header_fetch_parse)r} rx ry )r9 r r r~ s z"Message.values..)r3 )r9 r )r9 r values s zMessage.valuesc s f d d j D S)a' 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.
c s1 g | ]' \ } } | j j | | f q Sr )r2 r )r} rx ry )r9 r r r~ s z!Message.items..)r3 )r9 r )r9 r items s z
Message.itemsc C sO | j } x< | j D]1 \ } } | j | k r | j j | | Sq W| S)z~Get a header value.
Like __getitem__() but return failobj instead of None when the field
is missing.
)r) r3 r2 r )r9 rq failobjrx ry r r r r[ s
z Message.getc C s | j j | | f d S)zStore name and value in the model without modification.
This is an "internal" API, intended only for use by a parser.
N)r3 r* )r9 rq r" r r r set_raw s zMessage.set_rawc C s t | j j S)zReturn the (name, value) header pairs without modification.
This is an "internal" API, intended only for use by a generator.
)iterr3 copy)r9 r r r raw_items s zMessage.raw_itemsc C sk g } | j } xH | j D]= \ } } | j | k r | j | j j | | q q W| sg | S| S)aQ 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).
)r) r3 r* r2 r )r9 rq r r rx ry r r r get_all s #zMessage.get_allc K s g } xd | j D]V \ } } | d k rG | j | j d d q | j t | j d d | q W| d k r | j d | n t j | | | Wt j | } | S)Nr% r r ) r r[ r/ r r
rs r* r Z
decode_params) r9 r headerr r" paramsprq rv r r r _get_params_preserveq s
z Message._get_params_preservez content-typeTc C sJ t } | j | | } | | k r+ | S| rB d d | D S| Sd S)am 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.
c S s( g | ] \ } } | t | f q Sr )r1 )r} rx ry r r r r~ s z&Message.get_params..N)r r )r9 r r r0 r r r r r
get_params s
zMessage.get_paramsc C sf | | k r | SxO | j | | D]; \ } } | j | j k r# | rW t | S| Sq# q# W| S)a 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)
)r r) r1 )r9 r r r r0 rx ry r r r r] s
zMessage.get_paramz Content-Typer c C s t | t r( | r( | | | f } n | | k rO | j d k rO d } n | j | } | j | d | s | s t | | | } qJt j | t | | | g } n d } x | j d | d | D]u \ } }
d } | j | j k rt | | | } n t | |
| } | s1| } q t j | | g } q W| | j | k r| rx| j | | q| | =| | | 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.
Nr r r0 )r r) r# r ra r[ )r9 r r r Z new_ctyper ry r r r rl s % zMessage.del_paramc C s | j d d k s t n | j d k rD | d =d | d t } | j d | } | | k r+ | St j | j S)zReturn the boundary associated with the payload if present.
The boundary is extracted from the Content-Type header's `boundary'
parameter, and it is unquoted.
boundary)r r] r r rstrip)r9 r r r r r r get_boundary7 s
zMessage.get_boundaryc C s t } | j | d } | | k r9 t j d n g } d } xY | D]Q \ } } | j d k r | j d d | f d } qL | j | | f qL W| s | j d d | f n g } x | j D] \ } }
| j d k rmg } xG | D]? \ } }
|
d k r$| j | q | j d | |
f q Wt j | }
| j | j j
| |
q | j | |
f q W| | _ d S)
a 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.
z content-typez No Content-Type header foundFr z"%s"Tr z%s=%sN) r r r ZHeaderParseErrorr) r* r3 r ra r2 ru )r9 r r r Z newparamsZfoundpZpkZpvr{ hry r rx rv r r r set_boundaryD s2
zMessage.set_boundaryc C s t } | j d | } | | k r+ | St | t r | d pG d } y& | d j d } t | | } Wq t t f k
r | d } Yq Xn y | j d Wn t k
r | SYn X| j S)zReturn 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.
r r zus-asciir zraw-unicode-escape) r r] r r r r r^ r_ r) )r9 r r r ZpcharsetrF r r r get_content_charsetr s
zMessage.get_content_charsetc s f d d | j D S)a 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.
c s g | ] } | j q Sr )r )r} part)r r r r~ s z(Message.get_charsets..)walk)r9 r r )r r get_charsets s zMessage.get_charsets)r )3__name__
__module__ __qualname____doc__r r: r< r; rG rF rJ rK rL rP rf rk rj ro rp rr rz r| r r r r r r[ r r r rm r r r r r r r r r] rn rl r r r r r r Zemail.iteratorsr r r r r r j s` Z /
!2
. c @ s4 e Z d Z d d Z d d Z d d Z d S)
_IsAttachmentc C s
| | _ d S)N)r" )r9 r" r r r r: s z_IsAttachment.__init__c C s | j S)N)r" )r9 r r r __call__ s z_IsAttachment.__call__c C s t j d t d d | j S)Nz6is_attachment will be a method, not a property, in 3.5
stacklevel )warningswarnDeprecationWarningr" )r9 r r r __bool__ s z_IsAttachment.__bool__N)r r r r: r r r r r r r s r c @ s! e Z d Z d d d Z e d d Z d d Z d. d d Z d/ d0 d1 d2 h Z d d Z d d Z
d d d d Z d d d d Z d d Z
d d d Z d d d Z d d d Z d! d d" d# Z d$ d% Z d& d' Z d( d) Z d* d+ Z d, d- Z d S)3MIMEPartNc C s9 | d k r% d d l m } | } n t j | | d S)Nr )default)Z email.policyr r r: )r9 r2 r r r r r: s zMIMEPart.__init__c C s: | j d } | d k r! d n | j d k } t | S)Nzcontent-dispositionF
attachment)r[ Zcontent_dispositionr )r9 Zc_dresultr r r
is_attachment s !zMIMEPart.is_attachmentc c su | j r d S| j j d \ } } | d k r^ | | k rZ | j | | f Vn d S| d k rn d S| d k r x) | j D] } | j | | Dd Hq Wd Sd | k r | j d | f Vn d } | j d } | r x1 | j D] } | d | k r | } Pq q Wn | d k rM| j } | rD| d n d } n | d k rq| j | | Dd Hn d S)Nr text multipartrelatedstartz
content-idr )r r r r(
iter_parts
_find_bodyr] rf ) r9 r preferencelistmaintypesubtypeZsubpart candidater Zsubpartsr r r r s6 zMIMEPart._find_bodyr htmlplainc C sd t | } d } xK | j | | D]7 \ } } | | k r% | } | } | d k r\ Pq\ q% q% W| S)a Return best candidate mime part for display as 'body' of message.
Do a depth first search, starting with self, looking for the first part
matching each of the items in preferencelist, and return the part
corresponding to the first item that has a match, or None if no items
have a match. If 'related' is not included in preferencelist, consider
the root part of any multipart/related encountered as a candidate
match. Ignore parts with 'Content-Disposition: attachment'.
Nr )r r )r9 r Z best_prioZbodyZprior r r r get_body s
zMIMEPart.get_bodyr r alternativec c sd | j j d \ } } | d k s3 | d k r7 d S| j } | d k r | d k r | j d } | r d } g } x9 | D]1 } | j d | k r d } q | j | q W| r | Dd Hd Sn | j d
| Dd Hd Sg } xo | D]g } | j j d \ } } | | f | j k rW| j rW| | k rW| j | q n | Vq Wd S) a Return an iterator over the non-main parts of a multipart.
Skip the first of each occurrence of text/plain, text/html,
multipart/related, or multipart/alternative in the multipart (unless
they have a 'Content-Disposition: attachment' header) and include all
remaining subparts in the returned iterator. When applied to a
multipart/related, return all parts except the root part. Return an
empty iterator when applied to a multipart/alternative or a
non-multipart.
r r r Nr r Fz
content-idTr ) r r rf r] r[ r* pop _body_typesr ) r9 r r r r rw Z attachmentsr seenr r r iter_attachments s6
zMIMEPart.iter_attachmentsc c s( | j d k r$ | j Dd Hn d S)z~Return an iterator over all immediate subparts of a multipart.
Return an empty iterator for a non-multipart.
r N)r rf )r9 r r r r # s zMIMEPart.iter_partscontent_managerc O s. | d k r | j j } n | j | | | S)N)r2 r get_content)r9 r argskwr r r r + s zMIMEPart.get_contentc O s2 | d k r | j j } n | j | | | d S)N)r2 r set_content)r9 r r r r r r r 0 s zMIMEPart.set_contentc
C s> | j d k rU | j } | | f } | | k rU t d j | | qU n g } g } xU | j D]J \ } } | j j d r | j | | f qk | j | | f qk W| r t | d | j } | | _ | j
| _
| g | _
n g | _
| | _ d | | d <| d k r:| j d | n d S)Nr zCannot convert {} to {}zcontent-r2 z
multipart/z Content-Typer ) r r rs rt r3 r)
startswithr* rZ r2 r5 rn )
r9 r Zdisallowed_subtypesr Zexisting_subtypeZ keep_headersZ part_headersrq r" r r r r _make_multipart5 s,
zMIMEPart._make_multipartc C s | j d d | d S)Nr r mixed)z alternativer )r )r9 r r r r make_relatedP s zMIMEPart.make_relatedc C s | j d d | d S)Nr r )zmixed)r )r9 r r r r make_alternativeS s zMIMEPart.make_alternativec C s | j d f | d S)Nr )r )r9 r r r r
make_mixedV s zMIMEPart.make_mixed_dispc O s | j d k s$ | j | k r; t | d | n t | d | j } | j | | | r d | k r | | d .)r3 r5 )r9 r r r
clear_contentp s zMIMEPart.clear_content)relatedr r )textr )r r ) multipartr )r z alternative)r r r r: propertyr r r r r r r r r r r r r r r r r r r r r r r s, .
r c s" e Z d Z f d d Z S) EmailMessagec s0 t j | | d | k r, d | d s2
" ?