twisted.mail.test.test_pop3client.SimpleClient(POP3Client) class documentation

Part of twisted.mail.test.test_pop3client (View In Hierarchy)
Undocumented
Method __init__ Undocumented
Method serverGreeting Handle the server greeting.

Inherited from AdvancedPOP3Client:

Instance Variable startedTLS An indication of whether TLS has been negotiated successfully. (type: bool)
Instance Variable allowInsecureLogin An indication of whether plaintext login should be allowed when the server offers no authentication challenge and the transport does not offer any protection via encryption. (type: bool)
Instance Variable serverChallenge The challenge received in the server greeting. (type: bytes or None)
Instance Variable timeout The number of seconds to wait on a response from the server before timing out a connection. If the number is <= 0, no timeout checking will be performed. (type: int)
Instance Variable state The state which indicates what type of response is expected from the server. Valid states are: 'WELCOME', 'WAITING', 'SHORT', 'LONG_INITIAL', 'LONG'. (type: bytes)
Method sendShort Send a POP3 command to which a short response is expected.
Method sendLong Send a POP3 command to which a multi-line response is expected.
Method connectionMade Wait for a greeting from the server after the connection has been made.
Method timeoutConnection Drop the connection when the server does not respond in time.
Method connectionLost Clean up when the connection has been lost.
Method lineReceived Pass a received line to a state machine function and transition to the next state.
Method lineLengthExceeded Drop the connection when a server response exceeds the maximum line length (LineOnlyReceiver.MAX_LENGTH).
Method state_WELCOME Handle server responses for the WELCOME state in which the server greeting is expected.
Method state_WAITING Log an error for server responses received in the WAITING state during which the server is not expected to send anything.
Method state_SHORT Handle server responses for the SHORT state in which the server is expected to send a single line response.
Method state_LONG_INITIAL Handle server responses for the LONG_INITIAL state in which the server is expected to send the first line of a multi-line response.
Method state_LONG Handle server responses for the LONG state in which the server is expected to send a non-initial line of a multi-line response.
Method startTLS Switch to encrypted communication using TLS.
Method login Log in to the server.
Method apop Send an APOP command to perform authenticated login.
Method user Send a USER command to perform the first half of plaintext login.
Method password Send a PASS command to perform the second half of plaintext login.
Method delete Send a DELE command to delete a message from the server.
Method capabilities Send a CAPA command to retrieve the capabilities supported by the server.
Method noop Send a NOOP command asking the server to do nothing but respond.
Method reset Send a RSET command to unmark any messages that have been flagged for deletion on the server.
Method retrieve Send a RETR or TOP command to retrieve all or part of a message from the server.
Method stat Send a STAT command to get information about the size of the mailbox.
Method listSize Send a LIST command to retrieve the sizes of all messages on the server.
Method listUID Send a UIDL command to retrieve the UIDs of all messages on the server.
Method quit Send a QUIT command to disconnect from the server.
Instance Variable _capCache The cached server capabilities. Capabilities are not allowed to change during the session (except when TLS is negotiated), so the first response to a capabilities command can be used for later lookups. (type: None or dict mapping bytes to list of bytes and/or bytes to None)
Instance Variable _challengeMagicRe A regular expression which matches the challenge in the server greeting. (type: RegexObject)
Instance Variable _blockedQueue A list of blocked commands. While a command is awaiting a response from the server, other commands are blocked. When no command is outstanding, _blockedQueue is set to None. Otherwise, it contains a list of information about blocked commands. Each list entry provides the following information about a blocked command: the deferred that should be called when the response to the command is received, the function that sends the command, and the arguments to the function. (type: None or list of 3-tuple of (0) Deferred, (1) callable which results in a Deferred, (2) tuple)
Instance Variable _waiting A deferred which fires when the response to the outstanding command is received from the server. (type: Deferred or None)
Instance Variable _timedOut An indication of whether the connection was dropped because of a timeout. (type: bool)
Instance Variable _greetingError The server greeting minus the status indicator, when the connection was dropped because of an error in the server greeting. Otherwise, None. (type: bytes or None)
Instance Variable _xform The transform function which is used to convert each line of a multi-line response into usable values for use by the consumer function. If None, each line of the multi-line response is sent directly to the consumer function. (type: None or callable that takes bytes and returns object)
Instance Variable _consumer The consumer function which is used to store the values derived by the transform function from each line of a multi-line response into a list. (type: callable that takes object)
Method _blocked Block a command, if necessary.
Method _unblock Send the next blocked command.
Method _startTLS Continue the process of switching to encrypted communication.
Method _startedTLS Complete the process of switching to encrypted communication.
Method _getContextFactory Get a context factory with which to negotiate TLS.
Method _login Continue the process of logging in to the server.
Method _loginTLS Do a plaintext login over an encrypted transport.
Method _plaintext Perform a plaintext login.
Method _apop Perform an APOP login.
Method _consumeOrSetItem Send a command to which a long response is expected and process the multi-line response into a list accounting for deleted messages.
Method _consumeOrAppend Send a command to which a long response is expected and process the multi-line response into a list.

Inherited from LineOnlyReceiver (via AdvancedPOP3Client):

Class Variable delimiter The line-ending delimiter to use. By default this is b'\r\n'.
Class Variable 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.
Method dataReceived Translates bytes into lines, and calls lineReceived.
Method sendLine Sends a line to the other end of the connection.

Inherited from Protocol (via AdvancedPOP3Client, LineOnlyReceiver):

Method logPrefix Return a prefix matching the class name, to identify log messages related to this protocol instance.

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

Method makeConnection Make a connection to a transport and a server.

Inherited from TimeoutMixin (via AdvancedPOP3Client):

Class Variable timeOut The number of seconds after which to timeout the connection.
Method callLater Wrapper around reactor.callLater for test purpose.
Method resetTimeout Reset the timeout count down.
Method setTimeout Change the timeout period
Method __timedOut Undocumented
def __init__(self, deferred, contextFactory=None):
Undocumented
def serverGreeting(self, challenge):
overrides twisted.mail.pop3.AdvancedPOP3Client.serverGreeting

Handle the server greeting.

ParametersgreetingThe server greeting minus the status indicator. For servers implementing APOP authentication, this will contain a challenge string. (type: bytes)
API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.