org.xwiki.mail

Class VoidMailListener

java.lang.Object

org.xwiki.mail.VoidMailListener

All Implemented Interfaces:

MailListener

public class VoidMailListener
extends Object
implements MailListener

A MailListener doing nothing.

Since:

12.6

Version:

$Id: cd1f1cce0d55d56fc9d64623429bfcc13e067042 $

Constructor Summary

Constructors

Constructor and Description
VoidMailListener()

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VoidMailListener

public VoidMailListener()

Method Detail

onPrepareBegin

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

Description copied from interface: MailListener

Called when the preparation phase begins.

Specified by:

onPrepareBegin in interface MailListener

Parameters:

batchId - identifier of the batch being prepared

parameters - some parameters specifying addition context data

onPrepareMessageSuccess

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

Description copied from interface: MailListener

Called when a mail has been prepared with success.

Specified by:

onPrepareMessageSuccess in interface MailListener

Parameters:

message - the message to be sent

parameters - some parameters specifying addition context data

onPrepareMessageError

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

Description copied from interface: MailListener

Called when a mail has failed to be prepared.

Specified by:

onPrepareMessageError in interface MailListener

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

onPrepareFatalError

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

Description copied from interface: MailListener

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

Specified by:

onPrepareFatalError in interface MailListener

Parameters:

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

parameters - some parameters specifying addition context data

onPrepareEnd

public void onPrepareEnd(Map<String,Object> parameters)

Description copied from interface: MailListener

Called when the preparation phase is finished.

Specified by:

onPrepareEnd in interface MailListener

Parameters:

parameters - some parameters specifying addition context data

onSendMessageSuccess

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

Description copied from interface: MailListener

Called when a mail has been sent successfully.

Specified by:

onSendMessageSuccess in interface MailListener

Parameters:

message - the message sent

parameters - some parameters specifying addition context data

onSendMessageError

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

Description copied from interface: MailListener

Called when a mail has failed to be sent.

Specified by:

onSendMessageError in interface MailListener

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

onSendMessageFatalError

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

Description copied from interface: MailListener

Called when a message could not be retrieve for sending.

Specified by:

onSendMessageFatalError in interface MailListener

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

getMailStatusResult

public MailStatusResult getMailStatusResult()

Specified by:

getMailStatusResult in interface MailListener

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