Get Mail Deliverables

API Type

Web Services

Description

Retrieves all the mail deliverables for a process instance.

Syntax

public virtual WFMailDeliverable[] GetMailDeliverables(string processInstanceID)

Parameters

Name	Description
processInstanceID	Definition: Specifies the unique ID of a process instance. Type string Allowed Values: A valid process instance ID

Output

Array of WFMailDeliverable objects.

Example

//Process Instance ID associated with the Process Instance.
IWFWorkflowService svc = GetWorkflowService();
string processInstanceID = …// for example, "1e3d514d43d3465cae6ec3bbbd409168";

try
	{
    WFMailDeliverable[]emailNotifications =
    svc.GetMailDeliverables(processInstanceID);
    foreach(WFMailDeliverable m in emailNotifications)
    	{
        Console.WriteLine("Mail ID: '{0}'", m.ID);
        Console.WriteLine("Process Instance ID: '{0}'", m.ProcInstID);
        Console.WriteLine("E-Mail Subject: '{0}'", m.Mail.Subject);
    	}
	}

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

Supported Versions

3.2.0.4 and higher