U

��W[���@s dZd
dl
Z
d
dlZd
dlZd
dlmZ
d
dlmZ
d
dlm	Z	
d
dl
mZ
d
dl
mZ
d
dl
m
Z

d
d	lmZ
d
d
lmZmZ
d
dlmZmZmZ
d
dlmZ
d
d
lmZ
d
dlmZ
d
dlmZm Z 
ee	j!j"�
Gdd�d��
Z#Gdd�d�Z$Gdd�de%�Z&dd�Z'dd�Z(dd�Z)dd�Z*dd�Z+d d!�Z,d"d#�Z-ee
j.�
Gd$d%�d%ej/ej0��
Z1ee�
Gd&d'�d'��
Z2e3d(�
\Z4Z5Z6Z7iZ8e4e8e4<e4e8e5<e7e8e6<e4e8e7<Gd)d*�d*ej/�Z9d
d+l:m9Z;
d
d,l:m<Z<
d
d-l:m=Z=
d
d.l:m>Z>
d
d/l:m?Z?
d
d0l:m@Z@
d1d2d3d4d5d6d7d8d9d%d*d:dd'gZAdS);zQ
Post-office Protocol version 3.

@author: Glyph Lefkowitz
@author: Jp Calderone
�N)
�md5)
�implementer)
�cred)
�task)
�defer)
�
interfaces)
�smtp)�IServerFactoryPOP3�IMailboxPOP3)�	POP3Error�_POP3MessageDeleted�POP3ClientError)
�basic)
�policies)
�log)�_PY3�
intToBytesc@s eZ
dZd
Zdd�Zdd�ZdS)�APOPCredentialsz�
    Credentials for use in APOP authentication.

    @ivar magic: See L{__init__}
    @ivar username: See L{__init__}
    @ivar digest: See L{__init__}
    cCs|
|_||_
||_d
S)a�

        @type magic: L{bytes}
        @param magic: The challenge string used to encrypt the password.

        @type username: L{bytes}
        @param username: The username associated with these credentials.

        @type digest: L{bytes}
        @param digest: An encrypted version of the user's password.  Should be
            generated as an MD5 hash of the challenge string concatenated with
            the plaintext password.
        N)�magic�username�digest)�selfrrr�r�3/usr/lib/python3/dist-packages/twisted/mail/pop3.py�__init__0s


zAPOPCredentials.__init__cCs |j|
}t
|�
��}||jkS)
a4

        Validate a plaintext password against the credentials.

        @type password: L{bytes}
        @param password: A plaintext password.

        @rtype: L{bool}
        @return: C{True} if the credentials represented by this object match
        the given password, C{False} if they do not.
        )rr�	hexdigestr)r�passwordZseedZmyDigestrrr�
checkPasswordBs


zAPOPCredentials.checkPasswordN)�__name__�
__module__�__qualname__�__doc__rrrrrrr'src@s eZ
dZd
Zdd�Zdd�ZdS)�_HeadersPlusNLinesa�
    A utility class to retrieve the header and some lines of the body of a mail
    message.

    @ivar _file: See L{__init__}
    @ivar _extraLines: See L{__init__}

    @type linecount: L{int}
    @ivar linecount: The number of full lines of the message body scanned.

    @type headers: L{bool}
    @ivar headers: An indication of which part of the message is being scanned.
        C{True} for the header and C{False} for the body.

    @type done: L{bool}
    @ivar done: A flag indicating when the desired part of the message has been
        scanned.

    @type buf: L{bytes}
    @ivar buf: The portion of the message body that has been scanned, up to
        C{n} lines.
    cCs(|
|_||_
d
|_d|_d
|_d|_dS)z�
        @type file: file-like object
        @param file: A file containing a mail message.

        @type extraLines: L{int}
        @param extraLines: The number of lines of the message body to retrieve.
        r
�
�N)�_file�_extraLines�	linecount�headers�done�buf)r�fileZ
extraLinesrrrrjs




z_HeadersPlusNLines.__init__cCs�|jr
d
S|j
�|
�
}|s|S|jr�|�d�
d}}|dkrL|�d�
d}}|dkr�||7}|d|�}||d�}d|_d	|_nd
}|jd	kr�|j|�d
�
}|d|_|dd�D]8}|j|jkr�d|_|
S||d
7}|jd7_q�|S|SdS)a
        Scan bytes from the file.

        @type bytes: L{int}
        @param bytes: The number of bytes to read from the file.

        @rtype: L{bytes}
        @return: Each portion of the header as it is scanned.  Then, full lines
            of the message body as they are scanned.  When more than one line
            of the header and/or body has been scanned, the result is the
            concatenation of the lines.  When the scan results in no full
            lines, the empty string is returned.
        r$s

����s

�Nr#r
�

)	r)r%�readr(�findr'r*�splitr&)r�bytes�dataZdfZsz�valZdsplitZlnrrrr0zs6

























z_HeadersPlusNLines.readN)rrr r!rr0rrrrr"Ss
r"c@s6eZ
dZd
ZdZd
dd�
Zdd�Zdd	�Zes2eZ	dS)�_IteratorBuffera�

    An iterator which buffers the elements of a container and periodically
    passes them as input to a writer.

    @ivar write: See L{__init__}.
    @ivar memoryBufferSize: See L{__init__}.

    @type bufSize: L{int}
    @ivar bufSize: The number of bytes currently in the buffer.

    @type lines: L{list} of L{bytes}
    @ivar lines: The buffer, which is a list of strings.

    @type iterator: iterator which yields L{bytes}
    @ivar iterator: An iterator over a container of strings.
    r
NcCs,g|_|
|_
t|�
|_|d
kr"d}||_d
S)a�

        @type write: callable that takes L{list} of L{bytes}
        @param write: A writer which is a callable that takes a list of
            strings.

        @type iterable: iterable which yields L{bytes}
        @param iterable: An iterable container of strings.

        @type memoryBufferSize: L{int} or L{None}
        @param memoryBufferSize: The number of bytes to buffer before flushing
            the buffer to the writer.
        Ni
)�lines�write�iter�iterator�memoryBufferSize)rr8�iterabler;rrrr�s






z_IteratorBuffer.__init__c


