Package net.bugreaper.modules.email.assertable

Class AssertableMailpitResponse

java.lang.Object

net.bugreaper.modules.api.assertable.AssertableResponseAbstract

net.bugreaper.modules.email.assertable.AssertableMailpitResponse

All Implemented Interfaces:

ResponseMailpitInterface

public class AssertableMailpitResponse
extends net.bugreaper.modules.api.assertable.AssertableResponseAbstract
implements ResponseMailpitInterface

Provides a fluent API for asserting and extracting data from Email messages (API responses).

This class is designed to be used in a chainable manner, allowing multiple assertions to be performed in a single readable statement.

Usage Example:

 mailpit.getLatestEmailInMailbox("my_email@gmail.com")
         .seeEmailContainsFrom("sender@gmail.com")
         .seeEmailAttachmentsCountExactly(2);
 

Design Notes:

• All assertion methods return this to support fluent chaining.
• Assertion logic is delegated to internal helper methods to keep steps readable.
• Failures should throw assertion errors to immediately fail the test.

Constructor Summary

Constructors

Constructor	Description
AssertableMailpitResponse(io.restassured.response.Response response)

Method Summary

Modifier and Type	Method	Description
AssertableMailpitResponse	check()	Asserts that the response body is valid for subsequent checks.
Object	grabDataFromResponseByPath(String path)	Retrieves a field value of any type from the Mailpit response body.
AssertableMailpitResponse	seeEmailAttachmentsCountExactly(int expectedCount)	Asserts that the email message contains exactly the expected number of attachments.
AssertableMailpitResponse	seeEmailBccCountExactly(int expectedCount)	Asserts that the email message contains exactly the expected number of "Bcc" email addresses.
AssertableMailpitResponse	seeEmailBodyContains(String expectedSubString)	Asserts that the email message body contains the expected string.
AssertableMailpitResponse	seeEmailBodyEqual(String expectedBody)	Asserts that the email message body equals the expected string.
AssertableMailpitResponse	seeEmailCcCountExactly(int expectedCount)	Asserts that the email message contains exactly the expected number of "Cc" email addresses.
AssertableMailpitResponse	seeEmailContainsBcc(String expectedEmail)	Asserts that the email message contains the expected email address in the "Bcc" field.
AssertableMailpitResponse	seeEmailContainsCc(String expectedEmail)	Asserts that the email message contains the expected email address in the "Cc" field.
AssertableMailpitResponse	seeEmailContainsFrom(String expectedEmail)	Asserts that the email message contains the expected email address in the "From" field.
AssertableMailpitResponse	seeEmailContainsReplyTo(String expectedEmail)	Asserts that the email message contains the expected email address in the "ReplyTo" field.
AssertableMailpitResponse	seeEmailContainsTo(String expectedEmail)	Asserts that the email message contains the expected email address in the "To" field.
AssertableMailpitResponse	seeEmailReplyToCountExactly(int expectedCount)	Asserts that the email message contains exactly the expected number of "ReplyTo" email addresses.
AssertableMailpitResponse	seeEmailSubjectContains(String expectedSubString)	Asserts that the email message subject contains the expected string.
AssertableMailpitResponse	seeEmailSubjectEqual(String expectedSubject)	Asserts that the email message subject equals the expected string.
AssertableMailpitResponse	seeEmailToCountExactly(int expectedCount)	Asserts that the email message contains exactly the expected number of "To" email addresses.
AssertableMailpitResponse	seeResponseBodyFieldMatch(String path, org.hamcrest.Matcher<?> matcher)	Asserts that the email message body matches the specified matcher.

Methods inherited from class net.bugreaper.modules.api.assertable.AssertableResponseAbstract

