Return all Drafts
Changed onReturn all drafts in the user's Drafts folder.
Request
- Base URLhttps://api.us.nylas.com
- Auth
- HTTP bearer
- or HTTP bearer
Query parameters
The maximum number of objects to return. See Pagination for more information.
An identifier that specifies which page of data to return. You can get this value from the next_cursor response field. See Pagination for more information.
Pass one indexed metadata key/value pair (for example, ?metadata_pair=key1:value) to search for objects. The key must be key1, key2, key3, key4, or key5. See Metadata for more information.
Specify fields that you want Nylas to return, as a comma-separated list (for example, select=id,updated_at). This allows you to receive only the portion of object data that you're interested in. You can use select to optimize response size and reduce latency by limiting queries to only the information that you need.
Return items with a matching subject. The filter is case insensitive and will match partial subjects.
Return messages that have been sent or received from this comma-separated list of email addresses (for example, mail1@example.com,mail2@example.com). You can specify a maximum of 25 email addresses.
Return items containing messages sent to this email address.
Return items containing messages that were CC'd to this email address.
Return items containing messages that were BCC'd to this email address, likely sent from the parent account. (Most SMTP gateways remove BCC information, so this appears only if the user sent the email message, or received it because they were on the BCC list.)
Return items with one or more starred messages. For EWS, this is only supported for Microsoft Exchange 2010 or later.
Return items with a matching thread_id.
Return items with attachments.
(IMAP, Yahoo, and iCloud only) When true, Nylas queries the IMAP server directly instead of the Nylas database. You also need to set the in query parameter in your request so Nylas knows which folder to query.
Response
Drafts
Example response
{
"request_id": "5fa64c92-e840-4357-86b9-2aa364d35b88",
"next_cursor": "CigKGjRlaDdyNGQydTFqbWJ0bGo5a2QxdWJtdDZnGAEggIDAu7fw7bEYGg8IABIAGPjh2PGEi_0CIAEiBwgCEOqs6i4="
}Changes
- breaking
the
////response's property type changed fromobjecttoarrayfor status
- breaking
- info
added the optional property
/to the response with the status
- info