Page last modified 15:04, 9 Apr 2009 by arnec
MindTouch Community Portal > MindTouch Community Portal > Documentation > DReAM > Services > EmailService
Table of contents
- 1. Overview
- 2. Data Types
- 3. Features
- 3.1. POST:message
- 3.1.1.1. Access: Internal
- 3.1.1.2. Request body
- 3.1.1.3. Response
- 3.1.1.4. Response body
- 3.2. PUT:configuration/{configuration}
- 3.2.1.1. Access: Internal
- 3.2.1.2. Request body
- 3.2.1.3. Response
- 3.2.1.4. Response body
- 3.3. DELETE:configuration/{configuration}
- 3.3.1.1. Access: Internal
- 3.3.1.2. Response
- 3.3.1.3. Response body
- 3.1. POST:message
Assembly: mindtouch.dream
Class: MindTouch.Dream.Services.EmailService
SID: sid://mindtouch.com/2009/01/dream/email
Overview
The Email Service is a simple interface for allowing other services to send smtp email.
| Verb:Suffix | Description |
| POST:message | Send an email message |
| PUT:configuration/{configuration} | Register custom smtp server configuration |
| DELETE:configuration/{configuration} | De-register custom smtp server configuration |
Data Types
Config
<smtp>
<!-- defaults to localhost -->
<smtp-host>...</smtp-host>
<!-- defaults to standard smtp for plain or ssl communiction -->
<smtp-port>...</smtp-port>
<!-- skips smtp authentication if either is missing -->
<smtp-auth-user>...</smtp-auth-user>
<smtp-auth-password>...</smtp-auth-password>
<!-- use ssl to talk to smtp server -->
<use-ssl>true|false</use-ssl>
</smtp>
<email configuration="{optional configuration key}">
<!-- an email document can optionally inject headers into the message to be sent -->
<headers>
<header>
<name>...</name>
<value>...</value>
</header>
...
</headers>
<subject>...</subject>
<from>...</from>
<!-- one or more recipient email addresses -->
<to>...</to>
...
<!-- there can be up to two bodies, one the for a plain text body and the other for an html body -->
<body html="(true|false)">
...
</body>
...
</email>
Features
POST:message
Send an email via the configured Smtp server
Access: Internal
Request body
The body is assumed to be an Xml document conforming to the above email specification
Response
| Response | Response Body | Description |
| Ok (200) | none | operation completed successfully and a new event was created |
| Bad Request (400) | none | request could not be completed, because of invalid data in the request |
| Unauthorized (401) | none | request could not be completed, because of invalid or missing authorization headers |
Response body
None
PUT:configuration/{configuration}
Register custom smtp server configuration
Access: Internal
Request body
The body is assumed to be an Xml document conforming to the config specification
Response
| Response | Response Body | Description |
| Ok (200) | none | operation completed successfully and a new event was created |
| Bad Request (400) | none | request could not be completed, because of invalid data in the request |
| Unauthorized (401) | none | request could not be completed, because of invalid or missing authorization headers |
Response body
None
DELETE:configuration/{configuration}
De-register custom smtp server configuration
Access: Internal
Response
| Response | Response Body | Description |
| Ok (200) | none | operation completed successfully and a new event was created |
| Bad Request (400) | none | request could not be completed, because of invalid data in the request |
| Unauthorized (401) | none | request could not be completed, because of invalid or missing authorization headers |
Response body
None
- Was this page helpful?
- Tag page
- What links here
| Images 0 | ||
|---|---|---|
| No images to display in the gallery. |
You must login to post a comment.
Copyright © 2011 MindTouch, Inc. Powered by