Verify email address (POST /)
Registers an email address as a sender ID and verifies ownership of the email address.
A confirmation email separate from the response will be sent to the specified email address. Accessing the URL indicated in the email completes the verification procedure.
Once an email address is confirmed, emails can be sent from that address.
Request Headers
Refer to "Common API request headers".
Request Parameters
Action
Name of the API to run.
"VerifyEmailIdentity"
| Data Type | Cardinality |
|---|---|
| String | 1..1 |
Version
API version.
"v1.0" (optional)
| Data Type | Cardinality |
|---|---|
| String | 0..1 |
EmailAddress
Email address to be verified.
Up to 256 characters.
| Data Type | Cardinality |
|---|---|
| String | 1..1 |
Request Elements
n/a
HTTP status
Status
Returns the status of the request.
- 200:
- Normal completion
- 400:
- Request parameter error
- 401:
- Authentication error
- 403:
- Access denied
- 500:
- Internal error
| Data Type | Cardinality |
|---|---|
| Int | 1..1 |
Response elements (normal completion)
VerifyEmailIdentityResponse
Envelope of the response.
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| - | 1..1 | None | VerifyEmailIdentityResult ResponseMetadata |
VerifyEmailIdentityResult
Envelope of the result.
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| - | 1..1 | VerifyEmailIdentityResponse | None |
ResponseMetadata
Envelope of the metadata.
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| - | 1..1 | VerifyEmailIdentityResponse | 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=VerifyEmailIdentity
&EmailAddress=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: 65ce6f91-4e8d-44a1-b33e-5ba3de2f528b
<?xml version="1.0" encoding="UTF-8"?>
<VerifyEmailIdentityResponse>
<VerifyEmailIdentityResult/>
<ResponseMetadata>
<RequestId>65ce6f91-4e8d-44a1-b33e-5ba3de2f528b </RequestId>
</ResponseMetadata>
</VerifyEmailIdentityResponse>