Cs|S)
z�
        Return an iterator.

        @rtype: iterator which yields L{bytes}
        @return: An iterator over strings.
        r�
rrrr�__iter__�sz_IteratorBuffer.__iter__c
Cs�zt|j
�
}
Wn4tk
rB


|jr0|�|j�

|`
|`|`�YnLX|
d
k	r�|j�|
�

|jt|
�
7_|j|jkr�|�|j�

g|_d|_d
S)a\

        Get the next string from the container, buffer it, and possibly send
        the buffer to the writer.

        The contents of the buffer are written when it is full or when no
        further values are available from the container.

        @raise StopIteration: When no further values are available from the
        container.
        Nr
)	�nextr:�
StopIterationr7r8�append�bufSize�lenr;)r�
vrrr�__next__�s










z_IteratorBuffer.__next__)
N)
rrr r!rBrr>rErr?rrrrr6�s



r6cCst|j
j|
�}|�|�
S)
a}

    Direct the output of an iterator to the transport of a protocol and arrange
    for iteration to take place.

    @type proto: L{POP3}
    @param proto: A POP3 server protocol.

    @type gen: iterator which yields L{bytes}
    @param gen: An iterator over strings.

    @rtype: L{Deferred <defer.Deferred>}
    @return: A deferred which fires when the iterator finishes.
    )r6�	transport�
writeSequence�schedule)�proto�genZcollrrr�iterateLineGenerator�s
rKc

Cs$t|t
�st|�
�d
�
}d|dS)z�
    Format an object as a positive response.

    @type response: stringifyable L{object}
    @param response: An object with a string representation.

    @rtype: L{bytes}
    @return: A positive POP3 response string.
    �utf-8s+OK �
)�
isinstancer3�str�encode)
�responserrr�successResponse
s



rRc
csFd
}
d
}|D]}|
d7}
||7}dV
qtt
|
�
dt
|�
�
V
dS)a�

    Format a list of message sizes into a STAT response.

    This generator function is intended to be used with
    L{Cooperator <twisted.internet.task.Cooperator>}.

    @type msgs: L{list} of L{int}
    @param msgs: A list of message sizes.

    @rtype: L{None} or L{bytes}
    @return: Yields none until a result is available, then a string that is
        suitable for use in a STAT response. The string consists of the number
        of messages and the total size of the messages in octets.
    r
r#N�
 �rRr)�msgs�
ir3�sizerrr�formatStatResponse
s





rXc
cs4d
}
|D]&}|
d7}
t|
�
dt|�
dV
qdS)a_

    Format a list of message sizes for use in a LIST response.

    @type msgs: L{list} of L{int}
    @param msgs: A list of message sizes.

    @rtype: L{bytes}
    @return: Yields a series of strings that are suitable for use as scan
        listings in a LIST response. Each string consists of a message number
        and its size in octets.
    r
r#rSrMN)
r)rUrVrWrrr�formatListLines7
s


rYc
cs0tt
t|�
�
�
V
t|�
D]
}
|
V
qd
V
dS)ai

    Format a list of message sizes into a complete LIST response.

    This generator function is intended to be used with
    L{Cooperator <twisted.internet.task.Cooperator>}.

    @type msgs: L{list} of L{int}
    @param msgs: A list of message sizes.

    @rtype: L{bytes}
    @return: Yields a series of strings which make up a complete LIST response.
    �.
N)rRrrCrY)rU�elerrr�formatListResponseJ
s



r\ccsXt|�
D]J\}}|d
k	r|
|�
}t
|t�s8t|�
�d�
}t|d�
d|dV
qd
S)ar

    Format a list of message sizes for use in a UIDL response.

    @param msgs: See L{formatUIDListResponse}
    @param getUidl: See L{formatUIDListResponse}

    @rtype: L{bytes}
    @return: Yields a series of strings that are suitable for use as unique-id
        listings in a UIDL response. Each string consists of a message number
        and its unique id.
    NrLr#rSrM)�	enumeraterNr3rOrPr)rU�getUidlrV�
mZuidrrr�formatUIDListLines^
s





r`ccs*td
�
V
t
||
�D]
}|V
qdV
dS)a.
    Format a list of message sizes into a complete UIDL response.

    This generator function is intended to be used with
    L{Cooperator <twisted.internet.task.Cooperator>}.

    @type msgs: L{list} of L{int}
    @param msgs: A list of message sizes.

    @type getUidl: one-argument callable returning bytes
    @param getUidl: A callable which takes a message index number and returns
        the UID of the corresponding message in the mailbox.

    @rtype: L{bytes}
    @return: Yields a series of strings which make up a complete UIDL response.
    �rZN)rRr`)rUr^r[rrr�formatUIDListResponses
s



rbc@s�
eZ
dZd
ZdZdZdZddddddd	gZdZdZ	dZ
d
ZdZdZ
eej�
ZdZd
d�Zdd�Zdd�Zd[dd�
Zd\dd�
Zdd�Zdd�Zdd�Zdd �Zd!d"�Zd#d$�Zd]d%d&�
Zd'd(�Zd)d*�Z d+d,�Z!d-d.�Z"d/d0�Z#d1d2�Z$d3d4�Z%d5d6�Z&d7d8�Z'd9d:�Z(d^d;d<�
Z)d_d=d>�
Z*d?d@�Z+dAdB�Z,dCdD�Z-dEdF�Z.dGdH�Z/dIdJ�Z0dKdL�Z1dMdN�Z2dOdP�Z3dQdR�Z4dSdT�Z5dUdV�Z6dWdX�Z7dYdZ�Z8dS)`�POP3a�
    A POP3 server protocol.

    @type portal: L{Portal}
    @ivar portal: A portal for authentication.

    @type factory: L{IServerFactory} provider
    @ivar factory: A server factory which provides an interface for querying
        capabilities of the server.

    @type timeOut: L{int}
    @ivar timeOut: The number of seconds to wait for a command from the client
        before disconnecting.

    @type schedule: callable that takes interator and returns
        L{Deferred <defer.Deferred>}
    @ivar schedule: A callable that arranges for an iterator to be
        cooperatively iterated over along with all other iterators which have
        been passed to it such that runtime is divided between all of them.  It
        returns a deferred which fires when the iterator finishes.

    @type magic: L{bytes} or L{None}
    @ivar magic: An APOP challenge.  If not set, an APOP challenge string
        will be generated when a connection is made.

    @type _userIs: L{bytes} or L{None}
    @ivar _userIs: The username sent with the USER command.

    @type _onLogout: no-argument callable or L{None}
    @ivar _onLogout: The function to be executed when the connection is
        lost.

    @type mbox: L{IMailbox} provider
    @ivar mbox: The mailbox for the authenticated user.

    @type state: L{bytes}
    @ivar state: The state which indicates what type of messages are expected
        from the client.  Valid states are 'COMMAND' and 'AUTH'

    @type blocked: L{None} or L{list} of 2-L{tuple} of
        (E{1}) L{bytes} (E{2}) L{tuple} of L{bytes}
    @ivar blocked: A list of blocked commands.  While a response to a command
        is being generated by the server, other commands are blocked.  When
        no command is outstanding, C{blocked} is set to none.  Otherwise, it
        contains a list of information about blocked commands.  Each list
        entry consists of the command and the arguments to the command.

    @type _highest: L{int}
    @ivar _highest: The 1-based index of the highest message retrieved.

    @type _auth: L{IUsernameHashedPassword
        <cred.credentials.IUsernameHashedPassword>} provider
    @ivar _auth: Authorization credentials.
    NsCAPA�USER�PASS�APOPsAUTHsRPOP�QUITi,
