ark-email 0.11.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d612dc78e03726f7930429ab6d7cf9826145b9bf42d5049e8a5ecea9db3ad7b8
-  data.tar.gz: 33a733a57efb4084871fde7e35c7913c836eecc708a40af1210171f91de390c7
+  metadata.gz: 8d3a8978fdd41f199bc7e58a28af1391a16974818d5c90d9df9f5813a71791d4
+  data.tar.gz: a6b629b835da4d3c4d22f0f8c24815b4c66fff403fa277c75b37ad3b96a0055b
 SHA512:
-  metadata.gz: 4487eebe13f6bc9f8589ae754827ea7f0a62a9796964a1f938272f16b1dadce28b49efb4d836ab90b0d68742c2bfc3eca6b3ec4376df87255c56db9f75301dee
-  data.tar.gz: 3f9798c5f37e08efcbdc8f6723258412fe55f91bcb1f71b7440d204d1b5800ce75acbc6b0c0e7192c73b742b3729e343013869c3758fb1e44a399f8787ef0020
+  metadata.gz: '015863b0e54d3d1d11984029639548ccfb21338f48272c326eab7c423e863a29fd52f13ed019ca7eca4d459f8f96f71bcb16d30a226dd7d8bebe0279fe3dda02'
+  data.tar.gz: 5ca9ed7396673028c3bbf88e82686a397c4f05809538961c47c1c6ba8b1d23e9b5705f8ff8238031c003ed4fcc1dafa28917f9bb61053fd76559bf5608b0450c

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # 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)
+
+### Features
+
+* **api:** improve raw endpoint ([a0862f2](https://github.com/ArkHQ-io/ark-ruby/commit/a0862f2080187dcf8cdc0ab8d802849cdc9174ad))
+
 ## 0.11.0 (2026-01-22)
 
 Full Changelog: [v0.10.0...v0.11.0](https://github.com/ArkHQ-io/ark-ruby/compare/v0.10.0...v0.11.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.11.0"
+gem "ark-email", "~> 0.13.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/ark_email/models/email_send_raw_params.rb

@@ -7,23 +7,35 @@ module ArkEmail
       extend ArkEmail::Internal::Type::RequestParameters::Converter
       include ArkEmail::Internal::Type::RequestParameters
 
-      # @!attribute data
-      #   Base64-encoded RFC 2822 message
+      # @!attribute from
+      #   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 :data, String
+      required :from, String
 
-      # @!attribute mail_from
-      #   Envelope sender address
+      # @!attribute raw_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 :mail_from, String, api_name: :mailFrom
+      required :raw_message, String, api_name: :rawMessage
 
-      # @!attribute rcpt_to
-      #   Envelope recipient addresses
+      # @!attribute to
+      #   Recipient email addresses
       #
       #   @return [Array<String>]
-      required :rcpt_to, ArkEmail::Internal::Type::ArrayOf[String], api_name: :rcptTo
+      required :to, ArkEmail::Internal::Type::ArrayOf[String]
 
       # @!attribute bounce
       #   Whether this is a bounce message (accepts null)
@@ -31,12 +43,15 @@ module ArkEmail
       #   @return [Boolean, nil]
       optional :bounce, ArkEmail::Internal::Type::Boolean, nil?: true
 
-      # @!method initialize(data:, mail_from:, rcpt_to:, bounce: nil, request_options: {})
-      #   @param data [String] Base64-encoded RFC 2822 message
+      # @!method initialize(from:, raw_message:, to:, bounce: nil, request_options: {})
+      #   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 mail_from [String] Envelope sender address
+      #   @param raw_message [String] Base64-encoded RFC 2822 MIME message.
       #
-      #   @param rcpt_to [Array<String>] Envelope recipient addresses
+      #   @param to [Array<String>] Recipient email addresses
       #
       #   @param bounce [Boolean, nil] Whether this is a bounce message (accepts null)
       #

data/lib/ark_email/resources/emails.rb

@@ -263,18 +263,23 @@ 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 `data` 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(data:, mail_from:, rcpt_to:, bounce: nil, request_options: {})
+      # @overload send_raw(from:, raw_message:, to:, bounce: nil, request_options: {})
       #
-      # @param data [String] Base64-encoded RFC 2822 message
+      # @param from [String] Sender email address. Must be from a verified domain.
       #
-      # @param mail_from [String] Envelope sender address
+      # @param raw_message [String] Base64-encoded RFC 2822 MIME message.
       #
-      # @param rcpt_to [Array<String>] Envelope recipient addresses
+      # @param to [Array<String>] Recipient email addresses
       #
       # @param bounce [Boolean, nil] Whether this is a bounce message (accepts null)
       #

data/lib/ark_email/version.rb

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

data/rbi/ark_email/models/email_send_raw_params.rbi

@@ -11,17 +11,29 @@ module ArkEmail
           T.any(ArkEmail::EmailSendRawParams, ArkEmail::Internal::AnyHash)
         end
 
-      # Base64-encoded RFC 2822 message
+      # 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 :data
+      attr_accessor :from
 
-      # Envelope sender address
+      # 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 :mail_from
+      attr_accessor :raw_message
 
-      # Envelope recipient addresses
+      # Recipient email addresses
       sig { returns(T::Array[String]) }
-      attr_accessor :rcpt_to
+      attr_accessor :to
 
       # Whether this is a bounce message (accepts null)
       sig { returns(T.nilable(T::Boolean)) }
@@ -29,20 +41,32 @@ module ArkEmail
 
       sig do
         params(
-          data: String,
-          mail_from: String,
-          rcpt_to: T::Array[String],
+          from: String,
+          raw_message: String,
+          to: T::Array[String],
           bounce: T.nilable(T::Boolean),
           request_options: ArkEmail::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
-        # Base64-encoded RFC 2822 message
-        data:,
-        # Envelope sender address
-        mail_from:,
-        # Envelope recipient addresses
-        rcpt_to:,
+        # 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.
+        #
+        # **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:,
         # Whether this is a bounce message (accepts null)
         bounce: nil,
         request_options: {}
@@ -52,9 +76,9 @@ module ArkEmail
       sig do
         override.returns(
           {
-            data: String,
-            mail_from: String,
-            rcpt_to: T::Array[String],
+            from: String,
+            raw_message: String,
+            to: T::Array[String],
             bounce: T.nilable(T::Boolean),
             request_options: ArkEmail::RequestOptions
           }

data/rbi/ark_email/resources/emails.rbi

@@ -276,23 +276,37 @@ 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 `data` 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(
-          data: String,
-          mail_from: String,
-          rcpt_to: T::Array[String],
+          from: String,
+          raw_message: String,
+          to: T::Array[String],
           bounce: T.nilable(T::Boolean),
           request_options: ArkEmail::RequestOptions::OrHash
         ).returns(ArkEmail::Models::EmailSendRawResponse)
       end
       def send_raw(
-        # Base64-encoded RFC 2822 message
-        data:,
-        # Envelope sender address
-        mail_from:,
-        # Envelope recipient addresses
-        rcpt_to:,
+        # 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.
+        #
+        # **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:,
         # Whether this is a bounce message (accepts null)
         bounce: nil,
         request_options: {}

data/sig/ark_email/models/email_send_raw_params.rbs

@@ -1,38 +1,33 @@
 module ArkEmail
   module Models
     type email_send_raw_params =
-      {
-        data: String,
-        mail_from: String,
-        rcpt_to: ::Array[String],
-        bounce: bool?
-      }
+      { from: String, raw_message: String, to: ::Array[String], bounce: bool? }
       & ArkEmail::Internal::Type::request_parameters
 
     class EmailSendRawParams < ArkEmail::Internal::Type::BaseModel
       extend ArkEmail::Internal::Type::RequestParameters::Converter
       include ArkEmail::Internal::Type::RequestParameters
 
-      attr_accessor data: String
+      attr_accessor from: String
 
-      attr_accessor mail_from: String
+      attr_accessor raw_message: String
 
-      attr_accessor rcpt_to: ::Array[String]
+      attr_accessor to: ::Array[String]
 
       attr_accessor bounce: bool?
 
       def initialize: (
-        data: String,
-        mail_from: String,
-        rcpt_to: ::Array[String],
+        from: String,
+        raw_message: String,
+        to: ::Array[String],
         ?bounce: bool?,
         ?request_options: ArkEmail::request_opts
       ) -> void
 
       def to_hash: -> {
-        data: String,
-        mail_from: String,
-        rcpt_to: ::Array[String],
+        from: String,
+        raw_message: String,
+        to: ::Array[String],
         bounce: bool?,
         request_options: ArkEmail::RequestOptions
       }

data/sig/ark_email/resources/emails.rbs

@@ -54,9 +54,9 @@ module ArkEmail
       ) -> ArkEmail::Models::EmailSendBatchResponse
 
       def send_raw: (
-        data: String,
-        mail_from: String,
-        rcpt_to: ::Array[String],
+        from: String,
+        raw_message: String,
+        to: ::Array[String],
         ?bounce: bool?,
         ?request_options: ArkEmail::request_opts
       ) -> ArkEmail::Models::EmailSendRawResponse

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ark-email
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Ark
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-01-22 00:00:00.000000000 Z
+date: 2026-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi