ConoHa API Documantation

メッセージ一覧取得 - Mail API v1.0

Description
メールボックス内のメッセージ一覧を取得する

Request URL

Mail API v1.0

GET /v1/emails/(uuid:email_id)/messages

Request Paramters

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

Response Paramters

Parameter Value Style Type Description
messages - - list -
message_id - plain UUID メッセージID
from - plain string 送信者
subject - plain string 件名
size - plain int メールサイズ
date - plain string メール受信日付
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/bb370c78b7a9d/messages
  • RES
HTTP/1.1 200 Success
Date: Tue, 09 Dec 2014 01:46:58 GMT
Server: Apache
Content-Length: 1003
Content-Type: application/json

{
  "messages": [
      {
          "message_id": "d059a9cefb0ae755794894ccc0c01551",
          "from": "mail@example.com",
          "subject": "subject1",
          "size": 510,
          "date": "2015-04-07T04:19:05Z"
      },
      {
          "message_id": "5297373a3542bbe3a231217fd8726bc4",
          "from": "mail@example.com",
          "subject": "subject2",
          "size": 456,
          "date": "2015-04-07T04:19:05Z"
      }
  ],
  "total_count":100,
  "current_count":10
}