Mail modules

The technology-specific modules for mail perform specific tasks for the mail technology.

Connect to Cloud Mail Server

Connects to mail services that use OAuth 2.0. Connect to Cloud Mail Server supports Microsoft Office 365 and Google Workspace.

Value

Description

Connection Name

Name of your connection.

Microsoft Office 365

Connect to Microsoft Office 365.

Microsoft Office 365->Tenant Id

Tenant ID of your Microsoft Entra application.

Microsoft Office 365->Application Id

Application ID of your Microsoft Entra application.

Microsoft Office 365->Client Secret

Client secret you created for your Microsoft Entra application.

Microsoft Office 365->Mailbox

Email address you want to use for receiving mail.

Google Workspace

Connect to a Google Workspace.

Google Workspace->JSON Key

Contents of your JSON credentials file from the Google Cloud console. Choose one of the following options:

  • Paste the contents directly from your file. For DataType, select RawString or Password.

  • Store the contents of your file and fetch them from a supported key vault.

Google Workspace->Mailbox

Enter the Google Workspace email address you want to use to send and receive mail.

Connect to Exchange Server

Connects to a Microsoft Exchange Server to test email features. You can use this step for the exchange server and mail server test cases.

Value

Description

Connection Name

Name of the exchange server you want to connect to.

Authentication Type

Authentication method to connect to the Exchange Server endpoint. The following values are available:

  • Basic (legacy): uses basic authentication to connect with the endpoint. The result of associated test steps doesn't depend on credential validation. Note that Microsoft has announced the deprecation of this endpoint type.

  • OAuth: uses modern authentication via OAuth2 to connect with the endpoint. The result of associated test steps depends on credential validation (token acquisition). If the validation fails, so does the test case. Registration with the Microsoft identity platform is required.

In your associated test steps, always use this value with action mode Select.

Username

Username of the exchange server account.

Password

Password of the user account.

App Id

If you select OAuth as the Authentication Type, specify the Application (client) ID of your registration with the Microsoft identity platform.

Tenant Id

If you select OAuth as the Authentication Type, specify the Directory (tenant) ID of your registration with the Microsoft identity platform.

Exchange Web Services Url

Optionally, specify the address of exchange server.

Use the format https://<mail-server>/ews/exchange.asmx and replace <mail-server> with the address of your exchange server.

Otherwise, the Autodiscover service in the exchange server specifies this value automatically if it can be inferred from the username.

Connect to Mail Server

Specifies an e-mail server with which you test e-mail features. If there are no credentials test step value, the currently logged in Windows user is used to connect to the Mail Server.

Value

Description

Connection Name

Name of the mail server you want to connect to.

Mail Server

IP address or FQDN (Fully Qualified Domain Name) of the mail server.

Username

Username of the exchange server account.

Password

Password of the specifies username.

Port

If you select OAuth as the Authentication Type, specify the Application (client) ID of your registration with the Microsoft identity platform.

Enable Security

Select whether you want to use a secure connection with SSL/TLS certificates during e-mail operations.

The available values are:

  • True: use a secure connection.

  • False: don't use a secure connection.

Protocol

Network protocol you want to use.

The available values are:

  • SMTP (Simple Mail Transfer Protocol)

  • POP3 (Post Office Protocol)

  • IMAP (Internet Message Access Protocol)

Receive Mail Expert

Checks whether you received specific e-mails. This functionality supports POP3 or IMAP protocols only.

Value

Description

Connection Name

Name of the connection you defined. Use action mode Input.

Search criteria

Read-only.

Search criteria->From Address

Optionally, specify the e-mail address of the sender.

Search criteria->From Name

Optionally, specify the name of the sender.

Search criteria->To

Optionally, specify a recipient.

Search criteria->Cc

Optionally, specify a copy recipient.

Search criteria->Subject

Optionally, specify a subject line.

Search criteria->Attachment Name

Optionally, specify the file name of the attachment.

You can have multiple attachments. In the background, the system stores all attachment names as one string, separated by semicolons.

If you want to verify whether a specific attachment exists, use leading and trailing wildcards. The wildcards ensure that you only verify the existence of the one attachment, not the entire string.

For example, if you have several attachments, but only want to verify whether the attachment TestAttachment.txt exists, enter *TestAttachment.txt*.

You can also buffer attachment names. However, you can only buffer the entire string, not individual attachment names.

Search criteria->Body

Optionally, enter the message body. You can specify HTML or PLAIN text. If you don't select an option, the mail default format is plain text.

Use wildcards to verify only the body text, not the HTML tags.

Search criteria->From Date/Time

Optionally, specify the start date and time of the search period.

The system uses UTC time, so enter the start time and date in UTC.

Search criteria->To Date/Time

Optionally, specify the end date and time of the search period.

The system uses UTC time, so enter the end time and date in UTC.

Search criteria->Folder

Optionally, specify the folder structure path, for example INBOX.TestFolder. The separator depends on the mail server that you use. Use action mode Input.

