Email Component

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.

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.

Tooltip                                                                        

A short hint that displays when an end-user positions their cursor over the (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.

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).

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.

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.

  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.

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.

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.

Required                                                                        

When set to (ON), the end-user must enter a value in the component's visible fields. When set to (OFF), the input is optional.

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

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.

Custom CSS Class                                                                        

Enter a Custom CSS 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.