Interface MailpitClient

@Client(id="mailpit",
        errorType=String.class)
public interface MailpitClient

Declarative HTTP client for the Mailpit API v1.

Since:

3.1.0

See Also:

• Mailpit API V1.

Method Summary

Modifier and Type	Method	Description
String	deleteMessages(MailpitDeleteMessagesRequest request)	Deletes messages.
String	deleteSearch(String query, @Nullable String timezone)	Deletes messages matching a search.
String	deleteTag(String tag)	Deletes a tag from all messages.
MailpitChaosTriggers	getChaos()	Gets current chaos trigger settings.
MailpitAppInformation	getInfo()	Gets application information and mailbox totals.
MailpitMessage	getMessage(String id)	Gets a message and marks it read.
Map<String, List<String>>	getMessageHeaders(String id)	Gets message headers.
io.micronaut.http.HttpResponse<byte[]>	getMessagePart(String id, String partId)	Gets a message attachment or inline part.
io.micronaut.http.HttpResponse<byte[]>	getMessagePartThumbnail(String id, String partId)	Gets an attachment image thumbnail.
String	getRawMessage(String id)	Gets a message's raw source.
List<String>	getTags()	Gets all current tags.
MailpitWebUiConfiguration	getWebUiConfiguration()	Gets web UI configuration.
MailpitHtmlCheckResponse	htmlCheck(String id)	Runs Mailpit's HTML compatibility check for a message.
MailpitLinkCheckResponse	linkCheck(String id, @Nullable Boolean follow)	Runs Mailpit's link check for a message.
MailpitMessagesSummary	listMessages(@Nullable Integer start, @Nullable Integer limit)	Lists mailbox messages from newest to oldest.
String	releaseMessage(String id, MailpitReleaseMessageRequest request)	Releases a message through Mailpit's configured SMTP relay.
String	renameTag(String tag, MailpitRenameTagRequest request)	Renames a tag.
String	renderHtml(String id, @Nullable String embed)	Renders the message HTML part.
String	renderText(String id)	Renders the message text part.
MailpitMessagesSummary	search(String query, @Nullable Integer start, @Nullable Integer limit, @Nullable String timezone)	Searches messages.
MailpitSendResponse	send(MailpitSendRequest request)	Sends a message through Mailpit's HTTP send API.
MailpitChaosTriggers	setChaos(MailpitChaosTriggers triggers)	Sets current chaos trigger settings.
String	setMessageTags(MailpitSetTagsRequest request)	Sets tags for messages.
String	setReadStatus(MailpitSetReadStatusRequest request)	Sets read status for messages without a timezone query parameter.
String	setReadStatus(MailpitSetReadStatusRequest request, @Nullable String timezone)	Sets read status for messages.
MailpitSpamAssassinResponse	spamAssassinCheck(String id)	Runs SpamAssassin check for a message.

Method Details

getInfo

@Get("/api/v1/info")
MailpitAppInformation getInfo()

Gets application information and mailbox totals.

Returns:

Application information.

See Also:

• Get application information.

getWebUiConfiguration

@Get("/api/v1/webui")
MailpitWebUiConfiguration getWebUiConfiguration()

Gets web UI configuration.

Returns:

Web UI configuration.

See Also:

• Get web UI configuration.

getChaos

@Get("/api/v1/chaos")
MailpitChaosTriggers getChaos()

Gets current chaos trigger settings.

Returns:

Chaos trigger settings.

See Also:

• Get Chaos triggers.

setChaos

@Put("/api/v1/chaos")
MailpitChaosTriggers setChaos(@Body
 MailpitChaosTriggers triggers)

Sets current chaos trigger settings.

Parameters:

triggers - Chaos trigger settings.

Returns:

Updated chaos trigger settings.

See Also:

• Set Chaos triggers.

listMessages

@Get("/api/v1/messages")
MailpitMessagesSummary listMessages(@QueryValue("start")
 @Nullable Integer start,
 @QueryValue("limit")
 @Nullable Integer limit)

Lists mailbox messages from newest to oldest.

Parameters:

start - Pagination offset.

limit - Maximum number of messages.

Returns:

Message summaries.

See Also:

• List messages.

setReadStatus

@Consumes("text/plain")
@Put("/api/v1/messages")
String setReadStatus(@Body
 MailpitSetReadStatusRequest request)

Sets read status for messages without a timezone query parameter.

Parameters:

request - Read status request.

Returns:

Plain text response.

See Also:

• Set read status.

setReadStatus

@Consumes("text/plain")
@Put("/api/v1/messages")
String setReadStatus(@Body
 MailpitSetReadStatusRequest request,
 @QueryValue("tz")
 @Nullable String timezone)

Sets read status for messages.

Parameters:

request - Read status request.

timezone - Optional timezone identifier for search date filters.

Returns:

Plain text response.

See Also:

• Set read status.

deleteMessages

@Consumes("text/plain")
@Delete("/api/v1/messages")
String deleteMessages(@Body
 MailpitDeleteMessagesRequest request)

Deletes messages.

Parameters:

request - Delete messages request.

Returns:

Plain text response.

See Also:

• Delete messages.

search

@Get("/api/v1/search")
MailpitMessagesSummary search(@QueryValue("query")
 String query,
 @QueryValue("start")
 @Nullable Integer start,
 @QueryValue("limit")
 @Nullable Integer limit,
 @QueryValue("tz")
 @Nullable String timezone)

Searches messages.

Parameters:

query - Search query.

start - Pagination offset.

limit - Maximum number of messages.

timezone - Optional timezone identifier for date filters.

Returns:

