Check that a mailbox exists

GET/api/v1/mail/recipient-exists

Who can use this: Site admins, and accounts granted the domains.catchall permissionAs Markdown

Matches the whole address exactly, ignoring case, and never lists or suggests others. Use it before setting a catch-all, which doesn't check its destination.

Parameters

Name	Where	What it is
email required	query	The full address to check.e.g. you@example.com

Good to know

A suspended account, or text without an @, answers false.

curl -s 'https://api.mailmasker.org/api/v1/mail/recipient-exists?email=you%40example.com' \
  -H "Authorization: Bearer $TOKEN"

use Mojo::Base -strict;
use Mojo::UserAgent;

my $ua  = Mojo::UserAgent->new;
my $res = $ua->get('https://api.mailmasker.org/api/v1/mail/recipient-exists',
    { Authorization => "Bearer $ENV{TOKEN}" },
    form => { email => 'you@example.com' })->result;
die $res->code, ' ', ($res->json('/error') // $res->message), "\n" unless $res->is_success;
print $res->body, "\n";

There's no homelab-cli command for this yet.

Response 200 OK

{ "exists": true }