Skip to main content
New to Corsair? See API access, authentication, and error handling.

Validations

batch

validations.batch Start a batch validation job for at least 2 different email addresses; Mails.so documents it as paid-plan only, but a free account with credits ran batches in our test, and an account without access gets MailssoSubscriptionRequiredError. The job cannot be deleted through the API. It returns the job at once with no results: follow it with validations.getBatch until status is completed (it reads processing meanwhile). Risk: write
Input Needs at least 2 different addresses. Mails.so documents batches as paid-plan only, though a free account with credits ran one in our test. Returns the job at once with status pending and no results; read it with validations.getBatch. A write: it starts a job on your account that the API cannot delete, and it is never replayed after a 5xx. Output

getBatch

validations.getBatch Read a batch validation job by id: status processing while it runs, and once completed the counts per result and the validation of every address Risk: read
Input Reads processing with only the id and created_at while the job runs (HTTP 202 with a progress note in error), then completed with stats and emails. Mails.so documents no failed status and no cancel route. Output

single

validations.single Validate one email address: deliverability result and reason, a 0-100 score, and format, domain, MX, block-list, catch-all, generic, disposable and free-provider checks Risk: read
Input A malformed address answers 200 with result undeliverable and reason invalid_format, not an error. Mails.so reports the failure of a request as { data: null, error }, which the plugin throws as MailssoAPIError. Output