mailtrap 2.6.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38c84a79ba87b360caf02839703e51e1e1af2cb84092e03b995677805dd09c16
-  data.tar.gz: 2a6e502ff5876367d35ecc5907d4aaa3fd32689f342d6e91c3f54dd189cdcaea
+  metadata.gz: a56e52ebde096ddaa019f4c16e15f63fe37ace69d91892f4c92044c0727b3c3f
+  data.tar.gz: 79a7aca8251526389c4faa2f643ca8f7e58182de4dcbada0af2d8f9a5afe6464
 SHA512:
-  metadata.gz: 927ef7bb197ea1636462a5e926eb273d8703e383ddee5e66b578252cb6d51cc7cb1e2afba194c70186980d67d32488cf3115c529146a6fedb02a8a5b4f0ae699
-  data.tar.gz: abcba3b12d50ae4b292c6fcdfd5e4b1786dafbfe02dfbe20528662dd3f2fc12b6fd2b14bd53b7ab09082a51a006e58003c9d8a989616cc5827d14ee89263c32f
+  metadata.gz: df5e86fd7a0d31a5b717e189ae9637f6e0f413dad2d4fd2c9adbc56e7be5197ef5a59a759dc6eee9ff19a98c9196c7d5f1a984b3ee5f75ef69a5ca0f376a5519
+  data.tar.gz: 516e66780366eaf9f76b07f0957092b345fdd0262cd15dd997dcde5887276b7b37ba9c5c29971c6e7e53082e74db4deb5575ba1b4e0ebab4341fae05d7accc98

data/.coderabbit.yaml

@@ -0,0 +1,10 @@
+# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
+language: en
+reviews:
+  path_instructions:
+    - path: "spec/fixtures/vcr_cassettes/**/*.yml"
+      instructions: |
+        Act as a data privacy officer. Carefully read all the vcr cassettes
+        with recorded HTTP interactions and try to identify sensitive data that
+        could potentially be recorded. It can be anything from PII to
+        credentials. Ignore obvious placeholder values and real IDs in URLs.

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [2.7.0] - 2026-02-24 
+- Add Sandbox Messages API
+- Add Sending Domains API
+- Add Sandbox Attachments API
+- Add Accounts API
+
 ## [2.6.0] - 2026-01-27
 - Add Inboxes API
 - Add Projects API

data/Gemfile

@@ -8,6 +8,8 @@ gem 'appraisal'
 gem 'irb'
 gem 'mail'
 gem 'net-smtp'
+gem 'rack'
+gem 'rackup'
 gem 'rake', '~> 13.3'
 gem 'rdoc', '~> 7.1.0'
 gem 'rspec', '~> 3'
@@ -17,4 +19,5 @@ gem 'rubocop-rake', require: false
 gem 'rubocop-rspec', require: false
 gem 'vcr'
 gem 'webmock'
+gem 'webrick'
 gem 'yard', '~> 0.9'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mailtrap (2.6.0)
+    mailtrap (2.7.0)
       base64
 
 GEM
@@ -61,6 +61,9 @@ GEM
       stringio
     public_suffix (7.0.2)
     racc (1.8.1)
+    rack (3.2.4)
+    rackup (2.3.1)
+      rack (>= 3)
     rainbow (3.1.1)
     rake (13.3.1)
     rdoc (7.1.0)
@@ -120,6 +123,7 @@ GEM
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
+    webrick (1.9.2)
     yard (0.9.38)
 
 PLATFORMS
@@ -131,6 +135,8 @@ DEPENDENCIES
   mail
   mailtrap!
   net-smtp
+  rack
+  rackup
   rake (~> 13.3)
   rdoc (~> 7.1.0)
   rspec (~> 3)
@@ -140,6 +146,7 @@ DEPENDENCIES
   rubocop-rspec
   vcr
   webmock
+  webrick
   yard (~> 0.9)
 
 BUNDLED WITH

data/README.md

