nylas/com.nylas.models/ListThreadsQueryParams

ListThreadsQueryParams

public final class ListThreadsQueryParams implements IQueryParams

Constructors

public ListThreadsQueryParams ListThreadsQueryParams(@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 = "latest_message_before") Long latestMessageBefore, @Json(name = "latest_message_after") Long latestMessageAfter, @Json(name = "has_attachment") Boolean hasAttachment, @Json(name = "search_query_native") String searchQueryNative)

Types

Builder

public final class Builder

Builder for ListThreadsQueryParams.

Properties

anyEmail

private final List<String> anyEmail

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

bcc

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.

from

private final List<String> from

Return items containing messages sent from these email address.

hasAttachment

private final Boolean hasAttachment

Return emails that contain attachments.

inFolder

private final List<String> inFolder

Filter for threads in a specific folder or label. Note: The Nylas API only supports filtering by a single folder ID. If a list is provided, only the first folder ID will be used.

latestMessageAfter

private final Long latestMessageAfter

Return threads whose most recent message was received after this Unix timestamp.

latestMessageBefore

private final Long latestMessageBefore

Return threads whose most recent message was received before this Unix timestamp.

limit

private final Integer limit

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

pageToken

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.

searchQueryNative

private final String searchQueryNative

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

starred

private final Boolean starred

Return emails that are starred.

subject

private final String subject

Return items with a matching literal subject.

private final List<String> to

Return items containing messages sent to these email address.

unread

private final Boolean unread

Return emails that are unread.

Functions

convertToMap

public Map<String, Object> convertToMap()

Override convertToMap to handle the inFolder parameter correctly. The API expects a single folder ID, so we use only the first item if a list is provided.

getAnyEmail

public final List<String> getAnyEmail()

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

getBcc

public final List<String> getBcc()

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

getCc

public final List<String> getCc()

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

getFrom

public final List<String> getFrom()

Return items containing messages sent from these email address.

getHasAttachment

public final Boolean getHasAttachment()

Return emails that contain attachments.

getInFolder

public final List<String> getInFolder()

Filter for threads in a specific folder or label. Note: The Nylas API only supports filtering by a single folder ID. If a list is provided, only the first folder ID will be used.

getLatestMessageAfter

public final Long getLatestMessageAfter()

Return threads whose most recent message was received after this Unix timestamp.

getLatestMessageBefore

public final Long getLatestMessageBefore()

Return threads whose most recent message was received before this Unix timestamp.

getLimit

public final Integer getLimit()

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

getPageToken

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.

getSearchQueryNative

public final String getSearchQueryNative()

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

getStarred

public final Boolean getStarred()

Return emails that are starred.

getSubject

public final String getSubject()

Return items with a matching literal subject.

getTo

public final List<String> getTo()

Return items containing messages sent to these email address.

getUnread

public final Boolean getUnread()

Return emails that are unread.