Queue a local reply in the outbox
curl --request POST \
--url http://localhost:3000/api/v1/mail/reply \
--header 'Content-Type: application/json' \
--data '
{
"message": "<string>",
"bcc": "<string>",
"body": "<string>",
"cc": "<string>",
"execute": true,
"from": "<string>",
"idempotencyKey": "<string>",
"subject": "<string>",
"to": "<string>"
}
'import requests
url = "http://localhost:3000/api/v1/mail/reply"
payload = {
"message": "<string>",
"bcc": "<string>",
"body": "<string>",
"cc": "<string>",
"execute": True,
"from": "<string>",
"idempotencyKey": "<string>",
"subject": "<string>",
"to": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
message: '<string>',
bcc: '<string>',
body: JSON.stringify('<string>'),
cc: '<string>',
execute: true,
from: '<string>',
idempotencyKey: '<string>',
subject: '<string>',
to: '<string>'
})
};
fetch('http://localhost:3000/api/v1/mail/reply', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/mail/reply",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'message' => '<string>',
'bcc' => '<string>',
'body' => '<string>',
'cc' => '<string>',
'execute' => true,
'from' => '<string>',
'idempotencyKey' => '<string>',
'subject' => '<string>',
'to' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/api/v1/mail/reply"
payload := strings.NewReader("{\n \"message\": \"<string>\",\n \"bcc\": \"<string>\",\n \"body\": \"<string>\",\n \"cc\": \"<string>\",\n \"execute\": true,\n \"from\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"subject\": \"<string>\",\n \"to\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3000/api/v1/mail/reply")
.header("Content-Type", "application/json")
.body("{\n \"message\": \"<string>\",\n \"bcc\": \"<string>\",\n \"body\": \"<string>\",\n \"cc\": \"<string>\",\n \"execute\": true,\n \"from\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"subject\": \"<string>\",\n \"to\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/mail/reply")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"message\": \"<string>\",\n \"bcc\": \"<string>\",\n \"body\": \"<string>\",\n \"cc\": \"<string>\",\n \"execute\": true,\n \"from\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"subject\": \"<string>\",\n \"to\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": {
"accountId": "<string>",
"addresses": [
{
"address": "<string>",
"agentId": "<string>",
"contactId": "<string>",
"displayName": "<string>",
"id": "<string>",
"kind": "from",
"messageId": "<string>",
"normalizedAddress": "<string>",
"platformIdentityId": "<string>",
"raw": {}
}
],
"attachments": [
{
"contentType": "<string>",
"filename": "<string>",
"id": "<string>",
"localBlobRef": "<string>",
"messageId": "<string>",
"metadata": {},
"providerAttachmentId": "<string>",
"redactionStatus": "<string>",
"sha256": "<string>",
"sizeBytes": 123
}
],
"bodyRedactionStatus": "full_local",
"createdAt": 123,
"dateHeaderAt": 123,
"direction": "inbound",
"id": "<string>",
"mailboxId": "<string>",
"providerHistoryId": "<string>",
"providerMessageId": "<string>",
"providerProvenance": {},
"providerThreadId": "<string>",
"receivedAt": 123,
"rfcMessageId": "<string>",
"safePayload": {},
"sentAt": 123,
"snippet": "<string>",
"status": "received",
"subject": "<string>",
"subjectNormalized": "<string>",
"threadId": "<string>",
"updatedAt": 123
},
"outbox": {
"accountId": "<string>",
"ackedAt": 123,
"attemptCount": 123,
"createdAt": 123,
"id": "<string>",
"idempotencyKey": "<string>",
"lastErrorCode": "<string>",
"mailboxId": "<string>",
"messageId": "<string>",
"nextAttemptAt": 123,
"operation": "send",
"payload": {},
"providerResult": {},
"status": "pending",
"updatedAt": 123
},
"queued": true
}mail
Queue a local reply in the outbox
POST
/
api
/
v1
/
mail
/
reply
Queue a local reply in the outbox
curl --request POST \
--url http://localhost:3000/api/v1/mail/reply \
--header 'Content-Type: application/json' \
--data '
{
"message": "<string>",
"bcc": "<string>",
"body": "<string>",
"cc": "<string>",
"execute": true,
"from": "<string>",
"idempotencyKey": "<string>",
"subject": "<string>",
"to": "<string>"
}
'import requests
url = "http://localhost:3000/api/v1/mail/reply"
payload = {
"message": "<string>",
"bcc": "<string>",
"body": "<string>",
"cc": "<string>",
"execute": True,
"from": "<string>",
"idempotencyKey": "<string>",
"subject": "<string>",
"to": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
message: '<string>',
bcc: '<string>',
body: JSON.stringify('<string>'),
cc: '<string>',
execute: true,
from: '<string>',
idempotencyKey: '<string>',
subject: '<string>',
to: '<string>'
})
};
fetch('http://localhost:3000/api/v1/mail/reply', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/mail/reply",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'message' => '<string>',
'bcc' => '<string>',
'body' => '<string>',
'cc' => '<string>',
'execute' => true,
'from' => '<string>',
'idempotencyKey' => '<string>',
'subject' => '<string>',
'to' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/api/v1/mail/reply"
payload := strings.NewReader("{\n \"message\": \"<string>\",\n \"bcc\": \"<string>\",\n \"body\": \"<string>\",\n \"cc\": \"<string>\",\n \"execute\": true,\n \"from\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"subject\": \"<string>\",\n \"to\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3000/api/v1/mail/reply")
.header("Content-Type", "application/json")
.body("{\n \"message\": \"<string>\",\n \"bcc\": \"<string>\",\n \"body\": \"<string>\",\n \"cc\": \"<string>\",\n \"execute\": true,\n \"from\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"subject\": \"<string>\",\n \"to\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/mail/reply")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"message\": \"<string>\",\n \"bcc\": \"<string>\",\n \"body\": \"<string>\",\n \"cc\": \"<string>\",\n \"execute\": true,\n \"from\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"subject\": \"<string>\",\n \"to\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": {
"accountId": "<string>",
"addresses": [
{
"address": "<string>",
"agentId": "<string>",
"contactId": "<string>",
"displayName": "<string>",
"id": "<string>",
"kind": "from",
"messageId": "<string>",
"normalizedAddress": "<string>",
"platformIdentityId": "<string>",
"raw": {}
}
],
"attachments": [
{
"contentType": "<string>",
"filename": "<string>",
"id": "<string>",
"localBlobRef": "<string>",
"messageId": "<string>",
"metadata": {},
"providerAttachmentId": "<string>",
"redactionStatus": "<string>",
"sha256": "<string>",
"sizeBytes": 123
}
],
"bodyRedactionStatus": "full_local",
"createdAt": 123,
"dateHeaderAt": 123,
"direction": "inbound",
"id": "<string>",
"mailboxId": "<string>",
"providerHistoryId": "<string>",
"providerMessageId": "<string>",
"providerProvenance": {},
"providerThreadId": "<string>",
"receivedAt": 123,
"rfcMessageId": "<string>",
"safePayload": {},
"sentAt": 123,
"snippet": "<string>",
"status": "received",
"subject": "<string>",
"subjectNormalized": "<string>",
"threadId": "<string>",
"updatedAt": 123
},
"outbox": {
"accountId": "<string>",
"ackedAt": 123,
"attemptCount": 123,
"createdAt": 123,
"id": "<string>",
"idempotencyKey": "<string>",
"lastErrorCode": "<string>",
"mailboxId": "<string>",
"messageId": "<string>",
"nextAttemptAt": 123,
"operation": "send",
"payload": {},
"providerResult": {},
"status": "pending",
"updatedAt": 123
},
"queued": true
}Body
application/json
Local message id to reply to
BCC recipient or comma-separated recipients
Reply body
CC recipient or comma-separated recipients
Actually queue the reply; default is a dry-run that only shows the plan (exit 3)
Local sender mailbox id or address
Local outbox idempotency key
Override reply subject
Override recipient or comma-separated recipients