ListMessages Method

Lists the messages in a mailbox.

Syntax

public func listMessages(filter: String, threadId: String) throws -> Void

Remarks

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

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

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

threadId can be used to retrieve a specific subset of messages from a specific thread, or it can be left as an empty string to retrieve all messages in a mailbox.

Example (List all messages in a mailbox)


gmail.ListMessages("", "");

Example (List messages from a specific address)


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

Example (List messages with the 'Unread' label)


gmail.ListMessages("is:unread", "");

Example (List messages with a specific message ID)


gmail.ListMessages("rfc822msgid:123456", "");

Example (List Messages from a specific thread)


gmail.ListMessages("", "123456789");

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