REST Resources

/api/space/smtp-management/smtp-servers

The following operation is supported on this resource:

  • GET - Get all SMTP servers
GET /smtp-servers Version 1

Get all SMTP servers.

Sample Usage

GET /smtp-servers


  • Sample Output XML:
    <smtp-servers total="1" uri="/api/space/smtp-management/smtp-servers">
         <smtp-server href="/api/space/smtp-management/smtp-servers/819360" uri="/api/space/smtp-management/smtp-servers/819360">
               <id>819360</id>
               <name>Mail-Server</name>
               <ip-address>192.168.27.2</ip-address>
               <port>587</port>
               <is-active>Yes</is-active>
         </smtp-server>
    </smtp-servers>

  • Sample Output JSON:
    {
       "smtp-servers" : {
         "@total" : "1" ,
         "@uri" : "/api/space/smtp-management/smtp-servers" ,
         "smtp-server" : {
           "@href" : "/api/space/smtp-management/smtp-servers/819360" ,
           "@uri" : "/api/space/smtp-management/smtp-servers/819360" ,
           "id" : 819360 ,
           "name" : "Mail-Server" ,
           "ip-address" : "192.168.27.2" ,
           "port" : 587 ,
           "is-active" : "Yes"
         }
       }
    }

    • Access Control

    The following capabilities are required to access this API: ManageSmtpServers, CreateUser, ModifyUser