Get mail

The Get mail activity allows you to receive emails from the specified mail service. You can filter emails by address or subject, select only unread emails, mark selected emails as read or delete them.

начало внимание

If using a third-party mailing program is prohibited in the settings of your email provider, the activity will not work, an error occurs.

конец внимание

Activity settings

The activity settings are specified manually. To open the settings window, click on the activity on the process diagram.

Parameters Tab

The Parameters tab displays the basic activity parameters.

get-mail-1

Name. The activity name on the process diagram. It is set by default when adding the activity. You can change the name in this field.

Variable. A variable of the Mail type that will store the received emails.  You can select the variable from the list or create a new one by clicking the send-mail-3 button.

Open temporary folder. You can open the temporary folder where all attachments from received emails are stored and clear it.

Protocol. Select the IMAP or POP3 protocol. Depending on your choice, the corresponding set of filters for received emails is displayed at the end of the settings list.

SSL. If the connection to the mail server does not require SSL certificate verification, select No. The default value is Yes.

When filling in the Server address, Server port, Sender, Subject, and Folder fields, you can use process context variables that store the desired values. Click on the send-mail-2 icon and specify the variable. You can select it from the list or add a new one by clicking Create parameter. The value is inserted as {$variable name}.

Server address. Enter the address of the mail server. This field supports only the String type variables.

Server Port. Specify the port of the mail server. This field supports only the String and Integer type variables.

Timeout. How long (in milliseconds) will the system wait for a response from the mail server.

Login. Select or create a String type variable that will store the login from the email account. For the Gmail service and POP3 protocol, the login should be specified as recent:<login> to receive the latest messages (for the last 30 days).

Password. Select or create a String type variable to store the password for the email account on the server. If a password is required to connect third-party applications to the server, specify a variable containing this password. Specify it instead of the password to the email account.

Sender. Specify the sender's email address so that later you can filter emails by sender. For example, specify the variable {$sender}. This field supports only the String type variables.

Subject. Specify a subject so that later you can filter emails by subject. For example, specify the variable {$subject}. This field supports only the String type variables.

If the IMAP protocol is selected, then the following fields are displayed:

  • Date from, Date to. Select or create Date/Time type variables to specify the period for which you want to receive emails. If you do not specify the dates, the period will not be limited;
  • Mark as read. Select Yes, if you want received emails to be automatically marked as read;
  • Folder. Specify the name of the folder to receive emails from the mail server. For example, to specify Inbox, simply type inbox.

For the GMail service, you can specify other folders, for example, "Drafts", "Sent". To do this, enter the name of the folder as [Gmail]/<Folder name>. This field supports only the String and Integer type variables. If you do not fill in the field, the activity will not run.

Only unread. Select No to receive both read and unread emails. The default value is Yes.

If the POP3 protocol is selected, the following fields are displayed:

  • Number. Select or create an Integer type variable to determine the number of emails to receive, starting from the last one;
  • Delete received. Select Yes if you want to delete received emails. For the GMail service, in the email account settings specify the option to delete Gmail’s copy so that the emails are deleted.

Conditions Tab

Read more about the Conditions tab in the "Basic activity settings principles" article.

Found a typo? Highlight the text, press ctrl + enter and notify us