GET/users/{userId}/mail/filters

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

Authorization

oauth2

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

Scope

mail
mail.read

HTTP Request

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

Path Parameters

ParameterTypeDescription
userId string 

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

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

다음 목록 조회 시 사용하는 값


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 

보낸사람 메일 주소(분류 기준)


minLength : 1 
toCc string 

받는사람 또는 참조 메일 주소(분류 기준)


minLength : 1 
to string 

받는사람 메일 주소(분류 기준)


minLength : 1 
cc string 

참조 메일 주소(분류 기준)


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}