Gmail-Filter verwalten

In diesem Dokument wird erläutert, wie Sie Filter in der Gmail API verwenden.

Mit der Ressource settings.filters können Sie erweiterte Filterregeln für ein Konto konfigurieren. Mit Filtern können Labels automatisch hinzugefügt oder entfernt werden. Außerdem können E-Mails basierend auf den Attributen oder dem Inhalt der eingehenden Nachricht an bestätigte Aliase weitergeleitet werden.

Informationen zum Erstellen, Auflisten}, Abrufen oder Löschen von Gmail-Filtern finden Sie in der settings.filters-Ressource.

Übereinstimmungskriterien

Nachrichten nach Eigenschaften wie Absender, Betreff, Datum, Größe und Inhalt filtern. Filter werden nur auf bestimmte Nachrichten und nicht auf den gesamten E‑Mail-Verlauf angewendet. Jede Anfrage, die die erweiterte Suchsyntax von Gmail verwendet, kann auch in einem Filter verwendet werden. Hier einige Beispiele für gängige Filtermuster:

Filter Übereinstimmungen
criteria.from='sender@example.com' E‑Mails von sender@example.com
criteria.size=10485760
criteria.sizeComparison='larger'		 E-Mails, die größer als 10 MB sind
criteria.hasAttachment=true E‑Mails mit Anhang
criteria.subject='[People with Pets]' E‑Mails mit [People with Pets] im Betreff
criteria.query='"my important project"' E‑Mails mit my important project
criteria.negatedQuery='"secret knock"' E‑Mails, die nicht secret knock enthalten

Wenn ein Filter mehrere Kriterien enthält, muss eine Nachricht alle Kriterien erfüllen, damit der Filter angewendet wird.

Aktionen

Wenden Sie eine Action auf Nachrichten an, die den Filterkriterien entsprechen. Mit einem Action können Sie Nachrichten an eine bestätigte E‑Mail-Adresse weiterleiten oder Labels hinzufügen und entfernen.

Sie können Labels hinzufügen oder entfernen, um die Disposition der E‑Mail zu ändern. Einige gängige Aktionen sind beispielsweise:

Aktion Effekt
action.removeLabelIds=['INBOX'] E‑Mail archivieren (Posteingang überspringen)
action.removeLabelIds=['UNREAD'] Als gelesen markieren
action.removeLabelIds=['SPAM'] Nie als Spam markieren
action.removeLabelIds=['IMPORTANT'] Nie als wichtig markieren
action.addLabelIds=['IMPORTANT'] Als wichtig markieren
action.addLabelIds=['TRASH'] E-Mail löschen
action.addLabelIds=['STARRED'] Als „Markiert“ markieren
action.addLabelIds=['<user label id>'] Taggen Sie die E-Mail mit einem benutzerdefinierten Label. Pro Filter ist nur ein benutzerdefiniertes Label zulässig.

Codebeispiele

Die folgenden Codebeispiele zeigen, wie Sie Nachrichten aus einer Mailingliste kennzeichnen und archivieren:

Java

gmail/snippets/src/main/java/CreateFilter.java
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("gduser2@workspacesamples.dev"))
          .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
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": "gsuder1@workspacesamples.dev"},
        "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()