REST Resource: users.settings.filters

Ressource: Filter

Ressourcendefinition für Gmail-Filter. Filter werden auf bestimmte Nachrichten angewendet, nicht auf eine gesamte E-Mail-Konversation.

JSON-Darstellung 
{
  "id": string,
  "criteria": {
    object (Criteria)
  },
  "action": {
    object (Action)
  }
}
Felder
id

string

Die vom Server zugewiesene ID des Filters.
criteria

object (Criteria)

Übereinstimmungskriterien für den Filter.
action

object (Action)

Aktion, die der Filter ausführt.

Kriterien

Nachrichtenabgleichskriterien

JSON-Darstellung 
{
  "from": string,
  "to": string,
  "subject": string,
  "query": string,
  "negatedQuery": string,
  "hasAttachment": boolean,
  "excludeChats": boolean,
  "size": integer,
  "sizeComparison": enum (SizeComparison)
}
Felder
from

string

Der Anzeigename oder die E-Mail-Adresse des Absenders.
to

string

Der Anzeigename oder die E-Mail-Adresse des Empfängers. Enthält Empfänger in den Kopfzeilenfeldern „An“, „Cc“ und „Bcc“. Sie können einfach den lokalen Teil der E-Mail-Adresse verwenden. Beispiel: „beispiel“ und „beispiel@“ stimmen beide mit „beispiel@gmail.com“ überein. Bei diesem Feld wird nicht zwischen Groß- und Kleinschreibung unterschieden.
subject

string

Im Betreff der Nachricht wurde eine Wortgruppe gefunden, bei der die Groß- und Kleinschreibung nicht beachtet wird. Nachgestellte und vorangehende Leerzeichen werden abgeschnitten und benachbarte Leerzeichen werden zusammengeführt.
query

string

Es werden nur Nachrichten zurückgegeben, die mit der angegebenen Abfrage übereinstimmen. Unterstützt dasselbe Abfrageformat wie das Gmail-Suchfeld. Beispiel: "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread".
negatedQuery

string

Es werden nur Nachrichten zurückgegeben, die nicht mit der angegebenen Abfrage übereinstimmen. Unterstützt dasselbe Abfrageformat wie das Gmail-Suchfeld. Beispiel: "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread".
hasAttachment

boolean

Gibt an, ob die Nachricht einen Anhang hat.
excludeChats

boolean

Ob die Antwort Chats ausschließen soll.
size

integer

Die Größe der gesamten RFC822-Nachricht in Byte, einschließlich aller Header und Anhänge.
sizeComparison

enum (SizeComparison)

Gibt an, wie die Nachrichtengröße in Byte im Verhältnis zum Feld „Größe“ sein sollte.

SizeComparison

Bestimmt, wie das Feld „Größe“ mit der Nachrichtengröße verglichen werden soll.

Enums
unspecified
smaller Nachrichten suchen, die kleiner als die angegebene Größe sind.
larger Nachrichten suchen, die größer als die angegebene Größe sind.

Aktion

Eine Reihe von Aktionen, die für eine Nachricht ausgeführt werden sollen.

JSON-Darstellung 
{
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ],
  "forward": string
}
Felder
addLabelIds[]

string

Liste der Labels, die der Nachricht hinzugefügt werden sollen.
removeLabelIds[]

string

Liste der Labels, die aus der Nachricht entfernt werden sollen.
forward

string

E-Mail-Adresse, an die die Nachricht weitergeleitet werden soll.

Methoden

create

 Erstellt einen Filter.

delete

 Löscht den angegebenen Filter sofort und endgültig.

get

 Ruft einen Filter ab.

list

 Listet die Nachrichtenfilter eines Gmail-Nutzers auf.