io.commercetools.sunrise.email

Interface MessageEditor

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface MessageEditor

A functional interface for modifying a message without needing to handle checked exceptions like the MessagingExceptions thrown by MimeMessage.

This interface will typically be implemented by lambda expressions passed to EmailSender.send(MessageEditor). See the JavaDoc of that method for an example.

Method Summary

Modifier and Type	Method and Description
void	edit(javax.mail.internet.MimeMessage message) Implementations of this method modify the given message.

Method Detail

edit

void edit(@Nonnull
          javax.mail.internet.MimeMessage message)
   throws java.lang.Exception

Implementations of this method modify the given message. See the JavaDoc of EmailSender.send(MessageEditor) for an example of a lambda expression that implements this interface.

Parameters:

message - the message to modify

Throws:

java.lang.Exception - if modification fails