Konfiguration

Diese Fälle lösen einen ArgumentError in der Zeile aus, die den falschen Wert enthielt, statt erst als verwirrender Fehlschlag bei Ihrem ersten Versand aufzutauchen. Die Meldung sagt, was falsch war und was Sie stattdessen übergeben sollten, und gibt nie Zugangsdaten wieder.

Erzeugen Sie den Client einmal und teilen Sie ihn. Ein neuer Client pro Anfrage verwirft seine offenen Verbindungen ohne Nutzen, und nichts von seinem Zustand gehört zu einem bestimmten Aufrufer. Ein Client ist nach dem Erzeugen eingefroren und kann gefahrlos von vielen Threads gleichzeitig verwendet werden. Ein Puma- oder Sidekiq-Prozess braucht also nur einen, und nach einem Fork öffnet der Kindprozess eigene Verbindungen.

Für den Fall, der sonst einen Client pro Schlüssel erzwingen würde, etwa einen Job, der im Namen mehrerer Workspaces sendet, übergeben Sie api_key: beim Aufruf. Er ersetzt den Authorization-Header für diese Anfrage und hinterlässt nichts am Client.

message = {from: "[email protected]", to: "[email protected]", subject: "Your invoice", text: "Attached."}workspace_key = ENV.fetch("OPENEMAIL_API_KEY") client.emails.send(message) client.emails.send(message, api_key: workspace_key) client.threads.list(folder: "inbox", api_key: workspace_key)client.webhooks.list(api_key: workspace_key)

Jede Methode außerhalb von temp_mail nimmt ihn als Keyword-Argument entgegen, neben den Filtern einer Liste, und die temp_mail-Methoden nehmen stattdessen inbox_token:. Er wird vor dem Senden der Anfrage nach derselben Regel geprüft, die der Client verwendet. Ein Tippfehler löst daher einen ArgumentError zum api_key dieses Aufrufs aus statt eines 401 zu Zugangsdaten, die Sie dann erst suchen müssen. Ein wiederholter Aufruf behält den Schlüssel, den er erhalten hat.

client.raw ist der Transport, über den jede Methode läuft. client.raw.request ruft einen Pfad auf, den noch keine Methode kapselt, mit den Zugangsdaten, der Basis-URL, dem Timeout und den Wiederholungsregeln des Clients, und gibt den geparsten Body so zurück, wie es eine Methode tut.

ping = client.raw.request("/ping") label = client.raw.request("/labels", method: :post, body: {name: "Invoices"}) p ping[:ok], label[:id]

OpenEmail.create_temp_mail erzeugt einen Client für Wegwerf-Posteingänge, der keinen API-Schlüssel trägt und keinen aus der Umgebung liest. Er legt Posteingänge anonym an, und jeder Lesezugriff sendet das Posteingangs-Token, das create zurückgegeben hat, oder das neuere, das extend zurückgegeben hat, entweder pro Aufruf als inbox_token: oder einmalig als OpenEmail.create_temp_mail(inbox_token:).

temp_mail = OpenEmail.create_temp_mail inbox = temp_mail.createpage = temp_mail.list_messages(inbox[:id], inbox_token: inbox[:token]) p page.items.size, page.expires_at

Eine App, die jemand über OAuth verbunden hat, etwa ein Kommandozeilenwerkzeug oder ein Agent, hält ein Zugriffstoken statt eines API-Schlüssels. Übergeben Sie es als access_token:, entweder das Token selbst oder alles, was auf call antwortet und es zurückgibt, etwa ein Lambda oder eine Method. Das Callable wird einmal pro Aufruf aufgerufen, und die Wiederholungen dieses Aufrufs verwenden, was es zurückgab. Erneuern Sie das Token also darin, wenn es bald abläuft, dann muss der Client nie neu erzeugt werden.

tokens = {current: "token-from-your-oauth-flow"} oauth_client = OpenEmail::Client.new(access_token: -> { tokens.fetch(:current) }) me = oauth_client.me.get puts me[:clientId], me[:expiresAt] if me[:object] == "oauth_token"

