mail.update

Update Mail Service Configuration.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: data

data

Type: object

Mail configuration fields to update.

No Additional Properties

fromemail

Fromemail

Type: string

The sending address that the mail server will use for sending emails.

fromname

Fromname

Type: string

Display name that will appear as the sender name in outgoing emails.

outgoingserver

Outgoingserver

Type: string

Hostname or IP address of the SMTP server used for sending emails.

port

Port

Type: integer

TCP port number for the SMTP server connection.

security

Security

Type: enum (of string)

Type of encryption.

Must be one of:

• "PLAIN"
• "SSL"
• "TLS"

smtp

Smtp

Type: boolean

Whether SMTP authentication is enabled and user, pass are required.

user

User

SMTP username.

Any of

• Option 1
• Option 2

Type: string

Type: null

pass

Pass

SMTP password.

Any of

• Option 1
• Option 2

Type: string

Type: null

oauth

Oauth

OAuth configuration for email providers that support it or null for basic authentication.

Any of

• MailEntryOAuth
• EmptyDict
• Option 3

MailEntryOAuth

Type: object
No Additional Properties

provider Required

Provider

Type: string

An email provider, e.g. "gmail", "outlook".

client_id Required

Client Id

Type: string

OAuth client ID provided by the email provider.

client_secret Required

Client Secret

Type: string

OAuth client secret provided by the email provider.

refresh_token Required

Refresh Token

Type: string

OAuth refresh token used to obtain new access tokens for email authentication.

EmptyDict

Type: object

Type: null

Return value

MailEntry

Type: object

The resulting mail configuration.

No Additional Properties

fromemail Required

Fromemail

Type: string

The sending address that the mail server will use for sending emails.

fromname Required

Fromname

Type: string

Display name that will appear as the sender name in outgoing emails.

outgoingserver Required

Outgoingserver

Type: string

Hostname or IP address of the SMTP server used for sending emails.

port Required

Port

Type: integer

TCP port number for the SMTP server connection.

security Required

Security

Type: enum (of string)

Type of encryption.

Must be one of:

• "PLAIN"
• "SSL"
• "TLS"

smtp Required

Smtp

Type: boolean

Whether SMTP authentication is enabled and user, pass are required.

user Required

User

SMTP username.

Any of

• Option 1
• Option 2

Type: string

Type: null

pass Required

Pass

SMTP password.

Any of

• Option 1
• Option 2

Type: string

Type: null

oauth Required

Oauth

OAuth configuration for email providers that support it or null for basic authentication.

Any of

• MailEntryOAuth
• EmptyDict
• Option 3

MailEntryOAuth

Type: object
No Additional Properties

provider Required

Provider

Type: string

An email provider, e.g. "gmail", "outlook".

client_id Required

Client Id

Type: string

OAuth client ID provided by the email provider.

client_secret Required

Client Secret

Type: string

OAuth client secret provided by the email provider.

refresh_token Required

Refresh Token

Type: string

OAuth refresh token used to obtain new access tokens for email authentication.

EmptyDict

Type: object

Type: null

id Required

Id

Type: integer

Unique identifier for this mail configuration.

Required roles: ALERT_WRITE