send-email macro
Overview
The send-email macro is used to send custom email notifications to one or more recipients.
Where to use it?
Optional.
One or more send-email macros can be put in a trigger macro.
Parameters
Parameter | Required | Default | Notes |
|---|---|---|---|
macro body |
|
| The body of the email:
When using the |
Complex wiki markup (eg. macros) may not degrade nicely to | |||
| See below. |
| A list of one or more email addresses to send the email to:
|
|
|
Or, if set, users' preferred format. | Which email format to send?
|
|
|
| Email subject:
|
| See below. |
| A list of one or more users to send the email to:
Alternatively, set to |
Either a user or an address parameter must be specified for the macro. | |||
App configuration
Setting | Where | Notes |
|---|---|---|
From Address From Name | The "From" email address and name are set in → General Configuration → Mail Servers. | |
Notification settings | When using custom emails, check to see if they are duplicating any of the in-built emails sent by the app - if so, you can disable them in the notification settings at either Space or Global level. | |
Email Any Address | If disabled, emails listed in the |
Example
{workflow}
{state:Test|approved=Published}
{approval:Review}
{state}
{state:Published}
{state}
{trigger:pageapproved|approval=Review|partial=true}
{send-email:user=@user@|subject=Document approved}
Thank you for approving @page@!
{send-email}
{trigger}
{trigger:statechanged|state=Published}
{send-email:user=watchers|subject=Document Published}
@page@ was published! See what's new!
{send-email}
{trigger}
{workflow}
Related examples
-
Adding page activity to email — Include page activity report, or a link to it, in custom email notifications
-