特定期間のメール一括削除

    指定された期間内のメールを一括で削除します。

    ユーザーのメールボックスから、受信時刻 t が以下の条件を満たすメールを削除します。 送信済みメールのうち、送信確認フォルダに表示されるメールも削除されます。


    (startDate <= t < endDate)

    注意

    • バッチ処理となるため、リアルタイムでは削除されません。

    API の種類

    サーバー API

    Request

    Request URL

    • DELETE https://apis.worksmobile.com/r/{API_ID}/mail/works/deleteAllMailsByDay/v2

    HTTP Method

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

    Request Parameters

    パラメータ タイプ サイズ 必須 説明
    targetMemberEmail String Y 削除対象ユーザーのメールアドレス
    startDate String Y 削除対象期間の開始 (年月日時分秒)
    例) 20150101123000
    endDate String Y 削除対象期間の終了 (年月日時分秒)
    例) 20150202000000
    timeZone String N タイムゾーン(UTC)。「+, -」を付けてください。
    例) +0900

    Request Example

    https://apis.worksmobile.com/r/API_ID/mail/works/deleteAllMailsByDay/v2?targetMemberEmail=account1@example.com&startDate=20180213000000&endDate=20180214000000
    

    Response

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

    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": "Please check the date format(yyyyMMddHHmmss)",
        "domain": "mail"
    }