GET/users/{userId}/mail/filters

メールフィルタリストを取得する。

Authorization

oauth2

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

Scope

mail
mail.read

HTTP Request

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

Path Parameters

ParameterTypeDescription
userId string 

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

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

required
example : me 

Query Parameters

ParameterTypeDescription
query string 

検索キーワード


example : keyword 
count integer 

取得数


default : 30
minimum : 5
maximum : 200
example : 30
format : int32 
cursor string 

リストのカーソル値 (URL エンコードする)


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
filters array (AutomaticSort) 

メール自動振り分け情報


minItems : 0
uniqueItems : true 
responseMetaData object (responseMetaData) 

レスポンスのメタデータ

 

AutomaticSort

PropertyTypeDescription
filterId integer 

フィルター ID


minimum : 0
format : int64
readOnly : true 
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 

responseMetaData

PropertyTypeDescription
nextCursor string 

次のリスト取得時に使用するカーソル値

 

Response Example

example

1{2  "filters": [3    {4      "filterId": 529,5      "folderId": 0,6      "from": "admin@example.com",7      "toCc": "tocc@example.com",8      "to": "to@example.com",9      "cc": "cc@example.com",10      "subject": "subject",11      "body": "body",12      "hasAttach": false,13      "highlightColor": "#ffffff",14      "isForwardEmail": false,15      "isMoveFolder": false,16      "isRead": false,17      "isColor": false,18      "isReplyFromMe": false,19      "isCalendarMail": false,20      "isImportant": true,21      "isDelete": false,22      "isApplyExistingMails": false23    }24  ],25  "responseMetaData": {26    "nextCursor": "3"27  }28}