/mail/folders (GET)

GET

/mail/folders

const url = 'https://example.com/api/v1/mail/folders';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/mail/folders \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer

Responses

200

Default Response

application/json

Array<object>

object

path

required

string

name

required

string

role

required

string

Allowed values: inbox sent drafts trash junk archive other

delimiter

required

Any of:

string
null

string

subscribed

required

boolean

messages

required

integer

>= -9007199254740991 <= 9007199254740991

unseen

required

integer

>= -9007199254740991 <= 9007199254740991

Example

[
  {
    "role": "inbox"
  }
]