User Guide

Email Subscription Component

The Email Subscription component allows authors to insert an email signup field into a page. The component enables residents to sign up for one or more email listservs. When authors upload documents or publish pages associated with the listserv, an email is triggered to all subscribers with a link to the update.

 

The Email Subscription component is meant for agencies that have email listservs already configured with Publicis Sapient. Other agencies may have email newsletter signups through embedded forms or external links to forms (ex. Microsoft Office forms). These do not use this component.

Overview

Component name: Email Subscription

Authors who can use: all

Templates/page types that can use component: all

Required or optional: optional

Authoring Fields

Adding the Email Subscription component to the page

1. Once on the desired page in Edit mode, add the Email Subscription component by doing the following:

a. Option 1- double click on “Drag components here.” A modal titled “Insert New Component” will pop up. Type “Email Subscription Signup” in the search bar, or scroll to Email Subscription Signup in the list. Double click to add to page.

b. Option 2- on the left hand rail, navigate to the Components tab. Type “Email Subscription Signup” in the search bar, or scroll to Email Subscription Signup in the list. Double click to add to page.

Editing the Social Media component

  1. With the edit wrench, open the component.
  2. Newsletter Name field: Select the listserv that residents can sign up for through the component.
  3. Dropdown Description field: If multiple listservs are added above, describe what the user is selecting (ex. "Select a County").
  4. Title field: Add a title to display at the top of the component.
  5. Heading Level dropdown: Select the H-level of the title. Title can be H2 - H6.
  6. Subtitle field: Add a subtitle to display below the title.
  7. Description: Add a description to display above the email entry field. If multiple listservs are selected, this will display before the listserv selection dropdown.
  8. Helper Text field: Add helper text to display below the email entry field.

 

Email Subscription examples

All fields in Email Subscription component authored. Includes a dropdown for residents to select from multiple listservs.

Figure A: Email Subscription component as it appears on a page. This component includes a dropdown for residents to select from multiple listservs.

All fields in Email Subscription component authored. Only one listserv is available for signup, so no dropdown appears.

Figure B: Email Subscription component as it appears on a page. This component is set for subscriptions to only one listserv, so no dropdown appears.

Other Tips

  1. Learn how to trigger an email upon publication:
    1. Publishing assets
    2. Publishing pages        
  2. Residents may only sign up for one listserv at a time. If they want to join multiple listservs, they must choose the first one, sign up, then choose the second one, sign up, etc.
  3. If the component has a dropdown, email input box will appear after the resident has selected which listserv they are signing up for.
  4. Residents should only be able to click Subscribe arrow if they entered an email address in valid format.
    • If residents do not enter valid email format, they will be given an error message "Please enter valid email address"
    • After entering a valid email and clicking the arrow, a call is sent to the API to add the email to the database. Once that step is complete, residents should see success state with green check mark icon replacing the subscribe arrow. They will be given a success message "Thank you for subscribing!"