Zur Dokumentation springen
API

Eine Übersetzung in der Vorschau

Was `translate` bei einem Versand erzeugen würde, ohne dass etwas gesendet und etwas gespeichert wird.

POSTapi.openemail.uk/emails/translate

Führt den echten Aufruf gegen Ihren Workspace aus, mit Ihrem eigenen Schlüssel.

POST /emails/translate

Was translate bei einem Versand erzeugen würde, ohne dass etwas gesendet und etwas gespeichert wird.

Die Anfrage

Dieselben drei Optionen, die ein Versand auflöst, abzüglich des Umschlags, durch dieselbe Funktion geführt, die der Sendepfad aufruft. Diese Identität ist der ganze Wert des Endpunkts: Eine Vorschau mit eigenem Code wäre ein Versprechen, das wir nicht halten, und an dem Tag, an dem beide auseinanderliefen, würden das, was auf jemandes Bildschirm steht, und das, was im Postfach des Empfängers liegt, voneinander abweichen, ohne dass irgendetwas darauf hinwiese.

Parameter

tostringerforderlich
Die Sprache, in der geschrieben werden soll. Ein BCP-47-Code (`de`), ein englischer Name ("German") oder der Eigenname der Sprache ("Deutsch"). Die Antwort sagt Ihnen, auf welchen Code aufgelöst wurde, und das ist die Form, die man speichert, wenn man eine Sprache pro Kontakt vorhält.
htmlstring
Der HTML-Textkörper, bis zu einem Megabyte. Eines von html, text oder subject ist erforderlich.
textstring
Der Klartext-Teil. Unabhängig von `html` übersetzt, mit eigener Längenprüfung.
subjectstring
Die BetreffZEILE: ein string, nicht der boolean, der sie unter `translate` bei einem Versand ist. Das sind zwei verschiedene Fragen: Dort sagen Sie, ob ein Betreff übersetzt werden soll, den wir bereits haben, hier reichen Sie einen herüber.
fromstring
Worin Sie es geschrieben haben, in einer der gleichen drei Formen. Die Angabe erspart den Erkennungsaufruf.
includeOriginalboolean
Ob das zurückgegebene `html` Ihr Original bereits unter der Übersetzung mitführt. Standardwert true.

Unbekannte Schlüssel ergeben wie überall sonst ein 422. Eine Anfrage ohne html, text und subject ergibt ein 422 auf html: "One of html, text or subject is required".

Vorschau anzeigen

Der Roundtrip, den der Composer macht, bevor er jemandem zeigt, was er gleich versendet.

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"  }'
Antwort
{  "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 und subject kommen für ein Feld, das Sie nicht gesendet haben, als null zurück statt zu fehlen, sodass ein Client die Antwort darstellen kann, ohne sich zu merken, wonach er gefragt hat.

detectedSourceLanguage ist null, wenn die Erkennung sich enthalten hat. Das ist eine echte Antwort und kein Fehlschlag. Ein Textkörper aus Namen, Zahlen und Links gibt ihr nichts zu lesen, und die einzige Folge ist, dass Ihr Original ohne Sprachangabe beschriftet wird.

includeOriginal wird zurückgespiegelt, weil es ändert, was html enthält. Ist es an, führt der Textkörper Ihr Original bereits unter der Übersetzung mit, und eine eigene angehängte Kopie versendet es zweimal.

Vorschau, bearbeiten, senden

Die Form, für die das gebaut ist, heißt Vorschau, BEARBEITEN, Senden: Zeigen Sie einer Person die Übersetzung, lassen Sie sie ändern, und senden Sie dann das Freigegebene als gewöhnliches html und subject, ganz ohne translate in der Anfrage. Was freigegeben wurde, ist dann Wort für Wort das, was hinausgeht.

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>"  }'

Nach der Vorschau mit translate zu senden übersetzt ein zweites Mal und wirft die Bearbeitungen weg. Der Versand ginge in einem Wortlaut hinaus, den niemand gelesen hat – genau der eine Fehler, den es die Vorschau zu verhindern gibt.

Was es kostet und was es nicht tut

  • Drei Modellaufrufe (der Textkörper, der Betreff und einer, um zu ermitteln, worin Sie geschrieben haben), gemeinsam abgesetzt, sodass die Wartezeit der längste der drei ist und nicht ihre Summe. Die Angabe von from erspart den dritten. Es kostet dasselbe wie ein Versand mit translate, also lieber einmal eine Vorschau als eine pro Überarbeitung.
  • Es wird nichts gesendet, keine Zeile geschrieben und keine ID zurückgegeben. Hier gibt es nichts zu stornieren oder später abzurufen.
  • Es übersetzt und tut sonst nichts. Es liest nicht Korrektur, es verbessert den Text nicht, und es beantwortet die Nachricht nie.
  • Namen, Firmen, Links, Bestellnummern, Preise und Daten kommen so zurück, wie sie hineingingen, sodass sich die Übersetzung Zeile für Zeile gegen das Original prüfen lässt.
  • Zitierte Historie wird nicht entfernt, anders als auf der Lese-Seite. Übersetzt wird, was Sie übergeben – richtig für einen Composer, wo der Textkörper nur das ist, was jemand gerade geschrieben hat, und wissenswert, wenn Sie eine ganze Antwortkette schicken.
  • Mit emails:send gescoped, ohne eigenen Scope: Er gewährt nichts, was ein Absender nicht ohnehin könnte, und ein Scope, den auf einem Einwilligungsbildschirm niemand von emails:send unterscheiden kann, lässt jeden anderen Scope in dieser Liste ein wenig weniger bedeuten.

Der Textkörper ist auf dasselbe Megabyte begrenzt, das ein Versand erlaubt, aber die Übersetzung selbst lehnt alles über 30.000 Zeichen mit translation_too_long ab. Die Fehlercodes sind dieselben, die ein übersetzter Versand zurückgibt, aufgeführt unter Eine E-Mail senden.