Skip to content

Read mail settings

Read whether a Computer can receive mail, its policy for outgoing recipients and whether sending is suspended.

Parameters

#
computerstringRequired
Computer name or ID.

Returns

#
dataobjectAlways present
The Computer's receiving and reply settings.
Show 5 attributesHide attributes
notestring
Effects of disabling mail reception, returned for that change. May be omitted.
receiving_enabledbooleanAlways present
Whether mail reception is enabled for this Computer.
receiving_reasonstring
Why receiving is disabled or unavailable, when applicable. May be omitted.
reply_policystringAlways present
Permitted reply recipients. Values: "all", "known", "none", "owner".
sending_suspendedbooleanAlways present
Whether outgoing mail is suspended.

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 view.