Update SMTP Mail Properties

Details

API Details
Name

Update SMTP Mail Properties

Description

Updates the previously set mail properties used by the CloudCenter platform.

MethodPUT
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: update.tenants.tenantId.mailproperties.smtp

Example

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

Request Body

{
   "id":"3",
   "resource":"https://test/v1/tenants/1/smtpconfig",
   "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"
      }
   ]
}

Response

{
   "id":"3",
   "resource":"https://test/v1/tenants/1/smtpconfig",
   "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"
      }
   ]
}

Request Attributes

tenantId
  • DescriptionUnique, system-generated identifier for the tenant organization. A tenant admin must belong to this tenant to invoke any APIs for this tenant. See the Tenant ID and Tenant Name Dependency section for the relevant release for additional context.

  • Type: String

Required

vendorID
  • Description: Unique, system-generated ID for  the tenant organization

  • Type: String

Required

useParent
  • Description: Identifies if this tenant should use the same configuration as its parent.
  • Type: Boolean
    • True = The tenant uses the same configuration as the parent tenant.
    • False = Default. The tenant configuration is not the same as the parent.

smtps
  • Description: Identifies if this tenant should use Simple Mail Transfer Protocol Secure (SMTPS) for electronic mail transmission.
  • Type: Boolean
    • True = Default. The tenant uses SMTPS.
    • False = The tenant does not use SMTPS.

smtpHost
  • Description: The DNS host name for the SMTP server.

  • Type: String

smtpPort
  • Description: The mail port to be used for the SMTP server. Defaults to Port 465.

  • Type: Integer

smtpAuthUser
  • Description: The email for the user who needs to be authenticated to the SMTP server.

  • Type: String

smtpPassword
  • Description: The password for the user who needs to be authenticated to the SMTP server.

  • Type: String

copyToEmail
  • Description: Identifies an additional email address if users need to send a copy of this email to an additional address. For example, if you want to avoid sending emails to real users from test systems when testing a production system, you can configure an test email address using this attribute.

  • Type: String

mailFrom
  • Description: The email address to use for the SMTP mail. This sets the envelope return address.

  • Type: String

mailFromUser
  • Description: The name of the user for the SMTP mailFrom attribute. This sets the name on the envelope return address.

  • Type: String

mailProperties
  • Description: Information about the mail properties.

  • Type: Array of name-value pairs

    name
    • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

    • Type: String

    value
    • Description: Indicates the set value for this property
    • Type: Float

Response Attributes

id
  • DescriptionUnique, system-generated identifier for this CloudCenter Resource.

  • Type: String

resource
  • Description: Unique URL to access this resource.
  • Type: String

vendorID
  • Description: Unique, system-generated ID for  the tenant organization

  • Type: String

useParent
  • Description: Identifies if this tenant should use the same configuration as its parent.
  • Type: Boolean
    • True = The tenant uses the same configuration as the parent tenant.
    • False = Default. The tenant configuration is not the same as the parent.

smtps
  • Description: Identifies if this tenant should use Simple Mail Transfer Protocol Secure (SMTPS) for electronic mail transmission.
  • Type: Boolean
    • True = Default. The tenant uses SMTPS.
    • False = The tenant does not use SMTPS.

smtpHost
  • Description: The DNS host name for the SMTP server.

  • Type: String

smtpPort
  • Description: The mail port to be used for the SMTP server. Defaults to Port 465.

  • Type: Integer

smtpAuthUser
  • Description: The email for the user who needs to be authenticated to the SMTP server.

  • Type: String

smtpPassword
  • Description: The password for the user who needs to be authenticated to the SMTP server.

  • Type: String

copyToEmail
  • Description: Identifies an additional email address if users need to send a copy of this email to an additional address. For example, if you want to avoid sending emails to real users from test systems when testing a production system, you can configure an test email address using this attribute.

  • Type: String

mailFrom
  • Description: The email address to use for the SMTP mail. This sets the envelope return address.

  • Type: String

mailFromUser
  • Description: The name of the user for the SMTP mailFrom attribute. This sets the name on the envelope return address.

  • Type: String

mailProperties
  • Description: Information about the mail properties.

  • Type: Array of name-value pairs

    name
    • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

    • Type: String

    value
    • Description: Indicates the set value for this property
    • Type: Float


© 2017-2019 Cisco Systems, Inc. All rights reserved