Send email created from input data (POST /)
Sends email messages created from input data.
The maximum size of the message is 2 MB. (Total of Message.Body.Text.Data and Message.Body.Html.Data)
The maximum number of email addresses including TO, CC and BCC per message is 50. Execute the API as many times as required to send the email to more email addresses.
Request Headers
Refer to "Common API request headers".
Request parameters
Action
Name of the API to run.
"SendEmail"
| Data Type | Cardinality |
|---|---|
| String | 1..1 |
Version
API version.
"v1.0" (optional)
| Data Type | Cardinality |
|---|---|
| String | 0..1 |
Destination.ToAddresses.member.N
Send to (To).
If the string contains non-ASCII characters, you must use the MIME format for encoding.
The format below will be used for the MIME format encoding.
=? charset?encoding?encodedText?=
Refer to RFC 2047 for details.
| Data Type | Cardinality |
|---|---|
| String | 0..n (Destination is a required item) |
Destination.CcAddresses.member.N
Send to (Cc).
If the string contains non-ASCII characters, you must use the MIME format for encoding.
The format below will be used for the MIME format encoding.
=? charset?encoding?encodedText?=
Refer to RFC 2047 for details.
| Data Type | Cardinality |
|---|---|
| String | 0..n (Destination is a required item) |
Destination.BccAddresses.member.N
Send to (Bcc).
If the string contains non-ASCII characters, you must use the MIME format for encoding.
The format below will be used for the MIME format encoding.
=? charset?encoding?encodedText?=
Refer to RFC 2047 for details.
| Data Type | Cardinality |
|---|---|
| String | 0..n (Destination is a required item) |
Message.Subject.Data
Email subject data.
| Data Type | Cardinality |
|---|---|
| String | 0..1 (Message is a required item) |
Message.Subject.Charset
Character encoding of the email subject.
| Data Type | Cardinality |
|---|---|
| String | 0..1 (Message is a required item) |
Message.Body.Text.Data
Text data of the email body.
| Data Type | Cardinality |
|---|---|
| String | 0..1 (Message is a required item) |
Message.Body.Text.Charset
Character encoding of the email body.
| Data Type | Cardinality |
|---|---|
| String | 0..1 (Message is a required item) |
Message.Body.Html.Data
HTML data of the email body.
| Data Type | Cardinality |
|---|---|
| String | 0..1 (Message is a required item) |
Message.Body.Html.Charset
HTML character encoding of the email body.
| Data Type | Cardinality |
|---|---|
| String | 0..1 (Message is a required item) |
ReplyToAddresses.member.N
Reply-to list.
If the recipient replies to the message, it will be sent to the reply-to address.
Specify N from 1 to 10.
| Data Type | Cardinality |
|---|---|
| String | 0..n |
ReturnPath
Address to forward a notification (bounced email) to when a message was not delivered.
| Data Type | Cardinality |
|---|---|
| String | 0..1 |
Source
Email sender address.
If the string contains non-ASCII characters, you must use the MIME format for encoding.
The format below will be used for the MIME format encoding.
=? charset?encoding?encodedText?=
Refer to RFC 2047 for details.
| Data Type | Cardinality |
|---|---|
| String | 1..1 |
Request Elements
n/a
HTTP status
Status
Returns the status of the request.
- 200:
- Normal completion
- 400:
- The message could not be sent due to request parameter error or failed action.
- 401:
- Authentication error
- 403:
- Access denied
- 500:
- Internal error
| Data Type | Cardinality |
|---|---|
| Int | 1..1 |
Response Elements (normal completion)
SendEmailResponse
Envelope of the response.
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| - | 1..1 | None | SendEmailResult ResponseMetadata |
SendEmailResult
Envelope of the result.
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| - | 1..1 | SendEmailResponse | MessageId |
MessageId
Message ID generated to uniquely identify the message.
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| xsd:string | 1..1 | SendEmailResult | None |
ResponseMetadata
Envelope of the metadata.
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| - | 1..1 | SendEmailResponse | RequestId |
RequestId
ID that uniquely identifies the request.
This is required when contacting support staff to troubleshoot an issue.
UUID format (example: 647cd254-e0d1-44a9-af61-1d6d86ea6b77)
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| xsd:string | 1..1 | ResponseMetadata | None |
Example of request
POST / HTTP/1.1
Date: Fri, 06 Jun 2014 11:00:37 AM GMT
Content-Length: ...
Host: mail.jp-east-1.tps5.fujitsu.com
Content-Type: application/x-www-form-urlencoded; charset=utf-8
X-Auth-Token: MIIFvgY...
Action=SendEmail
&Destination.ToAddresses.member.1=allan%40example.com
&Message.Body.Text.Data=body
&Message.Subject.Data=subject
&Source=user%40example.com
Example of response
HTTP/1.1 200 OK
Date: Fri, 06 Jun 2014 11:00:38 GMT
Content-Length: ...
Content-Type: application/xml
x-fj-request-id: baf96453-4867-4359-9cfc-5fee3afe7e98
<?xml version="1.0" encoding="UTF-8"?>
<SendEmailResponse>
<SendEmailResult>
<MessageId>000001fd985ba1-c92b-49ba-97ee-afcefdb6bab5-000000</MessageId>
</SendEmailResult>
<ResponseMetadata>
<RequestId>baf96453-4867-4359-9cfc-5fee3afe7e98</RequestId>
</ResponseMetadata>
</SendEmailResponse>