com.crystaldecisions.sdk.plugin.destination.smtp
Interface ISMTPOptions

All Superinterfaces:

IDestinationScheduleOptions

public interface ISMTPOptions
extends IDestinationScheduleOptions

The ISMTPOptions interface allows you to set the global or schedule options to an SMTP email address.

Nested Class Summary

static interface

ISMTPOptions.CeSMTPAuthentication Specifies the authentication type to use against the SMTP server.

Method Summary

IAttachments	getAttachments() Returns the collection used to add, delete, and modify attachments.
IDestinationOutputByDocs	getAttachmentsByDocs() Attachments personalized for individual source documents.
java.util.List	getBCCAddresses() Returns the collection used to add, delete, and modify BCC recipients.
java.util.Set	getBCCRecipients() Returns the collection used to add, delete, and modify BCC recipients as Enterprise users or user groups.
java.util.List	getCCAddresses() Returns the collection used to add, delete, and modify CC recipients.
java.util.Set	getCCRecipients() Returns the collection used to add, delete, and modify CC recipients as Enterprise users or user groups.
java.lang.String	getDelimiter() Returns the email addresses delimiter sent to the mail server, default to semicolon
java.lang.String	getDomainName() Returns the name of the domain where the SMTP server is located.
java.lang.String	getMessage() Returns the message portion of the email message.
int	getPort() Returns the port the SMTP server is attached to.
java.lang.String	getSenderAddress() Returns the address of the sender.
java.lang.String	getServerName() Returns the Host the SMTP Server is running on.
boolean	getSkipMimeHeaders()
int	getSMTPAuthenticationType() Returns the type of authentication to use.
java.lang.String	getSMTPUserName() Returns the user name needed to connect to the SMTP server.
java.lang.String	getSubject() Returns the subject portion of the email message.
java.util.List	getToAddresses() Returns the collection used to add, delete, and modify To recipients.
java.util.Set	getToRecipients() Returns the collection used to add, delete, and modify To recipients as Enterprise users or user groups.
boolean	isAttachmentsEnabled() Returns whether or not using email attachments is enabled.
boolean	isBCCAddressesSet() Indicates whether the collection of BCC recipients exists.
boolean	isBCCRecipientsSet() Indicates whether the collection of BCC Enterprise recipients exists.
boolean	isCCAddressesSet() Indicates whether the collection of CC recipients exists.
boolean	isCCRecipientsSet() Indicates whether the collection of CC Enterprise recipients exists.
boolean	isSMTPPasswordNotEmpty() Returns a boolean indicating whether the password is set and not empty.
boolean	isSMTPPasswordSet() Returns a boolean indicating whether the password is set.
boolean	isSslEnabled() Returns a boolean to indicate if the SSL is enabled.
boolean	isToAddressesSet() Indicates whether the collection of To recipients exists.
boolean	isToRecipientsSet() Indicates whether the collection of To Enterprise recipients exists.
void	setAttachmentsEnabled(boolean bEnabled) Sets whether or not using email attachments is enabled.
void	setDelimiter(java.lang.String sVal) Sets the email addresses delimiter sent to the mail server.
void	setDomainName(java.lang.String sVal) Sets the name of the domain where the SMTP server is located.
void	setEnableSsl(boolean bEnabled) Sets SSL to boolean value: true if enabled and false if disabled.
void	setMessage(java.lang.String sVal) Sets the message portion of the email message.
void	setPort(int iVal) Sets the port the SMTP server is attached to.
void	setSenderAddress(java.lang.String sVal) Sets the address of the sender.
void	setServerName(java.lang.String sVal) Sets the Host the SMTP Server is running on.
void	setSkipMimeHeaders(boolean skip)
void	setSMTPAuthenticationType(int iVal) Sets the type of authentication to use.
void	setSMTPPassword(java.lang.String sVal) Sets the password needed to connect to the SMTP server.
void	setSMTPUserName(java.lang.String sVal) Sets the user name needed to connect to the SMTP server.
void	setSubject(java.lang.String sVal) Sets the subject portion of the email message.

Methods inherited from interface com.crystaldecisions.sdk.plugin.destination.common.IDestinationScheduleOptions

getInputFiles

Method Detail

getDomainName

java.lang.String getDomainName()
                               throws SDKException

Returns the name of the domain where the SMTP server is located.

Returns:

A String containing the name of the domain where the SMTP server is located.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setDomainName

void setDomainName(java.lang.String sVal)

Sets the name of the domain where the SMTP server is located.

Parameters:

sVal - A String containing the name of the domain where the SMTP server is located.

getServerName

java.lang.String getServerName()
                               throws SDKException

Returns the Host the SMTP Server is running on.

Returns:

A String containing the Host the SMTP Server is running on.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setServerName

void setServerName(java.lang.String sVal)

Sets the Host the SMTP Server is running on.