�COMMANDr
c

CsV|jd
kr|�
�|_|�|j�

|�|j�

t|jdd�rRt�dt	|j
���
�

d
S)zS
        Send a greeting to the client after the connection has been made.
        N�noisyTzNew connection from )r�
generateMagicrR�
setTimeout�timeOut�getattr�factoryr�msgrOrF�getPeerr=rrr�connectionMade�
s






zPOP3.connectionMadecCs&|jd
k	r|��
d
|_|�
d
�

d
S)z�
        Clean up when the connection has been lost.

        @type reason: L{Failure}
        @param reason: The reason the connection was terminated.
        N)�	_onLogoutrk)r�reasonrrr�connectionLost�
s



zPOP3.connectionLostc

Cst�
�S)
z}
        Generate an APOP challenge.

        @rtype: L{bytes}
        @return: An RFC 822 message id format string.
        )rZ	messageidr=rrrrj�
szPOP3.generateMagicracCs|j�
t|
�
�

d
S)z�
        Send a response indicating success.

        @type message: stringifyable L{object}
        @param message: An object whose string representation should be
            included in the response.
        N)rFr8rR�r�messagerrrrRszPOP3.successResponser$cCs*t|
t
�st|
�
�d
�
}
|�d|
�

dS)z�
        Send a response indicating failure.

        @type message: stringifyable L{object}
        @param message: An object whose string representation should be
            included in the response.
        rLs-ERR N)rNr3rOrP�sendLinerurrr�failResponses


zPOP3.failResponsecCs |��
t
|d
|j�|
�

dS)z�
        Pass a received line to a state machine function.

        @type line: L{bytes}
        @param line: A received line.
        Zstate_N)ZresetTimeoutrm�state�r�linerrr�lineReceiveds
zPOP3.lineReceivedcCsT|j}d
|_|r:|jd
kr:|�
d�
\}}|j|f
|��
q|jd
k	rP|j�|�

d
S)z�
        Process as many blocked commands as possible.

        If there are no more blocked commands, set up for the next command to
        be sent immediately.

        @type _: L{object}
        @param _: Ignored.
        Nr
)�blocked�pop�processCommand�extend)r�
_Zcommands�cmd�argsrrr�_unblock#s







z
POP3._unblockcCs`z|j|
�
d
�
�WSttttfk
rZ
}
z"t��
|�d�	|j
j|��

W5d}~XYnXdS)z�
        Handle received lines for the COMMAND state in which commands from the
        client are expected.

        @type line: L{bytes}
        @param line: A received command.
        rSzbad protocol or server: {}: {}N)rr2�
ValueError�AttributeErrorr�	TypeErrorr�errrx�format�	__class__r)rr{�
errr�
state_COMMAND6s




�zPOP3.state_COMMANDcGsx|jd
k	r|j�
|
|f�

d
S|
��}
|
|jk}|jsF|sFtd|
�
�
t|d|
�d�
d
�}|rh||�Std|
�
�
d
S)aq

        Dispatch a command from the client for handling.

        @type command: L{bytes}
        @param command: A POP3 command.

        @type args: L{tuple} of L{bytes}
        @param args: Arguments to the command.

        @raise POP3Error: When the command is invalid or the command requires
            prior authentication which hasn't been performed.
        Ns!not authenticated yet: cannot do Zdo_rLsUnknown protocol command: )r}rA�upper�	AUTH_CMDS�mboxrrm�decode)r�commandr�ZauthCmd�
frrrrFs











zPOP3.processCommandc
Csd
ddddddg}
t�
|j�
�rz*|j��}|rHt|t�sHt|�
�d�
}Wn&tk
r^


Yn"


t	�
�
YnX|
�d	|�

z*|j��}|r�t|t�s�t|�
�d�
}Wn&tk
r�


Yn^


t	�
�
YnLX|d
kr�d}|j�
��
r|j�
rt|jj�
�d�
}n|d}|
�d
|�

z.|j��}|�
rHt|t��
sHt|�
�d�
}Wn(tk
�
r`


YnR


t	�
�
Yn@X|j���
r�|j�
r�t|jj�
�d�
}n|d}|
�d|�

z|jj}Wn(tk
�
r�


Yn,


t	�
�
YnX|
�dd�|���
�

|
S)z�
        Return a list of server capabilities suitable for use in a CAPA
        response.

        @rtype: L{list} of L{bytes}
        @return: A list of server capabilities.
        sTOPrd�UIDLsPIPELINEsCELERITYsAUSPEXsPOTENCErLsIMPLEMENTATION NsNEVERs USERsEXPIRE sLOGIN-DELAY sSASL rS)�IServerFactoryZ
