Messages

Move a message

Move an email to a folder in the same mailbox.

POST/api/v1/mailboxes/{mailboxId}/messages/{uid}/move/

Permission write

Path parameters

mailboxIdintegerrequired

The selected mailbox ID. Email access requires a current mailbox grant.

uidintegerrequired

The message UID in the specified folder and UIDVALIDITY.

Maximum: 4294967295

Query parameters

folderstring

The mailbox folder name. Unicode names are supported.

Default: "INBOX" · Maximum 255 characters

uidValiditystringrequired

The exact UIDVALIDITY returned by the folder listing. Stale values are rejected.

Request headers

Idempotency-Keystringrequired

A unique key for this intentional action. Reuse it only with the same request input.

Maximum 128 characters

Request body

Send JSON with Content-Type: application/json.

confirmMailboxstring

Optional confirmation of the exact mailbox address.

Maximum 254 characters

destinationstringrequired

The destination folder in the same mailbox. Use the deletion endpoint for Trash.

Maximum 255 characters

Responses

200Success

Durable operation receipt with this endpoint’s result. Pending provisioning and SMTP acceptance are distinct from resource readiness and recipient delivery.

400Invalid request

Invalid input or missing idempotency key.

401Unauthenticated

Missing, expired, or revoked bearer credential.

403Forbidden

Wrong credential purpose, insufficient scope, or missing mailbox grant.

404Not found

Resource or message not found or unavailable to this integration.

409Conflict

Resource conflict, stale message reference, ambiguous submission, or idempotency conflict.

413Too large

Request or message exceeds the supported size.

429Rate limited

Rate limited. Honor Retry-After before retrying.

500Internal server error

Unexpected server error. Contact support with the request ID; inspect uncertain writes before retrying.

503Service unavailable

Integrations disabled or an upstream service unavailable.

See limits and errors for retry handling and the error envelope.

Example request

curl -X POST 'https://cherrymail.net/api/v1/mailboxes/123/messages/42/move/?uidValidity=1730000000' \
  -H "Authorization: Bearer $CHERRYMAIL_API_KEY" \
  -H "Idempotency-Key: example-request-1042" \
  -H "Content-Type: application/json" \
  -d '{
  "destination": "Archive"
}'

Responseapplication/json

dataobjectrequired

Show child fields

operation_idstring · uuidrequired

Durable operation ID. Use GET /operations/{id}/ to inspect it.

statestringrequired

Values: running, pending, completed, uncertain

resultobject | nullrequired

Endpoint-specific result; null while a concurrent request is running or its outcome is uncertain.

Show child fields

movedbooleanrequired

Value: true

folderstringrequired

uidValiditystringrequired

Destination UIDVALIDITY. If the server omits UIDPLUS metadata this may be the literal undefined string; relist the destination before addressing its messages.

uidinteger | nullrequired

New UID in the destination folder; null when no UID mapping was returned. Relist the destination in that case.

request_idstring · uuidrequired

Request ID for support and correlation. Also returned in X-Request-ID.

Example

200 response body

{
  "data": {
    "operation_id": "6032a8b5-5ab8-4d3d-9104-d1e8162a1453",
    "state": "completed",
    "result": {
      "moved": true,
      "folder": "Archive",
      "uidValidity": "1730000000",
      "uid": 91
    }
  },
  "request_id": "650f28e8-c344-42e4-ae43-c61539f83119"
}

Durable operation receipt with this endpoint’s result. Pending provisioning and SMTP acceptance are distinct from resource readiness and recipient delivery.

Response headers

Cache-Control: no-store

X-Request-ID

Same request ID as the JSON body.

RateLimit-Limit: 120;w=60

Per-credential limit and window.

RateLimit-Reset: 60

Rate-limit window in seconds.

Base URL
https://cherrymail.net/api/v1

View the OpenAPI contract ↗