Email Component

Estimated Reading Time:  4 minutes

Overview

The Email component provides a text field that validates end-user End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product. input to match valid email formatting. Email components look and act like Text Field components, but with an added validation feature. This component is often used with account setups or user registration. You can use it whenever you want an input field for a valid email address, though the component doesn't confirm if the email address is active.

You can find the component under the Secondary Fields group to the left of the Module Builder.

What You'll Learn

After completing this article, you’ll know when to use an Email component, how to configure its settings, and how to use it in an Unqork application.

Acceptable Email Formats

The email component relies on valid email address formatting to function as expected. In this case, valid formatting means that email addresses display as prefix@DomainName.TopLevelDomain. Reference this table to understand the accepted Email component formats and as a troubleshooting resource.

Attribute

Description

Prefix

The prefix is the name of an email mailbox that belongs to a specific person, mailing list, or department.

The recipient name must not exceed 64 characters and can include:

  • Upper and lowercase letters (A-Z, a-z)

  • Digits from 0 to 9

  • Special characters like ! # $ % & ' * + - / = ? ^ _ ` { |

A special character cannot be the first or last character in the prefix, nor can they appear in succession.

@

The symbol in an e-mail address separating the prefix from the domain name.

Domain Name

The domain name of a specific mailbox provider or organization. Domain names must not exceed 253 characters but can include:

  • Upper and lowercase letters (A-Z, a-z)

  • Digits from 0 to 9

  • A hyphen (-)

  • A period (.)

Top-Level Domain

Top-level domains are the highest level of the domain name system. Common top-level domains include:

  • .com

  • .net

  • .org

NOTE  Unqork supports all top-level domains.

About the Configuration Window

General

Setting

Description

Property ID

A Property ID is the unique field ID used by Unqork to track and link components in your module.

The Property ID is how the software identifies your component. Using Property IDs lets you link components, creating logic-based configurations and API APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services. calls.

Property IDs must use camel case A naming convention for computer programming. Use camelCase for Property IDs, for example: newUser, lastName, & rdoButton. (stylized as camelCase) without spaces or punctuation.

Notes

Select this tab to display the component's Notes area. You can use notes to keep your teammates informed.

The Notes editor offers a semi-WYSIWYG (What You See is What You Get) content editor. Built to look like a word processor, this editor lets you create, edit, and format your notes. Notes save when saving the component.

Display Icon Display

Select this tab to manage your component's display settings.

Data Icon Data

Select this tab to manage your component's data settings.

Validation Icon Validation

Select this tab to manage your component's validation settings.

Advanced Icon Advanced

Select this tab to manage your component's advanced settings.

Permissions Icon Permissions

Select this tab to see the RBAC RBAC (Role-Based Access Control) is a method to control system access for authorized users. The role in RBAC refers to the levels of access employees have to a network. (role-based access control) settings of the component.

Field Tag Icon Field Tags

Assign components one-word labels to help organize, identify, and group the components in your application.

Consider an example from the API Specification Snippet: Field Tags are applied to Hidden components in the panelRequest and panelResponse Panels. The Field Tags identify the data type of parameters included in the API APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services. request and response. The API Docs Dashboard tool populates with information about each parameter’s data type, identified by the Field Tag.

Field Tags act as a type of Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. group and let you group components for configuration purposes. Field Tags let you target two or more components using a simple logic component.

For example, add the Field Tag tagForDecision to multiple components in your module. Open the Inputs table of a Decisions component and reference the tagForDecision Field Tag as the input of the Decisions component. The output of the Decisions component then affects all components with the tagForDecision Field Tag.

Save your Field Tags by pressing Enter (Return) or adding a comma after each entry.

Shortcuts Icon Shortcuts

Select this tab to open the list of supported keyboard shortcuts you can use in the component settings modal. Keyboard shortcuts include:

  • Cmd + S (Mac) / Ctrl + S (PC): Save and close the component settings modal.

  • Cmd + G (Mac) / Ctrl + G (PC): Opens a search window to find specific fields and settings in the component settings modal.

  • Tab: Tab to the next field or setting in the component settings modal. This keyboard shortcut tabs left to right and top to bottom.

  • Shift + Tab: Tab to the previous field or setting in the component settings modal. The keyboard shortcut tabs from right to left and bottom to top.

  • Enter (Return): When tabbing to a Tooltip Icon (tooltip), press Enter (Return) to display the field or setting tooltip. Press Enter (Return) again to hide the tooltip.

Additional keyboard shortcuts:

  • Drop-down menus: When you Tab to a settings drop-down, use the keyboard's Up-Arrow Icon (up)/ Down-Arrow icon (down) arrows to make a selection. Then, press Enter (Return) to confirm the selection.

Documentation IconDocumentation

Select this tab to access the component documentation in Unqork's In-Product Help.

Cancel

Click this button to undo any unsaved configuration changes and return to the canvas.

Save & Close

Click this button to save all settings as configured and return to the canvas.

TIP  To learn more about settings that display when a component is associated with Data Models, view our General Component Settings article.

Display Panel

Field Text

Setting

Description

Label Text

Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field.

User-friendly labels make your module more accessible. Keep labels short and descriptive (a word or two) using title case. For longer entries, use sentence case.

Placeholder Text

A short prompt telling end-users the expected value of an input field. For example: Enter your Social Security Number. Placeholder Text displays inside the input field until the end-user begins an entry.

