Email category
Use Automated Test Framework (ATF) to test email notifications, outbound email flows, and inbound email responses.
Validate Outbound Email
Verify that a certain outbound email exists by searching for it in the Email [sys_email] table.
Use this step to test any email-generating script that isn't captured in the Validate Outbound Email Generated by Flow or Validate Outbound Email Generated by Notification test steps.
|
Field |
Description |
|---|---|
|
Execution order |
Integer specifying the order in which the test executes this step.As you create steps, the system automatically assigns each step an incremental value. This value causes the test to execute steps in the order that you created them. You can change this default order by editing the Execution order values. |
|
Application |
Application scope in which the system runs this step. |
|
Active |
Option to activate this test step for use. |
|
Test |
Name of the test that you're adding the step to. |
|
Step config |
Name of the step. |
|
Notes |
Notes about the test step. |
|
Conditions |
Conditions used to filter outbound emails. For example, to find an email that was sent to user@example.com, set the condition to [Recipients] [is] [user@example.com]. |
|
Table |
Table to be queried. By default, this step queries only the Email [sys_email] table. |
Validate Outbound Email Generated by Flow
Verify that a certain outbound email exists by searching for it in the Email [sys_email] table. Use this step to test that a flow is triggered as expected.
Note: This step searches only for emails that are created by a flow Send Email action. To find an email that was sent after a notification was triggered in a flow, use the Validate Outbound Email Generated by Notification step instead. To find an email that was created in any other flow action, such as a custom scripted action, use the Validate Outbound Email step instead.
|
Field |
Description |
|---|---|
|
Execution order |
Integer specifying the order in which the test executes this step.As you create steps, the system automatically assigns each step an incremental value. This value causes the test to execute steps in the order that you created them. You can change this default order by editing the Execution order values. |
|
Application |
Application scope in which the system runs this step. |
|
Active |
Option to activate this test step for use. |
|
Test |
Name of the test that you're adding the step to. |
|
Step config |
Name of the step. |
|
Notes |
Notes about the test step. |
|
Source Flow |
Flow that the outbound email was created from. |
|
Conditions |
Conditions used to filter outbound emails. For example, to find an email that was sent to user@example.com, set the condition to [Recipients] [is] [user@example.com]. |
|
Table |
Table to be queried. By default, this step queries only the Email [sys_email] table. |
Validate Outbound Email Generated by Notification
Verify that a certain outbound email exists by searching for it in the Email [sys_email] table. Use this step to test that an email notification is triggered as expected.
|
Field |
Description |
|---|---|
|
Execution order |
Integer specifying the order in which the test executes this step.As you create steps, the system automatically assigns each step an incremental value. This value causes the test to execute steps in the order that you created them. You can change this default order by editing the Execution order values. |
|
Application |
Application scope in which the system runs this step. |
|
Active |
Option to activate this test step for use. |
|
Test |
Name of the test that you're adding the step to. |
|
Step config |
Name of the step. |
|
Notes |
Notes about the test step. |
|
Source Notification |
Notification that the outbound email was created from. This field references the Notification [sysevent_email_action] table. |
|
Conditions |
Conditions used to filter outbound emails. For example, to find an email that was sent to user@example.com, set the condition to [Recipients] [is] [user@example.com]. |
|
Table |
Table to be queried. By default, this step queries only the Email [sys_email] table. |
Generate Inbound Email
Create an incoming email record to test an inbound email flow or an inbound email action.
|
Field |
Description |
|---|---|
|
Execution order |
Integer specifying the order in which the test executes this step.As you create steps, the system automatically assigns each step an incremental value. This value causes the test to execute steps in the order that you created them. You can change this default order by editing the Execution order values. |
|
Application |
Application scope in which the system runs this step. |
|
Active |
Option to activate this test step for use. |
|
Test |
Name of the test that you're adding the step to. |
|
Step config |
Name of the step. |
|
Notes |
Notes about the test step. |
|
From |
Address of the email sender. You can manually enter an email address or reference an email address from a user record. If you manually enter an email address, the system matches the address to an existing user record during testing. |
|
To |
Address of the email recipient. You can manually enter an email address or reference an email address from a user record. If you manually enter an email address, the system matches the address to an existing user record during testing. |
|
Subject |
Subject of the email. You can enter text or reference a string output from a previous test step. |
|
Body |
Content of the message body. You can enter text or reference a string output from a previous test step. |
|
Field |
Description |
|---|---|
|
output_email_record |
Record in the Email [sys_email] table. The Receive type is New and the Type is send - ready. For more information on what these fields mean, see System email log and mailboxes. |
Create a reply email record to test how the system handles a user response to an email notification.
|
Field |
Description |
|---|---|
|
Execution order |
Integer specifying the order in which the test executes this step.As you create steps, the system automatically assigns each step an incremental value. This value causes the test to execute steps in the order that you created them. You can change this default order by editing the Execution order values. |
|
Application |
Application scope in which the system runs this step. |
|
Active |
Option to activate this test step for use. |
|
Test |
Name of the test that you're adding the step to. |
|
Step config |
Name of the step. |
|
Notes |
Notes about the test step. |
|
Target Table |
Table of the target record. |
|
Target Record |
Record that the reply email updates. Selecting a target record also applies a watermark to the reply email. |
|
From |
Address of the email sender. You can manually enter an email address or reference an email address from a user record. If you manually enter an email address, the system matches the address to an existing user record during testing. |
|
To |
Address of the email recipient. You can manually enter an email address or reference an email address from a user record. If you manually enter an email address, the system matches the address to an existing user record during testing. |
|
Subject |
Subject of the email. You can enter text or reference a string output from a previous test step. |
|
Body |
Content of the message body. You can enter text or reference a string output from a previous test step. |
|
Field |
Description |
|---|---|
|
output_reply_email_record |
Record in the Email [sys_email] table. The Receive type is Reply and the Type is send - ready. For more information on what these fields mean, see System email log and mailboxes. |
Generate a string of random alphanumeric characters that you can use as test data for another step.
|
Field |
Description |
|---|---|
|
Execution order |
Integer specifying the order in which the test executes this step.As you create steps, the system automatically assigns each step an incremental value. This value causes the test to execute steps in the order that you created them. You can change this default order by editing the Execution order values. |
|
Application |
Application scope in which the system runs this step. |
|
Active |
Option to activate this test step for use. |
|
Test |
Name of the test that you're adding the step to. |
|
Step config |
Name of the step. |
|
Notes |
Notes about the test step. |
|
Length |
Number of characters in the generated string. The maximum length is 10,000 characters. If you leave the field blank, the string length is 10 characters by default. |
--- title: Email category description: Use Automated Test Framework \(ATF\) to test email notifications, outbound email flows, and inbound email responses.Verify that a certain outbound email exists by searching for it in the Email \[sys\_email\] table.Verify that a certain outbound email exists by searching for it in the Email \[sys\_email\] table. Use this step to test that a flow is triggered as expected.Verify that a certain outbound email exists by searching for it in the Email \[sys\_email\] table. Use this step to test that an email notification is triggered as expected.Create an incoming email record to test an inbound email flow or an inbound email action.Create a reply email record to test how the system handles a user response to an email notification.Generate a string of random alphanumeric characters that you can use as test data for another step. locale: en-US canonical_url: https://www.servicenow.com/docs/r/application-development/automated-test-framework-atf/test-steps-email-category.html release: brazil product: Automated Test Framework \(ATF\) classification: automated-test-framework-atf topic_type: reference last_updated: "2026-09-10" reading_time_minutes: 7 breadcrumb: [Automated Test Framework \(ATF\) test step categories, Automated Test Framework \(ATF\), Testing and debugging applications, Classic app development, Building applications] --- # Email category Use Automated Test Framework \(ATF\) to test email notifications, outbound email flows, and inbound email responses. ## Validate Outbound Email Verify that a certain outbound email exists by searching for it in the Email \[sys\_email\] table. Use this step to test any email-generating script that isn't captured in the [Validate Outbound Email Generated by Flow](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/application-development/automated-test-framework-atf/test-steps-email-category.md) or [Validate Outbound Email Generated by Notification](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/application-development/automated-test-framework-atf/test-steps-email-category.md) test steps. <table id="table_xzk_fbk_l3b"><thead><tr><th> Field </th><th> Description </th></tr></thead><tbody><tr><td> Execution order </td><td> Integer specifying the order in which the test executes this step.As you create steps, the system automatically assigns each step an incremental value. This value causes the test to execute steps in the order that you created them. You can change this default order by editing the **Execution order** values. </td></tr><tr><td> Application </td><td> Application scope in which the system runs this step. </td></tr><tr><td> Active </td><td> Option to activate this test step for use. </td></tr><tr><td> Test </td><td> Name of the test that you're adding the step to. </td></tr><tr><td> Step config </td><td> Name of the step. </td></tr><tr><td> Notes </td><td> Notes about the test step. </td></tr><tr><td> Conditions </td><td> Conditions used to filter outbound emails. For example, to find an email that was sent to user@example.com, set the condition to **\[Recipients\] \[is\] \[user@example.com\]**. </td></tr><tr><td> Table </td><td> Table to be queried. By default, this step queries only the Email \[sys\_email\] table. </td></tr></tbody> </table>**Note:** During testing, this step may take longer than expected to execute. The step times out after two minutes by default. ## Validate Outbound Email Generated by Flow Verify that a certain outbound email exists by searching for it in the Email \[sys\_email\] table. Use this step to test that a flow is triggered as expected. **Note:** This step searches only for emails that are created by a flow Send Email action. To find an email that was sent after a notification was triggered in a flow, use the [Validate Outbound Email Generated by Notification](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/application-development/automated-test-framework-atf/test-steps-email-category.md) step instead. To find an email that was created in any other flow action, such as a custom scripted action, use the [Validate Outbound Email](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/application-development/automated-test-framework-atf/test-steps-email-category.md) step instead. <table id="table_awk_kgg_r3b"><thead><tr><th> Field </th><th> Description </th></tr></thead><tbody><tr><td> Execution order </td><td> Integer specifying the order in which the test executes this step.As you create steps, the system automatically assigns each step an incremental value. This value causes the test to execute steps in the order that you created them. You can change this default order by editing the **Execution order** values. </td></tr><tr><td> Application </td><td> Application scope in which the system runs this step. </td></tr><tr><td> Active </td><td> Option to activate this test step for use. </td></tr><tr><td> Test </td><td> Name of the test that you're adding the step to. </td></tr><tr><td> Step config </td><td> Name of the step. </td></tr><tr><td> Notes </td><td> Notes about the test step. </td></tr><tr><td> Source Flow </td><td> Flow that the outbound email was created from. </td></tr><tr><td> Conditions </td><td> Conditions used to filter outbound emails. For example, to find an email that was sent to user@example.com, set the condition to **\[Recipients\] \[is\] \[user@example.com\]**. </td></tr><tr><td> Table </td><td> Table to be queried. By default, this step queries only the Email \[sys\_email\] table. </td></tr></tbody> </table>**Note:** During testing, this step may take longer than expected to execute. The step times out after two minutes by default. ## Validate Outbound Email Generated by Notification Verify that a certain outbound email exists by searching for it in the Email \[sys\_email\] table. Use this step to test that an email notification is triggered as expected. <table id="table_xzk_fbk_l3b"><thead><tr><th> Field </th><th> Description </th></tr></thead><tbody><tr><td> Execution order </td><td> Integer specifying the order in which the test executes this step.As you create steps, the system automatically assigns each step an incremental value. This value causes the test to execute steps in the order that you created them. You can change this default order by editing the **Execution order** values. </td></tr><tr><td> Application </td><td> Application scope in which the system runs this step. </td></tr><tr><td> Active </td><td> Option to activate this test step for use. </td></tr><tr><td> Test </td><td> Name of the test that you're adding the step to. </td></tr><tr><td> Step config </td><td> Name of the step. </td></tr><tr><td> Notes </td><td> Notes about the test step. </td></tr><tr><td> Source Notification </td><td> Notification that the outbound email was created from. This field references the Notification \[sysevent\_email\_action\] table. </td></tr><tr><td> Conditions </td><td> Conditions used to filter outbound emails. For example, to find an email that was sent to user@example.com, set the condition to **\[Recipients\] \[is\] \[user@example.com\]**. </td></tr><tr><td> Table </td><td> Table to be queried. By default, this step queries only the Email \[sys\_email\] table. </td></tr></tbody> </table>**Note:** During testing, this step may take longer than expected to execute. The step times out after two minutes by default. ## Generate Inbound Email Create an incoming email record to test an inbound email flow or an inbound email action. <table id="table_xzk_fbk_l3b"><thead><tr><th> Field </th><th> Description </th></tr></thead><tbody><tr><td> Execution order </td><td> Integer specifying the order in which the test executes this step.As you create steps, the system automatically assigns each step an incremental value. This value causes the test to execute steps in the order that you created them. You can change this default order by editing the **Execution order** values. </td></tr><tr><td> Application </td><td> Application scope in which the system runs this step. </td></tr><tr><td> Active </td><td> Option to activate this test step for use. </td></tr><tr><td> Test </td><td> Name of the test that you're adding the step to. </td></tr><tr><td> Step config </td><td> Name of the step. </td></tr><tr><td> Notes </td><td> Notes about the test step. </td></tr><tr><td> From </td><td> Address of the email sender. You can manually enter an email address or reference an email address from a user record. If you manually enter an email address, the system matches the address to an existing user record during testing. </td></tr><tr><td> To </td><td> Address of the email recipient. You can manually enter an email address or reference an email address from a user record. If you manually enter an email address, the system matches the address to an existing user record during testing. </td></tr><tr><td> Subject </td><td> Subject of the email. You can enter text or reference a string output from a previous test step. </td></tr><tr><td> Body </td><td> Content of the message body. You can enter text or reference a string output from a previous test step. </td></tr></tbody> </table><table id="table_lx3_y4p_l3b"><thead><tr><th> Field </th><th> Description </th></tr></thead><tbody><tr><td> output\_email\_record </td><td> Record in the Email \[sys\_email\] table. The **Receive type** is **New** and the **Type** is **send - ready**. For more information on what these fields mean, see [System email log and mailboxes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/platform-security/r_EmailLogs.md). </td></tr></tbody> </table>## Generate Inbound Reply email Create a reply email record to test how the system handles a user response to an email notification. <table id="table_xzk_fbk_l3b"><thead><tr><th> Field </th><th> Description </th></tr></thead><tbody><tr><td> Execution order </td><td> Integer specifying the order in which the test executes this step.As you create steps, the system automatically assigns each step an incremental value. This value causes the test to execute steps in the order that you created them. You can change this default order by editing the **Execution order** values. </td></tr><tr><td> Application </td><td> Application scope in which the system runs this step. </td></tr><tr><td> Active </td><td> Option to activate this test step for use. </td></tr><tr><td> Test </td><td> Name of the test that you're adding the step to. </td></tr><tr><td> Step config </td><td> Name of the step. </td></tr><tr><td> Notes </td><td> Notes about the test step. </td></tr><tr><td> Target Table </td><td> Table of the target record. </td></tr><tr><td> Target Record </td><td> Record that the reply email updates. Selecting a target record also applies a watermark to the reply email. </td></tr><tr><td> From </td><td> Address of the email sender. You can manually enter an email address or reference an email address from a user record. If you manually enter an email address, the system matches the address to an existing user record during testing. </td></tr><tr><td> To </td><td> Address of the email recipient. You can manually enter an email address or reference an email address from a user record. If you manually enter an email address, the system matches the address to an existing user record during testing. </td></tr><tr><td> Subject </td><td> Subject of the email. You can enter text or reference a string output from a previous test step. </td></tr><tr><td> Body </td><td> Content of the message body. You can enter text or reference a string output from a previous test step. </td></tr></tbody> </table><table id="table_lx3_y4p_l3b"><thead><tr><th> Field </th><th> Description </th></tr></thead><tbody><tr><td> output\_reply\_email\_record </td><td> Record in the Email \[sys\_email\] table. The **Receive type** is **Reply** and the **Type** is **send - ready**. For more information on what these fields mean, see [System email log and mailboxes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/platform-security/r_EmailLogs.md). </td></tr></tbody> </table>## Generate Random String Generate a string of random alphanumeric characters that you can use as test data for another step. <table id="table_xzk_fbk_l3b"><thead><tr><th> Field </th><th> Description </th></tr></thead><tbody><tr><td> Execution order </td><td> Integer specifying the order in which the test executes this step.As you create steps, the system automatically assigns each step an incremental value. This value causes the test to execute steps in the order that you created them. You can change this default order by editing the **Execution order** values. </td></tr><tr><td> Application </td><td> Application scope in which the system runs this step. </td></tr><tr><td> Active </td><td> Option to activate this test step for use. </td></tr><tr><td> Test </td><td> Name of the test that you're adding the step to. </td></tr><tr><td> Step config </td><td> Name of the step. </td></tr><tr><td> Notes </td><td> Notes about the test step. </td></tr><tr><td> Length </td><td> Number of characters in the generated string. The maximum length is 10,000 characters. If you leave the field blank, the string length is 10 characters by default. </td></tr></tbody> </table>|Field|Description| |-----|-----------| |random\_string|String of random alphanumeric characters.|
| title | Email category |
| description | Use Automated Test Framework \(ATF\) to test email notifications, outbound email flows, and inbound email responses.Verify that a certain outbound email exists by searching for it in the Email \[sys\_email\] table.Verify that a certain outbound email exists by searching for it in the Email \[sys\_email\] table. Use this step to test that a flow is triggered as expected.Verify that a certain outbound email exists by searching for it in the Email \[sys\_email\] table. Use this step to test that an email notification is triggered as expected.Create an incoming email record to test an inbound email flow or an inbound email action.Create a reply email record to test how the system handles a user response to an email notification.Generate a string of random alphanumeric characters that you can use as test data for another step. |
| locale | en-US |
| canonical_url | https://www.servicenow.com/docs/r/application-development/automated-test-framework-atf/test-steps-email-category.html |
| release | brazil |
| product | Automated Test Framework \(ATF\) |
| classification | automated-test-framework-atf |
| topic_type | reference |
| last_updated | 2026-09-10 |
| reading_time_minutes | 7 |
| breadcrumb | Automated Test Framework \(ATF\) test step categoriesAutomated Test Framework \(ATF\)Testing and debugging applicationsClassic app developmentBuilding applications |