Skip to navigation

Get an email

Returns an incoming email by ID.

Arguments

idStringRequired
The ID of the incoming email to return.

Returns

an IncomingEmail
createdAtString
The email's creation date.
idString
The email's unique identifier.
incomingEmailAttachmentslist of IncomingEmailAttachments
The files attached to or embedded in the email.
incomingEmailContactslist of IncomingEmailContacts
The contacts linked to the email.
incomingEmailMatterslist of IncomingEmailMatters
The links between the email and its matters, including unconfirmed suggestions.
incomingEmailUserslist of IncomingEmailUsers
The sender and recipient addresses on the email.
taggingslist of Taggings
The tags applied to the email.
updatedAtString
The date the email was last updated.
aiSummaryStringOptional

An AI-generated summary of the email.

archivedAtStringOptional
The date the email was archived. Returns null if the email is active.
archivedByUserUserOptional
The user who archived the email.
htmlBodyStringOptional
The email's HTML body, with scripts and other unsafe markup removed.
incomingEmailAttachmentsCountIntegerOptional
The number of files attached to the email.
incomingEmailContactsCountIntegerOptional
The number of contacts linked to the email.
rawFromlist of StringsOptional

The sender addresses as they appear in the From header.

receivedAtStringOptional
The date and time the email was received.
stateEnumIncomingEmailStateEnumOptional
Whether the email has been assigned to a matter.
Allowed values:
subjectStringOptional
The email's original subject line.
textBodyStringOptional

The email’s plain-text body.

titleStringOptional
The email's title. Defaults to the subject and can be edited.
unlinkedEmailslist of StringsOptional
The email addresses on the email that are not linked to any contact.