io.commercetools.sunrise.email.smtp

Class SmtpConfiguration

java.lang.Object

io.commercetools.sunrise.email.smtp.SmtpConfiguration

public class SmtpConfiguration
extends java.lang.Object

Instances of this class specify how to connect to an SMTP server with a username and password.

See Also:

SmtpAuthEmailSender.SmtpAuthEmailSender(SmtpConfiguration, Executor, int)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SmtpConfiguration.TransportSecurity How to secure the connection to an SMTP server.

Constructor Summary

Constructors

Constructor and Description
SmtpConfiguration(java.lang.String host, int port, SmtpConfiguration.TransportSecurity transportSecurity, java.lang.String username, java.lang.String password) Create a configuration that specifies how to connect to an SMTP server with the given username and password.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getHost()
java.lang.String	getPassword()
int	getPort()
SmtpConfiguration.TransportSecurity	getTransportSecurity()
java.lang.String	getUsername()

Methods inherited from class java.lang.Object

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

Constructor Detail

SmtpConfiguration

public SmtpConfiguration(@Nonnull
                         java.lang.String host,
                         int port,
                         @Nonnull
                         SmtpConfiguration.TransportSecurity transportSecurity,
                         @Nonnull
                         java.lang.String username,
                         @Nonnull
                         java.lang.String password)

Create a configuration that specifies how to connect to an SMTP server with the given username and password.

Parameters:

host - the name of the host running the SMTP server to use

port - the port of the SMTP server to use

transportSecurity - how to secure the SMTP connection

username - the username to use for authenticating with the SMTP server

password - the password to authenticate with

Method Detail

getHost

public java.lang.String getHost()

Returns:

the name of the host running the SMTP server to use

getPort

public int getPort()

Returns:

the port of the SMTP server to use

getTransportSecurity

public SmtpConfiguration.TransportSecurity getTransportSecurity()

Returns:

how to secure the SMTP connection

getUsername

public java.lang.String getUsername()

Returns:

the username to use for authenticating with the SMTP server

getPassword

public java.lang.String getPassword()

Returns:

the password to authenticate with