OBJECT

EmailMailboxRelationEntity

Link between an email and a mailbox the email belongs to.

link GraphQL Schema definition

  • type EmailMailboxRelationEntity {
  • # 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
  • # Email that belongs to the mailbox.
  • email: EmailEntity
  • # Direction of the email relative to this mailbox: outgoing for the mailbox that
  • # sent it, incoming for a mailbox that received it. The same email can therefore
  • # be outgoing in one mailbox and incoming in another. Defaults to the email
  • # direction when not set.
  • direction: EmailDirectionEnum
  • # Creation time.
  • emailCreated: DateTime
  • # Id of the email that belongs to the mailbox.
  • emailId: ID!
  • # True when the related email has been deleted from this mailbox; such links are
  • # hidden from the inbox view.
  • emailIsDeleted: Boolean
  • # Error code for the email in this mailbox; 0 means the email was processed
  • # without error.
  • errorCode: Int
  • # Tracking events recorded so far for the related email (opens, clicks, replies,
  • # bounces, unsubscribes); several can be combined. Read-only; kept in sync with
  • # the email's EmailEvent records.
  • eventTypes: EmailEventTypeFlagEnum
  • # Copy of the related email's draft flag; true when the email is an unsent draft,
  • # which shows it in the mailbox Drafts.
  • isDraft: Boolean
  • # Whether the email is scheduled to be sent at a future time and has not been sent
  • # yet.
  • isScheduled: Boolean
  • # Ids of the labels applied to this conversation in this mailbox. Read-only copy
  • # of the EmailLabelRelation records; manage labels via that entity rather than
  • # writing here.
  • labelIds: JSONString
  • # Id of the mailbox (connected email account) the email belongs to.
  • mailboxId: ID!
  • # Time when the email was sent, or its scheduled send time if it has not been sent
  • # yet.
  • sentOrScheduledAt: DateTime
  • # Id of the email thread, or the id of the email itself when it does not belong to
  • # a thread.
  • threadOrId: ID
  • # Copy of the related email's type: an individual email or part of a mass email.
  • # Read-only; kept in sync with the email.
  • type: EmailTypeEnum
  • # 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!]!
  • }