Index (module-email 1.0.4 API)

A B C E G L M N R S U W
All Classes and Interfaces|All Packages|Serialized Form

A

addAttach(String, String) - Method in class net.bugreaper.modules.email.Email.EmailBuilder
addAttach(String, String) - Method in interface net.bugreaper.modules.email.interfaces.EmailBuilderInt: Adds an attachment using automatic content type detection.
addBcc(String) - Method in class net.bugreaper.modules.email.Email.EmailBuilder
addBcc(String) - Method in interface net.bugreaper.modules.email.interfaces.EmailBuilderInt: Adds a "BCC" (blind carbon copy) recipient.
addCc(String) - Method in class net.bugreaper.modules.email.Email.EmailBuilder
addCc(String) - Method in interface net.bugreaper.modules.email.interfaces.EmailBuilderInt: Adds a "CC" (carbon copy) recipient.
addHeader(String, String) - Method in class net.bugreaper.modules.email.Email.EmailBuilder
addHeader(String, String) - Method in interface net.bugreaper.modules.email.interfaces.EmailBuilderInt: Adds a custom header in <key> format.
addReplyTo(String) - Method in class net.bugreaper.modules.email.Email.EmailBuilder
addReplyTo(String) - Method in interface net.bugreaper.modules.email.interfaces.EmailBuilderInt: Adds a "Reply-To" address.
addTags(String) - Method in class net.bugreaper.modules.email.Email.EmailBuilder
addTags(String) - Method in interface net.bugreaper.modules.email.interfaces.EmailBuilderInt: Adds a tag to the aggregated X-Tags header.
addTo(String) - Method in class net.bugreaper.modules.email.Email.EmailBuilder
addTo(String) - Method in interface net.bugreaper.modules.email.interfaces.EmailBuilderInt: Adds a "TO" recipient.
AllureStepBuilder<T extends AllureStepBuilder<T>> - Class in net.bugreaper.modules.email.allure
AllureStepBuilder() - Constructor for class net.bugreaper.modules.email.allure.AllureStepBuilder
ApiEmail - Class in net.bugreaper.modules.email.api
ApiEmail(String, int) - Constructor for class net.bugreaper.modules.email.api.ApiEmail
AssertableMailpitResponse - Class in net.bugreaper.modules.email.assertable: Provides a fluent API for asserting and extracting data from Email messages (API responses).
AssertableMailpitResponse(Response) - Constructor for class net.bugreaper.modules.email.assertable.AssertableMailpitResponse

B

build(String, String) - Method in class net.bugreaper.modules.email.Email
build(String, String) - Method in interface net.bugreaper.modules.email.interfaces.EmailInt: Entry point for fluent email builder.

C

check() - Method in class net.bugreaper.modules.email.assertable.AssertableMailpitResponse
check() - Method in interface net.bugreaper.modules.email.assertable.ResponseMailpitInterface: Asserts that the response body is valid for subsequent checks.
cleanAllMailboxes() - Method in class net.bugreaper.modules.email.EmailMailpit
cleanAllMailboxes() - Method in interface net.bugreaper.modules.email.interfaces.MailPitInterface: Deletes all messages from all mailboxes.
cleanMailbox(String) - Method in class net.bugreaper.modules.email.EmailMailpit
cleanMailbox(String) - Method in interface net.bugreaper.modules.email.interfaces.MailPitInterface: Deletes all messages from the mailbox.

E

