Package io.mailtrap.api.messages

Interface Messages

All Known Implementing Classes:
MessagesImpl
public interface Messages
Interface representing the Mailtrap Testing API for interaction with email messages

  • Method Details

    • getMessage

      MessageResponse getMessage(long accountId, long inboxId, long messageId)
      Get email message by ID
      Parameters:
      accountId - unique account ID
      inboxId - unique inbox ID
      messageId - unique message ID
      Returns:
      email message with its attributes

    • updateMessage

      MessageResponse updateMessage(long accountId, long inboxId, long messageId, UpdateMessageRequest request)
      Update message attributes
      Parameters:
      accountId - unique account ID
      inboxId - unique inbox ID
      messageId - unique message ID
      request - attributes to update
      Returns:
      email message with its updated attributes

    • deleteMessage

      MessageResponse deleteMessage(long accountId, long inboxId, long messageId)
      Delete message from inbox
      Parameters:
      accountId - unique account ID
      inboxId - unique inbox ID
      messageId - unique message ID
      Returns:
      attributes of the deleted message

    • getMessages

      List<MessageResponse> getMessages(long accountId, long inboxId, ListMessagesQueryParams queryParams)
      Parameters:
      accountId - unique account ID
      inboxId - unique inbox ID
      queryParams - additional query parameters
      Returns:
      list of messages

    • forwardMessage

      ForwardMessageResponse forwardMessage(long accountId, long inboxId, long messageId, ForwardMessageRequest request)
      Forward message to an email address. The email address must be confirmed by the recipient in advance
      Parameters:
      accountId - unique account ID
      inboxId - unique inbox ID
      messageId - unique message ID
      request - email where to forward message
      Returns:
      confirmation about forwarding

    • getSpamScore

      MessageSpamScoreResponse getSpamScore(long accountId, long inboxId, long messageId)
      Get a brief spam report by message ID
      Parameters:
      accountId - unique account ID
      inboxId - unique inbox ID
      messageId - unique message ID
      Returns:
      message spam analysis report

    • getMessageHtmlAnalysis

      MessageHtmlAnalysisResponse getMessageHtmlAnalysis(long accountId, long inboxId, long messageId)
      Get a brief HTML report by message ID
      Parameters:
      accountId - unique account ID
      inboxId - unique inbox ID
      messageId - unique message ID
      Returns:
      message HTML analysis report

    • getTextMessage

      String getTextMessage(long accountId, long inboxId, long messageId)
      Get text email body, if it exists
      Parameters:
      accountId - unique account ID
      inboxId - unique inbox ID
      messageId - unique message ID
      Returns:
      message body in txt format

    • getRawMessage

      String getRawMessage(long accountId, long inboxId, long messageId)
      Get raw email body
      Parameters:
      accountId - unique account ID
      inboxId - unique inbox ID
      messageId - unique message ID
      Returns:
      raw message body

    • getMessageSource

      String getMessageSource(long accountId, long inboxId, long messageId)
      Get HTML source of email
      Parameters:
      accountId - unique account ID
      inboxId - unique inbox ID
      messageId - unique message ID
      Returns:
      HTML source of a message

    • getHtmlMessage

      String getHtmlMessage(long accountId, long inboxId, long messageId)
      Get formatted HTML email body. Not applicable for plain text emails
      Parameters:
      accountId - unique account ID
      inboxId - unique inbox ID
      messageId - unique message ID
      Returns:
      message body in html format

    • getMessageAsEml

      String getMessageAsEml(long accountId, long inboxId, long messageId)
      Get email message in .eml format
      Parameters:
      accountId - unique account ID
      inboxId - unique inbox ID
      messageId - unique message ID
      Returns:
      .eml of the message

    • getMailHeaders

      MessageHeadersResponse getMailHeaders(long accountId, long inboxId, long messageId)
      Get mail headers of a message
      Parameters:
      accountId - unique account ID
      inboxId - unique inbox ID
      messageId - unique message ID
      Returns:
      mail headers of the message