フィルタ追加

    フィルタを追加して、条件に応じたメールのフォルダ振り分けや重要表示などを行います。

    API の種類

    サービス API

    Request URL

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

    HTTP Method

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

    Request

    振り分けルール

    振り分けルールのいずれか1つは必須です。
    複数のルールを組み合わせることもできますが、isReplyFromMe と isCalendarMail を同時に指定することはできません。

    パラメータ タイプ 必須 説明
    fromText String N 送信元
    toCcText String N 宛先、またはCC
    toText String N 宛先
    ccText String N CC
    subjectText String N メールの件名
    bodyText String N メールの本文
    isHasAttach Boolean N 添付ファイル有無
    ● true/false
    isReplyFromMe Boolean N 自分が送信したメールへの返信
    ● true/false
    isCalendarMail Boolean N カレンダー予定メール
    ● true/false
    処理方法

    tMoveFolder、isTreatForwardEmail、tHighlightColor、tToRead、tToImportant、isTreatToDelete のうちいずれか 1 つは必須です。

    • tMoveFolder を指定した場合、folderSN は必須パラメータです。
    • isTreatForwardEmailを指定した場合、forwardEmail は必須パラメータです。
    • tHighlightColorを指定した場合、highlightColor は必須パラメータです。
    • isTreatToDeleteを指定した場合、他の処理方法はすべて無視されます。
    パラメータ タイプ 必須 説明
    tMoveFolder String N フォルダに移動
    ● Y/N
    folderSN String N フォルダのシリアルナンバー
    1、2、3、13は使用不可
    isTreatForwardEmail Boolean N メールの転送
    ● true/false
    forwardEmail String N 転送先メールアドレス
    tHighlightColor String N 色の強調
    ● Y/N
    highlightColor String N 強調する色 (RGB値)
    tToRead String N 既読表示
    ● Y/N
    tToImportant String N 重要表示
    ● Y/N
    isTreatToDelete Boolean N 削除(ゴミ箱に移動)
    ● true/false
    既存のメールに分類基準適用の有無
    • 自分が作成したメールの返信、入力したメールアドレスに転送を選択した場合は設定した分類基準を既存のメールに適用できない。
    • 分類基準を適用する時間が長いので既存のメールの一部は分類されない場合がある。
    パラメータ タイプ 必須 説明
    isRetroactivity Boolean N 既存のメールにも適用
    ● true/false(既定値は false)

    Request Example

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

    Response

    呼び出しに成功すると HTTP Status コード 200 のみを返します。レスポンス内容は含みません。

    Error

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

    プロパティ タイプ 説明
    code String Error Code
    message String Error Message
    Http Status Error Code 説明
    400 INVALID_PARAMETER リクエスト値が不適切
    409 CONFLICT 同じフィルタが存在する
    500 SYSTEM_ERROR 内部サーバーエラー
    Error Example
    {
        "code": "CONFLICT",
        "domain": "mail",
        "message": "There is identical auto-sort list."
    }