PHP

$client->labels

Every method in this namespace: its signature, its parameters, what it returns and an example.

Methods

The user labels a thread can carry: list, create, rename, recolour and delete them, have AI apply one to arriving mail and try it on recent mail first, and read the palette of colours the app offers.

`labels->list`

List the workspace's labels, a page at a time

labels:readPages through results

Signature

list(?int $limit = null, ?string $cursor = null, ?string $apiKey = null): Page

Returns one page of the workspace's user labels, sorted by name and then by id. labels->listAll collects every page and labels->iterate walks them lazily. Each label carries its colour, threadCount (how many conversations carry it now), aiInstructions and aiEnabled, which say whether AI applies it to arriving mail, and createdAt and updatedAt, which is everything the Labels table in the app shows.

System labels such as INBOX, STARRED and UNREAD are not listed. A thread carries them and threads->update takes them, but they cannot be renamed, recoloured or deleted.

color is null on a label saved with no colour. Otherwise color.backgroundColor is a hex value or a gradient token such as gradient:sunset, and color.textColor is the ink the app draws on it, worked out on the server rather than stored.

Parameters

limitint: Page size, from 1 to 100. The server defaults to 25.
cursorstring: The nextCursor of the previous page, passed back as it came. Leave it out for the first page.
apiKeystring: Overrides the client's API key for this call only.

Returns

A Page of label arrays, with items, hasMore and nextCursor. Each item has id, name, type, color, threadCount, aiInstructions, aiEnabled, createdAt and updatedAt.

Example

$page = $client->labels->list(limit: 50); foreach ($page as $label) {    echo $label['id'], ' ', $label['name'], ' on ', $label['threadCount'], ' conversations, ', $label['color']['backgroundColor'] ?? 'no colour', PHP_EOL;} if ($page->hasMore) {    $next = $client->labels->list(limit: 50, cursor: $page->nextCursor);     echo count($next), ' more', PHP_EOL;}

Notes

Labels belong to the workspace, so a narrowed key still sees every label. threadCount is the exception: it counts only conversations delivered to the addresses the key holds.
An id is fixed when the label is created and survives a rename, so match on id rather than name in stored configuration.
The sidebar order in the app is each person's own arrangement and is not exposed.
The cursor is opaque and holds where the last row sat in this order, so a row deleted or edited between pages never breaks the walk: the next page starts at the first row that sorts after it. A cursor this list did not hand out is a 400 invalid_cursor.

Also available in

API: GET /labels
TypeScript: nextmail.labels.list()
Python: labels.list()
Ruby: labels.list
Go: Labels.List
Java: labels().list
C#: Labels.ListAsync
CLI: openemail labels list

`labels->listAll`

Collect every label into one array

labels:readPages through results

Signature

listAll(?int $limit = null, ?string $cursor = null, ?string $apiKey = null): array

Walks every page of labels->list and returns all labels in one array, sorted by name and then by id. One request per page.

Parameters

limitint: Page size for each request, from 1 to 100. The server defaults to 25.
cursorstring: Starts the walk after this cursor instead of the first page.
apiKeystring: Overrides the client's API key for every page of this walk.

Returns

A list of label arrays holding every label.

Example

$labels = $client->labels->listAll(limit: 100); $idsByName = array_column($labels, 'id', 'name'); echo count($labels), ' labels, Receipts is ', $idsByName['Receipts'] ?? 'missing', PHP_EOL;

Notes

If any page fails, the exception is thrown and the labels already fetched are discarded.

Also available in

API: GET /labels
TypeScript: nextmail.labels.listAll()
Python: labels.list_all()
Ruby: labels.list_all
Go: Labels.ListAll
Java: labels().listAll
C#: Labels.ListAllAsync

`labels->iterate`

Stream the labels one at a time

labels:readPages through results

Signature

iterate(?int $limit = null, ?string $cursor = null, ?string $apiKey = null): Generator

Returns a Generator that yields labels one at a time, sorted by name and then by id, and requests the next page only once the current one is used up. Nothing is fetched until the loop starts, and breaking out of the foreach stops the requests.

Parameters

limitint: Page size for each request, from 1 to 100. The server defaults to 25.
cursorstring: Starts the walk after this cursor instead of the first page.
apiKeystring: Overrides the client's API key for every page of this walk.

Returns

A Generator that yields one label array per step.

Example

