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
Field | Type | Inherited from | Description |
---|---|---|---|
FromAddress | String | SmtpSettings | Gets or sets the FromAddress value |
FromName | String | SmtpSettings | Gets or sets the FromName value |
Password | String | SmtpSettings | Gets or sets the Password value |
Port | Int32 | SmtpSettings | Gets or sets the Port value |
SecureSocketOptions | SecureSocketOptions | SmtpSettings | Gets or sets the SecureSocketOptions value |
SmtpHost | String | SmtpSettings | Gets or sets the SmtpHost value |
Username | String | SmtpSettings | Gets or sets the Username value |
{
"FromAddress" : "String",
"FromName" : "String",
"Password" : "String",
"Port" : "Int32",
"SecureSocketOptions" : "[SecureSocketOptions](/object-model/securesocketoptions)",
"SmtpHost" : "String",
"Username" : "String"
}
Example in C#
// Returns: SmtpSettings
var smtpSettings = await client.GetSmtpSettingsAsync();
Example in CURL
curl -X GET \
https://keepapi.feenicshosting.com/api/smtpsettings \
-H 'Authorization: Bearer TOKEN_GOES_HERE'
Example in C#
// Returns: nothing
await client.SetSmtpSettingsAsync(SmtpSettings settings);
Example in CURL
curl -X PUT \
https://keepapi.feenicshosting.com/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"
}'
Example in C#
// Returns: nothing
await client.SetSmtpToAwsAsync();
Example in CURL
curl -X PUT \
https://keepapi.feenicshosting.com/api/smtpsettings/useaws \
-H 'Authorization: Bearer TOKEN_GOES_HERE' \
-H 'Content-Type: application/json' \
-D '""'
Example in C#
// Returns: nothing
await client.SetSmtpToLocalAsync();
Example in CURL
curl -X PUT \
https://keepapi.feenicshosting.com/api/smtpsettings/uselocal \
-H 'Authorization: Bearer TOKEN_GOES_HERE' \
-H 'Content-Type: application/json' \
-D '""'