Skip to main content

Easy Form Settings - Emails/Handlers

Each form has its own group of settings and preferences which can be configured to control how users may access the form, number of submissions that can be made, email addresses associated with submissions, and more. 

With emails, administrators can configure the actions and behaviors when a submission is created, updated, or deleted. Handlers are used to route submitted data to external applications, send notification, and confirmations. 

To access these settings:

  1. From the Dashboard, click Easy Forms
  2. Find the form to configure the settings for by:
    1. Browse the list; OR
    2. Search the list by form name
  3. Once found, under the Operations column, click the drop down arrow, then click Settings
  4. Click the Emails/Handlers sub-tab

Setting up Emails

  1. Click +Add Email, complete the form that opens in the window on the right

General tab

  1. Title, this is the administrative name of the email notification
  2. In the Send To section
    1. To email, the address the notification will be sent to (see email options below)
    2. CC email, the address(s) that will be carbon copied on the form submission, this is optional (see email options below)
    3. BCC email, the address(s) that will be blind carbon copied on the form submission, this is optional (see email options below)
  3. In the Send From section
    1. From email, the address that will appear as the sender of the notification (see email options below)
    2. From name, the name that will appear as the sender of the notification (see email options below)
  4. In the Reply To section
    1. Reply-to email, the address used for reply submissions (see email options below)
      1. Typically, Reply-to addresses are different than the From addresses, assuming you want someone else to receive replies that are created by users who reply to the email notifications
  5. In the Message section
    1. Subject, select from
      1. Custom, enter your own subject text
      2. Default, [webform_submission:source-title]
      3. Elements, select from elements added to the webform 
    2. Body, select from
      1. Custom, enter the desired text in to the body field, click Browse Available Tokens to add tokens to pull data from the easy form elements into the email body
      2. Default, a basic message will be populated which includes tokens added to pull data from the easy form elements
      3. Elements, select an element from the easy form to display it's submission data as the body of the email
  6. Click Save

Email Options

  • Custom To Email Address
    • When selected, you'll be prompted manually enter a valid email address
  • Default [site:mail] Address
    • This address is configured in the Dashboard, under System Configuration, then Site Configuration, then Site Details
  • Elements
    • The email notification will be sent to the value of the form submission for the selected element
      • Note: this will fail if the value is not a valid email address
  • Other: Site Email Address
    • This address is configured in the Dashboard, under System Configuration, then Site Configuration, then Site Details
  • Other: Current Email Address
    • This is the address configured for the authenticated user
      • Note: this will not work when form is submitted by an anonymous user
  • Other: Webform Author Email Address
    • This is the address of the user who created the form
  • Other: Webform Submission Owner Email Address
    • This is the address of the user who reviews submissions
      • Note: this option only works for authenticated users

Conditions

Click the Conditions tab to configure settings that allow you to control the appearance, state, or validation of pages or elements. For more information on adding conditions, see the article Advanced Features for Easy Forms.

Advanced

Click the Advanced tab, to configure additional settings associated with email notifications triggered by the easy form. 

  1. Advanced Settings
    1. Enable the email handler, check this box to enable the handler
  2. Additional Settings
    1. Send email, check the box beside the condition you want the email sent for
      1. ...when draft is created
      2. ...when draft is updated
      3. ...when anonymous submission is converted to authenticated
      4. ...when submission is completed
      5. ...when submission is updated
      6. ...when submission is deleted
      7. ...when submission is locked
    2. Return path, select the email to which bounce messages are delivered. 
      1. Leave blank to automatically use the 'From' email address
    3. Sender email, the email address submitting the message, if other than shown by the From header
      1. Leave blank to automatically use the 'From' email address
    4. Sender name, select the name for the sender
    5. Send email as HTML, check this box to send the email in an HTML format
    6. Theme to render this email, select the theme the email will be rendered in
    7. Custom parameters, enter any additional custom parameters to be appended to the emails parameters
  3. Development settings
    1. Enable debugging, check this box to display onscreen all emails to all users
  4. Click Save when finished

Setting up Handlers

  1. Click the + Add Handler button, then select the handler to configure by clicking the Add Handler button under the operations column for the handler type:
    1. Action, triggers an action on a submission
    2. Debug, debug a webform submission
    3. Remote Post, Posts webform submissions to a URL
    4. Settings, Allows webform settings to be overridden based on submission data, source entity fields, and conditions

Action Handlers