foreach ($client->labels->iterate() as $label) {    if ($label['threadCount'] === 0) {        echo $label['name'], ' is on no conversation', PHP_EOL;    }}

Notes

The generator is lazy, so an abandoned loop costs only the pages you consumed.

Also available in

API: GET /labels
TypeScript: nextmail.labels.iterate()
Python: labels.iterate()
Ruby: labels.iterate
Go: Labels.Iterate
Java: labels().iterate
C#: Labels.IterateAsync

`labels->listColors`

List the colours the app offers for labels

labels:read

Signature

listColors(?string $apiKey = null): array

Returns the whole label palette as a plain list: the fourteen solid colours and seven gradients the app offers when you make or edit a label, in the order it shows them. It is a fixed catalogue, so there is no paging. Fetch it once and keep it.

value is what to send as color.backgroundColor: a hex such as #3B82F6 for a solid, a token such as gradient:sunset for a gradient. textColor is the ink drawn on it. A gradient also carries from and to, drawn at 135 degrees, and solid, one hex for places a gradient cannot go.

A label may carry a colour outside this list. Any hex set through the API is kept as it is, and the app offers it back as its own swatch.

Parameters

apiKeystring: Overrides the client's API key for this call only.

Returns

A list of arrays, each with kind, name, value, solid, from, to and textColor.

Example

$colors = $client->labels->listColors(); foreach ($colors as $color) {    echo $color['kind'], ' ', $color['name'], ' ', $color['value'], ' with ', $color['textColor'], ' text', PHP_EOL;}

Notes

kind is solid or gradient. from and to are null on a solid.

Also available in

API: GET /labels/colors
TypeScript: nextmail.labels.listColors()
Python: labels.list_colors()
Ruby: labels.list_colors
Go: Labels.ListColors
Java: labels().listColors
C#: Labels.ListColorsAsync
CLI: openemail labels list-colors

`labels->get`

Read one user label by id

labels:read

Signature

get(string $id, ?string $apiKey = null): array

Looks up a single user label and returns it in the same shape as a row of labels->list, with its colour, threadCount, aiInstructions, aiEnabled, createdAt and updatedAt.

Only user labels are served. INBOX, TRASH and the other system ids are a 404 here even though threads carry them. Ids are matched exactly, so user_receipts does not find USER_RECEIPTS.

Parameters

idstringRequired: Label id such as USER_RECEIPTS, matched case sensitively.
apiKeystring: Overrides the client's API key for this call only.

Returns

An array with id, name, type set to user, color, threadCount, aiInstructions, aiEnabled, createdAt and updatedAt.

Example

use Nextmail\Exception\NotFoundException; try {    $label = $client->labels->get('USER_RECEIPTS');     echo $label['name'], ' is on ', $label['threadCount'], ' conversations', PHP_EOL;} catch (NotFoundException) {    echo 'No such label', PHP_EOL;}

Notes

A missing label throws a NotFoundException, whose isNotFound() is true and whose errorCode is resource_not_found.

Also available in

API: GET /labels/{id}
TypeScript: nextmail.labels.get()
Python: labels.get()
Ruby: labels.get
Go: Labels.Get
Java: labels().get
C#: Labels.GetAsync
CLI: openemail labels get

`labels->create`

Create a user label

labels:write

Signature

create(array $body, ?string $apiKey = null): array

Creates a label and returns it as it is stored. name is trimmed and must then be 1 to 225 characters. The id is derived from the name as USER_ followed by the name upper cased, with each run of whitespace turned into _, so Big Clients becomes USER_BIG_CLIENTS, and it never changes afterwards.

A name another label already has, compared without case, is refused with 409 label_name_taken, and so is a name whose id another label holds because it was created under that name and renamed since. An existing label is never silently overwritten. A workspace holds at most 50 user labels, and the call past that is a 422 label_limit_reached on name.

