Email Component
Overview
The Email component acts like a Text Field component, but with an additional feature 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 ensure it matches valid email formatting. This component is often used with account setups or user registration. You can use it whenever you need end-users to submit a valid email address, though the component does not confirm if the email address is active.
You can find the component under the Secondary Fields group to the left of the Module Builder.
Acceptable Email Formats
The Email component relies on valid email address formatting in the form of prefix@DomainName.TopLevelDomain. Use the table below to better understand acceptable Email component formats:
|
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. Prefixes can include the following characters:
A special character cannot be the first or last character in the prefix, nor can they appear in succession. |
|
@ |
The symbol in an email 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. Domains can include the following characters:
|
|
Top-Level Domain |
Top-level domains are the highest level of the domain naming system. Common top-level domains can include the following examples:
That said, Unqork supports all top-level domains. |
About the Configuration Window
To learn more about general component settings and those 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 |
|
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 Label |
Setting the Hide Label toggle to (ON) stops Label Text from displaying 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.. Your Label Text still displays in the Module Builder. By default, the Hide Label toggle is set to (OFF). |
|
Disable User Input |
When set to (ON), end-users cannot 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 sends content to the field, the end-user can view 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 Helper Text |
Stops Helper Text from displaying in Express View. By default, the Hide Helper Text 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, like 999-99-9999. Or, use an input mask that stores a formatted username, like aa9999. |
Data Panel
Data Storage
|
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:
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. 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. 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 (ON) in Module Settings, only values from fields with Store Data in Database enabled are tracked. |
Validation Panel
|
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, like saving or submitting a form. |
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 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. |
|
Min/Max Length |
Sets the minimum or the maximum number of characters an end-user must enter for valid input. |
|
Regular Expression Pattern |
The Regular Expression pattern that the field's value must match to be valid. To learn about Regular Expression patterns, view our Regex in Unqork article. |
|
Pattern Error Message |
An error message that displays if the value does not 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
In this example, you'll configure an Email component that collects 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 Component. |
| 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:
Overview
The Email component acts like a Text Field component, but with an additional feature 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 ensure it matches valid email formatting. This component is often used with account setups or user registration. You can use it whenever you need end-users to submit a valid email address, though the component does not confirm if the email address is active.
You can find the component under the Secondary Fields group to the left of the Module Builder.
Acceptable Email Formats
The Email component relies on valid email address formatting in the form of prefix@DomainName.TopLevelDomain. Use the table below to better understand acceptable Email component formats:
|
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. Prefixes can include the following characters:
A special character cannot be the first or last character in the prefix, nor can they appear in succession. |
|
@ |
The symbol in an email 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. Domains can include the following characters:
|
|
Top-Level Domain |
Top-level domains are the highest level of the domain naming system. Common top-level domains can include the following examples:
That said, Unqork supports all top-level domains. |
About the Configuration Window
To learn more about general component settings and those that display when a component is associated with Data Models, view our General Component Settings article.
Display Panel
Field Text
|
Contextual Help
|
Default State Options
|
Formatting
|
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:
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. 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. 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 (ON) in Module Settings, only values from fields with Store Data in Database enabled are tracked. |
Validation Panel
|
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, like saving or submitting a form. |
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. To learn about Regular Expression patterns, view our Regex in Unqork article. |
|
Pattern Error Message |
An error message that displays if the value does not 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
In this example, you'll configure an Email component to collect 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