Prefix

Alphanumeric characters append to the start of the value entered in the field. If called by another component, the prefix stores with the value.

Suffix

Alphanumeric characters that append to the end of the value entered in the field. If called by another component, the suffix stores with the value.

Contextual Help

Setting

Description

Tooltip

A short hint that displays when an end-user positions their cursor over the Questionmark Icon (Tooltip) icon. Tooltips can display across more than one line.

Helper Text

A quick tip describing the expected value of an input field. Unlike a Tooltip, Helper Text stays visible under the input field and displays on a single line.

Default State Options

Setting

Description

Hide Helper Text

Stops Helper Text from displaying in Express View.

By default, the Hide Helper Text toggle is set to (OFF).

Disable User Input

When set to (ON), end-users can’t interact with or edit the Express View's input field or element. When end-users hover over the field, their cursor changes to alert them to the status change.

By default, the Disable User Input toggle is set to (OFF).

Read Only View

When set to (ON), the component is display-only. If another component pushes content to the field, the end-user sees that content. Otherwise, end-users see the word None.

By default, the Read Only View toggle is set to (OFF).

Hide Field

Shows or hides the component from view. Setting the Hide Field toggle to (ON) hides the component in Express View. Setting the toggle to (OFF) shows the component. The component is always visible in the Module Builder.

By default, the Hide Field toggle is set to (OFF).

Hide Label

Setting the Hide Label toggle to (ON) stops Label Text from displaying in Express View. Your Label Text still displays in the Module Builder.

By default, the Hide Label toggle is set to (OFF).

Formatting

Setting

Description

Input Mask

An Input Mask is a string of characters that indicates the format of a valid input. Use an Input Mask when the format of the input value must be consistent. Use "9" to require a number, "a" to require a letter, and "*" to require an alphanumeric character.

For example, you might use an input mask with a field that stores a Social Security Number (999-99-9999) or a formatted username (aa9999).

Data Panel

Setting

Description

Store Data in Database

The Store Data in Database setting affects how data persists through your application. When set to (ON), Unqork stores values entered into the field to the database (server-side submission). This occurs in three scenarios:

  • Navigating between Panels in a Navigation component. On navigation between pages (Panels), the component’s value saves to the database.

  • Triggering a module save event using a Button component with an Action Type of Save.

  • Navigating between screens of a workflow. On navigation between screens, the component’s value saves to the database.

NOTE  By default, workflows persist data from all fields in the client-side submission when navigating between screens. However, only values from fields with Store Data in Database enabled store in the server-side submission.

Set the toggle to (OFF) when you don’t want to store the values from this field in the database.

NOTE  When using a Plug-In to remote execute a module, ensure data moving between modules is persistent. You can optionally enable Store Data in Database for components in the source module. But any components in the API module whose values are included in an API response must have Store Data in Database enabled. When a component’s data is not persistent, the data isn't included in an API call's response. So, Plug-Ins or external services requesting data from the API module can't receive non-persistent data in the response. To learn more about Store Data in Database in the context of API modules, see the panelResponse Panel section of the API Specification Snippet article in our In-Product Help.

TIP  Store Data in Database also affects what data is tracked using Unqork’s built-in tracker. When the Enable Tracker and Track Value toggles are set to Toggle On Icon (ON) in Module Settings, only values from fields with Store Data in Database enabled are tracked.

Validation Panel

Email

Setting

Description

Email Error Message

Displays as a custom error message under the field when the end-user enters an invalid email address and advances (Saves/submits the module).

User Input

Setting

Description

Required

When set to (ON), the end user must enter a value in the component's visible fields. Set the toggle to (OFF) when an entry is optional.

By default, the Required toggle is set to (OFF).

Required Error Message

A custom error message that displays below a required field. The error message displays when the end-user tries to save or submit the module without completing the required field.

Advanced Panel

Additional Validation Options

Setting

Description

Min/Max Length

Sets the minimum or the maximum number of characters an end-user must enter for valid input.

Min/Max Length Error Message

A custom error message that displays below the input field. The error message displays when the entry doesn't meet the minimum or maximum character length rule.

Regular Expression Pattern

The Regular Expression pattern that the field's value must match to be valid.

TIP  To learn about Regular Expression patterns, see our Regex in Unqork article.

Pattern Error Message

An error message that displays if the value doesn't meet the Regular Expression pattern.

Additional Styling

Setting

Description

Custom CSS Class

Enter a Custom CSS Cascading Style Sheets (CSS) is a style sheet language used for presenting how a HTML or XML document looks to end-users. Class to apply to your component. Custom CSS lets you maintain a consistent look and feel when the field or element is part of a template or multiple modules.

Updated CSS styling applies to all components that reference this custom class name.

Adding an Email Component

Add and configure an Email component for collecting a beneficiary's email address. These instructions assume that you have an open module saved with a title.

1. Drag and drop an  Email component onto the canvas.
2. In the Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. field, enter beneficiaryEmail.
3. In the Label Text Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field. field, enter Beneficiary Email.
4. Click Save & Close.
5. Save your module.

Preview your module in Express View Express View is how your end-user views you application. Express View also lets you preview your applications to test your configuration and view the styling. This is also the view your end-users will see when interacting with your application. After configuring a module, click Preview in the Module Builder to interact with the module in Express View.. You'll see the following functionality:

Resources