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

# openemail.providerImports

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

## Methods

Move from Resend: suppressions, audiences, contacts, templates and webhooks come across with one key, with a checklist for domains and API keys.

### `providerImports.inspect()`

Look inside a Resend account before importing

```ts
inspect(apiKey: string, options?: RequestScope): Promise<ProviderInventoryResource>
```

Reads the first page of every resource with a full-access Resend key and returns a count for each, with `more` set where a resource runs past its first page. Nothing is stored, and the key is not kept.

A sending-only key is 400 `restricted_key`: create a full-access key at Resend for the import and revoke it afterwards.

Scopes: `settings:write`.

**Parameters**

- `apiKey` (`string`, required): A full-access Resend API key, `re_…`.
- `options.signal` (`AbortSignal`): Cancels the request.
- `options.apiKey` (`string`): Overrides the client API key for this call only.

**Returns**

`ProviderInventoryResource` with `counts` per resource.

**Example**

```ts
const inventory = await openemail.providerImports.inspect(process.env.RESEND_API_KEY!)

console.log(inventory.counts.contacts)
```

**Notes**

- A key restricted to addresses or domains is refused, since audiences, suppressions and templates belong to the whole workspace.

Also available in: API [`POST /provider-imports/inspect`](https://openemail.uk/docs/api/reference/imports#post-provider-imports-inspect); CLI [`openemail provider-imports inspect`](https://openemail.uk/docs/cli/reference/provider-imports#provider-imports-inspect).

### `providerImports.create()`

Import from Resend

```ts
create(body: ProviderImportCreate, options?: RequestScope): Promise<ProviderImportResource>
```

Queues an import from a Resend account. Suppressions keep their reason, segments 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 Resend.

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

- `body.apiKey` (`string`, required): A full-access Resend API key.
- `body.resources` (`Array<ProviderImportResourceKind>`, required): Any of `suppressions`, `audiences`, `contacts`, `templates`, `webhooks`, `domains` and `api-keys`.
- `options.signal` (`AbortSignal`): Cancels the request.
- `options.apiKey` (`string`): Overrides the client API key for this call only.

**Returns**

`ProviderImportResource` with `status: queued`.

**Example**

```ts
const job = await openemail.providerImports.create({
    apiKey: process.env.RESEND_API_KEY!,
    resources: ['suppressions', 'audiences', 'contacts', 'templates', 'webhooks', 'domains', 'api-keys']
})
```

**Notes**

- One import runs per workspace at a time; a second is 409 `already_running`.
- Contacts who unsubscribed at Resend are left out and counted in `report.contacts.unsubscribed`.

Also available in: API [`POST /provider-imports`](https://openemail.uk/docs/api/reference/imports#post-provider-imports); 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

```ts
list(options?: ProviderImportListOptions): Promise<Page<ProviderImportResource>>
```

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 `listAll` and `iterate` do that walk.

Scopes: `settings:read`.

**Parameters**

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

**Returns**

`Page<ProviderImportResource>` with `items`, `hasMore` and `nextCursor`.

**Example**

```ts
const page = await openemail.providerImports.list()

console.log(page.items.map((job) => job.status), page.hasMore)
```

Also available in: API [`GET /provider-imports`](https://openemail.uk/docs/api/reference/imports#get-provider-imports); 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

```ts
listAll(options?: ProviderImportListOptions): Promise<Array<ProviderImportResource>>
```

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

Scopes: `settings:read`.

**Parameters**

- `options.limit` (`number`): Page size per request, from 1 to 100, defaulting to 25 on the server.
- `options.cursor` (`string`): A provider import id to start after.
- `options.signal` (`AbortSignal`): Cancels the request in flight and rejects the whole walk.
- `options.apiKey` (`string`): Overrides the client API key for every page of this walk.

**Returns**

`Array<ProviderImportResource>` holding every provider import across all pages.

**Example**

```ts
const jobs = await openemail.providerImports.listAll()

console.log(jobs.filter((job) => job.status === 'completed').length)
```

**Notes**

- A failure on any page rejects the whole call.

Also available in: API [`GET /provider-imports`](https://openemail.uk/docs/api/reference/imports#get-provider-imports).

### `providerImports.iterate()`

Stream provider imports one at a time

```ts
iterate(options?: ProviderImportListOptions): AsyncGenerator<ProviderImportResource, void, undefined>
```

Returns an async generator that yields provider imports individually, newest first, and requests the next page only once the current one is drained. Breaking out of the loop stops the requests.

Scopes: `settings:read`.

**Parameters**

- `options.limit` (`number`): Page size per request, from 1 to 100, defaulting to 25 on the server.
- `options.cursor` (`string`): A provider import id to start after.
- `options.signal` (`AbortSignal`): Cancels the request in flight and rejects the whole walk.
- `options.apiKey` (`string`): Overrides the client API key for every page of this walk.

**Returns**

`AsyncGenerator<ProviderImportResource, void, undefined>` yielding one provider import per step.

**Example**

```ts
for await (const job of openemail.providerImports.iterate()) {
    if (job.status === 'running') console.log(job.id)
}
```

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

### `providerImports.get()`

Read one import from a sending provider

```ts
get(id: string, options?: RequestScope): Promise<ProviderImportResource>
```

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.
- `options.signal` (`AbortSignal`): Cancels the request.
- `options.apiKey` (`string`): Overrides the client API key for this call only.

**Returns**

`ProviderImportResource`.

**Example**

```ts
const job = await openemail.providerImports.get('pimp_3f9c2a7b1e4d8f60a5c7b92d')

console.log(job.status, job.report.contacts.added)
```

Also available in: API [`GET /provider-imports/{id}`](https://openemail.uk/docs/api/reference/imports#get-provider-imports-id); 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

```ts
cancel(id: string, options?: RequestScope): Promise<ProviderImportResource>
```

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

Scopes: `settings:write`.

**Parameters**

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

**Returns**

`ProviderImportResource` with `status: cancelled`.

**Example**

```ts
await openemail.providerImports.cancel('pimp_3f9c2a7b1e4d8f60a5c7b92d')
```

Also available in: API [`POST /provider-imports/{id}/cancel`](https://openemail.uk/docs/api/reference/imports#post-provider-imports-id-cancel); CLI [`openemail provider-imports cancel`](https://openemail.uk/docs/cli/reference/provider-imports#provider-imports-cancel).