$client->dnsConnections
كل دالّة في مساحة الأسماء هذه: توقيعها ومعلماتها وما تُرجعه ومثال عليها.
الدوالّ
The DNS provider accounts connected to the workspace, through which OpenEmail writes the records of a domain itself: list them, read what disconnecting one would leave behind, and disconnect it. Connecting one is done in the app, because the provider asks the person to sign in.
dnsConnections->list
List the DNS provider accounts connected to the workspace
list(?string $apiKey = null): arrayReturns every DNS provider account connected to the workspace, through which OpenEmail writes the records of a domain itself, as the Providers tab of the domains page in the app shows them. Each one names the domains it serves, how many records OpenEmail wrote through it and still keeps, and whether it is active, needs connecting again (needs-reauth) or was disconnected (revoked).
configured is false when this server cannot connect a provider at all. A connection is made in the app, because the provider asks the person to sign in, so there is no method to create one.
المعلمات
apiKeystringOverrides the client's API key for this call only.
يُرجع
An array with configured and every connection in data, a list of arrays, disconnected ones included.
مثال
$connections = $client->dnsConnections->list(); foreach ($connections['data'] as $connection) { echo $connection['subject'], ' ', $connection['status'], ' ', count($connection['domains']), ' domains', PHP_EOL;}ملاحظات
A GET is retried automatically on network failure and on 408, 429, 500, 502, 503 and 504 responses, up to the client's
maxRetries.
متاح أيضًا في
dnsConnections->get
Read a DNS connection and what disconnecting it would leave behind
get(string $id, ?string $apiKey = null): arrayReturns one connection with what disconnecting it would do: the domains it serves, the records OpenEmail wrote through it, busy for the domains a sync is running on right now, which hold a disconnect back until it ends, and keepsMail for the verified domains that stop receiving mail once their records come down.
المعلمات
idstringمطلوبA connection id from
dnsConnections->list.apiKeystringOverrides the client's API key for this call only.
يُرجع
An array with the fields of a connection in dnsConnections->list, plus busy and keepsMail, each a list of domain names.
مثال
$connection = $client->dnsConnections->get('dnsl_3f9a1c2e7b4d4e6f8a0b2c3d'); if ($connection['keepsMail'] !== []) { echo 'These stop receiving mail: ', implode(', ', $connection['keepsMail']), PHP_EOL;} if ($connection['busy'] !== []) { echo 'Wait for the sync on: ', implode(', ', $connection['busy']), PHP_EOL;}ملاحظات
A connection id that is not in this workspace is a 404
resource_not_found.A GET is retried automatically on network failure and on 408, 429, 500, 502, 503 and 504 responses, up to the client's
maxRetries.
متاح أيضًا في
dnsConnections->delete
Disconnect a DNS provider account
delete(string $id, ?string $apiKey = null): arrayDisconnects the account as Disconnect does in the app: the records OpenEmail wrote through it come down, every domain it serves is detached, and the connection is revoked at the provider. A verified domain whose records come down stops receiving mail, so read dnsConnections->get first. detached counts what came down and lists the records still published, to delete by hand.
A connection that is already disconnected is removed from the list instead, once no domain and no record is left on it, and removed says so.
المعلمات
idstringمطلوبA connection id from
dnsConnections->list.apiKeystringOverrides the client's API key for this call only.
يُرجع
An array for the connection with removed, confirmed and detached.
مثال
use OpenEmail\Exception\ConflictException; try { $result = $client->dnsConnections->delete('dnsl_3f9a1c2e7b4d4e6f8a0b2c3d'); if ($result['removed']) { echo 'Removed from the list', PHP_EOL; } else { echo $result['detached']['detached'] ?? 0, ' domains detached', PHP_EOL; }} catch (ConflictException $error) { echo 'Not yet: ', $error->errorCode, PHP_EOL;}ملاحظات
A sync running on one of its domains is refused with 409
dns_busy, and nothing is revoked. A disconnected connection that still has domains or records on it is refused with 409dns_connection_in_use.A key or an access token limited to particular addresses or domains is refused with 422
capability_unsupported. An access token acting for a member also needsworkspace:managein their role, or it is refused with 403insufficient_authority.An OAuth access token needs a verification code for this call, and is refused with 403
step_up_requireduntil the app has verified one in the last 60 minutes.isStepUpRequired()on the error says so. An API key is never asked for a code.Not retried by the SDK.