Class: Google::Apis::GmailV1::FilterCriteria

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/gmail_v1/classes.rb,
generated/google/apis/gmail_v1/representations.rb,
generated/google/apis/gmail_v1/representations.rb

Overview

Message matching criteria.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ FilterCriteria

Returns a new instance of FilterCriteria



256
257
258
# File 'generated/google/apis/gmail_v1/classes.rb', line 256

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#exclude_chatsBoolean Also known as: exclude_chats?

Whether the response should exclude chats. Corresponds to the JSON property excludeChats

Returns:

  • (Boolean)


203
204
205
# File 'generated/google/apis/gmail_v1/classes.rb', line 203

def exclude_chats
  @exclude_chats
end

#fromString

The sender's display name or email address. Corresponds to the JSON property from

Returns:

  • (String)


209
210
211
# File 'generated/google/apis/gmail_v1/classes.rb', line 209

def from
  @from
end

#has_attachmentBoolean Also known as: has_attachment?

Whether the message has any attachment. Corresponds to the JSON property hasAttachment

Returns:

  • (Boolean)


214
215
216
# File 'generated/google/apis/gmail_v1/classes.rb', line 214

def has_attachment
  @has_attachment
end

#negated_queryString

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". Corresponds to the JSON property negatedQuery

Returns:

  • (String)


222
223
224
# File 'generated/google/apis/gmail_v1/classes.rb', line 222

def negated_query
  @negated_query
end

#queryString

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". Corresponds to the JSON property query

Returns:

  • (String)


229
230
231
# File 'generated/google/apis/gmail_v1/classes.rb', line 229

def query
  @query
end

#sizeFixnum

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

Returns:

  • (Fixnum)


235
236
237
# File 'generated/google/apis/gmail_v1/classes.rb', line 235

def size
  @size
end

#size_comparisonString

How the message size in bytes should be in relation to the size field. Corresponds to the JSON property sizeComparison

Returns:

  • (String)


240
241
242
# File 'generated/google/apis/gmail_v1/classes.rb', line 240

def size_comparison
  @size_comparison
end

#subjectString

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

Returns:

  • (String)


246
247
248
# File 'generated/google/apis/gmail_v1/classes.rb', line 246

def subject
  @subject
end

#toString

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. Corresponds to the JSON property to

Returns:

  • (String)


254
255
256
# File 'generated/google/apis/gmail_v1/classes.rb', line 254

def to
  @to
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



261
262
263
264
265
266
267
268
269
270
271
# File 'generated/google/apis/gmail_v1/classes.rb', line 261

def update!(**args)
  @exclude_chats = args[:exclude_chats] if args.key?(:exclude_chats)
  @from = args[:from] if args.key?(:from)
  @has_attachment = args[:has_attachment] if args.key?(:has_attachment)
  @negated_query = args[:negated_query] if args.key?(:negated_query)
  @query = args[:query] if args.key?(:query)
  @size = args[:size] if args.key?(:size)
  @size_comparison = args[:size_comparison] if args.key?(:size_comparison)
  @subject = args[:subject] if args.key?(:subject)
  @to = args[:to] if args.key?(:to)
end