--- title: Email Suspend node description: The Email Suspend node generates and sends an email, such as an address verification email based on an email template. This node relies on an email provider to send the email. component: auth-node-ref version: latest page_id: auth-node-ref::email-suspend canonical_url: https://docs.pingidentity.com/auth-node-ref/latest/email-suspend.html keywords: ["Nodes & Trees", "Journeys", "Authentication", "Email"] page_aliases: ["auth-node-email-suspend.adoc"] superseded_by: https://docs.pingidentity.com/auth-node-ref/latest/email-suspend.html section_ids: examples: Examples example_1_forgotten_username: "Example 1: Forgotten username" before_you_start: Before you start the_journey: The journey try_the_journey: Try the journey example_2_registration: "Example 2: Registration" example_3_add_dynamic_user_data_to_the_email_suspend_message: "Example 3: Add dynamic user data to the email suspend message" availability: Availability inputs: Inputs email-suspend-dependencies: Dependencies configuration: Configuration outputs: Outputs outcomes: Outcomes errors: Errors --- # Email Suspend node The Email Suspend node generates and sends an email, such as an address verification email based on an email template. This node relies on an email provider to send the email. For self-managed deployments, the email service is configured in IDM. This node generates a unique link and passes it as the `resumeURI` property for the template. > **Collapse: How is derived?** > > The External Login Page URL is used as the base of the `resumeURI` if it's been configured. Otherwise, the Base URL Source service is used to construct the base of the `resumeURI`. > > Find more information in [Core authentication attributes > General](https://docs.pingidentity.com/pingoneaic/am-authentication/authn-core-settings.html#authn-core-general) and [Base URL Source](https://docs.pingidentity.com/pingoneaic/am-reference/services-configuration.html#realm-baseurl). The journey is suspended until the end user clicks the link in the email to resume it. Make sure the journey session is long enough for the end user to complete the journey so that it doesn't time out. Find more information in [Suspend duration](https://docs.pingidentity.com/pingoneaic/am-authentication/suspended-auth.html#configure-suspended-auth). If you don't need to suspend a journey and wait for a reply, use the [Email Template node](email-template.html) instead. ## Examples The following default journeys use the Email Suspend node: * `ForgottenUsername` * `ResetPassword` * `UpdatePassword` ### Example 1: Forgotten username In the default journey for recovering a forgotten username, the end user enters their email address to recover their username. #### Before you start * Configure the email service. You can use the built-in SMTP server. * Optionally use the email template editor to modify the `forgottenUsername` template. #### The journey ![Forgotten username journey with an \[.label\]#Email Suspend# node](_images/forgotten-username-journey.png) 1. The [Page node](page.html) with an [Attribute Collector node](attribute-collector.html) prompts for the end user's email address. 2. The [Identify Existing User node](identify-existing-user.html) attempts to look up the username by matching the email address to the email address in an identity profile. The lookup fails if more than one user profile uses the same email address. 3. The Email Suspend node reads the user profile, generates a unique `resumeURI` link to resume the journey, and populates the `forgottenUsername` email template. On success, the node makes a request to the email service to send the email. In any case, it displays the suspend message: ![Message from an \[.label\]#Email Suspend# node](_images/email-suspend-message.png) The node's settings are: | | | | --------------------- | ------------------------------------------------------------------------------------------------------- | | Email Template Name | `forgottenUsername` | | Email Attribute | `mail` (default) | | Email Suspend Message | `An email has been sent to the address you entered. Click the link in that email to proceed.` (default) | | Object Lookup | Enabled | | Identity Attribute | `mail` | 4. When the end user clicks the link to resume the journey, the [Inner Tree Evaluator node](inner-tree-evaluator.html) starts the `Login` journey. #### Try the journey Use the journey to recover the username for an account whose email you have access to. For example, if Babs Jensen's account has your email address, the Email Suspend node sends you a message such as the following: ![Email from the forgotten username journey](_images/forgotten-username-message.png) Follow the link to continue the journey and log in as Babs Jensen. ### Example 2: Registration For an example registration journey showing how to use the Email Suspend node and the [Email Template node](email-template.html), read the [Email Template node examples](email-template.html#email-template-examples). ### Example 3: Add dynamic user data to the email suspend message This example uses the [Configuration Provider node](config-provider.html) to imitate the Email Suspend node. Using the Configuration Provider node lets you include dynamic user data, such as their email address, in the email suspend message. ![Journey with a \[.label\]#Configuration Provider# node imitating the \[.label\]#Email Suspend# node](_images/email-suspend-journey-dynamic.png) Find more information in [Example 3: Imitate the Email Suspend node](config-provider.html#example3). ## Availability | Product | Available? | | ------------------------------------- | ---------- | | PingOne Advanced Identity Cloud | Yes | | PingAM (self-managed) | Yes 1 | | Ping Identity Platform (self-managed) | Yes | 1 This functionality requires that you configure AM as part of a [Ping Identity Platform deployment](https://docs.pingidentity.com/platform/8.1/sample-setup/). ## Inputs The Email Suspend node either uses the identity profile in the shared state data or looks up the user profile. In either case, the node uses any applicable profile properties to populate the email template, omitting missing values from the populated template. If Object Lookup is *not* enabled for the node (default), the shared state data must hold the Email Attribute with the recipient's email address and any properties the email template uses. If Object Lookup is enabled for the node, the shared state data must hold the profile value to match the configured Identity Attribute. The Email Suspend node uses the Identity Attribute to look up the profile, and its Email Attribute to get the recipient's email address from the profile. ## Dependencies Before you use the Email Suspend node: * (Optional) [Configure an email provider](https://docs.pingidentity.com/pingoneaic/tenants/email-provider.html). By default, tenants use the built-in SMTP server. * [Prepare an email template](https://docs.pingidentity.com/pingoneaic/tenants/email-templates.html). The template expressions refer to [user profile properties](https://docs.pingidentity.com/pingoneaic/identities/user-identity-properties-attributes-reference.html#user-details). Record the email template name for use when configuring the Email Suspend node. | | | | - | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | You can find the email template name in the required format in the URL when you're configuring the template.For example, the Forgotten Username email template's name is `forgottenUsername`:```none https://tenant-env-fqdn/?realm=alpha#/email/templates/edit/forgottenUsername ``` | ## Configuration | Property | Usage | | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Email Template Name | The name of the email template prepared as a [dependency](#email-suspend-dependencies).Default: `registration` | | Email Attribute | The shared state data property or profile attribute for the recipient's email address.Default: `mail` | | Email Suspend Message | The localized message to display when the node suspends the journey.According to [OWASP authentication recommendations](https://cheatsheetseries.owasp.org/cheatsheets/Authentication_Cheat_Sheet.html#authentication-and-error-messages), the message should be the same regardless of the validity of the recipient's email address.You can use plain text or HTML code in this message.Default: `An email has been sent to the address you entered. Click the link in that email to proceed.` | | Object Lookup | Whether to look up the managed identity profile.Default: disabled | | Identity Attribute | The attribute used to identify the managed object in the underlying identity service (PingIDM).The node uses this when Object Lookup is enabled.Default: `userName` | | Suspend Duration | (Optional) The length of time a journey session can be suspended in minutes. The time allowed for suspending the journey must be the same as or less than the maximum duration of the journey session.If set, this overrides the suspend duration set in the core authentication settings.Find more information in [Suspend duration](https://docs.pingidentity.com/pingoneaic/am-authentication/suspended-auth.html#suspended-auth-duration).Values from `1` to `2147483647` are allowed. | ## Outputs This node doesn't change the shared state. ## Outcomes The Email Suspend node has a single outcome path. Evaluation continues when the end user clicks the link in the email to resume the flow. ## Errors This node doesn't log any error or warning messages of its own.