ListDraftsQueryParams

public final class ListDraftsQueryParams implements IQueryParams

Class representing the query parameters for listing drafts.

Constructors

Link copied to clipboard
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

Link copied to clipboard
public final class Builder

Properties

Link copied to clipboard
private final List<String> anyEmail

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

Link copied to clipboard
private final List<String> bcc

Return items containing drafts bcc'ing these email address.

Link copied to clipboard
private final List<String> cc

Return items containing drafts cc'ing these email address.

Link copied to clipboard
private final Boolean hasAttachment

Return drafts that contain attachments.

Link copied to clipboard
private final Integer limit

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

Link copied to clipboard
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.

Link copied to clipboard
private final Boolean starred

Return drafts that are starred.

Link copied to clipboard
private final String subject

Return items with a matching literal subject.

Link copied to clipboard
private final String threadId

Return drafts that belong to this thread.

Link copied to clipboard
private final List<String> to

Return items containing drafts to be sent these email address.

Link copied to clipboard
private final Boolean unread

Return drafts that are unread.

Functions

Link copied to clipboard

Convert the query parameters to a json-formatted map.

Link copied to clipboard
public final List<String> getAnyEmail()

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

Link copied to clipboard
public final List<String> getBcc()

Return items containing drafts bcc'ing these email address.

Link copied to clipboard
public final List<String> getCc()

Return items containing drafts cc'ing these email address.

Link copied to clipboard
public final Boolean getHasAttachment()

Return drafts that contain attachments.

Link copied to clipboard
public final Integer getLimit()

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

Link copied to clipboard
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.

Link copied to clipboard
public final Boolean getStarred()

Return drafts that are starred.

Link copied to clipboard
public final String getSubject()

Return items with a matching literal subject.

Link copied to clipboard
public final String getThreadId()

Return drafts that belong to this thread.

Link copied to clipboard
public final List<String> getTo()

Return items containing drafts to be sent these email address.

Link copied to clipboard
public final Boolean getUnread()

Return drafts that are unread.