Bir mektup gönder

API 0.16.0OpenAPIllms-full.txt

POST/v1/mailboxes/{mailbox_id}/send

Gerekli Idempotency-Key 8–128 karakter uzunluğunda. Aynı tuş ve gövdeyle tekrarlamak aynı işlemi döndürür; başka bir kuruluş 409 veriyor. HTTP 202 sıraya girmek anlamına geliyor. Yanıtın alınıp alınmadığını değil, işlemin durumunu kontrol edin.

Yetki ve erişim alanları · Hatalar ve tekrarlar

Rica etmek

curl -X POST 'https://adapt-mail.com/v1/mailboxes/<mailbox_id>/send' \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Idempotency-Key: message-20261019-0001' \
  -H 'Content-Type: application/json' \
  --data '{"to":["[email protected]"],"subject":"Hello","text":"A message from Adapt Mail"}'

Seçenekler

mailbox_idpathmutlaka

integer

X-Customer-IDheader

Seçenek 1

string

Seçenek 2

null

Idempotency-Keyheadermutlaka

string

minLength: 8

maxLength: 128

Talep gövdesi · application/json

object

tomutlaka

array

Ana alıcıların adresleri.

minItems: 1

maxItems: 50

Dizi öğeleri

string

cc

array

Diğer katılımcıların görebileceği alıcı adreslerini kopyalayın.

maxItems: 50

Dizi öğeleri

string

bcc

array

Bcc alıcı adresleri.

maxItems: 50

Dizi öğeleri

string

subject

string

Mektubun konusu.

Varsayılan: ""

maxLength: 998

text

string

Mektubun metni biçimlendirilmeden.

Varsayılan: ""

maxLength: 200000

html

HTML-Mektubun biçimlendirilmiş versiyonu.

Seçenek 1

string

maxLength: 300000

Seçenek 2

null

file_ids

array

ID daha önce bu posta kutusuna indirilmiş dosyalar. Bunları indirirken veya dosya listesinden alın.

maxItems: 20

Dizi öğeleri

string · uuid

forward_message

Eklerinin iletilmesi gereken orijinal e-posta.

Seçenek 1

object

foldermutlaka

string

Klasör listesindeki klasör adı, örneğin INBOX.

minLength: 1

maxLength: 255

uidvaliditymutlaka

integer

Bu klasör için API yanıtının değeri uidvalidity'dir.

exclusiveMinimum: 0

uidmutlaka

integer

exclusiveMinimum: 0

Bilinmeyen alanlar kabul edilmez.

Seçenek 2

null

reply_to_message_id

Yanıtladığınız e-postanın message_id değeri.

Seçenek 1

string

maxLength: 998

Seçenek 2

null

references

Yanıt zincirini kaydetmek için orijinal mesajın references değeri.

Seçenek 1

string

maxLength: 4000

Seçenek 2

null

send_at

Saat dilimiyle birlikte gecikmeli gönderim zamanı, örneğin 2026-11-01T12:00:00Z. Bir değer olmadan, kuyruk işlenirken gönderim başlar.

Seçenek 1

string · date-time

Seçenek 2

null

Bilinmeyen alanlar kabul edilmez.

Yanıtlar

202 Başarılı yanıt

application/json

object

id

string · uuid

Durumu kontrol etmek ve bekleyen bir gönderimi iptal etmek için İşlem Kimliği.

kind

string

mailbox_id

Seçenek 1

integer

Seçenek 2

null

status

string

Geçerli değerler: "queued" "running" "succeeded" "failed" "uncertain" "cancelled"

run_at

string

UTC. cinsinden tarih ve saat Eğer uzaklık yoksa değer aynı zamanda UTC. değerini de temsil eder

created_at

string

UTC. cinsinden tarih ve saat Eğer uzaklık yoksa değer aynı zamanda UTC. değerini de temsil eder

completed_at

Seçenek 1

string

UTC. cinsinden tarih ve saat Eğer uzaklık yoksa değer aynı zamanda UTC. değerini de temsil eder

Seçenek 2

null

error

İşlem başarıyla tamamlanmadıysa hatanın nedeni.

Seçenek 1

string

Seçenek 2

null

result

Operasyonun sonucu. Göndermek için kabul edilen ve reddedilen alıcılar hakkında bilgi içerir.

Seçenek 1

object

Seçenek 2

null

400 Geçersiz başlık veya tanımlayıcı

application/json

object

detail

Seçenek 1

string

Seçenek 2

object

code

string

message

string

Seçenek 3

array

Dizi öğeleri

object

401 Giriş gerekli

application/json

object

detail

Seçenek 1

string

Seçenek 2

object

code

string

message

string

Seçenek 3

array

Dizi öğeleri

object

403 Erişim yok

application/json

object

detail

Seçenek 1

string

Seçenek 2

object

code

string

message

string

Seçenek 3

array

Dizi öğeleri

object

404 Kaynak bulunamadı

application/json

object

detail

Seçenek 1

string

Seçenek 2

object

code

string

message

string

Seçenek 3

array

Dizi öğeleri

object

409 Devlet çatışması

application/json

object

detail

Seçenek 1

string

Seçenek 2

object

code

string

message

string

Seçenek 3

array

Dizi öğeleri

object

413 Aşan boyut

application/json

object

detail

Seçenek 1

string

Seçenek 2

object

code

string

message

string

Seçenek 3

array

Dizi öğeleri

object

422 Doğrulama hatası

application/json

object

detail

array

Dizi öğeleri

object

locmutlaka

array

Dizi öğeleri

Seçenek 1

string

Seçenek 2

integer

msgmutlaka

string

typemutlaka

string

503 Geçici olarak kullanılamıyor

application/json

object

detail

Seçenek 1

string

Seçenek 2

object

code

string

message

string

Seçenek 3

array

Dizi öğeleri

object

Başarılı gönderim sonucu

İşlemin result alanları, kuyruğa alma yanıtı değil, yürütme sonrasındadır.

object

message_id

string

smtp_accepted

boolean

sent_saved

boolean

accepted_recipients

array

Dizi öğeleri

string

rejected_recipients

array

Dizi öğeleri

object

email

string

code

integer