Module imaplib :: Class IMAP4_SSL
[hide private]
[frames] | no frames]

_ClassType IMAP4_SSL

IMAP4 --+
        |
       IMAP4_SSL

IMAP4 client class over SSL connection

Instantiate with: IMAP4_SSL([host[, port[, keyfile[, certfile]]]])

        host - host's name (default: localhost);
        port - port number (default: standard IMAP4 SSL port).
        keyfile - PEM formatted file that contains your private key (default: None);
        certfile - PEM formatted certificate chain file (default: None);

for more documentation see the docstring of the parent class IMAP4.

Nested Classes [hide private]

Inherited from IMAP4: abort, error, readonly

Instance Methods [hide private]
 
__init__(self, host='', port=993, keyfile=None, certfile=None)
 
open(self, host='', port=993)
Setup connection to remote server on "host:port".
 
read(self, size)
Read 'size' bytes from remote.
 
readline(self)
Read line from remote.
 
send(self, data)
Send data to remote.
 
shutdown(self)
Close I/O established in "open".
 
socket(self)
Return socket instance used to connect to IMAP4 server.
 
ssl(self)
Return SSLObject instance used to communicate with the IMAP4 server.

Inherited from IMAP4: __getattr__, append, authenticate, capability, check, close, copy, create, delete, deleteacl, expunge, fetch, getacl, getannotation, getquota, getquotaroot, list, login, login_cram_md5, logout, lsub, myrights, namespace, noop, partial, print_log, proxyauth, recent, rename, response, search, select, setacl, setannotation, setquota, sort, status, store, subscribe, thread, uid, unsubscribe, xatom

Class Variables [hide private]

Inherited from IMAP4: mustquote

Method Details [hide private]

__init__(self, host='', port=993, keyfile=None, certfile=None)
(Constructor)

 
Overrides: IMAP4.__init__

open(self, host='', port=993)

 
Setup connection to remote server on "host:port".
    (default: localhost:standard IMAP4 SSL port).
This connection will be used by the routines:
    read, readline, send, shutdown.

Overrides: IMAP4.open

read(self, size)

 

Read 'size' bytes from remote.

Overrides: IMAP4.read

readline(self)

 

Read line from remote.

Overrides: IMAP4.readline

send(self, data)

 

Send data to remote.

Overrides: IMAP4.send

shutdown(self)

 

Close I/O established in "open".

Overrides: IMAP4.shutdown

socket(self)

 

Return socket instance used to connect to IMAP4 server.

socket = <instance>.socket()

Overrides: IMAP4.socket

ssl(self)

 

Return SSLObject instance used to communicate with the IMAP4 server.

ssl = <instance>.socket.ssl()