OBJECT

EmailEntity

link 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
  • companyEmail: CompanyEmailEntity
  • owner: ClientEntity
  • parentEmail: EmailEntity
  • senderAccount: AccountEntity
  • senderClient: ClientEntity
  • senderContact: ContactEntity
  • template: EmailTemplateEntity
  • # Field containing json.
  • additionalHeaders: JSONString
  • body: String!
  • bodySummary: String!
  • # Multi-line text input field.
  • cc: String
  • # Relation to single entity instance.
  • companyEmailId: ID
  • # Field whose values are strictly defined with an enumeration of values.
  • contentShareMode: ContentShareModeEnum
  • # Simple text input field.
  • contentType: String
  • # Datetime information.
  • dateSent: DateTime
  • # Field whose values are strictly defined with an enumeration of values.
  • direction: EmailDirectionEnum!
  • # Generic field wrapping sqlalchemy column, configurable by constructor.
  • #
  • # Good for one-of fields / generated fields.
  • #
  • errorCode: Int
  • # Boolean value.
  • isTracked: Boolean
  • # Generic field wrapping sqlalchemy column, configurable by constructor.
  • #
  • # Good for one-of fields / generated fields.
  • #
  • originalId: String
  • # Relation to single entity instance.
  • ownerId: ID
  • # Relation to single entity instance.
  • parentEmailId: ID
  • # Multi-line text input field.
  • sender: String
  • # Relation to single entity instance.
  • senderAccountId: ID
  • # Relation to single entity instance.
  • senderClientId: ID
  • # Relation to single entity instance.
  • senderContactId: ID
  • # Field whose values are strictly defined with an enumeration of values.
  • shareMode: ShareModeEnum
  • subject: String!
  • # Relation to single entity instance.
  • templateId: ID
  • # Generic field wrapping sqlalchemy column, configurable by constructor.
  • #
  • # Good for one-of fields / generated fields.
  • #
  • threadId: String
  • # Multi-line text input field.
  • to: String
  • # Field whose values are strictly defined with an enumeration of values.
  • type: EmailTypeEnum
  • # Generic field wrapping sqlalchemy column, configurable by constructor.
  • #
  • # Good for one-of fields / generated fields.
  • #
  • uid: String!
  • # Revision when entity was lastly changed.
  • revision: Int
  • # Relations to SalesUnits.
  • #
  • # 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
  • # Relations to Clients.
  • #
  • # 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
  • # Relations to SalesUnits.
  • #
  • # 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
  • # Relations to Clients.
  • #
  • # 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
  • # Relations to Accounts.
  • #
  • # 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
  • # Relations to Contacts.
  • #
  • # 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
  • # Relations to Projects.
  • #
  • # 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
  • # Relations to Leads.
  • #
  • # 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
  • # Relations to Opportunitys.
  • #
  • # 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
  • # Relations to CloudObjects.
  • #
  • # 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]
  • # before: [Not documented]
  • # after: [Not documented]
  • # first: [Not documented]
  • # last: [Not documented]
  • massEmailRelations(
  • category: MassEmailRelationCategory!,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): MassEmailRelationItemConnection
  • hasTrackingEvent: Boolean!
  • hasAnyAttachment: Boolean!
  • # Returns subject for conversation this email is in. Returns null if thread_id =
  • # null
  • conversationSubject: String
  • isConversationSubjectAvailable: Boolean!
  • isContentAvailable: Boolean!
  • canChangeConversationContentShareMode: Boolean!
  • # Arguments
  • # before: [Not documented]
  • # after: [Not documented]
  • # first: [Not documented]
  • # last: [Not documented]
  • conversationItems(
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): EmailConversationItemConnection
  • # Used for reply.
  • replyBody: String!
  • # Used for forward.
  • forwardBody: String!
  • }