Class: Google::Apis::GmailV1::Filter

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

Resource definition for Gmail filters. Filters apply to specific messages instead of an entire email thread.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Filter

Returns a new instance of Filter.



181
182
183
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 181

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

Instance Attribute Details

#action ⇒ Google::Apis::GmailV1::FilterAction

A set of actions to perform on a message. Corresponds to the JSON property action

Returns:



169
170
171
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 169

def action
  @action
end

#criteria ⇒ Google::Apis::GmailV1::FilterCriteria

Message matching criteria. Corresponds to the JSON property criteria

Returns:



174
175
176
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 174

def criteria
  @criteria
end

#id ⇒ String

The server assigned ID of the filter. Corresponds to the JSON property id

Returns:

  • (String) 


179
180
181
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 179

def id
  @id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



186
187
188
189
190
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 186

def update!(**args)
  @action = args[:action] if args.key?(:action)
  @criteria = args[:criteria] if args.key?(:criteria)
  @id = args[:id] if args.key?(:id)
end