mailcycle 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 335f0b7efcc3477484330570f7429ab5b02110bddcf744da2c22b5fc924b7dbe
+  data.tar.gz: c119a992721686b72afa4973aa0504066d0b41cdc6c20bad031b5fce460fd1e0
+SHA512:
+  metadata.gz: c41cce333ffe2bf99e02528ee4e95ddefea75d268d97c22a5a18474ddacb72bc6690d893e15eb6052c77f570cd2f0a99f285d490a19ae79fd19ce2b280bcf877
+  data.tar.gz: 682bb34d733d5872529ff1bb80e223e419f52cb63e755f74e9e0f4f35512eab22b0dccd896f7123c5a3732cab1eb79d47b5cf72cd5278a0eef242e2a114c1090

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Northlab Studios Ltd
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,208 @@
+# mailcycle
+
+A Ruby client for the Mailcycle API that does the encryption on your machine. Create addresses that receive mail, read what arrives, send, and listen for events. Mailcycle stores mail sealed to keys derived from your recovery phrase, and this gem derives them locally; the phrase never leaves your machine.
+
+Needs Ruby 3.1 or later. It has no dependencies beyond Ruby's own standard library.
+
+```sh
+gem install mailcycle
+```
+
+## Sign in
+
+```ruby
+require "mailcycle"
+
+# With the recovery phrase: everything the app can do, on any plan.
+mc = Mailcycle.sign_in(ENV.fetch("MAILCYCLE_PHRASE"))
+
+# With an API key (Operator and up). Add the phrase to open mail and create
+# addresses that receive it.
+scripted = Mailcycle.with_api_key(ENV.fetch("MAILCYCLE_API_KEY"), phrase: ENV["MAILCYCLE_PHRASE"])
+```
+
+Signing in uses the same handshake as the app: the server sends a challenge and the client proves it holds the key, so nothing secret crosses the wire. With an API key and a phrase, the phrase is checked against the key's account before anything is opened.
+
+Each `sign_in` opens a 30-day session. Keep `mc.session_token` somewhere private and pick it up with `Mailcycle.resume(token, phrase)` rather than signing in on every run. `Mailcycle.create_account` makes a new account and returns the client and its phrase; keep the phrase, because nothing can recover the account without it.
+
+Every one of these takes `api_url:` and `timeout:` (seconds) as well.
+
+## Addresses that receive mail
+
+```ruby
+address = mc.addresses.create(prefix: "signup", label: "Test run 42")
+puts address.email_address
+```
+
+The address's public key is derived from the phrase and sent with it, so the mail server can seal what arrives. The label is sealed on your machine, and the server stores it as ciphertext.
+
+## Reading mail
+
+```ruby
+mc.messages.all(address.id).each do |message|
+  puts "#{message.from_address} #{message.subject}"
+end
+
+data = mc.messages.attachment(message, 0)   # a binary String, opened locally
+```
+
+A message that will not open, because there is no phrase or it is the wrong one, comes back with `opened` false and empty content rather than an error, so one unreadable message does not hide the rest of a page.
+
+`message.html` is the HTML as the sender wrote it, remote images and all. `message.safe_html` has everything remote removed, the same way the app does it, and is the one to render; `message.blocked` says what was taken out and who it would have reported to.
+
+## Waiting for mail
+
+```ruby
+code = mc.messages.wait_for(address_id: address.id, subject: "verification")
+```
+
+Listens on the event stream and returns the next matching message, opened. Where the stream will not open it checks the address every five seconds instead, so `address_id` is needed then. If nothing arrives in time it raises a `Mailcycle::ApiError` with `code` `"timeout"`.
+
+Mail counts from the moment `wait_for` is called, including mail that arrived before the stream was up. To wait for a reply to something you send, take the time just before sending and pass it as `since:`; five seconds are allowed for the difference between your clock and the server's.
+
+```ruby
+since = Time.now
+mc.messages.send(from: address.email_address, to: "bot@example.com", subject: "Ping", text: "Hi")
+reply = mc.messages.wait_for(address_id: address.id, subject: "Ping", since: since)
+```
+
+## Sending
+
+```ruby
+mc.messages.send(from: address.email_address, to: "someone@example.com", subject: "Hello", text: "Hi")
+
+mc.messages.send(
+  from: address.email_address,
+  to: message.reply_to,
+  subject: "Re: Hello",
+  text: "Thanks",
+  reply_to: message   # fills in the threading headers
+)
+```
+
+Attachments take raw bytes and the client encodes them. A message can carry up to ten files, 3.5 MB between them. Give a file a `content_id` to show it inline, where the HTML says `cid:` and that id. Program and script files, like `.exe` and `.js`, are refused.
+
+```ruby
+files = [
+  Mailcycle::OutgoingAttachment.new(filename: "invoice.pdf", content: File.binread("invoice.pdf"),
+                                    mime_type: "application/pdf"),
+  Mailcycle::OutgoingAttachment.new(filename: "logo.png", content: File.binread("logo.png"),
+                                    mime_type: "image/png", content_id: "logo")
+]
+mc.messages.send(from: address.email_address, to: "someone@example.com", subject: "Your invoice",
+                 text: "Attached.", html: '<img src="cid:logo"><p>Attached.</p>', attachments: files)
+```
+
+A session can send from Personal up; an API key on Scale and up. Free receives only. Limits are in the [rate limits](https://docs.mailcycle.email/reference/rate-limits/).
+
+`send` returns a `Mailcycle::SendResult`: `message_id` is the Message-ID header, and `sent_copy_id` is the id of the copy in Sent, which the other message calls take.
+
+## Events
+
+```ruby
+stream = mc.events.stream
+stream.each do |event|
+  puts "#{event.event_type} #{event.payload}"
+end
+```
+
+The same events as webhooks, the moment they happen, and they carry ids rather than content. The stream reconnects after a drop, and events that happen while it is down are not replayed, so `on_reconnect:` is where to refetch whatever you are showing. `next_event(timeout: 30)` reads one at a time with a deadline, and `close` ends it.
+
+To check a webhook came from Mailcycle, pass the body exactly as it arrived, before any parsing:
+
+```ruby
+Mailcycle.verify_webhook_signature(secret, raw_body, request.headers["Mailcycle-Signature"])
+```
+
+## API keys
+
+```ruby
+created = mc.api_keys.create("Deploy script")
+puts created.token   # shown once; keep it somewhere private
+
+mc.api_keys.list.each do |key|
+  puts "#{key.id} #{key.name.inspect} ...#{key.hint}"
+end
+mc.api_keys.revoke(created.api_key.id)
+```
+
+Listing, creating and revoking keys need a signed-in session, so a leaked key cannot make more of itself. The name is sealed on your machine, and the server stores it as ciphertext. A name that will not open comes back as `nil`.
+
+`sign_out` on a client built with an API key does nothing. A key is not a session; it works until it is revoked.
+
+## Webhooks
+
+```ruby
+created = mc.webhooks.create("https://example.com/hooks/mail", ["message.received"], "Orders")
+secret = created.secret   # shown once, for checking signatures
+
+mc.webhooks.update(created.webhook.id, enabled: false)
+mc.webhooks.test(created.webhook.id)
+
+page = mc.webhooks.deliveries(created.webhook.id)
+page.deliveries.each do |delivery|
+  puts "#{delivery.event_type} #{delivery.status} #{delivery.response_status.inspect}"
+end
+```
+
+Webhooks are on Operator and up. `list` returns the webhooks with their names opened, and every event type one can ask for. `rotate_secret` returns a new secret once, and `redeliver` sends a logged event again with the same event id. Adding, changing, rotating and removing need a signed-in session; an API key can list, test, read deliveries and redeliver.
+
+## Sessions
+
+```ruby
+mc.sessions.list.each do |session|
+  puts "#{session.id} #{session.expires_at} #{session.current}"
+end
+mc.sessions.revoke_others
+```
+
+`revoke(id)` ends one session. All three need a signed-in session.
+
+## Deleting the account
+
+```ruby
+mc.delete_account
+```
+
+Erases the account and everything in it at once, with no grace period. Its addresses are retired and never issued again. It needs a signed-in session, and confirms with the phrase by answering a fresh challenge. If the account balance still holds money you paid in, it is refused with `balance_held`: ask for the balance back from Support first.
+
+`mc.subscription` returns the plan, renewal date and balance, and `mc.plans` lists every plan.
+
+## Pairing devices
+
+```ruby
+# The text of the device's QR code, or the eight digits it shows.
+device = mc.devices.pair("MC1:12345678:...", "Kitchen Pi")
+
+mc.devices.assign(device.id, address.id)     # hands the keys over too
+mc.devices.unassign(device.id, address.id)
+mc.devices.hand_over_keys(device.id)         # again, on its own
+```
+
+This is what the app's Add device screen does, done by a script. It needs the phrase and a signed-in session. The name is sealed on your machine.
+
+Each device has a wrap secret, and its address keys are sealed under it. The account keeps a copy in the device's sealed profile, so keys can be handed over again when an address is assigned or taken off.
+
+There are two ways the secret gets here. The QR code carries the device's own secret, so it never passes through Mailcycle. The eight digits carry no secret, so the client makes one and seals it to a key the device published. The server relays that key, so it could put its own in its place at pairing and read the keys that follow. The QR path does not have that gap. Use it where you can.
+
+A device on an older build publishes no key. Pairing it by its digits fails with an error that says to pair it in the app, or pass its QR code instead.
+
+## Errors
+
+Everything raises a `Mailcycle::Error`. An API failure is a `Mailcycle::ApiError` carrying the HTTP `status` and the API's own `code`, such as `plan_required` or `session_required`, which is what to match on rather than the message. See [errors](https://docs.mailcycle.email/reference/errors/).
+
+```ruby
+begin
+  mc.api_keys.list
+rescue Mailcycle::ApiError => e
+  raise unless e.code == "session_required"
+end
+```
+
+## How it is checked
+
+The encryption is checked against Mailcycle's published test vectors (https://docs.mailcycle.email/vectors.json), including the refusals.
+
+## Licence
+
+Apache License 2.0. Copyright (c) 2026 Northlab Studios Ltd. You may use, modify and redistribute this gem, including inside your own applications, under the terms in [LICENSE](LICENSE). Using the Mailcycle API itself is governed by the [Terms of Service](https://mailcycle.email/legal/terms/). Never ship an API key in software you distribute.