ConoHa API Documantation

メールアドレス一覧取得 - Mail API v1.0

Description
メールアドレス一覧を取得します。

Request URL

Mail API v1.0

GET /v1/emails

Request Paramters

Parameter Value Style Type Description
X-Auth-Token - header string Userトークン
domain_id(Optional) - query UUID ドメインID
offset(Optional) - query int 取得開始位置、Default:0
limit(Optional) - query int 取得数、Default:1000
sort_key(Optional) create_date/email query string ソートキー、Default:create_date
sort_type(Optional) asc/desc query string ソート順、Default:asc

Response Paramters

Parameter Value Style Type Description
emails - - list -
domain_id - plain UUID ドメインID
email_id - plain UUID メールID
email - plain string メールアドレス
virus_check true/false plain string true:ウィルスチェック有効、false:ウィルスチェック無効
spam_filter true/false plain string true:迷惑メールフィルタ有効、false:迷惑メールフィルタ無効
spam_filter_type subject/tray plain string subject:スパムメールに件名を付与する、tray:スパムメールをスパムディレクトリに隔離する
forwarding_copy true/false plain string true:転送メールを受信トレイに残す、false:転送メールを受信トレイに残さない
dkim - plain string 設定済:TXTレコードを表示 未設定:空
total_count - plain int 全体件数
current_count - plain int 抽出件数

Request Json

This operation does not accept a request body.

Normal response codes

200 - Success

Error response codes

401 - Access Denied
404 - Not Found

Repeatable

Yes

Example
※エンドポイントURLにつきましては、お客様環境によって異なりますので、コントロールパネルにてご確認の上ご利用ください。

  • REQ
curl -i -X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-Auth-Token: 39be9f8d53044388b7f2e867eba8b140" \
https://mail-hosting.tyo1.conoha.io/v1/emails?domain_id=1b508bb370c78b7a9d44
  • RES
HTTP/1.1 200 Success
Date: Tue, 09 Dec 2014 01:46:58 GMT
Server: Apache
Content-Length: 1003
Content-Type: application/json

{
    "emails": [
        {
            "domain_id": "1b508bb370c78b7a9d44",
            "email_id": "a61f62728e50414998f0beb08e16a49a",
            "email": "test1@example.com",
            "username": "paasmail_00000001",
            "total_usage": 50,
            "virus_check": true,
            "spam_filter": true,
            "spam_filter_type": "subject",
            "forwarding_copy": true,
            "dkim": "v=DKIM1;k=rsa;p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDBtCHd4ahNrK/aL8rr0Mw4XvCaFGnegO2+MGU3GJZkdRoa1yIA6tD5WJo+F/nMPxi12tr/MemNgo4vf8PjSmGIzywz45u8IcwuofwLK8/+tCi/rXtQFo56wKe2n+yXZ6E1prRTvlpGCKEWM9PYSWyLd7PgaD9sPS6hA1vvIIXP1QIDAQAB"
        },
        {
            "domain_id": "1b508bb370c78b7a9d44",
            "email_id": "y96hwtq0l0ehvk973b80543np47z4e8ed",
            "email": "test2@example.com",
            "username": "paasmail_00000002",
            "total_usage": 50,
            "virus_check": true,
            "spam_filter": true,
            "spam_filter_type": "subject",
            "forwarding_copy": true,
            "dkim": ""
        }
    ],
    "total_count":100,
    "current_count":10
}