Parameters:

sVal - A String containing the Host the SMTP Server is running on.

getPort

int getPort()
            throws SDKException

Returns the port the SMTP server is attached to. The default is 25.

Returns:

An int specifying the port the SMTP server is attached to.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setPort

void setPort(int iVal)

Sets the port the SMTP server is attached to. The default is 25.

Parameters:

iVal - An int specifying the port the SMTP server is attached to.

getSMTPAuthenticationType

int getSMTPAuthenticationType()
                              throws SDKException

Returns the type of authentication to use.

Returns:

An int specifying the type of authentication to use. This will be of type CeSMTPAuthentication.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

ISMTPOptions.CeSMTPAuthentication

setSMTPAuthenticationType

void setSMTPAuthenticationType(int iVal)

Sets the type of authentication to use.

Parameters:

iVal - An int specifying the type of authentication to use. This should be of type CeSMTPAuthentication.

See Also:

ISMTPOptions.CeSMTPAuthentication

getSMTPUserName

java.lang.String getSMTPUserName()
                                 throws SDKException

Returns the user name needed to connect to the SMTP server.

Returns:

A String containing the user name needed to connect to the SMTP server.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setSMTPUserName

void setSMTPUserName(java.lang.String sVal)

Sets the user name needed to connect to the SMTP server.

Parameters:

sVal - A String containing the user name needed to connect to the SMTP server.

setSMTPPassword

void setSMTPPassword(java.lang.String sVal)

Sets the password needed to connect to the SMTP server.

Parameters:

sVal - A String containing the password needed to connect to the SMTP server.

isSMTPPasswordSet

boolean isSMTPPasswordSet()
                          throws SDKException

Returns a boolean indicating whether the password is set.

Returns:

true if the password is set, false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

isSslEnabled

boolean isSslEnabled()
                     throws SDKException

Returns a boolean to indicate if the SSL is enabled.

Returns:

true if the SSL is enabled, false otherwise.

Throws:

SDKException - This exception is thrown if the process is unsuccessful.

setEnableSsl

void setEnableSsl(boolean bEnabled)

Sets SSL to boolean value: true if enabled and false if disabled.

Parameters:

bEnabled - true, if SSL is enabled, and false otherwise.

isSMTPPasswordNotEmpty

boolean isSMTPPasswordNotEmpty()
                               throws SDKException

Returns a boolean indicating whether the password is set and not empty.

Returns:

true if the password is set and not empty, false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getSenderAddress

java.lang.String getSenderAddress()
                                  throws SDKException

Returns the address of the sender.

Returns:

A String containing the address of the sender.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setSenderAddress

void setSenderAddress(java.lang.String sVal)

Sets the address of the sender.

Parameters:

sVal - A String containing the address of the sender.

getToAddresses

java.util.List getToAddresses()
                              throws SDKException

Returns the collection used to add, delete, and modify To recipients.

Returns:

A List containing the collection used to add, delete, and modify To recipients. This List contains String objects.

Throws:

SDKException - This is thrown if the process is unsuccessful.

isToAddressesSet

boolean isToAddressesSet()

Indicates whether the collection of To recipients exists. Calls to getToAddresses() will create this collection, thus when a destination is sent the server defaults for To recipients will be overriden. To avoid unnecessarily creating the collection of To recipients, call isToAddressesSet() before determining whether to call getToAddresses().

Returns:

A boolean indicating whether the collection of To recipients exists.

getCCAddresses

java.util.List getCCAddresses()
                              throws SDKException

Returns the collection used to add, delete, and modify CC recipients.

Returns:

A List containing the collection used to add, delete, and modify CC recipients. This List contains String objects.

Throws:

SDKException - This is thrown if the process is unsuccessful.

isCCAddressesSet

boolean isCCAddressesSet()

Indicates whether the collection of CC recipients exists. Calls to getCCAddresses() will create this collection, thus when a destination is sent the server defaults for CC addresses will be overriden. To avoid unnecessarily creating the collection of CC recipients, call isCCAddressesSet() before determining whether to call getCCAddresses().

Returns:

A boolean indicating whether the collection of CC recipients exists.

getBCCAddresses

java.util.List getBCCAddresses()
                               throws SDKException

Returns the collection used to add, delete, and modify BCC recipients.

Returns:

A List containing the collection used to add, delete, and modify BCC recipients. This List contains String objects.

Throws:

SDKException - This is thrown if the process is unsuccessful.

isBCCAddressesSet

boolean isBCCAddressesSet()

Indicates whether the collection of BCC recipients exists. Calls to getBCCAddresses() will create this collection, thus when a destination is sent the server defaults for BCC addresses will be overriden. To avoid unnecessarily creating the collection of BCC recipients, call isBCCAddressesSet() before determining whether to call getBCCAddresses().

Returns:

A boolean indicating whether the collection of BCC recipients exists.

