Email Handler

Email handler for MindsDB provides interfaces to connect to email services via APIs and pull data into MindsDB. It is also possible to send emails from MindsDB using this handler.

---

Table of Contents

• Email Handler
  • Table of Contents
  • Email Handler Implementation
  • Email Handler Initialization
  • Implemented Features
  • TODO
  • Example Usage

---

Email Handler Implementation

This handler was implemented using the standard Python libraries: email, imaplib and smtplib.

Email Handler Initialization

The Email handler is initialized with the following required parameters:

• email: a required email address to use for authentication.
• password: a required password to use for authentication.

To use the handler on a Gmail account, the password must be an app password.

Additionally, the following optional parameters can be passed:

• smtp_server: SMTP server to use for sending emails. Defaults to smtp.gmail.com.
• smtp_port: SMTP port to use for sending emails. Defaults to 587.
• imap_server: IMAP server to use for receiving emails. Defaults to imap.gmail.com.

At the moment, the handler has only been tested with Gmail and Outlook accounts.

Implemented Features

• Emails Table for a email account
  • Support SELECT
    • Support LIMIT
    • Support WHERE
    • Support ORDER BY
    • Support column selection
  • Support INSERT: send emails
    • Support to_field, subject and body columns

TODO

• Test the handler for other email providers like Yahoo, etc.

Connect to Gmail

To connect your Gmail account to MindsDB, use the below CREATE DATABASE statement:

CREATE DATABASE email_datasource
WITH ENGINE = 'email',
PARAMETERS = {
  "email": "youremail@gmail.com",
  "password": "yourpassword"
};

It creates a database that comes with the emails table. Now you can query for emails like this:

SELECT *
FROM email_datasource.emails;

And you can apply filters like this:

SELECT id, to_field, subject, body
FROM email_datasource.emails
WHERE subject = 'MindsDB'
ORDER BY id
LIMIT 5;

Or, write emails like this:

INSERT INTO email_datasource.emails(to_field, subject, body)
VALUES ("toemail@email.com", "MindsDB", "Hello from MindsDB!");

Connect to Outlook

To connect your Outlook account to MindsDB, use the below CREATE DATABASE statement:

CREATE DATABASE email_datasource
WITH ENGINE = 'email',
PARAMETERS = {
  "email": "youremail@gmail.com",
  "password": "yourpassword",
  "smtp_server": "smtp.office365.com", 
  "smtp_port": "587", 
  "imap_server": "outlook.office365.com" 
};

It creates a database that comes with the emails table. Now you can query for emails like this:

SELECT *
FROM email_datasource.emails;

And you can apply filters like this:

SELECT id, to_field, subject, body
FROM email_datasource.emails
WHERE subject = 'MindsDB'
ORDER BY id
LIMIT 5;