Package io.mailtrap.api.inboxes

Interface Inboxes

All Known Implementing Classes:
InboxesImpl
public interface Inboxes
Interface representing the Mailtrap Testing API for interaction with inboxes

  • Method Details

    • createInbox

      InboxResponse createInbox(long accountId, long projectId, CreateInboxRequest request)
      Create an inbox in a project
      Parameters:
      accountId - unique account ID
      projectId - unique project ID
      request - inbox request data
      Returns:
      the newly created inbox with its attributes

    • getInboxAttributes

      InboxResponse getInboxAttributes(long accountId, long inboxId)
      Get inbox attributes by inbox ID
      Parameters:
      accountId - unique account ID
      inboxId - unique inbox ID
      Returns:
      the attributes of the inbox

    • deleteInbox

      InboxResponse deleteInbox(long accountId, long inboxId)
      Delete an inbox with all its emails
      Parameters:
      accountId - unique account ID
      inboxId - unique inbox ID
      Returns:
      the attributes of the deleted inbox

    • updateInbox

      InboxResponse updateInbox(long accountId, long inboxId, UpdateInboxRequest request)
      Update inbox name, inbox email username
      Parameters:
      accountId - unique account ID
      inboxId - unique inbox ID
      request - request data
      Returns:
      the attributes of the updated inbox

    • cleanInbox

      InboxResponse cleanInbox(long accountId, long inboxId)
      Delete all messages (emails) from inbox
      Parameters:
      accountId - unique account ID
      inboxId - unique inbox ID
      Returns:
      the attributes of the inbox. permissions returns the permissions of the token for the inbox.

    • markAsRead

      InboxResponse markAsRead(long accountId, long inboxId)
      Mark all messages in the inbox as read
      Parameters:
      accountId - unique account ID
      inboxId - unique inbox ID
      Returns:
      the attributes of the inbox. permissions returns the permissions of the token for the inbox

    • resetCredentials

      InboxResponse resetCredentials(long accountId, long inboxId)
      Reset SMTP credentials of the inbox
      Parameters:
      accountId - unique account ID
      inboxId - unique inbox ID
      Returns:
      the attributes of the inbox. permissions returns the permissions of the token for the inbox

    • enableEmailAddress

      InboxResponse enableEmailAddress(long accountId, long inboxId)
      Turn the email address of the inbox on/off
      Parameters:
      accountId - unique account ID
      inboxId - unique inbox ID
      Returns:
      the attributes of the inbox. permissions returns the permissions of the token for the inbox

    • resetEmailAddresses

      InboxResponse resetEmailAddresses(long accountId, long inboxId)
      Reset username of email address per inbox
      Parameters:
      accountId - unique account ID
      inboxId - unique inbox ID
      Returns:
      the attributes of the inbox. permissions returns the permissions of the token for the inbox

    • getInboxes

      List<InboxResponse> getInboxes(long accountId)
      Get a list of inboxes
      Parameters:
      accountId - unique account ID
      Returns:
      the list of inboxes in the account to which the API token has access. permissions returns the permissions of the token for the inbox