/api/space/smtp-management/smtp-servers/{id}

The following operation is supported on this resource:

  • GET - Get SMTP server by ID
GET /smtp-servers/{id} Version 1

Get SMTP server by ID.

Sample Usage

GET /smtp-servers/{id}


  • Parameters:
    Name Type URI Type Description Required
    id Integer Path SMTP server database id Y
  • Sample Output XML:
    <smtp-server href="/api/space/smtp-management/smtp-servers/{id}" uri="/api/space/smtp-management/smtp-servers/{id}">
         <id>Integer</id>
         <name>String</name>
         <ip-address>String</ip-address>
         <port>Integer</port>
         <use-tls>Boolean</use-tls>
         <security-setting>String</security-setting>
         <auth-password>String</auth-password>
         <host-address>String</host-address>
         <from-email-addr>String</from-email-addr>
         <domain-name>String</domain-name>
         <is-active>String</is-active>
         <use-ssl>Boolean</use-ssl>
         <auth-user>String</auth-user>
         <domain-id>Integer</domain-id>
         <user-auth>Boolean</user-auth>
         <active-server>Boolean</active-server>
    </smtp-server>

  • Sample Output JSON:
    {
       "smtp-server" : {
         "@href" : "/api/space/smtp-management/smtp-servers/{id}" ,
         "@uri" : "/api/space/smtp-management/smtp-servers/{id}" ,
         "id" : "Integer" ,
         "name" : "String" ,
         "ip-address" : "String" ,
         "port" : "Integer" ,
         "use-tls" : "Boolean" ,
         "security-setting" : "String" ,
         "auth-password" : "String" ,
         "host-address" : "String" ,
         "from-email-addr" : "String" ,
         "domain-name" : "String" ,
         "is-active" : "String" ,
         "use-ssl" : "Boolean" ,
         "auth-user" : "String" ,
         "domain-id" : "Integer" ,
         "user-auth" : "Boolean" ,
         "active-server" : "Boolean"
       }
    }

  • Access Control

    The following capabilities are required to access this API: ManageSmtpServers