Python

openemail.labels

इस नेमस्पेस का हर मेथड: उसका सिग्नेचर, उसके पैरामीटर, वह क्या लौटाता है और एक उदाहरण।

मेथड

The labels a thread can carry.

`labels.list()`

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

labels:readनतीजों को पेज दर पेज लाता है

सिग्नेचर

def list(    *,    limit: int | None = None,    cursor: str | None = None,    api_key: str | None = None,    timeout: float | None = None,) -> Page[LabelResource]

Returns one page of the workspace's user labels, sorted by name and then by id. list_all collects every page into one list and iterate 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.update takes them, but they cannot be renamed, recoloured or deleted.

color is None 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.

पैरामीटर

limitint: Page size, from 1 to 100. The server defaults to 25.
cursorstr: The nextCursor of the previous page, passed back as it came. Leave it out for the first page.
api_keystr: Overrides the client API key for this call only.
timeoutfloat: Seconds this call may take, the response included, before it raises OpenEmailNetworkError with is_timeout. It overrides the client's timeout for this call, and 0 turns the limit off.

लौटाता है

Page[LabelResource], a dict with items, hasMore and nextCursor. Each item has id, name, type, color, threadCount, createdAt and updatedAt.

उदाहरण

from openemail import openemail page = openemail.labels.list(limit=50) for label in page['items']:    print(label['name'], label['threadCount']) if page['hasMore']:    print('more after', page['nextCursor'])

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.

इनमें भी उपलब्ध

API: GET /labels
TypeScript: labels.list()
Ruby: labels.list
CLI: openemail labels list

`labels.list_all()`

Collect every label into one list

labels:readनतीजों को पेज दर पेज लाता है

सिग्नेचर

def list_all(    *,    limit: int | None = None,    cursor: str | None = None,    api_key: str | None = None,    timeout: float | None = None,) -> builtins.list[LabelResource]

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

पैरामीटर

limitint: Page size for each request, from 1 to 100. The server defaults to 25.
cursorstr: Starts the walk after this cursor instead of the first page.
api_keystr: Overrides the client API key for every page of this walk.
timeoutfloat: Seconds this call may take, the response included, before it raises OpenEmailNetworkError with is_timeout. It overrides the client's timeout for this call, and 0 turns the limit off.

लौटाता है

list[LabelResource] holding every label.

उदाहरण

from openemail import openemail labels = openemail.labels.list_all(limit=100)ids_by_name = {label['name']: label['id'] for label in labels} receipts = ids_by_name.get('Receipts') if receipts is not None:    openemail.threads.update('thr_8f2c41d0a3b94e6f', {'addLabelIds': [receipts]})

इनमें भी उपलब्ध

API: GET /labels
TypeScript: labels.listAll()
Ruby: labels.list_all

`labels.iterate()`

Stream the labels one at a time

labels:readनतीजों को पेज दर पेज लाता है

सिग्नेचर

def iterate(    *,    limit: int | None = None,    cursor: str | None = None,    api_key: str | None = None,    timeout: float | None = None,) -> Iterator[LabelResource]

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 it stops the requests.

पैरामीटर

limitint: Page size for each request, from 1 to 100. The server defaults to 25.
cursorstr: Starts the walk after this cursor instead of the first page.
api_keystr: Overrides the client API key for every page of this walk.
timeoutfloat: Seconds this call may take, the response included, before it raises OpenEmailNetworkError with is_timeout. It overrides the client's timeout for this call, and 0 turns the limit off.

लौटाता है

Iterator[LabelResource], a generator yielding one label per step.

उदाहरण

from openemail import openemail for label in openemail.labels.iterate():    if label['threadCount'] == 0:        print('unused', label['name'])

इनमें भी उपलब्ध

API: GET /labels
TypeScript: labels.iterate()
Ruby: labels.iterate

`labels.list_colors()`

List the colours the app offers for labels

labels:read

सिग्नेचर

def list_colors(    *,    api_key: str | None = None,    timeout: float | None = None,) -> builtins.list[LabelColorResource]

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.

पैरामीटर

api_keystr: Overrides the client API key for this call only.
timeoutfloat: Seconds this call may take, the response included, before it raises OpenEmailNetworkError with is_timeout. It overrides the client's timeout for this call, and 0 turns the limit off.

लौटाता है

list[LabelColorResource], each with kind, name, value, solid, from, to and textColor.

उदाहरण

from openemail import openemail colors = openemail.labels.list_colors()sunset = next((color for color in colors if color['name'] == 'sunset'), None) label = openemail.labels.create(    {'name': 'Launch', 'color': {'backgroundColor': sunset['value'] if sunset else '#EF4444'}})print(label['id'], label['color'])

इनमें भी उपलब्ध

API: GET /labels/colors
TypeScript: labels.listColors()
Ruby: labels.list_colors
CLI: openemail labels list-colors

`labels.get()`

Read one user label by id

labels:read

सिग्नेचर

def get(    id: str,    *,    api_key: str | None = None,    timeout: float | None = None,) -> LabelResource

Looks up a single user label and returns it in the same shape as a row of list, 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.

पैरामीटर

idstrआवश्यक: Label id such as USER_RECEIPTS, matched case sensitively.
api_keystr: Overrides the client API key for this call only.
timeoutfloat: Seconds this call may take, the response included, before it raises OpenEmailNetworkError with is_timeout. It overrides the client's timeout for this call, and 0 turns the limit off.

