GraphQL RepositoriesemailLabel

`entities.emailLabel`

Read email label records with the emailLabel repository, and change them with the email label mutations. Same records as the REST EmailLabels entity.

Example: first three email label recordsGraphQLcURL

query FirstEmailLabels {
  entities {
    emailLabel {
      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 FirstEmailLabels { entities { emailLabel { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id name modified } } } } } }"}'

Queries

Fields of entities { emailLabel { … } }.

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.	EmailLabelEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[EmailLabelEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: EmailLabelFilterInput, orderBy: [EmailLabelOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[EmailLabelEntity!]!
QUERY	`getByCriteria`(filter: EmailLabelFilterInput, orderBy: [EmailLabelOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	EmailLabelEntityConnection
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!]!

Mutations

Kind	Mutation	Does	Returns
MUTATION	`createEmailLabel`(input: CreateEmailLabelInput!, validationLevel: [ValidationLevel!])	Create one record	CreateEmailLabelPayload
MUTATION	`updateEmailLabel`(input: UpdateEmailLabelInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateEmailLabelPayload
MUTATION	`bulkUpdateEmailLabel`(input: [CreateOrUpdateEmailLabelInput!]!, deleteInput: [DeleteEmailLabelInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateEmailLabelPayload
MUTATION	`deleteEmailLabel`(input: DeleteEmailLabelInput!)	Soft-delete	DeleteEmailLabelPayload

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.

EmailLabelEntity object 13 fields: isDeleteProtected, id, isDeleted, …

Personal label a user applies to email conversations to organize their mailbox; labels can be nested.

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.
`owner`	ClientEntity	Client who created this label; labels are personal and not shared with teammates.
`parentEmailLabel`	EmailLabelEntity	Parent label this one is nested under, or empty for a top-level label.
`color`	Int!	Color the label is displayed with, as a packed RGB integer.
`name`	String!	Name of the entity and its default text representation.
`ownerId`	ID!	Id of the client who created this label.
`parentEmailLabelId`	ID	Id of the parent label this one is nested under, or empty for a top-level label.
`revision`	Int	Revision when entity was lastly changed.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.

EmailLabelEntityConnection object pageInfo: PageInfo!, edges: [EmailLabelEntityEdge]!, totalCount: Int

Paginated list of EmailLabel records.

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

EmailLabelEntityEdge object node: EmailLabelEntity, cursor: String!

A Relay edge containing a EmailLabelEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[EmailLabelFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[EmailLabelFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	EmailLabelFilterInput	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.
`color`	EntityFilterNumberField	Color the label is displayed with, as a packed RGB integer.
`name`	EntityFilterStringField	Name of the entity and its default text representation.
`ownerId`	EntityFilterStringField	Id of the client who created this label.
`parentEmailLabelId`	EntityFilterStringField	Id of the parent label this one is nested under, or empty for a top-level label.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`owner`	ClientFilterInput	Client who created this label; labels are personal and not shared with teammates. Matches records where a related record meets these conditions.
`parentEmailLabel`	EmailLabelFilterInput	Parent label this one is nested under, or empty for a top-level label. Matches records where a related record meets these conditions.

EmailLabelOrderByInput input Asc or Desc per field

Sorting of EmailLabel 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.
`owner`	[ClientOrderByNestedInput!]	Client who created this label; labels are personal and not shared with teammates. Sorts by fields of the related record, listed in order of priority.
`parentEmailLabel`	[EmailLabelOrderByNestedInput!]	Parent label this one is nested under, or empty for a top-level label. Sorts by fields of the related record, listed in order of priority.
`color`	OrderByEnum	Color the label is displayed with, as a packed RGB integer.
`name`	OrderByEnum	Name of the entity and its default text representation.
`ownerId`	OrderByEnum	Id of the client who created this label.
`parentEmailLabelId`	OrderByEnum	Id of the parent label this one is nested under, or empty for a top-level label.
`revision`	OrderByEnum	Revision when entity was lastly changed.

CreateEmailLabelInput input 9 fields: clientMutationId, modified, created, …

Field values of a new EmailLabel record.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`parentEmailLabel`	CreateEmailLabelInput	Parent label this one is nested under, or empty for a top-level label.
`color`	Int!	Color the label is displayed with, as a packed RGB integer.
`name`	String!	Name of the entity and its default text representation.
`ownerId`	ID!	Id of the client who created this label.
`parentEmailLabelId`	ID	Id of the parent label this one is nested under, or empty for a top-level label.
`revision`	Int	Revision when entity was lastly changed.

CreateOrUpdateEmailLabelInput input 10 fields: clientMutationId, id, modified, …

Field values of an EmailLabel record to create, or to update when its id is set.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID	Unique identifier of entity.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`parentEmailLabel`	CreateEmailLabelInput	Parent label this one is nested under, or empty for a top-level label.
`color`	Int	Color the label is displayed with, as a packed RGB integer.
`name`	String	Name of the entity and its default text representation.
`ownerId`	ID	Id of the client who created this label.
`parentEmailLabelId`	ID	Id of the parent label this one is nested under, or empty for a top-level label.
`revision`	Int	Revision when entity was lastly changed.

DeleteEmailLabelInput input clientMutationId: String, id: ID!

Id of the EmailLabel record to delete.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID!	Unique identifier of entity.

UpdateEmailLabelInput input 10 fields: clientMutationId, id, modified, …

Id of an EmailLabel record and the field values to change.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID!	Unique identifier of entity.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`parentEmailLabel`	CreateEmailLabelInput	Parent label this one is nested under, or empty for a top-level label.
`color`	Int	Color the label is displayed with, as a packed RGB integer.
`name`	String	Name of the entity and its default text representation.
`ownerId`	ID	Id of the client who created this label.
`parentEmailLabelId`	ID	Id of the parent label this one is nested under, or empty for a top-level label.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateEmailLabelPayload object result: BulkUpdateResults!

Result of the bulkUpdateEmailLabel mutation.

Field	Type	Description
`result`	BulkUpdateResults!	Ids of the created, updated and deleted records, and the items that failed.

CreateEmailLabelPayload object emailLabel: EmailLabelEntity, clientMutationId: String

Result of the createEmailLabel mutation.

Field	Type	Description
`emailLabel`	EmailLabelEntity	The created record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

DeleteEmailLabelPayload object emailLabel: EmailLabelEntity, clientMutationId: String

Result of the deleteEmailLabel mutation.

Field	Type	Description
`emailLabel`	EmailLabelEntity	The deleted record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

UpdateEmailLabelPayload object emailLabel: EmailLabelEntity, clientMutationId: String

Result of the updateEmailLabel mutation.

Field	Type	Description
`emailLabel`	EmailLabelEntity	The updated record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).