mailkite 0.17.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b15ee263fe07ec0ace5a924dfbf72ea4af0315ec1d3e680c6de957fbabc9f802
-  data.tar.gz: 736c9345872755f6d696347f39131e103f4a1bb0a6620fa0ef0066061090751d
+  metadata.gz: aa6c0fe1916c302b913ce3ec7d39ca3b9e78633791fdfaf0d372306bc71bc134
+  data.tar.gz: 7795b6f4b60abcaadd6de5167a1326c1b0c5e5d8eb510ab4aeb141220c499459
 SHA512:
-  metadata.gz: 7f6115ce30631c431bb1f4f7eb009f21418930108ad237c318cc33ff753edb0751a1fdb8ff424f8d4f06d2340a7657e5bc3570295d71cca9907e62ed578964c8
-  data.tar.gz: 9bc55eac84d0f2f62ebc8630e14bba0a9a095ec083c1010ee8c111fcc842d3b6d1620f6bdeb6aaaec385c63a3b8c354ddae15ded8581ab71af6eb8cb0078b1e7
+  metadata.gz: 836d902177a964a2094203c597a857222cef22f6f6d51eefd0ab5ddff1baecd636c5a4fb310aa1c658f84e128c2f9e99ef52b1f963f4d3d5f8d6c825f8f46b92
+  data.tar.gz: 438ec7af44244d1cffd79b609dddffcc11cbe9655dc3796a690ac7997d10fe8fc5c229a073dbbcb34cae2ec17640f367ed1659196d4fb3d0ded23e43f2a70015

data/lib/mailkite.rb

@@ -15,7 +15,7 @@ require "base64"
 require "cgi"
 
 module Mailkite
-  VERSION = "0.17.0"
+  VERSION = "0.19.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
@@ -491,6 +491,125 @@ 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
+
+    # List the account's app passwords. Each one opens a mailbox over IMAP
+    # and/or the mailbox API, scoped to a domain and an address pattern
+    # within it.
+    def listAppPasswords
+      request("GET", "/api/app-passwords")
+    end
+
+    # Create an app password for one domain and address pattern. +body+ is a
+    # hash with "domain" (required) plus optional "address" (default "*"),
+    # "protocols" (default ["imap"]) and "label". The secret is returned once
+    # and never again.
+    def createAppPassword(body)
+      request("POST", "/api/app-passwords", body)
+    end
+
+    # Revoke an app password. Takes effect immediately — any IMAP session or
+    # API call using it stops authenticating.
+    def deleteAppPassword(id)
+      request("DELETE", "/api/app-passwords/#{id}")
+    end
+
+    # List a mailbox's messages, newest first. Authenticated with an app
+    # password granting "api" — this is how an agent reads its own inbox
+    # without an IMAP client. +params+ may carry :limit and :before.
+    def listMailboxMessages(address, params = {})
+      q = URI.encode_www_form({ "address" => address }.merge(params))
+      request("GET", "/api/mailbox/messages?#{q}")
+    end
+
+    # Fetch one message's raw RFC822 bytes from a mailbox. Same app password
+    # auth as the list.
+    def getMailboxMessageRaw(uid, address)
+      q = URI.encode_www_form("address" => address)
+      request("GET", "/api/mailbox/messages/#{uid}/raw?#{q}")
+    end
+
+    # Replace a message's IMAP flags (e.g. mark it "Seen"). Flags set here are
+    # the same ones an IMAP client sees.
+    def setMailboxMessageFlags(uid, address, flags)
+      q = URI.encode_www_form("address" => address)
+      request("POST", "/api/mailbox/messages/#{uid}/flags?#{q}", { "flags" => flags })
+    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.17.0
+  version: 0.19.0
 platform: ruby
 authors:
 - MailKite
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-08-01 00:00:00.000000000 Z
+date: 2026-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail