Mail

Send a message

POST/api/v1/mail/send

Who can use this: Any signed-in accountAs Markdown

The message goes out from your login address unless you name another in from, which must be one of the addresses you may send from (see List your addresses). It goes to one recipient, as plain text.

Parameters

Name	Where	What it is
to required	body	The one address to send it to.e.g. alex@example.com
subject required	body	The subject line.e.g. Lunch on Friday?
body required	body	The message, as plain text.e.g. Are you free at noon?
from	body	Send from this address instead of your login address. It may carry a name, as in `Shop <shop@example.com>`.

Good to know

Leaving out to, subject or body answers 400.
A from address you may not send from is refused with 403.
If the mail server won't take the message, the answer is 502.
Each message sent is recorded in your activity log, with its sender, recipient and subject.

curl -s -X POST 'https://api.mailmasker.org/api/v1/mail/send' \
  -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"to":"alex@example.com","subject":"Lunch on Friday?","body":"Are you free at noon?"}'

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

my $ua  = Mojo::UserAgent->new;
my $res = $ua->post('https://api.mailmasker.org/api/v1/mail/send',
    { Authorization => "Bearer $ENV{TOKEN}" },
    json => { to => 'alex@example.com', subject => 'Lunch on Friday?', body => 'Are you free at noon?' })->result;
die $res->code, ' ', ($res->json('/error') // $res->message), "\n" unless $res->is_success;
print $res->body, "\n";

homelab-cli mail send --to alex@example.com --subject "Lunch on Friday?" --body "Are you free at noon?"

Response 200 OK

{ "ok": true }