Create user for accessing SMTP server (POST /)
Creates a user for accessing the SMTP server.
Only one user can be created per contract.
Request Headers
Refer to "Common API request headers".
Request parameters
Action
Name of the API to run.
"CreateSMTPUser"
| Data Type | Cardinality |
|---|---|
| String | 1..1 |
Version
API version.
"v1.0" (optional)
| Data Type | Cardinality |
|---|---|
| String | 0..1 |
Request Elements
n/a
HTTP status
Status
Returns the status of the request.
One of the following values will be returned.
- 200:
- Normal completion
- 400:
- Request parameter error
- 401:
- Authentication error
- 403:
- Access denied
- 409:
- The SMTP user has already been created
- 500:
- Internal error
| Data Type | Cardinality |
|---|---|
| Int | 1..1 |
Response elements (normal completion)
CreateSMTPUserResponse
Envelope of the response.
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| - | 1..1 | None | CreateSMTPUserResult ResponseMetadata |
CreateSMTPUserResult
Envelope of the result.
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| - | 1..1 | CreateSMTPUserResponse | SMTPUser SMTPPassword |
SMTPUser
User for accessing the SMTP server.
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| xsd:string | 1..1 | CreateSMTPUserResult | None |
SMTPPassword
Password of the user for accessing the SMTP server.
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| xsd:string | 1..1 | CreateSMTPUserResult | None |
ResponseMetadata
Envelope of the metadata.
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| - | 1..1 | CreateSMTPUserResponse | 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=CreateSMTPUser
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"?>
<CreateSMTPUserResponse>
<CreateSMTPUserResult>
<SMTPUser>NKUIGMTPOU9PUZGKL1RW</SMTPUser>
<SMTPPassword>BiUIRJHe...</SMTPPassword>
</CreateSMTPUserResult>
<ResponseMetadata>
<RequestId>65ce6f91-4e8d-44a1-b33e-5ba3de2f528b </RequestId>
</ResponseMetadata>
</CreateSMTPUserResponse>