providedByrnZcap_IMPLEMENTATIONrNr3rOrP�NotImplementedErrorrr�rAZ
cap_EXPIREZperUserExpirationr�ZmessageExpirationZcap_LOGIN_DELAYZperUserLoginDelayZ
loginDelay�challengersr��join�keys)rZbaseCapsrDrrr�listCapabilitiesasl	





�






































zPOP3.listCapabilitiesc
Cs0|�d
�

|�
�D]}
|�|
�

q|�d�

dS)zW
        Handle a CAPA command.

        Respond with the server capabilities.
        sI can do the following:�
.N)rRr�rw)rZcaprrr�do_CAPA�s



zPOP3.do_CAPAcCs�t|j
d
d�s|�d�

dS|
dkrX|�d�

|j
jD]}|�|���

q6|�d�

dS|j
j�|
�����
}|j	rx|s�|�d�

dS|�|_
|j
��}|�dt�
|�
�d�
�

d	|_dS)
a�

        Handle an AUTH command.

        If the AUTH extension is not supported, send an error response.  If an
        authentication mechanism was not specified in the command, send a list
        of all supported authentication methods.  Otherwise, send an
        authentication challenge to the client and transition to the
        AUTH state.

        @type args: L{bytes} or L{None}
        @param args: The name of an authentication mechanism.
        r�NsAUTH extension unsupportedz!Supported authentication methods:r�sUnsupported SASL selecteds+ r/ZAUTH)rmrnrxrRr�rwr��get�strip�portal�_authZgetChallenge�base64Zencodestring�rstripry)rr��
aZauthZchalrrr�do_AUTH�s"


















zPOP3.do_AUTHcCs�d
|_zt
�|
�
�dd�}Wn tjk
r<


|�d�

YnpXt|�
dkrX|�d�

dS|d|j_	|d|j_
|j�|jdt
�}|�|j|d�
|�|j�

|�|j�

dS)a�

        Handle received lines for the AUTH state in which an authentication
        challenge response from the client is expected.

        Transition back to the COMMAND state.  Check the credentials and
        complete the authorization process with the L{_cbMailbox}
        callback function on success or the L{_ebMailbox} and L{_ebUnexpected}
        errback functions on failure.

        @type line: L{bytes}
        @param line: The challenge response.
        rhNr#sInvalid BASE64 encodingr.sInvalid AUTH responser
)ryr�Zdecodestringr2�binascii�ErrorrxrCr�rrQr��login�IMailbox�addCallback�
_cbMailbox�
addErrback�
_ebMailbox�
_ebUnexpected)rr{�parts�
drrr�
state_AUTH�s













zPOP3.state_AUTHcCs2t�
|j|
|�}|j|j|j|
f
d
��|j�

dS)a�

        Handle an APOP command.

        Perform APOP authentication and complete the authorization process with
        the L{_cbMailbox} callback function on success or the L{_ebMailbox}
        and L{_ebUnexpected} errback functions on failure.

        @type user: L{bytes}
        @param user: A username.

        @type digest: L{bytes}
        @param digest: An MD5 digest string.
        �
ZcallbackArgsN)r�
maybeDeferred�authenticateUserAPOP�addCallbacksr�r�r�r�)r�userrr�rrr�do_APOP�s

