跳转到内容
simail文档v0

API 参考

标签

消息和线程上的系统标签与自定义标签、如何按标签过滤,以及 agent 可以改哪些。

docs.simail.ai/zh/api/labels

标签是消息上的短字符串。一个线程的标签是它各条消息标签的并集。

标签设置者agent 可否修改
receivedsimail,在来信上不可以
sentsimail,在外发邮件上不可以
unreadsimail,在来信上可以
important你可以
draftsimail不可以
heldsimail;人放行该消息后清除不可以
spamsimail不可以
blockedsimail(发件人在拦截名单上)不可以
trash对消息或线程执行 DELETE不可以(只能通过删除)

其他不超过 64 个字符的小写字符串(a-z、0-9、-、_、.、/)都是自定义标签,例如 orders 或 needs-human。agent 可以自由添加和移除自定义标签。

PATCH/v0/inboxes/{inbox_id}/messages/{message_id}
PATCH/v0/inboxes/{inbox_id}/threads/{thread_id}
POST/v0/inboxes/{inbox_id}/messages/batch-update

都需要 message_update,正文为:

{ "add_labels": ["orders"], "remove_labels": ["unread"] }

试图修改 agent 不能改的标签会返回 400 validation_error。变更会发布 label.added 和 label.removed。发信时可以用 labels 给发出的那一份设置标签。

列表和搜索接口接受 labels=a,b(必须全部匹配)。spam、blocked 和 trash 默认不出现在列表里,除非你传入 include_spam、include_blocked 或 include_trash,每一个都需要对应的 label_*_read 权限。

MCP:list_labels 和 update_labels。