The server settings determine the exact folder names, including lowercase and uppercase letters.

Search criteria->Number of Emails to examine

Optionally, specify the maximum number of e-mails to examine.

Result

Read-only.

Result->ResultCount

Verify the result count of the filter criteria that you specified, i.e. how many e-mails the specific filter produces.

To do so, enter the expected number and use action mode Verify.

Result->Mail

Each Mail node under Result represents an individual e-mail that you want to search for and test.

You can search for and test multiple e-mails. To do so, create a separate node for each e-mail and fill out the Mail Attributes.

You can choose the following criteria from the Mail dropdown:

To verify the first e-mail, enter $1.

To specify the e-mail number using a dollar sign as a prefix, enter $<n> where <n> is the respective number.

To verify the last e-mail, enter $last.

Result->Mail Attributes

Specify further search criteria to narrow down the search.

You can choose the following criteria from the Mail Attributes drop-down menu:

  • From Name

  • From Address

  • To

  • Cc

  • Subject

  • Body

  • From Date/Time

  • To Date/Time

  • Attachment Name

Result->Mail Operations

You can select the following operations from the Mail Operations dropdown:

  • Delete: deletes the e-mail.

  • Move To: moves the e-mail to an existing folder. Only IMAP servers support this operation.

  • Read: marks the e-mail as read.

  • Unread: marks the e-mail as unread.

You can use one operation per e-mail. Use action mode Select.

Result->Mail->Save Attachments To

Optionally, specify the path to the folder where you want to save the attachment. Use action mode Input.

If your e-mail contains several attachments, all of them are saved to this folder.

If the folder already contains attachments with the same name, the system overwrites the existing files.

Result->Mail->Save Mail

Specify a unique name for the mail that you want to save.

In the Send Mail module this can be used to send a reply message.

Receive Mail Simple

Checks whether you received a specific, single e-mail. This functionality supports POP3 or IMAP protocols only.

Value

Description

Connection Name

Name of the connection you defined. Use action mode Input.

From Address

IP address or FQDN (Fully Qualified Domain Name) of the mail server.

From Name

Username of the exchange server account.

To

Password of the specifies username.

CC

If you select OAuth as the Authentication Type, specify the Application (client) ID of your registration with the Microsoft identity platform.

From Date/Time

Select whether you want to use a secure connection with SSL/TLS certificates during e-mail operations.

The available values are:

  • True: use a secure connection.

  • False: don't use a secure connection.

To Date/Time

Optionally, specify the start date and time of the search period.

To Date/Time

Optionally, specify the end date and time of the search period.

Subject

Optionally, specify the subject line.

Body

Optionally, enter the message body.

You can specify HTML or PLAIN text. If you don't select an option, the mail default format is plain text. Use wildcards to ensure that you only verify the body text, not the HTML tags. Note that the value entries are case-sensitive.

Attachment Name

Optionally, specify the file name of the attachment.

You can have multiple attachments. In the background, the system stores all attachment names as one string, separated by semicolons.

If you want to verify whether a specific attachment exists, use leading and trailing wildcards. The wildcards ensure that you only verify the existence of the one attachment, not the entire string.

For example, if you have several attachments, but only want to verify whether the attachment TestAttachment.txt exists, enter *TestAttachment.txt*.

You can also buffer attachment names. However, you can only buffer the entire string, not individual attachment names.

Folder

Optionally, specify the folder structure path, for example INBOX.TestFolder. The separator depends on the mail server that you use. Use action mode Input.

The server settings determine the exact folder names, including lowercase and uppercase letters.

Save Attachments To

Optionally, specify the path to the folder where you want to save the attachment. Use action mode Input.

If your e-mail contains several attachments, all of them are saved to this folder.

If the folder already contains attachments with the same name, the system overwrites the existing files.

Save Mail

Unique name for the e-mail you want to save.

In the Send Mail module this can be used to send a reply message.

Number of Emails to examine

Optionally, specify the maximum number of e-mails to examine.

Send Mail

Sends and replies to e-mail messages via Simple Mail Transfer Protocol (SMTP).

Value

Description

Connection Name

Name of the connection you defined.

From->Address

E-mail address of the sender.

From->Name

Optionally, specify the name of the sender.

Subject

Optionally, specify the subject line.

To

Recipient. You can add multiple recipients.

Cc

Optionally, specify a copy recipient. You can add multiple recipients.

Bcc

Optionally, specify a blind copy recipient. You can add multiple recipients.

Body

Enter the message body.

You can specify HTML or PLAIN text format. If you don't select an option, the system sends the mail in HTML format by default.

Attachment

Optionally, specify the full file path to the attachment. You can add multiple attachments.

Reply To->Mail To Reply

Optionally, specify the name of the saved e-mail.

Reply to->Reply Options

Optionally, select one of the following options from the Reply Options dropdown:

  • Reply: only the sender receives the reply.

  • ReplyAll: every addressee receives the reply.