Interface ISMTPConfiguration
-
- All Known Implementing Classes:
SMTPConfiguration
public interface ISMTPConfigurationProvides the interface for an SMTP configuration.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description java.lang.StringgetFromAddress()Returns the From address for sending emails.java.lang.StringgetReplyToAddress()Returns the Reply-To address for sending emails.java.lang.StringgetSMTPHost()Returns the host name for SMTP.intgetSMTPPort()Returns the port number for SMTP.java.lang.StringgetUserName()Returns the username for SMTP authentication.java.lang.StringgetUserPass()Returns the password for SMTP authentication.voidsetFromAddress(java.lang.String fromAddress)Deprecated.since 9.23.voidsetReplyToAddress(java.lang.String replyToAddress)Deprecated.since 9.23.voidsetSMTPHost(java.lang.String host)Deprecated.since 9.23.voidsetSMTPPort(int port)Deprecated.since 9.23.voidsetUserName(java.lang.String userName)Deprecated.since 9.23.voidsetUserPass(java.lang.String userPass)Deprecated.since 9.23.voidsetUseSSLSMTP(boolean useSSLSMTP)Deprecated.since 9.23.booleanuseSSLSMTP()Returns whether to use SSL for SMTP.
-
-
-
Method Detail
-
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 constructorSMTPConfiguration(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 constructorSMTPConfiguration(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
java.lang.String getSMTPHost()
Returns the host name for SMTP.- Returns:
- the host name
-
setSMTPHost
@Deprecated void setSMTPHost(java.lang.String host)
Deprecated.since 9.23. Use constructorSMTPConfiguration(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
java.lang.String getUserName()
Returns the username for SMTP authentication.- Returns:
- the SMTP username
-
setUserName
@Deprecated void setUserName(java.lang.String userName)
Deprecated.since 9.23. Use constructorSMTPConfiguration(int, String, String, String, boolean, String, String)instead.Sets the username for SMTP authentication.- Parameters:
userName- the username to set
-
getUserPass
java.lang.String getUserPass()
Returns the password for SMTP authentication.- Returns:
- the SMTP password
-
setUserPass
@Deprecated void setUserPass(java.lang.String userPass)
Deprecated.since 9.23. Use constructorSMTPConfiguration(int, String, String, String, boolean, String, String)instead.Sets the password name for SMTP authentication.- Parameters:
userPass- the password to set
-
getFromAddress
java.lang.String getFromAddress()
Returns the From address for sending emails.- Returns:
- the from address
-
setFromAddress
@Deprecated void setFromAddress(java.lang.String fromAddress)
Deprecated.since 9.23. Use constructorSMTPConfiguration(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
java.lang.String getReplyToAddress()
Returns the Reply-To address for sending emails.- Returns:
- the address where replies should go
-
setReplyToAddress
@Deprecated void setReplyToAddress(java.lang.String replyToAddress)
Deprecated.since 9.23. Use constructorSMTPConfiguration(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
-
-