REST Resource: users.settings.filters

리소스: Filter

Gmail 필터의 리소스 정의입니다. 필터는 전체 이메일 대화목록이 아닌 특정 메일에 적용됩니다.

JSON 표현
{
  "id": string,
  "criteria": {
    object (Criteria)
  },
  "action": {
    object (Action)
  }
}
필드
id

string

서버에서 할당된 필터 ID입니다.

criteria

object (Criteria)

필터의 일치 기준입니다.

action

object (Action)

필터가 수행하는 작업입니다.

기준

메시지 일치 기준입니다.

JSON 표현
{
  "from": string,
  "to": string,
  "subject": string,
  "query": string,
  "negatedQuery": string,
  "hasAttachment": boolean,
  "excludeChats": boolean,
  "size": integer,
  "sizeComparison": enum (SizeComparison)
}
필드
from

string

발신자의 표시 이름 또는 이메일 주소입니다.

to

string

수신자의 표시 이름 또는 이메일 주소입니다. '받는사람', '참조', '숨은참조'에 수신자 포함 헤더 필드를 포함합니다. 이메일 주소의 로컬 부분만 사용할 수 있습니다. 예: 'example' 및 'example@' 둘 다 'example@gmail.com'과 일치합니다. 이 필드는 대소문자를 구분하지 않습니다.

subject

string

메일 제목에서 대소문자를 구분하지 않는 구문입니다. 맨 앞과 맨 뒤에 오는 공백은 삭제되고 인접한 공백은 접힙니다.

query

string

지정된 쿼리와 일치하는 메시지만 반환합니다. Gmail 검색창과 동일한 쿼리 형식을 지원합니다. 예를 들면 "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread"입니다.

negatedQuery

string

지정된 쿼리와 일치하지 않는 메시지만 반환합니다. Gmail 검색창과 동일한 쿼리 형식을 지원합니다. 예를 들면 "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread"입니다.

hasAttachment

boolean

메일에 첨부파일이 있는지 여부입니다.

excludeChats

boolean

응답에서 채팅을 제외해야 하는지 여부입니다.

size

integer

모든 헤더와 첨부파일을 포함하여 전체 RFC822 메일의 크기(바이트)입니다.

sizeComparison

enum (SizeComparison)

크기 필드와 비교한 메시지 크기(바이트)입니다.

SizeComparison

크기 필드를 메일 크기와 비교하는 방법을 결정합니다.

열거형
unspecified
smaller 지정된 크기보다 작은 메시지를 찾습니다.
larger 지정된 크기보다 큰 메시지를 찾습니다.

작업

메시지에서 수행할 작업 집합입니다.

JSON 표현
{
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ],
  "forward": string
}
필드
addLabelIds[]

string

메일에 추가할 라벨 목록입니다.

removeLabelIds[]

string

메일에서 삭제할 라벨 목록입니다.

forward

string

메일을 전달해야 하는 이메일 주소입니다.

메서드

create

필터를 만듭니다.

delete

지정된 필터를 즉시 영구적으로 삭제합니다.

get

필터를 가져옵니다.

list

Gmail 사용자의 메일 필터를 나열합니다.