client.Drafts

パラメーター

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.

limitint?

Drafts per page, a whole number from 1 to 100. Defaults to 25.

cursorstring?

The nextCursor of the previous page, passed back unchanged.

apiKeystring?

Overrides the client's API key for this call only.

cancellationTokenCancellationToken

Cancels the request.

戻り値

例

var page = await client.Drafts.ListAsync(query: "subject:proposal", limit: 20); foreach (var summary in page){    var draft = await client.Drafts.GetAsync(summary["id"]!.GetValue<string>());     Console.WriteLine($"{draft["subject"]} to {string.Join(", ", draft["to"]?.AsArray() ?? [])}");}

注意事項

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

ほかの提供先

API

GET /drafts

TypeScript

drafts.list()

Python

drafts.list()

Ruby

drafts.list

PHP

drafts->list

Go

Drafts.List

Java

drafts().list

CLI

openemail drafts list

パラメーター

querystring?

Mailbox search over the subject, sender and body preview, as in ListAsync. 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.

limitint?

Page size for each request, a whole number from 1 to 100. Defaults to 25.

cursorstring?

A nextCursor to start the walk from instead of the first page.

apiKeystring?

Overrides the client's API key for every page of this walk.

cancellationTokenCancellationToken

Cancels the request.

戻り値

例

var drafts = await client.Drafts.ListAllAsync(limit: 100); Console.WriteLine($"{string.Join(Environment.NewLine, drafts.Select(row => row?["id"]))}");

注意事項

• Rows are ids only. Reading each draft afterwards is one GetAsync per id.

• Each page is its own request with its own retries, so one failed attempt does not restart the walk.

ほかの提供先

API

GET /drafts

TypeScript

drafts.listAll()

Python

drafts.list_all()

Ruby

drafts.list_all

PHP

drafts->listAll

Go

Drafts.ListAll

Java

drafts().listAll

パラメーター

querystring?

Mailbox search over the subject, sender and body preview, as in ListAsync. 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.

limitint?

Page size for each request, a whole number from 1 to 100. Defaults to 25.

cursorstring?

A nextCursor to start from instead of the first page.

apiKeystring?

Overrides the client's API key for every page of this walk.

cancellationTokenCancellationToken

Cancels the request.

戻り値

例

await foreach (var summary in client.Drafts.IterateAsync(query: "older_than:30d")){    var draft = await client.Drafts.GetAsync(summary["id"]!.GetValue<string>());     if ((draft["to"]?.AsArray().Count ?? 0) == 0 && (string?)draft["subject"] == "(no subject)")    {        await client.Drafts.DeleteAsync(draft["id"]!.GetValue<string>());    }}

注意事項

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

ほかの提供先

API

GET /drafts

TypeScript

drafts.iterate()

Python

drafts.iterate()

Ruby

drafts.iterate

PHP

drafts->iterate

Go

Drafts.Iterate

Java

drafts().iterate

パラメーター

idstring必須

Draft id, which starts with draft-.

apiKeystring?

Overrides the client's API key for this call only.

cancellationTokenCancellationToken

Cancels the request.

戻り値

例

var draft = await client.Drafts.GetAsync("draft-5f0c2a9e-8b1d-4e7a-a3c6-2d9f41b7e0c8"); Console.WriteLine($"{draft["from"]?.ToString() ?? "no sender"} to {string.Join(", ", draft["to"]?.AsArray() ?? [])}");Console.WriteLine($"{draft["subject"]}");Console.WriteLine($"{draft["threadId"]?.ToString() ?? "starts a new conversation"}");

注意事項

• A draft keeps the same id through every update.

• A missing draft throws an OpenEmailApiException whose IsNotFound is true.

ほかの提供先

API

GET /drafts/{id}

TypeScript

drafts.get()

Python

drafts.get()

Ruby

drafts.get

PHP

drafts->get

Go

Drafts.Get

Java

drafts().get

CLI

openemail drafts get

パラメーター

toIEnumerable<string>

Recipient addresses, bare or with a display name.

ccIEnumerable<string>

Copy recipients, bare or with a display name.

bccIEnumerable<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, or the thread holding the message forwardOf names.

forwardOfstring

Id of the message in threadId to forward. Sending the draft quotes it below the body and attaches its files.

apiKeystring?

Overrides the client's API key for this call only.

cancellationTokenCancellationToken

Cancels the request.

戻り値

例

var draft = await client.Drafts.CreateAsync(new Body{    ["from"] = "Ada Lovelace <[email protected]>",    ["to"] = new[] { "[email protected]" },    ["subject"] = "Engine notes for Thursday",    ["html"] = "<p>Agenda below, comments welcome.</p>",}); Console.WriteLine($"{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.

ほかの提供先

API

POST /drafts

TypeScript

drafts.create()

Python

drafts.create()

Ruby

drafts.create

PHP

drafts->create

Go

Drafts.Create

Java

drafts().create

CLI

openemail drafts create

パラメーター

idstring必須

Draft id, which starts with draft-.

toIEnumerable<string>

Replacement recipients. An empty dictionary clears them.

ccIEnumerable<string>

Replacement copy recipients.

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

apiKeystring?

Overrides the client's API key for this call only.

cancellationTokenCancellationToken

Cancels the request.

戻り値

例

var saved = await client.Drafts.UpdateAsync("draft-5f0c2a9e-8b1d-4e7a-a3c6-2d9f41b7e0c8", new Body{    ["to"] = new[] { "[email protected]", "[email protected]" },    ["subject"] = "Engine notes for Thursday, revised",}); var draft = await client.Drafts.GetAsync(saved["id"]!.GetValue<string>()); Console.WriteLine($"{draft["subject"]} to {string.Join(", ", draft["to"]?.AsArray() ?? [])}");

注意事項

• The SDK does not retry this call after a network failure. Read the draft with GetAsync before trying again.

• Leaving a field out keeps its stored value. An empty string clears threadId, and an empty string or null clears from.

ほかの提供先

API

PATCH /drafts/{id}

TypeScript

drafts.update()

Python

drafts.update()

Ruby

drafts.update

PHP

drafts->update

Go

Drafts.Update

Java

drafts().update

CLI

openemail drafts update

パラメーター

idstring必須

Draft id, which starts with draft-.

apiKeystring?

Overrides the client's API key for this call only.

cancellationTokenCancellationToken

Cancels the request.

戻り値

例

var removed = await client.Drafts.DeleteAsync("draft-5f0c2a9e-8b1d-4e7a-a3c6-2d9f41b7e0c8"); Console.WriteLine($"{removed["id"]}{((bool?)removed["deleted"] == true ? " is gone" : " is still there")}");

注意事項

• The SDK does not retry a delete. A 404 on your own second attempt after a lost response means the first one worked.

• Threads.UpdateAsync refuses DRAFT with 422 label_not_directly_settable, so an ordinary thread can never be turned into something this method deletes.

ほかの提供先

API

DELETE /drafts/{id}

TypeScript

drafts.delete()

Python

drafts.delete()

Ruby

drafts.delete

PHP

drafts->delete

Go

Drafts.Delete

Java

drafts().delete

CLI

openemail drafts delete