Cancel Mail Deliverable

API Type

Web Services

Description

Cancels the failed mail deliverable record based on a given message identifier. Note that canceling the failed mail deliverable record prevents it from being recycled or present on a given interval by the AgilePoint engine.

Syntax

public virtual void CancelMailDeliverable(string mailID)

Parameters

Name	Description
mailID	Definition: Specifies the unique ID for an email notification. Type string Allowed Values: A valid email notification ID.

Output

None.

Example

IWFWorkflowService svc = GetWorkflowService();
string mailID = …

try
    {
    svc.CancelMailDeliverable(mailID);
    }

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

Supported Versions

3.2.0.4 and higher