nylas/com.nylas.models/ListDraftsQueryParams

ListDraftsQueryParams

public final class ListDraftsQueryParams implements IQueryParams

Class representing the query parameters for listing drafts.

Constructors

ListDraftsQueryParams

public ListDraftsQueryParams ListDraftsQueryParams(@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 = "cc") List<String> cc, @Json(name = "bcc") List<String> bcc, @Json(name = "unread") Boolean unread, @Json(name = "starred") Boolean starred, @Json(name = "thread_id") String threadId, @Json(name = "has_attachment") Boolean hasAttachment)

Types

public final class Builder

Builder for ListDraftsQueryParams.

Properties

private final List<String> anyEmail

Return emails that have been sent or received from this list of email addresses. Pass one email address per list entry; the SDK sends them to the API as a single comma-delimited value. The API accepts a maximum of 25 addresses.

private final List<String> bcc

Return items containing drafts bcc'ing these email address.

private final List<String> cc

Return items containing drafts cc'ing these email address.

private final Boolean hasAttachment

Return drafts that contain attachments.

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 Boolean starred

Return drafts that are starred.

private final String subject

Return items with a matching literal subject.

private final String threadId

Return drafts that belong to this thread.

private final List<String> to

Return items containing drafts to be sent these email address.

private final Boolean unread

Return drafts that are unread.

Functions

public Map<String, Object> convertToMap()

The API does not accept repeated values for these parameters. See joinCommaDelimitedParams and collapseSingleValueParams.

public final List<String> getAnyEmail()

Return emails that have been sent or received from this list of email addresses. Pass one email address per list entry; the SDK sends them to the API as a single comma-delimited value. The API accepts a maximum of 25 addresses.

public final List<String> getBcc()

Return items containing drafts bcc'ing these email address.

public final List<String> getCc()

Return items containing drafts cc'ing these email address.

getHasAttachment

public final Boolean getHasAttachment()

Return drafts that contain attachments.

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.

public final Boolean getStarred()

Return drafts that are starred.

public final String getSubject()

Return items with a matching literal subject.

public final String getThreadId()

Return drafts that belong to this thread.

public final List<String> getTo()

Return items containing drafts to be sent these email address.

public final Boolean getUnread()

Return drafts that are unread.