ModelHooks module

SendMailAction

SendMailAction Entity

A model in the Hooks module, with 27 members for templates, 24 API properties and 35 members for admin templates.

View
What Smarty and Twig templates receive. Properties in REST API responses and job payloads. What admin screen templates receive when you override them.

Templates view

Properties 27

Take no arguments.

# getFrom()
?string
# getReplyTo()
?string
# getTo()
?string
# getCc()
?string
# getBcc()
?string
# getSubject()
?string
# getTemplate()
?string
# getTemplateCode()
?string
# getType()
string
Get the type of the action, which is the object name without namespace for the action
# getDisplayType()
string
Get Nice Name for Action Class
# getAvailablePreviousActions()
Collection
Get the available previous actions
# getId()
?int
# getName()
?string
# getText()
?string
# getPosition()
?int
# getData()
?array
# getCreated()
?DateTime
# getModified()
?DateTime
# getHook()
?Hook
Get the Hook this Action is assigned to
# getParent()
?BaseAction
# getPublished()
?DateTime
# isPublished()
bool
# isContainedInLoop()
bool
Check whether the action is contained in a loop
# getContainingLoop()
?Loop
Get the loop this action is contained in
# isNewRecord() Not in API & Jobs
bool
Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs
bool
Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs
bool
Check whether a model is versioned

API & Jobs view

API & JobsEach property is a key in REST API responses and job payloads. Its name is the template getter without get, is or has. Methods that need arguments are not available here.

Properties 24

Read-only values on the record.

# from
?string
# replyTo
?string
# to
?string
# cc
?string
# bcc
?string
# subject
?string
# template
?string
# templateCode
?string
# type
string
Get the type of the action, which is the object name without namespace for the action
# displayType
string
Get Nice Name for Action Class
# availablePreviousActions
Collection
Get the available previous actions
# id
?int
# name
?string
# text
?string
# position
?int
# data
?array
# created
?DateTime
# modified
?DateTime
# hook
?Hook
Get the Hook this Action is assigned to
# parent
?BaseAction
# published
?DateTime
# published
bool
# containedInLoop
bool
Check whether the action is contained in a loop
# containingLoop
?Loop
Get the loop this action is contained in

Admin view

AdminAvailable in cdna-admin templates. Copy an admin template into your site repository to change how this record is edited.

Properties 35

Take no arguments.

# getFrom()
?string
# getReplyTo()
?string
# getTo()
?string
# getCc()
?string
# getBcc()
?string
# getSubject()
?string
# getTemplate()
?string
# getTemplateCode()
?string
# getType()
string
Get the type of the action, which is the object name without namespace for the action
# getDisplayType()
string
Get Nice Name for Action Class
# getAvailablePreviousActions()
Collection
Get the available previous actions
# getId()
?int
# getName()
?string
# getText()
?string
# getPosition()
?int
# getData()
?array
# getCreated()
?DateTime
# getModified()
?DateTime
# getHook()
?Hook
Get the Hook this Action is assigned to
# getParent()
?BaseAction
# getPublished()
?DateTime
# isPublished()
bool
# isContainedInLoop()
bool
Check whether the action is contained in a loop
# getContainingLoop()
?Loop
Get the loop this action is contained in
# isNewRecord() Not in API & Jobs
bool
Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs
bool
Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs
bool
Check whether a model is versioned
# getDisplayIcon() Admin only
string
Get the display icon to use when rendering the action
# getRunDataVariables() Admin only
array
Get the run data variables provided by this action
# getEditUrl() Admin only
?string
Get the url for editing the record.
# getMoveUrl() Admin only
?string
Get the url for moving the record.
# getDeleteUrl() Admin only
?string
Get the url for deleting the record.
# getAvailableTemplates() Admin only
array
Get a listing of all templates under templates/hooks
# getAvailableTemplateVariables() Admin only
array
Get the template variables available in this action