sendclipper 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3f2ca79b7b603e79b2a71e81fd3bf8033e705b0c76171c8a69197db1e08cf45
-  data.tar.gz: f97e10cb672f61fb581b866d02fb884b62485bfbc1c63a2721d3e1c116d6223b
+  metadata.gz: 4044288ac0d8d8dddaa8e914c9ee649cf24d31043c6135360788ea7fccb7522f
+  data.tar.gz: f3cf0b37bb3c1e641e7ec4121c580a186c39003dadd2e308d540008a7d8bb89c
 SHA512:
-  metadata.gz: cef70da38935cb7581232e23fe51041f5b0a9f2d3cb845b956dfdb3608762b4165c78b7fd17af857f99ba2301102167a841139e37c0cdb00b3337f3ebe21d95e
-  data.tar.gz: fb85cd253f346b37a46907366bf8cfa8ce8459b3f731ce1d4d7089ff17bf0839094f2d1826950cf1f644e54c0d7f128140fbe0d1b465acd1bd1bf9ef60faed8e
+  metadata.gz: 822f264d7447e5d43e2280a65b04792f8c317507b26a30f77dc4892995c6f28a1cacd5c1884cf7b548918616271acb4aac9b38d621eba3219c567ef70efbb867
+  data.tar.gz: 68f7d996faf5e10b92f91a25babcb7e60fc37d07632d5a5e4c38c2887a0c5fcbef08042528596bab1fd051f2dee871be1eecdd0e32cf2eabc41f8665ed079a0a

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.2.0 — 2026-10-18
+
+- `emails.send`, `sandboxes.send` and each `batch.send` item take `reply_to:` (the API's `replyTo`): one address or a list of up to 10, sent as the `Reply-To` header.
+- `emails.send` and `sandboxes.send` take `attachments:`, a list of `{ filename:, content:, content_type: }`. `content:` is the file's raw bytes (`File.binread("invoice.pdf")`) and the SDK base64-encodes it; pass `content_base64:` instead when you already hold base64, and it is sent as it is. Giving both, or a `content:` that is not a String, raises `ArgumentError` before any request. Limits: 10 MiB per file, 25 MiB per message, 20 files. A batch item with attachments is refused by the API (`attachments_not_batchable`).
+- Needs the SendClipper API from 2026-10-18 on; an older API ignores both fields.
+
 ## 0.1.0 — 2026-10-16
 
 First release.

data/README.md

@@ -43,6 +43,23 @@ Fields are keyword arguments (or a Hash). Top-level names may be snake_case (`te
 
 `from` must be a bare address on a domain you verified in SendClipper. Each message has one recipient in `to`; for several, use `batch.send`.
 
+## Reply-To and attachments
+
+```ruby
+data, error = client.emails.send(
+  from: "bookings@acme.io",
+  to: "ada@lumen.io",
+  subject: "Your booking",
+  html: "<p>Your confirmation is attached.</p>",
+  reply_to: "support@acme.io",
+  attachments: [
+    { filename: "booking-42.pdf", content: File.binread("booking-42.pdf") }
+  ]
+)
+```
+
+`reply_to:` is one address or a list of up to 10. `content:` is the file's raw bytes (read it with `File.binread`) and the SDK base64-encodes it; if you already hold base64, pass `content_base64:` instead and it is sent as it is. `content_type:` is guessed from the filename when you leave it out. Limits: 10 MiB per file, 25 MiB of files per message, and your sending provider's own. Attachments are not accepted on a batch item (it fails with `attachments_not_batchable`); send those emails on their own. `sandboxes.send` takes the same fields.
+
 ## Send with a template
 
 Design and publish a template in the dashboard, then send it by id or by its send name:

data/lib/sendclipper/resources/base.rb

@@ -29,7 +29,43 @@ module SendClipper
         fields.each_with_object({}) do |(k, v), out|
           next if v.nil?
 
-          out[k.to_s.gsub(/_([a-z0-9])/) { Regexp.last_match(1).upcase }] = v
+          out[camel(k)] = v
+        end
+      end
+
+      def camel(key) = key.to_s.gsub(/_([a-z0-9])/) { Regexp.last_match(1).upcase }
+
+      # The fields of one message (emails.send, sandboxes.send, a batch item):
+      # camelized, with each attachment's +content:+ (the file's raw bytes)
+      # base64-encoded. +content_base64:+ is content that is already base64,
+      # sent as it is.
+      def email_fields(fields)
+        out = camelize(fields)
+        list = out["attachments"]
+        out["attachments"] = list.map { |a| attachment_field(a) } if list.is_a?(Array)
+        out
+      end
+
+      def attachment_field(attachment)
+        given = attachment.to_h
+        names = given.reject { |_, v| v.nil? }.keys.map(&:to_s)
+        if names.include?("content") && (names & %w[content_base64 contentBase64]).any?
+          raise ArgumentError, "An attachment takes content: (the file's bytes) or content_base64:, not both"
+        end
+
+        given.each_with_object({}) do |(k, v), out|
+          next if v.nil?
+
+          case k.to_s
+          when "content"
+            unless v.is_a?(String)
+              raise ArgumentError, "An attachment's content: must be a String of the file's bytes, e.g. File.binread(path)"
+            end
+
+            out["content"] = [v].pack("m0")
+          when "content_base64", "contentBase64" then out["content"] = v
+          else out[camel(k)] = v
+          end
         end
       end
 

data/lib/sendclipper/resources/emails.rb

@@ -10,9 +10,14 @@ module SendClipper
       #
       # Every call carries an Idempotency-Key, so the SDK's own retries never
       # send twice. Pass +idempotency_key:+ to make YOUR retries safe too.
+      #
+      # +reply_to:+ is one address or a list of up to 10. +attachments:+ is a
+      # list of { filename:, content:, content_type: }, where +content:+ is the
+      # file's raw bytes (File.binread("invoice.pdf")) and the SDK base64-encodes
+      # it; pass +content_base64:+ instead when you already hold base64.
       def send(params = nil, **kw)
         body, options = split(params, kw)
-        api_post("/emails", body, options: options)
+        api_post("/emails", email_fields(body), options: options)
       end
 
       # Same as client.batch.send.
@@ -50,11 +55,14 @@ module SendClipper
     class Batch < Base
       # Up to 500 messages in one request (one recipient each). Every item is
       # accepted or refused on its own; a refused item costs its siblings nothing.
+      # An item takes +reply_to:+; an item with +attachments:+ is refused
+      # (+attachments_not_batchable+), so send those messages on their own.
       def send(emails, **options) = self.class.post(@http, emails, options)
 
       # @api private
       def self.post(http, emails, options)
-        items = emails.map { |e| new(http).__send__(:camelize, e.to_h) }
+        fields = new(http)
+        items = emails.map { |e| fields.__send__(:email_fields, e.to_h) }
         http.call("POST", "/emails/batch", body: { "emails" => items }, options: options)
       end
     end

data/lib/sendclipper/resources/sandboxes.rb

@@ -38,10 +38,11 @@ module SendClipper
       def reset_credentials(id, **options) = api_post("/sandboxes/#{seg(id)}/credentials", nil, options: options)
 
       # Send to a sandbox through its JSON door, with the sandbox's own
-      # +sc_sbx_...+ token. Same fields as emails.send; nothing is delivered.
+      # +sc_sbx_...+ token. Same fields as emails.send (reply_to and attachments
+      # included); nothing is delivered.
       def send(sandbox_token, params = nil, **kw)
         body, options = split(params, kw)
-        api_post("/sandbox/emails", body, options: options, bearer: sandbox_token)
+        api_post("/sandbox/emails", email_fields(body), options: options, bearer: sandbox_token)
       end
     end
 

data/lib/sendclipper/version.rb

@@ -2,5 +2,5 @@
 
 module SendClipper
   # Kept equal to the release tag by CI.
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sendclipper
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - SendClipper