Email - Class in net.bugreaper.modules.email: Email helper that provides a common API for sending emails via SMTP using Jakarta Mail.
Email() - Constructor for class net.bugreaper.modules.email.Email: Constructs a Email client using YAML configuration.
Email(String, int) - Constructor for class net.bugreaper.modules.email.Email: Creates an Email helper configured for unauthenticated SMTP.
Email(String, int, String, String) - Constructor for class net.bugreaper.modules.email.Email: Creates an EmailMailpit helper configured for authenticated SMTP.
Email.EmailBuilder - Class in net.bugreaper.modules.email: Fluent builder for constructing complex emails.
EmailBuilder(Session, String, String) - Constructor for class net.bugreaper.modules.email.Email.EmailBuilder
EmailBuilderInt - Interface in net.bugreaper.modules.email.interfaces
EmailHelperException - Exception in net.bugreaper.modules.email.exceptions: Exceptions that can be thrown during Email helper use
EmailHelperException(String, Throwable) - Constructor for exception net.bugreaper.modules.email.exceptions.EmailHelperException: Constructs a new exception with the specified detail message and cause.
EmailInt - Interface in net.bugreaper.modules.email.interfaces
EmailMailpit - Class in net.bugreaper.modules.email: EmailMailpit helper that provides a common API for operating with Mailpit, an email and SMTP testing tool.
EmailMailpit() - Constructor for class net.bugreaper.modules.email.EmailMailpit: Constructs a EmailMailpit client using YAML configuration.
EmailMailpit(String, int) - Constructor for class net.bugreaper.modules.email.EmailMailpit: Creates an EmailMailpit helper with the specified connection settings.

G

getAllEmailsCount() - Method in class net.bugreaper.modules.email.EmailMailpit
getAllEmailsCount() - Method in interface net.bugreaper.modules.email.interfaces.MailPitInterface: Returns the number of messages in all mailboxes.
getConfigSummary() - Method in class net.bugreaper.modules.email.Email
getConfigSummary() - Method in class net.bugreaper.modules.email.EmailMailpit
getConfigSummary() - Method in interface net.bugreaper.modules.email.interfaces.MailPitInterface: Returns and logs (at INFO level) a human-readable summary of all resolved configuration values.
getEmailsCountInMailbox(String) - Method in class net.bugreaper.modules.email.EmailMailpit
getEmailsCountInMailbox(String) - Method in interface net.bugreaper.modules.email.interfaces.MailPitInterface: Returns the number of messages in the mailbox.
getInstance() - Static method in class net.bugreaper.modules.email.Email: Returns the instance of Email.
getInstance() - Static method in class net.bugreaper.modules.email.EmailMailpit: Returns the instance of EmailMailpit with config builder EmailMailpit().
getLatestEmailInMailbox(String) - Method in class net.bugreaper.modules.email.EmailMailpit
getLatestEmailInMailbox(String) - Method in interface net.bugreaper.modules.email.interfaces.MailPitInterface: Returns the latest message from the mailbox in Mailpit format.
grabDataFromResponseByPath(String) - Method in class net.bugreaper.modules.email.assertable.AssertableMailpitResponse
grabDataFromResponseByPath(String) - Method in interface net.bugreaper.modules.email.assertable.ResponseMailpitInterface: Retrieves a field value of any type from the Mailpit response body.

L

Log - Class in net.bugreaper.modules.email.logger
LOGGER - Static variable in class net.bugreaper.modules.email.logger.Log

M

MailpitHelperException - Exception in net.bugreaper.modules.email.exceptions: Exceptions that can be thrown during Mailpit helper use
MailpitHelperException(String) - Constructor for exception net.bugreaper.modules.email.exceptions.MailpitHelperException: Constructs a new exception with the specified detail message
MailPitInterface - Interface in net.bugreaper.modules.email.interfaces

N

net.bugreaper.modules.email - package net.bugreaper.modules.email
net.bugreaper.modules.email.allure - package net.bugreaper.modules.email.allure
net.bugreaper.modules.email.api - package net.bugreaper.modules.email.api
net.bugreaper.modules.email.assertable - package net.bugreaper.modules.email.assertable
net.bugreaper.modules.email.exceptions - package net.bugreaper.modules.email.exceptions
net.bugreaper.modules.email.interfaces - package net.bugreaper.modules.email.interfaces
net.bugreaper.modules.email.logger - package net.bugreaper.modules.email.logger

R

ResponseMailpitInterface - Interface in net.bugreaper.modules.email.assertable

S

