mailtrap 2.14.0 → 2.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0e9b68ca02cc19cc2c9800b4ea92a41082f50e71a79c1df11be822007e462f0
-  data.tar.gz: 426de0d20a602d9e792eb71a1fb8d7bfcf5d9b449d5159cff16c1b7e1ac2bb7c
+  metadata.gz: 5a727114a65c3b0d37de9dcc946d8e5d7d0c5c786b408844c4d399b9ae8caa32
+  data.tar.gz: 0ca0ebb87fe19a6d1a59268da9ba4b5f7cbe5c85224236764aa94dad103d6dc7
 SHA512:
-  metadata.gz: ca735c6afbeca23e39833447203a8988ba07b4cce4e926d78580c4efb8978b51d96afadeaf60975169d2ed44a32be47b1236a803351b9c98c66aa50a7cd8f2dd
-  data.tar.gz: defd7a908427006d002903ffe24d286ee7f15fcd2de28497056f2c9b0bf9fabfa1a0c471bb1d4f31ecae5ca8dab272001ce55f5ace461eac7dc5ed18eb8a1740
+  metadata.gz: b3b319869ad41f336475b58a86ef8d2b4c4e13979ae740690b5b4f95429b0094b0387ea7e1cde605085735e61bcc710af7c2424a7a7b44144c7db9fedb265ebd
+  data.tar.gz: 3d93fccceadcf06720feda85ff17ff2278df6f1a93f6b734e14e57f7a4d843b77cda69f88c350290f415474920a70c63056a6446265cba1e0d56c2601c7ffd02

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+## [2.16.0] - 2026-08-31
+
+## What's Changed
+* MT-23076: support expires_at for api token create and reset by @oshchyhol in https://github.com/mailtrap/mailtrap-ruby/pull/122
+* MT-23762: redact api token values from VCR cassettes by @oshchyhol in https://github.com/mailtrap/mailtrap-ruby/pull/125
+
+## New Contributors
+* @oshchyhol made their first contribution in https://github.com/mailtrap/mailtrap-ruby/pull/122
+
+**Full Changelog**: https://github.com/mailtrap/mailtrap-ruby/compare/v2.15.0...v2.16.0
+
+## [2.15.0] - 2026-08-28
+
+## What's Changed
+* Accept all sending domain update options by @mklocek in https://github.com/mailtrap/mailtrap-ruby/pull/126
+* Add tracking opt-outs and create-suppression endpoints by @mklocek in https://github.com/mailtrap/mailtrap-ruby/pull/127
+
+
+**Full Changelog**: https://github.com/mailtrap/mailtrap-ruby/compare/v2.14.0...v2.15.0
+
 ## [2.14.0] - 2026-08-14
 
 ## What's Changed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mailtrap (2.14.0)
+    mailtrap (2.16.0)
       base64
 
 GEM

data/README.md

@@ -179,6 +179,8 @@ Email API:
 - Sending Stats API – [`stats_api.rb`](examples/stats_api.rb)
 - Email Logs API – [`email_logs_api.rb`](examples/email_logs_api.rb)
 - Webhooks API – [`webhooks_api.rb`](examples/webhooks_api.rb)
+- Suppressions API – [`suppressions_api.rb`](examples/suppressions_api.rb)
+- Tracking Opt-outs API – [`tracking_opt_outs_api.rb`](examples/tracking_opt_outs_api.rb)
 
 Email Sandbox (Testing):
 
@@ -206,7 +208,9 @@ General:
 
 - Accounts API – [`accounts_api.rb`](examples/accounts_api.rb)
 - Account Accesses API – [`account_accesses_api.rb`](examples/account_accesses_api.rb)
+- API Tokens API – [`api_tokens_api.rb`](examples/api_tokens_api.rb)
 - Billing API – [`billing_api.rb`](examples/billing_api.rb)
+- Permissions API – [`permissions_api.rb`](examples/permissions_api.rb)
 - Templates API – [`email_templates_api.rb`](examples/email_templates_api.rb)
 - Action Mailer – [`action_mailer.rb`](examples/action_mailer.rb)
 - Verifying webhook signatures – [`webhooks_signature_verification.ru`](examples/webhooks_signature_verification.ru)

data/lib/mailtrap/account_accesses_api.rb

@@ -7,8 +7,6 @@ module Mailtrap
   class AccountAccessesAPI
     include BaseAPI
 
-    attr_reader :account_id
-
     self.response_class = AccountAccess
 
     # Retrieves a list of account accesses with optional filtering by domain, inbox, or project IDs

