Ruby

client.drafts

Chaque méthode de cet espace de noms : sa signature, ses paramètres, ce qu'elle retourne et un exemple.

Méthodes

Unsent messages saved in the mailbox.

`drafts.list`

List one page of drafts

drafts:readParcourt les résultats page par page

Signature

list(query: nil, limit: nil, cursor: nil, api_key: nil) -> OpenEmail::Page

Returns one page of saved drafts, most recently saved first. A row is only object and id, so call get for recipients, subject and body. A draft is stored as a thread labelled DRAFT, so this reads the same index as threads.list(folder: "draft").

query takes the same search syntax as threads.list. Plain words must all appear and match loosely, ignoring case, accents and separators, against the draft's subject, its sender and the first 4,000 characters of its body with markup stripped, while a quoted phrase is matched as written apart from case and accents, so "ben jamin" does not find "Ben-Jamin". Filler words such as the or emails are dropped when something else is left to search for. Recipients are stored as one list without roles and are not written for a draft, so to:, cc: and bcc: match nothing here. subject:, body: and from: narrow the search, and after:, before:, newer_than: and older_than: read the time the draft was last saved, in UTC, with after: including the day it names and before: excluding it. A draft saved with no subject is stored as (no subject), so subject:"no subject" finds it. The drafts folder always applies, so in: and folder is: operators such as is:sent cannot widen the search beyond drafts, in:anywhere included.

The API pages with an opaque pageToken, which the SDK hands back as next_cursor and accepts as cursor:. A page holds 25 drafts unless limit: says otherwise.

Paramètres

queryString: Mailbox search over the subject, sender and body preview. Plain words must all appear and match loosely, a quoted phrase has to appear as written, filler words are dropped when something else is left to search for, and operators such as subject: and older_than:30d narrow it. to:, cc: and bcc: match nothing on a draft, and the search cannot leave drafts.
limitInteger: Drafts per page, a whole number from 1 to 100. Defaults to 25.
cursorString: The next_cursor of the previous page, passed back unchanged.
api_keyString: Overrides the client's API key for this call only.

Retourne

An OpenEmail::Page of Hashes, with items, has_more? and next_cursor. Each item has only object, set to draft, and id.

Exemple

page = client.drafts.list(query: "subject:proposal", limit: 20) page.items.each do |summary|  draft = client.drafts.get(summary[:id])  p draft.values_at(:id, :subject, :to)end

Remarques

The server offers a cursor whenever a page comes back full, so has_more? can be true on the last page and the following call returns no items.
Saving a draft moves it to the top, so a draft edited while you page is not returned by later pages.
A value query cannot use is ignored rather than narrowing, so a typo in a value widens the result instead of emptying it. That covers category:, larger:, smaller:, size:, messagesize:, list:, rfc822msgid:, received: and sent:, the category words such as is:promotions, a has: word naming no kind of attachment, an importance: other than high or low, an unreadable date and a duration whose unit is not h, d, w, m or y. An operator name it does not know, project: for instance, is searched as plain text.

Aussi disponible dans

API: GET /drafts
TypeScript: drafts.list()
Python: drafts.list()
CLI: openemail drafts list

`drafts.list_all`

Collect every draft into one array

drafts:readParcourt les résultats page par page

Signature

list_all(query: nil, limit: nil, cursor: nil, api_key: nil) -> Array<Hash>

Walks every page with the same query as list and returns once the last page is in, so the whole result sits in memory at once. Drafts rarely number in the thousands, which makes this the simplest way to read them all.

Each request asks for limit: drafts, 25 when you leave it out. Passing cursor: starts the walk from that page instead of the first. The walk ends when the server stops offering a cursor or hands back the one it was given, and a failure on any page raises and discards what was collected.

Paramètres

queryString: Mailbox search over the subject, sender and body preview, as in list. Plain words must all appear and match loosely, a quoted phrase has to appear as written, filler words are dropped when something else is left to search for, and operators such as subject: and older_than:30d narrow it. to:, cc: and bcc: match nothing on a draft, and the search cannot leave drafts.
limitInteger: Page size for each request, a whole number from 1 to 100. Defaults to 25.
cursorString: A next_cursor to start the walk from instead of the first page.
api_keyString: Overrides the client's API key for every page of this walk.

Retourne

An Array of Hashes, every matching draft with object set to draft and its id, most recently saved first.

Exemple

drafts = client.drafts.list_all(limit: 100) puts "#{drafts.size} drafts waiting"

Remarques

Rows are ids only. Reading each draft afterwards is one get per id.
Each page is its own request with its own retries, so one failed attempt does not restart the walk.

