client.Labels

Cada método deste espaço de nomes: a sua assinatura, os seus parâmetros, o que devolve e um exemplo.

Métodos

The user labels a thread can carry: list, create, rename, recolour and delete them, and read the palette of colours the app offers.

`Labels.ListAsync`

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

labels:readPercorre os resultados por páginas

Assinatura

Task<Page> ListAsync(    int? limit = null,    string? cursor = null,    string? apiKey = null,    CancellationToken cancellationToken = default)

Returns one page of the workspace's user labels, sorted by name and then by id. Labels.ListAllAsync collects every page and Labels.IterateAsync walks them lazily. Each label carries its colour, threadCount (how many conversations carry it now) 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.UpdateAsync 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.

Parâmetros

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.
cancellationTokenCancellationToken: Cancels the request.

Devolve

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

Exemplo

var page = await client.Labels.ListAsync(limit: 50); foreach (var label in page){    Console.WriteLine($"{label["id"]} {label["name"]} on {label["threadCount"]} conversations, {label["color"]?["backgroundColor"]?.ToString() ?? "no colour"}");} if (page.HasMore){    var next = await client.Labels.ListAsync(limit: 50, cursor: page.NextCursor);     Console.WriteLine($"{next.Count} more");}

Notas

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.

Também disponível em

API: GET /labels
TypeScript: labels.list()
Python: labels.list()
Ruby: labels.list
PHP: labels->list
Go: Labels.List
Java: labels().list
CLI: openemail labels list

`Labels.ListAllAsync`

Collect every label into one object

labels:readPercorre os resultados por páginas

Assinatura

Task<IReadOnlyList<JsonObject>> ListAllAsync(    int? limit = null,    string? cursor = null,    string? apiKey = null,    CancellationToken cancellationToken = default)

Walks every page of Labels.ListAsync and returns all labels in one object, sorted by name and then by id. One request per page.

Parâmetros

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.
cancellationTokenCancellationToken: Cancels the request.

Devolve

A list of label objects holding every label.

Exemplo

var labels = await client.Labels.ListAllAsync(limit: 100); Console.WriteLine(labels.Count);

Notas

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

Também disponível em

API: GET /labels
TypeScript: labels.listAll()
Python: labels.list_all()
Ruby: labels.list_all
PHP: labels->listAll
Go: Labels.ListAll
Java: labels().listAll

`Labels.IterateAsync`

Stream the labels one at a time

labels:readPercorre os resultados por páginas

Assinatura

IAsyncEnumerable<JsonObject> IterateAsync(    int? limit = null,    string? cursor = null,    string? apiKey = null,    CancellationToken cancellationToken = default)

Returns an IAsyncEnumerable<JsonObject> 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 await foreach stops the requests.

Parâmetros

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.
cancellationTokenCancellationToken: Cancels the request.

Devolve

An IAsyncEnumerable<JsonObject> that yields one label per step.

Exemplo

await foreach (var label in client.Labels.IterateAsync()){    if ((int?)label["threadCount"] == 0)    {        Console.WriteLine($"{label["name"]} is on no conversation");    }}

Notas

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

Também disponível em

API: GET /labels
TypeScript: labels.iterate()
Python: labels.iterate()
Ruby: labels.iterate
PHP: labels->iterate
Go: Labels.Iterate
Java: labels().iterate

`Labels.ListColorsAsync`

List the colours the app offers for labels

labels:read

Assinatura

Task<IReadOnlyList<JsonObject>> ListColorsAsync(    string? apiKey = null,    CancellationToken cancellationToken = default)

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.

Parâmetros

apiKeystring?: Overrides the client's API key for this call only.
cancellationTokenCancellationToken: Cancels the request.

Devolve

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

Exemplo

var colors = await client.Labels.ListColorsAsync(); foreach (var color in colors){    Console.WriteLine($"{color["kind"]} {color["name"]} {color["value"]} with {color["textColor"]} text");}

Notas

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

