• Documentation >
• Tools >
• Email

Email

The Email app allows you to download emails via IMAP, send emails via SMTP, create new drafts, move and copy emails from one folder to another folder, mark emails as read or unread, and delete emails.

Prerequisites

• An email account

Connecting Email to Ibexa Connect

You can connect your Email account toIbexa Connect using the following methods:

• Connecting using a Gmail account

• Connecting other email using IMAP

• Connecting using Microsoft SMTP/IMAP OAuth

Connecting using a Gmail account

1. Go to Ibexa Connect and open the Email module's Create a connection dialogue and select the Connection type as Google.

   

2. In the Connection name field, enter a name for the connection and click Save. See the Connecting to Gmail for any issues you might encounter when connecting GMail.

   

3. Confirm the access by clicking Allow.

The connection has been established.

Connecting other email using IMAP

1. Go to Ibexa Connect and open the Email module's Create a connection dialogue and select Connection type as Others (IMAP).

   

2. In the Connection name field, enter a name for the connection.

3. In the Email provider field, do one of the following:

   1. Select the email account.

      1. User name: Enter your email address.

      2. Password: Enter your password.

         

   2. If your email account extension is not mentioned in the drop-down list, select Other and provide the following details:

      1. IMAP Server: Enter incoming mail server address (IMAP). If you do not have this information available, contact your email service provider.

      2. Port: Enter the port number.

      3. Use Secure Connection (TLS): Select to establish a secure connection between the servers.

      4. Use explicit TLS: Select to keep your connection encrypted.

      5. User name: Enter your email address.

      6. Password: Enter your password.

         

4. Click Continue.

The connection has been established.

Connecting using Microsoft SMTP/IMAP OAuth

Microsoft has deprecated Basic authentication in Exchange Online. Use this connection method if the basic authentication is unsuccessful.

1. Go to your Ibexa Connect scenario and select the Email module.

2. Under Connection, click Add, then select Microsoft SMTP/IMAP OAuth.

   

3. Enter a name for the connection and click Save.

4. In the prompt, confirm the access by clicking Accept.

You have successfully established the connection.

Note

If you need to replace the connection in multiple modules in your scenario, please use the DevTool plugin.

Triggers

Watch Emails

Triggers when a new email is received for processing according to specified criteria.

Folder	Select the folder whose emails you want to watch.
Criteria	Select the criteria of the emails you want to watch: * All Emails * Only Read Emails * Only Unread Emails
Sender Email Address	Enter the email address of the sender whose emails you want to watch.
Recipient Email Address	Enter the email address of the recipient whose emails you want to watch.
Subject	Enter the subject of the email you want to watch.
Phrase	Enter any keywords to watch only those emails containing specific phrases.
Mark message(s) as read when fetched	Select the option if you want to mark the unread email as read after retrieving the details.
Maximum number of results	The maximum number of emails Ibexa Connect should return during one scenario execution cycle.

Actions

Copy an email

Copies an email or a draft into a selected folder.

Source Folder	Select the folder from which you want to copy the email. For example, Inbox, Primary, Work, and so on.
Destination Folder	Select the folder to which you want to copy the email. For example, Inbox, Primary, Work, and so on.
Email ID (UID)	Enter the Email ID UID of the email you want to copy to the destination folder. You can get the UID of the email by using Ibexa Connect's Watch Email module or Search Email module.

Create a Draft

Copies an email or a draft into a selected folder.

Folder	Select the folder in which you want to create the draft email.
To	Enter the email address to which you want to send the email.
Subject	Enter the subject line of the email.
Content Type	Select the content type for the email: * HTML * Plain Text
HTML	Enter the email content in HTML format using HTML tags or in the plain text as selected in the Content type field.
Attachments	Add an attachment: File name Enter the file name. For example, sample.doc. Data Enter the path to the folder to upload the attachment. Content-ID Enter the content ID to insert the attachment (image) in the content.
Copy Recipient	Enter the email address to whom you want to send a copy of this email.
Blind Copy Recipient	Enter the email address to whom you want to send a copy of this email without appearing their email addresses in the email.
From	Enter the email address that appears in the From field.
Sender	Enter the email address that appears in the Sender field.
Reply-To	Enter the details of the email for which you are sending this email as a reply.
In-Reply-To	Enter the details of the email for which you are drafting this email in reply to.
References	Enter the details of any reference you want to add to the email.
Priority	Select the priority: * High * Low * Normal
Headers	Add the headers: Key Add the key. Value Enter the value fo the key.

Delete an Email

Removes an email or a draft from a selected folder.

