---
title: "client.provider_imports"
description: "Every method in this namespace: its signature, its parameters, what it returns and an example."
url: "https://nextmail.sh/docs/ruby/reference/provider-imports"
area: "Ruby"
category: "Reference"
---

# client.provider_imports

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.

### `provider_imports.inspect`

Look inside an account at another provider before importing

```ruby
inspect(provider_key = nil, provider: nil, api_key: nil) -> Hash
```

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

- `provider_key` (`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 goes in the request body and is not the Nextmail key the call authenticates with.
- `provider` (`String`): One of `resend`, `sendgrid`, `postmark`, `mailgun` and `mailchimp`, the values of `Nextmail::PROVIDER_IMPORT_PROVIDERS`. Left out, the server takes `resend`.
- `api_key` (`String`): Overrides the client API key for this call only.

**Returns**

A Hash with `provider`, `resources` and `counts`, which holds one Hash per resource (`suppressions`, `audiences`, `contacts`, `templates`, `webhooks`, `domains` and `api-keys`), each with `count` and `more`.

**Example**

```ruby
inventory = client.provider_imports.inspect("SG.8Rk2Lq5T7nVwX3yZp9QhMcB4dFs6JgA", provider: "sendgrid")

p inventory[:resources], inventory[:counts][:contacts]
```

**Notes**

- A key restricted to addresses or domains is refused, since audiences, suppressions and templates belong to the whole workspace.
- Called with no argument, `inspect` is Ruby's own and describes the resource object without calling the API, so always pass the provider key.
- 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://nextmail.sh/docs/api/reference/imports#post-provider-imports-inspect); TypeScript [`nextmail.providerImports.inspect()`](https://nextmail.sh/docs/sdk/reference/provider-imports#inspect); Python [`provider_imports.inspect()`](https://nextmail.sh/docs/python/reference/provider-imports#inspect); PHP [`providerImports->inspect`](https://nextmail.sh/docs/php/reference/provider-imports#inspect); Go [`ProviderImports.Inspect`](https://nextmail.sh/docs/go/reference/provider-imports#inspect); Java [`providerImports().inspect`](https://nextmail.sh/docs/java/reference/provider-imports#inspect); C# [`ProviderImports.InspectAsync`](https://nextmail.sh/docs/csharp/reference/provider-imports#inspect); CLI [`nextmail provider-imports inspect`](https://nextmail.sh/docs/cli/reference/provider-imports#provider-imports-inspect).

### `provider_imports.create`

Import from another provider

```ruby
create(body = nil, api_key: nil, **fields) -> Hash
```

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. A contact who unsubscribed at the provider is not imported and is recorded as unsubscribed, so `suppressions.list_unsubscribes` lists them. 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, as `inspect` takes it. This is the body field `apiKey:`, which is not the `api_key:` option that overrides the Nextmail key.
- `provider` (`String`): One of `resend`, `sendgrid`, `postmark`, `mailgun` and `mailchimp`. Left out, the server takes `resend`.
- `resources` (`Array<String>`, required): Any of `suppressions`, `audiences`, `contacts`, `templates`, `webhooks`, `domains` and `api-keys`.
- `api_key` (`String`): Overrides the client API key for this call only.

**Returns**

A Hash for the provider import, shaped like the one `get` returns, with `status` set to `queued`.

**Example**

```ruby
job = client.provider_imports.create(
  apiKey: "re_8Rk2Lq5T_7nVwX3yZp9QhMcB4dFs6JgA",
  provider: "resend",
  resources: ["suppressions", "audiences", "contacts", "templates", "webhooks", "domains", "api-keys"]
)

puts job[:id], job[:status]
```

**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 `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://nextmail.sh/docs/api/reference/imports#post-provider-imports); TypeScript [`nextmail.providerImports.create()`](https://nextmail.sh/docs/sdk/reference/provider-imports#create); Python [`provider_imports.create()`](https://nextmail.sh/docs/python/reference/provider-imports#create); PHP [`providerImports->create`](https://nextmail.sh/docs/php/reference/provider-imports#create); Go [`ProviderImports.Create`](https://nextmail.sh/docs/go/reference/provider-imports#create); Java [`providerImports().create`](https://nextmail.sh/docs/java/reference/provider-imports#create); C# [`ProviderImports.CreateAsync`](https://nextmail.sh/docs/csharp/reference/provider-imports#create); CLI [`nextmail provider-imports create`](https://nextmail.sh/docs/cli/reference/provider-imports#provider-imports-create).

### `provider_imports.list`

List one page of imports from sending providers

```ruby
list(limit: nil, cursor: nil, api_key: nil) -> Nextmail::Page
```

One page of the provider imports in the workspace, newest first, each with its report. Nothing is dropped from the history: follow `next_cursor` while `has_more?` is true to reach the first one, or let `list_all` and `iterate` do that walk.

Scopes: `settings:read`.

**Parameters**

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

**Returns**

The `Nextmail::Page` of provider import Hashes, with `items`, `has_more?` and `next_cursor`.

**Example**

```ruby
page = client.provider_imports.list

p page.items.map { |job| job[:status] }, page.has_more?
```

Also available in: API [`GET /provider-imports`](https://nextmail.sh/docs/api/reference/imports#get-provider-imports); TypeScript [`nextmail.providerImports.list()`](https://nextmail.sh/docs/sdk/reference/provider-imports#list); Python [`provider_imports.list()`](https://nextmail.sh/docs/python/reference/provider-imports#list); PHP [`providerImports->list`](https://nextmail.sh/docs/php/reference/provider-imports#list); Go [`ProviderImports.List`](https://nextmail.sh/docs/go/reference/provider-imports#list); Java [`providerImports().list`](https://nextmail.sh/docs/java/reference/provider-imports#list); C# [`ProviderImports.ListAsync`](https://nextmail.sh/docs/csharp/reference/provider-imports#list); CLI [`nextmail provider-imports list`](https://nextmail.sh/docs/cli/reference/provider-imports#provider-imports-list).

### `provider_imports.list_all`

Collect every provider import into one array

```ruby
list_all(limit: nil, cursor: nil, api_key: nil) -> Array<Hash>
```

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

Scopes: `settings:read`.

**Parameters**

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

**Returns**

An Array of provider import Hashes holding every provider import across all pages.

**Example**

```ruby
jobs = client.provider_imports.list_all

puts jobs.count { |job| job[:status] == "completed" }
```

**Notes**

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

Also available in: API [`GET /provider-imports`](https://nextmail.sh/docs/api/reference/imports#get-provider-imports); TypeScript [`nextmail.providerImports.listAll()`](https://nextmail.sh/docs/sdk/reference/provider-imports#listAll); Python [`provider_imports.list_all()`](https://nextmail.sh/docs/python/reference/provider-imports#listAll); PHP [`providerImports->listAll`](https://nextmail.sh/docs/php/reference/provider-imports#listAll); Go [`ProviderImports.ListAll`](https://nextmail.sh/docs/go/reference/provider-imports#listAll); Java [`providerImports().listAll`](https://nextmail.sh/docs/java/reference/provider-imports#listAll); C# [`ProviderImports.ListAllAsync`](https://nextmail.sh/docs/csharp/reference/provider-imports#listAll).

### `provider_imports.iterate`

Stream provider imports one at a time

```ruby
iterate(limit: nil, cursor: nil, api_key: nil, &block) -> Enumerator<Hash>
```

Returns an Enumerator that yields provider imports individually, newest first, or yields each one to a block when given one, and requests the next page only once the current one is drained. Breaking out of the loop stops the requests.

Scopes: `settings:read`.

**Parameters**

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

**Returns**

An Enumerator of provider import Hashes (or yields each one to a block), one provider import per step.

**Example**

```ruby
client.provider_imports.iterate do |job|
  puts job[:id] if job[:status] == "running"
end
```

**Notes**

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

Also available in: API [`GET /provider-imports`](https://nextmail.sh/docs/api/reference/imports#get-provider-imports); TypeScript [`nextmail.providerImports.iterate()`](https://nextmail.sh/docs/sdk/reference/provider-imports#iterate); Python [`provider_imports.iterate()`](https://nextmail.sh/docs/python/reference/provider-imports#iterate); PHP [`providerImports->iterate`](https://nextmail.sh/docs/php/reference/provider-imports#iterate); Go [`ProviderImports.Iterate`](https://nextmail.sh/docs/go/reference/provider-imports#iterate); Java [`providerImports().iterate`](https://nextmail.sh/docs/java/reference/provider-imports#iterate); C# [`ProviderImports.IterateAsync`](https://nextmail.sh/docs/csharp/reference/provider-imports#iterate).

### `provider_imports.get`

Read one import from a sending provider

```ruby
get(id, api_key: nil) -> Hash
```

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.
- `api_key` (`String`): Overrides the client API key for this call only.

**Returns**

A Hash with `id`, `provider`, `status`, `resources`, `step`, `report`, `lastError`, `createdAt`, `startedAt` and `finishedAt`. `report` holds a Hash for each resource, such as `report[:contacts][:added]`.

**Example**

```ruby
job = client.provider_imports.get("pimp_3f9c2a7b1e4d8f60a5c7b92d")

puts job[:status], job[:report][:contacts][:added]
```

Also available in: API [`GET /provider-imports/{id}`](https://nextmail.sh/docs/api/reference/imports#get-provider-imports-id); TypeScript [`nextmail.providerImports.get()`](https://nextmail.sh/docs/sdk/reference/provider-imports#get); Python [`provider_imports.get()`](https://nextmail.sh/docs/python/reference/provider-imports#get); PHP [`providerImports->get`](https://nextmail.sh/docs/php/reference/provider-imports#get); Go [`ProviderImports.Get`](https://nextmail.sh/docs/go/reference/provider-imports#get); Java [`providerImports().get`](https://nextmail.sh/docs/java/reference/provider-imports#get); C# [`ProviderImports.GetAsync`](https://nextmail.sh/docs/csharp/reference/provider-imports#get); CLI [`nextmail provider-imports get`](https://nextmail.sh/docs/cli/reference/provider-imports#provider-imports-get).

### `provider_imports.cancel`

Cancel an import from a sending provider

```ruby
cancel(id, api_key: nil) -> Hash
```

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.
- `api_key` (`String`): Overrides the client API key for this call only.

**Returns**

The provider import Hash, shaped like the one `get` returns, with `status` set to `cancelled`.

**Example**

```ruby
client.provider_imports.cancel("pimp_3f9c2a7b1e4d8f60a5c7b92d")
```

Also available in: API [`POST /provider-imports/{id}/cancel`](https://nextmail.sh/docs/api/reference/imports#post-provider-imports-id-cancel); TypeScript [`nextmail.providerImports.cancel()`](https://nextmail.sh/docs/sdk/reference/provider-imports#cancel); Python [`provider_imports.cancel()`](https://nextmail.sh/docs/python/reference/provider-imports#cancel); PHP [`providerImports->cancel`](https://nextmail.sh/docs/php/reference/provider-imports#cancel); Go [`ProviderImports.Cancel`](https://nextmail.sh/docs/go/reference/provider-imports#cancel); Java [`providerImports().cancel`](https://nextmail.sh/docs/java/reference/provider-imports#cancel); C# [`ProviderImports.CancelAsync`](https://nextmail.sh/docs/csharp/reference/provider-imports#cancel); CLI [`nextmail provider-imports cancel`](https://nextmail.sh/docs/cli/reference/provider-imports#provider-imports-cancel).