nylas/com.nylas.models/ListMessagesQueryParams

ListMessagesQueryParams

public final class ListMessagesQueryParams implements IQueryParams

Class representing the query parameters for listing messages.

Constructors

ListMessagesQueryParams

public ListMessagesQueryParams ListMessagesQueryParams(@Json(name = "limit") Integer limit, @Json(name = "page_token") String pageToken, @Json(name = "subject") String subject, @Json(name = "any_email") List<String> anyEmail, @Json(name = "to") List<String> to, @Json(name = "from") List<String> from, @Json(name = "cc") List<String> cc, @Json(name = "bcc") List<String> bcc, @Json(name = "in") List<String> inFolder, @Json(name = "unread") Boolean unread, @Json(name = "starred") Boolean starred, @Json(name = "thread_id") String threadId, @Json(name = "received_before") Integer receivedBefore, @Json(name = "received_after") Integer receivedAfter, @Json(name = "has_attachment") Boolean hasAttachment, @Json(name = "fields") MessageFields fields, @Json(name = "search_query_native") String searchQueryNative)

Types

public final class Builder

Properties

private final List<String> anyEmail

Return emails that have been sent or received from this list of email addresses.

private final List<String> bcc

Return items containing messages bcc'd on these email address.

private final List<String> cc

Return items containing messages cc'd on these email address.

private final MessageFields fields

Allows you to specify to return messages with headers included.

private final List<String> from

Return items containing messages sent from these email address.

private final Boolean hasAttachment

Return emails that contain attachments.

private final List<String> inFolder

Return emails that are in these folder IDs.

private final Integer limit

The maximum number of objects to return. This field defaults to 50. The maximum allowed value is 200.

private final String pageToken

An identifier that specifies which page of data to return. This value should be taken from the ListResponse.nextCursor response field.

private final Integer receivedAfter

Return emails that have been received after this timestamp.

private final Integer receivedBefore

Return emails that have been received before this timestamp.

searchQueryNative

private final String searchQueryNative

The provider-specific query string used to search messages. Available for Google and Microsoft Graph only.

private final Boolean starred

Return emails that are starred.

private final String subject

Return items with a matching literal subject.

private final String threadId

Return emails that belong to this thread.

private final List<String> to

Return items containing messages sent to these email address.

private final Boolean unread

Return emails that are unread.

Functions

public Map<String, Object> convertToMap()

Convert the query parameters to a json-formatted map.

public final List<String> getAnyEmail()

Return emails that have been sent or received from this list of email addresses.

public final List<String> getBcc()

Return items containing messages bcc'd on these email address.

public final List<String> getCc()

Return items containing messages cc'd on these email address.

public final MessageFields getFields()

Allows you to specify to return messages with headers included.

public final List<String> getFrom()

Return items containing messages sent from these email address.

getHasAttachment

public final Boolean getHasAttachment()

Return emails that contain attachments.

public final List<String> getInFolder()

Return emails that are in these folder IDs.

public final Integer getLimit()

The maximum number of objects to return. This field defaults to 50. The maximum allowed value is 200.

public final String getPageToken()

An identifier that specifies which page of data to return. This value should be taken from the ListResponse.nextCursor response field.

getReceivedAfter

public final Integer getReceivedAfter()

Return emails that have been received after this timestamp.

getReceivedBefore

public final Integer getReceivedBefore()

Return emails that have been received before this timestamp.

getSearchQueryNative

public final String getSearchQueryNative()

The provider-specific query string used to search messages. Available for Google and Microsoft Graph only.

public final Boolean getStarred()

Return emails that are starred.

public final String getSubject()

Return items with a matching literal subject.

public final String getThreadId()

Return emails that belong to this thread.

public final List<String> getTo()

Return items containing messages sent to these email address.

public final Boolean getUnread()

Return emails that are unread.