The IMAP plugin allows Mitto to grab files from UNREAD email attachments and download them to Mitto's file manager.

The files can then be used in subsequent jobs (CSV, Excel, JSON, etc) to create the database tables.

Setup:

The following information is needed to create an IMAP job in Mitto.

  • Email account
  • Password
  • Email provider: Outlook, Gmail, etc.

Creating IMAP Job

1. Click on + Add in bottom left screen.

2. Create a blank job (or use SQL job as a proxy and put in fake SQL "1").

3. Give the job a name [IMAP]  and save it.

4. Change the data type of the job to imap.

5. Edit the job to update the config.

6. Replace the existing configuration JSON with one of these templates (slightly altered to your use case):

Example 1:

{
    "credentials": {
        "username": "<email address>",
        "password": "<password>"
    },
    "filename_format": "{safe_root}_{year}{month:02d}{day:02d}.{ext}",
    "label": "inbox",
    "server": "<server>"
}

Example 2:

{
    "credentials": {
        "username": "<email address>",
        "password": "<password>"
    },
    "filename_format": "activity_visits_{safe_root}.{ext}",
    "label": "\"Inbox/BGC3/Activity Visit Folder\"",
    "server": "<server>"
}

JSON Congfiguration Options

label

  • This is the folder location of the emails.
  • This case insensitive.
  • Removing this key/value pair or using "label": "inbox" means you are looking at files in the top level inbox.
  • In order to look at lower level folders use quotes and forward slashes to separate the nested folders. See Example 2.

filename_format

  • This is how Mitto will name the output file in the file manager.
  • {safe_root} represents the original file name.
  • {ext} represents the original file extension.
  • You can alter the file name by adding text (Example 2) and/or datetime attributes (Example 1).
  • Leave the file names unchanged by removing this key/value pair or using "filename_format": "{safe_root}.{ext}"

server

  • This is the IMAP server.
  • Gmail = imap.gmail.com
  • Outlook = outlook.office365.com

Gmail specifics:

There are a few settings that need to be enabled on the Gmail side.

IMAP Access must have "Enable IMAP" selected. Details here.

Less secure app access must be turned ON. Security details can be found here.