API

Dërgoni përmes SMTP

I njëjti dërgim si POST /emails, për softuer që flet SMTP.

Lidhuni

Çdo gjë që dërgon postë përmes një serveri SMTP mund të dërgojë përmes OpenEmail: mailer-i i një framework-u, një CMS, një mjet monitorimi, një printer. Hyni me emrin e përdoruesit openemail dhe me një çelës API si fjalëkalim. Çelësit i duhet fushëveprimi emails:send, dhe një mesazh që ai dorëzon është i njëjti dërgim si POST /emails i bërë me atë çelës.

Cilësimi	Vlera
Host	`smtp.openemail.uk`
Port	`465` me SSL/TLS, ose `587` me STARTTLS
Emri i përdoruesit	`openemail`
Fjalëkalimi	Një çelës API me fushëveprimin `emails:send`
Hyrja	PLAIN ose LOGIN, që pjesa më e madhe e softuerit e quan Normal password

Asgjë nuk pranohet e paenkriptuar, dhe në portën 587 hyrja hapet vetëm pas STARTTLS. Një çelës API hyn vetëm për të dërguar. Leximi i një kutie postare përmes IMAP ose POP3 kërkon një fjalëkalim aplikacioni.

Dërgoni një mesazh testimi

Ruani një mesazh si message.eml dhe dorëzojeni me curl. From duhet të jetë një adresë me të cilën çelësi lejohet të dërgojë.

message.eml

From: Acme <[email protected]>To: [email protected]Subject: Hello over SMTPMessage-ID: <[email protected]> It works.

Porta 465

curl --url "smtps://smtp.openemail.uk:465" \  --user "openemail:$OPENEMAIL_API_KEY" \  --mail-from "[email protected]" \  --mail-rcpt "[email protected]" \  --upload-file message.eml --crlf

Porta 587

curl --ssl-reqd --url "smtp://smtp.openemail.uk:587" \  --user "openemail:$OPENEMAIL_API_KEY" \  --mail-from "[email protected]" \  --mail-rcpt "[email protected]" \  --upload-file message.eml --crlf

Përgjigjja për një mesazh të pranuar është 250 2.0.0 OK queued as, e ndjekur nga id-ja e mesazhit. Kjo id është ajo që merr GET /emails/{id}, ndaj mesazhi, ngjarjet e tij dhe gjurmimi i tij lexohen si ato të çdo dërgimi tjetër.

Si bëhet një mesazh dërgim

Mesazhi lexohet dhe dërgohet nëpër të njëjtën rrugë si një dërgim REST, ndaj rindërtohet nga pjesët e tij dhe nuk përcillet bajt për bajt.

Në mesazh	Në dërgim
From	`from`. Është i detyrueshëm, dhe është dërguesi kundrejt të cilit kontrollohet çelësi. Adresa te `MAIL FROM` mjafton të jetë aty.
RCPT TO	Kujt i dorëzohet mesazhi, më së shumti 50. Një marrës i përmendur te `To` është `to`, një i përmendur te `Cc` është `cc`, dhe një që nuk përmendet në asnjërën është `bcc`. Të paktën një duhet të jetë te `To`.
Reply-To	`replyTo`, adresa e parë.
Subject	`subject`.
Pjesët tekst dhe HTML	`text` dhe `html`. Një imazh që HTML-ja e përdor si `cid:` futet aty ku shfaqet.
Bashkëngjitjet	`attachments`: më së shumti 20 skedarë dhe gjithsej 5 MB.
Header-a të tjerë	`X-`, `List-`, Precedence, Auto-Submitted, Importance, Priority dhe Feedback-ID ruhen. Çdo header tjetër lihet jashtë.
X-OpenEmail-Stream	`stream`: `transactional` ose `broadcast`. Header-i hiqet para se mesazhi të niset.

Çfarë vlen

Gjithçka që vlen për një dërgim REST vlen edhe këtu, sepse është një rrugë e vetme.

Fushëveprimet e çelësit, si dhe adresat dhe domenet në të cilat është i kufizuar.
Kontrolli i dërguesit: From është një adresë në një domen që mund të dërgojë, dhe një me të cilën çelësi lejohet të dërgojë.
Kuota e dërgimeve e hapësirës së punës dhe lista e saj e bllokimit.
Nënshkrimi i adresës nga e cila dërgohet dhe gjurmimi i saj i hapjeve dhe i klikimeve, si në një dërgim REST që nuk vendos as signature as tracking.
Korsia: ndërsa korsia e dërgesave masive është pezulluar, një mesazh me X-OpenEmail-Stream: broadcast refuzohet.
Webhook-et dhe ngjarjet e dorëzimit, që e emërtojnë mesazhin me id-në e përgjigjes 250.

Riprovimet

Një mesazh me Message-ID dërgohet një herë. Kur i njëjti Message-ID dorëzohet sërish për të njëjtët marrës, përgjigjja mban id-në e mesazhit të parë dhe nuk dërgohet asgjë, ndaj softueri që riprovon pas një lidhjeje të këputur nuk mund ta dërgojë dy herë. I njëjti mesazh për marrës të tjerë është një dërgim tjetër. Shihni «Idempotenca».

Përgjigjet dhe kufijtë

Përgjigjja	Kur
250 2.0.0	Mesazhi vihet në radhë, dhe më pas vjen id-ja e tij.
535 5.7.8	Hyrja dështoi: një çelës i gabuar, i revokuar ose i skaduar, një çelës pa `emails:send`, ose një çelës API me një emër tjetër përdoruesi.
452 4.5.3	Më shumë se 50 marrës në një mesazh. Softueri i postës i dërgon vetë të tjerët në një mesazh tjetër.
552 5.3.4	Mesazhi është më i madh se 25 MB.
550 5.6.0	Mesazhi nuk mund të dërgohet siç është shkruar: pa `From`, askush te `To`, shumë bashkëngjitje ose bashkëngjitje tepër të mëdha, një korsi e panjohur. Teksti tregon cila prej tyre.
550 5.7.1	Dërgimi u refuzua: çelësi nuk lejohet të dërgojë me atë adresë, domeni nuk mund të dërgojë ende, ose korsia e dërgesave masive është pezulluar.
452 4.7.0	Kuota e dërgimeve e hapësirës së punës është shteruar.
451 4.7.1	Më shumë se 300 mesazhe nga një çelës brenda një minute. Softueri i postës pret dhe provon sërish.
451 4.3.0	Një gabim nga ana jonë. Provoni sërish pas pak.

Një lidhje që nuk ka asgjë për të dërguar mbyllet pas pesë minutash. Një lidhje mund të mbajë çdo numër mesazhesh, njëri pas tjetrit.

Në regjistrin e kërkesave

Çdo mesazh që dorëzon një çelës është një rresht në regjistrin e tij të kërkesave, me metodën SMTP, shtegun /emails dhe statusin që do të kishte pasur një dërgim REST: 202 kur u vu në radhë, dhe 403, 422 ose 429 me të njëjtin code gabimi kur u refuzua. GET /keys/{id}/requests?path=/emails i liston krahas dërgimeve REST. Një hyrje që dështon me një çelës të vërtetë shfaqet në aktivitetin e atij çelësi.