REST Resource: users.settings.filters

Ressource: Filter

Ressourcendefinition für Gmail-Filter. Filter werden auf bestimmte Nachrichten und nicht auf einen ganzen E-Mail-Thread angewendet.

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 durchführt.

Kriterien

Übereinstimmungskriterien für Nachrichten.

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

string

Den Anzeigenamen oder die E-Mail-Adresse des Absenders.
to

string

Den Anzeigenamen oder die E-Mail-Adresse des Empfängers. Umfasst Empfänger in den Feldern „An“, „Cc“ und „Bcc“ Header-Feldern. Sie können einfach den lokalen Teil der E-Mail-Adresse verwenden. Beispiel: „beispiel“ und "beispiel@" beide mit „beispiel@gmail.com“ übereinstimmen. Bei diesem Feld wird die Groß-/Kleinschreibung nicht berücksichtigt.
subject

string

Im Betreff der Nachricht wurde eine Wortgruppe ohne Berücksichtigung der Groß-/Kleinschreibung gefunden. Nachgestellte und vorangehende Leerzeichen werden abgeschnitten und angrenzende Leerzeichen werden minimiert.
query

string

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

string

Nur Nachrichten zurückgeben, die nicht mit der angegebenen Abfrage übereinstimmen Unterstützt dasselbe Anfrageformat 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

Gibt an, 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 Größenfeld sein sollte.

SizeComparison

Legt fest, wie das Größenfeld 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 sind als die angegebene Größe.

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.