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

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

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.



544
545
546
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 544

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

Instance Attribute Details

#id ⇒ Fixnum

The mailbox sequence ID. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


515
516
517
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 515

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:



520
521
522
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 520

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:



525
526
527
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 525

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:



532
533
534
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 532

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:



537
538
539
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 537

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:



542
543
544
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 542

def messages_deleted
  @messages_deleted
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



549
550
551
552
553
554
555
556
 
# File 'lib/google/apis/gmail_v1/classes.rb', line 549

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