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. Enter the settings for your email server.

   If you are using Microsoft 365 Exchange online, make sure to enter the correct server domain (https://outlook.office365.com/EWS/Exchange.asmx...)

2. Email server login credentials:

   • Enter from the Nintex credentials vault; or

   • Enter a credential by variable; or

   • Enter manually

     To select a credential from the credentials vault: Select From vault. Select a credential from the list.

Working with Microsoft Office 365 new authentication method?

You can set the Application ID and Tenant/Object ID directly into the Credentials Vault settings in the Nintex Admin Tool.

Read more about Working with Microsoft 365 Exchange and Modern Authentication

Or

Enter manually:

For Microsoft Office 365 new authentication method: Insert the Tenant ID and Application ID of the Microsoft Exchange (retrieve from Microsoft Azure > Email application).

• Tenant ID (Objec tID) is a sensitive information and is encrypted

• Application ID is not sensitive information isn't encrypted

• 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.

3. Mailbox:

   Choose whether to retrieve the messages from the user's default mailbox (as entered in 2 above) or a shared mailbox.

   • For a shared mailbox, enter the mailbox address.

4. (Optional) Test your email account settings.

IMAP/POP3 servers

1. Enter the settings for your email server.

2. Email server login credentials:

   • Enter from the Nintex credentials vault; or

   • Enter a credential by variable; or

   • Enter manually

3. (Optional) Test your email account settings.

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