Também disponível em

API: GET /labels/colors
TypeScript: labels.listColors()
Python: labels.list_colors()
Ruby: labels.list_colors
PHP: labels->listColors
Go: Labels.ListColors
Java: labels().listColors
CLI: openemail labels list-colors

`Labels.GetAsync`

Read one user label by id

labels:read

Assinatura

Task<JsonObject> GetAsync(    string id,    string? apiKey = null,    CancellationToken cancellationToken = default)

Looks up a single user label and returns it in the same shape as a row of Labels.ListAsync, with its colour, threadCount, 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.

Parâmetros

idstringObrigatório: Label id such as USER_RECEIPTS, matched case sensitively.
apiKeystring?: Overrides the client's API key for this call only.
cancellationTokenCancellationToken: Cancels the request.

Devolve

A JsonObject with id, name, type set to user, color, threadCount, createdAt and updatedAt.

Exemplo

try{    var label = await client.Labels.GetAsync("USER_RECEIPTS");     Console.WriteLine($"{label["name"]} is on {label["threadCount"]} conversations");}catch (OpenEmailApiException error) when (error.IsNotFound){    Console.WriteLine("No such label");}

Notas

A missing label throws an OpenEmailApiException whose IsNotFound is true and whose Code is resource_not_found.

Também disponível em

API: GET /labels/{id}
TypeScript: labels.get()
Python: labels.get()
Ruby: labels.get
PHP: labels->get
Go: Labels.Get
Java: labels().get
CLI: openemail labels get

`Labels.CreateAsync`

Create a user label

labels:write

Assinatura

Task<JsonObject> CreateAsync(    IReadOnlyDictionary<string, object?> body,    string? apiKey = null,    CancellationToken cancellationToken = default)

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.ListColorsAsync 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.

Parâmetros

namestringObrigatório: Display name, trimmed, 1 to 225 characters. Also decides the id.
colordictionary: The colour, a dictionary 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.
apiKeystring?: Overrides the client's API key for this call only.
cancellationTokenCancellationToken: Cancels the request.

Devolve

A JsonObject with the new id, the trimmed name, color, threadCount of 0, createdAt and updatedAt.

Exemplo

try{    var label = await client.Labels.CreateAsync(new Body    {        ["name"] = "Big Clients",        ["color"] = new Body { ["backgroundColor"] = "#3B82F6" },    });     Console.WriteLine($"Created {label["id"]}");}catch (OpenEmailApiException error) when (error.IsConflict){    Console.WriteLine($"That name is taken: {error.Code}");}

Notas

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.

Também disponível em

API: POST /labels
TypeScript: labels.create()
Python: labels.create()
Ruby: labels.create
PHP: labels->create
Go: Labels.Create
Java: labels().create
CLI: openemail labels create

`Labels.UpdateAsync`

Rename or recolour a user label

labels:write

Assinatura

Task<JsonObject> UpdateAsync(    string id,    IReadOnlyDictionary<string, object?> patch,    string? apiKey = null,    CancellationToken cancellationToken = default)

Renames a label, recolours it, or both, and returns it as it is stored. Send name, color or both: a field left out stays as it is, and a patch with neither 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.CreateAsync: 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.

Parâmetros

idstringObrigatório: Label id such as USER_RECEIPTS.
namestring: New display name, trimmed, 1 to 225 characters. Left out, the name stays.
colordictionary: New colour, a dictionary 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.
apiKeystring?: Overrides the client's API key for this call only.
cancellationTokenCancellationToken: Cancels the request.

Devolve

A JsonObject with the unchanged id and the new name and color.

Exemplo

var label = await client.Labels.UpdateAsync("USER_RECEIPTS", new Body{    ["name"] = "Invoices",    ["color"] = new Body { ["backgroundColor"] = "gradient:sunset" },}); Console.WriteLine($"{label["id"]} is now called {label["name"]}"); await client.Labels.UpdateAsync("USER_RECEIPTS", new Body { ["color"] = null });

