Skip to main content

IMAP Connector

IMAP Interact with your IMAP email account

Connections

IMAP Connection

Provide the details of your IMAP server.

To configure a connection to an IMAP server you will need a few properties:

  • The host and port of your IMAP server
  • A set of login credentials for a user that exists on the IMAP server
  • The version of encryption the IMAP server is compatible with.

The setup can vary widely depending on the email service you are using. We have provided a bit of context around some popular services to get you started.

Connecting to Gmail

To set up an IMAP connection to your Gmail account, you need to create a Google App Password. Go to your Google Account and select 'Security'. Under "Signing in to Google," select App Passwords. You may need to sign in.

If you don't have this option, it might be because:

  • 2 Step Verification is not set up for your account.
  • 2 Step Verification is only set up for security keys.
  • Your account is through work, school, or other organization.
  • You turned on Advanced Protection.

At the bottom, click Select App and choose Mail, and then click Select device and choose Other (Custom name). Then, click GENERATE. You'll be given a 16-character code, which is your app password. Copy that somewhere safe.

Finally, create a connection and provide these values:

  • Enter imap.gmail.com for the host
  • The default values for port and security are fine
  • Enter the username or email of your Gmail account
  • Enter the app password you created earlier

If you run into authentication problems, ensure that your account has IMAP enabled.

Connecting to Microsoft Office 365

If your Office 365 domain does not use multi-factor authentication (this is rare), then you can use your username and password to authenticate.

If MFA is enabled, you will need to create an app password to authenticate. To create an app password, log in to the Microsoft Security Center and open the Security info tab. Click +Add method and choose App password.

If you don't have an app password option, you'll need to contact your Office 365 administrator and have them enable it.

Give your app password a name, and copy the password that is generated.

Now, create a connection and provide these values:

  • Enter outlook.office365.com for the host
  • The default values for port and security are fine
  • Enter the username or email of your Outlook account
  • Enter your password or the app password you generated
InputCommentsDefault
HostProvide the host address for the desired IMAP server.
PortProvide the port for the desired IMAP server.993
SecureDetermines if the connection is secure.true
UsernameProvide a valid username or email.
PasswordProvide the password for the given user. This value is required if secured is set to true.
Minimum TLS VersionProvide a valid TLS version to be used in the connection.TLSv1.1
Maximum TLS VersionProvide a valid TLS version to be used in the connection.TLSv1.3
Min DH SizeMinimum size of bits to accept in a TLS connection1024

Actions

Add Flags

Add new flags to an existing message

InputCommentsDefault
Connection
MailboxProvide a string value for the name of the mailbox
RangeProvide a range of messages. Alternatively you can specify * to get the latest message
FlagsFor each item, provide a string value to be added to an existing message.

Append Message

Appends a new message to an existing mailbox

InputCommentsDefault
Connection
MailboxProvide a string value for the name of the mailbox
PathMailbox path to upload the message to
Message ContentMailbox path to upload the message to

Copy Message

Copies a message from one mailbox to another.

InputCommentsDefault
Connection
MailboxProvide a string value for the name of the mailbox
RangeProvide a range of messages. Alternatively you can specify * to get the latest message
New PathMailbox path to upload the message to

Create Mailbox

Creates a new mailbox folder and sets up subscription for the created mailbox

InputCommentsDefault
Connection
PathMailbox path to upload the message to

Delete Message

Delete an existing message

InputCommentsDefault
Connection
MailboxProvide a string value for the name of the mailbox
Message UIDThe UID of the message.

Download Message

Download either full RFC-822 formatted message or a specific body structure part

InputCommentsDefault
Connection
MailboxProvide a string value for the name of the mailbox
Message Index or IDThe index of the message you would like to download (1 for the oldest message, 2 for second oldest, etc), or the ID of the message.

Get Mailbox Status

Returns the status of a mailbox's properties

InputCommentsDefault
Connection
MailboxProvide a string value for the name of the mailbox

List Mailboxes

Returns a list of available mailboxes

InputCommentsDefault
Connection

Remove Flags From Message

Remove existing flags from an existing message

InputCommentsDefault
Connection
MailboxProvide a string value for the name of the mailbox
RangeProvide a range of messages. Alternatively you can specify * to get the latest message
FlagsFor each item, provide a string value to be added to an existing message.

Rename Mailbox

Change the name of an existing mailbox

InputCommentsDefault
Connection
PathMailbox path to upload the message to
New PathMailbox path to upload the message to

Search / List Mailbox Messages

Returns all messages in the given mailbox

InputCommentsDefault
Connection
MailboxProvide a string value for the name of the mailbox
FromFilter email messages by sender
ToFilter email messages by recipient
Read / Unread Filterall
Filter OptionsExtra parameters to filter the search results

Set Flags

Set a value for an existing message flag

InputCommentsDefault
Connection
MailboxProvide a string value for the name of the mailbox
RangeProvide a range of messages. Alternatively you can specify * to get the latest message
FlagsFor each item, provide a string value to be added to an existing message.