class documentation

class SimpleClient(POP3Client): (source)

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method serverGreeting Handle the server greeting.
Instance Variable allowInsecureLogin Undocumented
Instance Variable deferred Undocumented

Inherited from AdvancedPOP3Client:

Method apop Send an APOP command to perform authenticated login.
Method capabilities Send a CAPA command to retrieve the capabilities supported by the server.
Method connectionLost Clean up when the connection has been lost.
Method connectionMade Wait for a greeting from the server after the connection has been made.
Method delete Send a DELE command to delete a message from the server.
Method lineLengthExceeded Drop the connection when a server response exceeds the maximum line length (LineOnlyReceiver.MAX_LENGTH).
Method lineReceived Pass a received line to a state machine function and transition to the next state.
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 login Log in to the server.
Method noop Send a NOOP command asking the server to do nothing but respond.
Method password Send a PASS command to perform the second half of plaintext login.
Method quit Send a QUIT command to disconnect from the server.
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 sendLong Send a POP3 command to which a multi-line response is expected.
Method sendShort Send a POP3 command to which a short response is expected.
Method startTLS Switch to encrypted communication using TLS.
Method stat Send a STAT command to get information about the size of the mailbox.
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 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_SHORT Handle server responses for the SHORT state in which the server is expected to send a single line response.
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_WELCOME Handle server responses for the WELCOME state in which the server greeting is expected.
Method timeoutConnection Drop the connection when the server does not respond in time.
Method user Send a USER command to perform the first half of plaintext login.
Instance Variable serverChallenge The challenge received in the server greeting.
Instance Variable startedTLS An indication of whether TLS has been negotiated successfully.
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'.
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.
Instance Variable transport Undocumented
Method _apop Perform an APOP login.
Method _blocked Block a command, if necessary.
Method _consumeOrAppend Send a command to which a long response is expected and process the multi-line response into a list.
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 _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 _startedTLS Complete the process of switching to encrypted communication.
Method _startTLS Continue the process of switching to encrypted communication.
Method _unblock Send the next blocked command.
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...
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.
Instance Variable _challengeMagicRe A regular expression which matches the challenge in the server greeting.
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.
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.
Instance Variable _timedOut An indication of whether the connection was dropped because of a timeout.
Instance Variable _waiting A deferred which fires when the response to the outstanding command is received from the server.
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.

Inherited from LineOnlyReceiver (via AdvancedPOP3Client):

Method dataReceived Translates bytes into lines, and calls lineReceived.
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 AdvancedPOP3Client, LineOnlyReceiver):

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 AdvancedPOP3Client, LineOnlyReceiver, Protocol):

Method makeConnection Make a connection to a transport and a server.
Instance Variable connected Undocumented

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

Method callLater Wrapper around reactor.callLater for test purpose.
Method resetTimeout Reset the timeout count down.
Method setTimeout Change the timeout period
Instance Variable timeOut The number of seconds after which to timeout the connection.
Method __timedOut Undocumented
Instance Variable __timeoutCall Undocumented
def __init__(self, deferred, contextFactory=None): (source)

Undocumented

def serverGreeting(self, challenge): (source)

Handle the server greeting.

Parameters
challengeUndocumented
greeting:bytesThe server greeting minus the status indicator. For servers implementing APOP authentication, this will contain a challenge string.
deferred = (source)

Undocumented