seeAllEmailsCountExactly(int) - Method in class net.bugreaper.modules.email.EmailMailpit
seeAllEmailsCountExactly(int) - Method in interface net.bugreaper.modules.email.interfaces.MailPitInterface: Asserts that the number of messages in all mailboxes equals the expected count.
seeEmailAttachmentsCountExactly(int) - Method in class net.bugreaper.modules.email.assertable.AssertableMailpitResponse
seeEmailAttachmentsCountExactly(int) - Method in interface net.bugreaper.modules.email.assertable.ResponseMailpitInterface: Asserts that the email message contains exactly the expected number of attachments.
seeEmailBccCountExactly(int) - Method in class net.bugreaper.modules.email.assertable.AssertableMailpitResponse
seeEmailBccCountExactly(int) - Method in interface net.bugreaper.modules.email.assertable.ResponseMailpitInterface: Asserts that the email message contains exactly the expected number of "Bcc" email addresses.
seeEmailBodyContains(String) - Method in class net.bugreaper.modules.email.assertable.AssertableMailpitResponse
seeEmailBodyContains(String) - Method in interface net.bugreaper.modules.email.assertable.ResponseMailpitInterface: Asserts that the email message body contains the expected string.
seeEmailBodyEqual(String) - Method in class net.bugreaper.modules.email.assertable.AssertableMailpitResponse
seeEmailBodyEqual(String) - Method in interface net.bugreaper.modules.email.assertable.ResponseMailpitInterface: Asserts that the email message body equals the expected string.
seeEmailCcCountExactly(int) - Method in class net.bugreaper.modules.email.assertable.AssertableMailpitResponse
seeEmailCcCountExactly(int) - Method in interface net.bugreaper.modules.email.assertable.ResponseMailpitInterface: Asserts that the email message contains exactly the expected number of "Cc" email addresses.
seeEmailContainsBcc(String) - Method in class net.bugreaper.modules.email.assertable.AssertableMailpitResponse
seeEmailContainsBcc(String) - Method in interface net.bugreaper.modules.email.assertable.ResponseMailpitInterface: Asserts that the email message contains the expected email address in the "Bcc" field.
seeEmailContainsCc(String) - Method in class net.bugreaper.modules.email.assertable.AssertableMailpitResponse
seeEmailContainsCc(String) - Method in interface net.bugreaper.modules.email.assertable.ResponseMailpitInterface: Asserts that the email message contains the expected email address in the "Cc" field.
seeEmailContainsFrom(String) - Method in class net.bugreaper.modules.email.assertable.AssertableMailpitResponse
seeEmailContainsFrom(String) - Method in interface net.bugreaper.modules.email.assertable.ResponseMailpitInterface: Asserts that the email message contains the expected email address in the "From" field.
seeEmailContainsReplyTo(String) - Method in class net.bugreaper.modules.email.assertable.AssertableMailpitResponse
seeEmailContainsReplyTo(String) - Method in interface net.bugreaper.modules.email.assertable.ResponseMailpitInterface: Asserts that the email message contains the expected email address in the "ReplyTo" field.
seeEmailContainsTo(String) - Method in class net.bugreaper.modules.email.assertable.AssertableMailpitResponse
seeEmailContainsTo(String) - Method in interface net.bugreaper.modules.email.assertable.ResponseMailpitInterface: Asserts that the email message contains the expected email address in the "To" field.
seeEmailReplyToCountExactly(int) - Method in class net.bugreaper.modules.email.assertable.AssertableMailpitResponse
seeEmailReplyToCountExactly(int) - Method in interface net.bugreaper.modules.email.assertable.ResponseMailpitInterface: Asserts that the email message contains exactly the expected number of "ReplyTo" email addresses.
seeEmailsInMailboxCountExactly(String, int) - Method in class net.bugreaper.modules.email.EmailMailpit
seeEmailsInMailboxCountExactly(String, int) - Method in interface net.bugreaper.modules.email.interfaces.MailPitInterface: Asserts that the number of messages in specific mailbox equals the expected count.
seeEmailSubjectContains(String) - Method in class net.bugreaper.modules.email.assertable.AssertableMailpitResponse
seeEmailSubjectContains(String) - Method in interface net.bugreaper.modules.email.assertable.ResponseMailpitInterface: Asserts that the email message subject contains the expected string.
seeEmailSubjectEqual(String) - Method in class net.bugreaper.modules.email.assertable.AssertableMailpitResponse
seeEmailSubjectEqual(String) - Method in interface net.bugreaper.modules.email.assertable.ResponseMailpitInterface: Asserts that the email message subject equals the expected string.
seeEmailToCountExactly(int) - Method in class net.bugreaper.modules.email.assertable.AssertableMailpitResponse
seeEmailToCountExactly(int) - Method in interface net.bugreaper.modules.email.assertable.ResponseMailpitInterface: Asserts that the email message contains exactly the expected number of "To" email addresses.
seeMailboxIsEmpty(String) - Method in class net.bugreaper.modules.email.EmailMailpit
seeMailboxIsEmpty(String) - Method in interface net.bugreaper.modules.email.interfaces.MailPitInterface: Asserts that the mailbox is empty.
seeMailboxIsNotEmpty(String) - Method in class net.bugreaper.modules.email.EmailMailpit
seeMailboxIsNotEmpty(String) - Method in interface net.bugreaper.modules.email.interfaces.MailPitInterface: Asserts that the mailbox is not empty.
seeResponseBodyFieldMatch(String, Matcher<?>) - Method in class net.bugreaper.modules.email.assertable.AssertableMailpitResponse
seeResponseBodyFieldMatch(String, Matcher<?>) - Method in interface net.bugreaper.modules.email.assertable.ResponseMailpitInterface: Asserts that the email message body matches the specified matcher.
send() - Method in class net.bugreaper.modules.email.Email.EmailBuilder
send() - Method in interface net.bugreaper.modules.email.interfaces.EmailBuilderInt: Builds and sends the email.
sendDelete(String) - Method in class net.bugreaper.modules.email.api.ApiEmail
sendEmail(String, String, String, String) - Method in class net.bugreaper.modules.email.Email
sendEmail(String, String, String, String) - Method in interface net.bugreaper.modules.email.interfaces.EmailInt: Sends a simple plain-text email.
sendGet(String) - Method in class net.bugreaper.modules.email.api.ApiEmail
sendGetNoStep(String, Map<String, ?>) - Method in class net.bugreaper.modules.email.api.ApiEmail
sendPut(String, Object) - Method in class net.bugreaper.modules.email.api.ApiEmail
setAwaitMs(int) - Method in class net.bugreaper.modules.email.EmailMailpit
setAwaitMs(int) - Method in interface net.bugreaper.modules.email.interfaces.MailPitInterface: Configures the global await timeout for assertions that use await.
setChaosAuthentication(int) - Method in class net.bugreaper.modules.email.EmailMailpit
setChaosAuthentication(int) - Method in interface net.bugreaper.modules.email.interfaces.MailPitInterface: Configures an authentication error in the Mailpit server for subsequent email sends.
setChaosRecipient(int) - Method in class net.bugreaper.modules.email.EmailMailpit
setChaosRecipient(int) - Method in interface net.bugreaper.modules.email.interfaces.MailPitInterface: Configures a recipient error in the Mailpit server for subsequent email sends.
setChaosSender(int) - Method in class net.bugreaper.modules.email.EmailMailpit
setChaosSender(int) - Method in interface net.bugreaper.modules.email.interfaces.MailPitInterface: Configures a sender error in the Mailpit server for subsequent email sends.
setFrom(String) - Method in class net.bugreaper.modules.email.Email.EmailBuilder
setFrom(String) - Method in interface net.bugreaper.modules.email.interfaces.EmailBuilderInt: Set a "FROM" sender.
startStep(String) - Method in class net.bugreaper.modules.email.allure.AllureStepBuilder
step(String, Runnable) - Method in class net.bugreaper.modules.email.allure.AllureStepBuilder
stopStepFailed() - Method in class net.bugreaper.modules.email.allure.AllureStepBuilder
stopStepSuccess() - Method in class net.bugreaper.modules.email.allure.AllureStepBuilder

U

unsetChaos() - Method in class net.bugreaper.modules.email.EmailMailpit
unsetChaos() - Method in interface net.bugreaper.modules.email.interfaces.MailPitInterface: Disables predefined chaos errors in the Mailpit server.

W

withQueryParam(String, Object) - Method in class net.bugreaper.modules.email.api.ApiEmail

A B C E G L M N R S U W
All Classes and Interfaces|All Packages|Serialized Form