nylas/com.nylas.models/Folder

Folder

public final class Folder

Class representation of the Nylas folder response.

Constructors

public Folder Folder(@Json(name = "id") String id, @Json(name = "grant_id") String grantId, @Json(name = "name") String name, @Json(name = "object") String obj, @Json(name = "parent_id") String parentId, @Json(name = "background_color") String backgroundColor, @Json(name = "text_color") String textColor, @Json(name = "system_folder") Boolean systemFolder, @Json(name = "child_count") Integer childCount, @Json(name = "unread_count") Integer unreadCount, @Json(name = "total_count") Integer totalCount, @Json(name = "attributes") List<String> attributes)

Properties

private final List<String> attributes

Common attribute descriptors shared by system folders across providers. For example, Sent email folders have the ["\\Sent"] attribute. For IMAP grants, IMAP providers provide the attributes. For Google and Microsoft Graph, Nylas matches system folders to a set of common attributes.

backgroundColor

private final String backgroundColor

Folder background color. (Google only)

private final Integer childCount

The number of immediate child folders in the current folder. (Microsoft only)

private final String grantId

A Grant ID of the Nylas account.

private final String id

A globally unique object identifier.

private final String name

Folder name

private final String obj

The type of object.

private final String parentId

ID of the parent folder. (Microsoft only)

private final Boolean systemFolder

Indicates if the folder is user created or system created. (Google Only)

private final String textColor

Folder text color. (Google only)

private final Integer totalCount

The number of items inside of a folder.

private final Integer unreadCount

The number of unread items inside of a folder.

Functions

public final List<String> getAttributes()

Common attribute descriptors shared by system folders across providers. For example, Sent email folders have the ["\\Sent"] attribute. For IMAP grants, IMAP providers provide the attributes. For Google and Microsoft Graph, Nylas matches system folders to a set of common attributes.

getBackgroundColor

public final String getBackgroundColor()

Folder background color. (Google only)

public final Integer getChildCount()

The number of immediate child folders in the current folder. (Microsoft only)

public final String getGrantId()

A Grant ID of the Nylas account.

public final String getId()

A globally unique object identifier.

public final String getName()

Folder name

public final String getObj()

The type of object.

public final String getObject()

Get the type of object.

public final String getParentId()

ID of the parent folder. (Microsoft only)

getSystemFolder

public final Boolean getSystemFolder()

Indicates if the folder is user created or system created. (Google Only)

public final String getTextColor()

Folder text color. (Google only)

public final Integer getTotalCount()

The number of items inside of a folder.

public final Integer getUnreadCount()

The number of unread items inside of a folder.