List folders
List folders in an email account.
GET /api/v1/accounts/{accountId}/folders
List folders in an email account.
Authentication
Pass a Fluxmail API key as a bearer token. The key determines the member, mailbox scope, and permissions for the request.
Request
curl 'http://localhost:8977/api/v1/accounts/acct_123/folders' \
-H "Authorization: Bearer $FLUXMAIL_API_KEY"Parameters
| Name | Location | Required | Type | Details |
|---|---|---|---|---|
accountId | path | Yes | string | Minimum length: 1. |
Responses
| Status | Description | Content type |
|---|---|---|
200 | Folders | application/json |
400 | Invalid request | application/json |
401 | Authentication required | application/json |
403 | Permission or plan denied | application/json |
404 | Resource not found | application/json |
409 | Request conflict | application/json |
422 | Unsupported capability | application/json |
429 | Provider rate limit | application/json |
500 | Internal error | application/json |
503 | Provider unavailable | application/json |
200 response
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"role": {
"type": "string",
"enum": [
"inbox",
"sent",
"drafts",
"trash",
"spam",
"archive",
"starred",
"all"
]
},
"roleSource": {
"type": "string",
"enum": [
"user",
"extension",
"name"
]
},
"unreadCount": {
"type": "integer",
"minimum": 0
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
}
},
"warnings": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"data"
],
"additionalProperties": false
}Last updated