Fluxmail

Update folder settings for an owned IMAP mailbox

Reference for PATCH /api/v1/accounts/{accountId}/imap/folders.

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

Reference for PATCH /api/v1/accounts/{accountId}/imap/folders.

Authentication

Pass a Fluxmail member session as a bearer token. API keys cannot use this endpoint.

Request

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

Parameters

NameLocationRequiredTypeDetails
accountIdpathYesstringMinimum length: 1.

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
}

Responses

StatusDescriptionContent type
200Successapplication/json
400Invalid requestapplication/json
401Authentication requiredapplication/json
403Permission deniedapplication/json
404Not foundapplication/json
409Conflictapplication/json
413Request body too largeapplication/json
422Unsupported capabilityapplication/json
429Too many attemptsapplication/json
503Provider unavailableapplication/json

200 response

{
  "type": "object",
  "properties": {
    "data": {
      "nullable": true
    }
  }
}

Last updated