Class: Google::Apis::GmailV1::FilterAction

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

A set of actions to perform on a message.

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) ⇒ FilterAction

Returns a new instance of FilterAction



184
185
186
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 184

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

Instance Attribute Details

#add_label_ids ⇒ Array<String>

List of labels to add to the message. Corresponds to the JSON property addLabelIds

Returns:

  • (Array<String>) 


172
173
174
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 172

def add_label_ids
  @add_label_ids
end

#forward ⇒ String

Email address that the message should be forwarded to. Corresponds to the JSON property forward

Returns:

  • (String) 


177
178
179
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 177

def forward
  @forward
end

#remove_label_ids ⇒ Array<String>

List of labels to remove from the message. Corresponds to the JSON property removeLabelIds

Returns:

  • (Array<String>) 


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

def remove_label_ids
  @remove_label_ids
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



189
190
191
192
193
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 189

def update!(**args)
  @add_label_ids = args[:add_label_ids] if args.key?(:add_label_ids)
  @forward = args[:forward] if args.key?(:forward)
  @remove_label_ids = args[:remove_label_ids] if args.key?(:remove_label_ids)
end