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.InspectAsync
Look inside an account at another provider before importing
Task<JsonObject> InspectAsync( string providerKey, string? provider = null, string? apiKey = null, CancellationToken cancellationToken = default)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.
Parameters
providerKeystringRequiredThe 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.providerstring?One of
resend,sendgrid,postmark,mailgunandmailchimp, the values ofOpenEmail\Constants\ProviderImportProviders. Defaults toresend.apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Returns
A JsonObject with provider, resources and counts, which holds one object per resource (suppressions, audiences, contacts, templates, webhooks, domains and api-keys), each with count and more.
Example
using OpenEmail.Constants; var inventory = await client.ProviderImports.InspectAsync("SG.8Rk2Lq5T7nVwX3yZp9QhMcB4dFs6JgA", provider: ProviderImportProviders.Sendgrid); Console.WriteLine(inventory.ToJsonString());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
ProviderImports.CreateAsync
Import from another provider
Task<JsonObject> CreateAsync( IReadOnlyDictionary<string, object?> body, string? apiKey = null, CancellationToken cancellationToken = default)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.
Parameters
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 dictionary, 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.resourceslistRequiredAny of
suppressions,audiences,contacts,templates,webhooks,domainsandapi-keys, the values ofOpenEmail\Constants\ProviderImportResources.apiKeystring?The named argument that overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Returns
A JsonObject for the provider import, shaped like the one ProviderImports.GetAsync returns, with status set to queued.
Example
using OpenEmail.Constants; var import = await client.ProviderImports.CreateAsync(new Body{ ["apiKey"] = "SG.8Rk2Lq5T7nVwX3yZp9QhMcB4dFs6JgA", ["provider"] = ProviderImportProviders.Sendgrid, ["resources"] = ProviderImportResources.Values,}); Console.WriteLine($"{import["id"]} {import["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
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
ProviderImports.ListAsync
List one page of imports from sending providers
Task<Page> ListAsync( int? limit = null, string? cursor = null, string? apiKey = null, CancellationToken cancellationToken = default)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.ListAllAsync and ProviderImports.IterateAsync do that walk.
Parameters
limitint?Rows per page, a whole number from 1 to 100. The server defaults to 25.
cursorstring?The
nextCursorfrom the previous page. One that names no provider import in the workspace is a 400invalid_cursor.apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Returns
A Page of provider import objects, with items, hasMore and nextCursor.
Example
var page = await client.ProviderImports.ListAsync(limit: 10); foreach (var import in page){ Console.WriteLine($"{import["id"]} {import["provider"]} {import["status"]}");} if (page.HasMore){ var older = await client.ProviderImports.ListAsync(limit: 10, cursor: page.NextCursor); Console.WriteLine($"{older.Count} more on the next page");}Also available in
ProviderImports.ListAllAsync
Collect every provider import into one object
Task<IReadOnlyList<JsonObject>> ListAllAsync( int? limit = null, string? cursor = null, string? apiKey = null, CancellationToken cancellationToken = default)Follows nextCursor from page to page and returns every provider import in the workspace, newest first, each with its report.
Parameters
limitint?Page size per request, from 1 to 100, defaulting to 25 on the server.
cursorstring?A provider import id to start after.
apiKeystring?Overrides the client's API key for every page of this walk.
cancellationTokenCancellationTokenCancels the request.
Returns
A list of provider import objects holding every provider import across all pages.
Example
var imports = await client.ProviderImports.ListAllAsync(); Console.WriteLine(imports.Count);Notes
A failure on any page throws out of the whole call, and none of the pages already read are returned.
Also available in
ProviderImports.IterateAsync
Stream provider imports one at a time
IAsyncEnumerable<JsonObject> IterateAsync( int? limit = null, string? cursor = null, string? apiKey = null, CancellationToken cancellationToken = default)Returns an IAsyncEnumerable<JsonObject> 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.
Parameters
limitint?Page size per request, from 1 to 100, defaulting to 25 on the server.
cursorstring?A provider import id to start after.
apiKeystring?Overrides the client's API key for every page of this walk.
cancellationTokenCancellationTokenCancels the request.
Returns
An IAsyncEnumerable<JsonObject> that yields one provider import per step.
Example
await foreach (var import in client.ProviderImports.IterateAsync()){ if ((string?)import["status"] == "running") { Console.WriteLine($"{import["id"]} is on {import["step"]}"); break; }}Notes
The generator is lazy, so an abandoned loop costs only the pages you consumed.
Also available in
ProviderImports.GetAsync
Read one import from a sending provider
Task<JsonObject> GetAsync( string id, string? apiKey = null, CancellationToken cancellationToken = default)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.apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Returns
A JsonObject with id, provider, status, resources, step, report, lastError, createdAt, startedAt and finishedAt. report holds an object for each resource, such as import["report"]["contacts"]["added"].
Example
var import = await client.ProviderImports.GetAsync("pimp_3f9c2a7b1e4d8f60a5c7b92d"); Console.WriteLine($"{import["status"]}: {import["report"]?["contacts"]?["added"]?.ToString() ?? "0"} contacts added"); foreach (var domain in import["report"]?["domains"]?.AsArray() ?? []){ Console.WriteLine($"Add the domain {domain?["name"]} ({domain?["state"]})");}Also available in
ProviderImports.CancelAsync
Cancel an import from a sending provider
Task<JsonObject> CancelAsync( string id, string? apiKey = null, CancellationToken cancellationToken = default)Stops the import and erases the provider key. What already came across stays.
Parameters
idstringRequiredProvider import id,
pimp_followed by 24 hex characters.apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Returns
The provider import object, shaped like the one ProviderImports.GetAsync returns, with status set to cancelled.
Example
var import = await client.ProviderImports.CancelAsync("pimp_3f9c2a7b1e4d8f60a5c7b92d"); Console.WriteLine($"{import["id"]} is {import["status"]} at step {import["step"]}");