Interface: 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.

Extends¶

BaseStringSchema<Email>

Properties¶

codaType¶

codaType: Email

Defined in: schema.ts:558

Instructs Coda to render this value as an email address.

Overrides¶

BaseStringSchema.codaType

description?¶

optional description: string

Defined in: schema.ts:285

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

display?¶

optional display: EmailDisplayType

Defined in: schema.ts:560

How the email should be displayed in the UI.

type¶

type: String

Defined in: schema.ts:807

Identifies this schema as a string.

Inherited from¶

BaseStringSchema.type