--- title: "openemail.drafts" description: "Every method in this namespace: its signature, its parameters, what it returns and an example." url: "https://openemail.uk/docs/sdk/reference/drafts" area: "SDK" category: "Reference" --- # openemail.drafts Every method in this namespace: its signature, its parameters, what it returns and an example. ## Methods Unsent messages saved in the mailbox. ### `drafts.list()` List one page of drafts ```ts list(options?: DraftListOptions): Promise> ``` 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. Scopes: `drafts:read`. **Parameters** - `options.query` (`string`): 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. - `options.limit` (`number`): Drafts per page, a whole number from 1 to 100. Defaults to 25. - `options.cursor` (`string`): The `nextCursor` of the previous page, passed back unchanged. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `Page` with `items`, `hasMore` and `nextCursor`. Each item is `{ object: 'draft', id }`. **Example** ```ts 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) } ``` **Notes** - The server offers a cursor whenever a page comes back full, so `hasMore` 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. Also available in: API [`GET /drafts`](https://openemail.uk/docs/api/reference/drafts#get-drafts); CLI [`openemail drafts list`](https://openemail.uk/docs/cli/reference/drafts#drafts-list). ### `drafts.listAll()` Collect every draft into one array ```ts listAll(options?: DraftListOptions): Promise> ``` 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. Scopes: `drafts:read`. **Parameters** - `options.query` (`string`): 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. - `options.limit` (`number`): Page size for each request, a whole number from 1 to 100. Defaults to 25. - `options.cursor` (`string`): A `nextCursor` to start the walk from instead of the first page. - `options.signal` (`AbortSignal`): Cancels the request in flight and rejects the whole walk. - `options.apiKey` (`string`): Overrides the client's API key for every page of this walk. **Returns** `Array`, every matching draft as `{ object: 'draft', id }`, most recently saved first. **Example** ```ts const drafts = await openemail.drafts.listAll({ limit: 100 }) console.log(`${drafts.length} drafts waiting`) ``` **Notes** - 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. Also available in: API [`GET /drafts`](https://openemail.uk/docs/api/reference/drafts#get-drafts). ### `drafts.iterate()` Stream drafts one at a time across pages ```ts iterate(options?: DraftListOptions): AsyncGenerator ``` 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. Scopes: `drafts:read`. **Parameters** - `options.query` (`string`): 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. - `options.limit` (`number`): Page size for each request, a whole number from 1 to 100. Defaults to 25. - `options.cursor` (`string`): A `nextCursor` to start from instead of the first page. - `options.signal` (`AbortSignal`): Cancels the request in flight and ends the iteration with that error. - `options.apiKey` (`string`): Overrides the client's API key for every page of this walk. **Returns** `AsyncGenerator` yielding `{ object: 'draft', id }` per step. **Example** ```ts 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) } } ``` **Notes** - The generator is lazy, so an abandoned loop costs only the pages it consumed. Also available in: API [`GET /drafts`](https://openemail.uk/docs/api/reference/drafts#get-drafts). ### `drafts.get()` Read a draft's recipients, subject and body ```ts get(id: string, options?: RequestScope): Promise ``` 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. Scopes: `drafts:read`. **Parameters** - `id` (`string`, required): Draft id, which starts with `draft-`. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `DraftResource` with `id`, `to`, `cc`, `bcc`, `subject`, `html`, `from`, `threadId` and `attachments` as `{ filename, contentType }`. **Example** ```ts 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') ``` **Notes** - A draft keeps the same id through every update. - A missing draft throws `OpenEmailApiError` with `isNotFound` true. Also available in: API [`GET /drafts/{id}`](https://openemail.uk/docs/api/reference/drafts#get-drafts-id); CLI [`openemail drafts get`](https://openemail.uk/docs/cli/reference/drafts#drafts-get). ### `drafts.create()` Save a new draft ```ts create(body: DraftInput, options?: RequestScope): Promise ``` 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 `, 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. Scopes: `drafts:write`. **Parameters** - `body.to` (`Array`): Recipient addresses, bare or with a display name. - `body.cc` (`Array`): Copy recipients, bare or with a display name. - `body.bcc` (`Array`): Blind copy recipients, bare or with a display name. - `body.subject` (`string`): At most 998 characters. Empty is stored as `(no subject)`. - `body.html` (`string`): Body markup, at most 1,000,000 characters. Kept over `text` when both are set. - `body.text` (`string`): Body used only when `html` is absent, at most 1,000,000 characters. Stored as is and read back in `html`. - `body.from` (`string`): Sender address, optionally with a display name. Left out, the draft is saved with no sender. - `body.threadId` (`string`): Id of the thread this draft replies to. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `SavedDraftResource`, `{ object: 'draft', id }`, where `id` is the new draft's id. **Example** ```ts const draft = await openemail.drafts.create({ from: 'Ada Lovelace ', to: ['grace@example.com'], subject: 'Engine notes for Thursday', html: '

