GraphQL RepositoriescompanyEmail

`entities.companyEmail`

Read company email records with the companyEmail repository, and change them with the company email mutations. Same records as the REST CompanyEmails entity.

Example: first three company email recordsGraphQLcURL

query FirstCompanyEmails {
  entities {
    companyEmail {
      getByCriteria(first: 3, orderBy: [{ modified: Desc }]) {
        totalCount
        edges { node { id name modified } }
      }
    }
  }
}

curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query FirstCompanyEmails { entities { companyEmail { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id name modified } } } } } }"}'

Queries

Fields of entities { companyEmail { … } }.

Kind	Field	Returns
QUERY	`getById`(entityId: ID!) Returns the record with the given id, or null when there is none. Deleted records are returned as well.	CompanyEmailEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[CompanyEmailEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: CompanyEmailFilterInput, orderBy: [CompanyEmailOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[CompanyEmailEntity!]!
QUERY	`getByCriteria`(filter: CompanyEmailFilterInput, orderBy: [CompanyEmailOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	CompanyEmailEntityConnection
QUERY	`getChangedFieldsSinceRevision`(id: UUID!, revision: Int!) Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.	[UUID!]!
QUERY	`getAllForAdmin`(limit: Int, offset: Int, filter: CompanyEmailFilterInput, orderBy: [CompanyEmailOrderByInput!], includeDeleted: Boolean) Returns all company email accounts of the space, including those shared with other users, for administration.	[CompanyEmailEntity!]!

Types

The types this repository uses, each with its fields and their descriptions. Types several repositories share, such as PageInfo and the filter fields, are in the types index.

CompanyEmailEntity object 17 fields: isDeleteProtected, id, isDeleted, …

Shared company mailbox connected to the space that users can send emails from, such as a sales or support address.

Field	Type	Description
`isDeleteProtected`	Boolean!	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.
`id`	ID!	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`email`	String	Email address of the company mailbox (the From address).
`enabled`	Boolean!	False when the mailbox is disabled (either by the user or because the underlying feature is not available); true otherwise.
`errorCode`	Int	Error code recorded for the mailbox; empty when healthy. Set on integration failures or when the user disables the integration.
`name`	String!	Display name of the company email account, shown in the UI.
`pictureUrl`	String	URL of the avatar image used as the sender picture for emails sent from this account.
`serviceType`	EmailServiceTypeEnum!	Email service the company email account is connected through and sends from: Microsoft 365, Google or SendGrid.
`settings`	JSONString	Provider-specific configuration for the mailbox (e.g. parse_subdomain for SendGrid).
`token`	String	OAuth/secret credentials for the mailbox. Read-only and only returned to service-to-service callers; setting via the public API is not supported.
`features`	[EmailAccountFeatureEnum!]!	List of capabilities supported by the underlying email service (e.g. CanSyncBounces, CanSyncIncoming).
`mailboxId`	UUID	Stable UUID derived from the mailbox address and service type, used to correlate the company email account with its integration settings entry.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.
`limits`	EmailAccountLimit!	Daily sending limit of the email account and the number of emails sent from it in the last 24 hours.

CompanyEmailEntityConnection object pageInfo: PageInfo!, edges: [CompanyEmailEntityEdge]!, totalCount: Int

Paginated list of CompanyEmail records.

Field	Type	Description
`pageInfo`	PageInfo!	Pagination data for this connection.
`edges`	[CompanyEmailEntityEdge]!	Contains the nodes in this connection.
`totalCount`	Int	Total number of items in the connection.

CompanyEmailEntityEdge object node: CompanyEmailEntity, cursor: String!

A Relay edge containing a CompanyEmailEntity and its cursor.

Field	Type	Description
`node`	CompanyEmailEntity	The item at the end of the edge
`cursor`	String!	A cursor for use in pagination

CompanyEmailFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field

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

Input field	Type	Description
`OR`	[CompanyEmailFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[CompanyEmailFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	CompanyEmailFilterInput	Matches records that do not meet this filter.
`globalSearchQuery`	String	Search term matched against the fields that the global search covers for this entity.
`id`	EntityFilterStringField	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	EntityFilterDateTimeField	Last modification time.
`created`	EntityFilterDateTimeField	Creation time.
`email`	EntityFilterStringField	Email address of the company mailbox (the From address).
`enabled`	Boolean	False when the mailbox is disabled (either by the user or because the underlying feature is not available); true otherwise.
`errorCode`	EntityFilterNumberField	Error code recorded for the mailbox; empty when healthy. Set on integration failures or when the user disables the integration.
`name`	EntityFilterStringField	Display name of the company email account, shown in the UI.
`pictureUrl`	EntityFilterStringField	URL of the avatar image used as the sender picture for emails sent from this account.
`serviceType`	EmailServiceTypeEnumFilterInput	Email service the company email account is connected through and sends from: Microsoft 365, Google or SendGrid.

CompanyEmailOrderByInput input Asc or Desc per field

Sorting of CompanyEmail records. Set exactly one field in each item; list several items to sort by more fields, in order of priority.

Input field	Type	Description
`id`	OrderByEnum	Unique identifier of entity.
`isDeleted`	OrderByEnum	Specifies if the entity is considered deleted.
`modified`	OrderByEnum	Last modification time.
`created`	OrderByEnum	Creation time.
`email`	OrderByEnum	Email address of the company mailbox (the From address).
`enabled`	OrderByEnum	False when the mailbox is disabled (either by the user or because the underlying feature is not available); true otherwise.
`errorCode`	OrderByEnum	Error code recorded for the mailbox; empty when healthy. Set on integration failures or when the user disables the integration.
`name`	OrderByEnum	Display name of the company email account, shown in the UI.
`pictureUrl`	OrderByEnum	URL of the avatar image used as the sender picture for emails sent from this account.
`serviceType`	OrderByEnum	Email service the company email account is connected through and sends from: Microsoft 365, Google or SendGrid.

EmailServiceTypeEnumFilterInput input eq: [EmailServiceTypeEnum!], NOT: EmailServiceTypeEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input field	Type	Description
`eq`	[EmailServiceTypeEnum!]	Matches any of the listed values.
`NOT`	EmailServiceTypeEnumFilterInput	Matches values that do not meet this condition.

EmailAccountFeatureEnum enum CanSyncBounces, CanSyncIncoming

Capability supported by an email account's service.

Value	Description
`CanSyncBounces`	Bounced emails are detected and recorded.
`CanSyncIncoming`	Incoming emails, such as replies, are synchronized into Coevera.

EmailAccountLimit object messagesPerDay: Int!, sentMessages: Int!

Daily sending limit of a company email account and how many emails were sent from it in the last 24 hours.

Field	Type	Description
`messagesPerDay`	Int!	Maximum number of emails the email service of the account allows to send in 24 hours.
`sentMessages`	Int!	Number of emails sent from the account through Coevera in the last 24 hours.

EmailServiceTypeEnum enum O365Email, GoogleEmail, SendGrid

Email service a company email account sends through.

Value	Description
`O365Email`	Microsoft 365 (Outlook) account.
`GoogleEmail`	Google (Gmail / Google Workspace) account.
`SendGrid`	SendGrid account.