grabDataFromResponseByPathMethod, grabResponseBodyMethod, grabResponseHeaderMethod, grabStringFromResponseByPathMethod, seeResponseBodyElementsCountMethod, seeResponseBodyFieldMatchMethod, seeResponseCodeIsMethod, seeResponseCodeIsSuccessfulMethod, seeResponseContainsExtendedJsonMethod, seeResponseContainsJsonMethod, seeResponseContainsJsonMethod, seeResponseContainsJsonStrictOrderMethod, seeResponseContainsJsonSubsetMethod, seeResponseExactlyMatchJsonIgnoringOrderMethod, seeResponseExactlyMatchJsonMethod, seeResponseExactlyMatchJsonMethod, seeResponseHeaderMatchMethod, seeResponseIsJsonTypeMethod, seeResponseMatchesJsonSchemaMethod, seeResponseMatchesXmlSchemaMethod, seeResponseTimeLessMethod

Methods inherited from class java.lang.Object

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

Constructor Details

AssertableMailpitResponse

public AssertableMailpitResponse(io.restassured.response.Response response)

Method Details

check

public AssertableMailpitResponse check()

Description copied from interface: ResponseMailpitInterface

Asserts that the response body is valid for subsequent checks.

Used internally by EmailMailpit methods.

Specified by:

check in interface ResponseMailpitInterface

Returns:

this instance for method chaining

seeResponseBodyFieldMatch

@Step("\u2191(Email-mp)[ASSERT] Response body field: \'{path}\' <{matcher}>")
public AssertableMailpitResponse seeResponseBodyFieldMatch(String path,
 org.hamcrest.Matcher<?> matcher)

Description copied from interface: ResponseMailpitInterface

Asserts that the email message body matches the specified matcher.

NOTE: Use for some custom asserts or not yet supported features

Specified by:

seeResponseBodyFieldMatch in interface ResponseMailpitInterface

Parameters:

path - path to the field (for example: data.user.id)

matcher - Matcher

Returns:

this instance for method chaining

seeEmailBodyEqual

@Step("\u2191(Email-mp)[ASSERT] Email Body EQUAL to:")
public AssertableMailpitResponse seeEmailBodyEqual(@Param(mode=HIDDEN)
 String expectedBody)

Description copied from interface: ResponseMailpitInterface

Asserts that the email message body equals the expected string.

Specified by:

seeEmailBodyEqual in interface ResponseMailpitInterface

Parameters:

expectedBody - expected email body

Returns:

this instance for method chaining

seeEmailBodyContains

@Step("\u2191(Email-mp)[ASSERT] Email Body CONTAINS:")
public AssertableMailpitResponse seeEmailBodyContains(@Param(mode=HIDDEN)
 String expectedSubString)

Description copied from interface: ResponseMailpitInterface

Asserts that the email message body contains the expected string.

Specified by:

seeEmailBodyContains in interface ResponseMailpitInterface

Parameters:

expectedSubString - expected substring

Returns:

this instance for method chaining

seeEmailSubjectEqual

@Step("\u2191(Email-mp)[ASSERT] Email Subject EQUAL to:")
public AssertableMailpitResponse seeEmailSubjectEqual(@Param(mode=HIDDEN)
 String expectedSubject)

Description copied from interface: ResponseMailpitInterface

Asserts that the email message subject equals the expected string.

Specified by:

seeEmailSubjectEqual in interface ResponseMailpitInterface

Parameters:

expectedSubject - expected email subject

Returns:

this instance for method chaining

seeEmailSubjectContains

@Step("\u2191(Email-mp)[ASSERT] Email Subject CONTAINS:")
public AssertableMailpitResponse seeEmailSubjectContains(@Param(mode=HIDDEN)
 String expectedSubString)

Description copied from interface: ResponseMailpitInterface

Asserts that the email message subject contains the expected string.

Specified by:

seeEmailSubjectContains in interface ResponseMailpitInterface

Parameters:

expectedSubString - expected substring

Returns:

this instance for method chaining

seeEmailContainsFrom

@Step("\u2191(Email-mp)[ASSERT] Email has \'From\': <{expectedEmail}>")
public AssertableMailpitResponse seeEmailContainsFrom(String expectedEmail)

Description copied from interface: ResponseMailpitInterface

Asserts that the email message contains the expected email address in the "From" field.

Specified by:

seeEmailContainsFrom in interface ResponseMailpitInterface

Parameters:

expectedEmail - expected email address in the "From" field

Returns:

this instance for method chaining

seeEmailContainsTo

