Skip to main content

 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.

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

Parameters

NameDescriptionRequiredTypeDefault value
contentThe XML content to transformyesxml
nameThe name of the email template to useyesstring
clear-cacheIf true, the XSLT templates cache is clearednobooleanfalse
defaultIf the template should be loaded from the current group’s style or the default stylenobooleanfalse
subjectThe subject of the email if not specified in the XSLT templatenostringPageSeeder Email

Permission

This server requires administrator.

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