---
title: "$client->providerImports"
description: "Every method in this namespace: its signature, its parameters, what it returns and an example."
url: "https://openemail.uk/docs/php/reference/provider-imports"
area: "PHP"
category: "Reference"
---

# $client->providerImports

Every method in this namespace: its signature, its parameters, what it returns and an example.

## Methods

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

```php
inspect(string $providerKey, ?string $provider = null, ?string $apiKey = null): array
```

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

Scopes: `settings:write`.

**Parameters**

- `providerKey` (`string`, required): The key from the other provider: a full-access Resend key `re_…`, a SendGrid key `SG.…`, 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 the `apiKey` field of the request body, and it is not the `apiKey:` named argument, which overrides the OpenEmail key.
- `provider` (`string`): One of `resend`, `sendgrid`, `postmark`, `mailgun` and `mailchimp`, the values of `OpenEmail\Constants\ProviderImportProviders`. Defaults to `resend`.
- `apiKey` (`string`): Overrides the client's API key for this call only.

**Returns**

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

**Example**

```php
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;
}
```

**Notes**

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

Also available in: API [`POST /provider-imports/inspect`](https://openemail.uk/docs/api/reference/imports#post-provider-imports-inspect); TypeScript [`providerImports.inspect()`](https://openemail.uk/docs/sdk/reference/provider-imports#inspect); Python [`provider_imports.inspect()`](https://openemail.uk/docs/python/reference/provider-imports#inspect); Ruby [`provider_imports.inspect`](https://openemail.uk/docs/ruby/reference/provider-imports#inspect); CLI [`openemail provider-imports inspect`](https://openemail.uk/docs/cli/reference/provider-imports#provider-imports-inspect).

### `providerImports->create`

Import from another provider

```php
create(array $body, ?string $apiKey = null): array
```

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

Scopes: `settings:write`.

**Parameters**

- `apiKey` (`string`, required): The key from the other provider: a full-access Resend key `re_…`, a SendGrid key `SG.…`, a Postmark Server API token, a Mailgun private API key or a Mailchimp key ending in its datacenter, such as `-us6`. This is the `apiKey` field of the body array, which is not the `apiKey:` named argument that overrides the OpenEmail key.
- `provider` (`string`): One of `resend`, `sendgrid`, `postmark`, `mailgun` and `mailchimp`, the values of `OpenEmail\Constants\ProviderImportProviders`. Left out, the server takes `resend`.
- `resources` (`string[]`, required): Any of `suppressions`, `audiences`, `contacts`, `templates`, `webhooks`, `domains` and `api-keys`, the values of `OpenEmail\Constants\ProviderImportResources`.
- `apiKey` (`string`): The named argument that overrides the client's API key for this call only.

**Returns**

An array for the provider import, shaped like the one `providerImports->get` returns, with `status` set to `queued`.

**Example**

```php
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;
```

**Notes**

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

Also available in: API [`POST /provider-imports`](https://openemail.uk/docs/api/reference/imports#post-provider-imports); TypeScript [`providerImports.create()`](https://openemail.uk/docs/sdk/reference/provider-imports#create); Python [`provider_imports.create()`](https://openemail.uk/docs/python/reference/provider-imports#create); Ruby [`provider_imports.create`](https://openemail.uk/docs/ruby/reference/provider-imports#create); CLI [`openemail provider-imports create`](https://openemail.uk/docs/cli/reference/provider-imports#provider-imports-create).

### `providerImports->list`

List one page of imports from sending providers

```php
list(?int $limit = null, ?string $cursor = null, ?string $apiKey = null): Page
```

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

Scopes: `settings:read`.

**Parameters**

- `limit` (`int`): Rows per page, a whole number from 1 to 100. The server defaults to 25.
- `cursor` (`string`): The `nextCursor` from the previous page. One that names no provider import in the workspace is a 400 `invalid_cursor`.
- `apiKey` (`string`): Overrides the client's API key for this call only.

**Returns**

A `Page` of provider import arrays, with `items`, `hasMore` and `nextCursor`.

**Example**

```php
$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;
}
```

Also available in: API [`GET /provider-imports`](https://openemail.uk/docs/api/reference/imports#get-provider-imports); TypeScript [`providerImports.list()`](https://openemail.uk/docs/sdk/reference/provider-imports#list); Python [`provider_imports.list()`](https://openemail.uk/docs/python/reference/provider-imports#list); Ruby [`provider_imports.list`](https://openemail.uk/docs/ruby/reference/provider-imports#list); CLI [`openemail provider-imports list`](https://openemail.uk/docs/cli/reference/provider-imports#provider-imports-list).

### `providerImports->listAll`

Collect every provider import into one array

```php
listAll(?int $limit = null, ?string $cursor = null, ?string $apiKey = null): array
```

Follows `nextCursor` from page to page and returns every provider import in the workspace, newest first, each with its report.

Scopes: `settings:read`.

**Parameters**

- `limit` (`int`): Page size per request, from 1 to 100, defaulting to 25 on the server.
- `cursor` (`string`): A provider import id to start after.
- `apiKey` (`string`): Overrides the client's API key for every page of this walk.

**Returns**

A list of provider import arrays holding every provider import across all pages.

**Example**

```php
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;
```

**Notes**

- A failure on any page throws out of the whole call, and none of the pages already read are returned.

Also available in: API [`GET /provider-imports`](https://openemail.uk/docs/api/reference/imports#get-provider-imports); TypeScript [`providerImports.listAll()`](https://openemail.uk/docs/sdk/reference/provider-imports#listAll); Python [`provider_imports.list_all()`](https://openemail.uk/docs/python/reference/provider-imports#listAll); Ruby [`provider_imports.list_all`](https://openemail.uk/docs/ruby/reference/provider-imports#listAll).

### `providerImports->iterate`

Stream provider imports one at a time

```php
iterate(?int $limit = null, ?string $cursor = null, ?string $apiKey = null): Generator
```

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

Scopes: `settings:read`.

**Parameters**

- `limit` (`int`): Page size per request, from 1 to 100, defaulting to 25 on the server.
- `cursor` (`string`): A provider import id to start after.
- `apiKey` (`string`): Overrides the client's API key for every page of this walk.

**Returns**

A `Generator` that yields one provider import array per step.

**Example**

```php
foreach ($client->providerImports->iterate() as $import) {
    if ($import['status'] === 'running') {
        echo $import['id'], ' is on ', $import['step'], PHP_EOL;

        break;
    }
}
```

**Notes**

- The generator is lazy, so an abandoned loop costs only the pages you consumed.

Also available in: API [`GET /provider-imports`](https://openemail.uk/docs/api/reference/imports#get-provider-imports); TypeScript [`providerImports.iterate()`](https://openemail.uk/docs/sdk/reference/provider-imports#iterate); Python [`provider_imports.iterate()`](https://openemail.uk/docs/python/reference/provider-imports#iterate); Ruby [`provider_imports.iterate`](https://openemail.uk/docs/ruby/reference/provider-imports#iterate).

### `providerImports->get`

Read one import from a sending provider

```php
get(string $id, ?string $apiKey = null): array
```

Status, the step it is on and the report so far. Poll it while `status` is `queued` or `running`.

Scopes: `settings:read`.

**Parameters**

- `id` (`string`, required): Provider import id, `pimp_` followed by 24 hex characters.
- `apiKey` (`string`): Overrides the client's API key for this call only.

**Returns**

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']`.

**Example**

```php
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;
}
```

Also available in: API [`GET /provider-imports/{id}`](https://openemail.uk/docs/api/reference/imports#get-provider-imports-id); TypeScript [`providerImports.get()`](https://openemail.uk/docs/sdk/reference/provider-imports#get); Python [`provider_imports.get()`](https://openemail.uk/docs/python/reference/provider-imports#get); Ruby [`provider_imports.get`](https://openemail.uk/docs/ruby/reference/provider-imports#get); CLI [`openemail provider-imports get`](https://openemail.uk/docs/cli/reference/provider-imports#provider-imports-get).

### `providerImports->cancel`

Cancel an import from a sending provider

```php
cancel(string $id, ?string $apiKey = null): array
```

Stops the import and erases the provider key. What already came across stays.

Scopes: `settings:write`.

**Parameters**

- `id` (`string`, required): Provider import id, `pimp_` followed by 24 hex characters.
- `apiKey` (`string`): Overrides the client's API key for this call only.

**Returns**

The provider import array, shaped like the one `providerImports->get` returns, with `status` set to `cancelled`.

**Example**

```php
$import = $client->providerImports->cancel('pimp_3f9c2a7b1e4d8f60a5c7b92d');

echo $import['id'], ' is ', $import['status'], ' at step ', $import['step'], PHP_EOL;
```

Also available in: API [`POST /provider-imports/{id}/cancel`](https://openemail.uk/docs/api/reference/imports#post-provider-imports-id-cancel); TypeScript [`providerImports.cancel()`](https://openemail.uk/docs/sdk/reference/provider-imports#cancel); Python [`provider_imports.cancel()`](https://openemail.uk/docs/python/reference/provider-imports#cancel); Ruby [`provider_imports.cancel`](https://openemail.uk/docs/ruby/reference/provider-imports#cancel); CLI [`openemail provider-imports cancel`](https://openemail.uk/docs/cli/reference/provider-imports#provider-imports-cancel).