Send raw text email (POST /)
Sends email messages consisting of a message header and a body by specifying the raw text data.
Raw text messages need to comply with the relevant Internet email standards. If they do not, they cannot be sent.
The maximum size of the message is 2 MB. (Size of RawMessage.Data after base64 decoding)
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.
"SendRawEmail"
Data Type | Cardinality |
---|---|
String | 1..1 |
Version
API version.
"v1.0" (optional)
Data Type | Cardinality |
---|---|
String | 0..1 |
Destinations.member.N
List of email recipients.
If omitted, messages will be sent to the TO, CC, and BCC email addresses specified in the message header.
If specified, TO, CC, and BCC specified in the message header will be ignored and messages will only be sent to the email addresses specified in Destinations.
Specify N from 1 to 50.
Data Type | Cardinality |
---|---|
String | 0..n |
RawMessage.Data
Converted Base64 plain text data of the message to be sent.
- The message must be a header and a body separated by a blank line.
- All required header fields must be present.
- Each part of the multipart MIME message needs to be formatted appropriately.
Data Type | Cardinality |
---|---|
Blob | 1..1 |
Source
Email sender address.
If Source is specified, bounced emails and complaint emails will be sent to this address, and the Return-Path header in the message will be ignored.
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..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)
SendRawEmailResponse
Envelope of the response.
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
- | 1..1 | None | SendRawEmailResult ResponseMetadata |
SendRawEmailResult
Envelope of the result.
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
- | 1..1 | SendRawEmailResponse | 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=SendRawEmail
&RawMessage.Data=U3Viam...
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: 0ae83209-8dd0-4392-8b15-74c693c98aad
<?xml version="1.0" encoding="UTF-8"?>
<SendRawEmailResponse>
<SendRawEmailResult>
<MessageId>0000012d23161b-6d55-4355-981f-1f9e835008c0-000000</MessageId>
</SendRawEmailResult>
<ResponseMetadata>
<RequestId>0ae83209-8dd0-4392-8b15-74c693c98aad</RequestId>
</ResponseMetadata>
</SendRawEmailResponse>