EmailAction Class

Class representing action to send e-mail

Inheritance Hierarchy

System.Object
  CMS.WorkflowEngine.BaseWorkflowAction<TreeNode, BaseInfo, WorkflowActionEnum>
    CMS.DocumentEngine.DocumentWorkflowAction
      CMS.DocumentEngine.EmailAction

Namespace: CMS.DocumentEngine
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 11.0.0

Syntax

public class EmailAction : DocumentWorkflowAction

The EmailAction type exposes the following members.

Constructors

	Name	Description
Public method	EmailAction

Properties

	Name	Description
Public property	ActionDefinition	Action definition. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public property	ActionStep	Current step. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public property	Arguments	Action arguments (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Protected property	BasedOnTemplate	Whether is e-mail based or template or not
Protected property	Body	E-mail body specifically defined for step.
Public property	Comment	Comment used when action moves to next step. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public property	InfoObject	Current info object. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public property	InitialStep	Current step. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public property	MacroResolver	Macro resolver for action. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public property	Manager	Manager. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Protected property	Node	Current document. (Inherited from DocumentWorkflowAction.)
Public property	OriginalStep	Current step. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public property	Parameters	Parameters of action. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Protected property	Recipients	Recipients of e-mail separated by ';' or ','.
Protected property	Sender	Sender of e-mail.
Public property	StateObject	Current state object. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Protected property	Subject	Subject specifically defined for step.
Protected property	TemplateName	Template of e-mail.
Public property	User	User running action. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public property	Workflow	Current workflow. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Protected property	WorkflowManager	Workflow manager (Inherited from DocumentWorkflowAction.)

Methods

	Name	Description
Public method	Execute	Executes action (Overrides BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.Execute().)
Protected method	GetDefaultMacroResolver	Prepares macro resolver for usage. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Protected method	GetResolvedParameter<ReturnType>	Gets resolved value of parameter. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public method	LogMessage	Logs message to event log. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public method	Process	Processes action. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Protected method	RefreshNode	Refreshes node instance (Inherited from DocumentWorkflowAction.)