openemail.drafts
Каждый метод этого пространства имён: его сигнатура, параметры, что он возвращает, и пример.
Методы
Unsent messages saved in the mailbox.
drafts.list()
List one page of drafts
list(options?: DraftListOptions): Promise<Page<DraftSummaryResource>>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 nextCursor and accepts as options.cursor. A page holds 25 drafts unless options.limit says otherwise.
Параметры
options.querystringMailbox 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:andolder_than:30dnarrow it.to:,cc:andbcc:match nothing on a draft, and the search cannot leave drafts.options.limitnumberDrafts per page, a whole number from 1 to 100. Defaults to 25.
options.cursorstringThe
nextCursorof the previous page, passed back unchanged.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Возвращает
Page<DraftSummaryResource> with items, hasMore and nextCursor. Each item is { object: 'draft', id }.
Пример
const page = await openemail.drafts.list({ query: 'subject:proposal', limit: 20 }) for (const summary of page.items) { const draft = await openemail.drafts.get(summary.id) console.log(draft.id, draft.subject, draft.to)}Примечания
The server offers a cursor whenever a page comes back full, so
hasMorecan 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
querycannot use is ignored rather than narrowing, so a typo in a value widens the result instead of emptying it. That coverscategory:,larger:,smaller:,size:,messagesize:,list:,rfc822msgid:,received:andsent:, the category words such asis:promotions, ahas:word naming no kind of attachment, animportance:other thanhighorlow, an unreadable date and a duration whose unit is noth,d,w,mory. An operator name it does not know,project:for instance, is searched as plain text.
Также доступно в
drafts.listAll()
Collect every draft into one array
listAll(options?: DraftListOptions): Promise<Array<DraftSummaryResource>>Walks every page with the same query as list and resolves 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 options.limit drafts, 25 when you leave it out. Passing options.cursor starts the walk from that page instead of the first. The walk ends at the first empty page or when the server stops offering a cursor, and a failure on any page rejects the promise and discards what was collected.
Параметры
options.querystringMailbox 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 assubject:andolder_than:30dnarrow it.to:,cc:andbcc:match nothing on a draft, and the search cannot leave drafts.options.limitnumberPage size for each request, a whole number from 1 to 100. Defaults to 25.
options.cursorstringA
nextCursorto start the walk from instead of the first page.options.signalAbortSignalCancels the request in flight and rejects the whole walk.
options.apiKeystringOverrides the client's API key for every page of this walk.
Возвращает
Array<DraftSummaryResource>, every matching draft as { object: 'draft', id }, most recently saved first.
Пример
const drafts = await openemail.drafts.listAll({ limit: 100 }) console.log(`${drafts.length} drafts waiting`)Примечания
Rows are ids only. Reading each draft afterwards is one
getper id.Each page is its own request with its own retries, so one failed attempt does not restart the walk.
Также доступно в
- API
GET /drafts
drafts.iterate()
Stream drafts one at a time across pages
iterate(options?: DraftListOptions): AsyncGenerator<DraftSummaryResource, void, undefined>Returns an async generator that yields drafts one by one and requests the next page only when the current one is used up. 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.
Параметры
options.querystringMailbox 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 assubject:andolder_than:30dnarrow it.to:,cc:andbcc:match nothing on a draft, and the search cannot leave drafts.options.limitnumberPage size for each request, a whole number from 1 to 100. Defaults to 25.
options.cursorstringA
nextCursorto start from instead of the first page.options.signalAbortSignalCancels the request in flight and ends the iteration with that error.
options.apiKeystringOverrides the client's API key for every page of this walk.
Возвращает
AsyncGenerator<DraftSummaryResource, void, undefined> yielding { object: 'draft', id } per step.
Пример
for await (const summary of openemail.drafts.iterate({ query: 'older_than:30d' })) { const draft = await openemail.drafts.get(summary.id) if (draft.to.length === 0 && draft.subject === '(no subject)') { await openemail.drafts.delete(draft.id) }}Примечания
The generator is lazy, so an abandoned loop costs only the pages it consumed.
Также доступно в
- API
GET /drafts
drafts.get()
Read a draft's recipients, subject and body
get(id: string, options?: RequestScope): Promise<DraftResource>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: null, as does a draft saved without a sender. A draft saved with text and no html returns that text in html, unconverted.
threadId is null 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.
Параметры
idstringОбязательноDraft id, which starts with
draft-.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Возвращает
DraftResource with id, to, cc, bcc, subject, html, from, threadId and attachments as { filename, contentType }.
Пример
const draft = await openemail.drafts.get('draft-5f0c2a9e-8b1d-4e7a-a3c6-2d9f41b7e0c8') console.log(draft.from, draft.to, draft.subject)console.log(draft.threadId ?? 'starts a new conversation')Примечания
A draft keeps the same id through every update.
A missing draft throws
OpenEmailApiErrorwithisNotFoundtrue.
Также доступно в
drafts.create()
Save a new draft
create(body: DraftInput, options?: RequestScope): Promise<SavedDraftResource>Saves an unsent message to the mailbox and returns its id. Every field is optional, so an empty object 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 null. 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.
Параметры
body.toArray<string>Recipient addresses, bare or with a display name.
body.ccArray<string>Copy recipients, bare or with a display name.
body.bccArray<string>Blind copy recipients, bare or with a display name.
body.subjectstringAt most 998 characters. Empty is stored as
(no subject).body.htmlstringBody markup, at most 1,000,000 characters. Kept over
textwhen both are set.body.textstringBody used only when
htmlis absent, at most 1,000,000 characters. Stored as is and read back inhtml.body.fromstringSender address, optionally with a display name. Left out, the draft is saved with no sender.
body.threadIdstringId of the thread this draft replies to.
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Возвращает
SavedDraftResource, { object: 'draft', id }, where id is the new draft's id.
Пример
const draft = await openemail.drafts.create({ from: 'Ada Lovelace <[email protected]>', to: ['[email protected]'], subject: 'Engine notes for Thursday', html: '<p>Agenda below, comments welcome.</p>'}) console.log(draft.id)Примечания
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.
Также доступно в
drafts.update()
Change fields on a saved draft
update(id: string, body: DraftInput, options?: RequestScope): Promise<SavedDraftResource>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.
Параметры
idstringОбязательноDraft id, which starts with
draft-.body.toArray<string>Replacement recipients. An empty array clears them.
body.ccArray<string>Replacement copy recipients.
body.bccArray<string>Replacement blind copy recipients.
body.subjectstringReplacement subject, at most 998 characters.
body.htmlstringReplacement body markup, at most 1,000,000 characters.
body.textstringReplacement body used only when
htmlis absent.body.fromstringReplacement sender. An empty string clears it, leaving the draft with no sender.
body.threadIdstringThread the draft replies to. An empty string detaches it.
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Возвращает
SavedDraftResource, { object: 'draft', id }.
Пример
const saved = await openemail.drafts.update('draft-5f0c2a9e-8b1d-4e7a-a3c6-2d9f41b7e0c8', { to: ['[email protected]', '[email protected]'], subject: 'Engine notes for Thursday, revised'}) const draft = await openemail.drafts.get(saved.id)console.log(draft.to, draft.subject)Примечания
The SDK does not retry this call after a network failure. Read the draft with
getbefore trying again.An empty string is the only way to clear
threadIdorfrom, since leaving a field out keeps its stored value.
Также доступно в
drafts.delete()
Delete a draft permanently
delete(id: string, options?: RequestScope): Promise<DeletedDraftResource>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.
Параметры
idstringОбязательноDraft id, which starts with
draft-.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client's API key for this call only.
Возвращает
DeletedDraftResource, { object: 'draft', id, deleted: true }.
Пример
const removed = await openemail.drafts.delete('draft-5f0c2a9e-8b1d-4e7a-a3c6-2d9f41b7e0c8') console.log(removed.id, removed.deleted)Примечания
The SDK does not retry a delete. A 404 on your own second attempt after a lost response means the first one worked.
threads.updaterefusesDRAFTwith 422label_not_directly_settable, so an ordinary thread can never be turned into something this method deletes.