INPUT_OBJECT

EmailFilterInput

Filter conditions for Email records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

link GraphQL Schema definition

  • input EmailFilterInput {
  • # Matches records that meet at least one of the listed filters.
  • OR: [EmailFilterInput!]
  • # Matches records that meet all of the listed filters.
  • AND: [EmailFilterInput!]
  • # Matches records that do not meet this filter.
  • NOT: EmailFilterInput
  • # Search term matched against the fields that the global search covers for this
  • # entity.
  • globalSearchQuery: String
  • # Unique identifier of entity.
  • id: EntityFilterStringField
  • # Specifies if the entity is considered deleted.
  • isDeleted: Boolean
  • # Last modification time.
  • modified: EntityFilterDateTimeField
  • # Creation time.
  • created: EntityFilterDateTimeField
  • # Comma-separated list of blind-carbon-copy recipients.
  • bcc: EntityFilterStringField
  • # HTML body of the email. Returned only to users with read permission on the email
  • # content; otherwise empty.
  • body: EntityFilterStringField
  • # Plain-text summary of the email body. Returned only to users with read
  • # permission on the email content; otherwise empty.
  • bodySummary: EntityFilterStringField
  • # Comma-separated list of carbon-copy recipients.
  • cc: EntityFilterStringField
  • # Id of the company email used as the From / Reply-To. Empty when sent from the
  • # user mailbox.
  • companyEmailId: EntityFilterStringField
  • # 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: ContentShareModeEnumFilterInput
  • # MIME content type of the body (e.g. text/html, text/plain).
  • contentType: EntityFilterStringField
  • # Timestamp the email was sent. Empty for drafts and scheduled emails not yet
  • # sent.
  • dateSent: EntityFilterDateTimeField
  • # Direction of the email (Incoming, Outgoing).
  • direction: EmailDirectionEnumFilterInput
  • # Id of the original email a draft was started from (reply/forward source), or
  • # empty for a standalone draft.
  • draftParentEmailId: EntityFilterStringField
  • # Numeric error code recorded when the email failed to send. Zero when no error
  • # occurred.
  • errorCode: EntityFilterNumberField
  • # 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: EntityFilterStringField
  • # Id of the email owner.
  • ownerId: EntityFilterStringField
  • # Id of the parent (master) email.
  • parentEmailId: EntityFilterStringField
  • # Timestamp at which a scheduled email is queued to be sent. Empty for
  • # immediately-sent emails.
  • sendAt: EntityFilterDateTimeField
  • # Sender address as it appeared on the email (free-text "From" header).
  • sender: EntityFilterStringField
  • # Id of the matched sender account.
  • senderAccountId: EntityFilterStringField
  • # Id of the matched sender user.
  • senderClientId: EntityFilterStringField
  • # Id of the matched sender contact.
  • senderContactId: EntityFilterStringField
  • # Id of the personal email-integration account that sent this email.
  • senderEmailAccountId: EntityFilterStringField
  • # Tone of the email (Negative, Neutral or Positive) as assessed by AI from its
  • # content; empty until assessed. Returned only to users with read permission on
  • # the email content.
  • sentiment: EmailSentimentEnumFilterInput
  • # 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: ShareModeEnumFilterInput
  • # Name of the entity and its default text representation.
  • subject: EntityFilterStringField
  • # Discriminator identifying the concrete record type — always "email" for Email
  • # records. Read-only; useful when consuming polymorphic Message results.
  • tableName: EntityFilterStringField
  • # Id of the email template.
  • templateId: EntityFilterStringField
  • # Identifier grouping emails belonging to the same conversation thread.
  • threadId: EntityFilterStringField
  • # Comma-separated list of primary recipients.
  • to: EntityFilterStringField
  • # Whether the email is an individual email (Standard) or part of a mass email
  • # (Mass).
  • type: EmailTypeEnumFilterInput
  • # IMAP UID of the email on the source mailbox.
  • uid: EntityFilterStringField
  • # Revision when entity was lastly changed.
  • revision: EntityFilterNumberField
  • # Ids of the mailboxes (company or personal) the email envelope belongs to,
  • # aggregated from the active emailMailboxRelation rows.
  • mailboxIds: [UUID!]
  • # Configured company email used as the From / Reply-To. Empty when sent from the
  • # user mailbox. Matches records where a related record meets these conditions.
  • companyEmail: CompanyEmailFilterInput
  • # The original email a draft was started from (reply/forward source), or empty for
  • # a standalone draft. Matches records where a related record meets these
  • # conditions.
  • draftParentEmail: EmailFilterInput
  • # Sales user who owns this email. May be empty for unassigned emails. Matches
  • # records where a related record meets these conditions.
  • owner: ClientFilterInput
  • # For mass emails: the master email this copy was generated from. Empty for the
  • # master and for non-mass emails. Matches records where a related record meets
  • # these conditions.
  • parentEmail: EmailFilterInput
  • # Account record matched as the sender, or empty when the sender does not match an
  • # existing Account. Matches records where a related record meets these conditions.
  • senderAccount: AccountFilterInput
  • # Internal user matched as the sender, or empty when the sender is external.
  • # Matches records where a related record meets these conditions.
  • senderClient: ClientFilterInput
  • # Contact record matched as the sender, or empty when the sender does not match an
  • # existing Contact. Matches records where a related record meets these conditions.
  • senderContact: ContactFilterInput
  • # Email template used to compose this email, or empty when none was used. Matches
  • # records where a related record meets these conditions.
  • template: EmailTemplateFilterInput
  • # Sales units that have been granted shared access to this email envelope. Matches
  • # records where a related record meets these conditions.
  • sharingUnits: MessageSharingSalesUnitRelationFilterInput
  • # Users that have been granted shared access to this email envelope. Matches
  • # records where a related record meets these conditions.
  • sharingClients: MessageSharingClientRelationFilterInput
  • # Sales units that have been granted access to the email body when
  • # contentShareMode is restricted. Matches records where a related record meets
  • # these conditions.
  • contentSharingUnits: EmailContentSharingSalesUnitRelationFilterInput
  • # Users that have been granted access to the email body when contentShareMode is
  • # restricted. Matches records where a related record meets these conditions.
  • contentSharingClients: EmailContentSharingClientRelationFilterInput
  • # Accounts this email is linked to. Matches records where a related record meets
  • # these conditions.
  • accountRelations: MessageRelationFilterInput
  • # Contacts this email is linked to. Matches records where a related record meets
  • # these conditions.
  • contactRelations: MessageRelationFilterInput
  • # Projects this email is linked to. Matches records where a related record meets
  • # these conditions.
  • projectRelations: MessageRelationFilterInput
  • # Custom entity records this email is linked to. Matches records where a related
  • # record meets these conditions.
  • customEntityRelations: MessageRelationFilterInput
  • # Leads this email is linked to. Matches records where a related record meets
  • # these conditions.
  • leadRelations: MessageRelationFilterInput
  • # Opportunities this email is linked to. Matches records where a related record
  • # meets these conditions.
  • opportunityRelations: MessageRelationFilterInput
  • # Quotes this email is linked to. Matches records where a related record meets
  • # these conditions.
  • quoteRelations: MessageRelationFilterInput
  • # Tag labels applied to this email. Visible only to users that can read the email
  • # body. Matches records where a related record meets these conditions.
  • tags: TagRelationFilterInput
  • # Attachments and other documents linked to this email. Matches records where a
  • # related record meets these conditions.
  • documents: CloudObjectRelationFilterInput
  • }

link Require by