API Docs / Schemas / CreateEmailConfigRequest

CreateEmailConfigRequest

A connection to add. SMTP takes smtpSettings; Outlook and Gmail take returnUrl and answer with the
authorisationUrl to send the user to.

Properties

Name Type Description
providerType*enum

How the connection sends

Smtp Microsoft365 Google

How the connection sends

Smtp Microsoft365 Google

fromEmail*string

The address the emails are from (for Outlook and Gmail, the mailbox that will sign in)

The address the emails are from (for Outlook and Gmail, the mailbox that will sign in)

fromNamestring

The name the emails are from; the tenant's name when left out

The name the emails are from; the tenant's name when left out

isDefault*boolean

Make it the connection the tenant's emails go through. The tenant's first connection always is.

Make it the connection the tenant's emails go through. The tenant's first connection always is.

smtpSettingsEmailSmtpSettingsRequest

The SMTP settings; required for an SMTP connection

The SMTP settings; required for an SMTP connection

returnUrlstring

The page of this application the sign-in returns to, with oauth_status (success or error),
config_code and oauth_error added to its query; required for Outlook and Gmail

The page of this application the sign-in returns to, with oauth_status (success or error),
config_code and oauth_error added to its query; required for Outlook and Gmail

JSON Example

{
  "providerType": "Smtp",
  "fromEmail": "user@example.com",
  "fromName": "string",
  "isDefault": false,
  "smtpSettings": {
    "host": "string",
    "port": 1,
    "encryption": "...",
    "requiresAuthentication": false,
    "username": "string"
  }
}

Used By Operations