Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Example - Get SMTP settings

Example of fetching current mail sender (SMTP) settings

Request Headers

KeyValueDescription
Acceptapplication/json

Response Headers

KeyValueDescription
Content-Typeapplication/json; charset=utf-8

Response Body

Code Block
languagenone
{
  "Enabled": true,
  "Type": "SMTP",
  "FromAddress": "noreply@corp.com",
  "EmailPrefix": "[ET]",
  "HostName": "smtp.corp.com",
  "Port": null,
  "Timeout": 10000,
  "SSL": true,
  "UserName": "etmail",
  "Password": "etpwd",
  "Self": "http://localhost/apimailsender/default/settings"
}

Status Code

200 - OK

PUT

...

Updates default mail sender settings

...

Example - Update SMTP settings

Example of updating smtp settings for application.

Request Headers

KeyValueDescription
Acceptapplication/json

Request Body

Code Block
languagenone
{
  "Enabled": true,
  "Type": "SMTP",
  "FromAddress": "noreply@corp.com",
  "EmailPrefix": "[ET]",
  "HostName": "smtp.corp.com",
  "Port": null,
  "Timeout": 10000,
  "SSL": true,
  "UserName": "etmail",
  "Password": "etpwd"
}

Response Headers

KeyValueDescription
Content-Typeapplication/json; charset=utf-8

Response Body

Code Block
languagenone
{
  "Enabled": true,
  "Type": "SMTP",
  "FromAddress": "noreply@corp.com",
  "EmailPrefix": "[ET]",
  "HostName": "smtp.corp.com",
  "Port": null,
  "Timeout": 10000,
  "SSL": true,
  "UserName": "etmail",
  "Password": "etpwd",
  "Self": "http://localhost/apimailsender/default/settings"
}

Status Code

200 - OK