REST Resource: users.settings.filters

Ressource: Filter

Ressourcendefinition für Gmail-Filter. Filter gelten für bestimmte Nachrichten und nicht für eine ganze 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

Kriterien für die Nachrichtenübereinstimmung.

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

string

Anzeigename oder E-Mail-Adresse des Absenders
to

string

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

string

Im Betreff der Nachricht wurde eine Wortgruppe gefunden, bei der die Groß-/Kleinschreibung nicht berücksichtigt wird. Vorangestellte und nachgestellte Leerzeichen werden abgeschnitten und angrenzende Leerzeichen werden minimiert.
query

string

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

string

Gibt nur Nachrichten zurück, 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 enthält.
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 stehen sollte.

SizeComparison

Bestimmt, 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

 Der angegebene Filter wird sofort und endgültig gelöscht.

get

 Ruft einen Filter ab.

list

 Listet die Nachrichtenfilter eines Gmail-Nutzers auf.