Gerenciamento de filtros

Use Filtros para configurar regras de filtragem avançadas para uma conta. Os filtros podem adicionar ou remover marcadores automaticamente ou encaminhar e-mails para aliases verificados com base nos atributos ou no conteúdo da mensagem recebida.

Para informações sobre como criar, listar, receber ou excluir filtros, consulte a referência de filtros.

Critérios de correspondência

É possível filtrar mensagens por propriedades como remetente, data do assunto, tamanho e conteúdo. Qualquer consulta que use a sintaxe de pesquisa avançada do Gmail também pode ser usada em um filtro. Por exemplo, padrões de filtro comuns incluem:

Filtro	Correspondências
criteria.from='[e-mail]'	Todos os e-mails de [e-mail]
criteria.size=10485760 criteria.sizeComparison='larger'	Todos os e-mails com mais de 10 MB
criteria.hasAttachment=true	Todos os e-mails com anexos
criteria.subject='[People with Pets]'	Todos os e-mails com a string [People with Pets] no assunto
criteria.query='"my important project"'	Todos os e-mails que contêm a string my important project
criteria.negatedQuery='"secret knock"'	Todos os e-mails que não contêm a string secret knock

Se um filtro tiver vários critérios, uma mensagem precisará atender a todos eles para que o filtro seja aplicado.

Ações

É possível aplicar uma ação a mensagens que correspondem aos critérios do filtro. As mensagens podem ser encaminhadas para um endereço de e-mail verificado ou ter marcadores adicionados ou removidos.

Você pode adicionar ou remover marcadores para mudar a disposição do e-mail. Por exemplo, algumas ações comuns incluem:

Ação	Efeito
action.removeLabelIds=['INBOX']	Arquivar o e-mail (ignorar a caixa de entrada)
action.removeLabelIds=['UNREAD']	Marcar como lida
action.removeLabelIds=['SPAM']	Nunca marcar como spam
action.removeLabelIds=['IMPORTANT']	Nunca marcar como importante
action.addLabelIds=['IMPORTANT']	Marcar como importante
action.addLabelIds=['TRASH']	Excluir o e-mail
action.addLabelIds=['STARRED']	Marcar como com estrela
action.addLabelIds=['<user label id>']	Adicione uma tag ao e-mail com um marcador definido pelo usuário. Apenas um rótulo definido pelo usuário é permitido por filtro.

Exemplos

Confira um exemplo mais completo de como rotular e arquivar mensagens de uma lista de e-mails.

Java

gmail/snippets/src/main/java/CreateFilter.java

Ver no GitHub

import com.google.api.client.googleapis.json.GoogleJsonError;
import com.google.api.client.googleapis.json.GoogleJsonResponseException;
import com.google.api.client.http.HttpRequestInitializer;
import com.google.api.client.http.javanet.NetHttpTransport;
import com.google.api.client.json.gson.GsonFactory;
import com.google.api.services.gmail.Gmail;
import com.google.api.services.gmail.GmailScopes;
import com.google.api.services.gmail.model.Filter;
import com.google.api.services.gmail.model.FilterAction;
import com.google.api.services.gmail.model.FilterCriteria;
import com.google.auth.http.HttpCredentialsAdapter;
import com.google.auth.oauth2.GoogleCredentials;
import java.io.IOException;
import java.util.Arrays;

/* Class to demonstrate the use of Gmail Create Filter API */
public class CreateFilter {
  /**
   * Create a new filter.
   *
   * @param labelId - ID of the user label to add
   * @return the created filter id, {@code null} otherwise.
   * @throws IOException - if service account credentials file not found.
   */
  public static String createNewFilter(String labelId) throws IOException {
        /* Load pre-authorized user credentials from the environment.
           TODO(developer) - See https://developers.google.com/identity for
            guides on implementing OAuth2 for your application. */
    GoogleCredentials credentials = GoogleCredentials.getApplicationDefault()
        .createScoped(GmailScopes.GMAIL_SETTINGS_BASIC,
            GmailScopes.GMAIL_LABELS);
    HttpRequestInitializer requestInitializer = new HttpCredentialsAdapter(credentials);

    // Create the gmail API client
    Gmail service = new Gmail.Builder(new NetHttpTransport(),
        GsonFactory.getDefaultInstance(),
        requestInitializer)
        .setApplicationName("Gmail samples")
        .build();

    try {
      // Filter the mail from sender and archive them(skip the inbox)
      Filter filter = new Filter()
          .setCriteria(new FilterCriteria()
              .setFrom("[e-mail]"))
          .setAction(new FilterAction()
              .setAddLabelIds(Arrays.asList(labelId))
              .setRemoveLabelIds(Arrays.asList("INBOX")));

      Filter result = service.users().settings().filters().create("me", filter).execute();
      // Prints the new created filter ID
      System.out.println("Created filter " + result.getId());
      return result.getId();
    } catch (GoogleJsonResponseException e) {
      // TODO(developer) - handle error appropriately
      GoogleJsonError error = e.getDetails();
      if (error.getCode() == 403) {
        System.err.println("Unable to create filter: " + e.getDetails());
      } else {
        throw e;
      }
    }
    return null;
  }
}

Python

gmail/snippet/settings snippets/create_filter.py

Ver no GitHub

import google.auth
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError


def create_filter():
  """Create a filter.
  Returns: Draft object, including filter id.

  Load pre-authorized user credentials from the environment.
  TODO(developer) - See https://developers.google.com/identity
  for guides on implementing OAuth2 for the application.
  """
  creds, _ = google.auth.default()

  try:
    # create gmail api client
    service = build("gmail", "v1", credentials=creds)

    label_name = "IMPORTANT"
    filter_content = {
        "criteria": {"from": "[e-mail]"},
        "action": {
            "addLabelIds": [label_name],
            "removeLabelIds": ["INBOX"],
        },
    }

    # pylint: disable=E1101
    result = (
        service.users()
        .settings()
        .filters()
        .create(userId="me", body=filter_content)
        .execute()
    )
    print(f'Created filter with id: {result.get("id")}')

  except HttpError as error:
    print(f"An error occurred: {error}")
    result = None

  return result.get("id")


if __name__ == "__main__":
  create_filter()