Přejít na dokumentaci
API

Náhled překladu

Co by `translate` při odeslání vyprodukoval, aniž by se cokoli odeslalo nebo uložilo.

POSTapi.openemail.uk/emails/translate

Spustí skutečné volání proti vašemu pracovnímu prostoru, s vaším vlastním klíčem.

POST /emails/translate

Co by translate při odeslání vyprodukoval, aniž by se cokoli odeslalo nebo uložilo.

Požadavek

Tytéž tři volby, které rozřeší odeslání, minus obálka, prohnané toutéž funkcí, jakou volá odesílací cesta. Ta totožnost je celá hodnota tohoto endpointu: náhled s vlastním kódem by byl slib, který nedržíme, a v den, kdy by se ty dvě věci rozešly, by se to na něčí obrazovce lišilo od toho, co má příjemce ve schránce, a nic by na to neupozornilo.

Parametry

tostringpovinné
Jazyk, ve kterém se má psát. Kód BCP-47 (`de`), anglický název („German“) nebo vlastní název jazyka („Deutsch“). Odpověď vám řekne, na jaký kód se to rozřešilo, a to je ta podoba, kterou ukládat, pokud si držíte jazyk u každého kontaktu.
htmlstring
HTML tělo, až do jednoho megabajtu. Vyžaduje se jedno z html, text nebo subject.
textstring
Prostá textová část. Překládá se nezávisle na `html`, s vlastní kontrolou délky.
subjectstring
ŘÁDEK předmětu: řetězec, ne booleovská hodnota, jakou má pod `translate` při odeslání. Jsou to dvě různé otázky: tam říkáte, jestli přeložit předmět, který už držíme, tady ho předáváte.
fromstring
V čem jste to napsali, v kterékoli z týchž tří podob. Uvedením přeskočíte volání detekce.
includeOriginalboolean
Zda vrácené `html` už nese váš originál pod překladem. Výchozí hodnota je true.

Neznámé klíče jsou 422, jako všude jinde. Požadavek, který nemá ani html, ani text, ani subject, je 422 na html: „One of html, text or subject is required“.

Náhled

Okruh, který udělá editor zprávy, než někomu ukáže, co se chystá odeslat.

curl
curl -X POST "$OE/emails/translate" -H "$AUTH" -H "Content-Type: application/json" \  -d '{    "subject": "Your September invoice",    "html": "<p>Invoice attached. Payment is due on the 14th.</p>",    "to": "de"  }'
Odpověď
{  "object": "translation",  "language": { "code": "de", "label": "German", "native": "Deutsch", "flag": "🇩🇪", "rtl": false },  "detectedSourceLanguage": {    "code": "en", "label": "English", "native": "English", "flag": "🇬🇧", "rtl": false  },  "subject": "Ihre Rechnung für September",  "html": "<p>Rechnung im Anhang. Zahlbar bis zum 14.</p>\n<div style=\"margin:28px 0 0;padding:14px 0 0;border-top:1px solid #d6dae0\">\n<div style=\"margin:0 0 10px;font-size:12px;line-height:1.5;color:#6b7280\">Ursprüngliche Nachricht (English)</div>\n<div><p>Invoice attached. Payment is due on the 14th.</p></div>\n</div>",  "text": null,  "includeOriginal": true}

html, text a subject se u pole, které jste neposlali, vracejí jako null, místo aby chyběly, takže klient může odpověď vykreslit, aniž by si pamatoval, na co se ptal.

detectedSourceLanguage je null, když se detekce zdržela. To je skutečná odpověď, ne selhání. Tělo plné jmen, čísel a odkazů jí nedává co číst a jediný důsledek je, že váš originál bude popsaný bez uvedení jazyka.

includeOriginal se vrací zpátky, protože mění, co html obsahuje. Když je zapnuté, tělo už nese váš originál pod překladem a přidáním vlastní kopie ho pošlete dvakrát.

Náhled, úprava, odeslání

Tvar, pro který je tohle postavené, je náhled, ÚPRAVA, odeslání: ukažte člověku překlad, nechte ho ho změnit a pak odešlete to, co schválil, jako obyčejné html a subject a bez translate v požadavku. To, co schválil, pak slovo od slova odejde.

curl
curl -X POST "$OE/emails" -H "$AUTH" -H "Content-Type: application/json" \  -d '{    "from": "[email protected]",    "to": ["[email protected]"],    "subject": "Ihre Rechnung für September",    "html": "<p>Rechnung im Anhang. Zahlbar bis zum 14.</p>"  }'

Odeslání s translate po náhledu přeloží podruhé a úpravy zahodí. Odešlo by to ve formulaci, kterou nikdo nečetl – a to je to jediné selhání, kterému má náhled zabránit.

Co to stojí a co to nedělá

  • Tři volání modelu (tělo, předmět a jedno na určení toho, v čem jste psali) vydaná společně, takže čekání je to nejdelší z těch tří, ne jejich součet. Uvedení from to třetí vypustí. Stojí to stejně jako odeslání s translate, takže dělejte náhled jednou, ne při každé revizi.
  • Nic se neodešle, nezapíše se žádný řádek a nevrátí se žádné id. Není tu co rušit ani co si později vyzvednout.
  • Překládá a nic jiného nedělá. Nekoriguje, nevylepšuje text a nikdy na zprávu neodpovídá.
  • Jména, firmy, odkazy, čísla objednávek, ceny a data se vracejí tak, jak přišly, takže překlad lze s originálem porovnat řádek po řádku.
  • Citovaná historie se neodstraňuje, na rozdíl od čtecí poloviny. Překládá se to, co předáte, což je správně pro editor zprávy, kde tělo je jen to, co někdo právě napsal, a hodí se to vědět, pokud posíláte celé vlákno odpovědí.
  • Scope emails:send, bez vlastního scope: neuděluje nic, co by odesílatel už nemohl udělat, a scope, který na souhlasné obrazovce nikdo nerozezná od emails:send, dělá každý další scope v tom seznamu o něco méně významným.

Tělo je omezené stejným megabajtem, jaký povoluje odeslání, ale samotný překlad odmítne cokoli přes 30 000 znaků s translation_too_long. Chybové kódy jsou ty, které vrací přeložené odeslání; jsou vypsané v Odeslání e-mailu.