�zPOP3.do_APOPcCs`|
\}}}|tk	r*|�
d
�

t�d�

dS||_||_|�d�

t|jdd�r\t�	d|�

dS)a�
        Complete successful authentication.

        Save the mailbox and logout function for the authenticated user and
        send a successful response to the client.

        @type result: C{tuple}
        @param interface_avatar_logout: The first item of the tuple is a
            C{zope.interface.Interface} which is the interface
            supported by the avatar.  The second item of the tuple is a
            L{IMailbox} provider which is the mailbox for the
            authenticated user.  The third item of the tuple is a no-argument
            callable which is a function to be invoked when the session is
            terminated.

        @type user: L{bytes}
        @param user: The user being authenticated.
        �Authentication failedz9_cbMailbox() called with an interface other than IMailboxNzAuthentication succeededriTsAuthenticated login for )
r�rxrr�r�rrrRrmrnro)r�resultr�Z	interfaceZavatarZlogoutrrrr�s





�




zPOP3._cbMailboxcCsx|
�t
jjt
jj�}
t|
t
jj�r6|�d
t|
�
�

nt|
t
jj�rN|�d�

t|j	dd�rtt
�dt|j�
��
�

dS)a

        Handle an expected authentication failure.

        Send an appropriate error response for a L{LoginDenied} or
        L{LoginFailed} authentication failure.

        @type failure: L{Failure}
        @param failure: The authentication error.
        zAccess denied: r�riTzDenied login attempt from N)Ztrapr�errorZLoginDeniedZLoginFailed�
issubclassrxrOrmrnrrorFrp�rZfailurerrrr�1s








�zPOP3._ebMailboxcCs |�d
|
�
��

t�|
�

dS)z�
        Handle an unexpected authentication failure.

        Send an error response for an unexpected authentication failure.

        @type failure: L{Failure}
        @param failure: The authentication error.
        zServer error: N)rx�getErrorMessagerr�r�rrrr�Fs	
zPOP3._ebUnexpectedcCs|
|_|�
d
�

dS)z�
        Handle a USER command.

        Save the username and send a successful response prompting the client
        for the password.

        @type user: L{bytes}
        @param user: A username.
        sUSER accepted, send PASSN)�_userIsrR�rr�rrr�do_USERSs

zPOP3.do_USERcCsV|jd
kr|�
d�

d
S|j}d
|_t�|j||
�}|j|j|j|f
d��|j	�

d
S)a�

        Handle a PASS command.

        If a USER command was previously received, authenticate the user and
        complete the authorization process with the L{_cbMailbox} callback
        function on success or the L{_ebMailbox} and L{_ebUnexpected} errback
        functions on failure.  If a USER command was not previously received,
        send an error response.

        @type password: L{bytes}
        @param password: A password.
        NsUSER required before PASSr�)
r�rxrr��authenticateUserPASSr�r�r�r�r�)rrr�r�rrr�do_PASSas








�zPOP3.do_PASScs:�j�
��
d
�

g�_|
��j�

|
���
fdd��

|
S)a�

        Stop timeouts and block further command processing while a long
        operation completes.

        @type d: L{Deferred <defer.Deferred>}
        @param d: A deferred which triggers at the completion of a long
            operation.

        @rtype: L{Deferred <defer.Deferred>}
        @return: A deferred which triggers after command processing resumes and
            timeouts restart after the completion of a long operation.
        Nc

s
���
�
S�
N)
rk)
Zign�rrlrr�<lambda>�r$z%POP3._longOperation.<locals>.<lambda>)rlrkr}r�r�)rr�rr�r�_longOperationxs






zPOP3._longOperationcCs|�t
|jj|
��
S)
aG

        Direct the output of an iterator to the transport and arrange for
        iteration to take place.

        @type gen: iterable which yields L{bytes}
        @param gen: An iterator over strings.

        @rtype: L{Deferred <defer.Deferred>}
        @return: A deferred which fires when the iterator finishes.
        )rHr6rFrG)rrJrrr�
_coiterate�s
�zPOP3._coiteratec
s8t�
�jj�
}
�f
d
d�}�f
dd�}��|
�||��
S)z�
        Handle a STAT command.

        @rtype: L{Deferred <defer.Deferred>}
        @return: A deferred which triggers after the response to the STAT
            command has been issued.
        c

s��t
|�
�
Sr�)r�rX�
rUr=rr�
cbMessages�s
z POP3.do_STAT.<locals>.cbMessagesc

s&��|�
��

t�d
�

t�|�

dS)NzUnexpected do_STAT failure:�rxr�rror��
r�r=rr�
ebMessages�s



z POP3.do_STAT.<locals>.ebMessages)rr�r��listMessagesr�r�)rr�r�r�rr=r�do_STAT�s
zPOP3.do_STATcs��d
kr@t�
�
jj�
}�
f
dd�}�
f
dd�}�
�|�||��
Szt��
��dkrXt��
Wn:tk
r�


t�t	�s�t
��
�d�
��
�d��

YnHXt�
�
jj�d�}��
fd	d
�}��
fdd�}|�||�
�
�|�
Sd
S)
a

        Handle a LIST command.

        @type i: L{bytes} or L{None}
        @param i: A 1-based message index.

        @rtype: L{Deferred <defer.Deferred>}
        @return: A deferred which triggers after the response to the LIST
            command has been issued.
        Nc

s��t
|�
�
Sr�)r�r\r�r=rrr��s
z POP3.do_LIST.<locals>.cbMessagesc

s&��|�
��

t�d
�

t�|�

dS)N�Unexpected do_LIST failure:r�r�r=rrr��s



z POP3.do_LIST.<locals>.ebMessagesr#rL�Invalid message-number: c

s�
�t
��
d
t
|�
�

dS)NrSrT)
ro�rVrrr�	cbMessage�s

�zPOP3.do_LIST.<locals>.cbMessagec
s~|�t
t�}
|
dk	rX|
tkr(t�d
t�
�}|rHt|t�sHt|�
�	d�
}�
�
d|�

n"�
�
|���

t�
d�

t�|�

dS)N�}twisted.mail.pop3.IMailbox.listMessages may not raise IndexError for out-of-bounds message numbers: raise ValueError instead.rLr�r�)�checkr��
IndexError�warnings�warn�PendingDeprecationWarningrNr3rOrPrxr�rror�)r��errclsZ
invalidNumr�rr�	ebMessage�s 



�



�


zPOP3.do_LIST.<locals>.ebMessage)
rr�r�r�r�r��intr�rNr3rOrPrx)rrVr�r�r�r�r�rr�r�do_LIST�s$












zPOP3.do_LISTcs�|
d
kr@t�
�jj�
}�f
dd�}�f
dd�}��|�||��
Szt|
�
}
|
dkrXt��
Wntk
rx


��d�

Yn�Xz�j�	|
d�
}WnFt
k
r�


t�dt
�
��d�

Yn@tk
r�


��d�

Yn$Xt|t�s�t|�
�d	�
}��|�

d
S)
a

        Handle a UIDL command.

        @type i: L{bytes} or L{None}
        @param i: A 1-based message index.

        @rtype: L{Deferred <defer.Deferred>}
        @return: A deferred which triggers after the response to the UIDL
            command has been issued.
        Nc

s��t
|�jj��
Sr�)r�rbr�r^r�r=rrr��s

�z POP3.do_UIDL.<locals>.cbMessagesc

s&��|�
��

t�d
�

t�|�

dS)NzUnexpected do_UIDL failure:r�r�r=rrr��s



z POP3.do_UIDL.<locals>.ebMessagesr#�Bad message number argumentzxtwisted.mail.pop3.IMailbox.getUidl may not raise IndexError for out-of-bounds message numbers: raise ValueError instead.rL)rr�r�r�r�r�r�r�rxr^r�r�r�r�rNr3rOrPrR)rrVr�r�r�rorr=r�do_UIDL�s0










�




zPOP3.do_UIDLcs�zt|
�
d
��dkrt
��
Wn(t
k
rF


�
�d�

t�d�
YSXt��
jj��}��
fdd�}�
f
dd�}|�|�

|�	|�

|S)	a�

        Retrieve the size and contents of a message.

        @type i: L{bytes}
        @param i: A 1-based message index.

        @rtype: L{Deferred <defer.Deferred>} which successfully fires with
            2-L{tuple} of (E{1}) L{int}, (E{2}) file-like object
        @return: A deferred which successfully fires with the size of the
            message and a file containing the contents of the message.
        r#r
r�Nc
s6�st�
t��
St��jj�
�}
|
��f
d
d��

|
S)Nc

s�|fSr�r)
ZfObj�
rWrrr�3r$z=POP3._getMessageFile.<locals>.cbMessageSize.<locals>.<lambda>)rZfailrr�r��
getMessager�)rWZfileDeferred�rorr�r�
cbMessageSize/s





z+POP3._getMessageFile.<locals>.cbMessageSizec
sf|�t
tt�}
|
t
kr"��d
�

n@|
ttfkrN|
tkrBt�dt�
��d�

nt�	d�

t�
|�

dS)Nzmessage deletedr�r�z#Unexpected _getMessageFile failure:)r�rr�r�rxr�r�r�rror�)r�r�r=rr�ebMessageSomething6s





�



z0POP3._getMessageFile.<locals>.ebMessageSomething)
r�r�rxrZsucceedr�r�r�r�r�)rrVZsizeDeferredr�r�rr�r�_getMessageFiles












zPOP3._getMessageFilecs,���
�
}��
��fd
d�}��
|�|�
�
S)a�

        Send the contents of a message.

        @type i: L{bytes}
        @param i: A 1-based message index.

        @type fpWrapper: callable that takes a file-like object and returns
            a file-like object
        @param fpWrapper:

        @type successResponse: callable that takes L{int} and returns
            L{bytes}
        @param successResponse:

        @rtype: L{Deferred}
        @return: A deferred which triggers after the message has been sent.
        c
s�|dkrdSt�j
t�
�
��_
|\}
}�|�
}���|
�
�

t��}|�|�j�j�}�f
d
d�}�f
dd�}|�	|�

|�
|�

|S)Nc
s |d
krd}
nd}
��|
�

dS)Nr/�
.r��
rw)�lastsentr{r=rr�cbFileTransferms


zGPOP3._sendMessageContent.<locals>.cbMessageFile.<locals>.cbFileTransferc

s"�j�
�
t�d
�

t�|�

dS)Nz(Unexpected error in _sendMessageContent:)rF�loseConnectionrror�r�r=rr�ebFileTransferts




zGPOP3._sendMessageContent.<locals>.cbMessageFile.<locals>.ebFileTransfer)�max�_highestr�rRrZ
FileSenderZbeginFileTransferrF�transformChunkr�r�)�infoZresp�fp�
sr�r�r���	fpWrapperrVrrRrr�
cbMessageFile`s









