Package com.mendix.modules.email

Class SMTPConfiguration

java.lang.Object

com.mendix.modules.email.SMTPConfiguration

All Implemented Interfaces:

ISMTPConfiguration

public class SMTPConfiguration
extends Object
implements ISMTPConfiguration

Represents an SMTP configuration.

Constructor Summary

Constructors

Constructor	Description
SMTPConfiguration()	Creates an empty default SMTP configuration.
SMTPConfiguration(int smtpPort, String smtpHost, String userName, String userPass, boolean useSSLSMTP, String fromAddress, String replyToAddress)	Instantiate SMTPConfiguration using given parameters.

Method Summary

Modifier and Type	Method	Description
String	getFromAddress()	Returns the From address for sending emails.
String	getReplyToAddress()	Returns the Reply-To address for sending emails.
String	getSMTPHost()	Returns the host name for SMTP.
int	getSMTPPort()	Returns the port number for SMTP.
String	getUserName()	Returns the username for SMTP authentication.
String	getUserPass()	Returns the password for SMTP authentication.
void	setFromAddress(String fromAddress)	Deprecated.
void	setReplyToAddress(String replyToAddress)	Deprecated.
void	setSMTPHost(String host)	Deprecated.
void	setSMTPPort(int port)	Deprecated.
void	setUserName(String userName)	Deprecated.
void	setUserPass(String userPass)	Deprecated.
void	setUseSSLSMTP(boolean useSSLSMTP)	Deprecated.
boolean	useSSLSMTP()	Returns whether to use SSL for SMTP.

Methods inherited from class java.lang.Object

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

Constructor Details

SMTPConfiguration

public SMTPConfiguration()

Creates an empty default SMTP configuration.

SMTPConfiguration

public SMTPConfiguration(int smtpPort,
 String smtpHost,
 String userName,
 String userPass,
 boolean useSSLSMTP,
 String fromAddress,
 String replyToAddress)

Instantiate SMTPConfiguration using given parameters.

Parameters:

smtpPort - smtp port

smtpHost - smtp host

userName - user name

userPass - password

useSSLSMTP - use SSL

fromAddress - from address

replyToAddress - replyTo address

Method Details

useSSLSMTP

public boolean useSSLSMTP()

Description copied from interface: ISMTPConfiguration

Returns whether to use SSL for SMTP.

Specified by:

useSSLSMTP in interface ISMTPConfiguration

Returns:

true if SSL is used, false otherwise

setUseSSLSMTP

@Deprecated
public void setUseSSLSMTP(boolean useSSLSMTP)

Deprecated.

Description copied from interface: ISMTPConfiguration

Sets whether to use SSL for SMTP.

Specified by:

setUseSSLSMTP in interface ISMTPConfiguration

Parameters:

useSSLSMTP - true if SSL is to be used, false otherwise

getSMTPPort

public int getSMTPPort()

Description copied from interface: ISMTPConfiguration

Returns the port number for SMTP.

Specified by:

getSMTPPort in interface ISMTPConfiguration

Returns:

the port number

setSMTPPort

@Deprecated
public void setSMTPPort(int port)

Deprecated.

Description copied from interface: ISMTPConfiguration

Sets the port number for SMTP to the specified value.

Specified by:

setSMTPPort in interface ISMTPConfiguration

Parameters:

port - the port number to set

getSMTPHost

public String getSMTPHost()

Description copied from interface: ISMTPConfiguration

Returns the host name for SMTP.

Specified by:

getSMTPHost in interface ISMTPConfiguration

Returns:

the host name

setSMTPHost

@Deprecated
public void setSMTPHost(String host)

Deprecated.

Description copied from interface: ISMTPConfiguration

Sets the host name for SMTP to the specified value.

Specified by:

setSMTPHost in interface ISMTPConfiguration

Parameters:

host - the host name to set

getUserName

public String getUserName()

Description copied from interface: ISMTPConfiguration

Returns the username for SMTP authentication.

Specified by:

getUserName in interface ISMTPConfiguration

Returns:

the SMTP username

setUserName

@Deprecated
public void setUserName(String userName)

Deprecated.

Description copied from interface: ISMTPConfiguration

Sets the username for SMTP authentication.

Specified by:

setUserName in interface ISMTPConfiguration

Parameters:

userName - the username to set

getUserPass

public String getUserPass()

Description copied from interface: ISMTPConfiguration

Returns the password for SMTP authentication.

Specified by:

getUserPass in interface ISMTPConfiguration

Returns:

the SMTP password

setUserPass

@Deprecated
public void setUserPass(String userPass)

Deprecated.

Description copied from interface: ISMTPConfiguration

Sets the password name for SMTP authentication.

Specified by:

setUserPass in interface ISMTPConfiguration

Parameters:

userPass - the password to set

getFromAddress

public String getFromAddress()

Description copied from interface: ISMTPConfiguration

Returns the From address for sending emails.

Specified by:

getFromAddress in interface ISMTPConfiguration

Returns:

the from address

setFromAddress

@Deprecated
public void setFromAddress(String fromAddress)

Deprecated.

Description copied from interface: ISMTPConfiguration

Sets the From address for SMTP to the specified address.

Specified by:

setFromAddress in interface ISMTPConfiguration

Parameters:

fromAddress - the address from which emails will be sent

getReplyToAddress

public String getReplyToAddress()

Description copied from interface: ISMTPConfiguration

Returns the Reply-To address for sending emails.

Specified by:

getReplyToAddress in interface ISMTPConfiguration

Returns:

the address where replies should go

setReplyToAddress

@Deprecated
public void setReplyToAddress(String replyToAddress)

Deprecated.

Description copied from interface: ISMTPConfiguration

Sets the Reply-To address for SMTP to the specified address. Set to null if no Reply-To headers should be included in emails.

Specified by:

setReplyToAddress in interface ISMTPConfiguration

Parameters:

replyToAddress - the address to which email replies should go, or null if no such header should be included