org.xwiki.mail

Interface MailResult

public interface MailResult

The result of the batch of emails being sent.

Since:

6.4M3

Version:

$Id: e9a274d76eb8f6d2a95997ab60f9dfa4396c4e84 $

Method Summary

Methods

Modifier and Type	Method and Description
String	getBatchId()
boolean	isProcessed()
void	waitTillProcessed(long timeout) Wait till all messages on the sending queue have been sent (for this batch) before returning.

Method Detail

waitTillProcessed

void waitTillProcessed(long timeout)

Wait till all messages on the sending queue have been sent (for this batch) before returning.

Parameters:

timeout - the maximum amount of time to wait in milliseconds

Since:

6.4

isProcessed

boolean isProcessed()

Returns:

true if all the mails from this batch have been processed (sent successfully or not) or false otherwise

Since:

6.4RC1

getBatchId

String getBatchId()

Returns:

the batch id for this session of mail sending