io.quarkus.mailer.MockMailbox Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of quarkus-mailer Show documentation

Send emails

There is a newer version: 3.17.5

package io.quarkus.mailer;

import java.util.List;

import io.vertx.ext.mail.MailMessage;

/**
 * Mock mail collector, will be populated if mocking emails.
 */
public interface MockMailbox {

    /**
     * Returns a list of mails sent to the given address, whether it was via To, Cc or Bcc.
     *
     * @param address the email address we want to retrieve mail from
     * @return a list of messages sent to the given address, possibly empty.
     * @deprecated use {@link #getMailMessagesSentTo(String)}
     */
    @Deprecated(forRemoval = true, since = "3.0")
    List getMessagesSentTo(String address);

    /**
     * Returns a list of mails sent to the given address, whether it was via To, Cc or Bcc.
     *
     * @param address the email address we want to retrieve mail from
     * @return a list of mails sent to the given address, possibly empty.
     */
    List getMailsSentTo(String address);

    /**
     * Returns a list of mail messages sent to the given address, whether it was via To, Cc or Bcc.
     *
     * @param address the email address we want to retrieve mail from
     * @return a list of mail messages sent to the given address, possibly empty.
     */
    List getMailMessagesSentTo(String address);

    /**
     * Removes every sent message.
     */
    void clear();

    /**
     * Gets the total number of messages sent. This counts every message sent to every recipient.
     *
     * @return the total number of messages sent.
     */
    int getTotalMessagesSent();
}