FlowMail

Manages the email and notification functionalities within the workflow.

Properties

Name	Description
UserGroups	A list of user groups included in the workflow mail group.
Caption	The caption dictionary representing localized captions for the flow object.
EnablePushNotification	Gets or sets a value indicating whether push notification is enabled.
ShowInFlowHistory	Specifies whether this mail step should appear in the workflow history.
DetailObjects	A list of detail objects associated with the workflow mail group.
NotificationMessage	Gets the notification message associated with the message.
MailSubject	Gets the mail subject associated with the message.
DepartmentBasedUserGroups	A list of department-based user groups included in the workflow mail group.
Key	A unique identifier for the workflow step.
Name	Name for the workflow step.
EnableSendMail	Gets or sets a value indicating whether sending mail is enabled.
TableObjects	A list of table objects associated with the workflow mail group.
MailMessage	Gets the mail message associated with the message.
VariablePositions	A list of variable positions included in the workflow mail group.
ConstantPositions	A list of constant positions included in the workflow mail group.
IsCustomMailMessage	Gets or sets a value indicating whether the mail message is custom.
CustomMailMessage	Gets the custom mail message associated with the message.
MessageOptions	Gets or sets the message options.
WorkflowCodeInstance	The workflow code instance associated with the flow object.
Documents	A list of documents associated with the workflow mail group.
CachedDMObjects	The cached document management objects related to the flow object.
WebNotificationOptions	Gets or sets the web notification options.
IncludeFlowInitiator	Determines whether to include the workflow initiator in the mail group.
NotificationCaption	Gets the notification caption associated with the message.
Attachments	Gets the list of attachments associated with the message.
TypeCode	The type code associated with the flow object.
Users	A list of resolved users in the workflow mail group.
IncludeDocumentApproversOrRefusers	Specifies whether to include document approvers or refusers in the workflow mail group.
Members	Defines the configuration for members in the workflow mail group.
NotificationOptions	Gets or sets the push notification options.

Constructors

Name	Description
FlowMail(name, workflowData, workflowCodeInstance)	Constructor for the FlowMail class. Initializes a new instance of the FlowMail class.
FlowMail(name,workflowData,workflowCodeInstance)	Initializes a new instance of the FlowMail class.
FlowMail(name, workflowData, workflowCodeInstance)	Initializes a new instance of the FlowMail class.

Methods

Name	Description
Send(userInfo, requestItem)	Sends an email to the specified user based on the process request.
AddConstantPosition(id)	Adds a constant position to the workflow mail group using its ID.
ClearMembers()	Clears all members, positions, and related settings from the workflow mail group.
RemoveUser(id)	Removes a user from the workflow mail group by their ID.
SendInformationWebNotification(userInfo, requestItem)	Sends a web notification to inform the user about a process request.
SendWebNotification(payloadType,userInfo,requestItem)	Sends a web notification to a user.
RemovePosition(id)	Removes a constant position from the workflow mail group using its ID.
AddConstantUser(id)	Adds a constant user to the workflow mail group using their ID.
AddConstantPosition(id, code, description)	Adds a constant position to the workflow mail group with additional details.
Initialize()	Initializes the workflow mail step with necessary configurations.
RemoveDocument(flowDocument)	Removes a document from the workflow mail group.
AddDocument(flowDocument, viewName, viewId, panelSize)	Adds a document to the workflow mail group with specified view and display settings.
AddAttachment(value,type)	Adds an attachment to the mail message.
AddConstantUser(id, code, name)	Adds a constant user to the workflow mail group with additional details.
SendPushNotification(userInfo,requestItem)	Sends a push notification to a user.

Events

Name	Description
OnAfterExecution(sender, args)	Occurs after the execution of the workflow step.
OnBeforeExecution(sender, args)	Occurs before the execution of the workflow step.