Package com.hubspot.smtp.client

This package contains classes to create and maintain connections to SMTP servers.

See: Description

Interface Summary

Interface	Description
SendInterceptor	An extension point that supports intercepting commands and data before they are sent.

Class Summary

Class	Description
CompositeSendInterceptor	A chain of SendInterceptor instances that will call each other in turn.
EhloResponse	The parsed response to the EHLO command.
SmtpClientResponse	Wraps the session and the responses to one or more SMTP commands.
SmtpSession	An open connection to an SMTP server which can be used to send messages and other commands.
SmtpSessionConfig	Immutable implementation of AbstractSmtpSessionConfig.
SmtpSessionConfig.Builder	Builds instances of type SmtpSessionConfig.
SmtpSessionFactory	Creates SmtpSession instances by connecting to remote servers.
SmtpSessionFactoryConfig	Immutable implementation of AbstractSmtpSessionFactoryConfig.
SmtpSessionFactoryConfig.Builder	Builds instances of type SmtpSessionFactoryConfig.
Utf8SmtpRequestEncoder
Utf8SmtpResponseDecoder

Enum Summary

Enum	Description
Extension	An Extended SMTP feature.

Exception Summary

Exception	Description
ChannelClosedException
MessageTooLargeException	Unchecked exception thrown when the provided content is too large to be sent according to the server's EHLO response.
NoopErrorResponseException	Unchecked exception thrown when an error was received in response to a NOOP command.
ResponseException
SmtpException	A base exception that incorporates a connection ID into the exception message.

Package com.hubspot.smtp.client Description

This package contains classes to create and maintain connections to SMTP servers.

To connect to a remote server:

1. Create a SmtpSessionFactoryConfig to define application-wide settings
2. Pass this to the SmtpSessionFactory constructor to create a factory
3. Create a SmtpSessionConfig to specify the address of a remote server
4. Call SmtpSessionFactory.connect(com.hubspot.smtp.client.SmtpSessionConfig) with this configuration

Once you have an active session, you can send emails:

1. Initialise the connection by calling SmtpSession.send(io.netty.handler.codec.smtp.SmtpRequest) with an EHLO command
2. Optionally enable TLS encryption by calling SmtpSession.startTls() if TLS is supported
3. Send an email by calling SmtpSession.send(java.lang.String, java.lang.String, com.hubspot.smtp.messages.MessageContent) or one of its overloads.