Skip to content

Imapclient

flowtask.interfaces.IMAPClient

IMAP/POP Client.

Class for operations with IMAP Mailboxes.

IMAPClient

IMAPClient(*args, host=None, port=None, **kwargs)

Bases: ClientInterface

IMAPClient

Overview

The IMAPClient class provides operations for interacting with IMAP mailboxes.
It supports both SSL and non-SSL
connections and uses XOAUTH2 authentication by default.

.. table:: Properties :widths: auto

+------------------+----------+------------------------------------------------------------------------------------------+
| Name             | Required | Description                                                                              |
+------------------+----------+------------------------------------------------------------------------------------------+
| use_ssl          |   No     | Boolean flag to specify whether to use SSL, defaults to True.                            |
+------------------+----------+------------------------------------------------------------------------------------------+
| mailbox          |   No     | The mailbox to access, defaults to "Inbox".                                              |
+------------------+----------+------------------------------------------------------------------------------------------+
| overwrite        |   No     | Boolean flag to specify whether to overwrite existing configurations, defaults to False. |
+------------------+----------+------------------------------------------------------------------------------------------+

Return

The methods in this class manage the connection to the IMAP server and perform authentication and closure of
the connection.