Add Inboxes API

README.md

@@ -115,6 +115,7 @@ Refer to the [`examples`](examples) folder for more examples:
 - [ActionMailer](examples/action_mailer.rb)
 - [Email Templates API](examples/email_templates_api.rb)
 - [Projects API](examples/projects_api.rb)
+- [Inboxes API](examples/inboxes_api.rb)
 
 ### Content-Transfer-Encoding
 

examples/inboxes_api.rb

@@ -0,0 +1,33 @@
+require 'mailtrap'
+
+account_id = 3229
+client = Mailtrap::Client.new(api_key: 'your-api-key')
+inboxes = Mailtrap::InboxesAPI.new(account_id, client)
+
+# Create new Inbox
+list = inboxes.create(name: 'Test Inbox', project_id: 123_456)
+# => #<struct Mailtrap::Inbox id=1, name="Test Inbox">
+
+# Get all Inboxes
+inboxes.list
+# => [#<struct Mailtrap::Inbox id=1, name="Test Inbox">]
+
+# Update contact list
+inboxes.update(list.id, name: 'Test List Updated')
+# => #<struct Mailtrap::Inbox id=1, name="Test Inbox Updated">
+
+# Get contact list
+inbox = inboxes.get(list.id)
+# => #<struct Mailtrap::Inbox id=1, name="Test Inbox Updated">
+
+# Delete all messages (emails) from Inbox
+inboxes.clean(inbox.id)
+
+# Mark all messages in the inbox as read
+inboxes.mark_as_read(inbox.id)
+
+# Reset SMTP credentials of the inbox
+inboxes.reset_credentials(inbox.id)
+
+# Delete contact list
+inboxes.delete(inbox.id)

lib/mailtrap.rb

@@ -11,6 +11,7 @@
 require_relative 'mailtrap/contact_imports_api'
 require_relative 'mailtrap/suppressions_api'
 require_relative 'mailtrap/projects_api'
+require_relative 'mailtrap/inboxes_api'
 
 module Mailtrap
   # @!macro api_errors

lib/mailtrap/inboxes_api.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require_relative 'base_api'
+require_relative 'inbox'
+
+module Mailtrap
+  class InboxesAPI
+    include BaseAPI
+
+    self.supported_options = %i[name email_username project_id]
+    self.response_class = Inbox
+
+    # Lists all Inboxes for the account
+    # @return [Array<Inbox>] Array of Inboxes
+    # @!macro api_errors
+    def list
+      base_list
+    end
+
+    # Retrieves a specific inbox
+    # @param inbox_id [Integer] The inbox identifier
+    # @return [Inbox] Inbox object
+    # @!macro api_errors
+    def get(inbox_id)
+      base_get(inbox_id)
+    end
+
+    # Creates a new inbox
+    # @param [Hash] options The parameters to create
+    # @option options [String] :name The inbox name
+    # @return [Inbox] Created inbox object
+    # @!macro api_errors
+    # @raise [ArgumentError] If invalid options are provided
+    def create(options)
+      validate_options!(options, supported_options)
+      response = client.post("/api/accounts/#{account_id}/projects/#{options[:project_id]}/inboxes",
+                             wrap_request(options))
+      handle_response(response)
+    end
+
+    # Deletes an inbox
+    # @param inbox_id [Integer] The Inbox identifier
+    # @return nil
+    # @!macro api_errors
+    def delete(inbox_id)
+      base_delete(inbox_id)
+    end
+
+    # Updates an existing Inbox
+    # @param inbox_id [Integer] The Inbox identifier
+    # @param [Hash] options The parameters to update
+    # @option options [String] :name The inbox name
+    # @option options [String] :email_username The inbox email username
+    # @return [Inbox] Updated Inbox object
+    # @!macro api_errors
+    # @raise [ArgumentError] If invalid options are provided
+    def update(inbox_id, options)
+      base_update(inbox_id, options)
+    end
+
+    # Delete all messages (emails) from Inbox
+    # @param inbox_id [Integer] The Inbox identifier
+    # @return [Inbox] Updated Inbox object
+    # @!macro api_errors
+    def clean(inbox_id)
+      response = client.patch("#{base_path}/#{inbox_id}/clean")
+      handle_response(response)
+    end
+
+    # Mark all messages in the inbox as read
+    # @param inbox_id [Integer] The Inbox identifier
+    # @return [Inbox] Updated Inbox object
+    # @!macro api_errors
+    def mark_as_read(inbox_id)
+      response = client.patch("#{base_path}/#{inbox_id}/all_read")
+      handle_response(response)
+    end
+
+    # Reset SMTP credentials of the inbox
+    # @param inbox_id [Integer] The Inbox identifier
+    # @return [Inbox] Updated Inbox object
+    # @!macro api_errors
+    def reset_credentials(inbox_id)
+      response = client.patch("#{base_path}/#{inbox_id}/reset_credentials")
+      handle_response(response)
+    end
+
+    private
+
+    def wrap_request(options)
+      { inbox: options }
+    end
+
+    def base_path
+      "/api/accounts/#{account_id}/inboxes"
+    end
+  end
+end