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

등록된 자동 분류를 조회한다.

Authorization

oauth2

OAuth 2.0 인증.
자세한 인증 방식은 인가·인증를 참고한다.

Scope

mail
mail.read

HTTP Request

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

Path Parameters

ParameterTypeDescription
userId string 

구성원 ID (URL인코딩하여 사용)

  • User ID
  • Login 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