Agenda below, comments welcome.

' }) console.log(draft.id) ``` **Notes** - 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. Also available in: API [`POST /drafts`](https://openemail.uk/docs/api/reference/drafts#post-drafts); CLI [`openemail drafts create`](https://openemail.uk/docs/cli/reference/drafts#drafts-create). ### `drafts.update()` Change fields on a saved draft ```ts update(id: string, body: DraftInput, options?: RequestScope): Promise ``` 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. Scopes: `drafts:write`. **Parameters** - `id` (`string`, required): Draft id, which starts with `draft-`. - `body.to` (`Array`): Replacement recipients. An empty array clears them. - `body.cc` (`Array`): Replacement copy recipients. - `body.bcc` (`Array`): Replacement blind copy recipients. - `body.subject` (`string`): Replacement subject, at most 998 characters. - `body.html` (`string`): Replacement body markup, at most 1,000,000 characters. - `body.text` (`string`): Replacement body used only when `html` is absent. - `body.from` (`string`): Replacement sender. An empty string clears it, leaving the draft with no sender. - `body.threadId` (`string`): Thread the draft replies to. An empty string detaches it. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `SavedDraftResource`, `{ object: 'draft', id }`. **Example** ```ts const saved = await openemail.drafts.update('draft-5f0c2a9e-8b1d-4e7a-a3c6-2d9f41b7e0c8', { to: ['grace@example.com', 'charles@example.com'], subject: 'Engine notes for Thursday, revised' }) const draft = await openemail.drafts.get(saved.id) console.log(draft.to, draft.subject) ``` **Notes** - The SDK does not retry this call after a network failure. Read the draft with `get` before trying again. - An empty string is the only way to clear `threadId` or `from`, since leaving a field out keeps its stored value. Also available in: API [`PATCH /drafts/{id}`](https://openemail.uk/docs/api/reference/drafts#patch-drafts-id); CLI [`openemail drafts update`](https://openemail.uk/docs/cli/reference/drafts#drafts-update). ### `drafts.delete()` Delete a draft permanently ```ts delete(id: string, options?: RequestScope): Promise ``` 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. Scopes: `drafts:write`. **Parameters** - `id` (`string`, required): Draft id, which starts with `draft-`. - `options.signal` (`AbortSignal`): Cancels the request. - `options.apiKey` (`string`): Overrides the client's API key for this call only. **Returns** `DeletedDraftResource`, `{ object: 'draft', id, deleted: true }`. **Example** ```ts const removed = await openemail.drafts.delete('draft-5f0c2a9e-8b1d-4e7a-a3c6-2d9f41b7e0c8') console.log(removed.id, removed.deleted) ``` **Notes** - 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. Also available in: API [`DELETE /drafts/{id}`](https://openemail.uk/docs/api/reference/drafts#delete-drafts-id); CLI [`openemail drafts delete`](https://openemail.uk/docs/cli/reference/drafts#drafts-delete).