org.xwiki.mail

Interface MimeMessageFactory<T,U>

Type Parameters:

T - the type of the source from which to prefill the Mime Message(s)

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

@Role
@Unstable
public interface MimeMessageFactory<T,U>

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: cd0b83d4d4ee2a57e4a970bc5ffc14009db69341 $

Method Summary

Methods

Modifier and Type	Method and Description
U	createMessage(javax.mail.Session session, T source, Map<String,Object> parameters) Create a MimeMessage.

Method Detail

createMessage

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

Create a MimeMessage.

Parameters:

session - the JavaMail Session needed to create the instance(s) of MimeMessage (contains all configuration such as SMTP server, SMTP port, etc)

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)