Vor einer heiklen Änderung, etwa dem Löschen einer Domain oder dem Ändern eines Webhooks, verlangt die API von einem Zugriffstoken den Bestätigungscode, den die Web-App von der Person verlangen würde. Der Aufruf löst einen OpenEmail::PermissionError aus, einen 403, dessen step_up_required? true ist, und es wurde nichts geändert. Fordern Sie einen Code an, bestätigen Sie den, den die Person Ihnen gibt, und rufen Sie dann erneut auf. Ein API-Schlüssel wird nie gefragt.

domain_id = "b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f" begin  client.domains.delete(domain_id)rescue OpenEmail::ApiError => error  raise unless error.step_up_required?   challenge = client.security.begin_step_up   if challenge[:method] == "email"    puts "Enter the code we emailed to #{challenge[:sentTo]}"  else    puts "Enter the code from your authenticator app, or a backup code"  end   client.security.verify_step_up(code: $stdin.gets.to_s.strip)  client.domains.delete(domain_id)end

Wenn bei RubyGems eine neuere Version des Gems vorliegt, meldet der Client das einmal pro Prozess auf der Standardfehlerausgabe, als Zeile wie ℹ openemail 0.0.2 is available, you are on 0.0.1., gefolgt von der Seite des Gems. Die Prüfung läuft, wenn der erste Client erzeugt wird, in einem Hintergrund-Thread mit einem Timeout von zwei Sekunden und nur, wenn die Standardausgabe ein Terminal ist. Ist RubyGems nicht erreichbar, wird das ignoriert.

Der Standardadapter findet seinen Proxy mit Rubys eigenem URI#find_proxy und folgt damit denselben Regeln wie der Rest der Standardbibliothek: https_proxy oder HTTPS_PROXY nennt den Proxy, und no_proxy oder NO_PROXY listet die Hosts, die direkt erreicht werden. Benutzername und Passwort in der Proxy-URL werden an den Proxy gesendet, und ein Server auf diesem Rechner wird nie über einen Proxy erreicht.

adapter: ersetzt die HTTP-Schicht. Das ist alles, was auf call(request) antwortet, ein Lambda eingeschlossen, und ein OpenEmail::HttpResponse mit status, headers und body zurückgibt. Die Anfrage ist ein OpenEmail::HttpRequest mit method, url, headers, body und timeout, ein Test kann also genau prüfen, was hinausgegangen wäre.

requests = [] adapter = lambda do |request|  requests << request  OpenEmail::HttpResponse.new(    status: 200,    headers: {"content-type" => "application/json"},    body: JSON.generate({id: "msg_test", status: "sent", replayed: false})  )end test_client = OpenEmail::Client.new(api_key: "oe_test_fake", adapter:, max_retries: 0, disable_update_notice: true) sent = test_client.emails.send(from: "[email protected]", to: "[email protected]", subject: "Hi", text: "Hello") p sent[:status], requests.first.method, requests.first.url, requests.first.headers["Idempotency-Key"]p requests.first

Beim Ausgeben einer Anfrage erscheint ihr Authorization-Header als [redacted], ein Testprotokoll enthält also nie den Schlüssel.

• —Geben Sie einen Status außerhalb von 2xx mit dem Fehlerumschlag der API als Body zurück, etwa {"error": {"type": "validation_error", "code": "invalid_parameter", "message": "..."}}, um die passende Unterklasse von OpenEmail::ApiError zu erhalten.
• —Lösen Sie in call einen Timeout::Error aus oder einen Net::ReadTimeout, der einer ist, um einen OpenEmail::NetworkError zu erhalten, dessen timeout? true ist. Jeder andere StandardError, etwa Errno::ECONNREFUSED, wird zu einem NetworkError, dessen timeout? false ist.
• —NameError, TypeError und ArgumentError, die im Adapter ausgelöst werden, gelten als Fehler im Adapter selbst. Sie werden unverändert ausgelöst und nie wiederholt.