data/lib/mailtrap/accounts_api.rb

@@ -9,8 +9,6 @@ module Mailtrap
 
     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)

data/lib/mailtrap/api_tokens_api.rb

@@ -7,7 +7,7 @@ module Mailtrap
   class ApiTokensAPI
     include BaseAPI
 
-    self.supported_options = %i[name resources].freeze
+    self.supported_options = %i[name expires_at resources].freeze
 
     self.response_class = ApiToken
 
@@ -30,6 +30,9 @@ module Mailtrap
     # Creates a new API token. The full `token` value is returned ONLY ONCE — store it securely.
     # @param [Hash] options The parameters to create
     # @option options [String] :name Display name for the token
+    # @option options [String, nil] :expires_at Optional token expiration as an ISO 8601 date-time.
+    #   Omit for the server default (a 1-year default is being rolled out). Pass explicit nil for
+    #   a token that never expires. Past or more-than-5-years-ahead values are rejected with 422
     # @option options [Array<Hash>] :resources Permissions to assign
     #   - `{ resource_type:, resource_id:, access_level: }`
     # @return [ApiToken] Created token (full `token` value populated)
@@ -43,10 +46,17 @@ module Mailtrap
     # The old token stops working after a short grace period. The new `token` value is
     # returned ONLY ONCE — store it securely
     # @param token_id [Integer] The API token ID
+    # @param [Hash] options The reset parameters
+    # @option options [String, nil] :expires_at Optional token expiration as an ISO 8601 date-time.
+    #   Omit for the server default (a 1-year default is being rolled out). Pass explicit nil for
+    #   a token that never expires. Past or more-than-5-years-ahead values are rejected with 422
     # @return [ApiToken] New token (full `token` value populated)
     # @!macro api_errors
-    def reset(token_id)
-      response = client.post("#{base_path}/#{token_id}/reset")
+    # @raise [ArgumentError] If invalid options are provided
+    def reset(token_id, options = {})
+      validate_options!(options, %i[expires_at])
+      # An empty hash must not be sent as a body — the endpoint historically takes no body
+      response = client.post("#{base_path}/#{token_id}/reset", options.empty? ? nil : options)
       handle_response(response)
     end
 

data/lib/mailtrap/email_campaigns_api.rb

@@ -22,8 +22,6 @@ module Mailtrap
 
     self.response_class = EmailCampaign
 
-    attr_reader :client
-
     # @param client [Mailtrap::Client] The client instance
     def initialize(client = Mailtrap::Client.new)
       @client = client

data/lib/mailtrap/inbound_folders_api.rb

@@ -10,7 +10,6 @@ module Mailtrap
     self.supported_options = %i[name]
     self.response_class = InboundFolder
 
-    # Inbound is scoped to the token's account, so no account_id is required.
     # @param client [Mailtrap::Client] The client instance
     def initialize(client = Mailtrap::Client.new)
       @client = client

data/lib/mailtrap/inbound_inboxes_api.rb

@@ -12,7 +12,6 @@ module Mailtrap
     CREATE_OPTIONS = %i[name domain_id].freeze
     UPDATE_OPTIONS = %i[name].freeze
 
-    # Inbound is scoped to the token's account, so no account_id is required.
     # @param client [Mailtrap::Client] The client instance
     def initialize(client = Mailtrap::Client.new)
       @client = client

data/lib/mailtrap/inbound_messages_api.rb

@@ -14,7 +14,6 @@ module Mailtrap
 
     SEND_OPTIONS = %i[from to cc bcc reply_to text html category attachments headers custom_variables].freeze
 
-    # Inbound is scoped to the token's account, so no account_id is required.
     # @param client [Mailtrap::Client] The client instance
     def initialize(client = Mailtrap::Client.new)
       @client = client

data/lib/mailtrap/inbound_threads_api.rb

@@ -12,7 +12,6 @@ module Mailtrap
 
     self.response_class = InboundThread
 
-    # Inbound is scoped to the token's account, so no account_id is required.
     # @param client [Mailtrap::Client] The client instance
     def initialize(client = Mailtrap::Client.new)
       @client = client

data/lib/mailtrap/sandbox_attachments_api.rb

@@ -7,7 +7,7 @@ module Mailtrap
   class SandboxAttachmentsAPI
     include BaseAPI
 
-    attr_reader :account_id, :inbox_id, :sandbox_message_id, :client
+    attr_reader :inbox_id, :sandbox_message_id
 
     self.response_class = SandboxAttachment
 

