Fluxmail

PATCH /api/v1/admin/accounts/{accountId}/imap/folders

Update the folder overrides for an IMAP account. Requires admin.accounts.

Update the folder overrides for an IMAP account. Requires admin.accounts.

Authentication

Pass an administrator member session or an API key as a bearer token. The key must belong to an administrator and include the capability listed above.

Remote administrative requests require HTTPS. Requests from the local computer can use HTTP.

Request

curl 'http://localhost:8977/api/v1/admin/accounts/acct_123/imap/folders' \
  -X PATCH \
  -H "Authorization: Bearer $FLUXMAIL_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "sent": "Sent"
}'

Parameters

NameLocationRequiredTypeDetails
accountIdpathYesstringMinimum length: 1. Maximum length: 200.

Request body

Content type: application/json

{
  "type": "object",
  "properties": {
    "sent": {
      "type": "string",
      "nullable": true,
      "minLength": 1,
      "maxLength": 1024
    },
    "drafts": {
      "type": "string",
      "nullable": true,
      "minLength": 1,
      "maxLength": 1024
    },
    "trash": {
      "type": "string",
      "nullable": true,
      "minLength": 1,
      "maxLength": 1024
    },
    "archive": {
      "type": "string",
      "nullable": true,
      "minLength": 1,
      "maxLength": 1024
    },
    "spam": {
      "type": "string",
      "nullable": true,
      "minLength": 1,
      "maxLength": 1024
    }
  },
  "additionalProperties": false,
  "example": {
    "sent": "Sent"
  }
}

Responses

StatusDescriptionContent type
200Updated folder overridesapplication/json
400Invalid requestapplication/json
401Authentication requiredapplication/json
403Administrative access deniedapplication/json
404Resource not foundapplication/json
409Request conflictapplication/json
413Request body too largeapplication/json
415Unsupported media typeapplication/json
500Internal errorapplication/json
502License could not be verifiedapplication/json

200 response

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "additionalProperties": {
        "nullable": true
      }
    }
  },
  "required": [
    "data"
  ],
  "additionalProperties": false
}

Last updated