GET/users/{userId}/mail/filters/{filterId}

メールフィルタの設定を取得する。

Authorization

oauth2

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

Scope

mail
mail.read

HTTP Request

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

Path Parameters

ParameterTypeDescription
userId string 

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

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

required
example : me 
filterId string 

フィルター ID


required
example : 1 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
filter object (filter) 

フィルター情報


required 

filter

PropertyTypeDescription
filterId integer 

フィルター ID


required
format : int64 
folderId integer 

メールフォルダ ID


format : int32 
from string 

送信者メール

 
toCc string 

宛先または参照メール

 
to string 

宛先メール

 
cc string 

参照メール

 
subject string 

件名

 
body string 

メール本文

 
hasAttach boolean 

添付ファイルありフラグ


default : false 
highlightColor string 

強調色の RGB 値


minLength : 0 
isForwardEmail boolean 

メール転送フラグ


default : false 
isMoveFolder boolean 

メールフォルダに移動フラグ


default : false 
isRead boolean 

既読表示フラグ


default : false 
isColor boolean 

色の強調フラグ


default : false 
isReplyFromMe boolean 

自分が送信したメールへの返信フラグ


default : false 
isCalendarMail boolean 

カレンダー予定メールフラグ


default : false 
isImportant boolean 

重要表示フラグ


default : false 
isDelete boolean 

削除 (ゴミ箱に移動) フラグ


default : false 
isApplyExistingMails boolean 

既存のメールにも適用フラグ


default : false 

Response Example

example

1{2  "filter": {3    "filterId": 0,4    "folderId": 0,5    "from": "admin@example.com",6    "toCc": "tocc@example.com",7    "to": "to@example.com",8    "cc": "cc@example.com",9    "subject": "SubjectString",10    "body": "bodyString",11    "hasAttach": false,12    "highlightColor": "#e8f8fd",13    "isForwardEmail": false,14    "isMoveFolder": false,15    "isRead": false,16    "isColor": true,17    "isReplyFromMe": false,18    "isCalendarMail": false,19    "isImportant": false,20    "isDelete": false,21    "isApplyExistingMails": false22  }23}

HTTP 400

Bad Request

HTTP 500

Internal Server Error