z/POP3._sendMessageContent.<locals>.cbMessageFile)r�r�r�)rrVr�rRr�r�rr�r�_sendMessageContentMs

zPOP3._sendMessageContentcsVzt��
��d
krt
�
Wnt
k
r6


|�d�

YnX|�|
�f
dd�dd��SdS)a[

        Handle a TOP command.

        @type i: L{bytes}
        @param i: A 1-based message index.

        @type size: L{bytes}
        @param size: The number of lines of the message to retrieve.

        @rtype: L{Deferred}
        @return: A deferred which triggers after the response to the TOP
            command has been issued.
        r
zBad line count argumentc

s
t|��Sr�)
r"�
r�r�rrr��r$zPOP3.do_TOP.<locals>.<lambda>c


Ssd
S)NzTop of message followsrr�rrrr��r$N)r�r�rxr�)rrVrWrr�r�do_TOPs








�zPOP3.do_TOPcCs|�|
d
d�dd��S)z�
        Handle a RETR command.

        @type i: L{bytes}
        @param i: A 1-based message index.

        @rtype: L{Deferred}
        @return: A deferred which triggers after the response to the RETR
            command has been issued.
        c


Ss|Sr�rr�rrrr��r$zPOP3.do_RETR.<locals>.<lambda>c

Ss
d
|f
S)Nz%drr�rrrr��r$)
r��rrVrrr�do_RETR�s



�zPOP3.do_RETRcCs|
�d
d��dd�S)a�

        Transform a chunk of a message to POP3 message format.

        Make sure each line ends with C{'\r\n'} and byte-stuff the
        termination character (C{'.'}) by adding an extra one when one appears
        at the beginning of a line.

        @type chunk: L{bytes}
        @param chunk: A string to transform.

        @rtype: L{bytes}
        @return: The transformed string.
        r/rMr�s
..)
�replace)r�chunkrrrr��szPOP3.transformChunkcCs |
d
krd}nd}|�|�

dS)z�
        Send the termination sequence.

        @type lastsent: L{bytes}
        @param lastsent: The last character of the file.
        r/r�r�Nr�)rr�r{rrr�finishedFileTransfer�s

zPOP3.finishedFileTransfercCs$t|
�
d
}
|j
�|
�

|��
dS)z�
        Handle a DELE command.

        Mark a message for deletion and issue a successful response.

        @type i: L{int}
        @param i: A 1-based message index.
        r#N)r�r��
deleteMessagerRr�rrr�do_DELE�s	

zPOP3.do_DELEc

Cs|��
d
S)z]
        Handle a NOOP command.

        Do nothing but issue a successful response.
        N)
rRr=rrr�do_NOOP�szPOP3.do_NOOPc

Cs>z|j�
�
Wn


t��
|��
YnXd
|_|��
dS)zj
        Handle a RSET command.

        Unmark any messages that have been flagged for deletion.
        r
N)r��undeleteMessagesrr�rxr�rRr=rrr�do_RSET�s




zPOP3.do_RSETc

Cs|�|j
�

d
S)zr
        Handle a LAST command.

        Respond with the 1-based index of the highest retrieved message.
        N)rRr�r=rrr�do_LAST�szPOP3.do_LASTcCs|�d
�

dS)z�
        Handle an RPOP command.

        RPOP is not supported.  Send an error response.

        @type user: L{bytes}
        @param user: A username.

        zpermission denied, suckerN)
rxr�rrr�do_RPOP�s
zPOP3.do_RPOPc

Cs&|jr|j�
�
|��
|j��
d
S)z�
        Handle a QUIT command.

        Remove any messages marked for deletion, issue a successful response,
        and drop the connection.
        N)r��syncrRrFr�r=rrr�do_QUITs



zPOP3.do_QUITcCs2|jd
k	r$|j�
t|j|
|�d
t�Stj���
d
S)ax
        Perform APOP authentication.

        @type user: L{bytes}
        @param user: The name of the user attempting to log in.

        @type digest: L{bytes}
        @param digest: The challenge response.

        @rtype: L{Deferred <defer.Deferred>} which successfully results in
            3-L{tuple} of (E{1}) L{IMailbox <pop3.IMailbox>}, (E{2})
            L{IMailbox <pop3.IMailbox>} provider, (E{3}) no-argument callable
        @return: A deferred which fires when authentication is complete.  If
            successful, it returns an L{IMailbox <pop3.IMailbox>} interface, a
            mailbox, and a function to be invoked with the session is
            terminated.  If authentication fails, the deferred fails with an
            L{UnathorizedLogin <cred.error.UnauthorizedLogin>} error.

        @raise cred.error.UnauthorizedLogin: When authentication fails.
        N)r�r�rrr�rr��UnauthorizedLogin�rr�rrrrr�s




