curl -X PATCH "https://api.wirebox.sh/api/v1/mailboxes/eva/messages/msg_01J8ABC123XYZ" \
-H "Authorization: Bearer $WIREBOX_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"is_read": true
}'
{
"id": "msg_01J8ABC123XYZ",
"is_read": true,
"is_starred": false
}
Mail
Update & Delete Message
Update read and starred flags on a message, or permanently delete it.
PATCH
/
api
/
v1
/
mailboxes
/
{email_address}
/
messages
/
{message_id}
curl -X PATCH "https://api.wirebox.sh/api/v1/mailboxes/eva/messages/msg_01J8ABC123XYZ" \
-H "Authorization: Bearer $WIREBOX_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"is_read": true
}'
{
"id": "msg_01J8ABC123XYZ",
"is_read": true,
"is_starred": false
}
Update Message
Path Parameters
string
required
Full mailbox address (
eva@wireboxmail.com) or local agent handle (eva).string
required
Unique message identifier (
msg_ prefix).Body Parameters
boolean
Mark the message as read (
true) or unread (false).boolean
Star or unstar the message.
is_read or is_starred must be provided.
Response
string
Unique message identifier.
boolean
Updated read state.
boolean
Updated starred state.
curl -X PATCH "https://api.wirebox.sh/api/v1/mailboxes/eva/messages/msg_01J8ABC123XYZ" \
-H "Authorization: Bearer $WIREBOX_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"is_read": true
}'
{
"id": "msg_01J8ABC123XYZ",
"is_read": true,
"is_starred": false
}
Delete Message
Permanently deletes a message and its attachment records. The operation is idempotent: deleting an already-deleted message still returns200.
curl -X DELETE "https://api.wirebox.sh/api/v1/mailboxes/eva/messages/msg_01J8ABC123XYZ" \
-H "Authorization: Bearer $WIREBOX_API_KEY"
from wirebox import Wirebox
with Wirebox() as wirebox:
eva = wirebox.get_identity("eva")
eva.delete_message("msg_01J8ABC123XYZ")
import { Wirebox } from "@wirebox-sh/sdk";
const wirebox = new Wirebox();
const eva = await wirebox.getIdentity("eva");
await eva.deleteMessage("msg_01J8ABC123XYZ");
wirebox mail delete msg_01J8ABC123XYZ --identity eva
{
"id": "msg_01J8ABC123XYZ",
"deleted": true
}