EmailConfigDto

Response DTO for an email configuration

Properties

Name	Type	Description
code	string	Unique code identifying this email configuration
Unique code identifying this email configuration
tenantUser	CodeAndNameDto
fromEmail	string	The sender email address for this configuration
The sender email address for this configuration
fromName	string	The sender display name for this configuration
The sender display name for this configuration
isDefault	boolean	Whether this is the tenant's default email configuration
Whether this is the tenant's default email configuration
isShared	boolean	Whether this configuration is shared with all users in the tenant
Whether this configuration is shared with all users in the tenant
sendEnabled	boolean	Whether this configuration can send emails (true for SMTP, controlled by OAuth settings for OAuth providers)
Whether this configuration can send emails (true for SMTP, controlled by OAuth settings for OAuth providers)
readEnabled	boolean	Whether this configuration can read/sync mailbox emails (only applicable for OAuth providers)
Whether this configuration can read/sync mailbox emails (only applicable for OAuth providers)
signature	string	HTML signature to append to outbound emails sent from this configuration
HTML signature to append to outbound emails sent from this configuration
status	enum	Represents the lifecycle status of an email configuration PendingOAuthSetup Active OAuthFailed Deleted OAuthExpired ConnectionError Deleting
Represents the lifecycle status of an email configuration PendingOAuthSetup Active OAuthFailed Deleted OAuthExpired ConnectionError Deleting
statusReason	string	User-facing explanation when the configuration is in an error state (e.g. ConnectionError); null when the configuration is healthy. Surface this to the user alongside a reconnect prompt.
User-facing explanation when the configuration is in an error state (e.g. ConnectionError); null when the configuration is healthy. Surface this to the user alongside a reconnect prompt.
providerType	enum	Represents the type of email provider Smtp SendGrid Microsoft365 Google
Represents the type of email provider Smtp SendGrid Microsoft365 Google
smtpSettings	SmtpSettingsResponseDto
oAuthStatus	OAuthStatusResponse
createdDate	string	Date this configuration was created
Date this configuration was created
updatedDate	string	Date this configuration was last updated
Date this configuration was last updated

JSON Example

{
  "code": "string",
  "tenantUser": {
    "code": "string",
    "name": "string"
  },
  "fromEmail": "string",
  "fromName": "string",
  "isDefault": false
}

Used By Operations

Contained in Schemas

EmailConfigDtoPagedResult