Conversation

Conversation

Members

folder :Folder

Type:

id :string

The unique identifier of the conversation.
Type:
  • string

isStarred :boolean

Type:
  • boolean

labels :Array.<Label>

Type:

subject :string

Type:
  • string

time :Date

Type:
  • Date

Methods

(async) addLabel(label) → {Boolean}

Tag the conversation with a label.
Parameters:
Name Type Description
label Label | string Label or a string of the label name.
Returns:
true
Type
Boolean

(async) delete() → {Boolean}

Permanently deletes the conversation and associated emails. It will be gone forever! It will NOT be in the trash!
Returns:
true
Type
Boolean

(async) getEmails() → {Array.<Email>}

Get the emails that belong to the conversation.
Returns:
Type
Array.<Email>

(async) move(folder) → {Boolean}

Move the conversation to a new folder.
Parameters:
Name Type Description
folder Folder
Returns:
true
Type
Boolean

(async) removeLabel(label) → {Boolean}

Untag the conversation.
Parameters:
Name Type Description
label Label | string Label or a string of the label name.
Returns:
true
Type
Boolean

(async) star() → {Boolean}

Star (favorite) the conversation.
Returns:
true
Type
Boolean

(async) unstar() → {Boolean}

Unstar (unfavorite) the conversation.
Returns:
true
Type
Boolean