REST Resource: users.settings.filters

Recurso: Filter

Definição de recurso para filtros do Gmail. Os filtros são aplicados a mensagens específicas, e não a uma conversa por e-mail inteira.

Representação JSON 
{
  "id": string,
  "criteria": {
    object (Criteria)
  },
  "action": {
    object (Action)
  }
}
Campos
id

string

O ID do filtro atribuído pelo servidor.
criteria

object (Criteria)

Critérios de correspondência para o filtro.
action

object (Action)

Ação que o filtro executa.

Critérios

Critérios de correspondência de mensagens.

Representação JSON 
{
  "from": string,
  "to": string,
  "subject": string,
  "query": string,
  "negatedQuery": string,
  "hasAttachment": boolean,
  "excludeChats": boolean,
  "size": integer,
  "sizeComparison": enum (SizeComparison)
}
Campos
from

string

O nome de exibição ou endereço de e-mail do remetente.
to

string

O nome de exibição ou endereço de e-mail do destinatário. Inclui destinatários nos campos de cabeçalho "Para", "Cc" e "Cco". Você pode usar apenas a parte local do endereço de e-mail. Por exemplo, "example" e "example@" correspondem a "example@gmail.com". Esse campo não diferencia maiúsculas de minúsculas.
subject

string

Frase que não diferencia maiúsculas de minúsculas encontrada no assunto da mensagem. Os espaços em branco à esquerda e à direita são cortados, e os espaços adjacentes são recolhidos.
query

string

Retorna apenas mensagens que correspondem à consulta especificada. Aceita o mesmo formato de consulta da caixa de pesquisa no Gmail. Por exemplo, "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread".
negatedQuery

string

Retorna apenas mensagens que não correspondem à consulta especificada. Aceita o mesmo formato de consulta da caixa de pesquisa no Gmail. Por exemplo, "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread".
hasAttachment

boolean

Se a mensagem tem algum anexo.
excludeChats

boolean

Se a resposta deve excluir chats.
size

integer

O tamanho de toda a mensagem RFC822 em bytes, incluindo todos os cabeçalhos e anexos.
sizeComparison

enum (SizeComparison)

Como o tamanho da mensagem em bytes deve estar em relação ao campo de tamanho.

SizeComparison

Determina como o campo de tamanho deve ser comparado ao tamanho da mensagem.

Tipos enumerados
unspecified
smaller Encontre mensagens menores que o tamanho indicado.
larger Encontre mensagens maiores que o tamanho indicado.

Ação

Um conjunto de ações a serem realizadas em uma mensagem.

Representação JSON 
{
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ],
  "forward": string
}
Campos
addLabelIds[]

string

Lista de marcadores a serem adicionados à mensagem.
removeLabelIds[]

string

Lista de marcadores a serem removidos da mensagem.
forward

string

Endereço de e-mail para o qual a mensagem deve ser encaminhada. Isso redireciona a mensagem para o endereço especificado nesse campo, mantendo o remetente original no campo "De".

Métodos

create

 Cria um filtro.

delete

 Exclui imediatamente e permanentemente o filtro especificado.

get

 Recebe um filtro.

list

 Lista os filtros de mensagens de um usuário do Gmail.