3
\O @ sj d Z ddlmZ ddlmZ ddlmZ ddlmZ G dd dZG dd d Z G d
d d e
Z d d
Z G dd dZ
G dd de
ZG dd dZG dd deZG dd dZG dd deZG dd deZG d d d eZG d d d ZG d d! d!ZG d"d# d#eZG d$d% d%eZG d&d' d'Zeeeeeeeeeeeeeeeeeeed(ZG d)d* d*Zd+S ),a; Representing and manipulating email headers via custom objects.
This module provides an implementation of the HeaderRegistry API.
The implementation is designed to flexibly follow RFC5322 rules.
Eventually HeaderRegistry will be a public API, but it isn't yet,
and will probably change some before that happens.
)MappingProxyType)utils)errors)_header_value_parserc @ s^ e Zd ZdddZedd Zedd Zed d
Zed d Zd
d Z dd Z
dd Z dS )Address Nc C sl |dk rV|s|rt dtj|\}}|r:tdj|||jrJ|jd |j}|j}|| _|| _ || _
dS )a Create an object representing a full email address.
An address can have a 'display_name', a 'username', and a 'domain'. In
addition to specifying the username and domain separately, they may be
specified together by using the addr_spec keyword *instead of* the
username and domain keywords. If an addr_spec string is specified it
must be properly quoted according to RFC 5322 rules; an error will be
raised if it is not.
An Address object has display_name, username, domain, and addr_spec
attributes, all of which are read-only. The addr_spec and the string
value of the object are both quoted according to RFC5322 rules, but
without any Content Transfer Encoding.
Nz=addrspec specified when username and/or domain also specifiedz6Invalid addr_spec; only '{}' could be parsed from '{}'r ) TypeErrorparserZ
get_addr_spec
ValueErrorformat all_defects
local_partdomain
_display_name _username_domain)self display_nameusernamer addr_specZa_srest r ,/usr/lib64/python3.6/email/headerregistry.py__init__ s
zAddress.__init__c C s | j S )N)r )r r r r r 7 s zAddress.display_namec C s | j S )N)r )r r r r r ; s zAddress.usernamec C s | j S )N)r )r r r r r ? s zAddress.domainc C sT t | j}t|t|tj kr.tj| j}n| j}| jrH|d | j S |sPdS |S )zThe addr_spec (username@domain) portion of the address, quoted
according to RFC 5322 rules, but with no Content Transfer Encoding.
@z<>)setr lenr Z
DOT_ATOM_ENDS quote_stringr )r namesetZlpr r r r C s
zAddress.addr_specc C s dj | jj| j| j| jS )Nz1{}(display_name={!r}, username={!r}, domain={!r}))r __class____name__r r r )r r r r __repr__S s zAddress.__repr__c C s^ t | j}t|t|tj kr.tj| j}n| j}|rX| jdkrFdn| j}dj||S | jS )Nz<>r z{} <{}>)r r r r SPECIALSr r r )r r dispr r r r __str__X s
zAddress.__str__c C s8 t |t | krdS | j|jko6| j|jko6| j|jkS )NF)typer r r )r otherr r r __eq__c s
zAddress.__eq__)r r r N) r
__module__ __qualname__r propertyr r r r r! r$ r' r r r r r s
% r c @ sF e Zd ZdddZedd Zedd Zdd Zd
d Zd d
Z dS )GroupNc C s || _ |rt|nt | _dS )a Create an object representing an address group.
An address group consists of a display_name followed by colon and a
list of addresses (see Address) terminated by a semi-colon. The Group
is created by specifying a display_name and a possibly empty list of
Address objects. A Group can also be used to represent a single
address that is not in a group, which is convenient when manipulating
lists that are a combination of Groups and individual Addresses. In
this case the display_name should be set to None. In particular, the
string representation of a Group whose display_name is None is the same
as the Address object, if there is one and only one Address object in
the addresses list.
N)r tuple
_addresses)r r addressesr r r r m s zGroup.__init__c C s | j S )N)r )r r r r r s zGroup.display_namec C s | j S )N)r- )r r r r r. s zGroup.addressesc C s dj | jj| j| jS )Nz${}(display_name={!r}, addresses={!r})r r r r r. )r r r r r! s zGroup.__repr__c C s | j d kr&t| jdkr&t| jd S | j }|d k r\t|}t|t|tj kr\tj|}djdd | jD }|r~d| n|}dj ||S )N r z, c s s | ]}t |V qd S )N)str).0xr r r s z Group.__str__.. z{}:{};)
r r r. r0 r r r" r joinr )r r# r Zadrstrr r r r$ s
z
Group.__str__c C s, t |t | krdS | j|jko*| j|jkS )NF)r% r r. )r r& r r r r' s z Group.__eq__)NN)
r r( r) r r* r r. r! r$ r' r r r r r+ k s
r+ c @ sT e Zd ZdZdd Zdd Zedd Zedd Zd
d Z e
d d
Z dd Z dS )
BaseHeadera| Base class for message headers.
Implements generic behavior and provides tools for subclasses.
A subclass must define a classmethod named 'parse' that takes an unfolded
value string and a dictionary as its arguments. The dictionary will
contain one key, 'defects', initialized to an empty list. After the call
the dictionary must contain two additional keys: parse_tree, set to the
parse tree obtained from parsing the header, and 'decoded', set to the
string value of the idealized representation of the data from the value.
(That is, encoded words are decoded, and values that have canonical
representations are so represented.)
The defects key is intended to collect parsing defects, which the message
parser will subsequently dispose of as appropriate. The parser should not,
insofar as practical, raise any errors. Defects should be added to the
list instead. The standard header parsers register defects for RFC
compliance issues, for obsolete RFC syntax, and for unrecoverable parsing
errors.
The parse method may add additional keys to the dictionary. In this case
the subclass must define an 'init' method, which will be passed the
dictionary as its keyword arguments. The method should use (usually by
setting them as the value of similarly named attributes) and remove all the
extra keys added by its parse method, and then use super to call its parent
class with the remaining arguments and keywords.
The subclass should also make sure that a 'max_count' attribute is defined
that is either None or 1. XXX: need to better define this API.
c C s\ dg i}| j || tj|d r4tj|d |d< tj| |d }|d= |j|f| |S )Ndefectsdecoded)parser Z_has_surrogates _sanitizer0 __new__init)clsnamevaluekwdsr r r r r; s zBaseHeader.__new__c C s || _ || _|| _d S )N)_name _parse_tree_defects)r r>
parse_treer7 r r r r< s zBaseHeader.initc C s | j S )N)rA )r r r r r> s zBaseHeader.namec C s
t | jS )N)r, rC )r r r r r7 s zBaseHeader.defectsc C s t | jj| jjt| f| jfS )N)_reconstruct_headerr r __bases__r0 __dict__)r r r r
__reduce__ s
zBaseHeader.__reduce__c C s t j| |S )N)r0 r; )r= r? r r r _reconstruct s zBaseHeader._reconstructc C s` t jt jt j| jdt jddgg}| jrH|jt jt jddg |j| j |j |dS )at Fold header according to policy.
The parsed representation of the header is folded according to
RFC5322 rules, as modified by the policy. If the parse tree
contains surrogateescaped bytes, the bytes are CTE encoded using
the charset 'unknown-8bit".
Any non-ASCII characters in the parse tree are CTE encoded using
charset utf-8. XXX: make this a policy setting.
The returned value is an ASCII-only string possibly containing linesep
characters, and ending with a linesep character. The string includes
the header name and the ': ' separator.
z header-name:z
header-sepr4 Zfws)policy)
r ZHeaderZ HeaderLabelZ
ValueTerminalr> rB appendZCFWSListZWhiteSpaceTerminalfold)r rK headerr r r rM s zBaseHeader.foldN)
r r( r) __doc__r; r< r* r> r7 rH classmethodrI rM r r r r r6 s
r6 c C s t | |i j|S )N)r% rI )Zcls_namebasesr? r r r rE s rE c @ s& e Zd ZdZeejZedd Z dS )UnstructuredHeaderNc C s" | j ||d< t|d |d< d S )NrD r8 ) value_parserr0 )r= r? r@ r r r r9 s zUnstructuredHeader.parse)
r r( r) max_count staticmethodr get_unstructuredrS rP r9 r r r r rR s
rR c @ s e Zd ZdZdS )UniqueUnstructuredHeaderr/ N)r r( r) rT r r r r rW s rW c sF e Zd ZdZdZeejZe dd Z
fddZ e dd Z
ZS )
DateHeadera Header whose value consists of a single timestamp.
Provides an additional attribute, datetime, which is either an aware
datetime using a timezone, or a naive datetime if the timezone
in the input string is -0000. Also accepts a datetime as input.
The 'value' attribute is the normalized form of the timestamp,
which means it is the output of format_datetime on the datetime.
Nc C sz |s6|d j tj d |d< d|d< tj |d< d S t|trJtj|}||d< tj |d |d< | j
|d |d< d S )Nr7 datetimer r8 rD ) rL r ZHeaderMissingRequiredValuer Z TokenList
isinstancer0 r Zparsedate_to_datetimeZformat_datetimerS )r= r? r@ r r r r9 ) s
zDateHeader.parsec s |j d| _t j|| d S )NrY )pop _datetimesuperr< )r argskw)r r r r< 7 s zDateHeader.initc C s | j S )N)r\ )r r r r rY ; s zDateHeader.datetime)r r( r) rO rT rU r rV rS rP r9 r< r* rY
__classcell__r r )r r rX s
rX c @ s e Zd ZdZdS )UniqueDateHeaderr/ N)r r( r) rT r r r r ra @ s ra c sP e Zd ZdZedd Zedd Z fddZe dd Z
e d
d Z Z S )
AddressHeaderNc C s t j| \}} |S )N)r Zget_address_list)r? address_listr r r rS I s zAddressHeader.value_parserc C s t |trZ| j| |d< }g }x,|jD ]"}|jt|jdd |jD q(W t|j }n"t
|dsj|g}dd |D }g }||d< ||d< dj d d |D |d
< d|kr| j|d
|d< d S ) NrD c S s* g | ]"}t |jpd |jpd |jp"d qS )r )r r r
r )r1 Zmbr r r
X s z'AddressHeader.parse..__iter__c S s& g | ] }t |d s td|gn|qS )r. N)hasattrr+ )r1 itemr r r rd a s groupsr7 z, c S s g | ] }t |qS r )r0 )r1 rg r r r rd g s r8 ) rZ r0 rS r. rL r+ r Z
all_mailboxeslistr rf r5 )r= r? r@ rc rh Zaddrr7 r r r r9 O s$
zAddressHeader.parsec s( t |jd| _d | _t j|| d S )Nrh )r, r[ _groupsr- r] r< )r r^ r_ )r r r r< k s zAddressHeader.initc C s | j S )N)rj )r r r r rh p s zAddressHeader.groupsc C s& | j d kr tdd | jD | _ | j S )Nc S s g | ]}|j D ]}|qqS r )r. )r1 groupaddressr r r rd w s z+AddressHeader.addresses..)r- r, rj )r r r r r. t s
zAddressHeader.addresses)
r r( r) rT rU rS rP r9 r< r* rh r. r` r r )r r rb E s rb c @ s e Zd ZdZdS )UniqueAddressHeaderr/ N)r r( r) rT r r r r rm | s rm c @ s e Zd Zedd ZdS )SingleAddressHeaderc C s( t | jdkr tdj| j| jd S )Nr/ z9value of single address header {} is not a single addressr )r r. r
r r> )r r r r rl s
zSingleAddressHeader.addressN)r r( r) r* rl r r r r rn s rn c @ s e Zd ZdZdS )UniqueSingleAddressHeaderr/ N)r r( r) rT r r r r ro s ro c sZ e Zd ZdZeejZedd Z fddZ
e dd Z e dd Z
e d
d Z ZS ) MIMEVersionHeaderr/ c C s | j | |d< }t||d< |d j|j |jd kr r? r r r
s z1ParameterizedMIMEHeader.parse..)rS r0 rt r ry )r= r? r@ rD r r r r9 s
z ParameterizedMIMEHeader.parsec s |j d| _t j|| d S )Nry )r[ _paramsr] r< )r r^ r_ )r r r r< s z ParameterizedMIMEHeader.initc C s
t | jS )N)r r| )r r r r ry s z ParameterizedMIMEHeader.params)
r r( r) rT rP r9 r< r* ry r` r r )r r rx s
rx c sJ e Zd ZeejZ fddZedd Z edd Z
edd Z Z S ) ContentTypeHeaderc s2 t j|| tj| jj| _tj| jj| _d S )N) r] r< r r: rB maintype _maintypesubtype_subtype)r r^ r_ )r r r r< s zContentTypeHeader.initc C s | j S )N)r )r r r r r~ s zContentTypeHeader.maintypec C s | j S )N)r )r r r r r s zContentTypeHeader.subtypec C s | j d | j S )N/)r~ r )r r r r content_type s z ContentTypeHeader.content_type)
r r( r) rU r Zparse_content_type_headerrS r< r* r~ r r r` r r )r r r} s
r} c s2 e Zd ZeejZ fddZedd Z Z
S )ContentDispositionHeaderc s2 t j|| | jj}|d kr"|ntj|| _d S )N)r] r< rB content_dispositionr r: _content_disposition)r r^ r_ Zcd)r r r r< s z ContentDispositionHeader.initc C s | j S )N)r )r r r r r s z,ContentDispositionHeader.content_disposition) r r( r) rU r Z parse_content_disposition_headerrS r< r* r r` r r )r r r s
r c sB e Zd ZdZeejZedd Z fddZ
e dd Z Z
S ) ContentTransferEncodingHeaderr/ c C s2 | j | |d< }t||d< |d j|j d S )NrD r8 r7 )rS r0 rt r )r= r? r@ rD r r r r9 s z#ContentTransferEncodingHeader.parsec s" t j|| tj| jj| _d S )N)r] r< r r: rB cte_cte)r r^ r_ )r r r r< s z"ContentTransferEncodingHeader.initc C s | j S )N)r )r r r r r s z!ContentTransferEncodingHeader.cte)r r( r) rT rU r Z&parse_content_transfer_encoding_headerrS rP r9 r< r* r r` r r )r r r s
r )ZsubjectZdatez resent-datez orig-dateZsenderz
resent-senderZtoz resent-toZccz resent-ccZbccz
resent-bccfromz resent-fromzreply-toz mime-versionz content-typezcontent-dispositionzcontent-transfer-encodingc @ s8 e Zd ZdZeedfddZdd Zdd Zd d
Z d S ) HeaderRegistryz%A header_factory and header registry.Tc C s& i | _ || _|| _|r"| j jt dS )a Create a header_factory that works with the Policy API.
base_class is the class that will be the last class in the created
header class's __bases__ list. default_class is the class that will be
used if "name" (see __call__) does not appear in the registry.
use_default_map controls whether or not the default mapping of names to
specialized classes is copied in to the registry when the factory is
created. The default is True.
N)registry
base_class
default_classupdate_default_header_map)r r r Zuse_default_mapr r r r ' s
zHeaderRegistry.__init__c C s || j |j < dS )zLRegister cls as the specialized class for handling "name" headers.
N)r rz )r r> r= r r r map_to_type9 s zHeaderRegistry.map_to_typec C s, | j j|j | j}td|j || jfi S )N_)r getrz r r% r r )r r> r= r r r __getitem__? s zHeaderRegistry.__getitem__c C s | | ||S )a Create a header instance for header 'name' from 'value'.
Creates a header instance by creating a specialized class for parsing
and representing the specified header by combining the factory
base_class with a specialized class from the registry or the
default_class, and passing the name and value to the constructed
class's constructor.
r )r r> r? r r r __call__C s
zHeaderRegistry.__call__N)
r r( r) rO r6 rR r r r r r r r r r # s r N) rO typesr Zemailr r r r r r+ r0 r6 rE rR rW rX ra rb rm rn ro rp rx r} r r r r r r r r sR [6d '7
%