Show email sending limits (POST /)
Shows the sending limits of emails for a user.
Request Headers
Refer to "Common API request headers".
Request Parameters
Action
Name of the API to run.
"GetSendQuota"
| 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.
- 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)
GetSendQuotaResponse
Envelope of the response.
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| - | 1..1 | None | GetSendQuotaResult ResponseMetadata |
GetSendQuotaResult
Envelope of the result.
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| - | 1..1 | GetSendQuotaResponse | SentLast24Hours Max24HourSend MaxSendRate |
SentLast24Hours
The number of emails the user sent in the past 24 hours.
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Double | 1..1 | GetSendQuotaResult | None |
Max24HourSend
The maximum number of emails the user is allowed to send in a 24-hour period.
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Double | 1..1 | GetSendQuotaResult | None |
MaxSendRate
The maximum number of emails the user is allowed to send per second.
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| Double | 1..1 | GetSendQuotaResult | None |
ResponseMetadata
Envelope of the metadata.
| Data Type | Cardinality | Parent Element | Child Element(s) |
|---|---|---|---|
| - | 1..1 | GetSendQuotaResponse | 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=GetSendQuota
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: d96bd874-9bf2-11e1-8ee7-c98a0037a2b6
<?xml version="1.0" encoding="UTF-8"?>
<GetSendQuotaResponse>
<GetSendQuotaResult>
<SentLast24Hours>127.0</SentLast24Hours>
<Max24HourSend>43200000.0</Max24HourSend>
<MaxSendRate>500.0</MaxSendRate>
</GetSendQuotaResult>
<ResponseMetadata>
<RequestId>d96bd874-9bf2-11e1-8ee7-c98a0037a2b6</RequestId>
</ResponseMetadata>
</GetSendQuotaResponse>