@@ -173,24 +173,27 @@ mail(delivery_method: :mailtrap_bulk)
 Refer to the [`examples`](examples) folder for more examples:
 
 Email API:
-- Full email sending – [`full.rb`](examples/full.rb)
 
-- Batch sending – [`batch.rb`](examples/batch.rb)
+- Full Email Sending – [`full.rb`](examples/full.rb)
+- Batch Sending – [`batch.rb`](examples/batch.rb)
+- Sending Domains API  – [`sending_domains_api.rb`](examples/sending_domains_api.rb)
 
 Email Sandbox (Testing):
 
 - Projects CRUD – [`projects_api.rb`](examples/projects_api.rb)
 - Inboxes CRUD - [`inboxes_api.rb`](examples/inboxes_api.rb)
+- Sandbox Messages CRUD - [`sandbox_messages_api.rb`](examples/sandbox_messages_api.rb)
+- Sandbox Attachments API - [`sandbox_attachments_api.rb`](examples/sandbox_attachments_api.rb)
 
 Contact management:
 
-- Contacts CRUD & listing – [`contacts_api.rb`](examples/contacts_api.rb)
+- Contacts CRUD & Listing – [`contacts_api.rb`](examples/contacts_api.rb)
 
-General API:
+General:
 
 - Templates CRUD – [`email_templates_api.rb`](examples/email_templates_api.rb)
-
 - Action Mailer – [`action_mailer.rb`](examples/action_mailer.rb)
+- Accounts API – [`accounts_api.rb`](examples/accounts_api.rb)
 
 ## Migration guide v1 → v2
 
