gmail.users.drafts.list
GET {{baseUrl}}/gmail/v1/users/:userId/drafts?includeSpamTrash=<boolean>&maxResults=<integer>&pageToken=<string>&q=<string>&$.xgafv=<string>&access_token=<string>&alt=<string>&callback=<string>&fields=<string>&key=<string>&oauth_token=<string>&prettyPrint=<boolean>"aUser=<string>&upload_protocol=<string>&uploadType=<string>
Lists the drafts in the user's mailbox.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
includeSpamTrash | string | Include drafts from SPAM and TRASH in the results. | |
maxResults | string | Maximum number of drafts to return. | |
pageToken | string | Page token to retrieve a specific page of results in the list. | |
q | string | Only return draft messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread". | |
$.xgafv | string | V1 error format. | |
access_token | string | OAuth access token. | |
alt | string | Data format for response. | |
callback | string | JSONP | |
fields | string | Selector specifying which fields to include in a partial response. | |
key | string | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. | |
oauth_token | string | OAuth 2.0 token for the current user. | |
prettyPrint | string | Returns response with indentations and line breaks. | |
quotaUser | string | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. | |
upload_protocol | string | Upload protocol for media (e.g. "raw", "multipart"). | |
uploadType | string | Legacy upload protocol for media (e.g. "media", "multipart"). |
RESPONSES
status: OK
{"drafts":[{"id":"veniam Duis exercitati","message":{"historyId":"dolore sint Excepteur ipsum reprehenderit","id":"minim et dolore","internalDate":"proident Excepteur","labelIds":["irure dolore fugiat aliquip eiusmod","do sint laboris occaecat"],"payload":{"body":{"attachmentId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"data":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"size":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"filename":"laborum","headers":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"mimeType":"labore Excepteur","partId":"anim eu tempor velit","parts":[{"value":"\u003cCircular reference to #/components/schemas/MessagePart detected\u003e"},{"value":"\u003cCircular reference to #/components/schemas/MessagePart detected\u003e"}]},"raw":"aute qui","sizeEstimate":-56161869,"snippet":"consectetur occaecat irure elit","threadId":"ex eu proident in magna"}},{"id":"elit Duis dolore","message":{"historyId":"ut","id":"deserunt laborum","internalDate":"mollit minim","labelIds":["cillum laboris","do velit magna aute laboris"],"payload":{"body":{"attachmentId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"data":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"size":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"filename":"aute Lorem sed irure","headers":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"mimeType":"ullamco i","partId":"nisi laboris sunt","parts":[{"value":"\u003cCircular reference to #/components/schemas/MessagePart detected\u003e"},{"value":"\u003cCircular reference to #/components/schemas/MessagePart detected\u003e"}]},"raw":"","sizeEstimate":-54111262,"snippet":"id quis in do","threadId":"pariatur ut Excep"}}],"nextPageToken":"in aliquip culpa","resultSizeEstimate":99349769}