Get SMTP Server

API Type

REST

HTTP Method

GET

Description

Retrieves the SMTP server of the current server configuration.

URL Format (On Premises)

https://[domain]:[port]/AgilePointServer/Admin/GetSmtpServer

URL Format (AgilePoint for Azure)

https://[domain]:[port]/AgilePointService/Admin/GetSmtpServer

Request Parameters

Name	Description
None	Not Applicable

JavaScript Code Example

$("#btnGetSmtpServer").click(function () {
  
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Admin/GetSmtpServer",
    type: "GET"
  });
  
});

Java Code Example

public String GetSMTPServer() {

  String URI = "http://mydomain:9011/AgilePointServer/Admin/GetSMTPServer";

  HTTPOperations ops = new HTTPOperations(domain, this.userName,
                       password, appID, locale);

  return ops.GETMethod(URI);
}

C# Code Example

public string GetSmtpServer()
  {
    string URI = "http://mydomain:9011/AgilePointServer/Admin/GetSmtpServer";

    HTTPOperations ops = new HTTPOperations(domain, this.userName, 
                         password, appID, locale);

    return ops.GetData(URI);
  }

Output

A string that contains the name of the AgilePoint system's SMTP server.

JSON Response Body Example

{
  GetSmtpServerResult: "String content"
}

Supported Versions

AgilePoint BPMS v5.0 R2 and higher