public AssertableMailpitResponse seeEmailContainsTo(String expectedEmail)

Description copied from interface: ResponseMailpitInterface

Asserts that the email message contains the expected email address in the "To" field.

Specified by:

seeEmailContainsTo in interface ResponseMailpitInterface

Parameters:

expectedEmail - expected email address in the "To" field

Returns:

this instance for method chaining

seeEmailContainsCc

public AssertableMailpitResponse seeEmailContainsCc(String expectedEmail)

Description copied from interface: ResponseMailpitInterface

Asserts that the email message contains the expected email address in the "Cc" field.

Specified by:

seeEmailContainsCc in interface ResponseMailpitInterface

Parameters:

expectedEmail - expected email address in the "Cc" field

Returns:

this instance for method chaining

seeEmailContainsBcc

public AssertableMailpitResponse seeEmailContainsBcc(String expectedEmail)

Description copied from interface: ResponseMailpitInterface

Asserts that the email message contains the expected email address in the "Bcc" field.

Specified by:

seeEmailContainsBcc in interface ResponseMailpitInterface

Parameters:

expectedEmail - expected email address in the "Bcc" field

Returns:

this instance for method chaining

seeEmailContainsReplyTo

public AssertableMailpitResponse seeEmailContainsReplyTo(String expectedEmail)

Description copied from interface: ResponseMailpitInterface

Asserts that the email message contains the expected email address in the "ReplyTo" field.

Specified by:

seeEmailContainsReplyTo in interface ResponseMailpitInterface

Parameters:

expectedEmail - expected email address in the "ReplyTo" field

Returns:

this instance for method chaining

seeEmailAttachmentsCountExactly

public AssertableMailpitResponse seeEmailAttachmentsCountExactly(int expectedCount)

Description copied from interface: ResponseMailpitInterface

Asserts that the email message contains exactly the expected number of attachments.

Specified by:

seeEmailAttachmentsCountExactly in interface ResponseMailpitInterface

Parameters:

expectedCount - expected number of attachments

Returns:

this instance for method chaining

seeEmailToCountExactly

public AssertableMailpitResponse seeEmailToCountExactly(int expectedCount)

Description copied from interface: ResponseMailpitInterface

Asserts that the email message contains exactly the expected number of "To" email addresses.

Specified by:

seeEmailToCountExactly in interface ResponseMailpitInterface

Parameters:

expectedCount - expected number of "To" email addresses in the message

Returns:

this instance for method chaining

seeEmailCcCountExactly

public AssertableMailpitResponse seeEmailCcCountExactly(int expectedCount)

Description copied from interface: ResponseMailpitInterface

Asserts that the email message contains exactly the expected number of "Cc" email addresses.

Specified by:

seeEmailCcCountExactly in interface ResponseMailpitInterface

Parameters:

expectedCount - expected number of "Cc" email addresses in the message

Returns:

this instance for method chaining

seeEmailBccCountExactly

public AssertableMailpitResponse seeEmailBccCountExactly(int expectedCount)

Description copied from interface: ResponseMailpitInterface

Asserts that the email message contains exactly the expected number of "Bcc" email addresses.

Specified by:

seeEmailBccCountExactly in interface ResponseMailpitInterface

Parameters:

expectedCount - expected number of "Bcc" email addresses in the message

Returns:

this instance for method chaining

seeEmailReplyToCountExactly

public AssertableMailpitResponse seeEmailReplyToCountExactly(int expectedCount)

Description copied from interface: ResponseMailpitInterface

Asserts that the email message contains exactly the expected number of "ReplyTo" email addresses.

Specified by:

seeEmailReplyToCountExactly in interface ResponseMailpitInterface

Parameters:

expectedCount - expected number of "ReplyTo" email addresses in the message

Returns:

this instance for method chaining

grabDataFromResponseByPath

public Object grabDataFromResponseByPath(String path)

Description copied from interface: ResponseMailpitInterface

Retrieves a field value of any type from the Mailpit response body.

Specified by:

grabDataFromResponseByPath in interface ResponseMailpitInterface

Parameters:

path - path to the field (for example: messages[0].To)

Returns:

field value from the response body