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
contentThe XML content to transform.yesxml
nameThe name of the email template to use.yesstring
clear-cacheIf true, the XSLT templates cache is cleared.nobooleanfalse
defaultIf the template should be loaded from the current group's style or the default style.nobooleanfalse
subjectThe subject of the email if not specified in the XSLT template.nostringPageSeeder Email

Permission

Permissions requirements to be updated.

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