Trust
Trust reports for inbound messages.
| Method | Path | Summary |
|---|---|---|
GET | /v0/inboxes/{inbox_id}/messages/{message_id}/trust | Get Message Trust Report |
GET | /v0/pods/{pod_id}/inboxes/{inbox_id}/messages/{message_id}/trust | Get Message Trust Report in Pod |
Get Message Trust Report
The same object as the message trust. 404 for messages without a report (outbound messages).
Authentication: Authorization: Bearer <api key> or the dashboard mm_session cookie. Permission: message_read.
Path parameters
inbox_idstringRequiredID of the inbox: its email address, as in AgentMail (inbox_id == email).
message_idstringRequiredID of the message.
Response
200 The trust report (application/json)
level"verified" | "known" | "unknown" | "suspicious" | "quarantined"RequiredOverall verdict, safest first. quarantined messages are labelled QUARANTINE and hidden from lists unless asked for.
scorenumberRequired0 to 1, higher is safer. Ranks messages within a level. (minimum 0, maximum 1)
authenticationobjectRequiredsenderobjectRequiredcontentobjectRequiredlinksobject[]Requiredattachmentsobject[]RequiredclassificationobjectRequiredreasonsstring[]RequiredHuman-readable reasons for the verdict.
computed_atstring (date-time)RequiredWhen the report was computed.
Errors
| Status | Meaning |
|---|---|
401 | Missing, invalid, expired or revoked credential. |
403 | The credential lacks the permission or scope for this request (error.type forbidden), or MachineMail suspended the organization or its sending (account_suspended: error.message says what still works; do not retry or re-register). |
404 | Not found. Also returned for resources outside the credential scope. |
500 | Unexpected server error. |
Error bodies use the error envelope.
Example
Get Message Trust Report in Pod
Same as Get Message Trust Report (GET /v0/inboxes/{inbox_id}/messages/{message_id}/trust), limited to the pod.
Authentication: Authorization: Bearer <api key> or the dashboard mm_session cookie. Permission: message_read.
Path parameters
pod_idstringRequiredID of the pod.
inbox_idstringRequiredID of the inbox: its email address, as in AgentMail (inbox_id == email).
message_idstringRequiredID of the message.
Response
200 The trust report (application/json)
level"verified" | "known" | "unknown" | "suspicious" | "quarantined"RequiredOverall verdict, safest first. quarantined messages are labelled QUARANTINE and hidden from lists unless asked for.
scorenumberRequired0 to 1, higher is safer. Ranks messages within a level. (minimum 0, maximum 1)
authenticationobjectRequiredsenderobjectRequiredcontentobjectRequiredlinksobject[]Requiredattachmentsobject[]RequiredclassificationobjectRequiredreasonsstring[]RequiredHuman-readable reasons for the verdict.
computed_atstring (date-time)RequiredWhen the report was computed.
Errors
| Status | Meaning |
|---|---|
401 | Missing, invalid, expired or revoked credential. |
403 | The credential lacks the permission or scope for this request (error.type forbidden), or MachineMail suspended the organization or its sending (account_suspended: error.message says what still works; do not retry or re-register). |
404 | Not found. Also returned for resources outside the credential scope. |
500 | Unexpected server error. |
Error bodies use the error envelope.