Description
Create an email address.
Request URL
Mail API v1.0 POST /v1/emails
Request Paramters
| Parameter | Value | Style | Type | Description |
|---|---|---|---|---|
| X-Auth-Token | - | header | string | User Token |
| domain_id | - | plain | UUID | Domain ID |
| - | plain | string | Email Address | |
| password | - | plain | string | パスワード、文字種別:以下参照、文字長:9~70文字 |
※About Password
・A combination of capital letters, small letters and numbers are required
・The special letters allowed:!#$%&?“'=+-_{}[]^~:;().,/|\*@
Response Paramters
| Parameter | Value | Style | Type | Description |
|---|---|---|---|---|
| - | plain | dict | - | |
| domain_id | - | plain | UUID | Domain ID |
| email_id | - | plain | UUID | Email ID |
| - | plain | string | Mail Address The type of characters allowed for local part : [a-z, 0-9, -](Cannot begin or end with a hyphen. )The length of characters for local part : 2-63 | |
| virus_check | true | plain | string | true:virus check is enabled / false:virus check is disabled |
| spam_filter | true | plain | string | true:spam filter is enabled / false:spam filter is disabled |
| spam_filter_type | tray | plain | string | subject:give a subject to spam mail /tray:redirect spam mail to a spam folder |
| forwarding_copy | true | plain | string | true:leave a copy of a forwarded message in the mailbox /false:not leave a copy of a forwarded message in the mailbox |
| total_count | - | plain | int | Total Count |
| current_count | - | plain | int | Current Count |
Request Json
{
"domain_id": "(uuid:domain_id)",
"email": "test@example.com",
"password": "ZE!Zr0vKO"
}
Normal response codes
200 - Success
Error response codes
401 - Access Denied
409 - Duplicate
Repeatable
No
Example
curl -i -X POST \
-H "Accept: application/json" \
-H "X-Auth-Token: 39be9f8d53044388b7f2e867eba8b140" \
-d
'{
"domain_id": "1b508bb370c78b7a9d44",
"email": "test@example.com",
"password": "ZE!Zr0vKO"
}' \
https://mail-hosting.tyo1.cloud.z.com/v1/emails
HTTP/1.1 200 Success
Date: Tue, 09 Dec 2014 01:46:58 GMT
Server: Apache
Content-Length: 1003
Content-Type: application/json
{
"email":{
"domain_id": "1b508bb370c78b7a9d44",
"email_id": "a61f62728e50414998f0beb08e16a49a",
"email": "test@example.com",
"username": "paasmail_00000001",
"total_usage": 50,
"virus_check": true,
"spam_filter": true,
"spam_filter_type": "tray",
"forwarding_copy": true
}
}