Aussi disponible dans

API: GET /drafts
TypeScript: drafts.listAll()
Python: drafts.list_all()

`drafts.iterate`

Stream drafts one at a time across pages

drafts:readParcourt les résultats page par page

Signature

iterate(query: nil, limit: nil, cursor: nil, api_key: nil, &block) -> Enumerator<Hash>

Returns an Enumerator that yields drafts one by one and requests the next page only when the current one is used up. Given a block, it yields each draft to the block instead. Nothing is fetched until the loop starts, and breaking out of it stops further requests.

The cursor marks a position in save time rather than a row count, so deleting drafts inside the loop does not make the walk skip the ones after them. Updating a draft during the walk moves it to the top, and it is not yielded a second time.

Paramètres

queryString: Mailbox search over the subject, sender and body preview, as in list. Plain words must all appear and match loosely, a quoted phrase has to appear as written, filler words are dropped when something else is left to search for, and operators such as subject: and older_than:30d narrow it. to:, cc: and bcc: match nothing on a draft, and the search cannot leave drafts.
limitInteger: Page size for each request, a whole number from 1 to 100. Defaults to 25.
cursorString: A next_cursor to start from instead of the first page.
api_keyString: Overrides the client's API key for every page of this walk.

Retourne

An Enumerator of Hashes, each with object set to draft and id (or yields each one to a block).

Exemple

client.drafts.iterate(query: "older_than:30d") do |summary|  draft = client.drafts.get(summary[:id])   client.drafts.delete(draft[:id]) if draft[:to].empty? && draft[:subject] == "(no subject)"end

Remarques

The Enumerator is lazy, so an abandoned loop costs only the pages it consumed.

Aussi disponible dans

API: GET /drafts
TypeScript: drafts.iterate()
Python: drafts.iterate()

`drafts.get`

Read a draft's recipients, subject and body

drafts:read

Signature

get(id, api_key: nil) -> Hash

Returns the fields a draft was saved with: to, cc, bcc, subject, the body as html, the from address, the threadId it replies to and its attachment list. The id must belong to a thread labelled DRAFT, so an ordinary thread id is a 404 here even though threads.get opens it.

Values come back normalised rather than as sent. Recipients are bare addresses with display names dropped, an empty subject reads as (no subject), and from is the address the draft was saved with. It is reported only while the workspace can still send as the stored sender, so a draft saved from an address that has since gone reads from: nil, as does a draft saved without a sender. A draft saved with text and no html returns that text in html, unconverted.

threadId is nil for a draft that does not reply to anything. attachments carries only filename and contentType, because draft attachments are stored as names and types without content.

Paramètres

idStringObligatoire: Draft id, which starts with draft-.
api_keyString: Overrides the client's API key for this call only.

Retourne

A Hash with id, to, cc, bcc, subject, html, from, threadId and attachments, an Array of Hashes with filename and contentType.

Exemple

draft = client.drafts.get("draft-5f0c2a9e-8b1d-4e7a-a3c6-2d9f41b7e0c8") p draft.values_at(:from, :to, :subject)puts draft[:threadId] || "starts a new conversation"

Remarques

A draft keeps the same id through every update.
A missing draft raises OpenEmail::NotFoundError, an OpenEmail::ApiError with not_found? true.

Aussi disponible dans

API: GET /drafts/{id}
TypeScript: drafts.get()
Python: drafts.get()
CLI: openemail drafts get

`drafts.create`

Save a new draft

drafts:write

Signature

create(body = nil, api_key: nil, **fields) -> Hash

Saves an unsent message to the mailbox and returns its id. Every field is optional, so a call with no fields saves a blank draft. The body is strict: any key outside the fields below is a 422 invalid_parameter, and there is no field for attachments.

Nothing is validated beyond length. Addresses in to, cc and bcc may carry a display name, as in Ada Lovelace <[email protected]>, and from is stored as given. A draft saved without from has no sender, and get reads from back as nil. subject is capped at 998 characters, and html and text at 1,000,000 each. When both bodies are sent only html is kept.

threadId records the conversation the draft replies to, but the draft is stored as a thread of its own under its new id. It shows up in threads.list(folder: "draft"), not inside the original thread.

Paramètres

toArray<String>: Recipient addresses, bare or with a display name.
ccArray<String>: Copy recipients, bare or with a display name.
bccArray<String>: Blind copy recipients, bare or with a display name.
subjectString: At most 998 characters. Empty is stored as (no subject).
htmlString: Body markup, at most 1,000,000 characters. Kept over text when both are set.
textString: Body used only when html is absent, at most 1,000,000 characters. Stored as is and read back in html.
fromString: Sender address, optionally with a display name. Left out, the draft is saved with no sender.
threadIdString: Id of the thread this draft replies to.
api_keyString: Overrides the client's API key for this call only.

