com.spacecode.sdk.network.alert

Class SmtpServer

java.lang.Object

com.spacecode.sdk.network.alert.SmtpServer

public class SmtpServer
extends java.lang.Object

SmtpServer is used by TcpDevice class in order to set/get SMTP server information (alerts raising).

Constructor Summary

Constructors

Constructor and Description
SmtpServer(java.lang.String address, int port, java.lang.String username, java.lang.String password, boolean sslEnabled) Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAddress()
java.lang.String	getPassword()
int	getPort()
java.lang.String	getUsername()
boolean	isSslEnabled()
void	setAddress(java.lang.String address) Update the address of the SMTP server.
void	setPassword(java.lang.String password) Update the password used to authenticate on SMTP server.
void	setPort(int port) Update the TCP port number used by the SMTP server.
void	setSslEnabled(boolean sslEnabled) Update the SSL protocol state.
void	setUsername(java.lang.String username) Update the username used to authenticate on SMTP server.

Methods inherited from class java.lang.Object

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

Constructor Detail

SmtpServer

public SmtpServer(java.lang.String address,
          int port,
          java.lang.String username,
          java.lang.String password,
          boolean sslEnabled)

Default constructor.

Parameters:

address - SMTP server address.

port - SMTP server TCP port.

username - Username to access the SMTP server. Can be left null or blank.

password - Password to access the SMTP server. Can be left null or blank.

sslEnabled - True if SSL protocol should be used for authentication.

Throws:

java.lang.IllegalArgumentException - In case of invalid parameter.

Method Detail

getAddress

public java.lang.String getAddress()

Returns:

Server address.

setAddress

public void setAddress(java.lang.String address)

Update the address of the SMTP server.

Parameters:

address - New address.

Throws:

java.lang.IllegalArgumentException - In case of invalid parameter.

getPort

public int getPort()

Returns:

Server port.

setPort

public void setPort(int port)

Update the TCP port number used by the SMTP server.

Parameters:

port - New port number.

Throws:

java.lang.IllegalArgumentException - In case of invalid parameter.

getUsername

public java.lang.String getUsername()

Returns:

Username used to authenticate on SMTP server.

setUsername

public void setUsername(java.lang.String username)

Update the username used to authenticate on SMTP server.

Parameters:

username - New username (null is equivalent to empty).

getPassword

public java.lang.String getPassword()

Returns:

Password used to authenticate on SMTP server.

setPassword

public void setPassword(java.lang.String password)

Update the password used to authenticate on SMTP server.

Parameters:

password - New password (null is equivalent to empty).

isSslEnabled

public boolean isSslEnabled()

Returns:

True if SSL is enabled, false otherwise.

setSslEnabled

public void setSslEnabled(boolean sslEnabled)

Update the SSL protocol state.

Parameters:

sslEnabled - If true, SSL protocol will be enabled. If false, it will be disabled.