mailkite 0.16.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a20b1eccf548161ab6465617e8575de9ecb1a9f99d1adbc3391461f6d2b81462
-  data.tar.gz: 2e8cf7aff2c4ed5a8baa85b2d570671f2e48dd0438c7cacefc547ae8947a1431
+  metadata.gz: a4b8b0706aa98435dc195e58ee8c548e762e5fff84819432b96741de752ef32a
+  data.tar.gz: b5ab6561c1750cd702b7f4e545001bd25d8a0c75996a930eae70b691e2500bc4
 SHA512:
-  metadata.gz: 28eacd06c017ad6386a8ceedede3f5817283f463d13514842cb0b833362b777022a268fbcfcf75e9188deae873254a6150aa1d34f1ad6945c543588d2352793f
-  data.tar.gz: e135e827740708030d5f0f080f058149130b2781e34f0061c21358b856c88b7c87e207d8275738bab8178d540524fd04bcca115a35a89c866087d75d741953e3
+  metadata.gz: 6c599c0cc4f9efc6c94e5701d7adca5b508bf6fb94a7cc6c2747ad5c23649c362014664acaa402de2086af7507e757c686959681fdc3ce147f136cdfe515af34
+  data.tar.gz: 79b945cbac587203ea1c2a9613a9eb76ef98bfc357572ed2767c861c880ffbb341753f58aab10abda130aa65923928d403cbc62a7840c5a8c1ea115b1c7e0360

data/lib/mailkite.rb

@@ -15,7 +15,7 @@ require "base64"
 require "cgi"
 
 module Mailkite
-  VERSION = "0.16.0"
+  VERSION = "0.18.0"
   DEFAULT_BASE_URL = "https://api.mailkite.dev"
   # Reject webhook events older than this (ms) to block replays. Pass 0 to disable.
   DEFAULT_TOLERANCE_MS = 5 * 60 * 1000
@@ -214,10 +214,29 @@ module Mailkite
     # message keys: from, to, text/html, etc. `subject` is optional when a
     # template supplies it. Pass `templateId` to render a stored template and
     # `templateData` (a hash) to fill its variables.
+    # Send an email. +message+ is a hash with "from", "to" and a body ("text"
+    # and/or "html"). Also accepted: "subject" (optional when a template
+    # supplies it), "cc"/"bcc" (string or array), "replyTo", "inReplyTo"
+    # (thread a reply), "attachments" (array of {filename, url|content,
+    # contentType}), "headers" (hash of extra raw MIME headers, e.g.
+    # List-Unsubscribe — immediate sends only), and "templateId" +
+    # "templateData" to render a stored template.
     def send(message)
       request("POST", "/v1/send", message)
     end
 
+    # Send one personalized message per recipient (up to 50) in a single call.
+    # +batch+ is a hash with "from" and "recipients" (array of {"to",
+    # "templateData", "headers"} — exactly one address each). Shared fields
+    # ("subject", "html"/"text", "templateId", "templateData", "headers", …)
+    # form the base message; per-recipient "templateData" and "headers" are
+    # merged over the shared ones (the recipient wins). Every message passes
+    # the same gates as send() and gets its own id — the response reports each
+    # recipient's outcome in order, so a batch can partially succeed.
+    def sendBatch(batch)
+      request("POST", "/v1/send/batch", batch)
+    end
+
     # Extension → MIME map for raw-binary attachment uploads (default
     # application/octet-stream when an extension is unknown).
     ATTACHMENT_MIME = {
@@ -332,6 +351,22 @@ module Mailkite
       request("DELETE", "/api/domains/#{id}/webhook")
     end
 
+    def setTrackingWebhook(id, body)
+      request("PUT", "/api/domains/#{id}/tracking-webhook", body)
+    end
+
+    def deleteTrackingWebhook(id)
+      request("DELETE", "/api/domains/#{id}/tracking-webhook")
+    end
+
+    def setWebhookEvents(id, body)
+      request("PUT", "/api/domains/#{id}/webhook-events", body)
+    end
+
+    def deleteWebhookEvents(id)
+      request("DELETE", "/api/domains/#{id}/webhook-events")
+    end
+
     def testWebhook(id)
       request("POST", "/api/domains/#{id}/webhook/test")
     end
@@ -456,6 +491,82 @@ module Mailkite
       request("POST", "/api/broadcasts/#{id}/send", body)
     end
 
+    # --- Account ----------------------------------------------------------
+    # Create a MailKite account from just an email — no password. +body+ is a
+    # hash with "email" (required) and optional "channel", "ref" and
+    # "referrer". Returns the new account's API key immediately; a
+    # verification link is emailed, and SENDING stays blocked until the
+    # address is verified (poll me()). An existing email returns 409
+    # account_exists with no credentials. PUBLIC — no API key required.
+    def register(body)
+      request("POST", "/api/v1/provision", body)
+    end
+
+    # The account behind this credential: email, whether it is verified
+    # (sending is blocked until it is), and plan. Use to poll verification
+    # state after register().
+    def me
+      request("GET", "/v1/me")
+    end
+
+    # Get the account's unrestricted API key (mk_live_…). Read-or-create: the
+    # first call mints it.
+    def getApiKey
+      request("GET", "/api/keys")
+    end
+
+    # Rotate the account API key: the old key stops working immediately and a
+    # fresh one is returned. The plaintext is only shown here.
+    def rotateApiKey
+      request("POST", "/api/keys/rotate")
+    end
+
+    # List the account's domain-scoped API keys. A scoped key can send and
+    # manage only its one domain — hand one to each site or CI job so a leak
+    # burns only that surface.
+    def listScopedKeys
+      request("GET", "/api/keys/scoped")
+    end
+
+    # Create a key scoped to one domain. +body+ is a hash with "domainId"
+    # (required) and optional "name". Ideal for per-site installs (e.g. a
+    # WordPress plugin) — the site never holds the account master key.
+    def createScopedKey(body)
+      request("POST", "/api/keys/scoped", body)
+    end
+
+    # Revoke a domain-scoped key. Takes effect immediately.
+    def deleteScopedKey(id)
+      request("DELETE", "/api/keys/scoped/#{id}")
+    end
+
+    # Current billing-period usage: emails used vs the plan's included bucket
+    # (null = unlimited), AI actions, and the overage state that gates
+    # sending. Powers quota meters in dashboards and integrations.
+    def getUsage
+      request("GET", "/api/billing/usage")
+    end
+
+    # --- Suppressions -----------------------------------------------------
+    # List suppressed addresses (unsubscribes, hard bounces, spam complaints,
+    # manual). Sends to a suppressed address are dropped before delivery.
+    def listSuppressions
+      request("GET", "/api/contacts/suppressions")
+    end
+
+    # Suppress an address so this account never sends to it again. +body+ is
+    # a hash with "email" (required) and optional "reason" (defaults to
+    # manual) and "note".
+    def addSuppression(body)
+      request("POST", "/api/contacts/suppressions", body)
+    end
+
+    # Remove an address from the suppression list. Removing an unsuppressed
+    # address is a no-op success.
+    def removeSuppression(email)
+      request("DELETE", "/api/contacts/suppressions/#{CGI.escape(email)}")
+    end
+
     # --- Docs -----------------------------------------------------------
     # Semantic search over the MailKite docs. PUBLIC — no auth required.
     # Returns { "query" => ..., "matches" => [...] }.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailkite
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.18.0
 platform: ruby
 authors:
 - MailKite
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-07-29 00:00:00.000000000 Z
+date: 2026-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail