Class InboxesImpl

All Implemented Interfaces:
Inboxes

public class InboxesImpl extends ApiResourceWithValidation implements Inboxes
  • Constructor Details

  • Method Details

    • createInbox

      public InboxResponse createInbox(long accountId, long projectId, CreateInboxRequest request)
      Description copied from interface: Inboxes
      Create an inbox in a project
      Specified by:
      createInbox in interface Inboxes
      Parameters:
      accountId - unique account ID
      projectId - unique project ID
      request - inbox request data
      Returns:
      the newly created inbox with its attributes
    • getInboxAttributes

      public InboxResponse getInboxAttributes(long accountId, long inboxId)
      Description copied from interface: Inboxes
      Get inbox attributes by inbox ID
      Specified by:
      getInboxAttributes in interface Inboxes
      Parameters:
      accountId - unique account ID
      inboxId - unique inbox ID
      Returns:
      the attributes of the inbox
    • deleteInbox

      public InboxResponse deleteInbox(long accountId, long inboxId)
      Description copied from interface: Inboxes
      Delete an inbox with all its emails
      Specified by:
      deleteInbox in interface Inboxes
      Parameters:
      accountId - unique account ID
      inboxId - unique inbox ID
      Returns:
      the attributes of the deleted inbox
    • updateInbox

      public InboxResponse updateInbox(long accountId, long inboxId, UpdateInboxRequest request)
      Description copied from interface: Inboxes
      Update inbox name, inbox email username
      Specified by:
      updateInbox in interface Inboxes
      Parameters:
      accountId - unique account ID
      inboxId - unique inbox ID
      request - request data
      Returns:
      the attributes of the updated inbox
    • cleanInbox

      public InboxResponse cleanInbox(long accountId, long inboxId)
      Description copied from interface: Inboxes
      Delete all messages (emails) from inbox
      Specified by:
      cleanInbox in interface Inboxes
      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

      public InboxResponse markAsRead(long accountId, long inboxId)
      Description copied from interface: Inboxes
      Mark all messages in the inbox as read
      Specified by:
      markAsRead in interface Inboxes
      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

      public InboxResponse resetCredentials(long accountId, long inboxId)
      Description copied from interface: Inboxes
      Reset SMTP credentials of the inbox
      Specified by:
      resetCredentials in interface Inboxes
      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

      public InboxResponse enableEmailAddress(long accountId, long inboxId)
      Description copied from interface: Inboxes
      Turn the email address of the inbox on/off
      Specified by:
      enableEmailAddress in interface Inboxes
      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

      public InboxResponse resetEmailAddresses(long accountId, long inboxId)
      Description copied from interface: Inboxes
      Reset username of email address per inbox
      Specified by:
      resetEmailAddresses in interface Inboxes
      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

      public List<InboxResponse> getInboxes(long accountId)
      Description copied from interface: Inboxes
      Get a list of inboxes
      Specified by:
      getInboxes in interface 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