History class

This is the full description of the History class.

class google_workspace.gmail.histories.History

A record of a change to the user’s mailbox with one message.

Parameters
  • gmail_client (GmailClient) – The gmail_client.

  • history_data (dict) – The history data.

  • history_type (str) – The history type. Can have one of the following values: "messageAdded", "messageDeleted", "labelAdded", "labelRemoved".

  • message_format (str, optional) – The format to download the message as. This only has an effect before you first access the message attribute. Can have one of the following values: "minimal", "full", "raw", "metadata". Defaults to “raw”.

gmail_client

The gmail_client.

history_data

The history data.

history_type

A string of the histroy_type.

message_format

A string of the message_format.

label_ids

The message’s label ids.

thread_id

The message’s thread id.

gmail_id

The message’s gmail id.

modified_labels

If the history_type is labelAdded or labelRemoved this will contain a list of the modified lables.

message_added

A boolean indicating of the history_type is messageAdded.

message_deleted

A boolean indicating of the history_type is messageDeleted.

label_added

A boolean indicating of the history_type is labelAdded.

label_removed

A boolean indicating of the history_type is labelRemoved.

message

The message its self. will be one of the message objects based on message_format.