View SMTP Mail Properties

Details

API Details
Name

View SMTP Mail Properties

Description

Displays configured SMTP mail properties if using SMTP authentication for the CCM VM to send emails.

MethodGET
URIv1/tenants/tenantId/mailproperties/smtp
CloudCenter Release
  • Introduced in CloudCenter 4.8.2
Notes
  • For additional context on <PORT> usage in the following example(s), see Base URI Format.
ESB Headeraction: create.tenants.tenantId.mailProperties.smtp

Example 1 – ROOT Admin

curl -k -X GET -H "Accept: application/json" -H "Content-Type: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/tenants/1/mailproperties/smtp"

Response

{
   "id":"3",
   "resource":"https://<HOST>:<PORT>/v1/tenants/1/mailproperties/smtp",
   "vendorId":1,
   "useParent":false,
   "smtps":true,
   "smtpHost":"smtp.gmail.com",
   "smtpPort":465,
   "smtpAuthUser":"guy@cliqr.com",
   "smtpPassword":"testpass",
   "copyToEmail":"qaadmin@cliqr.com",
   "mailFrom":"admin@cliqrtech.com",
   "mailFromUser":"Cliqr Admin",
   "mailProperties":[
      {
         "name":"mail.smtp.socketFactory.class",
         "value":"javax.net.ssl.SSLSocketFactory"
      },
      {
         "name":"mail.smtp.socketFactory.fallback",
         "value":"false"
      },
      {
         "name":"mail.smtp.auth",
         "value":"true"
      },
      {
         "name":"mail.smtp.socketFactory.port",
         "value":"465"
      }
   ]
}

Example 2 – Tenant Admin

curl -k -X GET -H "Accept: application/json" -H "Content-Type: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/tenantProperties/override/49"

Response

{
   "id":"49",
   "resource":"https://<ccm-ip>/tenantProperties/override/49",
   "propertyId":32,
   "vendorId":3,
   "propertyValue":"1"
}

Request Attributes

Required

Response Attributes