लौटाता है

LabelResource with id, name, type (always user), color, threadCount, createdAt and updatedAt.

उदाहरण

from openemail import openemail label = openemail.labels.get('USER_RECEIPTS')color = label['color'] print(label['name'], color['backgroundColor'] if color else 'no colour', label['threadCount'])

इनमें भी उपलब्ध

API: GET /labels/{id}
TypeScript: labels.get()
Ruby: labels.get
CLI: openemail labels get

`labels.create()`

Create a user label

labels:write

सिग्नेचर

def create(    body: LabelInput,    *,    api_key: str | None = None,    timeout: float | None = None,) -> LabelResource

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 with param set to color.backgroundColor. list_colors 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.

पैरामीटर

body['name']strआवश्यक: Display name, trimmed, 1 to 225 characters. Also decides the id.
body['color']LabelColorInput: The colour. Leave it out for a label with no colour.
body['color']['backgroundColor']strआवश्यक: A hex colour such as #3B82F6 or a gradient token such as gradient:sunset, at most 32 characters. Required once color is given.
body['color']['textColor']str: Accepted and ignored. The ink is worked out from backgroundColor.
api_keystr: Overrides the client API key for this call only.
timeoutfloat: Seconds this call may take, the response included, before it raises OpenEmailNetworkError with is_timeout. It overrides the client's timeout for this call, and 0 turns the limit off.

लौटाता है

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

उदाहरण

from openemail import openemail label = openemail.labels.create(    {'name': 'Big Clients', 'color': {'backgroundColor': 'gradient:aurora'}})color = label['color'] print(label['id'], color['textColor'] if color else None)

इनमें भी उपलब्ध

API: POST /labels
TypeScript: labels.create()
Ruby: labels.create
CLI: openemail labels create

`labels.update()`

Rename or recolour a user label

labels:write

सिग्नेचर

def update(    id: str,    patch: LabelPatch,    *,    api_key: str | None = None,    timeout: float | None = None,) -> LabelResource

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

पैरामीटर

idstrआवश्यक: Label id such as USER_RECEIPTS.
patch['name']str: New display name, trimmed, 1 to 225 characters. Left out, the name stays.
patch['color']LabelColorInput | None: New colour. None clears it, and leaving it out keeps the stored colour.
patch['color']['backgroundColor']strआवश्यक: A hex colour or a gradient token, at most 32 characters. An empty string clears the colour.
patch['color']['textColor']str: Accepted and ignored. The ink is worked out from backgroundColor.
api_keystr: Overrides the client API key for this call only.
timeoutfloat: Seconds this call may take, the response included, before it raises OpenEmailNetworkError with is_timeout. It overrides the client's timeout for this call, and 0 turns the limit off.

लौटाता है

LabelResource with the unchanged id and the new name and color.

उदाहरण

from openemail import openemail saved = openemail.labels.update('USER_RECEIPTS', {'color': {'backgroundColor': '#EA9602'}})color = saved['color'] print(saved['id'], saved['name'], color['backgroundColor'] if color else None)

इनमें भी उपलब्ध

API: PATCH /labels/{id}
TypeScript: labels.update()
Ruby: labels.update
CLI: openemail labels update

`labels.delete()`

Delete a user label and remove it from every thread

labels:write

सिग्नेचर

def delete(    id: str,    *,    api_key: str | None = None,    timeout: float | None = None,) -> DeletedLabelResource

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.

पैरामीटर

idstrआवश्यक: Label id such as USER_OLD_PROJECT.
api_keystr: Overrides the client API key for this call only.
timeoutfloat: Seconds this call may take, the response included, before it raises OpenEmailNetworkError with is_timeout. It overrides the client's timeout for this call, and 0 turns the limit off.

लौटाता है

DeletedLabelResource with object set to label, the id, and deleted set to True.

उदाहरण

from openemail import openemail removed = openemail.labels.delete('USER_OLD_PROJECT') print(removed['id'], removed['deleted'])

इनमें भी उपलब्ध

API: DELETE /labels/{id}
TypeScript: labels.delete()
Ruby: labels.delete
CLI: openemail labels delete

openemail.labels

मेथड

पैरामीटर

लौटाता है

उदाहरण

टिप्पणियाँ

इनमें भी उपलब्ध

पैरामीटर

लौटाता है

उदाहरण

टिप्पणियाँ

इनमें भी उपलब्ध

पैरामीटर

लौटाता है

उदाहरण

टिप्पणियाँ

इनमें भी उपलब्ध

पैरामीटर

लौटाता है

उदाहरण

टिप्पणियाँ

इनमें भी उपलब्ध

पैरामीटर

लौटाता है

उदाहरण

टिप्पणियाँ

इनमें भी उपलब्ध

पैरामीटर

लौटाता है

उदाहरण

टिप्पणियाँ

इनमें भी उपलब्ध

पैरामीटर

लौटाता है

उदाहरण

टिप्पणियाँ

इनमें भी उपलब्ध

पैरामीटर

लौटाता है

उदाहरण

टिप्पणियाँ

इनमें भी उपलब्ध

आपका इनबॉक्स,आपकी अपनी शर्तों पर।

आपका इनबॉक्स,
आपकी अपनी शर्तों पर।