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 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 service depends on the email recipients. Following are the values for the notify parameter and PageSeeder role required when accessing them:

  • recipients  admin-system (i.e. Administrator)
  • normal|announce  edit-xlinks (i.e. Contributor and above)
  • self  view-members (i.e. Reviewer and above)

Note

XSLT templates are cached internally, specifying clear-cache=true will clear the cache.

Parameters

NameDescriptionRequiredTypeDefault value
content the XML to be transformed into the body of the message yes xml
name the email template to use yes string
recipients if notify is set to recipients, a comma-separated list of email addresses must be included. maybe string
attachments comma-separated list of URLs to attach to message no string
notify who the message is being sent to [normal|announce|self|recipients] no enum normal
subject the message subject, if it is not specified in the XSLT template no string PageSeeder Email

Permission

Undocumented permissions requirements.

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