Package com.mendix.modules.email.interfaces

Interface ISMTPConfiguration

All Known Implementing Classes:

SMTPConfiguration

public interface ISMTPConfiguration

Provides the interface for an SMTP configuration.

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. since 9.23.
void	setReplyToAddress(String replyToAddress)	Deprecated. since 9.23.
void	setSMTPHost(String host)	Deprecated. since 9.23.
void	setSMTPPort(int port)	Deprecated. since 9.23.
void	setUserName(String userName)	Deprecated. since 9.23.
void	setUserPass(String userPass)	Deprecated. since 9.23.
void	setUseSSLSMTP(boolean useSSLSMTP)	Deprecated. since 9.23.
boolean	useSSLSMTP()	Returns whether to use SSL for SMTP.

Method Details

useSSLSMTP

boolean useSSLSMTP()

Returns whether to use SSL for SMTP.

Returns:

true if SSL is used, false otherwise

setUseSSLSMTP

@Deprecated
void setUseSSLSMTP(boolean useSSLSMTP)

Deprecated.

since 9.23. Use constructor SMTPConfiguration(int, String, String, String, boolean, String, String) instead.

Sets whether to use SSL for SMTP.

Parameters:

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

getSMTPPort

int getSMTPPort()

Returns the port number for SMTP.

Returns:

the port number

setSMTPPort

@Deprecated
void setSMTPPort(int port)

Deprecated.

since 9.23. Use constructor SMTPConfiguration(int, String, String, String, boolean, String, String) instead.

Sets the port number for SMTP to the specified value.

Parameters:

port - the port number to set

getSMTPHost

String getSMTPHost()

Returns the host name for SMTP.

Returns:

the host name

setSMTPHost

@Deprecated
void setSMTPHost(String host)

Deprecated.

since 9.23. Use constructor SMTPConfiguration(int, String, String, String, boolean, String, String) instead.

Sets the host name for SMTP to the specified value.

Parameters:

host - the host name to set

getUserName

String getUserName()

Returns the username for SMTP authentication.

Returns:

the SMTP username

setUserName

@Deprecated
void setUserName(String userName)

Deprecated.

since 9.23. Use constructor SMTPConfiguration(int, String, String, String, boolean, String, String) instead.

Sets the username for SMTP authentication.

Parameters:

userName - the username to set

getUserPass

String getUserPass()

Returns the password for SMTP authentication.

Returns:

the SMTP password

setUserPass

@Deprecated
void setUserPass(String userPass)

Deprecated.

since 9.23. Use constructor SMTPConfiguration(int, String, String, String, boolean, String, String) instead.

Sets the password name for SMTP authentication.

Parameters:

userPass - the password to set

getFromAddress

String getFromAddress()

Returns the From address for sending emails.

Returns:

the from address

setFromAddress

@Deprecated
void setFromAddress(String fromAddress)

Deprecated.

since 9.23. Use constructor SMTPConfiguration(int, String, String, String, boolean, String, String) instead.

Sets the From address for SMTP to the specified address.

Parameters:

fromAddress - the address from which emails will be sent

getReplyToAddress

String getReplyToAddress()

Returns the Reply-To address for sending emails.

Returns:

the address where replies should go

setReplyToAddress

@Deprecated
void setReplyToAddress(String replyToAddress)

Deprecated.

since 9.23. Use constructor SMTPConfiguration(int, String, String, String, boolean, String, String) instead.

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

Parameters:

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