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

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

Overview

Message matching criteria.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ FilterCriteria

Returns a new instance of FilterCriteria.



431
432
433
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 431

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

Instance Attribute Details

#exclude_chats ⇒ Boolean Also known as: exclude_chats?

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

Returns:

  • (Boolean) 


378
379
380
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 378

def exclude_chats
  @exclude_chats
end

#from ⇒ String

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

Returns:

  • (String) 


384
385
386
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 384

def from
  @from
end

#has_attachment ⇒ Boolean Also known as: has_attachment?

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

Returns:

  • (Boolean) 


389
390
391
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 389

def has_attachment
  @has_attachment
end

#negated_query ⇒ String

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) 


397
398
399
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 397

def negated_query
  @negated_query
end

#query ⇒ String

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) 


404
405
406
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 404

def query
  @query
end

#size ⇒ Fixnum

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

Returns:

  • (Fixnum) 


410
411
412
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 410

def size
  @size
end

#size_comparison ⇒ String

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

Returns:

  • (String) 


415
416
417
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 415

def size_comparison
  @size_comparison
end

#subject ⇒ String

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) 


421
422
423
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 421

def subject
  @subject
end

#to ⇒ String

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) 


429
430
431
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 429

def to
  @to
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



436
437
438
439
440
441
442
443
444
445
446
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 436

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