data/lib/mailtrap/sandbox_messages_api.rb

@@ -7,7 +7,7 @@ module Mailtrap
   class SandboxMessagesAPI
     include BaseAPI
 
-    attr_reader :account_id, :inbox_id, :client
+    attr_reader :inbox_id
 
     self.supported_options = %i[is_read]
 

data/lib/mailtrap/sending_domain.rb

@@ -12,6 +12,7 @@ module Mailtrap
   # @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 tracking_opt_out_enabled [Boolean] Whether the tracking opt-out link 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
@@ -31,6 +32,7 @@ module Mailtrap
     :dns_records,
     :open_tracking_enabled,
     :click_tracking_enabled,
+    :tracking_opt_out_enabled,
     :auto_unsubscribe_link_enabled,
     :custom_domain_tracking_enabled,
     :health_alerts_enabled,

data/lib/mailtrap/sending_domains_api.rb

@@ -7,7 +7,13 @@ module Mailtrap
   class SendingDomainsAPI
     include BaseAPI
 
-    self.supported_options = %i[open_tracking_enabled click_tracking_enabled auto_unsubscribe_link_enabled]
+    self.supported_options = %i[
+      open_tracking_enabled
+      click_tracking_enabled
+      tracking_opt_out_enabled
+      auto_unsubscribe_link_enabled
+      inbound_enabled
+    ]
 
     self.response_class = SendingDomain
 
@@ -50,7 +56,9 @@ module Mailtrap
     # @param [Hash] options The parameters to update
     # @option options [Boolean] :open_tracking_enabled Enable open tracking for emails sent from this domain
     # @option options [Boolean] :click_tracking_enabled Enable click tracking for links in emails sent from this domain
+    # @option options [Boolean] :tracking_opt_out_enabled Enable the tracking opt-out link in tracked emails
     # @option options [Boolean] :auto_unsubscribe_link_enabled Automatically add an unsubscribe link to emails
+    # @option options [Boolean] :inbound_enabled Enable inbound email for this domain
     # @return [SendingDomain] Updated sending domain
     # @!macro api_errors
     # @raise [ArgumentError] If invalid options are provided

data/lib/mailtrap/suppressions_api.rb

@@ -7,6 +7,8 @@ module Mailtrap
   class SuppressionsAPI
     include BaseAPI
 
+    self.supported_options = %i[email domain_id sending_stream type].freeze
+
     self.response_class = Suppression
 
     # Lists all suppressions for the account
@@ -20,12 +22,28 @@ module Mailtrap
       base_list(query_params)
     end
 
+    # Adds an email address to the account's suppression list
+    # @param [Hash] options The suppression attributes
+    # @option options [String] :email Email address to suppress
+    # @option options [Integer] :domain_id ID of the domain to suppress this email for
+    # @option options [String] :sending_stream The sending stream to suppress for: "transactional" or "bulk"
+    # @option options [String] :type Reason for the suppression, defaults to "manual import" when omitted
+    # @return [Suppression] Created suppression
+    # @!macro api_errors
+    # @raise [ArgumentError] If invalid options are provided
+    def create(options)
+      validate_options!(options, supported_options)
+      response = client.post(base_path, options)
+      build_entity(response[:data], Suppression)
+    end
+
     # Deletes a suppression
     # @param suppression_id [String] The suppression UUID
-    # @return nil
+    # @return [Suppression] The deleted suppression
     # @!macro api_errors
     def delete(suppression_id)
-      client.delete("#{base_path}/#{suppression_id}")
+      response = client.delete("#{base_path}/#{suppression_id}")
+      build_entity(response, Suppression)
     end
 
     private

data/lib/mailtrap/tracking_opt_out.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Mailtrap
+  # Data Transfer Object for Tracking Opt-out
+  # @see https://docs.mailtrap.io/developers/management/tracking-opt-outs
+  # @attr_reader id [String] The tracking opt-out UUID
+  # @attr_reader email [String] The email address opted out of tracking
+  # @attr_reader created_at [String] The creation timestamp
+  # @attr_reader domain_name [String, nil] Sending domain the tracking opt-out applies to
+  TrackingOptOut = Struct.new(
+    :id,
+    :email,
+    :created_at,
+    :domain_name,
+    keyword_init: true
+  )
+end

