Class: Google::Apis::GmailV1::History

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 record of a change to the user's mailbox. Each history change may affect multiple messages in multiple ways.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ History

Returns a new instance of History.



365
366
367
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 365

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

Instance Attribute Details

#id ⇒ Fixnum

The mailbox sequence ID. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


336
337
338
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 336

def id
  @id
end

#labels_added ⇒ Array<Google::Apis::GmailV1::HistoryLabelAdded>

Labels added to messages in this history record. Corresponds to the JSON property labelsAdded

Returns:



341
342
343
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 341

def labels_added
  @labels_added
end

#labels_removed ⇒ Array<Google::Apis::GmailV1::HistoryLabelRemoved>

Labels removed from messages in this history record. Corresponds to the JSON property labelsRemoved

Returns:



346
347
348
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 346

def labels_removed
  @labels_removed
end

#messages ⇒ Array<Google::Apis::GmailV1::Message>

List of messages changed in this history record. The fields for specific change types, such as messagesAdded may duplicate messages in this field. We recommend using the specific change-type fields instead of this. Corresponds to the JSON property messages

Returns:



353
354
355
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 353

def messages
  @messages
end

#messages_added ⇒ Array<Google::Apis::GmailV1::HistoryMessageAdded>

Messages added to the mailbox in this history record. Corresponds to the JSON property messagesAdded

Returns:



358
359
360
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 358

def messages_added
  @messages_added
end

#messages_deleted ⇒ Array<Google::Apis::GmailV1::HistoryMessageDeleted>

Messages deleted (not Trashed) from the mailbox in this history record. Corresponds to the JSON property messagesDeleted

Returns:



363
364
365
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 363

def messages_deleted
  @messages_deleted
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



370
371
372
373
374
375
376
377
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 370

def update!(**args)
  @id = args[:id] if args.key?(:id)
  @labels_added = args[:labels_added] if args.key?(:labels_added)
  @labels_removed = args[:labels_removed] if args.key?(:labels_removed)
  @messages = args[:messages] if args.key?(:messages)
  @messages_added = args[:messages_added] if args.key?(:messages_added)
  @messages_deleted = args[:messages_deleted] if args.key?(:messages_deleted)
end