Email

Email is an input used to save Email addresses.

💡 Common email usage

The Email input type can be used to store any legal email address.

API definition

Basic

{
  "myEmailInput": {
    "title": "My email input",
    "icon": "My icon",
    "description": "My email input",
    "type": "string",
    "format": "email",
    "default": "me@example.com"
  }
}

Select (Enum)

{
  "myEmailSelectInput": {
    "title": "My email select input",
    "icon": "My icon",
    "description": "My email select input",
    "type": "string",
    "format": "email",
    "enum": ["me@example.com", "example@example.com"]
  }
}

Array

{
  "myEmailArrayInput": {
    "title": "My email array input",
    "icon": "My icon",
    "description": "My email array input",
    "type": "array",
    "items": {
      "type": "string",
      "format": "email"
    }
  }
}

Check out Port's API reference to learn more.

Terraform definition

Basic

resource "port_action" "myAction" {
  # ...action properties
  user_properties = {
    string_props = {
      "myEmailInput" = {
        title       = "My email input"
        description = "My email input"
        format      = "email"
        default     = "me@example.com"
      }
    }
  }
}

Select (Enum)

resource "port_action" "myAction" {
  # ...action properties
  user_properties = {
    string_props = {
      "myEmailInput" = {
        title       = "My email input"
        description = "My email input"
        format      = "email"
        default     = "me@example.com"
        enum = ["me@example.com", "example@example.com"]
      }
    }
  }
}

Array - coming soon

resource "port_action" "myAction" {
  # ...action properties
  user_properties = {
    array_props = {
      "myEmailInput" = {
        title       = "My email input"
        description = "My email input"
        default     = "me@example.com"
        string_items = {
          format = "email"
        }
      }
    }
  }
}