OBJECT
EmailEntity

GraphQL Schema definition

type EmailEntity {
#   Tells if the entity instance is protected against delete (Entities that need to 
#   be present in the system at any time). Delete action still may fail if entity is 
#   deletable, due some other additional validations.
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 
#   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.
additionalHeaders: JSONString 
body: String! 
bodySummary: String! 
#   Comma-separated list of carbon-copy recipients.
cc: String 
#   Id of the company email.
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! 
#   Numeric error code recorded when the email failed to send. Zero when no error 
#   occurred.
errorCode: Int 
#   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 
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 
#   Field whose values are strictly defined with an enumeration of values.
sentiment: EmailSentimentEnum 
#   Sharing model for the email envelope (e.g. shared with selected sales units or 
#   selected users). The matching sharing_units / sharing_clients lists control who 
#   is granted access.
shareMode: ShareModeEnum 
subject: 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 
#   Email category (e.g. regular email, mass email, calendar invitation).
type: EmailTypeEnum 
#   IMAP UID of the email on the source mailbox.
uid: String! 
#   Revision when entity was lastly changed.
revision: Int 
#   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 
#   content_share_mode 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 content_share_mode 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
#   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(
filter: CloudObjectFilterInput,
filterEdge: CloudObjectRelationFilterInput,
orderBy: [CloudObjectOrderByInput!],
includeDeleted: Boolean,
before: String,
after: String,
first: Int,
last: Int
): CloudObjectRelationEntityConnection 
#   Checks which permissions current user has on concrete entity instance.
# 
# Arguments
#   permissions: [Not documented]
instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]! 
massTrackingInfo: MassEmailTrackingInfo! 
trackingHistory: [EmailTrackingEvent]! 
# Arguments
#   category: [Not documented]
#   sortBy: [Not documented]
#   sortOrder: [Not documented]
#   before: [Not documented]
#   after: [Not documented]
#   first: [Not documented]
#   last: [Not documented]
massEmailRelations(
category: MassEmailRelationCategory!,
sortBy: MassEmailDetailGridSortyBy,
sortOrder: SortOrder,
before: String,
after: String,
first: Int,
last: Int
): MassEmailRelationItemConnection 
hasTrackingEvent: Boolean! 
hasAnyAttachment: Boolean! 
wasBounced: Boolean! 
#   Returns subject for conversation this email is in. Returns null if thread_id = 
#   null
conversationSubject: String 
isConversationSubjectAvailable: Boolean! 
isContentAvailable: Boolean! 
canChangeConversationContentShareMode: Boolean! 
# Arguments
#   sortOrder: [Not documented]
#   before: [Not documented]
#   after: [Not documented]
#   first: [Not documented]
#   last: [Not documented]
conversationItems(
sortOrder: SortOrder,
before: String,
after: String,
first: Int,
last: Int
): EmailConversationItemConnection 
oldestConversationItem: EmailEntity 
newestReadableConversationItem: EmailEntity 
#   Used for reply.
replyBody: String! 
#   Used for forward.
forwardBody: String! 
}
EmailEntity

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
