Cloud Mail 2020 JavaScript Edition

Questions / Feedback?

ListDrafts Method

Lists the drafts in a mailbox.

Syntax

async gmail.listDrafts(filter : string): Promise<void>

Remarks

This method lists the drafts found in the mailbox. This method populates the MessageInfo* properties.

If the number of drafts is greater than the message page size, NextPageToken will be populated and calling ListDrafts again will list the next page of drafts.

filter can be used to retrieve a specific subset of drafts, or it can be left as an empty string to retrieve all drafts in a mailbox.

Example (List all drafts in a mailbox)


gmail.ListDrafts("");

Example (List drafts from a specific address)


gmail.ListDrafts("from:someuser@example.com");

Example (List drafts with the 'Unread' label)


gmail.ListDrafts("is:unread");

Example (List drafts with a specific message ID)


gmail.ListDrafts("rfc822msgid:123456");

Copyright (c) 2022 /n software inc. - All rights reserved.
Cloud Mail 2020 JavaScript Edition - Version 20.0 [Build 8308]