eu.easyrpa.openframework.email.exception

Class BreakEmailFetchException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

eu.easyrpa.openframework.email.exception.BreakEmailFetchException

All Implemented Interfaces:

Serializable

public class BreakEmailFetchException
extends RuntimeException

Is intended to use to interrupt the fetching of email messages by some reason.

In email client functions where isSatisfy lambda expression is used this exception can be thrown for immediate interrupting of the function execution.

Here is an example of using this exception:

  @Inject
  private EmailClient emailClient;

  public void execute() {
    ...
    log.info("Fetch the first message from default inbox folder that contain attachments.");
    List<EmailMessage> messages = emailClient.fetchMessages(msg -> {
        if (msg.hasAttachments()) {
           //By throwing this exception it stops further checking of
           //emails and return this message as single result
           throw new BreakEmailFetchException(true);
        }
        return false;
    });
    ...
 }
 

See Also:

EmailClient.fetchMessages(Predicate), EmailClient.fetchMessages(String, Predicate), EmailClient.fetchAllMessages(Predicate), EmailClient.waitMessages(Predicate), EmailClient.waitMessages(Predicate, Duration), EmailClient.waitMessages(Predicate, Duration, Duration), EmailClient.waitMessages(String, Predicate), EmailClient.waitMessages(String, Predicate, Duration), EmailClient.waitMessages(String, Predicate, Duration, Duration), Serialized Form

Constructor Summary

Constructors

Constructor and Description
BreakEmailFetchException(boolean includeIntoResult) Constructs a new BreakEmailFetchException.

Method Summary

Modifier and Type	Method and Description
boolean	isIncludeIntoResult() Checks whether is necessary to put the currently checking email message into results.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

BreakEmailFetchException

public BreakEmailFetchException(boolean includeIntoResult)

Constructs a new BreakEmailFetchException.

Parameters:

includeIntoResult - the flag that indicates whether is necessary to put the currently checking email message into results. If the value is true then the currently checking email message should be included into results.

Method Detail

isIncludeIntoResult

public boolean isIncludeIntoResult()

Checks whether is necessary to put the currently checking email message into results.

Returns:

true if the currently checking email message should be included into results and false otherwise.