�zPOP3.authenticateUserAPOPcCs2|jd
k	r$|j�
tj�|
|�d
t�Stj���
d
S)a�
        Perform authentication for a username/password login.

        @type user: L{bytes}
        @param user: The name of the user attempting to log in.

        @type password: L{bytes}
        @param password: The password to authenticate with.

        @rtype: L{Deferred <defer.Deferred>} which successfully results in
            3-L{tuple} of (E{1}) L{IMailbox <pop3.IMailbox>}, (E{2}) L{IMailbox
            <pop3.IMailbox>} provider, (E{3}) no-argument callable
        @return: A deferred which fires when authentication is complete.  If
            successful, it returns a L{pop3.IMailbox} interface, a mailbox,
            and a function to be invoked with the session is terminated.
            If authentication fails, the deferred fails with an
            L{UnathorizedLogin <cred.error.UnauthorizedLogin>} error.

        @raise cred.error.UnauthorizedLogin: When authentication fails.
        N)r�r�r�credentialsZUsernamePasswordr�r�r
)rr�rrrrr�2s




�zPOP3.authenticateUserPASS)
ra)
r$)
N)
N)
N)9rrr r!rr�rrr�r�rnr�rlryr}�staticmethodrZ	coiteraterHr�rqrtrjrRrxr|r�r�rr�r�r�r�r�r�r�r�r�r�r�r�r�r�r�r�r�r�r�r�r�r�r�r�r�r
r
r�r�rrrrrc�
sf6








M
$"

;
032		

rcc@sBeZ
dZd
Zddd�
Zdd�Zdd�Zd	d
�Zdd�Zd
d�Z	dS)�Mailboxz%
    A base class for mailboxes.
    Nc
CsgS)
a�
        Retrieve the size of a message, or, if none is specified, the size of
        each message in the mailbox.

        @type i: L{int} or L{None}
        @param i: The 0-based index of the message.

        @rtype: L{int}, sequence of L{int}, or L{Deferred <defer.Deferred>}
        @return: The number of octets in the specified message, or, if an
            index is not specified, a sequence of the number of octets for
            all messages in the mailbox or a deferred which fires with
            one of those. Any value which corresponds to a deleted message
            is set to 0.

        @raise ValueError or IndexError: When the index does not correspond to
            a message in the mailbox.  The use of ValueError is preferred.
        rr�rrrr�VszMailbox.listMessagesc
Cst�
d
S)a

        Retrieve a file containing the contents of a message.

        @type i: L{int}
        @param i: The 0-based index of a message.

        @rtype: file-like object
        @return: A file containing the message.

        @raise ValueError or IndexError: When the index does not correspond to
            a message in the mailbox.  The use of ValueError is preferred.
        N�
r�r�rrrr�ks
zMailbox.getMessagec
Cst�
d
S)a�

        Get a unique identifier for a message.

        @type i: L{int}
        @param i: The 0-based index of a message.

        @rtype: L{bytes}
        @return: A string of printable characters uniquely identifying the
            message for all time.

        @raise ValueError or IndexError: When the index does not correspond to
            a message in the mailbox.  The use of ValueError is preferred.
        Nr
r�rrrr^{szMailbox.getUidlc
Cst�
d
S)a�

        Mark a message for deletion.

        This must not change the number of messages in this mailbox.  Further
        requests for the size of the deleted message should return 0.  Further
        requests for the message itself may raise an exception.

        @type i: L{int}
        @param i: The 0-based index of a message.

        @raise ValueError or IndexError: When the index does not correspond to
            a message in the mailbox.  The use of ValueError is preferred.
        Nr
r�rrrr��szMailbox.deleteMessagec


Csd
S)z�
        Undelete all messages marked for deletion.

        Any message which can be undeleted should be returned to its original
        position in the message sequence and retain its original UID.
        Nrr=rrrr��szMailbox.undeleteMessagesc


Csd
S)zJ
        Discard the contents of any message marked for deletion.
        Nrr=rrrr

�szMailbox.sync)
N)
rrr r!r�r�r^r�r�r

rrrrr
Qs

r
r,c@s�eZ
dZd
ZeZdZddlZe�d�
Z	dd�Z
d'dd	�
Zd
d�Zdd
�Z
dd�Zdd�Zdd�Zdd�Zdd�Zdd�Zdd�Zd(dd�
Zd)dd �
Zd!d"�Zd#d$�ZeZd%d&�ZdS)*�
POP3Clienta}
    A POP3 client protocol.

    @type mode: L{int}
    @ivar mode: The type of response expected from the server.  Choices include
    none (0), a one line response (1), the first line of a multi-line
    response (2), and subsequent lines of a multi-line response (3).

    @type command: L{bytes}
    @ivar command: The command most recently sent to the server.

    @type welcomeRe: L{RegexObject <re.RegexObject>}
    @ivar welcomeRe: A regular expression which matches the APOP challenge in
        the server greeting.

    @type welcomeCode: L{bytes}
    @ivar welcomeCode: The APOP challenge passed in the server greeting.
    sWELCOMEr
Ns<(.*)>c
Csd
dl}
|
j
dtdd�
dS)z,
        Issue deprecation warning.
        r
Nzdtwisted.mail.pop3.POP3Client is deprecated, please use twisted.mail.pop3.AdvancedPOP3Client instead.�)
�
stacklevel)r�r��DeprecationWarning)rr�rrrr�s


�zPOP3Client.__init__cCsN|d
k	r4t|t
�s t|�
�d�
}|�|
d|�

n
|�|
�

|
|_t|_d
S)z�
        Send a POP3 command to which a short response is expected.

        @type command: L{bytes}
        @param command: A POP3 command.

        @type params: stringifyable L{object} or L{None}
        @param params: Command arguments.
        NrLrS)rNr3rOrPrwr��SHORT�mode�rr�Zparamsrrr�	sendShort�s







