Web service API

How to use PageSeeder's Web service API

send mail

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

com.pageseeder.mail.SendEmail

Description

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 destinations:

  • 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

Note

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.

 

Parameters

NameDescriptionRequiredTypeDefault value
contentThe XML to be transformed into the body of the message.yesxml
nameThe email template to use.yesstring
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 message.nostring
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 template.nostringPageSeeder Email
notify-asyncWhether emails should be sent asynchronously (for slow email servers).nobooleanfalse

Permission

Permissions requirements to be updated.

Response

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