com.businessobjects.sdk.plugin.desktop.common
Interface IAlertEmailConfiguration

All Superinterfaces:

IAlertDeliveryConfiguration

public interface IAlertEmailConfiguration
extends IAlertDeliveryConfiguration

This interface exposes configuration settings for delivering alert notifications by email. You can define email configuration settings for the entire system or for an individual event.

Since:

4.0

See Also:

IEvent

Method Summary

boolean	areAttachmentsEnabled() Returns whether or not attachments are enabled.
IAlertDeliveryAttachments	getAttachments() Returns a collection of attachments.
java.util.List	getBCCAddresses() Returns a list of BCC recipients.
java.util.List	getCCAddresses() Returns a list of CC recipients.
java.util.List	getInputFiles() (Optional) Returns a collection of FRS paths to be used as the inputs for attachments.
java.lang.String	getMessage() Returns the message.
java.lang.String	getSenderAddress() Returns the address of the sender.
java.lang.String	getSubject() Returns the subject.
java.util.List	getToAddresses() Returns a list of To recipients.
void	setAttachmentsEnabled(boolean enable) Sets whether attachments are enabled.
void	setMessage(java.lang.String sVal) Sets the message.
void	setSenderAddress(java.lang.String sVal) Sets the address of the sender.
void	setSubject(java.lang.String sVal) Sets the subject.

Methods inherited from interface com.businessobjects.sdk.plugin.desktop.common.IAlertDeliveryConfiguration

isEnabled, setEnabled

Method Detail

getSenderAddress

java.lang.String getSenderAddress()

Returns the address of the sender.

Returns:

A String object that contains the address of the sender.

See Also:

IAlertEmailConfiguration.setSenderAddress(java.lang.String)

setSenderAddress

void setSenderAddress(java.lang.String sVal)

Sets the address of the sender.

Parameters:

sVal - A String object that contains the address of the sender.

See Also:

IAlertEmailConfiguration.getSenderAddress()

getToAddresses

java.util.List getToAddresses()

Returns a list of To recipients. You can modify this list to add, remove or modify To recipients.

Returns:

A List of To recipients.

getCCAddresses

java.util.List getCCAddresses()
                              throws SDKException

Returns a list of CC recipients. You can modify this list to add, remove or modify CC recipients.

Returns:

A List of CC recipients.

Throws:

SDKException

getBCCAddresses

java.util.List getBCCAddresses()
                               throws SDKException

Returns a list of BCC recipients. You can modify this list to add, remove or modify BCC recipients.

Returns:

A List of BCC recipients.

Throws:

SDKException

getSubject

java.lang.String getSubject()

Returns the subject.

Returns:

A String object that contains the subject.

See Also:

IAlertEmailConfiguration.setSubject(java.lang.String)

setSubject

void setSubject(java.lang.String sVal)

Sets the subject.

Parameters:

sVal - A String object that contains the subject.

See Also:

IAlertEmailConfiguration.getSubject()

getMessage

java.lang.String getMessage()

Returns the message.

Returns:

A String object that contains the message.

See Also:

IAlertEmailConfiguration.setMessage(java.lang.String)

setMessage

void setMessage(java.lang.String sVal)

Sets the message.

Parameters:

sVal - A String object that contains the message.

See Also:

IAlertEmailConfiguration.getMessage()

areAttachmentsEnabled

boolean areAttachmentsEnabled()

Returns whether or not attachments are enabled.

Returns:

true if attachments are enabled, false otherwise.

See Also:

IAlertEmailConfiguration.setAttachmentsEnabled(boolean)

setAttachmentsEnabled

void setAttachmentsEnabled(boolean enable)

Sets whether attachments are enabled.

Parameters:

enable - true to enable attachments, false otherwise.

See Also:

IAlertEmailConfiguration.areAttachmentsEnabled()

getAttachments

IAlertDeliveryAttachments getAttachments()

Returns a collection of attachments. You can modify this collection to add, delete, or modify attachments.

Returns:

An IAlertDeliveryAttachments object that contains the attachments.

getInputFiles

java.util.List getInputFiles()

(Optional) Returns a collection of FRS paths to be used as the inputs for attachments. You can modify this collection to add, delete, or modify attachment input. If this is not set or an empty list, then the attachments will use the files associated with Event Source as input. Otherwise, you must make sure the size of the Input Files list equals that of the Attachments.

Returns:

A List<String> object to contain customized FRS paths to the attachments.