ImapHook

IMAP

This hook connects to a mail server by using the imap protocol.

View Source

Last Updated: Apr. 27, 2021

Access Instructions

Install the IMAP provider package into your Airflow environment.

Import the module into your DAG file and instantiate it with your desired params.

Parameters

imap_conn_idstrThe connection id that contains the information used to authenticate the client.

Documentation

This hook connects to a mail server by using the imap protocol.

Note

Please call this Hook as context manager via with to automatically open and close the connection to the mail server.

Example DAGs

Improve this module by creating an example DAG.

View Source
  1. Add an `example_dags` directory to the top-level source of the provider package with an empty `__init__.py` file.
  2. Add your DAG to this directory. Be sure to include a well-written and descriptive docstring
  3. Create a pull request against the source code. Once the package gets released, your DAG will show up on the Registry.

Was this page helpful?