Folder	Select the folder of the email you want to delete. For example, Inbox, Primary, Work, and so on.
Email ID (UID)	Enter the Email UID of the email you want to delete. You can get the UID of the email by using Ibexa Connect's Watch Email module or Search Email module.
Expunge	If selected, permanently removes all the messages marked as Deleted in the currently open mailbox. When you use Gmail then the behavior is driven by the setting in Settings > Forwarding POP/IMAP in IMAP access section.

Get Emails

Returns emails that match the specified criteria.

Folder	Select the folder whose email details you want to retrieve. For example, Inbox, Primary, Work, and so on.
Mark message(s) as read when fetched	Select the option if you want to mark the unread email as read after retrieving the details.
Criteria	Select the emails you want to retrieve: * All Emails * Only Read Emails * Only Unread Emails
Sender email address	Enter the email address of the sender whose emails you want to retrieve.
Recipient email address	Enter the email address of the recipient whose emails you want to retrieve.
From date	Enter the date to retrieve the emails processed on or after the specified date.
Before date	Enter the date to retrieve the emails processed on or before the specified date.
Subject	Enter the subject of the email you want to retrieve.
Phrase	Enter any keywords to retrieve only those containing those phrases.
Email ID (UID)	Enter the Email ID (UID) of the email whose details you want to retrieve. You can get the UID of the email by using Ibexa Connect's Watch Email module or Search Email module.
Maximum number of results	The maximum number of emails Ibexa Connect should return during one scenario execution cycle.
Continue the execution of the route even if the module returns no results	Select if you want to continue to run the module even if there are no results returned.

Mark an Email as Read

Marks an email or a draft in a selected folder as read by setting the Read flag.

Folder	Select the folder of the email you want to mark as read. For example, Inbox, Primary, Work, and so on.
Email ID (UID)	Enter the Email UID of the email you want to mark as read. You can get the UID of the email by using Ibexa Connect's Watch Email module or Search Email module.

Mark an Email as Unread

Marks an email or a draft in a selected folder as unread by setting the Unread flag.

Folder	Select the folder of the email you want to mark as unread. For example, Inbox, Primary, Work, and so on.
Email ID	Enter the Email UID of the email you want to mark as unread. You can get the UID of the email by using Ibexa Connect's Watch Email module or Search Email module.

Move an Email

Moves a chosen email or a draft to a selected folder.

Source Folder	Select the folder from which you want to move the email. For example, Inbox, Primary, Work, and so on.
Destination Folder	Select the folder to which you want to add the email. For example, Inbox, Primary, Work, and so on.
Email ID (UID)	Enter the Email ID UID of the email you want to move to the destination folder. You can get the UID of the email by using Ibexa Connect's Watch Email module or Search Email module.

Send an Email

Sends a new email.

Note

To use other than the GOOGLE type of mailbox, set a new connection that works with SMTP protocol.

Save Message after Sending	Select whether you want to save the email in your mailbox after sending it.
To	Enter the email address to whom you want to send the email.
Subject	Enter the subject line of the email.
Content Type	Select the content type for the email: * HTML * Plain Text
Content	Enter the email content in HTML format using HTML tags or in the plain text as selected in the Content Type field.
Attachments	Add an attachment: File name Enter the file name. For example, sample.doc. Data Enter the path to the folder to upload the attachment. Content-ID Enter the content ID to insert the attachment (image) in the content.
Copy Recipient	Enter the email address to whom you want to send a copy of this email.
Blind Copy Recipient	Enter the email address to whom you want to send a copy of this email without having their email addresses appear in the email.
From	Enter the email address (and name, if needed) that appears in the From field in the email. Use the correct syntax: [email protected] or "Name" [email protected]
Sender	Enter the email address that appears in the Sender field in the email. 1. Open the Send an email action advanced settings using the checkbox. 2. Enter the required sender name or email Use the correct syntax as shown in the hint on the screenshot below. [email protected] or "Name" [email protected]
Reply-To	Enter the details of the email for which you are sending this email as a reply.
In-Reply-To	Enter the details of the email for which you are drafting this email in reply to.
References	Enter the details of any reference you want to add to the email.
Priority	Select the priority of the email: * High * Low * Normal
Headers	Add the headers: Key Add the key. For example, Sender, Date, To, and so on. Value Enter the value for the key.

The Unique Email ID in IMAP protocol

The Unique Email ID known as 'Email ID (UID)' is the email's identifier. The Email ID is specific for each of the email's folders.

Tip

For getting and deleting the same email from the same folder, you can see below:

Getting an email from your Inbox

Deleting the email from your Inbox

Iterators

Iterate Attachments

Iterates received attachments one by one.

The email iterator module lets you manage email attachments separately. For example, you can set up to watch emails to iterate the emails with attachments and receive alerts.

For more information about iterators, see Iterator.