zPOP3Client.sendShortcCsJ|r0t|t
�st|�
�d
�
}|�|
d|�

n
|�|
�

|
|_t|_dS)z�
        Send a POP3 command to which a long response is expected.

        @type command: L{bytes}
        @param command: A POP3 command.

        @type params: stringifyable L{object}
        @param params: Command arguments.
        rLrSN)rNr3rOrPrwr��
FIRST_LONGr
r
rrr�sendLong�s







zPOP3Client.sendLongcCs|
d
d�dkrt|_
d
S)z�
        Handle responses from the server for which no other handler exists.

        @type line: L{bytes}
        @param line: A received line.
        N���s-ERR)�NONEr
rzrrr�handle_defaults
zPOP3Client.handle_defaultcCsD|
�d
d�\}}|dkr$|j
��
n|j�|
�
}|r@|�d�
|_dS)z�
        Handle a server response which is expected to be a server greeting.

        @type line: L{bytes}
        @param line: A received line.
        rSr#s+OKN)r2rFr��	welcomeRe�match�groupZwelcomeCode)rr{�coder4r_rrr�handle_WELCOMEs



zPOP3Client.handle_WELCOMEcGsDz*t|d
|
�
d�
|�}|dk	r(||�
Wn


t��
YnXdS)a�

        Dispatch a response from the server for handling.

        Command X is dispatched to handle_X() if it exists.  If not, it is
        dispatched to the default handler.

        @type command: L{bytes}
        @param command: The command.

        @type default: callable that takes L{bytes} or
            L{None}
        @param default: The default handler.

        @type args: L{tuple} or L{None}
        @param args: Arguments to the handler function.
        Zhandle_rLN)rmr�rr�)rr��defaultr��methodrrr�	_dispatchs

�


zPOP3Client._dispatchcCs�|jt
ks|jtkr4t|j|_|�|j|j|
�
nd|jtkr�|
d
krht|j|_|�|jdd�
dS|
dd�d
kr�|
dd�}
|�|jdd|
�
dS)a�
        Dispatch a received line for processing.

        The choice of function to handle the received line is based on the
        type of response expected to the command sent to the server and how
        much of that response has been received.

        An expected one line response to command X is handled by handle_X().
        The first line of a multi-line response to command X is also handled by
        handle_X().  Subsequent lines of the multi-line response are handled by
        handle_X_continue() except for the last line which is handled by
        handle_X_end().

        @type line: L{bytes}
        @param line: A received line.
        r�s_endNr#s	_continue)r
r

r
�NEXTr
r�r
�LONGrzrrrr|9s










zPOP3Client.lineReceivedcCs&t||�
�
��d
�
}|�|
|�
dS)a@

        Perform an authenticated login.

        @type user: L{bytes}
        @param user: The username with which to log in.

        @type password: L{bytes}
        @param password: The password with which to log in.

        @type magic: L{bytes}
        @param magic: The challenge provided by the server.
        �asciiN)rrrP�apop)rr�rrrrrr�apopAuthenticateWs

zPOP3Client.apopAuthenticatecCs|�d
d�
|
|f�
�
dS)a

        Send an APOP command to perform authenticated login.

        @type user: L{bytes}
        @param user: The username with which to log in.

        @type digest: L{bytes}
        @param digest: The challenge response with which to authenticate.
        rfrSN)r
r�r
rrrr!
hs
zPOP3Client.apopcCs|�d
|
�
dS)z�
        Send a RETR command to retrieve a message from the server.

        @type i: L{int} or L{bytes}
        @param i: A 0-based message index.
        sRETRN�
r
r�rrr�retruszPOP3Client.retrcCs|�d
|
�
dS)z�
        Send a DELE command to delete a message from the server.

        @type i: L{int} or L{bytes}
        @param i: A 0-based message index.
        sDELEN�
r
r�rrr�deleszPOP3Client.deleracCs|�d
|
�
dS)a

        Send a LIST command to retrieve the size of a message or, if no message
        is specified, the sizes of all messages.

        @type i: L{int} or L{bytes}
        @param i: A 0-based message index or the empty string to specify all
            messages.
        sLISTNr#
r�rrr�list�s	zPOP3Client.listcCs|�d
|
�
dS)a,

        Send a UIDL command to retrieve the unique identifier of a message or,
        if no message is specified, the unique identifiers of all messages.

        @type i: L{int} or L{bytes}
        @param i: A 0-based message index or the empty string to specify all
            messages.
        r�Nr#
r�rrr�uidl�s	zPOP3Client.uidlcCs|�d
|
�
dS)z�
        Send a USER command to perform the first half of a plaintext login.

        @type name: L{bytes}
        @param name: The username with which to log in.
        rdNr%
)r�namerrrr��szPOP3Client.usercCs|�d
|
�
dS)z�
        Perform the second half of a plaintext login.

        @type password: L{bytes}
        @param password: The plaintext password with which to authenticate.
        reNr%
)rrrrrr�szPOP3Client.passwordc

Cs|�d
�

dS)zD
        Send a QUIT command to disconnect from the server.
        rgNr%
r=rrr�quit�szPOP3Client.quit)
N)
ra)
ra)rrr r!r

r
r��re�compiler
rr
r
r
r
r
r|r"
r!
r$
r&
r'
r(
r�rZpass_r*
rrrrr	
�s,











	r	
)
r	
)
� InsecureAuthenticationDisallowed)
�ServerErrorResponse)
�LineTooLong)
�TLSError)
�TLSNotSupportedErrorr�r�rr
r-
r.
r/
r0
r1
�AdvancedPOP3Client)Br!r�r�r�ZhashlibrZzope.interfacerZtwistedrZtwisted.internetrrrZtwisted.mailrZtwisted.mail.interfacesr	r�r
r�Ztwisted.mail._exceptrrr
Ztwisted.protocolsrrZtwisted.pythonrZtwisted.python.compatrrr
ZIUsernamePasswordrr"�objectr6rKrRrXrYr\r`rbZ	IProducerZLineOnlyReceiverZTimeoutMixinrcr
�ranger
r

r
r
r
r	
Ztwisted.mail.pop3clientr2
r-
r.
r/
r0
r1
�__all__rrrr�<module>s�












+US
L
]









