• Home
• com.commercetools.sunrise.email
• email-api
• 0.3.0
• source code
• MessageEditor.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.commercetools.sunrise.email.MessageEditor Maven / Gradle / Ivy

package com.commercetools.sunrise.email;

import javax.annotation.Nonnull;
import javax.mail.MessagingException;
import javax.mail.internet.MimeMessage;

/**
 * A functional interface for modifying a message without needing to handle checked exceptions like the
 * {@link MessagingException}s thrown by {@link MimeMessage}.
 * 

 * This interface will typically be implemented by lambda expressions passed to
 * {@link EmailSender#send(MessageEditor)}. See the JavaDoc of that method for an example.
 */
@FunctionalInterface
public interface MessageEditor {

    /**
     * Implementations of this method modify the given message. See the JavaDoc of
     * {@link EmailSender#send(MessageEditor)} for an example of a lambda expression that implements this interface.
     *
     * @param message the message to modify
     * @throws Exception if modification fails
     */
    void edit(@Nonnull final MimeMessage message) throws Exception;
}