Send Mail

API Type

REST

HTTP Method

POST

Description

Sends an email through AgilePoint Server.

Good to Know

  • If the variables WorkItemID and ProcesInstanceID are not provided, process attributes (custom attributes) are not resolved.

URL Format (OnPremises, PrivateCloud)

https://[domain]:[port]/AgilePointServer/Workflow/SendMail

URL Format (OnDemand)

https://[domain]:[port]/AgilePointService/Workflow/SendMail

Request Parameters

Name Description
None Not Applicable

Request Body Properties

Name Description

Attachments
Function:
File attachments included with the email.
Type
string
Accepted Values:
A valid path and file name on the AgilePoint Server.

This parameter must use a file path from the file system (for example, C:\file.txt) on the machine where AgilePoint Server is installed.

If there is no attachment, you can pass null or String.Empty.

Body
Function:
Specifies the body portion of an email.
Type
string
Accepted Values:
Free text.

CC
Function:
Specifies the CC portion of an email.
Type
string
Accepted Values:
A string that includes one or more email addresses in SMTP format.

From
Function:
Specifies the From portion of an email.
Type
string
Accepted Values:
A string that includes one or more email addresses in SMTP format.

Subject
Function:
The subject of an email.
Type
string
Accepted Values:
One line of text that can have spaces.

To
Function:
Specifies the To portion of an email.
Type
string
Accepted Values:
A string that includes one or more email addresses in SMTP format.

MailPriority
Function:
The email's priority.
Type
enum
Accepted Values:
  • high
  • normal
  • low

These properties are based on the class SendMailHelper

JavaScript Code Example

$("#btnSendMail").click(function () {

  var JSONObject = { To: "susan.miller@mydomain.com",
    CC: null, 
    From: "susan.miller@mydomain.com",
    Subject: "REST Test App",
    Body: "REST Test App Body",
    Attachments: null,
    MailPriority: "low"
  };
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Workflow/SendMail",
    dataType: "text",
    data: JSON.stringify(JSONObject)
  });

});

Java Code Example

public String SendMail() {

  String URI = "https://mydomain:9011/AgilePointServer/Workflow/SendMail";

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

  JSONObject postData = new JSONObject();
  
    postData.put("To", "susan.miller@mydomain.com");
    postData.put("CC", "");
    postData.put("From", "susan.miller@mydomain.com");
    postData.put("Subject", "REST Test App");
    postData.put("Body", "Body of mail");
    postData.put("Attachments", "");
    postData.put("MailPriority","low");

    return ops.POSTMethod(URI, postData.toString());
  return "";
}

C# Code Example

public string SendMail()
  {
    string URI = "https://mydomain:9011/AgilePointServer/Workflow/SendMail";

    string jsonRequestdata = "{
      \"To\":\"" + "milindg90@ymail.com" + "\",
      \"CC\":\"" + null + "\",
      \"From\":\"" + "milind.gunjan@agilepoint.com" + "\",
      \"Subject\":\"" + "milindg90" + "\",
      \"Body\":\"" + "com" + "\",
      \"Attachments\":\"" + null + "\"}";
      \"MailPriority\":\"" + low + "\"}";

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

    return ops.POSTMethod(URI, "");
  }

cURL Code Example

Note: The authorization code is an example. You must generate your own authorization code in base64 encoded format with the syntax Domain\Username:Password. 
curl --header "Content-Type: application/json" 
                         --header "Authorization:Basic QVAtNDI0XEFkbWluOnBhc3M=" 
                         --request POST 
                         --data {\"To\":\"susan.miller@mydomain.com\",
                         \"CC\":\"null\",
                         \"From\":\"susan.miller@mydomain.com\",
                         \"Subject\":\"REST Test App\",
                         \"Body\":\"REST Test App Body\"}
                         \"MailPriority\":\"low\"}
                         https://mydomain:9011/AgilePointServer/Workflow/SendMail

Output

None.

JSON Response Body Example

{
  "Attachments":"String content",
  "Body":"String content",
  "CC":"String content",
  "From":"String content",
  "Subject":"String content",
  "To":"String content",
  "MailPriority":"String content"
}

Supported Versions

AgilePoint v5.0 R2 and higher

Code Examples in the AgilePoint NX Documentation

The AgilePoint NX Product Documentation is intended as a basic reference to help you understand how to complete basic coding tasks, such as make API or JavaScript method calls. Code examples that show specific use cases, the solutions to specific business problems, or detailed implementation scenarios are outside the scope of the AgilePoint NX Product Documentation. For specific and/or advanced types of examples that may better meet your requirements, AgilePoint provides several resources:

  • AgilePoint Community Forums - A free, AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
  • Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
  • Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.