preview mail
/members/{member}/groups/{group}/mail/preview [POST]
API Support | Available since | Last updated | Output |
---|---|---|---|
5.5003 | 5.5914 | xml |
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
Name | Description | Required | Type | Default |
---|---|---|---|---|
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
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.