ScriptMailResult (XWiki Platform - Mail - Send - Default Implementation 14.8-rc-1 API)

java.lang.Object
- org.xwiki.mail.script.ScriptMailResult

All Implemented Interfaces:

MailResult
```
public class ScriptMailResult
extends Object
implements MailResult
```
Implementation used by the Mail Sender Script Service. It wraps the Java MailResult class to add a new getStatusResult() method since in the Scripting API the MailListener is passed as a hint and thus the user cannot call MailListener.getMailStatusResult() on it.

Since:

6.4M3

Version:

$Id: a6fbf19dee354b17d2c57d7c453773c27bdcb79a $

Constructor Summary

Constructors
Constructor Description

ScriptMailResult(MailResult wrappedMailResult, MailStatusResult mailStatusResult)

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`String`	`getBatchId()`
`MailStatusResult`	`getStatusResult()`
`boolean`	`isProcessed()`	Deprecated. since 7.1M2 use `MailStatusResult.isProcessed()` instead.
`void`	`waitTillProcessed(long timeout)`	Deprecated. use `MailStatusResult.waitTillProcessed(long)`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ScriptMailResult
```
public ScriptMailResult(MailResult wrappedMailResult,
                        MailStatusResult mailStatusResult)
```
    Parameters:
    
    wrappedMailResult - the MailResult instance to wrap
    
    mailStatusResult - see getStatusResult()
- Method Detail
  - getStatusResult
```
public MailStatusResult getStatusResult()
```
    Returns:
    
    the MailListener's MailStatusResult object which is useful for script users to get the status of each mail from the batch
  - getBatchId
```
public String getBatchId()
```
    Specified by:
    
    getBatchId in interface MailResult
  - waitTillProcessed
```
@Deprecated(since="7.1M2")
public void waitTillProcessed(long timeout)
```
    Deprecated.
    use MailStatusResult.waitTillProcessed(long). Kept to not break script backward compatibility
    
    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
```
@Deprecated
public boolean isProcessed()
```
    Deprecated.
    since 7.1M2 use MailStatusResult.isProcessed() instead. Kept to not break script backward compatibility
    
    Returns:
    
    true if all the mails from this batch have been processed (sent successfully or not) or false otherwise
    
    Since:
    
    6.4RC1