...
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: |
Note: When using the send-email macro in a trigger initiated by an expiration event, page or space reference links (when the page title is set between [ ] to generate a link from it) are not supported. However regular links wiki markup, for example, [google|https://google.com] do work. |
| Info |
|---|
Complex wiki markup (eg. macros) may not degrade nicely to text/plain MIME type. |
|
address
|  See below.
| | A list of one or more email addresses to send the email to: | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 6 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| cql | label = "macro-send-email" and label = "parameter-address" and label = "example" and space = currentSpace ( ) |
|---|
|
|
mimetype
| | text/html
Or, if set, users' preferred format. | Which email format to send? | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 6 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| cql | label = "macro-send-email" and label = "parameter-mimetype" and label = "example" and space = currentSpace ( ) |
|---|
|
|
subject
| | | Email subject: | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 6 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| cql | label = "macro-send-email" and label = "parameter-subject" and label = "example" and space = currentSpace ( ) |
|---|
|
|
user
| See below. | | A list of one or more users to send the email to: Alternatively, set to watchers to email everyone watching the page or blog post associated with the workflow. | Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 6 |
|---|
| showSpace | false |
|---|
| sort | title |
|---|
| cql | label = "macro-send-email" and label = "parameter-user" and label = "example" and space = currentSpace ( ) |
|---|
|
|
|
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  Image Modified → 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 address parameter can only be sent to if they are associated with registered user accounts (those in the confluence-users user group). |
Example
| Code Block |
|---|
|
{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}
|
...