color is optional. color.backgroundColor is a hex colour (#RGB, #RGBA, #RRGGBB or #RRGGBBAA, stored upper cased) or a gradient token such as gradient:sunset, and anything else is a 422 invalid_parameter on color.backgroundColor. labels->listColors returns the palette the app offers. textColor may be sent but is ignored: the ink is worked out from the background. Leaving color out stores no colour.

aiInstructions says what the label is for in plain words, such as invoices and receipts. With aiEnabled on, AI reads each arriving message against them and adds the label when it fits. It skips spam, the Bin, encrypted mail and muted threads, and it only labels: it never archives or moves anything. Turning aiEnabled on needs instructions and a paid plan, and a workspace may have 10 such labels. Without instructions it is a 422 invalid_parameter on aiInstructions, on the free plan a 403 plan_required, and past the tenth a 422 ai_label_limit_reached.

Parameters

namestringRequired: Display name, trimmed, 1 to 225 characters. Also decides the id.
colorarray: The colour, an array with backgroundColor. Leave it out for a label with no colour.
color.backgroundColorstring: A hex colour such as #3B82F6 or a gradient token such as gradient:sunset, at most 32 characters. Required once color is given.
color.textColorstring: Accepted and ignored. The ink is worked out from backgroundColor.
aiInstructionsstring|null: What the label is for, in plain words, up to 500 characters, such as invoices and receipts.
aiEnabledbool: Have AI apply the label to arriving mail that fits aiInstructions. It needs instructions and a paid plan, and a workspace may have 10 such labels.
apiKeystring: Overrides the client's API key for this call only.

Returns

An array with the new id, the trimmed name, color, threadCount of 0, aiInstructions, aiEnabled, createdAt and updatedAt.

Example

use Nextmail\Exception\ConflictException; try {    $label = $client->labels->create([        'name' => 'Big Clients',        'color' => ['backgroundColor' => '#3B82F6'],    ]);     echo 'Created ', $label['id'], PHP_EOL;} catch (ConflictException $error) {    echo 'That name is taken: ', $error->errorCode, PHP_EOL;}

Notes

The SDK does not retry a create after a network failure. If you retry by hand after a lost response, a 409 label_name_taken means the first attempt succeeded.
The label is created before its AI settings are saved, so a create refused with plan_required, ai_label_limit_reached or invalid_parameter on aiInstructions leaves the label in place with no instructions and aiEnabled off. Set them with update rather than creating it again.
test runs the instructions over recent mail and shows what they would catch, without labelling anything.

Also available in

API: POST /labels
TypeScript: nextmail.labels.create()
Python: labels.create()
Ruby: labels.create
Go: Labels.Create
Java: labels().create
C#: Labels.CreateAsync
CLI: openemail labels create

`labels->update`

Rename or recolour a user label, or change what AI does with it

labels:write

Signature

update(string $id, array $patch, ?string $apiKey = null): array

Renames a label, recolours it, or changes what AI does with it, and returns it as it is stored. Send any of name, color, aiInstructions and aiEnabled: a field left out stays as it is, and a patch with none of them is a 422. 'color' => null, or an empty backgroundColor, clears the colour.

The id never changes. A label created as Receipts keeps USER_RECEIPTS after a rename to Invoices, and every thread keeps the label. A new name another label already has, compared without case, is refused with 409 label_name_taken.

Colours follow the rules on labels->create: a hex value or a gradient token, and anything else is a 422 invalid_parameter. Only user labels can be changed, and a system label id is a 404.

With aiEnabled on, AI reads each arriving message against aiInstructions and adds the label when it fits. It skips spam, the Bin, encrypted mail and muted threads, and it only labels: it never archives or moves anything. Turning it on needs instructions and a paid plan, and a workspace may have 10 such labels. Without instructions it is a 422 invalid_parameter on aiInstructions, on the free plan a 403 plan_required, and past the tenth a 422 ai_label_limit_reached. 'aiInstructions' => null clears the instructions, which also turns aiEnabled off.

Parameters

idstringRequired: Label id such as USER_RECEIPTS.
namestring: New display name, trimmed, 1 to 225 characters. Left out, the name stays.
colorarray|null: New colour, an array with backgroundColor. Null clears it, and leaving it out keeps the stored colour.
color.backgroundColorstring: A hex colour or a gradient token, at most 32 characters. An empty string clears the colour.
color.textColorstring: Accepted and ignored. The ink is worked out from backgroundColor.
aiInstructionsstring|null: What the label is for, in plain words, up to 500 characters. Null clears it, which also turns aiEnabled off. Left out, it stays.
aiEnabledbool: Whether AI applies the label to arriving mail that fits aiInstructions. Turning it on needs instructions and a paid plan, and a workspace may have 10 such labels. Left out, it stays.
apiKeystring: Overrides the client's API key for this call only.

Returns

An array with the unchanged id and the new name, color, aiInstructions and aiEnabled.

Example

$label = $client->labels->update('USER_RECEIPTS', [    'name' => 'Invoices',    'color' => ['backgroundColor' => 'gradient:sunset'],]); echo $label['id'], ' is now called ', $label['name'], PHP_EOL; $client->labels->update('USER_RECEIPTS', ['color' => null]); $sorted = $client->labels->update('USER_RECEIPTS', [    'aiInstructions' => 'invoices and receipts',    'aiEnabled' => true,]); echo $sorted['aiEnabled'] ? 'AI applies it to mail that fits: ' : 'AI leaves it alone: ', $sorted['aiInstructions'] ?? 'no instructions', PHP_EOL;

Notes

The SDK retries this call after a network failure, since the same patch sent twice leaves the same label.
test runs instructions over recent mail and shows what they would catch, so you can try wording before you save it here.

Also available in

API: PATCH /labels/{id}
TypeScript: nextmail.labels.update()
Python: labels.update()
Ruby: labels.update
Go: Labels.Update
Java: labels().update
C#: Labels.UpdateAsync
CLI: openemail labels update

`labels->test`

Try a label on recent mail

labels:writethreads:read

Signature

test(string $id, ?array $body = null, ?string $apiKey = null): array

Runs the AI over the newest 20 inbox threads and returns the ones the label would catch, without labelling anything. Send aiInstructions to try wording you have not saved yet, or leave the body out to try what the label holds.

It spends one AI action of the caller, which the labelling of arriving mail never does. A message that arrived encrypted is skipped, and a key limited to particular addresses reads only the threads delivered to them.

Parameters

idstringRequired: Label id such as USER_RECEIPTS, as list returns it.
aiInstructionsstring: What the label is for, in plain words, 1 to 500 characters. Left out, the instructions saved on the label are tried.
apiKeystring: Overrides the client's API key for this call only.

Returns

An array with object set to label_test, labelId, examined and matched. examined is how many recent threads were read, and each match is an array with threadId, subject, sender and receivedOn, where sender is the address the newest message is from and receivedOn is when it arrived, as its Date header gives it, or null.

Example

$result = $client->labels->test('USER_RECEIPTS', ['aiInstructions' => 'invoices and receipts']); echo count($result['matched']), ' of ', $result['examined'], ' would get the label', PHP_EOL; foreach ($result['matched'] as $match) {    echo $match['sender'], ': ', $match['subject'], PHP_EOL;}

Notes

Needs both labels:write and threads:read. An unknown label id is a 404.
With no instructions to try, neither in the call nor on the label, it is a 422 invalid_parameter. A spent AI allowance is a 429 ai_quota_exceeded, and a 409 ai_not_configured while AI is unavailable.
Nothing is saved: the label keeps the instructions it had. Save the wording with update once it catches what you want.
The SDK does not retry it, because each call spends an AI action.

Also available in

API: POST /labels/{id}/test
TypeScript: nextmail.labels.test()
Python: labels.test()
Ruby: labels.test
Go: Labels.Test
Java: labels().test
C#: Labels.TestAsync
CLI: openemail labels test

`labels->delete`

Delete a user label and remove it from every thread

labels:write

Signature

delete(string $id, ?string $apiKey = null): array

Deletes a user label and, in the same transaction, takes it off every thread that carried it. The threads are otherwise untouched, so a thread that was only filed under this label stays in whatever folder it was in.

There is no undo. Creating a label with the same name again produces the same id, but the threads it was removed from do not get it back. Only user labels can be deleted, and a system label id is a 404.

Parameters

idstringRequired: Label id such as USER_OLD_PROJECT.
apiKeystring: Overrides the client's API key for this call only.

Returns

An array with object set to label, id and deleted set to true.

Example

$label = $client->labels->get('USER_OLD_PROJECT'); $deleted = $client->labels->delete($label['id']); if ($deleted['deleted']) {    echo 'Removed from ', $label['threadCount'], ' conversations', PHP_EOL;}

Notes

The SDK does not retry a delete. A 404 on your own second attempt after a lost response means the first one worked.
Call labels->get first if you want to say how many conversations will lose the label: its threadCount is that number.

Also available in

API: DELETE /labels/{id}
TypeScript: nextmail.labels.delete()
Python: labels.delete()
Ruby: labels.delete
Go: Labels.Delete
Java: labels().delete
C#: Labels.DeleteAsync
CLI: openemail labels delete

$client->labels

Methods

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Parameters

Returns

Example

Notes

Also available in

Your inbox,on your own terms.

Your inbox,
on your own terms.