Notas

The SDK retries this call after a network failure, since the same patch sent twice leaves the same label.

Também disponível em

API: PATCH /labels/{id}
TypeScript: labels.update()
Python: labels.update()
Ruby: labels.update
PHP: labels->update
Go: Labels.Update
Java: labels().update
CLI: openemail labels update

`Labels.TestAsync`

Try a label on recent mail

labels:writethreads:read

Assinatura

Task<JsonObject> TestAsync(    string id,    IReadOnlyDictionary<string, object?>? body = null,    string? apiKey = null,    CancellationToken cancellationToken = default)

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 it 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.

Parâmetros

idstringObrigatório: Label id such as USER_RECEIPTS, as ListAsync 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.
cancellationTokenCancellationToken: Cancels the request.
apiKeystring?: Overrides the client API key for this call only.

Devolve

A JsonObject, { object: 'label_test', labelId, examined, matched }. examined is how many recent threads were read, and each match is { threadId, subject, sender, receivedOn }, with sender the address the newest message is from and receivedOn when it arrived, as its Date header gives it, or null.

Exemplo

var trial = await client.Labels.TestAsync("USER_RECEIPTS", new Body { ["aiInstructions"] = "Receipts and invoices for something we paid for" }); Console.WriteLine($"{trial["matched"]?.AsArray().Count} of {trial["examined"]} recent threads would get the label"); foreach (var match in trial["matched"]?.AsArray() ?? []){    Console.WriteLine($"{match?["sender"]}: {match?["subject"]}");}

Notas

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 an install with no AI model set up a 409 ai_not_configured.
Nothing is saved: the label keeps the instructions it had. Save the wording with UpdateAsync once it catches what you want.
The SDK does not retry it, because each call spends an AI action.

Também disponível em

API: POST /labels/{id}/test
TypeScript: labels.test()
Python: labels.test()
Ruby: labels.test
PHP: labels->test
Go: Labels.Test
Java: labels().test
CLI: openemail labels test

`Labels.DeleteAsync`

Delete a user label and remove it from every thread

labels:write

Assinatura

Task<JsonObject> DeleteAsync(    string id,    string? apiKey = null,    CancellationToken cancellationToken = default)

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.

Parâmetros

idstringObrigatório: Label id such as USER_OLD_PROJECT.
apiKeystring?: Overrides the client's API key for this call only.
cancellationTokenCancellationToken: Cancels the request.

Devolve

A JsonObject with object set to label, id and deleted set to true.

Exemplo

var label = await client.Labels.GetAsync("USER_OLD_PROJECT"); var deleted = await client.Labels.DeleteAsync(label["id"]!.GetValue<string>()); if ((bool?)deleted["deleted"] == true){    Console.WriteLine($"Removed from {label["threadCount"]} conversations");}

Notas

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.GetAsync first if you want to say how many conversations will lose the label: its threadCount is that number.

Também disponível em

API: DELETE /labels/{id}
TypeScript: labels.delete()
Python: labels.delete()
Ruby: labels.delete
PHP: labels->delete
Go: Labels.Delete
Java: labels().delete
CLI: openemail labels delete

client.Labels

Métodos

Parâmetros

Devolve

Exemplo

Notas

Também disponível em

Parâmetros

Devolve

Exemplo

Notas

Também disponível em

Parâmetros

Devolve

Exemplo

Notas

Também disponível em

Parâmetros

Devolve

Exemplo

Notas

Também disponível em

Parâmetros

Devolve

Exemplo

Notas

Também disponível em

Parâmetros

Devolve

Exemplo

Notas

Também disponível em

Parâmetros

Devolve

Exemplo

Notas

Também disponível em

Parâmetros

Devolve

Exemplo

Notas

Também disponível em

Parâmetros

Devolve

Exemplo

Notas

Também disponível em

A sua caixa de entrada,nos seus termos.

A sua caixa de entrada,
nos seus termos.