Package io.mailtrap.api.messages

Class MessagesImpl

java.lang.Object

io.mailtrap.api.apiresource.ApiResource

io.mailtrap.api.messages.MessagesImpl

All Implemented Interfaces:

Messages

public class MessagesImpl
extends ApiResource
implements Messages

Field Summary

Fields inherited from class io.mailtrap.api.apiresource.ApiResource

apiHost, httpClient, token

Constructor Summary

Constructors

Constructor	Description
MessagesImpl(MailtrapConfig config)

Method Summary

Modifier and Type	Method	Description
MessageResponse	deleteMessage(long accountId, long inboxId, long messageId)	Delete message from inbox
ForwardMessageResponse	forwardMessage(long accountId, long inboxId, long messageId, ForwardMessageRequest request)	Forward message to an email address.
String	getHtmlMessage(long accountId, long inboxId, long messageId)	Get formatted HTML email body.
MessageHeadersResponse	getMailHeaders(long accountId, long inboxId, long messageId)	Get mail headers of a message
MessageResponse	getMessage(long accountId, long inboxId, long messageId)	Get email message by ID
String	getMessageAsEml(long accountId, long inboxId, long messageId)	Get email message in .eml format
MessageHtmlAnalysisResponse	getMessageHtmlAnalysis(long accountId, long inboxId, long messageId)	Get a brief HTML report by message ID
List<MessageResponse>	getMessages(long accountId, long inboxId, @NonNull ListMessagesQueryParams listMessagesQueryParams)
String	getMessageSource(long accountId, long inboxId, long messageId)	Get HTML source of email
String	getRawMessage(long accountId, long inboxId, long messageId)	Get raw email body
MessageSpamScoreResponse	getSpamScore(long accountId, long inboxId, long messageId)	Get a brief spam report by message ID
String	getTextMessage(long accountId, long inboxId, long messageId)	Get text email body, if it exists
MessageResponse	updateMessage(long accountId, long inboxId, long messageId, UpdateMessageRequest request)	Update message attributes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MessagesImpl

public MessagesImpl(MailtrapConfig config)

Method Details

getMessage

public MessageResponse getMessage(long accountId,
 long inboxId,
 long messageId)

Description copied from interface: Messages

Get email message by ID

Specified by:

getMessage in interface Messages

Parameters:

accountId - unique account ID

inboxId - unique inbox ID

messageId - 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 interface Messages

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

public MessageResponse deleteMessage(long accountId,
 long inboxId,
 long messageId)

Description copied from interface: Messages

Delete message from inbox

Specified by:

deleteMessage in interface Messages

Parameters:

accountId - unique account ID

inboxId - unique inbox ID

messageId - 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 interface Messages

Parameters:

accountId - unique account ID

inboxId - unique inbox ID

listMessagesQueryParams - 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 interface Messages

Parameters:

accountId - unique account ID

inboxId - unique inbox ID

messageId - unique message ID

request - email where to forward message

Returns:

confirmation about forwarding

getSpamScore

public MessageSpamScoreResponse getSpamScore(long accountId,
 long inboxId,
 long messageId)

Description copied from interface: Messages

Get a brief spam report by message ID

Specified by:

getSpamScore in interface Messages

Parameters:

accountId - unique account ID

inboxId - unique inbox ID

messageId - 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 interface Messages

Parameters:

accountId - unique account ID

inboxId - unique inbox ID

messageId - unique message ID

Returns:

message HTML analysis report

getTextMessage

public String getTextMessage(long accountId,
 long inboxId,
 long messageId)

Description copied from interface: Messages

Get text email body, if it exists

Specified by:

getTextMessage in interface Messages

Parameters:

accountId - unique account ID

inboxId - unique inbox ID

messageId - unique message ID

Returns:

message body in txt format

getRawMessage

public String getRawMessage(long accountId,
 long inboxId,
 long messageId)

Description copied from interface: Messages

Get raw email body

Specified by:

getRawMessage in interface Messages

Parameters:

accountId - unique account ID

inboxId - unique inbox ID

messageId - unique message ID

Returns:

raw message body

getMessageSource

public String getMessageSource(long accountId,
 long inboxId,
 long messageId)

Description copied from interface: Messages

Get HTML source of email

Specified by:

getMessageSource in interface Messages

Parameters:

accountId - unique account ID

inboxId - unique inbox ID

messageId - unique message ID

Returns:

HTML source of a message

getHtmlMessage

public String getHtmlMessage(long accountId,
 long inboxId,
 long messageId)

Description copied from interface: Messages

Get formatted HTML email body. Not applicable for plain text emails

Specified by:

getHtmlMessage in interface Messages

Parameters:

accountId - unique account ID

inboxId - unique inbox ID

messageId - unique message ID

Returns:

message body in html format

getMessageAsEml

public String getMessageAsEml(long accountId,
 long inboxId,
 long messageId)

Description copied from interface: Messages

Get email message in .eml format

Specified by:

getMessageAsEml in interface Messages

Parameters:

accountId - unique account ID

inboxId - unique inbox ID

messageId - unique message ID

Returns:

.eml of the message

getMailHeaders

public MessageHeadersResponse getMailHeaders(long accountId,
 long inboxId,
 long messageId)

Description copied from interface: Messages

Get mail headers of a message

Specified by:

getMailHeaders in interface Messages

Parameters:

accountId - unique account ID

inboxId - unique inbox ID

messageId - unique message ID

Returns:

mail headers of the message