Message summaries.

See Also:

• Search messages.

deleteSearch

@Consumes("text/plain")
@Delete("/api/v1/search")
String deleteSearch(@QueryValue("query")
 String query,
 @QueryValue("tz")
 @Nullable String timezone)

Deletes messages matching a search.

Parameters:

query - Search query.

timezone - Optional timezone identifier for date filters.

Returns:

Plain text response.

See Also:

• Delete messages by search.

getMessage

@Get("/api/v1/message/{id}")
MailpitMessage getMessage(@PathVariable("id")
 String id)

Gets a message and marks it read.

Parameters:

id - Message database ID or latest.

Returns:

Message.

See Also:

• Get message summary.

getMessageHeaders

@Get("/api/v1/message/{id}/headers")
Map<String, List<String>> getMessageHeaders(@PathVariable("id")
 String id)

Gets message headers.

Parameters:

id - Message database ID or latest.

Returns:

Message headers.

See Also:

• Get message headers.

getMessagePart

@Get("/api/v1/message/{id}/part/{partId}")
io.micronaut.http.HttpResponse<byte[]> getMessagePart(@PathVariable("id")
 String id,
 @PathVariable("partId")
 String partId)

Gets a message attachment or inline part.

Parameters:

id - Message database ID or latest.

partId - Attachment part ID.

Returns:

Binary part response.

See Also:

• Get message attachment.

getMessagePartThumbnail

@Get("/api/v1/message/{id}/part/{partId}/thumb")
io.micronaut.http.HttpResponse<byte[]> getMessagePartThumbnail(@PathVariable("id")
 String id,
 @PathVariable("partId")
 String partId)

Gets an attachment image thumbnail.

Parameters:

id - Message database ID or latest.

partId - Attachment part ID.

Returns:

Binary thumbnail response.

See Also:

• Get an attachment image thumbnail.

getRawMessage

@Consumes("text/plain")
@Get("/api/v1/message/{id}/raw")
String getRawMessage(@PathVariable("id")
 String id)

Gets a message's raw source.

Parameters:

id - Message database ID or latest.

Returns:

Raw message source.

See Also:

• Get message source.

releaseMessage

@Consumes("text/plain")
@Post("/api/v1/message/{id}/release")
String releaseMessage(@PathVariable("id")
 String id,
 @Body
 MailpitReleaseMessageRequest request)

Releases a message through Mailpit's configured SMTP relay.

Parameters:

id - Message database ID or latest.

request - Release message request.

Returns:

Plain text response.

See Also:

• Release message.

htmlCheck

@Get("/api/v1/message/{id}/html-check")
MailpitHtmlCheckResponse htmlCheck(@PathVariable("id")
 String id)

Runs Mailpit's HTML compatibility check for a message.

Parameters:

id - Message database ID or latest.

Returns:

HTML check response.

See Also:

• HTML check.

linkCheck

@Get("/api/v1/message/{id}/link-check")
MailpitLinkCheckResponse linkCheck(@PathVariable("id")
 String id,
 @QueryValue("follow")
 @Nullable Boolean follow)

Runs Mailpit's link check for a message.

Parameters:

id - Message database ID or latest.

follow - Whether redirects should be followed.

Returns:

Link check response.

See Also:

• Link check.

spamAssassinCheck

@Get("/api/v1/message/{id}/sa-check")
MailpitSpamAssassinResponse spamAssassinCheck(@PathVariable("id")
 String id)

Runs SpamAssassin check for a message.

Parameters:

id - Message database ID or latest.

Returns:

SpamAssassin response.

See Also:

• SpamAssassin check.

send

@Consumes("text/plain")
@Post("/api/v1/send")
MailpitSendResponse send(@Body
 MailpitSendRequest request)

Sends a message through Mailpit's HTTP send API.

Parameters:

request - Send request.

Returns:

Send response.

See Also:

• Send a message.

getTags

@Get("/api/v1/tags")
List<String> getTags()

Gets all current tags.

Returns:

Tag names.

See Also:

• Get all current tags.

setMessageTags

@Consumes("text/plain")
@Put("/api/v1/tags")
String setMessageTags(@Body
 MailpitSetTagsRequest request)

Sets tags for messages.

Parameters:

request - Set tags request.

Returns:

Plain text response.

See Also:

• Set message tags.

renameTag

@Consumes("text/plain")
@Put("/api/v1/tags/{tag}")
String renameTag(@PathVariable("tag")
 String tag,
 @Body
 MailpitRenameTagRequest request)

Renames a tag.

Parameters:

tag - Current tag name.

request - Rename request.

Returns:

Plain text response.

See Also:

• Rename a tag.

deleteTag

@Consumes("text/plain")
@Delete("/api/v1/tags/{tag}")
String deleteTag(@PathVariable("tag")
 String tag)

Deletes a tag from all messages.

Parameters:

tag - Tag name.

Returns:

Plain text response.

See Also:

• Delete a tag.

renderHtml

@Consumes("text/html")
@Get("/view/{id}.html")
String renderHtml(@PathVariable("id")
 String id,
 @QueryValue("embed")
 @Nullable String embed)

Renders the message HTML part.

Parameters:

id - Message database ID or latest.

embed - Whether Mailpit should render iframe-friendly HTML.

Returns:

Rendered HTML.

See Also:

• Render message HTML part.

renderText

@Consumes("text/plain")
@Get("/view/{id}.txt")
String renderText(@PathVariable("id")
 String id)

Renders the message text part.

Parameters:

id - Message database ID or latest.

Returns:

Rendered text.

See Also:

• Render message text part.