getToRecipients

java.util.Set getToRecipients()
                              throws SDKException

Returns the collection used to add, delete, and modify To recipients as Enterprise users or user groups.

Returns:

A Set containing the collection used to add, delete, and modify To recipients as Enterprise users or user groups. This Set contains Integer objects representing IDs for Enterprise users or user groups

Throws:

SDKException - This is thrown if the process is unsuccessful.

isToRecipientsSet

boolean isToRecipientsSet()

Indicates whether the collection of To Enterprise recipients exists. Calls to getToRecipients() will create this collection, thus when a destination is sent the server defaults for To Enterprise recipients will be overriden. To avoid unnecessarily creating the collection of To Enterprise recipients, call isToRecipientsSet() before determining whether to call getToRecipients().

Returns:

A boolean indicating whether the collection of To Enterprise recipients exists.

getCCRecipients

java.util.Set getCCRecipients()
                              throws SDKException

Returns the collection used to add, delete, and modify CC recipients as Enterprise users or user groups.

Returns:

A Set containing the collection used to add, delete, and modify CC recipients as Enterprise users or user groups. This Set contains Integer objects representing IDs for Enterprise users or user groups

Throws:

SDKException - This is thrown if the process is unsuccessful.

isCCRecipientsSet

boolean isCCRecipientsSet()

Indicates whether the collection of CC Enterprise recipients exists. Calls to getCCRecipients() will create this collection, thus when a destination is sent the server defaults for CC Enterprise recipients will be overriden. To avoid unnecessarily creating the collection of CC Enterprise recipients, call isCCRecipientsSet() before determining whether to call getCCRecipients().

Returns:

A boolean indicating whether the collection of CC Enterprise recipients exists.

getBCCRecipients

java.util.Set getBCCRecipients()
                               throws SDKException

Returns the collection used to add, delete, and modify BCC recipients as Enterprise users or user groups.

Returns:

A Set containing the collection used to add, delete, and modify BCC recipients as Enterprise users or user groups. This Set contains Integer objects representing IDs for Enterprise users or user groups

Throws:

SDKException - This is thrown if the process is unsuccessful.

isBCCRecipientsSet

boolean isBCCRecipientsSet()

Indicates whether the collection of BCC Enterprise recipients exists. Calls to getBCCRecipients() will create this collection, thus when a destination is sent the server defaults for BCC Enterprise recipients will be overriden. To avoid unnecessarily creating the collection of BCC Enterprise recipients, call isBCCRecipientsSet() before determining whether to call getBCCRecipients().

Returns:

A boolean indicating whether the collection of BCC Enterprise recipients exists.

getSubject

java.lang.String getSubject()
                            throws SDKException

Returns the subject portion of the email message.

Returns:

A String containing the subject portion of the email message.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setSubject

void setSubject(java.lang.String sVal)

Sets the subject portion of the email message.

Parameters:

sVal - A String containing the subject portion of the email message.

getMessage

java.lang.String getMessage()
                            throws SDKException

Returns the message portion of the email message.

Returns:

A String containing the message portion of the email message.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setMessage

void setMessage(java.lang.String sVal)

Sets the message portion of the email message.

Parameters:

sVal - A String containing the message portion of the email message.

getAttachments

IAttachments getAttachments()
                            throws SDKException

Returns the collection used to add, delete, and modify attachments.

Returns:

An IAttachments object containing the collection used to add, delete, and modify attachments.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getAttachmentsByDocs

IDestinationOutputByDocs getAttachmentsByDocs()
                                              throws SDKException

Attachments personalized for individual source documents. The output is a collection of destination collections associated with each source document. Each element is of type IDestinationOutputPerDoc which, in this case, represents a attachment collection of type IAttachment.

Returns:

IDestinationFilesByDocs A collection of attachment collections associated with each source document.

Throws:

SDKException

isAttachmentsEnabled

boolean isAttachmentsEnabled()
                             throws SDKException

Returns whether or not using email attachments is enabled.

Returns:

true if using email attachments is enabled, and false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setAttachmentsEnabled

void setAttachmentsEnabled(boolean bEnabled)

Sets whether or not using email attachments is enabled.

Parameters:

bEnabled - true if using email attachments is enabled, and false otherwise.

getDelimiter

java.lang.String getDelimiter()
                              throws SDKException

Returns the email addresses delimiter sent to the mail server, default to semicolon

Returns:

A String containing the message portion of the email message.

Throws:

SDKException - This is thrown if the property is not there.

setDelimiter

void setDelimiter(java.lang.String sVal)

Sets the email addresses delimiter sent to the mail server.

Parameters:

sVal - A String containing the delimiter, usually semincolon or comma

getSkipMimeHeaders

boolean getSkipMimeHeaders()

setSkipMimeHeaders

void setSkipMimeHeaders(boolean skip)