client.Tools
Chaque méthode de cet espace de noms : sa signature, ses paramètres, ce qu'elle retourne et un exemple.
Méthodes
The free tools on the OpenEmail website: checks of the public mail records of any domain, which are its DMARC policy, its BIMI logo and a deliverability report across MX, SPF, DKIM, DMARC and BIMI, a reader for the sign-in code in a message, and the price of every plan for a usage. They need no scope.
Tools.CheckDmarcAsync
Check a domain's DMARC policy
Task<JsonObject> CheckDmarcAsync( string domain, string? apiKey = null, CancellationToken cancellationToken = default)Reads the domain's DMARC record from public DNS, or the record of the organisational domain it inherits from, and says how strict it is and what is wrong with it, the DMARC checker on the OpenEmail website. stage is missing, invalid, monitor for p=none, quarantine or reject, and issues lists the problems written to be shown to a person.
Paramètres
domainstringObligatoireThe domain to check, such as
acme.com. An email address or a URL is read as its domain, and any public domain works, not only the ones in this workspace.apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Retourne
A JsonObject with domain, record, inheritedFrom, every tag in tags, stage and issues.
Exemple
var report = await client.Tools.CheckDmarcAsync("acme.com"); Console.WriteLine($"{report["stage"]} with p={report["tags"]?["p"]?.ToString() ?? "none"}"); foreach (var issue in report["issues"]?.AsArray() ?? []){ Console.WriteLine($"- {issue}");}Remarques
Needs no scope: any key or access token for the workspace may run it.
A domain that does not read as one is 422
invalid_parameterondomain, and DNS that did not answer is 503unreachable, which is worth retrying.
Aussi disponible dans
Tools.CheckBimiAsync
Check a domain's BIMI logo
Task<JsonObject> CheckBimiAsync( string domain, string? apiKey = null, CancellationToken cancellationToken = default)Reads the domain's BIMI record, fetches the logo it names and checks the DMARC policy beside it, since inboxes draw a logo only at p=quarantine or p=reject, the BIMI checker on the OpenEmail website. status is present, partial when the record is there but something stops inboxes showing the logo, absent or invalid, and issues says why.
Paramètres
domainstringObligatoireThe domain to check, such as
acme.com. An email address or a URL is read as its domain, and any public domain works, not only the ones in this workspace.apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Retourne
A JsonObject with record, logoUrl, authorityUrl, logoSvg, logoReachable, dmarcPolicy, dmarcEnforced, status and issues.
Exemple
var report = await client.Tools.CheckBimiAsync("acme.com"); if ((string?)report["status"] != "present"){ Console.WriteLine($"{string.Join(Environment.NewLine, report["issues"]?.AsArray() ?? [])}");}Remarques
Needs no scope: any key or access token for the workspace may run it.
A domain that does not read as one is 422
invalid_parameterondomain, and DNS that did not answer is 503unreachable, which is worth retrying.
Aussi disponible dans
- API
GET /tools/bimi- TypeScript
tools.checkBimi()- Python
tools.check_bimi()- Ruby
tools.check_bimi- PHP
tools->checkBimi- Go
Tools.CheckBimi- Java
tools().checkBimi- CLI
openemail tools check-bimi
Tools.CheckDeliverabilityAsync
Check a domain's deliverability
Task<JsonObject> CheckDeliverabilityAsync( string domain, string? apiKey = null, CancellationToken cancellationToken = default)Checks the records a receiving mailbox reads before it trusts mail from the domain, the deliverability checker on the OpenEmail website: MX, SPF, DKIM at the selectors its mail provider uses, DMARC and BIMI. Each check says pass, warn, fail or absent with a verdict and notes, and score weighs them into 0 to 100, graded A to F.
Paramètres
domainstringObligatoireThe domain to check, such as
acme.com. An email address or a URL is read as its domain, and any public domain works, not only the ones in this workspace.apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Retourne
A JsonObject with score, grade, provider and checks, a list of objects each with id, label, status, verdict, record and notes.
Exemple
var report = await client.Tools.CheckDeliverabilityAsync("acme.com"); Console.WriteLine($"{report["grade"]} ({report["score"]}/100)"); foreach (var check in report["checks"]?.AsArray() ?? []){ Console.WriteLine($"{check?["id"]} {check?["status"]} {check?["verdict"]}");}Remarques
Needs no scope: any key or access token for the workspace may run it.
A domain that does not read as one is 422
invalid_parameterondomain, and DNS that did not answer is 503unreachable, which is worth retrying.
Aussi disponible dans
Tools.ReadVerificationCodeAsync
Read the sign-in code in a message
Task<JsonObject> ReadVerificationCodeAsync( IReadOnlyDictionary<string, object?> body, string? apiKey = null, CancellationToken cancellationToken = default)Finds the sign-in or verification code in a message you pass in, with the reader that puts a code at the top of a message in OpenEmail. Send the whole MIME source as raw, or the subject with html or text.
It answers only when it is sure: the message has to hold exactly one code worded as one, such as a verification code, a one-time code or a security code, in any of the common languages. Two different codes, or a number that could be an order, a booking, a meeting, a phone number or a promotion, leave code null.
It reads only what you send, so it cannot tell whether the sender is who it claims to be. The verificationCode that Threads.GetAsync returns on each message of your mailbox also requires the sender to pass authentication.
Paramètres
rawstringThe whole message as MIME source, as it was received. Wins over the other fields when it is set.
subjectstringSubject line, at most 998 characters.
htmlstringHTML body. Links are left out before the code is looked for.
textstringPlain text body, used when there is no
html.apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Retourne
A JsonObject with object set to verification_code and code: the code as you would type it, digits only or capital letters and digits without spaces or dashes, or null when the reader is not sure.
Exemple
var result = await client.Tools.ReadVerificationCodeAsync(new Body{ ["subject"] = "Your verification code", ["html"] = "<p>Your code is <b>396-696</b>. It expires in 10 minutes.</p>",}); if (result["code"] is not null){ Console.WriteLine($"{result["code"]}");} var fromSource = await client.Tools.ReadVerificationCodeAsync(new Body { ["raw"] = await File.ReadAllBytesAsync("message.eml") }); Console.WriteLine($"{fromSource["code"]?.ToString() ?? "No code"}");Remarques
Needs no scope: any key or access token for the workspace may run it.
Nothing is stored and no model is called, so it is safe to run on every message.
A body with none of
raw,subject,htmlortextis 422invalid_parameter.
Aussi disponible dans
Tools.EstimateCostAsync
Estimate what OpenEmail costs for a usage
Task<JsonObject> EstimateCostAsync( int? sends = null, int? domains = null, int? people = null, int? aiActions = null, string? interval = null, string? apiKey = null, CancellationToken cancellationToken = default)Prices every plan for the usage you describe, as the cost calculator on the OpenEmail website does: the plan itself, the extra sends and AI actions it would bill, the monthly total, and whether the plan fits at all. A plan does not fit when the usage needs more domains than it includes, more than one person without team access, or more sends than it allows without billing extra. cheapest names the cheapest plan that fits.
Amounts are in US cents per month. With interval: set to year, the plan price is the monthly equivalent of paying yearly.
Paramètres
sendsint?Emails sent in a month. Defaults to 0.
domainsint?Domains you send from. Defaults to 1.
peopleint?People who use the workspace. Defaults to 1.
aiActionsint?AI actions in a day, such as drafts, rewrites and summaries. Defaults to 0.
intervalstring?How you pay:
monthoryear, as inOpenEmail\Constants\BillingIntervals. Defaults tomonth.apiKeystring?Overrides the client's API key for this call only.
cancellationTokenCancellationTokenCancels the request.
Retourne
A JsonObject with object set to cost_estimate, the interval, the need that was priced with its defaults filled in, every plan in plans, each an object with plan, name, fits, blockers, baseCents, extraSends, sendsCents, extraAiActions, aiCents, extrasCents and totalCents, and cheapest, the id of the cheapest plan that fits, or null when none does.
Exemple
var estimate = await client.Tools.EstimateCostAsync(sends: 25000, domains: 2, people: 4, aiActions: 30); Console.WriteLine(estimate.ToJsonString());Remarques
Needs no scope: any key or access token for the workspace may run it.
It prices the plans as they are sold today and reads nothing in the workspace.
blockersnames what a plan cannot carry:domains,peopleorsends, the values inOpenEmail\Constants\PlanBlockers.
Aussi disponible dans
Tools.CheckAddressAsync
Check an email address
Task<JsonObject> CheckAddressAsync( string email, bool? deep = null, string? apiKey = null, CancellationToken cancellationToken = default)Says whether an address is worth sending to, the email checker on the OpenEmail website: result is valid, risky, invalid or unknown, and reasons says why. It checks the syntax, whether the domain takes mail at all, whether it is a throwaway domain or a shared address such as info@, and offers a correction in suggestion for a likely typo such as gmial.com. Run it on a sign-up form before the first message, or over a list before a broadcast.
With the emails:read scope, workspace also says what this workspace knows: whether it suppressed the address and when it last delivered to it or saw it bounce. It never shows another workspace's history, and without the scope it is null.
deep also asks whether the mailbox itself exists, in checks.mailbox. A deep check is billed per address through pay as you go and needs the emails:send scope. Without it the check is free and checks.mailbox is null.
Paramètres
emailstringObligatoireThe address to check, such as
[email protected].deepbool?Also ask whether the mailbox exists. Billed per address through pay as you go. Defaults to false.
cancellationTokenCancellationTokenCancels the request.
apiKeystring?Overrides the client's API key for this call only.
Retourne
A JsonObject with email, normalized, result, reasons, suggestion, checks, workspace and checkedAt.
Exemple
var check = await client.Tools.CheckAddressAsync("[email protected]"); Console.WriteLine($"{check["email"]} is {check["result"]}: {string.Join(", ", check["reasons"]?.AsArray() ?? [])}"); if ((string?)check["suggestion"] is { } suggestion){ Console.WriteLine($"Did you mean {suggestion}?");}Remarques
Needs no scope without
deep: any key or access token for the workspace may run it.An address whose syntax is wrong is not an error: it returns
resultinvalidand the reasoninvalid_syntax.With
deep, a workspace where pay as you go is off, paused or not part of the plan is 409deep_check_unavailable, a check that would pass its monthly limit is 409deep_check_limit_reached, and a mailbox check that did not answer is 503deep_check_unavailable. Nothing is billed for any of them.A GET is retried automatically on network failure and on 408, 500, 502, 503 and 504 responses, up to the client
MaxRetries, and on a 429 only when it carries aRetry-Afterof a minute or less.
Aussi disponible dans
Tools.CheckAddressesAsync
Check several email addresses
Task<JsonObject> CheckAddressesAsync( IReadOnlyDictionary<string, object?> body, string? apiKey = null, CancellationToken cancellationToken = default)Checks up to 100 addresses in one call, each as CheckAddressAsync does, and returns them in the order they were sent. Use it to clean a list before importing it or sending a broadcast to it.
deep applies to every address and is billed for each one that reaches the mailbox check, through pay as you go, and needs the emails:send scope.
Paramètres
emailsIEnumerable<string>ObligatoireThe addresses to check, from 1 to 100.
deepboolAlso ask whether each mailbox exists. Billed per address through pay as you go. Defaults to false.
cancellationTokenCancellationTokenCancels the request.
apiKeystring?Overrides the client's API key for this call only.
Retourne
A JsonObject with one object per address in data, in the order they were sent.
Exemple
var checks = await client.Tools.CheckAddressesAsync(new Body{ ["emails"] = new[] { "[email protected]", "[email protected]", "[email protected]" },}); foreach (var check in checks["data"]?.AsArray() ?? []){ Console.WriteLine($"{check?["email"]} is {check?["result"]}");}Remarques
Needs no scope without
deep: any key or access token for the workspace may run it.More than 100 addresses, or none, is 422
invalid_parameteronemails.It changes nothing, so it is safe to run again, but the SDK does not retry a POST.