Skip to content

Interface: EmailSchema

core.EmailSchema

A schema representing a return value or object property that is an email address.

An email address can be represented visually as an icon, an icon plus the email address, or the just the email address. Autocomplete against previously typed domain names is also an option in the user interface.

Hierarchy

  • BaseStringSchema<Email>

EmailSchema

Properties

autocomplete

Optional autocomplete: boolean

Whether to auto-complete the email domain during user input.

Defined in

schema.ts:498


codaType

codaType: Email

Instructs Coda to render this value as an email address.

Overrides

BaseStringSchema.codaType

Defined in

schema.ts:494


description

Optional description: string

A explanation of this object schema property shown to the user in the UI.

If your pack has an object schema with many properties, it may be useful to explain the purpose or contents of any property that is not self-evident.

Inherited from

BaseStringSchema.description

Defined in

schema.ts:215


display

Optional display: EmailDisplayType

How the email should be displayed in the UI.

Defined in

schema.ts:496


type

type: String

Identifies this schema as a string.

Inherited from

BaseStringSchema.type

Defined in

schema.ts:698