CarlyEmail docs
Labels are strings on a message. Some are applied by the system, and those are the ones worth understanding.
| Label | Applied when |
|---|---|
received |
Inbound mail |
sent |
Outbound mail |
unread |
On arrival, until you remove it |
unauthenticated |
Failed DMARC, or failed both SPF and DKIM |
spam |
The receiving path's spam or virus verdict said so |
trash |
You moved it there |
The default view hides three of them
Listings exclude spam, trash and unauthenticated unless you ask for them.
That last one is the important default: mail failing authentication is kept so
you can inspect it, but it is not handed to an agent as though it were genuine.
curl "https://api.carlyemail.com/v0/inboxes/$INBOX_ID/messages?include_spam=true" \
-H "Authorization: Bearer $CARLYEMAIL_API_KEY"
Your own labels can be added and removed freely:
curl -X PATCH https://api.carlyemail.com/v0/messages/$MESSAGE_ID \
-H "Authorization: Bearer $CARLYEMAIL_API_KEY" \
-H 'content-type: application/json' \
-d '{"add_labels": ["escalated"], "remove_labels": ["unread"]}'