|
Server : LiteSpeed System : Linux host 5.15.0-161-generic #171-Ubuntu SMP Sat Oct 11 08:17:01 UTC 2025 x86_64 User : idnco5810 ( 1093) PHP Version : 8.2.29 Disable Function : NONE Directory : /lib/python3/dist-packages/twisted/mail/__pycache__/ |
Upload File : |
o
�bg� � @ s� d Z ddlZddlZddlZddlmZ ddlmZ ddlm Z ddl
m Z ddl m
Z
mZmZ ddlmZ dd lmZmZmZ dd
lmZmZ dd lm Z m Z dd l m Z e e j j!�G d
d� d��Z"G dd� d�Z#G dd� d�Z$dd� Z%dd� Z&dd� Z'dd� Z(dd � Z)d d � Z*d d � Z+e ej,�G d!d"� d"e j-e j.��Z/e e�G d#d$� d$��Z0e1d%�\Z2Z3Z4Z5i Z6e2e6e2< e2e6e3< e5e6e4< e2e6e5< G d&d'� d'e j-�Z7dd(lm8Z8m9Z9m:Z:m;Z;m<Z< dd)l=m7Z> g d*�Z?dS )+zQ
Post-office Protocol version 3.
@author: Glyph Lefkowitz
@author: Jp Calderone
� N)�md5)�Optional)� implementer)�cred)�defer�
interfaces�task)�smtp)�POP3ClientError� POP3Error�_POP3MessageDeleted)� IMailboxPOP3�IServerFactoryPOP3)�basic�policies)�logc @ � e Zd ZdZdd� Zdd� ZdS )�APOPCredentialsz�
Credentials for use in APOP authentication.
@ivar magic: See L{__init__}
@ivar username: See L{__init__}
@ivar digest: See L{__init__}
c C s || _ || _|| _dS )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)�selfr r r � r �3/usr/lib/python3/dist-packages/twisted/mail/pop3.py�__init__- s
zAPOPCredentials.__init__c C s | 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.
)r r � hexdigestr )r �password�seed�myDigestr r r �
checkPassword> s
z APOPCredentials.checkPasswordN)�__name__�
__module__� __qualname__�__doc__r r r r r r r # s r c @ r )�_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.
c C s( || _ || _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 �file�
extraLinesr r r r f s
z_HeadersPlusNLines.__init__c C s� | j rdS | j�|�}|s|S | jrA|�d�d}}|dkr&|�d�d}}|dkr@||7 }|d|� }||d� }d| _d | _nd}| jd krz| j| �d
�}|d | _|dd� D ] }| j| jkrjd| _ | S ||d
7 }| jd7 _q[|S |S ) 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�data�df�sz�val�dsplit�lnr r r r3 u s8 �
z_HeadersPlusNLines.readN)r r! r" r# r r3 r r r r r$ N s r$ c @ s2 e Zd ZdZdZd
dd�Zdd� Zdd � ZeZdS ) �_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 Nc C s, g | _ || _t|�| _|du rd}|| _dS )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)r r? �iterablerB r r r r � s
z_IteratorBuffer.__init__c C � | S )z�
Return an iterator.
@rtype: iterator which yields L{bytes}
@return: An iterator over strings.
r �r r r r �__iter__� � z_IteratorBuffer.__iter__c C s� zt | j�}W n ty | jr| �| j� | `| `| `� w |durF| j�|� | jt|�7 _| j| jkrH| �| j� g | _d| _dS dS dS )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 ) �nextrA �
StopIterationr> r? �append�bufSize�lenrB )r �vr r r �__next__� s" �
�z_IteratorBuffer.__next__�N) r r! r" r# rK r rF rN rH r r r r r= � s
r= c C s t | jj|�}| �|�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.
)r= � transport�
writeSequence�schedule)�proto�gen�collr r r �iterateLineGenerator� s
rV c C s$ t | t�s t| ��d�} d| d S )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 �
)�
isinstancer6 �str�encode)�responser r r �successResponse s
r] c c s@ � d}d}| D ]
}|d7 }||7 }dV qt d||f �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� %d %d�r] )�msgs�ir6 �sizer r r �formatStatResponse s �rc c c s* � d}| D ]
}|d7 }d||f V 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% s %d %d
Nr )r` ra rb r r r �formatListLines+ s � �rd c c s. � t dt| �f �V t| �E dH dV 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.
s %dN� .
)r] rL rd �r` r r r �formatListResponse= s �
rg c c sR � t | �D ]!\}}|dur&||�}t|t�s t|��d�}d|d |f V qdS )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.
NrW s %d %b
r% )� enumeraterY r6 rZ r[ )r` �getUidlra �m�uidr r r �formatUIDListLinesO s �
��rl c c s& � t d�V t| |�E dH dV 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.
� Nre )r] rl )r` ri r r r �formatUIDListResponsec s �
rn c @ s� e Zd ZU dZdZee ed< dZdZ g d�Z
dZ dZ dZ
dZdZdZeej�ZdZdd � Zd
d � Zd d
� ZdXdd�ZdYdd�Zdd� Zdd� Z dd� Z dd� Z d d � Z d d � Z dZd d!�Z!d"d#� Z"d$d%� Z#d&d'� Z$d(d)� Z%d*d+� Z&d,d-� Z'd.d/� Z(d0d1� Z)d2d3� Z*d4d5� Z+dZd6d7�Z,dZd8d9�Z-d:d;� Z.d<d=� Z/d>d?� Z0d@dA� Z1dBdC� Z2dDdE� Z3dFdG� Z4dHdI� Z5dJdK� Z6dLdM� Z7dNdO� Z8dPdQ� Z9dRdS� Z:dTdU� Z;dVdW� Z<dS )[�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.
Nr )s CAPA� USER� PASS� APOPs AUTHs RPOP� QUITi, �COMMANDr c C sZ | j du r
| �� | _ | �| j � | �| j� t| jdd�r+t�dt | j
� � � � dS dS )zS
Send a greeting to the client after the connection has been made.
N�noisyTzNew connection from ) r �
generateMagicr] �
setTimeout�timeOut�getattr�factoryr �msgrZ rP �getPeerrE r r r �connectionMade� s
�zPOP3.connectionMadec C s& | j dur | � � d| _ | �d� dS )z�
Clean up when the connection has been lost.
@type reason: L{Failure}
@param reason: The reason the connection was terminated.
N)� _onLogoutrw )r �reasonr r r �connectionLost� s
zPOP3.connectionLostc C s t �� S )z}
Generate an APOP challenge.
@rtype: L{bytes}
@return: An RFC 822 message id format string.
)r � messageidrE r r r rv � s zPOP3.generateMagicrm c C s | j �t|�� dS )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)rP r? r] �r �messager r r r] � s zPOP3.successResponser& c C s* t |t�s t|��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.
rW s -ERR N)rY r6 rZ r[ �sendLiner� r r r � failResponse� s
zPOP3.failResponsec C s | � � t| d| j �|� dS )z�
Pass a received line to a state machine function.
@type line: L{bytes}
@param line: A received line.
�state_N)� resetTimeoutry �state�r �liner r r � lineReceived s zPOP3.lineReceivedc C sf | j }d| _ |r$| j du r$|�d�\}}| j|g|�R � |r$| j du s
| j dur1| j �|� dS dS )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 �_�commands�cmd�argsr r r �_unblock s
�
�z
POP3._unblockc C sr z | j |�d�� W S ttttfy8 } z t�� | �d� d|j
j � d�d� |j
�g�� W Y d}~dS d}~ww )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.
� s : s bad protocol or serverrW r& N)r� r5 �
ValueError�AttributeErrorr � TypeErrorr �errr� �join� __class__r r[ r� )r r� �er r r �
state_COMMAND s
�����zPOP3.state_COMMANDc G st | j dur| j �||f� dS |�� }|| jv }| js#|s#td| ��t| d|�d� d�}|r4||� S td| ��)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 �do_rW s Unknown protocol command: )r� rJ �upper� AUTH_CMDS�mboxr ry �decode)r �commandr� �authCmd�fr r r r� 4 s
zPOP3.processCommandc C s� g d�}t �| j�r�z| j�� }|r t|t�s t|��d�}W n ty( Y n t y4 t
� � Y nw |� d| � z| j�
� }|rPt|t�sPt|��d�}W n tyZ Y n0 t yf t
� � Y n$w |du rmd}| j�� r�| jrt| jj��d�}n|d }|� d| � z| j�� }|r�t|t�s�t|��d�}W n ty� Y n* t y� t
� � Y n w | j�� r�| jr�t| jj��d�}n|d }|� d| � z| jj}W n ty� Y |S t y� t
� � Y |S w |� d d
�|�� � � |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.
)s TOPrp � UIDLs PIPELINEs CELERITYs AUSPEXs POTENCErW s IMPLEMENTATION Ns NEVERs USERs EXPIRE s LOGIN-DELAY s SASL r� )�IServerFactory�
providedByrz �cap_IMPLEMENTATIONrY r6 rZ r[ �NotImplementedError�
BaseExceptionr r� rJ �
cap_EXPIRE�perUserExpirationr� �messageExpiration�cap_LOGIN_DELAY�perUserLoginDelay�
loginDelay� challengersr� r� �keys)r �baseCapsrM r r r �listCapabilitiesN sp
� �
� �
� �
�
�zPOP3.listCapabilitiesc C s0 | � d� | �� D ]}| �|� q | �d� dS )zW
Handle a CAPA command.
Respond with the server capabilities.
s I can do the following:� .N)r] r� r� )r �capr r r �do_CAPA� s
z POP3.do_CAPAc C s� t | jdd�s| �d� dS |du r,| �d� | jjD ] }| �|�� � q| �d� dS | jj�|�� �� �}| j r<|sC| �d� dS |� | _
| j
� � }| �dt �
|� � 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� Ns AUTH extension unsupportedz!Supported authentication methods:r� s Unsupported SASL selecteds + �AUTH)ry rz r� r] r� r� r� �get�strip�portal�_auth� getChallenge�base64� b64encoder� )r r� �a�auth�chalr r r �do_AUTH� s"
z POP3.do_AUTHc C s� d| _ z t�|��dd�}W n tjy | �d� Y dS w t|�dkr,| �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.
rt Nr% s Invalid BASE64 encodingr1 s Invalid AUTH responser )r� r� � b64decoder5 �binascii�Errorr� rL r� r r\ r� �login�IMailbox� addCallback�
_cbMailbox�
addErrback�
_ebMailbox�
_ebUnexpected)r r� �parts�dr r r �
state_AUTH� s
�
zPOP3.state_AUTHc C s2 t �| j||�}|j| j| j|fd��| 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.
�� callbackArgsN)r �
maybeDeferred�authenticateUserAPOP� addCallbacksr� r� r� r� )r �userr r� r r r �do_APOP� s
�z POP3.do_APOPc C sd |\}}}|t ur| �d� t�d� dS || _|| _| �d� t| jdd�r0t� d| � dS 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 result: 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 succeededru Ts Authenticated login for )
r� r� r r� r� r~ r] ry rz r{ )r �resultr� � interface�avatar�logoutr r r r� � s
�zPOP3._cbMailboxc C s| |� tjjtjj�}t|tjj�r| �dt|� � n t|tjj�r'| �d� t| j dd�r<t
� dt| j �
� � � dS 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� ru TzDenied login attempt from N)�trapr �error� LoginDenied� LoginFailed�
issubclassr� rZ ry rz r r{ rP r| �r �failurer r r r� s
�zPOP3._ebMailboxc C s | � 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)r� �getErrorMessager r� r� r r r r� ) s zPOP3._ebUnexpectedc C s || _ | �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.
s USER accepted, send PASSN)�_userIsr] �r r� r r r �do_USER5 s
z POP3.do_USERc G sf | j du r | �d� dS | j }d| _ d�|f| �}t�| j||�}|j| j| j|fd�� | j
� dS )a2
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.
@type words: L{tuple} of L{bytes}
@param words: Other parts of the password split by spaces.
Ns USER required before PASSr� r� ) r� r� r� r r� �authenticateUserPASSr� r� r� r� r� )r r �wordsr� r� r r r �do_PASSB s
�z POP3.do_PASSc s: � 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 rO )rw )�ign�r rx r r �<lambda>n �
z%POP3._longOperation.<locals>.<lambda>)rx rw r� r� r� )r r� r r� r �_longOperation] s
zPOP3._longOperationc C s | � 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.
)rR r= rP rQ )r rT r r r �
_coiterateq s zPOP3._coiteratec s8 t �� jj�}� fdd�}� fdd�}� �|�||��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 � � � t| ��S rO )r� rc rf rE r r �
cbMessages� � z POP3.do_STAT.<locals>.cbMessagesc �& � � | �� � t�d� t�| � d S )NzUnexpected do_STAT failure:�r� r� r r{ r� �r� rE r r �
ebMessages� �
z POP3.do_STAT.<locals>.ebMessages)r r� r� � listMessagesr� r� )r r� r� r� r rE r �do_STAT~ s z POP3.do_STATc s� � du r t ��jj�}�fdd�}�fdd�}��|�||��S z
t� �� � dk r,t� �W n tyJ t� t �s@t
� �� d�� �� d� � Y dS w t ��jj� d �}� �fd d
�}� �fd d �}|�||� ��|�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 r� rO )r� rg rf rE r r r� � r� z POP3.do_LIST.<locals>.cbMessagesc r� )N�Unexpected do_LIST failure:r� r� rE r r r� � r� z POP3.do_LIST.<locals>.ebMessagesr% rW � Invalid message-number: c s �� d� | f � d S )Nr^ r_ )r{ �ra r r r � cbMessage� s z POP3.do_LIST.<locals>.cbMessagec s� | � tt�}|d ur-|tu rt�dt� � }|r$t|t�s$t|�� d�}��
d| � d S ��
| � � � t �
d� t �| � d S )N�}twisted.mail.pop3.IMailbox.listMessages may not raise IndexError for out-of-bounds message numbers: raise ValueError instead.rW r� r� )�checkr� �
IndexError�warnings�warn�PendingDeprecationWarningrY r6 rZ r[ r� r� r r{ r� )r� �errcls�
invalidNumr� r r � ebMessage� s �
z POP3.do_LIST.<locals>.ebMessage)
r r� r� r� r� r� �intr� rY r6 rZ r[ r� )r ra r� r� r� r� r r r� r �do_LIST� s( �
�
z POP3.do_LISTc s� |du r t �� jj�}� fdd�}� fdd�}� �|�||��S z
t|�}|dk r,t� �W n ty< � �d� Y dS w z
� j� |d �}W n# t
y\ t � dt
� � �d� Y dS tyj � �d� Y dS w t|t�swt|��d �}� �|� dS )
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��S rO )r� rn r� ri rf rE r r r� � s �z POP3.do_UIDL.<locals>.cbMessagesc r� )NzUnexpected do_UIDL failure:r� r� rE r r r� � r� 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.rW )r r� r� r� r� r� r r� r� ri r r r r rY r6 rZ r[ r] )r ra r� r� r� r{ r rE r �do_UIDL� s6 � � � �
z POP3.do_UIDLc s� zt |�d � � dk rt� �W n ty" ��d� t�d� Y S w t��jj� �}� �fdd�}�fdd�}|�|� |� |� |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� �S t ��jj��}|�� fdd�� |S )Nc s � | fS rO r )�fObj�rb r r r� s z=POP3._getMessageFile.<locals>.cbMessageSize.<locals>.<lambda>)r �failr r� r� �
getMessager� )rb � fileDeferred�r{ r r r �
cbMessageSize s
z+POP3._getMessageFile.<locals>.cbMessageSizec sj | � ttt�}|tu r� �d� d S |ttfv r)|tu r"t�dt� � �d� d S t� d� t�
| � d S )Nzmessage deletedr r z#Unexpected _getMessageFile failure:) r r r� r r� r r r r r{ r� )r� r rE r r �ebMessageSomething! s
��
�
z0POP3._getMessageFile.<locals>.ebMessageSomething)
r r� r� r �succeedr� r� r� r� r� )r ra � sizeDeferredr r r r r �_getMessageFile s �
�
zPOP3._getMessageFilec s, �� ��}� ���fdd�}��|�|��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� | d u rd S t �jt����_| \}}� |�}���|�� t�� }|�|�j�j�}�fdd�}�fdd�}|� |� |�
|� |S )Nc s | dkrd}nd}� � |� d S )Nr2 �
.r� �r� )�lastsentr� rE r r �cbFileTransferY s zGPOP3._sendMessageContent.<locals>.cbMessageFile.<locals>.cbFileTransferc s" � j �� t�d� t�| � d S )Nz(Unexpected error in _sendMessageContent:)rP �loseConnectionr r{ r� r� rE r r �ebFileTransfer` s
zGPOP3._sendMessageContent.<locals>.cbMessageFile.<locals>.ebFileTransfer) �max�_highestr r] r �
FileSender�beginFileTransferrP �transformChunkr� r� )�info�resp�fp�sr� r r �� fpWrapperra r r] r r �
cbMessageFileL s
z/POP3._sendMessageContent.<locals>.cbMessageFile)r r� r� )r ra r( r] r� r) r r' r �_sendMessageContent8 s
zPOP3._sendMessageContentc sR z t � �� � dk r t�W n ty | �d� Y dS w | �|� fdd�dd� �S )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 | � �S rO )r$ �r% r r r r� � r� z POP3.do_TOP.<locals>.<lambda>c S � dS )NzTop of message followsr r r r r r� � � N)r r� r� r* )r ra rb r r r �do_TOPk s � �
�z POP3.do_TOPc C s | � |dd� 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 S rD rO r r+ r r r r� � r- z POP3.do_RETR.<locals>.<lambda>c S s
d| f S )Nz%dr r r r r r� � r� )r* �r ra r r r �do_RETR� s z POP3.do_RETRc C s |� dd�� 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.
r2 rX r s
..)�replace)r �chunkr r r r" � s zPOP3.transformChunkc C s |dkrd}nd}| � |� dS )z�
Send the termination sequence.
@type lastsent: L{bytes}
@param lastsent: The last character of the file.
r2 r r� Nr )r r r� r r r �finishedFileTransfer� s zPOP3.finishedFileTransferc C s$ 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� �
deleteMessager] r/ r r r �do_DELE� s z POP3.do_DELEc C s | � � dS )z]
Handle a NOOP command.
Do nothing but issue a successful response.
Nr_ rE r r r �do_NOOP� s z POP3.do_NOOPc C sF z| j �� W n ty t�� | �� Y dS w d| _| �� dS )zj
Handle a RSET command.
Unmark any messages that have been flagged for deletion.
r N)r� �undeleteMessagesr� r r� r� r r] rE r r r �do_RSET� s � z POP3.do_RSETc C s | � | j� dS )zr
Handle a LAST command.
Respond with the 1-based index of the highest retrieved message.
N)r] r rE r r r �do_LAST� s z POP3.do_LASTc C � | � 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)r� r� r r r �do_RPOP� s
z POP3.do_RPOPc C s& | j r| j �� | �� | j�� dS )z�
Handle a QUIT command.
Remove any messages marked for deletion, issue a successful response,
and drop the connection.
N)r� �syncr] rP r rE r r r �do_QUIT� s
z POP3.do_QUITc C s. | j dur| j �t| j||�dt�S tj�� �)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� r r r� r r� �UnauthorizedLogin�r r� r r r r r� � �
�
zPOP3.authenticateUserAPOPc C s. | j dur| j �tj�||�dt�S tj�� �)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 � credentials�UsernamePasswordr� r� r> )r r� r r r r r� r@ zPOP3.authenticateUserPASSc C s t � �rO )r� rE r r r �
stopProducing* s zPOP3.stopProducing�rm )r& rO )=r r! r" r# r r r6 �__annotations__r� r~ r� r� rz r� rx r� r� � staticmethodr � coiteraterR r r} r� rv r] r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r
r r r* r. r0 r" r3 r5 r6 r8 r9 r; r= r� r� rC r r r r ro y sj
7
L
#
?343
ro c @ sB e Zd ZdZddd�Zdd� Zdd� Zd d
� Zd d � Zd
d� Z dS )�Mailboxz%
A base class for mailboxes.
Nc C s g S )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.
r r/ r r r r� 5 s zMailbox.listMessagesc C � t �)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.
�r� r/ r r r r I s
zMailbox.getMessagec C rI )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.
rJ r/ r r r ri X � zMailbox.getUidlc C rI )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.
rJ r/ r r r r4 h rK zMailbox.deleteMessagec C r, )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.
Nr rE r r r r7 x rG zMailbox.undeleteMessagesc C r, )zJ
Discard the contents of any message marked for deletion.
Nr rE r r r r< � s z Mailbox.syncrO )
r r! r" r# r� r ri r4 r7 r< r r r r rH / s
rH r/ c @ s� e Zd ZdZeZdZddlZe�d�Z dd� Z
d'dd �Z d
d � Z d d
� Z
dd� Zdd� Zdd� Zdd� Zdd� Zdd� Zdd� Zd(d d �Zd(d d �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{Pattern <re.Pattern.search>}
@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.
s WELCOMEr Ns <(.*)>c C s ddl }|jdtdd� dS )z,
Issue deprecation warning.
r Nzdtwisted.mail.pop3.POP3Client is deprecated, please use twisted.mail.pop3.AdvancedPOP3Client instead.� )�
stacklevel)r r �DeprecationWarning)r r r r r r � s
�zPOP3Client.__init__c C sN |durt |t�st|��d�}| �|d | � n| �|� || _t| _dS )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.
NrW r� )rY r6 rZ r[ r� r� �SHORT�mode�r r� �paramsr r r � sendShort� s
zPOP3Client.sendShortc C sJ |rt |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.
rW r� N)rY r6 rZ r[ r� r� �
FIRST_LONGrQ rR r r r �sendLong� s
zPOP3Client.sendLongc C s |dd� dkr
t | _dS dS )z�
Handle responses from the server for which no other handler exists.
@type line: L{bytes}
@param line: A received line.
N���s -ERR)�NONErQ r� r r r �handle_default� s
�zPOP3Client.handle_defaultc C sJ |� dd�\}}|dkr| j�� dS | j�|�}|r#|�d�| _dS dS )z�
Handle a server response which is expected to be a server greeting.
@type line: L{bytes}
@param line: A received line.
r� r% s +OKN)r5 rP r � welcomeRe�match�group� welcomeCode)r r� �coder7 rj r r r �handle_WELCOME� s �zPOP3Client.handle_WELCOMEc G sP zt | d|�d� |�}|dur||� W dS W dS ty' t�� Y dS w )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.
�handle_rW N)ry r� r� r r� )r r� �defaultr� �methodr r r � _dispatch� s � �zPOP3Client._dispatchc C s� | j tks
| j tkrt| j | _ | �| j| j|� dS | j tkrO|dkr5t| j | _ | �| jd d� dS |dd� dkrC|dd� }| �| jd d|� dS 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)rQ rP rU �NEXTrc r� rY �LONGr� r r r r� s
�zPOP3Client.lineReceivedc C s& 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)r r r[ �apop)r r� r r r r r r �apopAuthenticate- s
zPOP3Client.apopAuthenticatec C s | � dd�||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.
rr r� N)rV r� r? r r r rg = s
zPOP3Client.apopc C � | � 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.
s RETRN�rV r/ r r r �retrI � zPOP3Client.retrc C ri )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.
s DELEN�rT r/ r r r �deleR rl zPOP3Client.delerm c C ri )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.
s LISTNrj r/ r r r �list[ � zPOP3Client.listc C ri )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� Nrj r/ r r r �uidlf rp zPOP3Client.uidlc C ri )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.
rp Nrm )r �namer r r r� q rl zPOP3Client.userc C ri )z�
Perform the second half of a plaintext login.
@type password: L{bytes}
@param password: The plaintext password with which to authenticate.
rq Nrm )r r r r r r z rl zPOP3Client.passwordc C r: )zD
Send a QUIT command to disconnect from the server.
rs Nrm rE r r r �quit� s zPOP3Client.quitrO rD )r r! r" r# rP rQ r� �re�compilerZ r rT rV rY r_ rc r� rh rg rk rn ro rq r� r �pass_rs r r r r rL � s.
rL )� InsecureAuthenticationDisallowed� LineTooLong�ServerErrorResponse�TLSError�TLSNotSupportedError)rL )r� r� r r
rw ry rx rz r{ ro rL �AdvancedPOP3Clientr rH )@r# r� r� r �hashlibr �typingr �zope.interfacer �twistedr �twisted.internetr r r � twisted.mailr �twisted.mail._exceptr
r r �twisted.mail.interfacesr
r� r r� �twisted.protocolsr r �twisted.pythonr rA �IUsernamePasswordr r$ r= rV r] rc rd rg rl rn � IProducer�LineOnlyReceiver� TimeoutMixinro rH �rangerX rP rU re rd rL rw rx ry rz r{ �twisted.mail._pop3clientr| �__all__r r r r �<module> s^
*TP <X |