OBJECT

EmailRepository

Read operations for Email records.

link GraphQL Schema definition

  • type EmailRepository {
  • # Returns the record with the given id, or null when there is none. Deleted
  • # records are returned as well.
  • #
  • # Arguments
  • # entityId: Id of the record to return.
  • getById(entityId: ID!): EmailEntity
  • # Returns the records with the given ids; ids without a record are left out.
  • # Deleted records are returned as well.
  • #
  • # Arguments
  • # entityIds: Ids of the records to return.
  • getByIds(entityIds: [ID!]!): [EmailEntity!]!
  • # Returns the records that match the filter, paged with limit and offset.
  • #
  • # Arguments
  • # limit: Maximum number of records to return.
  • # offset: Number of records to skip from the start of the result.
  • # filter: Conditions the returned records must meet.
  • # orderBy: Sorting of the returned records.
  • # includeDeleted: When true, deleted records are returned as
  • # well. Defaults to false.
  • getAll(
  • limit: Int,
  • offset: Int,
  • filter: EmailFilterInput,
  • orderBy: [EmailOrderByInput!],
  • includeDeleted: Boolean
  • ): [EmailEntity!]!
  • # Returns the records that match the filter as a cursor-paginated connection.
  • #
  • # Arguments
  • # filter: Conditions the returned records must meet.
  • # orderBy: Sorting of the returned records.
  • # includeDeleted: When true, deleted records are returned as
  • # well. Defaults to false.
  • # 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.
  • getByCriteria(
  • filter: EmailFilterInput,
  • orderBy: [EmailOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): EmailEntityConnection
  • # Returns the ids of the fields of a record that changed after the given revision.
  • # Returns an empty list for entities without change tracking.
  • #
  • # Arguments
  • # id: Id of the record.
  • # revision: Revision to compare against; only later changes are
  • # returned.
  • getChangedFieldsSinceRevision(
  • id: UUID!,
  • revision: Int!
  • ): [UUID!]!
  • # Returns the recipients from the given list who have unsubscribed from emails, so
  • # they can be removed before sending.
  • #
  • # Arguments
  • # recipients: Recipients to check, identified by address or by
  • # linked account/contact.
  • checkForUnsubscribed(
  • recipients: [SendEmailRecipientParams!]!
  • ): [SendEmailRecipient!]!
  • # Returns the saved draft replying to the given email in the given mailbox, or
  • # null when there is none.
  • #
  • # Arguments
  • # parentId: Id of the email the draft replies to.
  • # mailboxId: Id of the mailbox the draft belongs to.
  • getDraftByParentAndMailbox(
  • parentId: UUID!,
  • mailboxId: UUID!
  • ): EmailEntity
  • # Returns the records (accounts, contacts, opportunities, projects, quotes, custom
  • # entities) linked to the email's conversation thread.
  • #
  • # Arguments
  • # emailId: Id of the email.
  • # mailboxId: When set, only emails of the thread in this mailbox
  • # are considered.
  • getLinkedItems(emailId: UUID!, mailboxId: UUID): [EmailLinkedItem!]!
  • }

link Require by