$client->providerImports
この名前空間のすべてのメソッドの、シグネチャ、パラメーター、戻り値、例。
メソッド
Move from Resend, SendGrid, Postmark, Mailgun or Mailchimp: suppressions, audiences, contacts, templates and webhooks come across with one key, with a checklist for domains and API keys.
providerImports->inspect
Look inside an account at another provider before importing
inspect(string $providerKey, ?string $provider = null, ?string $apiKey = null): arrayReads the first page of every resource with a key from Resend, SendGrid, Postmark, Mailgun or Mailchimp and returns a count for each, with more set where a resource runs past its first page. resources lists what this key can bring across: what the provider has no such thing for, or the key may not read, is left out. Nothing is stored, and the key is not kept.
provider: picks the provider and defaults to resend. Resend needs a full-access key, SendGrid a key with read access, Postmark a Server API token, Mailgun a private API key from either region and Mailchimp an API key with its datacenter suffix. A key that can read nothing but sending is 400 restricted_key: create one with more access for the import and revoke it afterwards.
パラメーター
providerKeystring必須The key from the other provider: a full-access Resend key
re_…, a SendGrid keySG.…, a Postmark Server API token, a Mailgun private API key or a Mailchimp key ending in its datacenter, such as-us6. It is sent as theapiKeyfield of the request body, and it is not theapiKey:named argument, which overrides the OpenEmail key.providerstringOne of
resend,sendgrid,postmark,mailgunandmailchimp, the values ofOpenEmail\Constants\ProviderImportProviders. Defaults toresend.apiKeystringOverrides the client's API key for this call only.
戻り値
An array with provider, resources and counts, which holds one array per resource (suppressions, audiences, contacts, templates, webhooks, domains and api-keys), each with count and more.
例
use OpenEmail\Constants\ProviderImportProviders; $inventory = $client->providerImports->inspect('SG.8Rk2Lq5T7nVwX3yZp9QhMcB4dFs6JgA', provider: ProviderImportProviders::SENDGRID); foreach ($inventory['resources'] as $resource) { $count = $inventory['counts'][$resource] ?? null; echo $resource, ': ', $count['count'] ?? 0, ($count['more'] ?? false) ? ' or more' : '', PHP_EOL;}注意事項
A key restricted to addresses or domains is refused, since audiences, suppressions and templates belong to the whole workspace.
Postmark keeps domains and sender signatures behind an Account token, which the import does not take, so they are not in
resources. Mailchimp has no webhooks for sending events and does not list API keys.
ほかの提供先
providerImports->create
Import from another provider
create(array $body, ?string $apiKey = null): arrayQueues an import from Resend, SendGrid, Postmark, Mailgun or Mailchimp. Suppressions keep their reason, segments and lists become audiences, subscribed contacts arrive with their names, templates arrive as HTML templates with their variables declared, and webhooks are registered switched off because deliveries here are signed differently. Domains and API keys come back as a checklist in the report, since a signing key or a token cannot leave the provider that made it. Resources the provider has no such thing for, or the key cannot read, are left out, and resources on the import says what it brings.
The key is held encrypted only while the import runs and is erased when it ends, fails or is cancelled. Running it twice duplicates nothing.
パラメーター
apiKeystring必須The key from the other provider: a full-access Resend key
re_…, a SendGrid keySG.…, a Postmark Server API token, a Mailgun private API key or a Mailchimp key ending in its datacenter, such as-us6. This is theapiKeyfield of the body array, which is not theapiKey:named argument that overrides the OpenEmail key.providerstringOne of
resend,sendgrid,postmark,mailgunandmailchimp, the values ofOpenEmail\Constants\ProviderImportProviders. Left out, the server takesresend.resourcesstring[]必須Any of
suppressions,audiences,contacts,templates,webhooks,domainsandapi-keys, the values ofOpenEmail\Constants\ProviderImportResources.apiKeystringThe named argument that overrides the client's API key for this call only.
戻り値
An array for the provider import, shaped like the one providerImports->get returns, with status set to queued.
例
use OpenEmail\Constants\ProviderImportProviders;use OpenEmail\Constants\ProviderImportResources; $import = $client->providerImports->create([ 'apiKey' => 'SG.8Rk2Lq5T7nVwX3yZp9QhMcB4dFs6JgA', 'provider' => ProviderImportProviders::SENDGRID, 'resources' => ProviderImportResources::values(),]); echo $import['id'], ' ', $import['status'], PHP_EOL;注意事項
One import runs per workspace at a time; a second is 409
already_running.Contacts who unsubscribed at the provider are left out and counted in
$import['report']['contacts']['unsubscribed'].SendGrid hands out contacts through an export it prepares first, so the contacts step waits for it before anything arrives.
ほかの提供先
providerImports->list
List one page of imports from sending providers
list(?int $limit = null, ?string $cursor = null, ?string $apiKey = null): PageOne page of the provider imports in the workspace, newest first, each with its report. Nothing is dropped from the history: follow nextCursor while hasMore is true to reach the first one, or let providerImports->listAll and providerImports->iterate do that walk.
パラメーター
limitintRows per page, a whole number from 1 to 100. The server defaults to 25.
cursorstringThe
nextCursorfrom the previous page. One that names no provider import in the workspace is a 400invalid_cursor.apiKeystringOverrides the client's API key for this call only.
戻り値
A Page of provider import arrays, with items, hasMore and nextCursor.
例
$page = $client->providerImports->list(limit: 10); foreach ($page as $import) { echo $import['id'], ' ', $import['provider'], ' ', $import['status'], PHP_EOL;} if ($page->hasMore) { $older = $client->providerImports->list(limit: 10, cursor: $page->nextCursor); echo count($older), ' more on the next page', PHP_EOL;}ほかの提供先
providerImports->listAll
Collect every provider import into one array
listAll(?int $limit = null, ?string $cursor = null, ?string $apiKey = null): arrayFollows nextCursor from page to page and returns every provider import in the workspace, newest first, each with its report.
パラメーター
limitintPage size per request, from 1 to 100, defaulting to 25 on the server.
cursorstringA provider import id to start after.
apiKeystringOverrides the client's API key for every page of this walk.
戻り値
A list of provider import arrays holding every provider import across all pages.
例
use OpenEmail\Constants\ProviderImportStatuses; $imports = $client->providerImports->listAll(); $completed = array_filter($imports, static fn(array $import): bool => $import['status'] === ProviderImportStatuses::COMPLETED); echo count($completed), ' of ', count($imports), ' imports completed', PHP_EOL;注意事項
A failure on any page throws out of the whole call, and none of the pages already read are returned.
ほかの提供先
providerImports->iterate
Stream provider imports one at a time
iterate(?int $limit = null, ?string $cursor = null, ?string $apiKey = null): GeneratorReturns a Generator that yields provider imports one at a time, newest first, and requests the next page only once the current one is used up. Breaking out of the foreach stops the requests.
パラメーター
limitintPage size per request, from 1 to 100, defaulting to 25 on the server.
cursorstringA provider import id to start after.
apiKeystringOverrides the client's API key for every page of this walk.
戻り値
A Generator that yields one provider import array per step.
例
foreach ($client->providerImports->iterate() as $import) { if ($import['status'] === 'running') { echo $import['id'], ' is on ', $import['step'], PHP_EOL; break; }}注意事項
The generator is lazy, so an abandoned loop costs only the pages you consumed.
ほかの提供先
providerImports->get
Read one import from a sending provider
get(string $id, ?string $apiKey = null): arrayStatus, the step it is on and the report so far. Poll it while status is queued or running.
パラメーター
idstring必須Provider import id,
pimp_followed by 24 hex characters.apiKeystringOverrides the client's API key for this call only.
戻り値
An array with id, provider, status, resources, step, report, lastError, createdAt, startedAt and finishedAt. report holds an array for each resource, such as $import['report']['contacts']['added'].
例
use OpenEmail\Constants\ProviderImportStatuses; $import = $client->providerImports->get('pimp_3f9c2a7b1e4d8f60a5c7b92d'); while (in_array($import['status'], [ProviderImportStatuses::QUEUED, ProviderImportStatuses::RUNNING], true)) { sleep(5); $import = $client->providerImports->get($import['id']);} echo $import['status'], ': ', $import['report']['contacts']['added'] ?? 0, ' contacts added', PHP_EOL; foreach ($import['report']['domains'] ?? [] as $domain) { echo 'Add the domain ', $domain['name'], ' (', $domain['state'], ')', PHP_EOL;}ほかの提供先
providerImports->cancel
Cancel an import from a sending provider
cancel(string $id, ?string $apiKey = null): arrayStops the import and erases the provider key. What already came across stays.
パラメーター
idstring必須Provider import id,
pimp_followed by 24 hex characters.apiKeystringOverrides the client's API key for this call only.
戻り値
The provider import array, shaped like the one providerImports->get returns, with status set to cancelled.
例
$import = $client->providerImports->cancel('pimp_3f9c2a7b1e4d8f60a5c7b92d'); echo $import['id'], ' is ', $import['status'], ' at step ', $import['step'], PHP_EOL;