client.tools
Every method in this namespace: its signature, its parameters, what it returns and an example.
Methods
The free tools on the Nextmail 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.check_dmarc
Check a domain's DMARC policy
check_dmarc(domain, api_key: nil) -> HashReads 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 Nextmail website. stage is missing, invalid, monitor for p=none, quarantine or reject, and issues lists the problems written to be shown to a person.
Parameters
domainStringRequiredThe 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.api_keyStringOverrides the client's API key for this call only.
Returns
A Hash with domain, record, inheritedFrom, every tag in tags, stage and issues.
Example
report = client.tools.check_dmarc("acme.com") puts report[:stage], report[:tags][:p]p report[:issues]Notes
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.
Also available in
tools.check_bimi
Check a domain's BIMI logo
check_bimi(domain, api_key: nil) -> HashReads 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 Nextmail website. status is present, partial when the record is there but something stops inboxes showing the logo, absent or invalid, and issues says why.
Parameters
domainStringRequiredThe 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.api_keyStringOverrides the client's API key for this call only.
Returns
A Hash with record, logoUrl, authorityUrl, logoSvg, logoReachable, dmarcPolicy, dmarcEnforced, status and issues.
Example
report = client.tools.check_bimi("acme.com") p report[:issues] unless report[:status] == "present"Notes
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.
Also available in
tools.check_deliverability
Check a domain's deliverability
check_deliverability(domain, api_key: nil) -> HashChecks the records a receiving mailbox reads before it trusts mail from the domain, the deliverability checker on the Nextmail 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.
Parameters
domainStringRequiredThe 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.api_keyStringOverrides the client's API key for this call only.
Returns
A Hash with score, grade, provider and checks, an Array of Hashes each with id, label, status, verdict, record and notes.
Example
report = client.tools.check_deliverability("acme.com") puts report[:grade], report[:score]report[:checks].each { |check| puts check.values_at(:id, :status, :verdict).join(" ") }Notes
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.
Also available in
tools.read_verification_code
Read the sign-in code in a message
read_verification_code(body = nil, api_key: nil, **fields) -> HashFinds 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 Nextmail. 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, give code: nil.
It reads only what you send, so it cannot tell whether the sender is who it claims to be. The verificationCode on a message in your mailbox also requires the sender to pass authentication.
Parameters
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.api_keyStringOverrides the client's API key for this call only.
Returns
A Hash 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 nil when the reader is not sure.
Example
result = client.tools.read_verification_code( subject: "Your verification code", html: "<p>Your code is <b>396-696</b>. It expires in 10 minutes.</p>") puts result[:code] if result[:code]Notes
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.
Also available in
tools.estimate_cost
Estimate what Nextmail costs for a usage
estimate_cost(sends: nil, domains: nil, people: nil, ai_actions: nil, interval: nil, api_key: nil) -> HashPrices every plan for the usage you describe, as the cost calculator on the Nextmail 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.
Parameters
sendsIntegerEmails sent in a month. Defaults to 0.
domainsIntegerDomains you send from. Defaults to 1.
peopleIntegerPeople who use the workspace. Defaults to 1.
ai_actionsIntegerAI actions in a day, such as drafts, rewrites and summaries. Defaults to 0.
intervalStringHow you pay:
monthoryear. Defaults tomonth.api_keyStringOverrides the client's API key for this call only.
Returns
A Hash with interval, need, the usage that was priced with its defaults filled in, plans, an Array with one Hash per plan, and cheapest, the id of the cheapest plan that fits or nil. Each plan has plan, name, fits, blockers, baseCents, extraSends, sendsCents, extraAiActions, aiCents, extrasCents and totalCents, and blockers holds the values of Nextmail::PLAN_BLOCKERS that stop it fitting.
Example
estimate = client.tools.estimate_cost(sends: 25_000, domains: 2, people: 4, ai_actions: 30) best = estimate[:plans].find { |plan| plan[:plan] == estimate[:cheapest] }puts best[:name], best[:totalCents] if bestNotes
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.
Also available in
tools.check_address
Check an email address
check_address(email, deep: nil, api_key: nil) -> HashSays whether an address is worth sending to, the email checker on the Nextmail 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 nil.
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 nil.
Parameters
emailStringRequiredThe address to check, such as
ada@acme.com.deepBooleanAlso ask whether the mailbox exists. Billed per address through pay as you go. Defaults to false.
api_keyStringOverrides the client's API key for this call only.
Returns
A Hash with email, normalized, result, reasons, suggestion, checks, workspace and checkedAt.
Example
check = client.tools.check_address("ada@gmial.com") p check[:reasons], check[:suggestion] unless check[:result] == "valid"Notes
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 with
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's
max_retries:, and on a 429 only when it carries aRetry-Afterof a minute or less.
Also available in
tools.check_addresses
Check several email addresses
check_addresses(body = nil, api_key: nil, **fields) -> HashChecks up to 100 addresses in one call, each as check_address 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.
Parameters
emailsArrayRequiredThe addresses to check, from 1 to 100 Strings.
deepBooleanAlso ask whether each mailbox exists. Billed per address through pay as you go. Defaults to false.
api_keyStringOverrides the client's API key for this call only.
Returns
A Hash with one Hash per address in data, in the order they were sent.
Example
checks = client.tools.check_addresses(emails: ["ada@acme.com", "info@example.org"]) safe = checks[:data].select { |check| check[:result] == "valid" }.map { |check| check[:email] } p safeNotes
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.
Google Workspace
Fastmail