@@ -204,15 +207,24 @@ Bug reports and pull requests are welcome on [GitHub](https://github.com/railswa
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests. You can also run `bin/console` for an interactive 
+prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 
-To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To release a new version, update the version number in `version.rb`, and then
+run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and the created tag, and push the `.gem` file to 
+[rubygems.org](https://rubygems.org).
+
+To run the documentation server, first generate the documentation with
+`yard doc`, then run `yard server`.
 
 All contributions are required to have rspec tests covering its functionality.
 
-Please be sure to update [README](README.md) with new examples and features when applicable.
+Please be sure to update [README](README.md) with new examples and features
+when applicable.
 
 ## License
 
@@ -224,4 +236,4 @@ Everyone interacting in the Mailtrap project's codebases, issue trackers, chat r
 
 ## Compatibility with previous releases
 
-Versions of this package up to 2.0.2 were an [unofficial client](https://github.com/vchin/mailtrap-client) developed by [@vchin](https://github.com/vchin). Package version 3 is a completely new package. 
+Versions of this package up to 2.0.2 were an [unofficial client](https://github.com/vchin/mailtrap-client) developed by [@vchin](https://github.com/vchin). Package version 3 is a completely new package. 

data/lib/mailtrap/account.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Mailtrap
+  # Data Transfer Object for Account
+  # @see https://api-docs.mailtrap.io/docs/mailtrap-api-docs/d26921ca2a48f-get-all-accounts
+  # @attr_reader id [Integer] The account ID
+  # @attr_reader name [String] The account name
+  # @attr_reader access_levels [Array] The account access levels
+  #
+  Account = Struct.new(
+    :id,
+    :name,
+    :access_levels,
+    keyword_init: true
+  )
+end

data/lib/mailtrap/accounts_api.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'base_api'
+require_relative 'account'
+
+module Mailtrap
+  class AccountsAPI
+    include BaseAPI
+
+    self.response_class = Account
+
+    attr_reader :client
+
+    # @param client [Mailtrap::Client] The client instance
+    # @raise [ArgumentError] If account_id is nil
+    def initialize(client = Mailtrap::Client.new)
+      @client = client
+    end
+
+    # Lists all accounts
+    # @return [Array<Account>] Array of accounts
+    # @!macro api_errors
+    def list
+      base_list
+    end
+
+    private
+
+    def base_path
+      '/api/accounts'
+    end
+  end
+end

data/lib/mailtrap/client.rb

@@ -115,7 +115,7 @@ module Mailtrap
     #   )
     # @param base [#to_json] The base email configuration for the batch.
     # @param requests [Array<#to_json>] Array of individual email requests.
-    # @return [Hash] The JSON response from the API.
+    # @return [Hash, String, nil] JSON response or raw response body from the API.
     # @!macro api_errors
     # @raise [Mailtrap::MailSizeError] If the message is too large.
     def send_batch(base, requests)
@@ -153,7 +153,7 @@ module Mailtrap
     #     text: 'Congrats for sending test email with Mailtrap!'
     #   )
     # @param mail [#to_json] The email to send
-    # @return [Hash] The JSON response
+    # @return [Hash, String, nil] JSON response or raw response body
     # @!macro api_errors
     # @raise [Mailtrap::MailSizeError] If the message is too large
     def send(mail)
@@ -168,7 +168,7 @@ module Mailtrap
     # Performs a GET request to the specified path
     # @param path [String] The request path
     # @param query_params [Hash] Query parameters to append to the URL (optional)
-    # @return [Hash, nil] The JSON response
+    # @return [Hash, String, nil] JSON response or raw response body
     # @!macro api_errors
     def get(path, query_params = {})
       perform_request(
@@ -182,7 +182,7 @@ module Mailtrap
     # Performs a POST request to the specified path
     # @param path [String] The request path
     # @param body [Hash] The request body
-    # @return [Hash, nil] The JSON response
+    # @return [Hash, String, nil] JSON response or raw response body
     # @!macro api_errors
     def post(path, body = nil)
       perform_request(
@@ -196,7 +196,7 @@ module Mailtrap
     # Performs a PATCH request to the specified path
     # @param path [String] The request path
     # @param body [Hash] The request body
-    # @return [Hash, nil] The JSON response
+    # @return [Hash, String, nil] JSON response or raw response body
     # @!macro api_errors
     def patch(path, body = nil)
       perform_request(
@@ -209,7 +209,7 @@ module Mailtrap
 
     # Performs a DELETE request to the specified path
     # @param path [String] The request path
-    # @return [Hash, nil] The JSON response
+    # @return [Hash, String, nil] JSON response or raw response body
     # @!macro api_errors
     def delete(path)
       perform_request(
@@ -221,8 +221,11 @@ module Mailtrap
 
     private
 
-    def http_client_for(host)
-      @http_clients[host] ||= Net::HTTP.new(host, api_port).tap { |client| client.use_ssl = true }
+    def validate_args!(api_key, api_port, bulk, sandbox, inbox_id)
+      raise ArgumentError, 'api_key is required' if api_key.nil?
+      raise ArgumentError, 'api_port is required' if api_port.nil?
+      raise ArgumentError, 'bulk stream is not applicable for sandbox API' if bulk && sandbox
+      raise ArgumentError, 'inbox_id is required for sandbox API' if sandbox && inbox_id.nil?
     end
 
     def select_api_host(bulk:, sandbox:)
@@ -235,14 +238,6 @@ module Mailtrap
       end
     end
 
-    def send_path
-      "/api/send#{"/#{inbox_id}" if sandbox}"
-    end
-
-    def batch_request_path
-      "/api/batch#{"/#{inbox_id}" if sandbox}"
-    end
-
     def perform_request(method:, host:, path:, query_params: {}, body: nil)
       http_client = http_client_for(host)
 
@@ -254,6 +249,10 @@ module Mailtrap
       handle_response(response)
     end
 
+    def http_client_for(host)
+      @http_clients[host] ||= Net::HTTP.new(host, api_port).tap { |client| client.use_ssl = true }
+    end
+
     def setup_request(method, uri_or_path, body = nil)
       request = case method
                 when :get
@@ -279,17 +278,17 @@ module Mailtrap
     def handle_response(response) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength
       case response
       when Net::HTTPOK, Net::HTTPCreated
-        json_response(response.body)
+        parse_response(response)
       when Net::HTTPNoContent
         nil
       when Net::HTTPBadRequest
         raise Mailtrap::Error, ['bad request'] if response.body.empty?
 
-        raise Mailtrap::Error, response_errors(response.body)
+        raise Mailtrap::Error, response_errors(response)
       when Net::HTTPUnauthorized
-        raise Mailtrap::AuthorizationError, response_errors(response.body)
+        raise Mailtrap::AuthorizationError, response_errors(response)
       when Net::HTTPForbidden
-        raise Mailtrap::RejectionError, response_errors(response.body)
+        raise Mailtrap::RejectionError, response_errors(response)
       when Net::HTTPPayloadTooLarge
         raise Mailtrap::MailSizeError, ['message too large']
       when Net::HTTPTooManyRequests
@@ -303,20 +302,37 @@ module Mailtrap
       end
     end
 
-    def response_errors(body)
-      parsed_body = json_response(body)
-      Array(parsed_body[:errors] || parsed_body[:error])
+    def parse_response(response)
+      if json_response?(response)
+        json_response(response.body)
+      else
+        response.body
+      end
+    end
+
+    def response_errors(response)
+      if json_response?(response)
+        parsed_body = json_response(response.body)
+        Array(parsed_body[:errors] || parsed_body[:error])
+      else
+        [response.body]
+      end
+    end
+
+    def json_response?(response)
+      response.content_type == 'application/json'
     end
 
     def json_response(body)
       JSON.parse(body, symbolize_names: true)
     end
 
-    def validate_args!(api_key, api_port, bulk, sandbox, inbox_id)
-      raise ArgumentError, 'api_key is required' if api_key.nil?
-      raise ArgumentError, 'api_port is required' if api_port.nil?
-      raise ArgumentError, 'bulk stream is not applicable for sandbox API' if bulk && sandbox
-      raise ArgumentError, 'inbox_id is required for sandbox API' if sandbox && inbox_id.nil?
+    def send_path
+      "/api/send#{"/#{inbox_id}" if sandbox}"
+    end
+
+    def batch_request_path
+      "/api/batch#{"/#{inbox_id}" if sandbox}"
     end
   end
 end

data/lib/mailtrap/sandbox_attachment.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Mailtrap
+  # Data Transfer Object for SandboxAttachment
+  # @see https://docs.mailtrap.io/developers/email-sandbox/email-sandbox-api/attachments
+  # @attr_reader id [Integer] The attachment ID
+  # @attr_reader message_id [Integer] The message ID
+  # @attr_reader filename [String] The attachment filename
+  # @attr_reader attachment_type [String] The attachment type
+  # @attr_reader content_type [String] The attachment content type
+  # @attr_reader content_id [String] The attachment content ID
+  # @attr_reader transfer_encoding [String] The attachment transfer encoding
+  # @attr_reader attachment_size [Integer] The attachment size in bytes
+  # @attr_reader created_at [String] The attachment creation timestamp
+  # @attr_reader updated_at [String] The attachment update timestamp
+  # @attr_reader attachment_human_size [String] The attachment size in human-readable format
+  # @attr_reader download_path [String] The attachment download path
+  #
+  SandboxAttachment = Struct.new(
+    :id,
+    :message_id,
+    :filename,
+    :attachment_type,
+    :content_type,
+    :content_id,
+    :transfer_encoding,
+    :attachment_size,
+    :created_at,
+    :updated_at,
+    :attachment_human_size,
+    :download_path,
+    keyword_init: true
+  )
+end

data/lib/mailtrap/sandbox_attachments_api.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative 'base_api'
+require_relative 'sandbox_attachment'
+
+module Mailtrap
+  class SandboxAttachmentsAPI
+    include BaseAPI
+
+    attr_reader :account_id, :inbox_id, :sandbox_message_id, :client
+
+    self.response_class = SandboxAttachment
+
+    # @param account_id [Integer] The account ID
+    # @param inbox_id [Integer] The inbox ID
+    # @param sandbox_message_id [Integer] The message ID
+    # @param client [Mailtrap::Client] The client instance
+    # @raise [ArgumentError] If account_id is nil
+    # @raise [ArgumentError] If inbox_id is nil
+    def initialize(account_id, inbox_id, sandbox_message_id, client = Mailtrap::Client.new)
+      raise ArgumentError, 'inbox_id is required' if inbox_id.nil?
+      raise ArgumentError, 'sandbox_message_id is required' if sandbox_message_id.nil?
+
+      @inbox_id = inbox_id
+      @sandbox_message_id = sandbox_message_id
+
+      super(account_id, client)
+    end
+
+    # Retrieves a specific sandbox attachment
+    # @param sandbox_attachment_id [Integer] The sandbox attachment ID
+    # @return [SandboxAttachment] Sandbox attachment object
+    # @!macro api_errors
+    def get(sandbox_attachment_id)
+      base_get(sandbox_attachment_id)
+    end
+
+    # Lists all sandbox attachments for a message, limited up to 30 at once
+    # @return [Array<SandboxAttachment>] Array of sandbox attachment objects
+    # @!macro api_errors
+    def list
+      base_list
+    end
+
+    private
+
+    def base_path
+      "/api/accounts/#{account_id}/inboxes/#{inbox_id}/messages/#{sandbox_message_id}/attachments"
+    end
+  end
+end

data/lib/mailtrap/sandbox_message.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Mailtrap
+  # Data Transfer Object for Sandbox Message
+  # @see https://docs.mailtrap.io/developers/email-sandbox/email-sandbox-api/messages
+  # @attr_reader id [Integer] The message ID
+  # @attr_reader inbox_id [Integer] The inbox ID
+  # @attr_reader subject [String] The message subject
+  # @attr_reader sent_at [String] The timestamp when the message was sent
+  # @attr_reader from_email [String] The sender's email address
+  # @attr_reader from_name [String] The sender's name
+  # @attr_reader to_email [String] The recipient's email address
+  # @attr_reader to_name [String] The recipient's name
+  # @attr_reader email_size [Integer] The size of the email in bytes
+  # @attr_reader is_read [Boolean] Whether the message has been read
+  # @attr_reader created_at [String] The timestamp when the message was created
+  # @attr_reader updated_at [String] The timestamp when the message was last updated
+  # @attr_reader html_body_size [Integer] The size of the HTML body in bytes
+  # @attr_reader text_body_size [Integer] The size of the text body in bytes
+  # @attr_reader human_size [String] The human-readable size of the email
+  # @attr_reader html_path [String] The path to the HTML version of the email
+  # @attr_reader txt_path [String] The path to the text version of the email
+  # @attr_reader raw_path [String] The path to the raw version of the email
+  # @attr_reader download_path [String] The path to download the email
+  # @attr_reader html_source_path [String] The path to the HTML source of the email
+  # @attr_reader blacklists_report_info [Boolean] Information about blacklists report
+  # @attr_reader smtp_information [Hash] Information about SMTP
+  #
+  SandboxMessage = Struct.new(
+    :id,
+    :inbox_id,
+    :subject,
+    :sent_at,
+    :from_email,
+    :from_name,
+    :to_email,
+    :to_name,
+    :email_size,
+    :is_read,
+    :created_at,
+    :updated_at,
+    :html_body_size,
+    :text_body_size,
+    :human_size,
+    :html_path,
+    :txt_path,
+    :raw_path,
+    :download_path,
+    :html_source_path,
+    :blacklists_report_info,
+    :smtp_information,
+    keyword_init: true
+  ) do
+    # @return [Boolean] Whether the message has been read
+    def read?
+      is_read
+    end
+  end
+end

data/lib/mailtrap/sandbox_messages_api.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+require_relative 'base_api'
+require_relative 'sandbox_message'
+
+module Mailtrap
+  class SandboxMessagesAPI
+    include BaseAPI
+
+    attr_reader :account_id, :inbox_id, :client
+
+    self.supported_options = %i[is_read]
+
+    self.response_class = SandboxMessage
+
+    # @param account_id [Integer] The account ID
+    # @param inbox_id [Integer] The inbox ID
+    # @param client [Mailtrap::Client] The client instance
+    # @raise [ArgumentError] If account_id is nil
+    # @raise [ArgumentError] If inbox_id is nil
+    def initialize(account_id, inbox_id, client = Mailtrap::Client.new)
+      raise ArgumentError, 'inbox_id is required' if inbox_id.nil?
+
+      @inbox_id = inbox_id
+
+      super(account_id, client)
+    end
+
+    # Retrieves a specific sandbox message from inbox
+    # @param message_id [Integer] The sandbox message ID
+    # @return [SandboxMessage] Sandbox message object
+    # @!macro api_errors
+    def get(message_id)
+      base_get(message_id)
+    end
+
+    # Deletes a sandbox message
+    # @param message_id [Integer] The sandbox message ID
+    # @return [SandboxMessage] Deleted Sandbox message object
+    # @!macro api_errors
+    def delete(message_id)
+      base_delete(message_id)
+    end
+
+    # Updates an existing sandbox message
+    # @param message_id [Integer] The sandbox message ID
+    # @param is_read [Boolean]
+    # @return [SandboxMessage] Updated Sandbox message object
+    # @!macro api_errors
+    def mark_as_read(message_id, is_read: true)
+      base_update(message_id, { is_read: is_read })
+    end
+
+    # Lists all sandbox messages for the account, limited up to 30 at once
+    # @param search [String] Search query string. Matches subject, to_email, and to_name.
+    # @param last_id [Integer] If specified, a page of records before last_id is returned.
+    # Overrides page if both are given.
+    # @param page [Integer] Page number for paginated results.
+    # @return [Array<SandboxMessage>] Array of sandbox message objects
+    # @!macro api_errors
+    def list(search: nil, last_id: nil, page: nil)
+      raise ArgumentError, 'Provide either last_id or page, not both' unless last_id.nil? || page.nil?
+
+      query_params = {}
+      query_params[:search] = search unless search.nil?
+      query_params[:last_id] = last_id unless last_id.nil?
+      query_params[:page] = page unless page.nil?
+
+      base_list(query_params)
+    end
+
+    # Forward message to an email address.
+    # @param message_id [Integer] The sandbox message ID
+    # @param email [String] The email to forward sandbox message to
+    # @return [String] Forwarded message confirmation
+    # @!macro api_errors
+    def forward_message(message_id, email:)
+      client.post("#{base_path}/#{message_id}/forward", { email: email })
+    end
+
+    # Get message spam score
+    # @param message_id [Integer] The sandbox message ID
+    # @return [Hash] Spam report
+    # @!macro api_errors
+    def spam_score(message_id)
+      client.get("#{base_path}/#{message_id}/spam_report")
+    end
+
+    # Get message HTML analysis
+    # @param message_id [Integer] The sandbox message ID
+    # @return [Hash] brief HTML report
+    # @!macro api_errors
+    def html_analysis(message_id)
+      client.get("#{base_path}/#{message_id}/analyze")
+    end
+
+    # Get text message
+    # @param message_id [Integer] The sandbox message ID
+    # @return [String] text email body
+    # @!macro api_errors
+    def text_body(message_id)
+      client.get("#{base_path}/#{message_id}/body.txt")
+    end
+
+    # Get raw message
+    # @param message_id [Integer] The sandbox message ID
+    # @return [String] raw email body
+    # @!macro api_errors
+    def raw_body(message_id)
+      client.get("#{base_path}/#{message_id}/body.raw")
+    end
+
+    # Get message source
+    # @param message_id [Integer] The sandbox message ID
+    # @return [String] HTML source of a message.
+    # @!macro api_errors
+    def html_source(message_id)
+      client.get("#{base_path}/#{message_id}/body.htmlsource")
+    end
+
+    # Get formatted HTML email body. Not applicable for plain text emails.
+    # @param message_id [Integer] The sandbox message ID
+    # @return [String] message body in html format.
+    # @!macro api_errors
+    def html_body(message_id)
+      client.get("#{base_path}/#{message_id}/body.html")
+    end
+
+    # Get message as EML
+    # @param message_id [Integer] The sandbox message ID
+    # @return [String] mail message body in EML format.
+    # @!macro api_errors
+    def eml_body(message_id)
+      client.get("#{base_path}/#{message_id}/body.eml")
+    end
+
+    # Get mail headers
+    # @param message_id [Integer] The sandbox message ID
+    # @return [Hash] mail headers of the message.
+    # @!macro api_errors
+    def mail_headers(message_id)
+      client.get("#{base_path}/#{message_id}/mail_headers")
+    end
+
+    private
+
+    def base_path
+      "/api/accounts/#{account_id}/inboxes/#{inbox_id}/messages"
+    end
+
+    def wrap_request(options)
+      { message: options }
+    end
+  end
+end

data/lib/mailtrap/sending_domain.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Mailtrap
+  # Data Transfer Object for Sending Domain
+  # @see https://docs.mailtrap.io/developers/management/sending-domains
+  # @attr_reader id [Integer] The sending domain ID
+  # @attr_reader domain_name [String] The sending domain name
+  # @attr_reader demo [Boolean] Whether the sending domain is a demo domain
+  # @attr_reader compliance_status [String] The compliance status of the sending domain
+  # @attr_reader dns_verified [Boolean] Whether the DNS records are verified
+  # @attr_reader dns_verified_at [String, nil] The timestamp when DNS was verified
+  # @attr_reader dns_records [Array] The DNS records for the sending domain
+  # @attr_reader open_tracking_enabled [Boolean] Whether open tracking is enabled
+  # @attr_reader click_tracking_enabled [Boolean] Whether click tracking is enabled
+  # @attr_reader auto_unsubscribe_link_enabled [Boolean] Whether auto unsubscribe link is enabled
+  # @attr_reader custom_domain_tracking_enabled [Boolean] Whether custom domain tracking is enabled
+  # @attr_reader health_alerts_enabled [Boolean] Whether health alerts are enabled
+  # @attr_reader critical_alerts_enabled [Boolean] Whether critical alerts are enabled
+  # @attr_reader alert_recipient_email [String, nil] The email address for alert recipients
+  # @attr_reader permissions [Hash] The permissions for the sending domain
+  #
+  SendingDomain = Struct.new(
+    :id,
+    :domain_name,
+    :demo,
+    :compliance_status,
+    :dns_verified,
+    :dns_verified_at,
+    :dns_records,
+    :open_tracking_enabled,
+    :click_tracking_enabled,
+    :auto_unsubscribe_link_enabled,
+    :custom_domain_tracking_enabled,
+    :health_alerts_enabled,
+    :critical_alerts_enabled,
+    :alert_recipient_email,
+    :permissions,
+    :created_at,
+    :updated_at,
+    keyword_init: true
+  )
+end

data/lib/mailtrap/sending_domains_api.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require_relative 'base_api'
+require_relative 'sending_domain'
+
+module Mailtrap
+  class SendingDomainsAPI
+    include BaseAPI
+
+    self.supported_options = %i[domain_name]
+
+    self.response_class = SendingDomain
+
+    # Lists all sending domains for the account
+    # @return [Array<SendingDomain>] Array of sending domains
+    # @!macro api_errors
+    def list
+      response = client.get(base_path)
+      response[:data].map { |item| handle_response(item) }
+    end
+
+    # Retrieves a specific sending domain
+    # @param domain_id [Integer] The sending domain ID
+    # @return [SendingDomain] Sending domain object
+    # @!macro api_errors
+    def get(domain_id)
+      base_get(domain_id)
+    end
+
+    # Creates a new sending domain
+    # @param [Hash] options The parameters to create
+    # @option options [String] :domain_name The sending domain name
+    # @return [SendingDomain] Created sending domain
+    # @!macro api_errors
+    # @raise [ArgumentError] If invalid options are provided
+    def create(options)
+      base_create(options)
+    end
+
+    # Deletes a sending domain
+    # @param domain_id [Integer] The sending domain ID
+    # @return nil
+    # @!macro api_errors
+    def delete(domain_id)
+      base_delete(domain_id)
+    end
+
+    # Email DNS configuration instructions for the sending domain
+    # @param domain_id [Integer] The sending domain ID
+    # @param email [String] The email for instructions
+    # @return nil
+    # @!macro api_errors
+    def send_setup_instructions(domain_id, email:)
+      client.post("#{base_path}/#{domain_id}/send_setup_instructions", email:)
+    end
+
+    private
+
+    def base_path
+      "/api/accounts/#{account_id}/sending_domains"
+    end
+
+    def wrap_request(options)
+      { sending_domain: options }
+    end
+  end
+end

data/lib/mailtrap/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mailtrap
-  VERSION = '2.6.0'
+  VERSION = '2.7.0'
 end

data/lib/mailtrap.rb

@@ -4,14 +4,18 @@ require_relative 'mailtrap/action_mailer' if defined? ActionMailer
 require_relative 'mailtrap/mail'
 require_relative 'mailtrap/errors'
 require_relative 'mailtrap/version'
+require_relative 'mailtrap/accounts_api'
 require_relative 'mailtrap/email_templates_api'
 require_relative 'mailtrap/contacts_api'
 require_relative 'mailtrap/contact_lists_api'
 require_relative 'mailtrap/contact_fields_api'
 require_relative 'mailtrap/contact_imports_api'
 require_relative 'mailtrap/suppressions_api'
+require_relative 'mailtrap/sending_domains_api'
 require_relative 'mailtrap/projects_api'
 require_relative 'mailtrap/inboxes_api'
+require_relative 'mailtrap/sandbox_messages_api'
+require_relative 'mailtrap/sandbox_attachments_api'
 
 module Mailtrap
   # @!macro api_errors

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mailtrap
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.7.0
 platform: ruby
 authors:
 - Railsware Products Studio LLC
@@ -30,6 +30,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coderabbit.yaml"
 - ".rspec"
 - ".rubocop.yml"
 - Appraisals
@@ -41,6 +42,8 @@ files:
 - README.md
 - Rakefile
 - lib/mailtrap.rb
+- lib/mailtrap/account.rb
+- lib/mailtrap/accounts_api.rb
 - lib/mailtrap/action_mailer.rb
 - lib/mailtrap/action_mailer/delivery_method.rb
 - lib/mailtrap/action_mailer/railtie.rb
@@ -66,6 +69,12 @@ files:
 - lib/mailtrap/mail/from_template.rb
 - lib/mailtrap/project.rb
 - lib/mailtrap/projects_api.rb
+- lib/mailtrap/sandbox_attachment.rb
+- lib/mailtrap/sandbox_attachments_api.rb
+- lib/mailtrap/sandbox_message.rb
+- lib/mailtrap/sandbox_messages_api.rb
+- lib/mailtrap/sending_domain.rb
+- lib/mailtrap/sending_domains_api.rb
 - lib/mailtrap/suppression.rb
 - lib/mailtrap/suppressions_api.rb
 - lib/mailtrap/version.rb
@@ -92,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Official mailtrap.io API client
 test_files: []