Parameters
#computerstringRequired
Computer name or ID.
statestring
Set
on to accept incoming mail or off to refuse it, delete reply threads and unsubscribe senders. Omit to keep the current setting.reply_policystring
Mail recipients: known allows the owner, organization members and people with access. With receiving on, all also allows subscribers and replies to mail received in the last 30 days. owner allows only the owner; none blocks sending. Omission keeps the current policy.
dry_runboolean
Preview the change without applying it.
Returns
#dataobjectAlways present
The Computer's receiving and reply settings. A preview of the requested change.
Show 2 attributesHide attributes
alternative-1object
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.
alternative-2object
A preview of the requested change.
Show 3 attributesHide attributes
changesstring[]
Proposed effects and losses. May be omitted.
dry_runbooleanAlways present
True for a preview; no changes are made.
messagestringAlways present
What the request would do.
Errors
#| Code | Status | What happened |
|---|---|---|
| invalid | 400 | An input is missing or invalid. |
| unauthenticated | 401 | The credential is missing, invalid, expired or revoked. |
| denied | 403 | The caller lacks permission for this action. |
| not_found | 404 | The resource is absent or inaccessible to this caller. |
| conflict | 409 | The request conflicts with the current resource state or an earlier request. |
| over_capacity | 409 | The request exceeds a resource or credential allowance. |
| access_list_full | 409 | The change would exceed the access-list allowance. |
| payment_required | 402 | Payment or credit is required. |
| rate_limited | 429 | The caller's request rate exceeds its limit. |
| busy | 429 | Too much work is in progress to accept this request. |
| unknown | 503 | The outcome is unconfirmed; a change may have happened. |
| unavailable | 503 | The service or requested feature is unavailable. |
Notes
#- API key permission:
mail.