picoware.applications.email.IMAP4

class documentation

class IMAP4:

Constructor: IMAP4(host, port)

A minimal IMAP4 client for MicroPython.

Method	`__init__`	Connect to an IMAP server over SSL.
Method	`login`	Authenticate with the server.
Method	`logout`	Close the IMAP session.
Method	`select`	Select a mailbox.
Method	`uid_fetch`	Fetch a body part by UID.
Method	`uid_search`	Search by UID.
Method	`uid_store`	Set flags on a message by UID.
Method	`_cmd`	Send a tagged IMAP command and return its tag.
Method	`_read_exact`	Read exactly n bytes from the socket.
Method	`_read_line`	Read a single line from the socket.
Method	`_read_literal`	Read a literal, keeping only the first max_literal bytes.
Method	`_response`	Read responses until the tagged response for `tag`.
Instance Variable	`_sock`	Undocumented
Instance Variable	`_tag`	Undocumented

def __init__(self, host, port=993): ¶

Connect to an IMAP server over SSL.

Parameters
host:`str`	The server hostname.
port:`int`	The server port. Defaults to 993.

def login(self, username, password): ¶

Authenticate with the server.

Parameters
username:`str`	The login username.
password:`str`	The login password.

Returns
`bool`	True on success.

def logout(self): ¶

Close the IMAP session.

def select(self, mailbox='INBOX'): ¶

Select a mailbox.

Parameters
mailbox:`str`	The mailbox name. Defaults to "INBOX".

Returns
`tuple`	(ok, response data).

def uid_fetch(self, uid, parts, max_literal=0): ¶

Fetch a body part by UID.

Parameters
uid:`str`	The message UID.
parts:`str`	The body part specifier.
max_literal:`int`	Maximum literal bytes to keep. Defaults to 0.

Returns
`bytes or None`	The literal bytes.

def uid_search(self, criteria='UNSEEN'): ¶

Search by UID.

Parameters
criteria:`str`	The search criteria. Defaults to "UNSEEN".

Returns
`list`	UID strings.

def uid_store(self, uid, flags='(\\Seen)'): ¶

Set flags on a message by UID.

Parameters
uid:`str`	The message UID.
flags:`str`	The flags to set. Defaults to "(Seen)".

Returns
`bool`	True on success.

def _cmd(self, command): ¶

Send a tagged IMAP command and return its tag.

Parameters
command:`str`	The IMAP command.

Returns
`bytes`	The command tag.

def _read_exact(self, n): ¶

Read exactly n bytes from the socket.

Parameters
n:`int`	The number of bytes to read.

Returns
`bytes`	The bytes read.

def _read_line(self): ¶

Read a single line from the socket.

def _read_literal(self, size, max_literal=0): ¶

Read a literal, keeping only the first max_literal bytes.

Parameters
size:`int`	The literal size.
max_literal:`int`	Maximum bytes to keep. Defaults to 0.

Returns
`bytes`	The literal bytes.

def _response(self, tag, max_literal=0): ¶

Read responses until the tagged response for tag.

Parameters
tag:`bytes`	The command tag.
max_literal:`int`	Maximum literal bytes to keep. Defaults to 0.

Returns
`tuple`	(status, data); literals are stored as ('literal', bytes).

_sock = ¶

Undocumented

_tag: int = ¶

Undocumented