Email Component

The Email component acts like a Text Field component, but with an additional feature that validates end-user 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.

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:

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

  • Digits from 0 to 9.

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

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:

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

  • Digits from 0 to 9.

  • A hyphen (-) and period (.).

Top-Level Domain

Top-level domains are the highest level of the domain naming system.

Common top-level domains can include the following examples:

  • .com

  • .net

  • .org

That said, Unqork supports all top-level domains.

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.

 

A static image displaying the Email component's Display settings.

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 Label

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

By default, this setting is set to (OFF).

Hide Field

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

By default, Hide Field 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.

Input Behavior

Controls how end-users interact with the component. Choose from the following options:

  • Enable User Input: Allow end-users to view and enter data in this field.

  • Disable User Input: Prevents end-users from entering data in the field, but lets them view it. In the Module Builder, the field’s background displays as gray. In Express View, when end-users hover over the field, their cursor displays with a prohibited symbol.

  • Read Only - Legacy: Prevents end-users from entering data and replaces the field with the component’s data value. If no value is provided, the component displays None.

  • Read Only - Accessible: Makes the field non-editable and applies the readonly HTML attribute, which notifies screen readers that the field cannot be modified.

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 field, enter beneficiaryEmail.
3. In the Label Text field, enter Beneficiary Email.
4. Click Save Component.
5.  Save  your module.

Preview your module in Express View. You'll see the following functionality:

Static image displaying the Express View Preview of the completed Email component use case.