Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
absoluteUrltrue
excludeOverview
typeflat
separatorpipe

Overview

Excerpt
hiddentrue

Send an email

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 {a trigger } macromacro.

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) See below.

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

Filter by label (Content by label)
showLabelsfalse
max6
showSpacefalse
sorttitle
cqllabel = "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?

  • text/html – force HTML format

  • text/plain – force plain text format

Filter by label (Content by label)
showLabelsfalse
max6
showSpacefalse
sorttitle
cqllabel = "macro-send-email" and label = "parameter-mimetype" and label = "example" and space = currentSpace ( )

subject

Email subject:

Filter by label (Content by label)
showLabelsfalse
max6
showSpacefalse
sorttitle
cqllabel = "macro-send-email" and label = "parameter-subject" and label = "example" and space = currentSpace ( )

user

(info) See below.

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@

watchers to email everyone watching the page or blog post associated with the workflow.

Filter by label (Content by label)
showLabelsfalse
max6
showSpacefalse
sorttitle
cqllabel = "macro-send-email" and label = "parameter-user" and label = "example" and space = currentSpace ( )

(info) 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
languagetextthemeRDark
{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@watchers|subject=Document Published}
          @page@ was published! See what's new!
      {send-email}
   	{trigger}
{workflow}

...

Related examples

Filter by label (Content by label)
showLabelsfalse
max100
showSpacefalse
sorttitle
excerptTypesimple
cqllabel = "macro-send-email" and label = "example" and space = currentSpace ( )

See also

Workflow Authoring Guide: