twisted.mail.pop3.AdvancedPOP3Client.capabilities(self, useCache=True) method documentationtwisted.mail.pop3.AdvancedPOP3Client
View Source
Send a CAPA command to retrieve the capabilities supported by the server.
Not all servers support this command. If the server does not support this, it is treated as though it returned a successful response listing no capabilities. At some future time, this may be changed to instead seek out information about a server's capabilities in some other fashion (only if it proves useful to do so, and only if there are servers still in use which do not support CAPA but which do support POP3 extensions that are useful).
| Parameters | useCache | A flag that determines whether previously retrieved results should be used if available. (type: bool) |
| Returns | A deferred which fires with a mapping of capability name to parameters. For example:
C: CAPA
S: +OK Capability list follows
S: TOP
S: USER
S: SASL CRAM-MD5 KERBEROS_V4
S: RESP-CODES
S: LOGIN-DELAY 900
S: PIPELINING
S: EXPIRE 60
S: UIDL
S: IMPLEMENTATION Shlemazle-Plotz-v302
S: .
will be lead to a result of:
| {'TOP': None,
| 'USER': None,
| 'SASL': ['CRAM-MD5', 'KERBEROS_V4'],
| 'RESP-CODES': None,
| 'LOGIN-DELAY': ['900'],
| 'PIPELINING': None,
| 'EXPIRE': ['60'],
| 'UIDL': None,
| 'IMPLEMENTATION': ['Shlemazle-Plotz-v302']}
(type: Deferred which successfully results in dict mapping bytes to list of bytes and/or bytes to None) | |
| Function | consume | Undocumented |
| Function | capaNotSupported | Undocumented |
| Function | gotCapabilities | Undocumented |