Get email settings

GET

/api/v1/instance/email

const url = 'https://example.com/api/v1/instance/email';
const options = {method: 'GET', headers: {cookie: 'ttx_access_token=<ttx_access_token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/instance/email \
  --cookie ttx_access_token=<ttx_access_token>

The outgoing email settings.

Authorizations

sessionCookie

Responses

200

Successful Response

application/json

EmailSettingsRead

Platform -> Email. Never carries a secret: has_password says whether one is stored, password_readable whether the current key still decrypts it.

object

active

required

Active

boolean

allow_insecure

required

Allow Insecure

boolean

configured

required

Configured

boolean

enabled

Enabled

boolean

failed

Failed

integer

from_address

Any of:

string
null

string

from_name

Any of:

string
null

string

has_password

Has Password

boolean

last_error

Any of:

string
null

string

last_failed_at

Any of:

string
null

string format: date-time

last_sent_at

Any of:

string
null

string format: date-time

password_readable

Password Readable

boolean

default: true

pending

Pending

integer

pinned_by_env

required

Pinned By Env

boolean

reply_to

Any of:

string
null

string

smtp_host

Any of:

string
null

string

smtp_port

Any of:

integer
null

integer

smtp_security

Any of:

string
null

string

Allowed values: starttls tls none

smtp_username

Any of:

string
null

string

transport

Any of:

string
null

string

updated_at

Any of:

string
null

string format: date-time

Example

{
  "enabled": false,
  "failed": 0,
  "has_password": false,
  "password_readable": true,
  "pending": 0,
  "smtp_security": "starttls"
}