General tab

  1. General settings 
    1. Title, name the handler
    2. Administrative notes, add any relevant administrative notes if applicable
  2. Trigger
    1. Execute, select the trigger type from:
      1. ...when draft is created
      2. ...when draft is updated
      3. ...when anonymous submission is converted to authenticated
      4. ...when submission is completed
      5. ... when submission is updated
  3. Actions
    1. Change status, select from
      1. Flag/Star
      2. Unflag/Unstar
    2. Change lock, select from 
      1. Lock
      2. Unlock
        1. Submissions can only be unlocked programmatically 
    3. Append the below text to notes (plain text)
    4. Display message
      1. Enter a message to display
    5. Display message type, select from 
      1. Status
      2. Error
      3. Warning
      4. Info
    6. Update the below submission data (YAML)
    7. Available element keys, expand the section to view the available element keys
  4. Click Save when finished

Conditions tab

Click the Conditions tab to configure settings that allow you to control the appearance, state, or validation of pages or elements. For more information on adding conditions, see the article Advanced Features for Easy Forms.

Advanced tab

Click the Advanced tab, to configure additional settings associated with handler. 

  1. Advanced settings
    1. Enable the Action handler, when checked, will enable the action handler
  2. Development settings
    1. Enable debugging, when checked, trigger actions will be displayed on screen for all users
  3. Click Save when finished

Debug Handlers

General tab

  1. General settings 
    1. Title, name the handler
    2. Administrative notes, add any relevant administrative notes if applicable
  2. Debug settings
    1. Data format, select from
      1. YAML
      2. JSON
    2. Include submission properties, when checked, all submission properties and values will be included in the displayed debug information
  3. Click Save when finished

Conditions tab

Click the Conditions tab to configure settings that allow you to control the appearance, state, or validation of pages or elements. For more information on adding conditions, see the article Advanced Features for Easy Forms.

Advanced tab

Click the Advanced tab, to configure additional settings associated with handler. 

  1. Advanced settings
    1. Enable the Debug handler, when checked, will enable the debug handler
    2. Click Save when finished

Remote Post Handlers

General tab

  1. General settings 
    1. Title, name the handler
    2. Administrative notes, add any relevant administrative notes if applicable
  2. Completed, data will be posted when a submission is completed
    1. Completed URL, enter the full URL to POST to when the submission is completed
  3. Updated, data will be posted when a submission is updated
    1. Updated URL, enter the full URL to POST to when the submission is updated
  4. Deleted, data will be posted when a submission is deleted
    1. Deleted URL, enter the full URL to POST to when the submission is deleted
  5. Submission data, data will be posted when a submission is completed
    1. Check the box beside the data to post
  6. Click Save when finished

Conditions tab

Click the Conditions tab to configure settings that allow you to control the appearance, state, or validation of pages or elements. For more information on adding conditions, see the article Advanced Features for Easy Forms.

Advanced tab

Click the Advanced tab, to configure additional settings associated with handler. 

  1. Advanced settings
    1. Enable the Remote post handler, when checked, will enable the remote post handler
  2. Additional settings
    1. Method, select POST to request the web server accept the data enclosed when a completed form is submitted
    2. Post type, select from 
      1. x-www-form-urlencoded
        1. Use this option when unsure, as it is the default format for HTML webforms
      2. JSON
    3. Cast posted element value and custom data, when checked posted element values will be cast to integers, floats, and booleans as needed
      1. Custom data can be cast by placing the desired type in parentheses before the value or token
    4. Custom data, enter the custom data that will be included in all remote post requests 
    5. Custom options, enter custom request options that will be used by the Guzzle HTTP client
    6. Custom error response message, enter a message to be displayed when the response status code is not 2xx
    7. Add, select a numerical value and click the button to add more settings as needed
    8. Custom error response redirect URL, enter the URL or path to redirect when a remote fails
  3. Development settings 
    1. Enable debugging, when checked, posted submissions will be displayed on screen for all users
  4. Click Save when finished 

Settings Handlers

General tab

  1. General settings 
    1. Title, name the handler
    2. Administrative notes, add any relevant administrative notes if applicable
  2. Confirmation settings
    1. Confirmation title, enter a title display at the top of the page upon a successful submission
    2. Confirmation message, enter a message to be displayed upon a successful submission
  3. Custom settings
    1. Custom settings (YAML), enter the setting name and value as YAML
  4. Available custom settings, expand the section to see the available settings
  5. Click Save when finished

Conditions tab

Click the Conditions tab to configure settings that allow you to control the appearance, state, or validation of pages or elements. For more information on adding conditions, see the article Advanced Features for Easy Forms.

Advanced tab

Click the Advanced tab, to configure additional settings associated with handler. 

  1. Advanced settings
    1. Enable the Settings handler, when checked, will enable the settings handler
  2. Developer settings
    1. Enable debugging, when checked, settings will be displayed on screen for all users
  3. Click Save when finished
Was this article helpful?
0 out of 0 found this helpful
Return to top