Class: Mailtrap::SandboxAttachmentsAPI

Inherits:
Object
  • Object
show all
Includes:
BaseAPI
Defined in:
lib/mailtrap/sandbox_attachments_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from BaseAPI

included

Constructor Details

#initialize(account_id, inbox_id, sandbox_message_id, client = Mailtrap::Client.new) ⇒ SandboxAttachmentsAPI

Returns a new instance of SandboxAttachmentsAPI.

Parameters:

  • account_id (Integer) —

    The account ID

  • inbox_id (Integer) —

    The inbox ID

  • sandbox_message_id (Integer) —

    The message ID

  • client (Mailtrap::Client) (defaults to: Mailtrap::Client.new) —

    The client instance

Raises:

  • (ArgumentError) —

    If account_id is nil

  • (ArgumentError) —

    If inbox_id is nil



20
21
22
23
24
25
26
27
28
 
# File 'lib/mailtrap/sandbox_attachments_api.rb', line 20

def initialize(, 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(, client)
end

Instance Attribute Details

#account_id ⇒ Object (readonly)

Returns the value of attribute account_id.



10
11
12
 
# File 'lib/mailtrap/sandbox_attachments_api.rb', line 10

def 
  @account_id
end

#client ⇒ Object (readonly)

Returns the value of attribute client.



10
11
12
 
# File 'lib/mailtrap/sandbox_attachments_api.rb', line 10

def client
  @client
end

#inbox_id ⇒ Object (readonly)

Returns the value of attribute inbox_id.



10
11
12
 
# File 'lib/mailtrap/sandbox_attachments_api.rb', line 10

def inbox_id
  @inbox_id
end

#sandbox_message_id ⇒ Object (readonly)

Returns the value of attribute sandbox_message_id.



10
11
12
 
# File 'lib/mailtrap/sandbox_attachments_api.rb', line 10

def sandbox_message_id
  @sandbox_message_id
end

Instance Method Details

#get(sandbox_attachment_id) ⇒ SandboxAttachment

Retrieves a specific sandbox attachment

Parameters:

  • sandbox_attachment_id (Integer) —

    The sandbox attachment ID

Returns:

Raises:



34
35
36
 
# File 'lib/mailtrap/sandbox_attachments_api.rb', line 34

def get(sandbox_attachment_id)
  base_get(sandbox_attachment_id)
end

#list ⇒ Array<SandboxAttachment>

Lists all sandbox attachments for a message, limited up to 30 at once

Returns:

Raises:



41
42
43
 
# File 'lib/mailtrap/sandbox_attachments_api.rb', line 41

def list
  base_list
end