org.xwiki.mail

Interface MailListener

All Known Implementing Classes:

CompositeMailListener, VoidMailListener

@Role
public interface MailListener

Allows listening to Mail sending results.

Since:

6.1M2

Version:

$Id: 1d50511f77473b66ee1843af1b03c47b4b619c46 $

Method Summary

Modifier and Type	Method and Description
MailStatusResult	getMailStatusResult()
void	onPrepareBegin(String batchId, Map<String,Object> parameters) Called when the preparation phase begins.
void	onPrepareEnd(Map<String,Object> parameters) Called when the preparation phase is finished.
void	onPrepareFatalError(Exception exception, Map<String,Object> parameters) Called when the preparation phase has encounter a fatal error.
void	onPrepareMessageError(ExtendedMimeMessage message, Exception e, Map<String,Object> parameters) Called when a mail has failed to be prepared.
void	onPrepareMessageSuccess(ExtendedMimeMessage message, Map<String,Object> parameters) Called when a mail has been prepared with success.
void	onSendMessageError(ExtendedMimeMessage message, Exception exception, Map<String,Object> parameters) Called when a mail has failed to be sent.
void	onSendMessageFatalError(String uniqueMessageId, Exception exception, Map<String,Object> parameters) Called when a message could not be retrieve for sending.
void	onSendMessageSuccess(ExtendedMimeMessage message, Map<String,Object> parameters) Called when a mail has been sent successfully.

Method Detail

onPrepareBegin

void onPrepareBegin(String batchId,
                    Map<String,Object> parameters)

Called when the preparation phase begins.

Parameters:

batchId - identifier of the batch being prepared

parameters - some parameters specifying addition context data

Since:

7.1RC1

onPrepareMessageSuccess

void onPrepareMessageSuccess(ExtendedMimeMessage message,
                             Map<String,Object> parameters)

Called when a mail has been prepared with success.

Parameters:

message - the message to be sent

parameters - some parameters specifying addition context data

Since:

7.4.1

onPrepareMessageError

void onPrepareMessageError(ExtendedMimeMessage message,
                           Exception e,
                           Map<String,Object> parameters)

Called when a mail has failed to be prepared.

Parameters:

message - the message that was tried to be prepared

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

parameters - some parameters specifying addition context data

Since:

7.4.1

onPrepareFatalError

void onPrepareFatalError(Exception exception,
                         Map<String,Object> parameters)

Called when the preparation phase has encounter a fatal error. The batch in progress has been incompletely processed.

Parameters:

exception - the exception explaining why messages couldn't be prepared

parameters - some parameters specifying addition context data

Since:

7.1RC1

onPrepareEnd

void onPrepareEnd(Map<String,Object> parameters)

Called when the preparation phase is finished.

Parameters:

parameters - some parameters specifying addition context data

Since:

7.1RC1

onSendMessageSuccess

void onSendMessageSuccess(ExtendedMimeMessage message,
                          Map<String,Object> parameters)

Called when a mail has been sent successfully.

Parameters:

message - the message sent

parameters - some parameters specifying addition context data

Since:

7.4.1

onSendMessageError

void onSendMessageError(ExtendedMimeMessage message,
                        Exception exception,
                        Map<String,Object> parameters)

Called when a mail has failed to be sent.

Parameters:

message - the message that was tried to be sent

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

parameters - some parameters specifying addition context data

Since:

7.4.1

onSendMessageFatalError

void onSendMessageFatalError(String uniqueMessageId,
                             Exception exception,
                             Map<String,Object> parameters)

Called when a message could not be retrieve for sending.

Parameters:

uniqueMessageId - the unique message identifier that was tried to be load for sending

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

parameters - some parameters specifying addition context data

Since:

7.4.1

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.waitTillProcessed(long) or MailStatusResult.isProcessed() to ensure that all mails have been processed

Since:

6.4M3