Package ProcImap :: Module imaplib2 :: Class IMAP4_SSL

Class IMAP4_SSL

object --+    
         |    
     IMAP4 --+
             |
            IMAP4_SSL

IMAP4 client class over SSL connection

Instantiate with:
    IMAP4_SSL(host=None, port=None, keyfile=None, certfile=None, debug=None, debug_file=None)

    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);
    debug      - debug level (default: 0 - no debug);
    debug_file - debug stream (default: sys.stderr).

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=None, port=None, keyfile=None, certfile=None, debug=None, debug_file=None)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

source code

open(host=None, port=None)
Setup secure connection to remote server on "host:port" (default: localhost:standard IMAP4 SSL port).

source code

read(self, size)
data = read(size) Read at most 'size' bytes from remote.

source code

send(data)
Send 'data' to remote.

source code

ssl(self)
ssl = ssl() Return socket.ssl instance used to communicate with the IMAP4 server.

source code

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

Inherited from IMAP4 (private): _CRAM_MD5_AUTH, _append_untagged, _check_bye, _checkquote, _close_threads, _command, _command_complete, _command_completer, _deliver_dat, _deliver_exc, _dump_ur, _end_idle, _handler, _init_debug, _log, _match, _mesg, _print_log, _put_response, _quote, _reader, _request_pop, _request_push, _simple_command, _untagged_response, _writer

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Class Variables

[hide private]

Inherited from IMAP4: continuation_cre, literal_cre, mapCRLF_cre, mustquote_cre, response_code_cre, untagged_response_cre, untagged_status_cre

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, host=None, port=None, keyfile=None, certfile=None, debug=None, debug_file=None)
(Constructor)

source code

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__: (inherited documentation)

open(host=None, port=None)

source code

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

Overrides: IMAP4.open

read(self, size)

source code

data = read(size) Read at most 'size' bytes from remote.

Overrides: IMAP4.read

send(data)

source code

Send 'data' to remote.

Overrides: IMAP4.send

Class IMAP4_SSL

__init__(self, host=None, port=None, keyfile=None, certfile=None, debug=None, debug_file=None) (Constructor)

open(host=None, port=None)

read(self, size)

send(data)

init(self, host=None, port=None, keyfile=None, certfile=None, debug=None, debug_file=None)
(Constructor)