ejel
Class ExceptionEventArgs

java.lang.Object
  ejel.EventArgs
      ejel.ExceptionEventArgs

public class ExceptionEventArgs
extends EventArgs

Sent as a part of the EventID.EID_EXCEPTION event which is raised when an exception occurs while sender engine work. It contains all what external code needs to know about the exception. The ExceptionEventArgs let external code to ignore the exception and resume to next email, try to send the same email through an other email account and/or disable that one.

Constructor Summary

ExceptionEventArgs(int acntIndex, int rcptIndex, Recipient[] rcpts, java.lang.Exception ex)
ExceptionEventArgs constructor

Method Summary

int	getAccountIndex() Gets the EmailAccount index in the main accounts list
boolean	getDisableAccountStatus() Gets the disable account status of the event
java.lang.Exception	getException() Gets the Exception object if set or null
Recipient	getRecipientAt(int index) Gets the Recipient object at the index specified by the index param
int	getRecipientIndex() Gets the Recipient object index in the main recipients list
int	getRecipientsCount() Gets the Recipient objects count to who the email will be sent
boolean	getTryAgainStatus() Gets the try again status of the event
void	SetDisableAccountStatus() Sets to true the disable account status of the event
void	setTryAgainStatus() Sets to true so the sender engine will try to send the same email again

Methods inherited from class java.lang.Object

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

Constructor Detail

ExceptionEventArgs

public ExceptionEventArgs(int acntIndex,
                          int rcptIndex,
                          Recipient[] rcpts,
                          java.lang.Exception ex)

ExceptionEventArgs constructor

Parameters:

acntIndex - The EmailAccount object index in the main accounts list

rcptIndex - The first Recipient index in the main recipients list

rcpts - The array of the Recipient objects to who the email will be sent

ex - The Exception occured and reported by this event

Method Detail

getAccountIndex

public int getAccountIndex()

Gets the EmailAccount index in the main accounts list

Returns:

The EmailAccount index in the main accounts list

getRecipientIndex

public int getRecipientIndex()

Gets the Recipient object index in the main recipients list

Returns:

The Recipient object index in the main recipients list

getRecipientsCount

public int getRecipientsCount()

Gets the Recipient objects count to who the email will be sent

Returns:

The Recipient objects count to who the email will be sent

getRecipientAt

public Recipient getRecipientAt(int index)
                         throws java.lang.IndexOutOfBoundsException

Gets the Recipient object at the index specified by the index param

Parameters:

index - The index of the Recipient object to be retrieved

Returns:

The Recipient object at the index specified by the index param

Throws:

java.lang.IndexOutOfBoundsException

setTryAgainStatus

public void setTryAgainStatus()

Sets to true so the sender engine will try to send the same email again

getTryAgainStatus

public boolean getTryAgainStatus()

Gets the try again status of the event

Returns:

The try again status of the event

SetDisableAccountStatus

public void SetDisableAccountStatus()

Sets to true the disable account status of the event

getDisableAccountStatus

public boolean getDisableAccountStatus()

Gets the disable account status of the event

Returns:

The disable account status of the event

getException

public java.lang.Exception getException()

Gets the Exception object if set or null

Returns:

The Exception object if set or null