Ruby-Gem
Der offizielle Ruby-Client für die OpenEmail-API. Keine Laufzeitabhängigkeiten und eine Methode für jeden Endpunkt.
Was es ist
Ein Gem für die gesamte API (Versand, Templates, Tracking, Threads, Entwürfe, Labels, Kontakte, Audiences, Anmeldeformulare, Broadcasts, Domains, Regeln, Webhooks, Kalender, Einstellungen, Rollen, Mitglieder, Sperrliste, Dateien und Wegwerf-Postfächer), mit einer Methode für jede Methode des TypeScript-SDK unter demselben Namen in snake_case, einer Fehlerklasse für jede Art von Ablehnung, Wiederholungsversuchen, die keinen Versand doppelt auslösen können, und einer Prüfung für Webhook-Signaturen. Es braucht Ruby 3.2 oder neuer und sonst nichts, und ein einzelner Client kann gefahrlos von mehreren Threads gemeinsam genutzt werden und übersteht einen Fork.
bundle add openemailrequire "openemail" OpenEmail.init(api_key: ENV.fetch("OPENEMAIL_API_KEY")) OpenEmail.emails.send( from: "Acme Billing <[email protected]>", to: "[email protected]", subject: "Your September invoice", html: "<p>Invoice attached.</p>")Wohin als Nächstes
Es kapselt dieselbe API wie jeder andere Client
Alles hier ist die Oberfläche, die die API-Referenz dokumentiert und das TypeScript-SDK kapselt. Lesen Sie also in der API-Referenz nach, was ein Endpunkt tut, und hier, wie Sie ihn aus Ruby aufrufen. Jede TypeScript-Methode hat ein Ruby-Gegenstück, und die Paritätsprüfung des Gems führt beide mit denselben Argumenten aus und schlägt fehl, wenn sie nicht Byte für Byte dieselbe Anfrage senden.