Get Email

The Get Email action An instruction within a botflow. in a botflow Automated steps that you can design for each bot that will run. retrieves email messages from an email server.

Note: 
  • On May 30, 2022, basic access authentication for Gmail was deprecated and less secure apps are no longer supported. If you are using App Passwords to send or get email from a Gmail inbox, those passwords will continue to work. If you want to use full OAuth authentication for additional security and standardization, you can transition to it with Nintex Bot 17.10.0 or later.

  • On December 31, 2022, basic authentication for Microsoft Exchange Online was deprecated. If you want to use full OAuth authentication for additional security and standardization, you can transition to it with Nintex Bot 17.10.0 or later.

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. Select 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. If needed, type the value of the Password and confirm it to ensure that the correct value has been submitted.
      Note: 
      • On May 30, 2022, basic access authentication for Gmail was deprecated and less secure apps are no longer supported. If you are using App Passwords to send or get email from a Gmail inbox, those passwords will continue to work. If you want to use full OAuth authentication for additional security and standardization, you can transition to it with Nintex Bot 17.10.0 or later.

      • On December 31, 2022, basic authentication for Microsoft Exchange Online was deprecated. If you want to use full OAuth authentication for additional security and standardization, you can transition to it with Nintex Bot 17.10.0 or later.

    6. (Optional) Click + (plus sign) in the Additional Fields table header to add optional fields.
      1. Type a Name for the field.
      2. Type the Value to send to the application.
      3. Click OK.
    7. (Optional) Select the Never save protected values with botflow check box.
    8. 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.

    9. (Optional) Type a Note to document special instructions or functionality.
    10. Click OK to save the credential.
  3. Add an email account to your botflow.
  4. To create an email account:

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

    • Account
      • Letter: Displays the default connection letter A specific letter used by Nintex RPA LE to communicate with an external application when a Nintex RPA LE action runs..
      • 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.
      • Send Mail As: Type an email display name for the email From field.
      • Authentication: Select an authentication method:
        • None. Users can send, but not receive, emails.

        • OAuth2. Select if you are using full OAuth authentication for Gmail. This does not require a password for login after a token has been received from the provider. In order to receive the token, allow Google to access your Nintex RPA LE account.

        • App Pasword. This requires a SMTP password for login.

        • Basic. This requires a SMTP password for login.

      • Confirm Password: Type the email authentication password.
        Note: 
        • On May 30, 2022, basic access authentication for Gmail was deprecated and less secure apps are no longer supported. If you are using App Passwords to send or get email from a Gmail inbox, those passwords will continue to work. If you want to use full OAuth authentication for additional security and standardization, you can transition to it with Nintex Bot 17.10.0 or later.

        • On December 31, 2022, basic authentication for Microsoft Exchange Online was deprecated. If you want to use full OAuth authentication for additional security and standardization, you can transition to it with Nintex Bot 17.10.0 or later.

      • 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 Connection: Click to validate the 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)
      • Server: Type the SMTP server name or IP address.
      • Port: Type the required port number.
      • SSL: Select Yes to send email using SSL.
    • Receive Email (IMAP)
      • Server: Type the IMAP Server name or IP address.
      • Port: Type the required port number.
      • SSL: Select Yes to receive email using SSL.
    Note: 

     

    If you are using full OAuth authentication for Gmail, you must enable IMAP access. In the Gmail account Settings, go to Settings > Forwarding and POP/IMAP > IMAP access > Enable IMAP. Nintex Bot uses the following Gmail OAuth authentication server settings:

    SMTP server settings

    Server: smtp.gmail.com

    Port: 587

    Authentication: TLS/STARTTLS

     

    IMAP server settings

    Server: imap.gmail.com

    Port: 993

    Authentication: SslOnConnect

  5. On the Actions list, click Email and then click Get Email from the Email list.
  6. 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 Bot 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.