Skip to content

Read a message's delivery

Read the delivery status of an outgoing message by the ID returned when the Computer sent it. Requires owner or root access.

Parameters

#
computerstringRequired
Computer name or ID.
messagestringRequired
Message ID returned when the Computer sent the mail.

Returns

#
dataobjectAlways present
The recorded status of an outgoing message.
Show 7 attributesHide attributes
acceptedboolean
Whether Heaven durably accepted the message for sending. May be omitted.
failureobject
Sending failure and any retry timing. May be omitted.
Show 3 attributesHide attributes
errorstringAlways present
Explanation of the failure.
kindstringAlways present
Failure category.
retry_afterinteger
Retry delay in seconds. May be omitted.
idstring
Message ID. May be omitted.
receiving_enabledbooleanAlways present
Whether the sending Computer can currently receive mail.
receiving_reasonstring
Why receiving is unavailable, when applicable. May be omitted.
statusstring
Recorded sending state. Reconcile an unknown outcome before resending. May be omitted.
successboolean
Whether the sending attempt succeeded. Recipient delivery is not confirmed. May be omitted.

Errors

#
CodeStatusWhat happened
invalid400An input is missing or invalid.
unauthenticated401The credential is missing, invalid, expired or revoked.
denied403The caller lacks permission for this action.
not_found404The resource is absent or inaccessible to this caller.
conflict409The request conflicts with the current resource state or an earlier request.
over_capacity409The request exceeds a resource or credential allowance.
access_list_full409The change would exceed the access-list allowance.
rate_limited429The caller's request rate exceeds its limit.
busy429Too much work is in progress to accept this request.
unknown503The outcome is unconfirmed; a change may have happened.
unavailable503The service or requested feature is unavailable.

Notes

#
  • API key permission: mail status.