com.google.api.services.gmail.model

Class FilterCriteria

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.gmail.model.FilterCriteria

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class FilterCriteria
extends com.google.api.client.json.GenericJson

Message matching criteria.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Gmail API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
FilterCriteria()

Method Summary

Modifier and Type	Method and Description
FilterCriteria	clone()
Boolean	getExcludeChats() Whether the response should exclude chats.
String	getFrom() The sender's display name or email address.
Boolean	getHasAttachment() Whether the message has any attachment.
String	getNegatedQuery() Only return messages not matching the specified query.
String	getQuery() Only return messages matching the specified query.
Integer	getSize() The size of the entire RFC822 message in bytes, including all headers and attachments.
String	getSizeComparison() How the message size in bytes should be in relation to the size field.
String	getSubject() Case-insensitive phrase found in the message's subject.
String	getTo() The recipient's display name or email address.
FilterCriteria	set(String fieldName, Object value)
FilterCriteria	setExcludeChats(Boolean excludeChats) Whether the response should exclude chats.
FilterCriteria	setFrom(String from) The sender's display name or email address.
FilterCriteria	setHasAttachment(Boolean hasAttachment) Whether the message has any attachment.
FilterCriteria	setNegatedQuery(String negatedQuery) Only return messages not matching the specified query.
FilterCriteria	setQuery(String query) Only return messages matching the specified query.
FilterCriteria	setSize(Integer size) The size of the entire RFC822 message in bytes, including all headers and attachments.
FilterCriteria	setSizeComparison(String sizeComparison) How the message size in bytes should be in relation to the size field.
FilterCriteria	setSubject(String subject) Case-insensitive phrase found in the message's subject.
FilterCriteria	setTo(String to) The recipient's display name or email address.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

FilterCriteria

public FilterCriteria()

Method Detail

getExcludeChats

public Boolean getExcludeChats()

Whether the response should exclude chats.

Returns:

value or null for none

setExcludeChats

public FilterCriteria setExcludeChats(Boolean excludeChats)

Whether the response should exclude chats.

Parameters:

excludeChats - excludeChats or null for none

getFrom

public String getFrom()

The sender's display name or email address.

Returns:

value or null for none

setFrom

public FilterCriteria setFrom(String from)

The sender's display name or email address.

Parameters:

from - from or null for none

getHasAttachment

public Boolean getHasAttachment()

Whether the message has any attachment.

Returns:

value or null for none

setHasAttachment

public FilterCriteria setHasAttachment(Boolean hasAttachment)

Whether the message has any attachment.

Parameters:

hasAttachment - hasAttachment or null for none

getNegatedQuery

public String getNegatedQuery()

Only return messages not matching the specified query. Supports the same query format as the Gmail search box. For example, `"from:someuser@example.com rfc822msgid: is:unread"`.

Returns:

value or null for none

setNegatedQuery

public FilterCriteria setNegatedQuery(String negatedQuery)

Only return messages not matching the specified query. Supports the same query format as the Gmail search box. For example, `"from:someuser@example.com rfc822msgid: is:unread"`.

Parameters:

negatedQuery - negatedQuery or null for none

getQuery

public String getQuery()

Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, `"from:someuser@example.com rfc822msgid: is:unread"`.

Returns:

value or null for none

setQuery

public FilterCriteria setQuery(String query)

Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, `"from:someuser@example.com rfc822msgid: is:unread"`.

Parameters:

query - query or null for none

getSize

public Integer getSize()

The size of the entire RFC822 message in bytes, including all headers and attachments.

Returns:

value or null for none

setSize

public FilterCriteria setSize(Integer size)

The size of the entire RFC822 message in bytes, including all headers and attachments.

Parameters:

size - size or null for none

getSizeComparison

public String getSizeComparison()

How the message size in bytes should be in relation to the size field.

Returns:

value or null for none

setSizeComparison

public FilterCriteria setSizeComparison(String sizeComparison)

How the message size in bytes should be in relation to the size field.

Parameters:

sizeComparison - sizeComparison or null for none

getSubject

public String getSubject()

Case-insensitive phrase found in the message's subject. Trailing and leading whitespace are be trimmed and adjacent spaces are collapsed.

Returns:

value or null for none

setSubject

public FilterCriteria setSubject(String subject)

Case-insensitive phrase found in the message's subject. Trailing and leading whitespace are be trimmed and adjacent spaces are collapsed.

Parameters:

subject - subject or null for none

getTo

public String getTo()

The recipient's display name or email address. Includes recipients in the "to", "cc", and "bcc" header fields. You can use simply the local part of the email address. For example, "example" and "example@" both match "example@gmail.com". This field is case-insensitive.

Returns:

value or null for none

setTo

public FilterCriteria setTo(String to)

The recipient's display name or email address. Includes recipients in the "to", "cc", and "bcc" header fields. You can use simply the local part of the email address. For example, "example" and "example@" both match "example@gmail.com". This field is case-insensitive.

Parameters:

to - to or null for none

set

public FilterCriteria set(String fieldName,
                          Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public FilterCriteria clone()

Overrides:

clone in class com.google.api.client.json.GenericJson