Package io.mailtrap.api.messages
Class MessagesImpl
java.lang.Object
io.mailtrap.api.apiresource.ApiResource
io.mailtrap.api.messages.MessagesImpl
- All Implemented Interfaces:
Messages
-
Field Summary
Fields inherited from class io.mailtrap.api.apiresource.ApiResource
apiHost, httpClient, token
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiondeleteMessage
(long accountId, long inboxId, long messageId) Delete message from inboxforwardMessage
(long accountId, long inboxId, long messageId, ForwardMessageRequest request) Forward message to an email address.getHtmlMessage
(long accountId, long inboxId, long messageId) Get formatted HTML email body.getMailHeaders
(long accountId, long inboxId, long messageId) Get mail headers of a messagegetMessage
(long accountId, long inboxId, long messageId) Get email message by IDgetMessageAsEml
(long accountId, long inboxId, long messageId) Get email message in .eml formatgetMessageHtmlAnalysis
(long accountId, long inboxId, long messageId) Get a brief HTML report by message IDgetMessages
(long accountId, long inboxId, @NonNull ListMessagesQueryParams listMessagesQueryParams) getMessageSource
(long accountId, long inboxId, long messageId) Get HTML source of emailgetRawMessage
(long accountId, long inboxId, long messageId) Get raw email bodygetSpamScore
(long accountId, long inboxId, long messageId) Get a brief spam report by message IDgetTextMessage
(long accountId, long inboxId, long messageId) Get text email body, if it existsupdateMessage
(long accountId, long inboxId, long messageId, UpdateMessageRequest request) Update message attributes
-
Constructor Details
-
MessagesImpl
-
-
Method Details
-
getMessage
Description copied from interface:Messages
Get email message by ID- Specified by:
getMessage
in interfaceMessages
- Parameters:
accountId
- unique account IDinboxId
- unique inbox IDmessageId
- unique message ID- Returns:
- email message with its attributes
-
updateMessage
public MessageResponse updateMessage(long accountId, long inboxId, long messageId, UpdateMessageRequest request) Description copied from interface:Messages
Update message attributes- Specified by:
updateMessage
in interfaceMessages
- Parameters:
accountId
- unique account IDinboxId
- unique inbox IDmessageId
- unique message IDrequest
- attributes to update- Returns:
- email message with its updated attributes
-
deleteMessage
Description copied from interface:Messages
Delete message from inbox- Specified by:
deleteMessage
in interfaceMessages
- Parameters:
accountId
- unique account IDinboxId
- unique inbox IDmessageId
- unique message ID- Returns:
- attributes of the deleted message
-
getMessages
public List<MessageResponse> getMessages(long accountId, long inboxId, @NonNull @NonNull ListMessagesQueryParams listMessagesQueryParams) - Specified by:
getMessages
in interfaceMessages
- Parameters:
accountId
- unique account IDinboxId
- unique inbox IDlistMessagesQueryParams
- additional query parameters- Returns:
- list of messages
-
forwardMessage
public ForwardMessageResponse forwardMessage(long accountId, long inboxId, long messageId, ForwardMessageRequest request) Description copied from interface:Messages
Forward message to an email address. The email address must be confirmed by the recipient in advance- Specified by:
forwardMessage
in interfaceMessages
- Parameters:
accountId
- unique account IDinboxId
- unique inbox IDmessageId
- unique message IDrequest
- email where to forward message- Returns:
- confirmation about forwarding
-
getSpamScore
Description copied from interface:Messages
Get a brief spam report by message ID- Specified by:
getSpamScore
in interfaceMessages
- Parameters:
accountId
- unique account IDinboxId
- unique inbox IDmessageId
- unique message ID- Returns:
- message spam analysis report
-
getMessageHtmlAnalysis
public MessageHtmlAnalysisResponse getMessageHtmlAnalysis(long accountId, long inboxId, long messageId) Description copied from interface:Messages
Get a brief HTML report by message ID- Specified by:
getMessageHtmlAnalysis
in interfaceMessages
- Parameters:
accountId
- unique account IDinboxId
- unique inbox IDmessageId
- unique message ID- Returns:
- message HTML analysis report
-
getTextMessage
Description copied from interface:Messages
Get text email body, if it exists- Specified by:
getTextMessage
in interfaceMessages
- Parameters:
accountId
- unique account IDinboxId
- unique inbox IDmessageId
- unique message ID- Returns:
- message body in txt format
-
getRawMessage
Description copied from interface:Messages
Get raw email body- Specified by:
getRawMessage
in interfaceMessages
- Parameters:
accountId
- unique account IDinboxId
- unique inbox IDmessageId
- unique message ID- Returns:
- raw message body
-
getMessageSource
Description copied from interface:Messages
Get HTML source of email- Specified by:
getMessageSource
in interfaceMessages
- Parameters:
accountId
- unique account IDinboxId
- unique inbox IDmessageId
- unique message ID- Returns:
- HTML source of a message
-
getHtmlMessage
Description copied from interface:Messages
Get formatted HTML email body. Not applicable for plain text emails- Specified by:
getHtmlMessage
in interfaceMessages
- Parameters:
accountId
- unique account IDinboxId
- unique inbox IDmessageId
- unique message ID- Returns:
- message body in html format
-
getMessageAsEml
Description copied from interface:Messages
Get email message in .eml format- Specified by:
getMessageAsEml
in interfaceMessages
- Parameters:
accountId
- unique account IDinboxId
- unique inbox IDmessageId
- unique message ID- Returns:
- .eml of the message
-
getMailHeaders
Description copied from interface:Messages
Get mail headers of a message- Specified by:
getMailHeaders
in interfaceMessages
- Parameters:
accountId
- unique account IDinboxId
- unique inbox IDmessageId
- unique message ID- Returns:
- mail headers of the message
-