Internet Message Access Protocol

The entity, Internet Message Access Protocol (IMAP) is configured and mapped when you are dealing with emails. IMAP is a standard internet protocol used by clients to retrieve emails from a mail server over a TCP/IP connection.

To retrieve emails, you need to specify a registered email ID, which is used for reading the emails that are received. When an email is sent to an ID that is configured in the IMAP, the system reads all the incoming messages of that ID. Whenever the subject line of that email ID matches the Subject of the Email Trigger property of the Start activity in the process flow, the corresponding process flow is triggered automatically.

IMAPs are created and managed in the Management > Configuration Management module. For configuring IMAP, you need to understand the concept of IMAP.

Creating New IMAP

Follow the steps below to create a new IMAP.

1. Navigate to Management > Configuration Management > IMAP

   
   

2. Click +Create New.

3. Enter the Basic details in the Create IMAP panel as explained below. Scroll down the Create IMAP section to view the configuration details.

   Field	Description
   Name*	Enter the name of the IMAP. Character limit: 50. Data type: Alphanumeric and underscore.
   Server Type	Select the server type. IMAP and POP3 are the two commonly used Internet mail protocols for retrieving emails. - Imaps: IMAP is the better option when you need to check your emails from multiple devices, such as a work laptop, a home computer, or a tablet, smartphone, or other mobile device. IMAP saves all your e-mail on the server. - Pop3s: POP3 access mean e-mail is delivered and stored on your personal computer, tablet, or phone. When you check e-mail and download it to your computer the e-mail is immediately deleted from the server.
   Type	Select the required type. The configurations appear as per the selected type. Generic : To connect to generic IMAP server. Refer to IMAP Generic Configurations. MS Graph API : To read email from Microsoft Outlook in the Platform through Azure portal configurations. You can access Outlook emails using the Graph API. Refer to MS Graph API Configurations.
   Description	Write a brief description of the IMAP. Character limit: 1000 characters Data type: Alphanumeric and symbols.

4. Click Create on the bottom right of the page and the IMAP gets created with the details entered.

IMAP Generic Configurations

Based on the Type selected in the creation of IMAP Configuration, the applicable configurations appear.
Type = Generic

MS Graph API Generic Configurations

Based on the Type selected in the creation of IMAP Configuration, the applicable configurations appear.
Type = MS Graph API

You should register and setup Azure App and then provide the necessary permissions to specific mailboxes for getting the required configuration details.

Viewing and Editing IMAP

1. Navigate to Management > Configuration Management > IMAP.

2. Click the IMAP card for viewing the details of the selected IMAP. The details of the IMAP appear in the Info Actions panel (Edit IMAP).

   
   

3. Edit the IMAP details as needed.

4. Click Save.

Duplicating IMAP

When an IMAP is duplicated all the properties of the IMAP get copied except the “Password”. Hence while duplicating the IMAP, the user is prompted to enter the password for the duplicate IMAP. Unless the user enters the password value, the data source cannot be duplicated.

Follow the below steps for duplicating an existing IMAP.

1. Navigate to Management > Configuration Management > IMAP. The list of all IMAPs appears.
2. Hover over any IMAP card. Three dots appear on the upper right side of the card.

3. Click the three dots. More Actions appear.

   
   

4. Click Duplicate. A confirmation pop-up appears along with the password confirmation textbox.

   
   

5. Enter the Entity Password (email account password) and click Ok to duplicate the IMAP (or you can click Cancel to cancel the duplicate action). Password does not get copied during duplication and hence you need to provide a valid password for the IMAP that is copied. A Success message appears on successful duplication of the IMAP.

   
   

6. Click Ok. A duplicate copy of IMAP appears on the IMAP page with the same IMAP name suffixed with “_copied”.

   
   

Deleting IMAP

1. Navigate to Management > Configuration Management > IMAP. The list of all IMAPs appears.

2. Click the IMAP name card that is to be deleted. The lower-right of the page displays the Delete button.

   
   

3. Click Delete. A Confirmation pop-up for delete appears.

   
   

4. Click Ok for deleting the IMAP.
   Or
   Click Cancel to cancel the action.

Alternatively, you can follow the below steps to delete the IMAP:

1. Navigate to Management > Configuration Management > IMAP.
2. Hover over the IMAP card. Three dots appear on the upper right side of the card.
3. Click the three dots. More Actions appear.

4. Click Delete and follow step 4 in the above procedure.

   
   

Appendix

Generating App Password

Different SMTP/IMAP hosts have different way of getting authentication password.

If the SMTP/IMAP host is not enabled with 2-step authentication, you can provide the password of the user in the password field to trigger the email.

If an SMTP/IMAP host is enabled with 2-step authentication, you need to generate 16-digit app password and then provide that password in the Auth = true > Password field.

An example of generating app password for the SMTP/IMAP host (Gmail) where 2-step authentication is enabled, is provided below.

Example – Gmail Host

Follow the steps below to generate the password for Gmail account.

1. Login to the Google account (the account that you want to configure in SMTP/IMAP) using your credentials.
2. Navigate through Google Account > Manage your Google Account. Google Account page opens.
3. On the right-side menu click Security. The Security page appears.
4. In the Signing into Google section, click 2-Step verification. 2-Step verification page appears.
   If you have already turned on the 2-step verification, go to step 13 or else if you have not turned on 2-step verification go to step 5.
5. Click Get Started. You will be logged out and prompted for password to continue. This is a verification process.
6. Enter your password and click Next. You will be redirected to the 2-step verification page.
7. Below What phone number do you want to use? provide the Phone number.
8. Below How do you want to get codes? select the option Text message (preferred) if you want to get the code as text message or select the option Phone Call if you want to get the codes through a phone call.
9. Click Next. A verification code is sent as SMS to the phone number that you entered above.
10. Enter the code in the specified field and click Next. A success message is displayed (if correct code is entered).
11. Click Turn On. Now the 2-Step Authentication is switched on. If the 2-Step Verification is switched off, you can just give your account password in the password field in the Platform > Management > Configuration Management > SMTP/IMAP properties.
12. Navigate back to Security page > Signing into Google section.
13. Click App Passwords. You will be logged out and prompted for password to continue.
14. Enter your password and click Next. App Password page opens. It will prompt for the app (Select app) and device (Select device). That is, in which app you need to access or which device you need to access the account.
15. Click Select App > click Other (Custom Name) as we are using it for Platform, we need to specify that.
16. Enter Platform and click Generate. An app password is generated and displayed.
17. Below Your app password for your device, copy the 16 characters (password may be displayed in normally or in asterisks).
18. Click Done.
19. Now you have copied the app password and you can copy this password in the Platform > Management > Configuration Management > SMTP/IMAP properties.