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:

Note: Complex wiki markup (eg. macros) may not degrade nicely to text/plain MIME type

address

(info)


A list of one or more email addresses to send the email to:

There is no content with the specified labels

mimetype


text/html

Or, if set, users' preferred format.

Which email format to send?

  • text/html – force HTML format
  • text/plain – force plain text format

subject



user

(info)


A list of one or more users to send the email to:

  • Comma-separated list which can contain:
    • Usernames
    • User groups
  • Supports Value References

Alternatively, set to @watchers@ to email everyone watching the page or blog post associated with the workflow.

(info) Either user or address parameter must be specified.

App configuration

SettingWhereNotes

From Address

From Name

The "From" email address and name are set in → General Configuration → Mail Servers.

Notification settingsWhen 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 AddressIf 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

{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}

All examples

See also

Workflow Authoring Guide: