特定のメールフォルダでメールリスト照会

    特定のメールフォルダでメールリストを照会します。

    参考

    • メールリスト照会APIは、時間順表示のみ対応しています。

    APIの種類

    サービスAPI

    Request URL

    https://apis.worksmobile.com/r/{API ID}/mail/v2/getMailList

    HTTP Method

    GET(Content-Type: application/x-www-form-urlencoded; charset=UTF-8)

    Request

    パラメータ タイプ 必須 説明
    folderSN Integer N メールリストを照会するメールフォルダのシリアルナンバー。
    下記は、システムメールフォルダのシリアルナンバーと当該のメールフォルダです。
    ● -1: すべてのメール(既定値)
    ● 0: 受信フォルダ
    ● 1: 送信済みメール
    ● 2: 送信確認
    ● 3: 下書き
    ● 4: ゴミ箱
    ● 5: 迷惑メール
    ● 6: メモフォルダ
    シリアルナンバーが100以上の場合は、ユーザーの作成したメールフォルダ。
    page Integer N 照会するページの番号
    例) 1
    pageSize Integer N 1ページに含まれるメール数。
    この値がない場合、ユーザーの設定した値を使います。
    (環境設定 > メール > 基本設定 > メール確認/リスト表示 > 表示件数に設定されている値を使用)
    例) 30(既定値)
    type String N 照会するメールを指定。
    ● "all": すべてのメール (既定値)
    ● "mark": 重要なメール
    (isUnread=trueの場合、type=allとして処理されます。)
    ● "attach": 添付ファイルのあるメール
    (isUnread=trueの場合、type=allとして処理されます。)
    ● "tome": Toに自分が含まれているメール
    (isUnread=trueの場合、type=allとして処理されます。)
    sortField Integer N 整列基準
    ● 1: 日付(既定値)
    ● 3: 送信先
    ● 4: 宛先 (folderSN=-1の場合、使用不可。)
    ● 5: 件名
    ● 6: メールサイズ
    ● 8: 重要メール (必ずsortType=0に設定する必要があります。)
    ● 9: 添付ファイル (必ずsortType=0に設定する必要があります。)
    sortType Integer N 整列基準
    ● 0: 降順 (既定値)
    ● 1: 昇順
    isUnread Boolean N 未読メールのみ照会するかどうか
    ● true: 未読メールのみ照会
    ● false: すべてのメールを照会 (既定値)
    previewMode Integer N プレビュー情報を含むか
    ● 0: 無効(既定値)
    ● 1: メール本文プレビュー情報
    ● 2: メール本文プレビューの情報と添付ファイルの情報
    ● 3: 添付ファイル情報

    Request Example

    https://apis.worksmobile.com/r/{API ID}/mail/v2/getMailList?folderSN=0&isUnread=false
    

    Response

    API 呼び出しに成功すると HTTP Status コード 200 を返し、応答内容は JSON 形式で返します。

    プロパティ タイプ 必須 説明
    currentTime Long Y 現在時刻。UNIXタイムスタンプ形式で表示します。
    例) 1409208669
    lastPage Integer Y 最後のページ番号
    例) 3
    totalCount Integer Y 全体メール数
    例) 100
    listCount Integer Y 全体ページ数
    例) 3
    unreadCount Integer Y 未読メール数
    例) 10
    pageSize Integer Y 1ページに含まれるメール数
    例) 30
    folderName String Y メールフォルダ名
    例) 送信済みメール
    mailData List Y 照会するメールリスト情報
    mailData[].priority Integer Y メール作成時に重要メール選択をするかどうか(メールの件名に赤いエクスクラメーションマークを表示)
    ● 3: 重要メール
    ● 1: 一般メール
    mailData[].size Integer Y メールサイズ(単位: byte)
    例) 1024
    mailData[].threadCount String Y 会話型リストでやり取りしたメール数
    例) 0
    mailData[].threadId String Y スレッドメールのID
    例) a1903976041747540dbfc1dd0e99c86@example.com
    mailData[].status Integer Y メール状態
    ● 0: 未読メール
    ● 1: 既読メール
    ● 2: 未読の重要メール
    ● 3: 既読の重要メール
    mailData[].subject String Y 件名
    mailData[].mailSN Integer Y メールのシリアルナンバー
    例) 1234
    mailData[].mimeSN String Y MIMEシリアルナンバー
    例) 1408959094.599851.19650.619501
    mailData[].from Object Y 送信先リスト
    mailData[].from.name String Y 送信先の名前
    mailData[].from.email String Y 送信先のメールアドレス
    mailData[].toList List Y 宛先リスト
    mailData[].toList[].name String Y 受信者名
    mailData[].toList[].email String Y 宛先のメールアドレス
    mailData[].attachInfo List N プレビュー用の添付ファイル情報
    ● previewModeが2または3の場合にのみデータ有り
    mailData[].attachInfo[].contentSN Integer N 添付ファイルのシリアルナンバー
    mailData[].attachInfo[].filename String N 添付ファイル名
    mailData[].attachInfo[].contentSize Long N 添付ファイルサイズ(単位:byte)
    mailData[].attachInfo[].contentType String N 添付ファイルのcontentType
    mailData[].preview String N プレビュー用テキストbr>● previewModeが1または2の場合にのみデータ有り
    mailData[].receivedTime Long Y 受信時刻。UNIXタイムスタンプ形式で表示。
    例) 1408959094
    mailData[].attachCount Integer Y 添付ファイル数
    例) 1
    mailData[].folderSN Integer Y メールフォルダのシリアルナンバー
    例) 6
    mailData[].toMe Boolean Y Toに自分が含まれているかどうか。
    ● true: Toに含まれている。
    ● false: CCに含まれている。
    mailData[].securityLevel String Y メールのセキュリティレベル
    ● "SECRET": 機密
    ● "IN_HOUSE": 社外秘
    ● "NORMAL": 一般
    mailData[].sentTime Long Y メール送信時刻。 UNIXタイムスタンプ形式で表示。
    例) 1408959094
    mailData[].color String Y メールリストを照会するときに表示される背景色の値。
    例) #ffffff
    mailData[].reSend Boolean Y メール転送設定。
    ● true: 可
    ● false: 不可
    mailData[].spamType String Y 迷惑メール分類コード
    ● "SYSTEM_DEFINE": システム分類基準
    ● "USER_DEFINE": ユーザー分類基準
    ● "USER_REPORT": ユーザーが迷惑メール報告
    ● "USER_MOVE": ユーザーが迷惑メールフォルダへ移動
    mailData[].unreadThreadCount Integer Y 会話型リストで未読のスレッドメール数
    例) 0

    Response Example

    {
            "currentTime": 1409126091,
            "lastPage": 1,
            "mailData": [
                {
                    "priority": 3,
                    "size": 1042,
                    "threadCount": 0,
                    "threadId": "<a1903976041747540dbfc1dd0e99c86@example.com>",
                    "status": 5,
                    "subject": "こんにちは",
                    "mailSN": 5,
                    "mimeSN": "1408959094.599851.19650.619501",
                    "from": {
                        "name": "山田太郎",
                        "email": "user01@example.com"
                    },
                    "toList": [
                        {
                            "name": "",
                            "email": "user01@example.com"
                        }
                    ],
                    "attachInfo": [{
                "contentSN": 2,
                "filename": "giphy.gif",
                "contentOffset": 2095,
                "contentSize": 786174,
                "contentType": "image/gif",
                "decodedSize": 589630
            }],
                    "preview": " ",
                    "receivedTime": 1408959094,
                    "attachCount": 0,
                    "folderSN": 6,
                    "toMe": false,
                    "securityLevel": "NORMAL",
                    "sentTime": 1408959094,
                    "iconType": 0,
                    "color": "#ffffff",
                    "reSend": true,
                    "spamType": null,
                    "unreadThreadCount": 0
                },
                {
                    "priority": 3,
                    "size": 196331,
                    "threadCount": 0,
                    "threadId": "<14363dcad647f36b603771dc9ea88ad0@example.com>",
                    "status": 5,
                    "subject": "複雑なページの読み込み確認中...",
                    "mailSN": 2,
                    "mimeSN": "1408957487.49617.14930.64547",
                    "from": {
                        "name": "山田太郎",
                        "email": "user01@example.com"
                    },
                    "toList": [
                        {
                            "name": "",
                            "email": "user01@example.com"
                        }
                    ],
                    "attachInfo": [],
                    "preview": "",
                    "receivedTime": 1408957487,
                    "attachCount": 0,
                    "folderSN": 6,
                    "toMe": false,
                    "securityLevel": "NORMAL",
                    "sentTime": 1408957486,
                    "iconType": 0,
                    "color": "#ffffff",
                    "reSend": true,
                    "spamType": null,
                    "unreadThreadCount": 0
                },
                {
                    "priority": 3,
                    "size": 2079,
                    "threadCount": 0,
                    "threadId": "<67823c36f479f825abc761952852936@example.com>",
                    "status": 37,
                    "subject": "わたしが作成した開発メールです。",
                    "mailSN": 1,
                    "mimeSN": "1408951522.795266.30402.825668",
                    "from": {
                        "name": "山田太郎",
                        "email": "user01@example.com"
                    },
                    "toList": [
                        {
                            "name": "",
                            "email": "user01@example.com"
                        }
                    ],
                    "attachInfo": [],
                    "preview": "",
                    "receivedTime": 1408951522,
                    "attachCount": 0,
                    "folderSN": 101,
                    "toMe": false,
                    "securityLevel": "NORMAL",
                    "sentTime": 1408951522,
                    "iconType": 0,
                    "color": "#ffffff",
                    "reSend": true,
                    "spamType": null,
                    "unreadThreadCount": 0
                }
            ],
            "totalCount": 3,
            "listCount": 3,
            "unreadCount": 0,
            "pageSize": 30,
            "folderName": "すべてのメール "
    
    }
    

    Error

    呼び出しに失敗すると HTTP Status と以下のエラー情報を返します。

    プロパティ タイプ 説明
    code String Error Code
    message String Error Message
    HTTP Status Error Code 説明
    400 INVALID_PARAMETER パラメーターエラー
    500 SYSTEM_ERROR 内部サーバーエラー
    Error Example
    {
        "code": "INVALID_PARAMETER",
        "message": "Invalid request parameters",
        "domain": "mail"
    }