Retourne

A Hash with object set to draft and id, the new draft's id.

Exemple

draft = client.drafts.create(  from: "Ada Lovelace <[email protected]>",  to: ["[email protected]"],  subject: "Engine notes for Thursday",  html: "<p>Agenda below, comments welcome.</p>") puts draft[:id]

Remarques

The SDK does not retry a create after a network failure, because the endpoint takes no idempotency key and a second attempt saves a second draft.
A display name containing a comma splits into two broken recipients, because the lists are joined and split again on commas. Send such names without the comma.
Draft ids are draft- followed by a UUID.

Aussi disponible dans

API: POST /drafts
TypeScript: drafts.create()
Python: drafts.create()
CLI: openemail drafts create

`drafts.update`

Change fields on a saved draft

drafts:write

Signature

update(id, body = nil, api_key: nil, **fields) -> Hash

A partial update: each field you send replaces the stored value and each field you leave out keeps it. Arrays replace wholesale, so sending to with one address drops the rest. The limits and the strict body are the same as create.

The draft must already exist. An unknown id, or the id of a thread that is not a draft, is a 404 rather than a new draft. The returned id is the one to keep using, and it is always the id you passed.

Sending text without html replaces the stored body with that text. An update also empties the draft's attachment list, because draft attachments are stored as names and types without content and only entries with content are carried over.

Paramètres

idStringObligatoire: Draft id, which starts with draft-.
toArray<String>: Replacement recipients. An empty Array clears them.
ccArray<String>: Replacement copy recipients.
bccArray<String>: Replacement blind copy recipients.
subjectString: Replacement subject, at most 998 characters.
htmlString: Replacement body markup, at most 1,000,000 characters.
textString: Replacement body used only when html is absent.
fromString: Replacement sender. An empty string clears it, leaving the draft with no sender.
threadIdString: Thread the draft replies to. An empty string detaches it.
api_keyString: Overrides the client's API key for this call only.

Retourne

A Hash with object set to draft and id, the id you passed.

Exemple

saved = client.drafts.update(  "draft-5f0c2a9e-8b1d-4e7a-a3c6-2d9f41b7e0c8",  to: ["[email protected]", "[email protected]"],  subject: "Engine notes for Thursday, revised") draft = client.drafts.get(saved[:id])p draft.values_at(:to, :subject)

Remarques

The SDK does not retry this call after a network failure. Read the draft with get before trying again.
Leaving a field out keeps its stored value. An empty string clears threadId, and an empty string or nil clears from.

Aussi disponible dans

API: PATCH /drafts/{id}
TypeScript: drafts.update()
Python: drafts.update()
CLI: openemail drafts update

`drafts.delete`

Delete a draft permanently

drafts:write

Signature

delete(id, api_key: nil) -> Hash

Removes the draft, its stored body and its attachment entries from the mailbox. It does not go to the Bin and there is no undo.

The id must belong to a thread carrying the DRAFT label, so an ordinary thread id is a 404. Use threads.trash to remove real mail.

Paramètres

idStringObligatoire: Draft id, which starts with draft-.
api_keyString: Overrides the client's API key for this call only.

Retourne

A Hash with object set to draft, the id and deleted set to true.

Exemple

removed = client.drafts.delete("draft-5f0c2a9e-8b1d-4e7a-a3c6-2d9f41b7e0c8") puts removed[:id], removed[:deleted]

Remarques

The SDK does not retry a delete. A 404 on your own second attempt after a lost response means the first one worked.
threads.update refuses DRAFT with 422 label_not_directly_settable, so an ordinary thread can never be turned into something this method deletes.

Aussi disponible dans

API: DELETE /drafts/{id}
TypeScript: drafts.delete()
Python: drafts.delete()
CLI: openemail drafts delete

client.drafts

Méthodes

Paramètres

Retourne

Exemple

Remarques

Aussi disponible dans

Paramètres

Retourne

Exemple

Remarques

Aussi disponible dans

Paramètres

Retourne

Exemple

Remarques

Aussi disponible dans

Paramètres

Retourne

Exemple

Remarques

Aussi disponible dans

Paramètres

Retourne

Exemple

Remarques

Aussi disponible dans

Paramètres

Retourne

Exemple

Remarques

Aussi disponible dans

Paramètres

Retourne

Exemple

Remarques

Aussi disponible dans

Votre boîte de réception,à vos conditions.

Votre boîte de réception,
à vos conditions.