Get Email Messages

Identify all email messages matching a specified filter or a single message matching a key for the purpose of performing a sequence of actions on the message(s).

Step 1: Identify the messages

The first step in using the Get Email Messages command is to identify the messages on which the specified actions will be performed.

The settings available on the Email account tab vary for Exchange and IMAP/POP3 servers.

Exchange servers

1. Select Exchange (Microsoft Graph 2013 and above) as the Email server type.

2. Choose how to input credentials:

   • From credentials vault: Select this option if you want to get credentials from the Nintex Credentials Vault.

   • Enter credential by variable: Use this option if you want to input credentials using variables.

   • Enter manually: If you choose this option, enter the username, password, application ID, tenant ID, and client secret manually.
     

3. If you select Enter manually, enter the Application ID and Directory ID of the Microsoft Exchange. You can get these from Microsoft Azure under the Email application settings.

   • Working with the Microsoft Office 365 new authentication method? You can set the Application ID and Team ID directly into the Credentials Vault settings in the Nintex Admin Tool.

   • Once IDs are entered, they cannot be removed - only edited. To remove the IDs, you need to delete the trigger and re-create it. Read more about Working with Microsoft 365 Exchange and Modern Authentication.

   • Application ID isn't sensitive information and isn't encrypted.

   • Directory ID is sensitive information and is encrypted.

   • Client Secret is sensitive information and is encrypted.

     Inputting a client secret locks the Mailbox option to Shared mailbox without an option to change it back to the User's default mailbox.

     

4. Select which mailbox to get the email message from:

   • User's default mailbox: Using the credentials entered above.

   • Shared mailbox: Enter the mailbox address.

5. (Optional) Click Test settings... to test the email account settings.

6. Expand the Error handling section to customize the error codes and messages for any errors, or choose the default values.

IMAP/POP3 servers

1. Select IMAP or POP3 as the Email server type.

2. (Optional) Select Use SSL and select one of the following from the dropdown:

   • Auto: Automatically determines whether to use SSL based on the server configuration.

   • SSL Implicit: Uses SSL without explicit encryption negotiation between the client and the server.

   • SSL Explicit: Initiates SSL encryption after explicit negotiation between the client and the server.

3. Enter the Server details.

4. Enter the Port details.

5. Choose how to input credentials:

   • From credentials vault: Select this option if you want to get credentials from the Nintex Credentials Vault.

   • Enter credential by variable: Use this option if you want to input credentials using variables.

   • Enter manually: If you choose this option, enter the username, password, application ID, tenant ID, and client secret manually.

6. If you select Enter manually, enter the Application ID and Directory ID of the IMAP or POP3. You can get these from the Microsoft Azure portal, typically under the settings or configuration section related to your application or service.

   • Application ID isn't sensitive information and isn't encrypted.

   • Directory ID is sensitive information and is encrypted.

   • Client Secret is sensitive information and is encrypted.

7. (Optional) Click Test settings... to test your email account settings.
   

8. Expand the Error handling section to customize the error codes and messages for any errors, or choose the default values.

Get messages tab

1. (a) Define the filter by which the messages will be identified and retrieved; or

   (b) Enter the name of the variable into which you have set an email key. (For more information, see Get Email Trigger Input.)

   To define search From, enter the email address (for example, gilgolan@yahoo.com). To define search To, enter the display name only. (for example, if the complete email is Mike Smith <mikesmith@yahoo.com>, enter Mike Smith)

2. Enter the name of the variable into which you'd like place the result (the number of messages matching the filter criteria).

3. Indicate if you would like retry the search until at least one message is found and, if applicable, specify retry settings.

4. Instruct the wizard how to handle any errors encountered. Read more about error handling.

Step 2 - Define the actions

Upon adding the get email messages command to your wizard, you will notice that it becomes an empty "container" within the Editor Pane, waiting for you to fill it with instructions:

1. Enter the action(s) the wizard should take on each matching email message

   • You can do this by dragging the required Advanced Command(s) directly into the container