Send Mail

API Type

Web Services

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.

Syntax

public virtual void SendMail(String To, String CC, String Subject, String Body)

Parameters

NameDescription

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.

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.

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

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

Output

None.

Example

//Sample for using Workflow.SendMail
IWFWorkflowService svc = GetWorkflowService();

try
	{               
    // email recipients
    string To = "bill@tusca.com";
    
    // CC
    string CC = "bob@tusca.com";
    
    //Subject of the Mail
    string Subject = "This is email Subject";
    
    //Body of the Mail
    string Body = "This email Body";
    svc.SendMail(To, CC, Subject, Body);
	}

catch (Exception ex)
	{
    Console.WriteLine("Failed! " + ShUtil.GetSoapMessage(ex));
	}

Supported Versions

3.2.0.4 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.