POST/users/{userId}/mail/filters

フィルタを登録する。
フィルタ条件に一致するメールが受信されると、既読または重要メールで表示したり、指定したメールフォルダに移動または他の宛先に転送できる。

  • 振り分けルール
    • パラメータのうち、1 つは必須で指定する。重複指定も可能
    • ただし、isReplyFromMe と isCalendarMail は同時に指定できない
  • 処理方法
    • isMoveFolder、isTreatForwardEmail、isHighlightColor、isRead、isImportant、isDelete の 6 つのパラメータのいずれか一つは必須で指定する
    • isMoveFolder を指定した場合、folderId は必須入力パラメータ
    • useForwardEmail を指定した場合、forwardEmail は必須入力パラメータ
    • ishighlightColor を指定した場合、highlightColor は必須入力パラメータ
    • isDelete を指定した場合、他の処理方法はすべて無視される

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

mail

HTTP Request

POSThttps://www.worksapis.com/v1.0/users/{userId}/mail/filters

Path Parameters

ParameterTypeDescription
userId string 

ユーザーを特定する ID (URL エンコードする)

  • ユーザー ID (userId)
  • ログイン ID (email)
  • 自身 ("me")

required
example : me 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required
example : application/json 

Request Body

PropertyTypeDescription
from string 

From メールアドレス (振り分けルール)


minLength : 1 
toCc string 

To または Cc メールアドレス (振り分けルール)


minLength : 1 
to string 

To メールアドレス (振り分けルール)


minLength : 1 
cc string 

Cc メールアドレス (振り分けルール)


minLength : 1 
subject string 

件名 (振り分けルール)


minLength : 2
maxLength : 180 
body string 

本文 (振り分けルール)


minLength : 2 
hasAttach boolean 

添付ファイルありフラグ (振り分けルール)


default : false 
isReplyFromMe boolean 

自分が送信したメールへの送信フラグ (振り分けルール)


default : false 
isCalendarMail boolean 

カレンダー予定メールフラグ (振り分けルール)


default : false 
folderId integer 

メールフォルダ ID (処理方法)


minimum : 0
format : int32 
highlightColor string 

強調色の RGB 値 (処理方法)


minLength : 1 
useForwardEmail boolean 

転送の可否 (処理方法)


default : false 
forwardEmail string 

転送するメールの受信メール (処理方法)


format : email 
isMoveFolder boolean 

メールフォルダに移動フラグ (処理方法)


default : false 
isRead boolean 

既読表示フラグ (処理方法)


default : false 
isColor boolean 

強調色フラグ (処理方法)


default : false 
isImportant boolean 

重要表示フラグ (処理方法)


default : false 
isDelete boolean 

削除 (ゴミ箱に移動) フラグ (処理方法)


default : false 
isApplyExistingMails boolean 

既存メールにも適用フラグ (処理方法)


default : false 

Request Example

example

1{2  "from": "sender@example.com",3  "toCc": "tocc@example.com",4  "to": "to@example.com",5  "cc": "cc@example.com",6  "subject": "subjectstring",7  "body": "bodystring",8  "hasAttach": false,9  "isReplyFromMe": false,10  "isCalendarMail": false,11  "folderId": 0,12  "useForwardEmail": true,13  "forwardEmail": "forward@example.com",14  "isMoveFolder": false,15  "isread": false,16  "isColor": true,17  "highlightColor": "#e8f8fd",18  "isImportant": false,19  "isDelete": false,20  "isApplyExistingMails": false21}

Response

HTTP 201

Created

HTTP 400

Bad Request

HTTP 500

Internal Server Error