FlowMail
Manages the email and notification functionalities within the workflow.
Properties
| Name | Description |
|---|---|
| MessageOptions | Gets or sets the message options. |
| NotificationOptions | Gets or sets the push notification options. |
| Key | A unique identifier for the workflow step. |
| MailMessage | Gets the mail message associated with the message. |
| WorkflowCodeInstance | The workflow code instance associated with the flow object. |
| CachedDMObjects | The cached document management objects related to the flow object. |
| NotificationCaption | Gets the notification caption associated with the message. |
| NotificationMessage | Gets the notification message associated with the message. |
| IncludeFlowInitiator | Determines whether to include the workflow initiator in the mail group. |
| IsCustomMailMessage | Gets or sets a value indicating whether the mail message is custom. |
| DepartmentBasedUserGroups | A list of department-based user groups included in the workflow mail group. |
| VariablePositions | A list of variable positions included in the workflow mail group. |
| MailSubject | Gets the mail subject associated with the message. |
| IncludeDocumentApproversOrRefusers | Specifies whether to include document approvers or refusers in the workflow mail group. |
| EnableSendMail | Gets or sets a value indicating whether sending mail is enabled. |
| TypeCode | The type code associated with the flow object. |
| Members | Defines the configuration for members in the workflow mail group. |
| Attachments | Gets the list of attachments associated with the message. |
| WebNotificationOptions | Gets or sets the web notification options. |
| TableObjects | A list of table objects associated with the workflow mail group. |
| Name | Name for the workflow step. |
| DetailObjects | A list of detail objects associated with the workflow mail group. |
| Users | A list of resolved users in the workflow mail group. |
| UserGroups | A list of user groups included in the workflow mail group. |
| Documents | A list of documents associated with the workflow mail group. |
| EnablePushNotification | Gets or sets a value indicating whether push notification is enabled. |
| CustomMailMessage | Gets the custom mail message associated with the message. |
| ShowInFlowHistory | Specifies whether this mail step should appear in the workflow history. |
| Caption | The caption dictionary representing localized captions for the flow object. |
| ConstantPositions | A list of constant positions included in the workflow mail group. |
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 |
|---|---|
| AddConstantPosition(id, code, description) | Adds a constant position to the workflow mail group with additional details. |
| AddConstantPosition(id) | Adds a constant position to the workflow mail group using its ID. |
| AddConstantUser(id) | Adds a constant user to the workflow mail group using their ID. |
| Initialize() | Initializes the workflow mail step with necessary configurations. |
| AddAttachment(value,type) | Adds an attachment to the mail message. |
| ClearMembers() | Clears all members, positions, and related settings from the workflow mail group. |
| RemoveDocument(flowDocument) | Removes a document from the workflow mail group. |
| RemovePosition(id) | Removes a constant position from the workflow mail group using its ID. |
| SendPushNotification(userInfo,requestItem) | Sends a push notification to a user. |
| SendInformationWebNotification(userInfo, requestItem) | Sends a web notification to inform the user about a process request. |
| RemoveUser(id) | Removes a user from the workflow mail group by their ID. |
| Send(userInfo, requestItem) | Sends an email to the specified user based on the process request. |
| AddDocument(flowDocument, viewName, viewId, panelSize) | Adds a document to the workflow mail group with specified view and display settings. |
| AddConstantUser(id, code, name) | Adds a constant user to the workflow mail group with additional details. |
| SendWebNotification(payloadType,userInfo,requestItem) | Sends a web notification to a user. |
Events
| Name | Description |
|---|---|
| OnBeforeExecution(sender, args) | Occurs before the execution of the workflow step. |
| OnAfterExecution(sender, args) | Occurs after the execution of the workflow step. |
Generic Types
| Name | Description |
|---|---|
| TProperties | Generic type of properties. |