Package com.mendix.modules.email
Class SMTPConfiguration
- java.lang.Object
-
- com.mendix.modules.email.SMTPConfiguration
-
- All Implemented Interfaces:
ISMTPConfiguration
public class SMTPConfiguration extends java.lang.Object implements ISMTPConfiguration
Represents an SMTP configuration.
-
-
Constructor Summary
Constructors Constructor Description SMTPConfiguration()
Creates an empty default SMTP configuration.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getFromAddress()
Returns the From address for sending emails.java.lang.String
getReplyToAddress()
Returns the Reply-To address for sending emails.java.lang.String
getSMTPHost()
Returns the host name for SMTP.int
getSMTPPort()
Returns the port number for SMTP.java.lang.String
getUserName()
Returns the user name for SMTP authentication.java.lang.String
getUserPass()
Returns the password for SMTP authentication.void
setFromAddress(java.lang.String fromAddress)
Sets the From address for SMTP to the specified address.void
setReplyToAddress(java.lang.String replyToAddress)
Sets the Reply-To address for SMTP to the specified address.void
setSMTPHost(java.lang.String host)
Sets the host name for SMTP to the specified value.void
setSMTPPort(int port)
Sets the port number for SMTP to the specified value.void
setUserName(java.lang.String userName)
Sets the user name for SMTP authentication.void
setUserPass(java.lang.String userPass)
Sets the password name for SMTP authentication.void
setUseSSLSMTP(boolean useSSLSMTP)
Sets whether to use SSL for SMTP.boolean
useSSLSMTP()
Returns whether to use SSL for SMTP.
-
-
-
Method Detail
-
useSSLSMTP
public boolean useSSLSMTP()
Description copied from interface:ISMTPConfiguration
Returns whether to use SSL for SMTP.- Specified by:
useSSLSMTP
in interfaceISMTPConfiguration
- Returns:
- true if SSL is used, false otherwise
-
setUseSSLSMTP
public void setUseSSLSMTP(boolean useSSLSMTP)
Description copied from interface:ISMTPConfiguration
Sets whether to use SSL for SMTP.- Specified by:
setUseSSLSMTP
in interfaceISMTPConfiguration
- 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 interfaceISMTPConfiguration
- Returns:
- the port number
-
setSMTPPort
public void setSMTPPort(int port)
Description copied from interface:ISMTPConfiguration
Sets the port number for SMTP to the specified value.- Specified by:
setSMTPPort
in interfaceISMTPConfiguration
- Parameters:
port
- the port number to set
-
getSMTPHost
public java.lang.String getSMTPHost()
Description copied from interface:ISMTPConfiguration
Returns the host name for SMTP.- Specified by:
getSMTPHost
in interfaceISMTPConfiguration
- Returns:
- the host name
-
setSMTPHost
public void setSMTPHost(java.lang.String host)
Description copied from interface:ISMTPConfiguration
Sets the host name for SMTP to the specified value.- Specified by:
setSMTPHost
in interfaceISMTPConfiguration
- Parameters:
host
- the host name to set
-
getUserName
public java.lang.String getUserName()
Description copied from interface:ISMTPConfiguration
Returns the user name for SMTP authentication.- Specified by:
getUserName
in interfaceISMTPConfiguration
- Returns:
- the SMTP user name
-
setUserName
public void setUserName(java.lang.String userName)
Description copied from interface:ISMTPConfiguration
Sets the user name for SMTP authentication.- Specified by:
setUserName
in interfaceISMTPConfiguration
- Parameters:
userName
- the user name to set
-
getUserPass
public java.lang.String getUserPass()
Description copied from interface:ISMTPConfiguration
Returns the password for SMTP authentication.- Specified by:
getUserPass
in interfaceISMTPConfiguration
- Returns:
- the SMTP password
-
setUserPass
public void setUserPass(java.lang.String userPass)
Description copied from interface:ISMTPConfiguration
Sets the password name for SMTP authentication.- Specified by:
setUserPass
in interfaceISMTPConfiguration
- Parameters:
userPass
- the password to set
-
getFromAddress
public java.lang.String getFromAddress()
Description copied from interface:ISMTPConfiguration
Returns the From address for sending emails.- Specified by:
getFromAddress
in interfaceISMTPConfiguration
- Returns:
- the from address
-
setFromAddress
public void setFromAddress(java.lang.String fromAddress)
Description copied from interface:ISMTPConfiguration
Sets the From address for SMTP to the specified address.- Specified by:
setFromAddress
in interfaceISMTPConfiguration
- Parameters:
fromAddress
- the address from which emails will be sent
-
getReplyToAddress
public java.lang.String getReplyToAddress()
Description copied from interface:ISMTPConfiguration
Returns the Reply-To address for sending emails.- Specified by:
getReplyToAddress
in interfaceISMTPConfiguration
- Returns:
- the address where replies should go
-
setReplyToAddress
public void setReplyToAddress(java.lang.String replyToAddress)
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 interfaceISMTPConfiguration
- Parameters:
replyToAddress
- the address to which email replies should go, or null if no such header should be included
-
-