data/lib/mailtrap/tracking_opt_outs_api.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require_relative 'base_api'
+require_relative 'tracking_opt_out'
+require_relative 'tracking_opt_outs_list_response'
+
+module Mailtrap
+  class TrackingOptOutsAPI
+    include BaseAPI
+
+    self.supported_options = %i[email domain_id].freeze
+
+    self.response_class = TrackingOptOut
+
+    # @param client [Mailtrap::Client] The client instance
+    def initialize(client = Mailtrap::Client.new)
+      @client = client
+    end
+
+    # Lists email addresses that have opted out of open and click tracking
+    # @param email [String, nil] Filter by exact email address (case-insensitive)
+    # @param start_time [String, nil] Only opt-outs created at or after this ISO 8601 timestamp
+    # @param end_time [String, nil] Only opt-outs created at or before this ISO 8601 timestamp
+    # @param last_id [String, nil] Cursor from the previous response's +last_id+ for the next page
+    # @return [TrackingOptOutsListResponse] The page of tracking opt-outs and the next cursor
+    # @!macro api_errors
+    def list(email: nil, start_time: nil, end_time: nil, last_id: nil)
+      query_params = {}
+      query_params[:email] = email unless email.nil?
+      query_params[:start_time] = start_time unless start_time.nil?
+      query_params[:end_time] = end_time unless end_time.nil?
+      query_params[:last_id] = last_id unless last_id.nil?
+
+      response = client.get(base_path, query_params)
+
+      TrackingOptOutsListResponse.new(
+        data: Array(response[:data]).map { |item| build_entity(item, TrackingOptOut) },
+        last_id: response[:last_id]
+      )
+    end
+
+    # Adds an email address to the tracking opt-out list for a sending domain
+    # @param [Hash] options The tracking opt-out attributes
+    # @option options [String] :email Email address to opt out of tracking
+    # @option options [Integer] :domain_id ID of the sending domain the opt-out applies to
+    # @return [TrackingOptOut] Created tracking opt-out
+    # @!macro api_errors
+    # @raise [ArgumentError] If invalid options are provided
+    def create(options)
+      validate_options!(options, supported_options)
+      response = client.post(base_path, options)
+      build_entity(response[:data], TrackingOptOut)
+    end
+
+    # Removes an email address from the tracking opt-out list
+    # @param tracking_opt_out_id [String] The tracking opt-out UUID
+    # @return [TrackingOptOut] The deleted tracking opt-out
+    # @!macro api_errors
+    def delete(tracking_opt_out_id)
+      response = client.delete("#{base_path}/#{tracking_opt_out_id}")
+      build_entity(response, TrackingOptOut)
+    end
+
+    private
+
+    def base_path
+      '/api/tracking_opt_outs'
+    end
+  end
+end

data/lib/mailtrap/tracking_opt_outs_list_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Mailtrap
+  # Data Transfer Object for a paginated list of tracking opt-outs
+  # @see https://docs.mailtrap.io/developers/management/tracking-opt-outs
+  # @attr_reader data [Array<TrackingOptOut>] The tracking opt-outs on this page
+  # @attr_reader last_id [String, nil] Cursor for the next page, or nil if this is the last page
+  TrackingOptOutsListResponse = Struct.new(
+    :data,
+    :last_id,
+    keyword_init: true
+  )
+end

data/lib/mailtrap/version.rb

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

data/lib/mailtrap.rb

@@ -18,6 +18,7 @@ require_relative 'mailtrap/contact_imports_api'
 require_relative 'mailtrap/contact_exports_api'
 require_relative 'mailtrap/contact_events_api'
 require_relative 'mailtrap/suppressions_api'
+require_relative 'mailtrap/tracking_opt_outs_api'
 require_relative 'mailtrap/email_campaigns_api'
 require_relative 'mailtrap/sending_domains_api'
 require_relative 'mailtrap/company_info_api'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailtrap
 version: !ruby/object:Gem::Version
-  version: 2.14.0
+  version: 2.16.0
 platform: ruby
 authors:
 - Railsware Products Studio LLC
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-08-17 00:00:00.000000000 Z
+date: 2026-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -117,6 +117,9 @@ files:
 - lib/mailtrap/sub_accounts_api.rb
 - lib/mailtrap/suppression.rb
 - lib/mailtrap/suppressions_api.rb
+- lib/mailtrap/tracking_opt_out.rb
+- lib/mailtrap/tracking_opt_outs_api.rb
+- lib/mailtrap/tracking_opt_outs_list_response.rb
 - lib/mailtrap/version.rb
 - lib/mailtrap/webhook.rb
 - lib/mailtrap/webhooks.rb