org.xwiki.mail

Interface MimeMessageFactory<T>

Type Parameters:

T - the return type of what gets created (usually a MimeMessage or an Iterator of MimeMessage)

@Role
@Unstable
public interface MimeMessageFactory<T>

Create one or several MimeMessage. This allows Component implementers the ability to create and pre-fill one or several MimeMessage objects according to some algorithm. For example a Template Mime Message Factory could compute the subject and its content from an XObject in a wiki page. And a Group Mime Message Factory could generate an Iterator of MimeMessage, which itself would generate one MimeMessage per user in the Group.

Since:

6.4.1

Version:

$Id: 4b4a92762999b16f771a3fb58862c9d3ed6d19cd $

Method Summary

Methods

Modifier and Type	Method and Description
T	createMessage(Object source, Map<String,Object> parameters) Create one or several MimeMessage.

Method Detail

createMessage

T createMessage(Object source,
              Map<String,Object> parameters)
                throws javax.mail.MessagingException

Create one or several MimeMessage.

Parameters:

source - the source from which to prefill the Mime Message(s) (depends on the implementation)

parameters - an optional generic list of parameters. The supported parameters depend on the implementation

Returns:

the pre-filled MimeMessage(s) that can then be further modified by the user

Throws:

javax.mail.MessagingException - in case of an error while creating the MimeMessage(s)