Von Mailgun wechseln

Richten Sie das SDK auf https://api.openemail.uk/compat/mailgun aus und geben Sie ihm statt des Mailgun-Schlüssels einen OpenEmail-API-Schlüssel mit der Berechtigung emails:send. Er dient als Passwort derselben HTTP-Basic-Anmeldung, und der Benutzername wird nicht geprüft. Die Domain im Pfad muss eine Domain des Workspace sein, und die From-Adresse entscheidet, ob eine Nachricht hinausgehen darf, wie überall in OpenEmail.

import formData from 'form-data'import Mailgun from 'mailgun.js' const mailgun = new Mailgun(formData)const mg = mailgun.client({  username: 'api',  key: process.env.OPENEMAIL_API_KEY,  url: 'https://api.openemail.uk/compat/mailgun',}) await mg.messages.create('acme.com', {  from: 'Acme Billing <[email protected]>',  to: ['[email protected]'],  subject: 'Your invoice',  html: '<p>Your invoice is attached.</p>',})

Bedient wird der Endpunkt POST /v3/{domain}/messages, als multipart/form-data, das Anhänge brauchen, oder als application/x-www-form-urlencoded. Ein Feldname, der auf [] endet, wird ohne diese Endung gelesen.

• —Ein template zusammen mit html oder text, weil eine OpenEmail-Vorlage den gesamten Inhalt liefert, und ein t:version, das keine Versionsnummer ist.
• —o:deliverytime-optimize-period und o:time-zone-localize, weil OpenEmail keinen Sendezeitpunkt je Empfänger wählt. Andere h:X-Mailgun--Header, die Anweisungen an Mailgun sind: Verwenden Sie stattdessen die passende o:-Option.
• —amp-html für sich allein. Neben html oder text bleibt es weg, weil diese die Nachricht ohnehin tragen.
• —Mehr als eine Reply-To-Adresse, mehr als 10 Tags, ein Tag-Name aus anderen Zeichen als Buchstaben, Ziffern, _ und - sowie ein Batch mit mehr als 100 Empfängern. Mailgun nimmt 1.000, teilen Sie größere Batches also auf.

o:dkim, o:require-tls, o:skip-verification, o:sending-ip, o:sending-ip-pool, o:tracking-pixel-location-top, o:archive-to, o:deliver-within und t:text werden angenommen und ändern nichts.

• —Ein Versand antwortet mit 200, der Meldung Queued. Thank you. und einer id: der OpenEmail-Nachrichten-ID in spitzen Klammern, die GET /emails/{id} und Webhooks ohne diese verwenden. Ein Batch-Versand erzeugt eine Nachricht pro Empfänger, jede mit eigener ID, und antwortet mit der ersten. Ein Header Idempotency-Key funktioniert wie im Rest der API.
• —Ein fehlender oder unbekannter Schlüssel antwortet mit 401 und dem reinen Text Forbidden, eine Domain, die der Workspace nicht hat, mit 404 und Domain not found. Alles andere kommt als message zurück: 400 für eine Nachricht, die nicht gesendet werden kann, 403 für einen Schlüssel ohne emails:send, eine From-Adresse, die der Schlüssel nicht verwenden darf, eine Domain, die noch nicht senden kann, oder einen Workspace, der sein Versandkontingent aufgebraucht hat, und 413 für einen Body über 25 MB oder Anhänge über 5 MB.
• —Scheitert ein Empfänger eines Batches, nachdem andere angenommen wurden, nennt der Fehler die bereits gesendeten Nachrichten und antwortet mit 400, damit ein SDK, das Anfragen wiederholt, sie nicht doppelt sendet.