netexCloud - Web Services Api | Email configuration service

Get current configuration

Retrieves the currenct configuration

  • URL: /integration/ws/management/rest/emailServer
  • Method: GET
  • Headers:
    • Accept: version/format header
    • X-Cloud-Auth-Token*: authorization header
  • Responses:
    • 200: OK.
    • Body:
      • commonId: entity commonId.
      • extendedASCII: marked when the external server admit all the RFC email combinations.
      • externalId: extenral Id.
      • hostname: host of the email server.
      • id: internal id.
      • password: email server password.
      • port: email server port.
      • serverEnabled: if the param is marked as true, then we use the external email server, if not, we use netex email server .
      • username: email server username.
  • example URL: http://netex.local.cloud.me:8180/integration/ws/management/rest/emailServer
  • Response example:
Response
{
"commonId": "ae4024d91d2d41daa731042f8e8fe6f7",
"extendedASCII": false,
"externalId": null,
"hostname": null,
"id": "402881f2715a205101715a28c6740000",
"password": null,
"port": 25,
"serverEnabled": false,
"username": null
}


Update email server configuration

Updates the currenct configuration

  • URL: /integration/ws/management/rest/emailServer
  • Method: POST
  • Headers:
    • Accept: version/format header
    • X-Cloud-Auth-Token*: authorization header
  • Body:
    • commonId: entity commonId.
    • extendedASCII: marked when the external server admit all the RFC email combinations.
    • externalId: extenral Id.
    • hostname: host of the email server.
    • id: internal id.
    • password: email server password.
    • port: email server port.
    • serverEnabled: if the param is marked as true, then we use the external email server, if not, we use netex email server .
    • username: email server username.
  • Responses:
    • 200: OK.
    • Body:
      • commonId: entity commonId.
      • extendedASCII: marked when the external server admit all the RFC email combinations.
      • externalId: extenral Id.
      • hostname: host of the email server.
      • id: internal id.
      • password: email server password.
      • port: email server port.
      • serverEnabled: if the param is marked as true, then we use the external email server, if not, we use netex email server .
      • smtpAuth: indicates we use smtp protocol to connect with the email server.
      • username: email server username.
  • example URL: http://netex.local.cloud.me:8180/integration/ws/management/rest/emailServer
  • Response example:

response
expand source