twisted.mail.test.test_pop3.MyPOP3Downloader

class documentation

class MyPOP3Downloader(pop3.POP3Client):

Constructor: MyPOP3Downloader()

View In Hierarchy

A POP3 client which downloads all messages from the server.

Method handle_APOP Require an OK response to APOP.
Method handle_QUIT Require an OK response to QUIT.
Method handle_RETR_continue Record one line of message information.
Method handle_RETR_end Record the received message information.
Method handle_WELCOME Authenticate.
Instance Variable lines Undocumented
Instance Variable message Undocumented

Inherited from POP3Client:

Method __init__ Issue deprecation warning.
Method apop Send an APOP command to perform authenticated login.
Method apopAuthenticate Perform an authenticated login.
Method dele Send a DELE command to delete a message from the server.
Method handle_default Handle responses from the server for which no other handler exists.
Method lineReceived Dispatch a received line for processing.
Method list Send a LIST command to retrieve the size of a message or, if no message is specified, the sizes of all messages.
Method password Perform the second half of a plaintext login.
Method quit Send a QUIT command to disconnect from the server.
Method retr Send a RETR command to retrieve a message from the server.
Method sendLong Send a POP3 command to which a long response is expected.
Method sendShort Send a POP3 command to which a short response is expected.
Method uidl Send a UIDL command to retrieve the unique identifier of a message or, if no message is specified, the unique identifiers of all messages.
Method user Send a USER command to perform the first half of a plaintext login.
Instance Variable command The command most recently sent to the server.
Instance Variable 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).
Instance Variable welcomeCode The APOP challenge passed in the server greeting.
Instance Variable welcomeRe A regular expression which matches the APOP challenge in the server greeting.
Method _dispatch Dispatch a response from the server for handling.

Inherited from LineOnlyReceiver (via POP3Client):

Method dataReceived Translates bytes into lines, and calls lineReceived.
Method lineLengthExceeded Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way.
Method sendLine Sends a line to the other end of the connection.
Constant MAX_LENGTH The maximum length of a line to allow (If a sent line is longer than this, the connection is dropped). Default is 16384.
Class Variable delimiter The line-ending delimiter to use. By default this is b'\r\n'.
Instance Variable _buffer Undocumented

Inherited from Protocol (via POP3Client, LineOnlyReceiver):

Method connectionLost Called when the connection is shut down.
Method logPrefix Return a prefix matching the class name, to identify log messages related to this protocol instance.
Class Variable factory Undocumented

Inherited from BaseProtocol (via POP3Client, LineOnlyReceiver, Protocol):

Method connectionMade Called when a connection is made.
Method makeConnection Make a connection to a transport and a server.
Instance Variable connected Undocumented
Instance Variable transport Undocumented
def handle_APOP(self, line):

Require an OK response to APOP.

Parameters
lineThe APOP response.
def handle_QUIT(self, line):

Require an OK response to QUIT.

Parameters
lineThe QUIT response.
def handle_RETR_continue(self, line):

Record one line of message information.

Parameters
lineA RETR response line.
def handle_RETR_end(self):

Record the received message information.

def handle_WELCOME(self, line):
overrides twisted.mail.pop3.POP3Client.handle_WELCOME

Authenticate.

Parameters
lineThe welcome response.
lines: list =

Undocumented

message =

Undocumented