ark-email 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c00d08f6dc8c60212e04d6f91c6a2a9224a5719a1e361c7b39467b880f035ba2
-  data.tar.gz: 549a5f2e13e0ccbbb47a2c7d66f6bc8cbde7121968a633801113cb9ac074d8a6
+  metadata.gz: 8d3a8978fdd41f199bc7e58a28af1391a16974818d5c90d9df9f5813a71791d4
+  data.tar.gz: a6b629b835da4d3c4d22f0f8c24815b4c66fff403fa277c75b37ad3b96a0055b
 SHA512:
-  metadata.gz: 0404fdb2d9cf3efbcdec7ae804e0f5ef57abd64781ee91c74d070736ad8631e7495168b22123d5eff5c7fdc42202e6148c151fef56146bf04a3566125763d9be
-  data.tar.gz: ee1ed6181c4d43550145d9924379cbd21eb36cecd8154f1d35ac0be30f975b9eb4ad9f06ae35ee26e02c0d17c8bc1be1225bea4912c78d6928d1cb47a339062b
+  metadata.gz: '015863b0e54d3d1d11984029639548ccfb21338f48272c326eab7c423e863a29fd52f13ed019ca7eca4d459f8f96f71bcb16d30a226dd7d8bebe0279fe3dda02'
+  data.tar.gz: 5ca9ed7396673028c3bbf88e82686a397c4f05809538961c47c1c6ba8b1d23e9b5705f8ff8238031c003ed4fcc1dafa28917f9bb61053fd76559bf5608b0450c

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 0.13.0 (2026-01-23)
+
+Full Changelog: [v0.12.0...v0.13.0](https://github.com/ArkHQ-io/ark-ruby/compare/v0.12.0...v0.13.0)
+
+### Features
+
+* **api:** fix from in Send raw MIME email ([cc449e8](https://github.com/ArkHQ-io/ark-ruby/commit/cc449e8446159fdda2c063f8ecc3c49397a5946f))
+* **api:** improve raw MIME error handling ([ecbba2f](https://github.com/ArkHQ-io/ark-ruby/commit/ecbba2fe4af6f1116b4581adf8d5bfcc4be11140))
+
 ## 0.12.0 (2026-01-23)
 
 Full Changelog: [v0.11.0...v0.12.0](https://github.com/ArkHQ-io/ark-ruby/compare/v0.11.0...v0.12.0)

data/README.md

@@ -26,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "ark-email", "~> 0.12.0"
+gem "ark-email", "~> 0.13.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/ark_email/models/email_send_raw_params.rb

@@ -8,13 +8,25 @@ module ArkEmail
       include ArkEmail::Internal::Type::RequestParameters
 
       # @!attribute from
-      #   Sender email address
+      #   Sender email address. Must be from a verified domain.
+      #
+      #   **Supported formats:**
+      #
+      #   - Email only: `hello@yourdomain.com`
+      #   - With display name: `Acme <hello@yourdomain.com>`
+      #   - With quoted name: `"Acme Support" <support@yourdomain.com>`
+      #
+      #   The domain portion must match a verified sending domain in your account.
       #
       #   @return [String]
       required :from, String
 
       # @!attribute raw_message
-      #   Base64-encoded RFC 2822 MIME message
+      #   Base64-encoded RFC 2822 MIME message.
+      #
+      #   **You must base64-encode your raw email before sending.** The raw email should
+      #   include headers (From, To, Subject, Content-Type, etc.) followed by a blank line
+      #   and the message body.
       #
       #   @return [String]
       required :raw_message, String, api_name: :rawMessage
@@ -32,9 +44,12 @@ module ArkEmail
       optional :bounce, ArkEmail::Internal::Type::Boolean, nil?: true
 
       # @!method initialize(from:, raw_message:, to:, bounce: nil, request_options: {})
-      #   @param from [String] Sender email address
+      #   Some parameter documentations has been truncated, see
+      #   {ArkEmail::Models::EmailSendRawParams} for more details.
+      #
+      #   @param from [String] Sender email address. Must be from a verified domain.
       #
-      #   @param raw_message [String] Base64-encoded RFC 2822 MIME message
+      #   @param raw_message [String] Base64-encoded RFC 2822 MIME message.
       #
       #   @param to [Array<String>] Recipient email addresses
       #

data/lib/ark_email/resources/emails.rb

@@ -263,16 +263,21 @@ module ArkEmail
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {ArkEmail::Models::EmailSendRawParams} for more details.
+      #
       # Send a pre-formatted RFC 2822 MIME message. Use this for advanced use cases or
       # when migrating from systems that generate raw email content.
       #
-      # The `rawMessage` field should contain the base64-encoded raw email.
+      # **Important:** The `rawMessage` field must be base64-encoded. Your raw MIME
+      # message (with headers like From, To, Subject, Content-Type, followed by a blank
+      # line and the body) must be encoded to base64 before sending.
       #
       # @overload send_raw(from:, raw_message:, to:, bounce: nil, request_options: {})
       #
-      # @param from [String] Sender email address
+      # @param from [String] Sender email address. Must be from a verified domain.
       #
-      # @param raw_message [String] Base64-encoded RFC 2822 MIME message
+      # @param raw_message [String] Base64-encoded RFC 2822 MIME message.
       #
       # @param to [Array<String>] Recipient email addresses
       #

data/lib/ark_email/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ArkEmail
-  VERSION = "0.12.0"
+  VERSION = "0.13.0"
 end

data/rbi/ark_email/models/email_send_raw_params.rbi

@@ -11,11 +11,23 @@ module ArkEmail
           T.any(ArkEmail::EmailSendRawParams, ArkEmail::Internal::AnyHash)
         end
 
-      # Sender email address
+      # Sender email address. Must be from a verified domain.
+      #
+      # **Supported formats:**
+      #
+      # - Email only: `hello@yourdomain.com`
+      # - With display name: `Acme <hello@yourdomain.com>`
+      # - With quoted name: `"Acme Support" <support@yourdomain.com>`
+      #
+      # The domain portion must match a verified sending domain in your account.
       sig { returns(String) }
       attr_accessor :from
 
-      # Base64-encoded RFC 2822 MIME message
+      # Base64-encoded RFC 2822 MIME message.
+      #
+      # **You must base64-encode your raw email before sending.** The raw email should
+      # include headers (From, To, Subject, Content-Type, etc.) followed by a blank line
+      # and the message body.
       sig { returns(String) }
       attr_accessor :raw_message
 
@@ -37,9 +49,21 @@ module ArkEmail
         ).returns(T.attached_class)
       end
       def self.new(
-        # Sender email address
+        # Sender email address. Must be from a verified domain.
+        #
+        # **Supported formats:**
+        #
+        # - Email only: `hello@yourdomain.com`
+        # - With display name: `Acme <hello@yourdomain.com>`
+        # - With quoted name: `"Acme Support" <support@yourdomain.com>`
+        #
+        # The domain portion must match a verified sending domain in your account.
         from:,
-        # Base64-encoded RFC 2822 MIME message
+        # Base64-encoded RFC 2822 MIME message.
+        #
+        # **You must base64-encode your raw email before sending.** The raw email should
+        # include headers (From, To, Subject, Content-Type, etc.) followed by a blank line
+        # and the message body.
         raw_message:,
         # Recipient email addresses
         to:,

data/rbi/ark_email/resources/emails.rbi

@@ -276,7 +276,9 @@ module ArkEmail
       # Send a pre-formatted RFC 2822 MIME message. Use this for advanced use cases or
       # when migrating from systems that generate raw email content.
       #
-      # The `rawMessage` field should contain the base64-encoded raw email.
+      # **Important:** The `rawMessage` field must be base64-encoded. Your raw MIME
+      # message (with headers like From, To, Subject, Content-Type, followed by a blank
+      # line and the body) must be encoded to base64 before sending.
       sig do
         params(
           from: String,
@@ -287,9 +289,21 @@ module ArkEmail
         ).returns(ArkEmail::Models::EmailSendRawResponse)
       end
       def send_raw(
-        # Sender email address
+        # Sender email address. Must be from a verified domain.
+        #
+        # **Supported formats:**
+        #
+        # - Email only: `hello@yourdomain.com`
+        # - With display name: `Acme <hello@yourdomain.com>`
+        # - With quoted name: `"Acme Support" <support@yourdomain.com>`
+        #
+        # The domain portion must match a verified sending domain in your account.
         from:,
-        # Base64-encoded RFC 2822 MIME message
+        # Base64-encoded RFC 2822 MIME message.
+        #
+        # **You must base64-encode your raw email before sending.** The raw email should
+        # include headers (From, To, Subject, Content-Type, etc.) followed by a blank line
+        # and the message body.
         raw_message:,
         # Recipient email addresses
         to:,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ark-email
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Ark