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
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.
Parameters
apiKeystringRequiredA full-access Resend API key,
re_….options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client API key for this call only.
Returns
ProviderInventoryResource with counts per resource.
Example
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
providerImports.create()
Import from Resend
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.
Parameters
body.apiKeystringRequiredA full-access Resend API key.
body.resourcesArray<ProviderImportResourceKind>RequiredAny of
suppressions,audiences,contacts,templates,webhooks,domainsandapi-keys.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client API key for this call only.
Returns
ProviderImportResource with status: queued.
Example
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
providerImports.list()
List one page of imports from sending providers
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.
Parameters
options.limitnumberRows per page, a whole number from 1 to 100. The server defaults to 25.
options.cursorstringThe
nextCursorfrom the previous page. One that names no provider import in the workspace is a 400invalid_cursor.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client API key for this call only.
Returns
Page<ProviderImportResource> with items, hasMore and nextCursor.
Example
const page = await openemail.providerImports.list() console.log(page.items.map((job) => job.status), page.hasMore)Also available in
providerImports.listAll()
Collect every provider import into one array
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.
Parameters
options.limitnumberPage size per request, from 1 to 100, defaulting to 25 on the server.
options.cursorstringA provider import id to start after.
options.signalAbortSignalCancels the request in flight and rejects the whole walk.
options.apiKeystringOverrides the client API key for every page of this walk.
Returns
Array<ProviderImportResource> holding every provider import across all pages.
Example
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
providerImports.iterate()
Stream provider imports one at a time
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.
Parameters
options.limitnumberPage size per request, from 1 to 100, defaulting to 25 on the server.
options.cursorstringA provider import id to start after.
options.signalAbortSignalCancels the request in flight and rejects the whole walk.
options.apiKeystringOverrides the client API key for every page of this walk.
Returns
AsyncGenerator<ProviderImportResource, void, undefined> yielding one provider import per step.
Example
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
providerImports.get()
Read one import from a sending provider
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.
Parameters
idstringRequiredProvider import id,
pimp_followed by 24 hex characters.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client API key for this call only.
Returns
ProviderImportResource.
Example
const job = await openemail.providerImports.get('pimp_3f9c2a7b1e4d8f60a5c7b92d') console.log(job.status, job.report.contacts.added)Also available in
providerImports.cancel()
Cancel an import from a sending provider
cancel(id: string, options?: RequestScope): Promise<ProviderImportResource>Stops the import and erases the Resend key. What already came across stays.
Parameters
idstringRequiredProvider import id,
pimp_followed by 24 hex characters.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client API key for this call only.
Returns
ProviderImportResource with status: cancelled.
Example
await openemail.providerImports.cancel('pimp_3f9c2a7b1e4d8f60a5c7b92d')