SmtpSettings

Represents SMTP server configuration for sending email notifications

This is how you view or set the Simple Mail Transfer Protocol (SMTP) Settings for Keep to be able to send email (alerts/notices/updates).

SmtpSettings Properties

SmtpSettings

Field Type Inherited from Description
FromAddress String SmtpSettings Gets or sets the email address of the sender
FromName String SmtpSettings Gets or sets the display name for the email sender
Password String SmtpSettings Gets or sets the SMTP authentication password
Port Int32 SmtpSettings Gets or sets the SMTP server port
SecureSocketOptions SecureSocketOptions SmtpSettings Gets or sets the secure socket options for the SMTP connection
SmtpHost String SmtpSettings Gets or sets the SMTP server hostname or IP address
Username String SmtpSettings Gets or sets the SMTP authentication username

JSON Structure of SmtpSettings

{
   "FromAddress"	:	"String",
   "FromName"	:	"String",
   "Password"	:	"String",
   "Port"	:	"Int32",
   "SecureSocketOptions"	:	"[SecureSocketOptions](/object-model/securesocketoptions)",
   "SmtpHost"	:	"String",
   "Username"	:	"String"
}

Get Smtp Settings Async

Example in C#

// Returns: SmtpSettings
var smtpSettings = await client.GetSmtpSettingsAsync();

Example in CURL



           curl -X GET \
               https://api.us.acresecurity.cloud/api/smtpsettings  \
               -H 'Authorization: Bearer TOKEN_GOES_HERE'

Set Smtp Settings Async

Example in C#

// Returns: nothing
await client.SetSmtpSettingsAsync(SmtpSettings settings);

Example in CURL



           curl -X PUT \
               https://api.us.acresecurity.cloud/api/smtpsettings  \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' \
               -H 'Content-Type: application/json' \
               -d '{
                       "$type":"Feenics.Keep.WebApi.Model.SmtpSettings, Feenics.Keep.WebApi.Model",
                       "SmtpHost":null,
                       "Port":0,
                       "SecureSocketOptions":0,
                       "Username":"USERNAME_HERE",
                       "Password":"PASSWORD_HERE",
                       "FromName":"SENDING_FROM_NAME",
                       "FromAddress":"SENDING_FROM_ADDRESS"
                   }'

Set Smtp To Aws Async

Example in C#

// Returns: nothing
await client.SetSmtpToAwsAsync();

Example in CURL



           curl -X PUT \
               https://api.us.acresecurity.cloud/api/smtpsettings/useaws  \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' \
               -H 'Content-Type: application/json' \
               -d '""'

Set Smtp To Local Async

Example in C#

// Returns: nothing
await client.SetSmtpToLocalAsync();

Example in CURL



           curl -X PUT \
               https://api.us.acresecurity.cloud/api/smtpsettings/uselocal  \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' \
               -H 'Content-Type: application/json' \
               -d '""'