OBJECT
EmailEntity

Email message sent or received by users of the space, linked to the contacts, accounts and other records it concerns.
GraphQL Schema definition

type EmailEntity {
# True when the record is protected against deletion because it must always exist 
# in the space. Deleting a record that is not protected can still fail on other 
# checks. Read-only.
isDeleteProtected: Boolean! 
# Unique identifier of entity.
id: ID! 
# Specifies if the entity is considered deleted.
isDeleted: Boolean 
# Last modification time.
modified: DateTime 
# Creation time.
created: DateTime 
# Configured company email used as the From / Reply-To. Empty when sent from the 
# user mailbox.
companyEmail: CompanyEmailEntity 
# The original email a draft was started from (reply/forward source), or empty for 
# a standalone draft.
draftParentEmail: EmailEntity 
# Sales user who owns this email. May be empty for unassigned emails.
owner: ClientEntity 
# For mass emails: the master email this copy was generated from. Empty for the 
# master and for non-mass emails.
parentEmail: EmailEntity 
# Account record matched as the sender, or empty when the sender does not match an 
# existing Account.
senderAccount: AccountEntity 
# Internal user matched as the sender, or empty when the sender is external.
senderClient: ClientEntity 
# Contact record matched as the sender, or empty when the sender does not match an 
# existing Contact.
senderContact: ContactEntity 
# Email template used to compose this email, or empty when none was used.
template: EmailTemplateEntity 
# Extra raw email headers preserved from the source message, as a JSON object 
# mapping each header name to a string or a list of strings.
additionalHeaders: JSONString 
# Comma-separated list of blind-carbon-copy recipients.
bcc: String 
# HTML body of the email, or a localized "Private content" label when the caller 
# cannot read its content.
# 
# Arguments
# mailboxId: Mailbox the email is shown in (inbox). Content 
# sharing is not applied there: the content is available when the email is in one 
# of your mailboxes. Without it content sharing applies.
body(mailboxId: ID): String! 
# Plain-text summary of the body, or a localized "Private content" label when the 
# caller cannot read the email content.
# 
# Arguments
# mailboxId: Mailbox the email is shown in (inbox). Content 
# sharing is not applied there: the content is available when the email is in one 
# of your mailboxes. Without it content sharing applies.
bodySummary(mailboxId: ID): String! 
# Comma-separated list of carbon-copy recipients.
cc: String 
# Id of the company email used as the From / Reply-To. Empty when sent from the 
# user mailbox.
companyEmailId: ID 
# How the email body is shared with non-owners (e.g. Private hides the body, 
# Public makes it visible to anyone with read access on the email envelope).
contentShareMode: ContentShareModeEnum 
# MIME content type of the body (e.g. text/html, text/plain).
contentType: String 
# Timestamp the email was sent. Empty for drafts and scheduled emails not yet 
# sent.
dateSent: DateTime 
# Direction of the email (Incoming, Outgoing).
direction: EmailDirectionEnum! 
# Id of the original email a draft was started from (reply/forward source), or 
# empty for a standalone draft.
draftParentEmailId: ID 
# Saved state of an email draft (recipients, subject, body, attachments, template, 
# sharing) used to reopen it for editing. Empty for emails that are not drafts.
draftSettings: EmailDraftSettings 
# Numeric error code recorded when the email failed to send. Zero when no error 
# occurred.
errorCode: Int 
# True when this email is an unsent draft. Drafts have no dateSent/sendAt and are 
# excluded from the sent/scheduled streams.
isDraft: Boolean 
# True when delivery tracking is enabled. Tracked emails generate EmailEvent 
# records on open/click.
isTracked: Boolean 
# External identifier of the email on the source mailbox (e.g. IMAP Message-ID). 
# Used to deduplicate when re-syncing.
originalId: String 
# Id of the email owner.
ownerId: ID 
# Id of the parent (master) email.
parentEmailId: ID 
# Sending configuration of a scheduled email (sending account, recipients, linked 
# records, follow-up options). Empty when the email is not scheduled.
scheduleSettings: EmailScheduleSettings 
# Timestamp at which a scheduled email is queued to be sent. Empty for 
# immediately-sent emails.
sendAt: DateTime 
# Sender address as it appeared on the email (free-text "From" header).
sender: String 
# Id of the matched sender account.
senderAccountId: ID 
# Id of the matched sender user.
senderClientId: ID 
# Id of the matched sender contact.
senderContactId: ID 
# Id of the personal email-integration account that sent this email.
senderEmailAccountId: ID 
# Sentiment of the email. Null without access to the email content.
# 
# Arguments
# mailboxId: Mailbox the email is shown in (inbox). Content 
# sharing is not applied there: the content is available when the email is in one 
# of your mailboxes. Without it content sharing applies.
sentiment(mailboxId: ID): EmailSentimentEnum 
# Sharing model for the email envelope (e.g. shared with selected sales units or 
# selected users). The matching sharingUnits / sharingClients lists control who is 
# granted access.
shareMode: ShareModeEnum 
# Subject line of the email, or a localized "Private content" label when the 
# caller cannot read its content.
# 
# Arguments
# mailboxId: Mailbox the email is shown in (inbox). Content 
# sharing is not applied there: the content is available when the email is in one 
# of your mailboxes. Without it content sharing applies.
subject(mailboxId: ID): String! 
# Discriminator identifying the concrete record type — always "email" for Email 
# records. Read-only; useful when consuming polymorphic Message results.
tableName: String! 
# Id of the email template.
templateId: ID 
# Identifier grouping emails belonging to the same conversation thread.
threadId: ID 
# Comma-separated list of primary recipients.
to: String 
# Whether the email is an individual email (Standard) or part of a mass email 
# (Mass).
type: EmailTypeEnum 
# IMAP UID of the email on the source mailbox.
uid: String! 
# Revision when entity was lastly changed.
revision: Int 
# True when the current authenticated user has marked this email as favorite. 
# Per-user.
isFavorite: Boolean! 
# Sales units that have been granted shared access to this email envelope.
# 
# Arguments
# filter: Filter SalesUnit relations by target SalesUnit 
# attributes.
# filterEdge: Filter MessageSharingSalesUnitRelation relations by 
# edge (relation) MessageSharingSalesUnitRelation attributes.
# orderBy: Order SalesUnit relations by target SalesUnit 
# attributes.
# includeDeleted: Returns deleted target records as well. Default 
# is true.
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
sharingUnits(
filter: SalesUnitFilterInput,
filterEdge: MessageSharingSalesUnitRelationFilterInput,
orderBy: [SalesUnitOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): MessageSharingSalesUnitRelationEntityConnection 
# Users that have been granted shared access to this email envelope.
# 
# Arguments
# filter: Filter Client relations by target Client attributes.
# filterEdge: Filter MessageSharingClientRelation relations by 
# edge (relation) MessageSharingClientRelation attributes.
# orderBy: Order Client relations by target Client attributes.
# includeDeleted: Returns deleted target records as well. Default 
# is true.
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
sharingClients(
filter: ClientFilterInput,
filterEdge: MessageSharingClientRelationFilterInput,
orderBy: [ClientOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): MessageSharingClientRelationEntityConnection 
# Sales units that have been granted access to the email body when 
# contentShareMode is restricted.
# 
# Arguments
# filter: Filter SalesUnit relations by target SalesUnit 
# attributes.
# filterEdge: Filter EmailContentSharingSalesUnitRelation 
# relations by edge (relation) EmailContentSharingSalesUnitRelation attributes.
# orderBy: Order SalesUnit relations by target SalesUnit 
# attributes.
# includeDeleted: Returns deleted target records as well. Default 
# is true.
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
contentSharingUnits(
filter: SalesUnitFilterInput,
filterEdge: EmailContentSharingSalesUnitRelationFilterInput,
orderBy: [SalesUnitOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): EmailContentSharingSalesUnitRelationEntityConnection 
# Users that have been granted access to the email body when contentShareMode is 
# restricted.
# 
# Arguments
# filter: Filter Client relations by target Client attributes.
# filterEdge: Filter EmailContentSharingClientRelation relations 
# by edge (relation) EmailContentSharingClientRelation attributes.
# orderBy: Order Client relations by target Client attributes.
# includeDeleted: Returns deleted target records as well. Default 
# is true.
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
contentSharingClients(
filter: ClientFilterInput,
filterEdge: EmailContentSharingClientRelationFilterInput,
orderBy: [ClientOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): EmailContentSharingClientRelationEntityConnection 
# Accounts this email is linked to.
# 
# Arguments
# filter: Filter Account relations by target Account attributes.
# filterEdge: Filter MessageRelation relations by edge (relation) 
# MessageRelation attributes.
# orderBy: Order Account relations by target Account attributes.
# includeDeleted: Returns deleted target records as well. Default 
# is true.
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
accountRelations(
filter: AccountFilterInput,
filterEdge: MessageRelationFilterInput,
orderBy: [AccountOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): MessageRelationEntityConnection 
# Contacts this email is linked to.
# 
# Arguments
# filter: Filter Contact relations by target Contact attributes.
# filterEdge: Filter MessageRelation relations by edge (relation) 
# MessageRelation attributes.
# orderBy: Order Contact relations by target Contact attributes.
# includeDeleted: Returns deleted target records as well. Default 
# is true.
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
contactRelations(
filter: ContactFilterInput,
filterEdge: MessageRelationFilterInput,
orderBy: [ContactOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): MessageRelationEntityConnection 
# Projects this email is linked to.
# 
# Arguments
# filter: Filter Project relations by target Project attributes.
# filterEdge: Filter MessageRelation relations by edge (relation) 
# MessageRelation attributes.
# orderBy: Order Project relations by target Project attributes.
# includeDeleted: Returns deleted target records as well. Default 
# is true.
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
projectRelations(
filter: ProjectFilterInput,
filterEdge: MessageRelationFilterInput,
orderBy: [ProjectOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): MessageRelationEntityConnection 
# Custom entity records this email is linked to.
# 
# Arguments
# filter: Filter CustomEntity relations by target CustomEntity 
# attributes.
# filterEdge: Filter MessageRelation relations by edge (relation) 
# MessageRelation attributes.
# orderBy: Order CustomEntity relations by target CustomEntity 
# attributes.
# includeDeleted: Returns deleted target records as well. Default 
# is true.
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
customEntityRelations(
filter: CustomEntityFilterInput,
filterEdge: MessageRelationFilterInput,
orderBy: [CustomEntityOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): MessageRelationEntityConnection 
# Leads this email is linked to.
# 
# Arguments
# filter: Filter Lead relations by target Lead attributes.
# filterEdge: Filter MessageRelation relations by edge (relation) 
# MessageRelation attributes.
# orderBy: Order Lead relations by target Lead attributes.
# includeDeleted: Returns deleted target records as well. Default 
# is true.
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
leadRelations(
filter: LeadFilterInput,
filterEdge: MessageRelationFilterInput,
orderBy: [LeadOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): MessageRelationEntityConnection 
# Opportunities this email is linked to.
# 
# Arguments
# filter: Filter Opportunity relations by target Opportunity 
# attributes.
# filterEdge: Filter MessageRelation relations by edge (relation) 
# MessageRelation attributes.
# orderBy: Order Opportunity relations by target Opportunity 
# attributes.
# includeDeleted: Returns deleted target records as well. Default 
# is true.
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
opportunityRelations(
filter: OpportunityFilterInput,
filterEdge: MessageRelationFilterInput,
orderBy: [OpportunityOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): MessageRelationEntityConnection 
# Quotes this email is linked to.
# 
# Arguments
# filter: Filter Quote relations by target Quote attributes.
# filterEdge: Filter MessageRelation relations by edge (relation) 
# MessageRelation attributes.
# orderBy: Order Quote relations by target Quote attributes.
# includeDeleted: Returns deleted target records as well. Default 
# is true.
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
quoteRelations(
filter: QuoteFilterInput,
filterEdge: MessageRelationFilterInput,
orderBy: [QuoteOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): MessageRelationEntityConnection 
# Tag labels applied to this email. Visible only to users that can read the email 
# body.
# 
# Arguments
# filter: Filter Tag relations by target Tag attributes.
# filterEdge: Filter TagRelation relations by edge (relation) 
# TagRelation attributes.
# orderBy: Order Tag relations by target Tag attributes.
# includeDeleted: Returns deleted target records as well. Default 
# is true.
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
tags(
filter: TagFilterInput,
filterEdge: TagRelationFilterInput,
orderBy: [TagOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): TagRelationEntityConnection 
# Attachments and other documents linked to this email.
# 
# Arguments
# mailboxId: Mailbox the email is shown in (inbox). Content 
# sharing is not applied there: the content is available when the email is in one 
# of your mailboxes. Without it content sharing applies.
# filter: Filter CloudObject relations by target CloudObject 
# attributes.
# filterEdge: Filter CloudObjectRelation relations by edge 
# (relation) CloudObjectRelation attributes.
# orderBy: Order CloudObject relations by target CloudObject 
# attributes.
# includeDeleted: Returns deleted target records as well. Default 
# is true.
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
documents(
mailboxId: ID,
filter: CloudObjectFilterInput,
filterEdge: CloudObjectRelationFilterInput,
orderBy: [CloudObjectOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): CloudObjectRelationEntityConnection 
# Ids of the mailboxes (company or personal) the email envelope belongs to, 
# aggregated from the active emailMailboxRelation rows.
mailboxIds: [UUID!]! 
# Permissions the current user has on this record, out of the requested ones.
# 
# Arguments
# permissions: Permissions to check; the result lists those the 
# current user has.
instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]! 
# Tracking statistics (sent, opened, clicked, replied, bounced, unsubscribed) of 
# the individual emails sent from this mass email.
massTrackingInfo: MassEmailTrackingInfo! 
# Tracking events of the email, newest first: up to the 20 latest opens, clicks 
# and unsubscribes, followed by the send event.
trackingHistory: [EmailTrackingEvent]! 
# Recipients of this mass email in the selected category, with their delivery and 
# engagement state.
# 
# Arguments
# category: Recipient group to list, by delivery or engagement 
# outcome.
# sortBy: Column the recipients are sorted by.
# sortOrder: Sort direction.
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
massEmailRelations(
category: MassEmailRelationCategory!,
sortBy: MassEmailDetailGridSortyBy,
sortOrder: SortOrder,
before: String,
after: String,
first: Int,
last: Int
): MassEmailRelationItemConnection 
# True when a tracking event other than a bounce (such as an open or a click) was 
# recorded for the email.
hasTrackingEvent: Boolean! 
# True when at least one file is attached to the email.
hasAnyAttachment: Boolean! 
# True when the email bounced; for a mass email, when any email sent from it 
# bounced. Soft bounces are not counted.
wasBounced: Boolean! 
# Subject of the latest sent email in this conversation whose content the caller 
# can read, or a localized "Private content" label when there is none.
# 
# Arguments
# mailboxId: Limits the conversation to emails in this mailbox.
conversationSubject(mailboxId: ID): String 
# True when the caller can read the content of at least one sent email in this 
# conversation, so `conversationSubject` returns a real subject.
# 
# Arguments
# mailboxId: Limits the conversation to emails in this mailbox.
isConversationSubjectAvailable(mailboxId: ID): Boolean! 
# True when the caller can read the content of this email; otherwise `subject`, 
# `body` and `bodySummary` return a localized "Private content" label.
# 
# Arguments
# mailboxId: Mailbox the email is shown in (inbox). Content 
# sharing is not applied there: the content is available when the email is in one 
# of your mailboxes. Without it content sharing applies.
isContentAvailable(mailboxId: ID): Boolean! 
# True when the caller can change who can read the content of at least one email 
# in this conversation (see `updateEmailThreadContentShareModeEmail`).
# 
# Arguments
# mailboxId: Limits the conversation to emails in this mailbox.
canChangeConversationContentShareMode(
mailboxId: ID
): Boolean! 
# Paged conversation this email is in, optionally scoped to one mailbox. 
# Deprecated in favour of `conversation`, which returns the whole thread in one 
# payload.
# 
# Arguments
# sortOrder: Order of the emails by time; oldest first by 
# default.
# mailboxId: Limits the conversation to emails in this mailbox 
# and also includes its drafts and scheduled emails.
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
conversationItems(
sortOrder: SortOrder,
mailboxId: ID,
before: String,
after: String,
first: Int,
last: Int
): EmailConversationItemConnection 
# All emails of the conversation this email belongs to in one unpaged list, 
# ordered like `conversationItems`.
# 
# Arguments
# mailboxId: Limits the conversation to emails in this mailbox 
# and also includes its drafts and scheduled emails.
# sortOrder: Order of the emails by time; oldest first by 
# default.
conversation(mailboxId: ID, sortOrder: SortOrder): [EmailConversationItem!]! 
# Earliest sent email of this conversation; empty when this email is the only one 
# in it.
# 
# Arguments
# mailboxId: Limits the conversation to emails in this mailbox.
oldestConversationItem(mailboxId: ID): EmailEntity 
# Latest sent email of this conversation whose content the caller can read; empty 
# when this email is the only one in it.
# 
# Arguments
# mailboxId: Limits the conversation to emails in this mailbox.
newestReadableConversationItem(mailboxId: ID): EmailEntity 
# HTML body prefilled for a reply: an "On   wrote:" line followed by 
# the quoted original message. Null when the caller cannot read the email content.
# 
# Arguments
# mailboxId: Mailbox the email is shown in (inbox). Content 
# sharing is not applied there: the content is available when the email is in one 
# of your mailboxes. Without it content sharing applies.
replyBody(mailboxId: ID): String 
# HTML body prefilled for forwarding: a forwarded-message header (From, Date, 
# Subject, To, Cc) followed by the quoted original message. Null when the caller 
# cannot read the email content.
# 
# Arguments
# mailboxId: Mailbox the email is shown in (inbox). Content 
# sharing is not applied there: the content is available when the email is in one 
# of your mailboxes. Without it content sharing applies.
forwardBody(mailboxId: ID): String 
# True when another user created this email and the given mailbox is not a company 
# mailbox the caller can use.
# 
# Arguments
# mailboxId: Mailbox the email is viewed in.
isDifferentActor(mailboxId: ID!): Boolean! 
# Records the email is linked to in the given mailbox, such as its sender and 
# recipients. An item without `id` is an address not matched to any record, and 
# `isAvailable` is false for a record the caller cannot see.
# 
# Arguments
# mailboxId: Mailbox the email is viewed in.
linkedRecords(mailboxId: ID!): [EmailEntityLinkedRecord!]! 
# Labels the caller applied to this email's conversation, oldest first. Labels 
# applied by other users and deleted labels are not returned.
# 
# Arguments
# mailboxId: Limits the labels to those applied in this mailbox.
# before: Cursor until which to take entities to result set.
# after: Cursor after which to start taking entities to result 
# set.
# first: Number of entities to return from beginning of the 
# result set.
# last: Return only the "last" number of entities from result 
# set.
labels(mailboxId: ID, before: String, after: String, first: Int, last: Int): EmailLabelRelationEntityConnection 
}
EmailEntity

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
