Web service API

How to use PageSeeder's Web service API

send mail

/members/{member}/groups/{group}/mail/send [POST]



Send an email message.

Use XSLT and the specified template to transform the provided XML content into an email message.

Send the message to one of the following four destination:

  • normal – all members of the group according to their notification settings.
  • announce – send to all members of the group ignoring their notification settings.
  • self – send to member currently logged in.
  • recipients  send to the email addresses specified in the parameter recipients .

The default option is normal

The security required to access this generator depends on the from, template and notify parameters:

  • from=[anything]  Administrator
  • template=[not external] Administrator
  • notify=recipients Administrator
  • notify=normal|announce Contributor and above
  • notify=self Reviewer and above


If the template specified is "external", then the content parameter XML will be wrapped in a <notification> element which follows the same format as for the other templates and will include a <group> element.



NameDescriptionRequiredTypeDefault value
contentthe XML to be transformed into the body of the messageyesxml
namethe email template to useyesstring
recipientsif notify is set to recipients, a comma-separated list of email addresses must be included.maybestring
groupscomma-separated list of additional groups to send the email to (notify must be normal|announce)nostring
attachmentscomma-separated list of URLs to attach to messagenostring
notifywho the message is being sent to [normal|announce|self|recipients]noenumnormal
fromwho the email is from [member|group|pageseeder|system] (administrators and template='external' only)noenummember
subjectthe message subject, if it is not specified in the XSLT templatenostringPageSeeder Email
notify-async Whether to send emails asynchronously (for slow email servers). no boolean false


Undocumented permissions requirements.


The XML output has the following format:

<email-notification delayed="[true|false]" />

Error Handling

No specific errors expected for this service.

Created on , last edited on