org.xwiki.mail

Interface MailListener

@Role
@Unstable
public interface MailListener

Allows listening to Mail sending results.

Since:

6.1M2

Version:

$Id: 0ba1c10672de9096e832a63404aa92c05148813e $

Method Summary

Methods

Modifier and Type	Method and Description
MailStatusResult	getMailStatusResult()
void	onError(javax.mail.internet.MimeMessage message, Exception e, Map<String,Object> parameters) Called when the mail has failed to be sent.
void	onPrepare(javax.mail.internet.MimeMessage message, Map<String,Object> parameters) Called when the mail is ready to be sent but before it is actually sent.
void	onSuccess(javax.mail.internet.MimeMessage message, Map<String,Object> parameters) Called when the mail has been sent successfully.

Method Detail

onPrepare

void onPrepare(javax.mail.internet.MimeMessage message,
             Map<String,Object> parameters)

Called when the mail is ready to be sent but before it is actually sent.

Parameters:

message - the message to be sent

parameters - some parameters specifying addition context data (for example the current wiki is stored under the wiki key)

onSuccess

void onSuccess(javax.mail.internet.MimeMessage message,
             Map<String,Object> parameters)

Called when the mail has been sent successfully.

Parameters:

message - the message sent

parameters - some parameters specifying addition context data (for example the current wiki is stored under the wiki key)

onError

void onError(javax.mail.internet.MimeMessage message,
           Exception e,
           Map<String,Object> parameters)

Called when the mail has failed to be sent.

Parameters:

message - the message that was tried to be sent

e - the exception explaining why the message couldn't be sent

parameters - some parameters specifying addition context data (for example the current wiki is stored under the wiki key)

getMailStatusResult

MailStatusResult getMailStatusResult()

Returns:

the status of all the mails from the batch (whether they were sent successfully, failed to be sent, ready to be sent but not sent yet, etc). Note that since mails can be sent asynchronously it's possible that when calling this method, not all mails have been processed yet for sending and thus users or this method should call MailStatusResult.getSize() to ensure that they get the expected number and if not wait some more

Since:

6.4M3