Method: legacySoarSettings.legacyTestEmailSettings

Full name: projects.locations.instances.legacySoarSettings.legacyTestEmailSettings

legacySoarSettings.legacyTestEmailSettings tests the email settings.

HTTP request


Path parameters

Parameters
instance

string

Required. The instance to get the test email settings for. Format: projects/{project}/locations/{location}/instances/{instance}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "senderDisplayName": string,
  "senderEmailAddress": string,
  "username": string,
  "password": string,
  "smtpServerAddress": string,
  "mailServerProvider": string,
  "azureClientId": string,
  "azureTenantId": string,
  "siemplifySmtp": boolean,
  "isRequireAuthentication": boolean,
  "smtpPort": integer,
  "useOauthToken": boolean,
  "useSsl": boolean,
  "trustCertificate": boolean
}
Fields
senderDisplayName

string

Optional. The sender display name.
senderEmailAddress

string

Required. The sender email address.
username

string

Optional. The username.
password

string

Optional. The password.
smtpServerAddress

string

Required. The smtp server address.
mailServerProvider

string

Optional. The mail server provider.
azureClientId

string

Optional. The azure client id.
azureTenantId

string

Optional. The azure tenant id.
siemplifySmtp

boolean

Optional. Whether siemplify smtp is enabled.
isRequireAuthentication

boolean

Optional. Whether authentication is required.
smtpPort

integer

Optional. The smtp port.
useOauthToken

boolean

Optional. Whether to use oauth token.
useSsl

boolean

Optional. Whether to use ssl.
trustCertificate

boolean

Optional. Whether to trust certificate.

Response body

Response message for LegacySoarSettingService.LegacyTestEmailSettings.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "errorMessage": string,
  "isSuccessful": boolean
}
Fields
errorMessage

string

Output only. The error message.
isSuccessful

boolean

Output only. Whether the email was successful.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.