メールフォルダ名取得

    指定したメールフォルダの名前を取得します。

    注意

    • 存在しない folderSN でリクエストした場合も成功 (200,folderName は空)で返されます。

    API の種類

    サービス API

    Request URL

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

    HTTP Method

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

    Request

    パラメータ タイプ 必須 説明
    folderSN String Y メールフォルダのシリアルナンバー

    Request Example

    https://apis.worksmobile.com/r/{API ID}/mail/v2/getFolder?folderSN=0
    

    Response

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

    プロパティ タイプ 必須 説明
    folderName String Y フォルダ名
    folderSN String Y フォルダのシリアルナンバー

    Response Example

    {"folderName":"受信フォルダ","folderSN":0}
    

    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 parameter, Please check folderSN",
        "domain": "mail"
    }