IPage.SendWorkFlowNotificationMail Method

IPageSendWorkFlowNotificationMail Method

Ingeniux CMS Content Store API

Sends a workflow notification email to the given recipients.

Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 9.0.565.0 (9.0.565)

Syntax

void SendWorkFlowNotificationMail(
	IWorkflow workflow,
	ITransition transition,
	IUser assignToUser,
	string emailRecipients,
	string comment
)

Sub SendWorkFlowNotificationMail ( 
	workflow As IWorkflow,
	transition As ITransition,
	assignToUser As IUser,
	emailRecipients As String,
	comment As String
)

void SendWorkFlowNotificationMail(
	IWorkflow^ workflow, 
	ITransition^ transition, 
	IUser^ assignToUser, 
	String^ emailRecipients, 
	String^ comment
)

abstract SendWorkFlowNotificationMail : 
        workflow : IWorkflow * 
        transition : ITransition * 
        assignToUser : IUser * 
        emailRecipients : string * 
        comment : string -> unit

Parameters

workflow: Type: Ingeniux.CMSIWorkflow
The workflow this page is currently on
transition: Type: Ingeniux.CMSITransition
The transition to be used to advance the page in workflow
assignToUser: Type: Ingeniux.CMSIUser
The user this page will be assigend to after the given transition
emailRecipients: Type: SystemString
The email addresses of the recipients, delimited by semicolons.
comment: Type: SystemString
The comments user put in during workflow advancement

Remarks

The subject and body of workflow notification email are based on a predefined template located in the App_Data\xml\custom\emailNotifications folder.

The file name of the workflow notification email template is workflowNotifications.xml.

Modify this file to change the email content.

Examples

Workflow notification email template default content. Note that the names between two percent characters ("%")are variables; these are case-sensitive.

Copy

  <?xml version="1.0" encoding="utf-8" ?>
<EmailTemplate>
  <Subject>%siteName% - %workflowName% Notification - %pageName% - %pageId%</Subject>
  <Body>
    <p><strong>Workflow Notification</strong></p>
    <p><em><a href="mailto:%workingUserEmail%">%workingUserName%</a> </em>advanced the item <em><a href="%siteUrl%?ID=%pageId%">%pageName% (%pageId%)</a> </em>through the "<em>%transitionName%</em>" transition in the "<em>%workflowName%</em>" workflow, and assigned it to <em><a href="mailto:%nextUserEmail%">%nextUserName%</a></em></p>
    <p> </p>
    <p><strong>Comments from Assigning User:</strong>
    <br /><em>%comments%</em></p>
    <p> </p>
    <p><strong>View Item:</strong><br/><a href="%siteUrl%?ID=%pageId%">%siteUrl%?ID=%pageId%</a></p>
  </Body>
</EmailTemplate>

Reference

IPage Interface

Ingeniux.CMS Namespace

IPageSendGroupNotificationMail(IUserGroup, IUser, String, IWorkflow, ITransition)