Get Email

The Get Email action A feature that supplies the instructions in a botflow. in a botflow A file that stores the actions and variables designed to automate tasks. retrieves email messages from an email server.

Using the Get Email action, you can:

  • Retrieve regularly scheduled emails.
  • Refresh a local inbox for new messages.

Some examples of using the Get Email action are to:

  • Retrieve a regularly distributed newsletter.
  • Collect account notifications.
  • Set up automated email processing.

Add a Get Email action to a botflow

This example provides the steps necessary to add a Get Email action to a botflow.

To add a Get Email action to a botflow:

  1. Create a Credential to use your email account authentication from within the botflow.

    2. To create a credential:

    1. Click Add Item () on the Botflow Pane.
    2. Click Credential.
    3. Type a Name for the credential.
    4. Type a unique Username.
      Note: 
      • The username cannot match the name of any other credential in the botflow.
      • For email, the username is the email address.
    5. Type the value of the Password and confirm it to ensure that the correct value has been submitted.
    6. (Optional) Select Never save protected values with botflow.

      7. Note: In compliance with companies that have a policy against saved passwords, when selected, neither the password nor any of the Additional Field values are saved in the botflow. This option is for use in an attended bot situation where the user must first enter the password and/or Additional Field values before botflow runs, either by using the Credential Prompt action or by manually setting those values.

    7. (Optional) Type Notes to document any special instructions or functionality.
    8. Click OK to save the credential.
  2. Add an email account to your botflow.

    3. To create an email account:

    1. Click Add Item () on the Botflow Pane.
    2. Click Email.

      3. The Email window displays.

    • Account
      • Letter: Displays the default connection letter A rule that controls the connection to a target or application..
      • Email: Displays the email account information created in Credentials. If more than one credential is available, select the required credential from the drop-down list.
      • Authentication: Select Yes to require an SMTP Password for login.
      • Confirm Password: Enter the email authentication password.
      • Purpose: Select to:
        • Send & Receive: Both the Send Email (SMTP) settings and the Receive Email (IMAP) settings must be configured.
        • Send only: Only the Send Email (SMTP) settings must be configured.
        • Receive only: Only Receive Email (IMAP) settings must be configured.
      • Test Settings: Click to validate the entered Email Account information.

        • If the test is successful, a test email is sent to the email address provided in the Email field.

    • Send Email (SMTP)
      • Name: Enter an email display name for the email From field.
      • Server: Enter the SMTP Server name or IP address.
      • Port: Enter the required port number.
      • SSL: Select Yes to send email using SSL.
    • Receive Email (IMAP)
      • Server: Enter the IMAP Server name or IP address.
      • Port: Enter the required port number.
      • SSL: Select Yes to receive email using SSL.

  3. On the Actions list, click Email and then click Get Email from the Email list.

    4. The Get Email Action Builder window displays.

  1. Set the Get Email settings.

    Folder: Type an email folder into the Folder field.

    Retrieve: Select the email messages to retrieve from the drop-down list.

    Limit: Check the box to type a number value in the Limit field.

  1. If needed, adjust the Rule settings to modify how Nintex RPA finds the application target.
  2. If needed, adjust the Run Error Task settings to fine tune how the action runs.
  1. View the action Details settings.
  2. If needed, adjust the Run Switch setting to create the action without running it.
  3. Optionally, add an action note.
  4. Click OK to add the Get Email action to the botflow.

If you will be using your account to routinely send email, consider using Account Preferences to store your Email Preferences.

To set Email preferences:

  1. Click Account from the Nintex RPAMenu Bar.
  2. Click Preferences in the Account Panel.

    3. The Preferences window displays.

  3. Click Email.

    4. The Email configurable fields display.

    Account

    • Email: Enter the email address. This address displays in the email From field.
    • Authentication: Defaults to Yes and requires SMTP Password for login.
    • Password: Enter the email authentication password.
    • Purpose: Defaults to Send and Receive. Select to Send only or Receive only if required.

    Send Email (SMTP)

    • Name: Enter an email display name for the email From field.
    • Server: Enter the SMTP Server name or IP address.
    • Port: Defaults to 25. Enter a different port number if required.
    • SSL: Defaults to No. Select yes to send email using SSL.

    Receive Email (IMAP)

    • Server: Enter the IMAP Server name or IP address.
    • Port: Defaults to 993. Enter a different port number if required.
    • SSL: Defaults to Yes. Select no if receiving email using SSL is not required.

  4. Click OK to save the changes.
Field or button Description
Get Email Options/Settings
    General
    • Folder: Type an email folder into the Folder field, use the drop-down list to select an available email folder, or use the Expression Builder to build the action settings using variables or other token values.
    • Retrieve: Select the email messages to retrieve from the drop-down list:
      • All Messages: Retrieves all messages in the selected Folder.
      • Unread Messages: Retrieves all unread messages in the selected Folder.
      • Read Messages: Retrieves all read messages in the selected Folder.
      • Custom: Displays the available Custom Options to further filter the Get Email action:
        • Status: Select the check box to use the drop-down list and set the filter logic between Unread and Read emails.
        • Sent Date: Check the box to use the drop-down list to set the filter logic and type a value in the field, or use the Expression Builder to build the action settings using variables or other token values.
        • From: Check the box to use the drop-down list to set the filter logic and type a value in the field, or use the Expression Builder to build the action settings using variables or other token values.
        • To: Check the box to use the drop-down list to set the filter logic and type a value in the field, or use the Expression Builder to build the action settings using variables or other token values.
        • Cc: Check the box to use the drop-down list to set the filter logic and type a value in the field, or use the Expression Builder to build the action settings using variables or other token values.
        • Subject: Check the box to use the drop-down list to set the filter logic and type a value in the field, or use the Expression Builder to build the action settings using variables or other token values.
        • Message: Check the box to use the drop-down list to set the filter logic and type a value in the field, or use the Expression Builder to build the action settings using variables or other token values.
        • Attachment: Check the box to use the drop-down list to set the filter logic.
        • Priority: Check the box to use the drop-down list to set the filter logic between Normal, High, or Low priority emails.
    • Limit: Check the box to type a number value in the Limit field, use the up and down arrows to adjust the Limit number, or use the Expression Builder to build the action settings using variables or other token values.
Rules
  1. Click Rules from the Action Builder The Action Builder window provides access to the tools needed to create and modify Actions or instructions within a botflow. window to adjust the Connection Letter.
  1. Click the Connection Letter to select another email account.
  2. Click to select All Email or Current Email.

Note: Selecting Current Email requires that the email action be inside of the Loop Email action.
Details

When directed by Nintex Support, click Details from the Preview Panel of the Action Builder. If needed, Nintex Support will supply additional information.
Run error task
  1. Click Run error task.
  2. Open the On Error drop-down list and select the required setting:
    • Run error task: A botflow containing an error task automatically runs the error task in the event of an error. If the botflow does not contain an error task, the botflow stops in the event of an error.
    • Stop on error: The botflow stops in the event of an error.
    • Ignore errors: The action is skipped in the event of an error and the botflow attempts to execute the next action
  1. Click X to close the drop-down and save the setting.
Note

(Optional) Type a Note to document any special instructions or functionality.    
Run Switch

The Run Switch toggle controls how Nintex RPA runs an action when adding or editing an action in a botflow.

  • Run: To run the action automatically when you click OK, turn the toggle to Run.

  • Don't Run: If you do not want to run the action automatically when you click OK, turn the toggle to Don't Run.
OK/Cancel Click OK to save the action or click Cancel to discard the action or any changes.