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

public interface ISMTPOptions

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.
java.util.List	getCCAddresses() Returns the collection used to add, delete, and modify CC recipients.
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.
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.
boolean	isAttachmentsEnabled() Returns whether or not using email attachments is enabled.
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.
void	setAttachmentsEnabled(boolean bEnabled) Sets whether or not using email attachments is enabled.
void	setDomainName(java.lang.String sVal) Sets the name of the domain where the SMTP server is located.
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	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.

Method Detail

getDomainName

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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.

isSMTPPasswordNotEmpty

public 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

public 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

public void setSenderAddress(java.lang.String sVal)

Sets the address of the sender.

Parameters:

sVal - A String containing the address of the sender.

getToAddresses

public 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.

getCCAddresses

public 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.

getSubject

public 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

public 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

public 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

public 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

public 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.

isAttachmentsEnabled

public 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

public 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.