send mail
/members/{member}/groups/{group}/mail/send [POST]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 5.5003 | 5.9300 | xml |
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 destinations:
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 parameterrecipients.
The default option is normal.
external, then the content parameter XML is wrapped in a <notification> element which follows the same format as for the other templates and includes a <group> element.
Parameters
| Name | Description | Required | Type | Default |
|---|---|---|---|---|
| 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 | |
| groups | Comma-separated list of additional groups to send the email to (notify must be normal|announce) | no | 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 |
| from | Who the email is from [member|group|pageseeder|system] (administrators and template='external' only) | no | enum | member |
| subject | The message subject, if it is not specified in the XSLT template | no | string | PageSeeder Email |
| notify-async | Whether emails should be sent asynchronously (for slow email servers) | no | boolean | false |
Permission
The security required to access this service depends on the from, template and notify parameters:
from=[anything]– administratortemplate=[not external]– administratornotify=recipients– administratornotify=normal|announce– contributor and highernotify=self– reviewer and higher
Response
The XML output has the following format:
<email-notification delayed="[true|false]" />
Error Handling
No specific errors expected for this service.