# mail.update

Update Mail Service Configuration.

Type: object

##

Type: array
No Additional Items

#### Tuple Validation

##### Parameter 1: data

#### data

Type: object

Mail configuration fields to update.

No Additional Properties

##

#### Fromemail

Type: string

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

##

#### Fromname

Type: string

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

##

#### Outgoingserver

Type: string

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

##

#### Port

Type: integer

TCP port number for the SMTP server connection.

##

#### Security

Type: enum (of string)

Type of encryption.

##### Must be one of:

- "PLAIN"
- "SSL"
- "TLS"

##

#### Smtp

Type: boolean

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

##

#### User

SMTP username.

## Any of

Type: string
Type: null

##

#### Pass

SMTP password.

## Any of

Type: string
Type: null

##

#### Oauth

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

## Any of

#### MailEntryOAuth

Type: object
No Additional Properties

##

#### Provider

Type: string

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

##

#### Client Id

Type: string

OAuth client ID provided by the email provider.

##

#### Client Secret

Type: string

OAuth client secret provided by the email provider.

##

#### Refresh Token

Type: string

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

#### EmptyDict

Type: object
Type: null

##

#### MailEntry

Type: object

The resulting mail configuration.

No Additional Properties

##

#### Fromemail

Type: string

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

##

#### Fromname

Type: string

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

##

#### Outgoingserver

Type: string

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

##

#### Port

Type: integer

TCP port number for the SMTP server connection.

##

#### Security

Type: enum (of string)

Type of encryption.

##### Must be one of:

- "PLAIN"
- "SSL"
- "TLS"

##

#### Smtp

Type: boolean

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

##

#### User

SMTP username.

## Any of

Type: string
Type: null

##

#### Pass

SMTP password.

## Any of

Type: string
Type: null

##

#### Oauth

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

## Any of

#### MailEntryOAuth

Type: object
No Additional Properties

##

#### Provider

Type: string

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

##

#### Client Id

Type: string

OAuth client ID provided by the email provider.

##

#### Client Secret

Type: string

OAuth client secret provided by the email provider.

##

#### Refresh Token

Type: string

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

#### EmptyDict

Type: object
Type: null

##

#### Id

Type: integer

Unique identifier for this mail configuration.

Required roles: ALERT_WRITE