Web service API

How to use PageSeeder's Web service API

preview mail

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

com.pageseeder.mail.PreviewEmail

Description

Preview an Email output

Transform the XML content provided using the XSLT from the template specified.

Note

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

Parameters

NameDescriptionRequiredTypeDefault value
content the XML content to transform yes xml
name the name of the email template to use yes string
clear-cache if true, the XSLT templates cache is cleared no boolean false
default If the template should be loaded from the current group's style or the default style no boolean false
subject The subject of the email if not specified in the XSLT template no string PageSeeder Email

Permission

Undocumented permissions requirements.

Response

The XML output has the following format:

<email-preview>
   <headers>
      <header name="Auto-Submitted"
              value="auto-generated" />
      <header name="Subject"
              value="[project-group] New comment created!" />
       ...
   </headers>
   <output format="html">
      [XHTML output]
   </output>
   <output format="text">
      [text output]
   </output>
</email-preview>

Error handling

No specific errors expected for this service.

Created on , last edited on