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

Class IMAP4_SSL

source code

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=global_settings.applications_parent, certfile=global_settings.applications_parent) source code
 
open(self, host='', port=993)
Setup connection to remote server on "host:port".
source code
 
read(self, size)
Read 'size' bytes from remote.
source code
 
readline(self)
Read line from remote.
source code
 
send(self, data)
Send data to remote.
source code
 
shutdown(self)
Close I/O established in "open".
source code
 
socket(self)
Return socket instance used to connect to IMAP4 server.
source code
 
ssl(self)
Return SSLObject instance used to communicate with the IMAP4 server.
source code

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=global_settings.applications_parent, certfile=global_settings.applications_parent)
(Constructor)

source code 
Overrides: IMAP4.__init__

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

source code 
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)

source code 
Read 'size' bytes from remote.
Overrides: IMAP4.read

readline(self)

source code 
Read line from remote.
Overrides: IMAP4.readline

send(self, data)

source code 
Send data to remote.
Overrides: IMAP4.send

shutdown(self)

source code 
Close I/O established in "open".
Overrides: IMAP4.shutdown

socket(self)

source code 

Return socket instance used to connect to IMAP4 server.

socket = <instance>.socket()
Overrides: IMAP4.socket

ssl(self)

source code 

Return SSLObject instance used to communicate with the IMAP4 server.

ssl = <instance>.socket.ssl()