EmailConfigDto
One of the tenant's own email connections (SMTP, Outlook or Gmail), which it sends its emails through. Send
only. With no connected default, the tenant's emails go through CIS Manager's own sender, replies to the tenant.
Properties
| Name | Type | Description |
|---|---|---|
| code* | string | The connection's code |
The connection's code | ||
| providerType* | enum | How the connection sends |
How the connection sends | ||
| fromEmail* | string | The address the emails are from |
The address the emails are from | ||
| fromName | string | The name the emails are from |
The name the emails are from | ||
| isDefault* | boolean | Whether the tenant's emails go through this connection (when it is connected) |
Whether the tenant's emails go through this connection (when it is connected) | ||
| status* | enum | The connection's state; only a connected one sends |
The connection's state; only a connected one sends | ||
| statusReason | string | Why the connection is not connected, when known |
Why the connection is not connected, when known | ||
| smtpSettings | EmailSmtpSettingsDto | The SMTP settings of an SMTP connection (never the password) |
The SMTP settings of an SMTP connection (never the password) | ||
| connectedEmail | string | The mailbox an Outlook or Gmail connection signed in as |
The mailbox an Outlook or Gmail connection signed in as | ||
| authorisationUrl | string | Where to send the user to sign in, while an Outlook or Gmail connection awaits it |
Where to send the user to sign in, while an Outlook or Gmail connection awaits it | ||
| createdDate* | string | When the connection was added |
When the connection was added | ||
JSON Example
{
"code": "string",
"providerType": "Smtp",
"fromEmail": "string",
"fromName": "string",
"isDefault": false,
"status": "PendingOAuthSetup",
"createdDate": "2024-01-01T00:00:00Z"
}