Package org.apache.commons.net.smtp
Class SMTPSClient
java.lang.Object
org.apache.commons.net.SocketClient
org.apache.commons.net.smtp.SMTP
org.apache.commons.net.smtp.SMTPClient
org.apache.commons.net.smtp.SMTPSClient
- Direct Known Subclasses:
AuthenticatingSMTPClient
SMTP over SSL processing. Copied from FTPSClient.java and modified to suit SMTP. If implicit mode is selected (NOT the default), SSL/TLS negotiation starts
right after the connection has been established. In explicit mode (the default), SSL/TLS negotiation starts when the user calls execTLS() and the server
accepts the command. Implicit usage:
SMTPSClient c = new SMTPSClient(true);
c.connect("127.0.0.1", 465);
Explicit usage:
SMTPSClient c = new SMTPSClient();
c.connect("127.0.0.1", 25);
if (c.execTLS()) {
// Rest of the commands here
}
Warning: the hostname is not verified against the certificate by default, use setHostnameVerifier(HostnameVerifier) or
setEndpointCheckingEnabled(boolean) (on Java 1.7+) to enable verification.- Since:
- 3.0
-
Field Summary
Fields inherited from class org.apache.commons.net.smtp.SMTP
_commandSupport_, DEFAULT_PORT, encodingFields inherited from class org.apache.commons.net.SocketClient
_defaultPort_, _hostname_, _input_, _output_, _serverSocketFactory_, _socket_, _socketFactory_, _timeout_, connectTimeout, NETASCII_EOL, remoteInetSocketAddress -
Constructor Summary
ConstructorsConstructorDescriptionConstructor for SMTPSClient, usingDEFAULT_PROTOCOLi.e.SMTPSClient(boolean implicit) Constructor for SMTPSClient, usingDEFAULT_PROTOCOLi.e.SMTPSClient(boolean implicit, SSLContext ctx) Constructor for SMTPSClient, usingDEFAULT_PROTOCOLi.e.SMTPSClient(String proto) Constructor for SMTPSClient, using explicit security mode.SMTPSClient(String proto, boolean implicit) Constructor for SMTPSClient.SMTPSClient(String proto, boolean implicit, String encoding) Constructor for SMTPSClient.SMTPSClient(SSLContext context) Constructor for SMTPSClient. -
Method Summary
Modifier and TypeMethodDescriptionprotected voidBecause there are so many connect() methods, the _connectAction_() method is provided as a means of performing some action immediately after establishing a connection, rather than reimplementing all the connect() methods.booleanexecTLS()The TLS command execution.String[]Returns the names of the cipher suites which could be enabled for use on this connection.String[]Returns the names of the protocol versions which are currently enabled for use on this connection.Gets the currently configuredHostnameVerifier.Gets theKeyManagerinstance.Gets the currently configuredTrustManager.booleanReturn whether or not endpoint identification using the HTTPS algorithm on Java 1.7+ is enabled.voidsetEnabledCipherSuites(String[] cipherSuites) Controls which particular cipher suites are enabled for use on this connection.voidsetEnabledProtocols(String[] protocolVersions) Controls which particular protocol versions are enabled for use on this connection.voidsetEndpointCheckingEnabled(boolean enable) Automatic endpoint identification checking using the HTTPS algorithm is supported on Java 1.7+.voidsetHostnameVerifier(HostnameVerifier newHostnameVerifier) Override the defaultHostnameVerifierto use.voidsetKeyManager(KeyManager newKeyManager) Sets aKeyManagerto use.voidsetTrustManager(TrustManager newTrustManager) Override the defaultTrustManagerto use.Methods inherited from class org.apache.commons.net.smtp.SMTPClient
addRecipient, addRecipient, completePendingCommand, listHelp, listHelp, login, login, logout, reset, sendMessageData, sendNoOp, sendShortMessageData, sendSimpleMessage, sendSimpleMessage, setSender, setSender, verifyMethods inherited from class org.apache.commons.net.smtp.SMTP
data, disconnect, expn, getCommandSupport, getReply, getReplyCode, getReplyString, getReplyStrings, helo, help, help, mail, noop, quit, rcpt, removeProtocolCommandistener, rset, saml, send, sendCommand, sendCommand, sendCommand, sendCommand, soml, turn, vrfyMethods inherited from class org.apache.commons.net.SocketClient
addProtocolCommandListener, applySocketAttributes, checkOpenOutputStream, connect, connect, connect, connect, connect, connect, createCommandSupport, fireCommandSent, fireReplyReceived, getCharset, getCharsetName, getConnectTimeout, getDefaultPort, getDefaultTimeout, getKeepAlive, getLocalAddress, getLocalPort, getProxy, getReceiveBufferSize, getRemoteAddress, getRemoteInetSocketAddress, getRemotePort, getSendBufferSize, getServerSocketFactory, getSoLinger, getSoTimeout, getTcpNoDelay, isAvailable, isConnected, removeProtocolCommandListener, setCharset, setConnectTimeout, setDefaultPort, setDefaultTimeout, setKeepAlive, setProxy, setReceiveBufferSize, setSendBufferSize, setServerSocketFactory, setSocketFactory, setSoLinger, setSoTimeout, setTcpNoDelay, verifyRemote
-
Constructor Details
-
SMTPSClient
public SMTPSClient()Constructor for SMTPSClient, usingDEFAULT_PROTOCOLi.e. TLS Sets security mode to explicit (isImplicit = false). -
SMTPSClient
Constructor for SMTPSClient, usingDEFAULT_PROTOCOLi.e. TLS- Parameters:
implicit- The security mode,truefor implicit,falsefor explicit
-
SMTPSClient
Constructor for SMTPSClient, usingDEFAULT_PROTOCOLi.e. TLS- Parameters:
implicit- The security mode,truefor implicit,falsefor explicitctx- A pre-configured SSL Context.
-
SMTPSClient
Constructor for SMTPSClient.- Parameters:
context- A pre-configured SSL Context.- See Also:
-
SMTPSClient
Constructor for SMTPSClient, using explicit security mode.- Parameters:
proto- the protocol.
-
SMTPSClient
Constructor for SMTPSClient.- Parameters:
proto- the protocol.implicit- The security mode,truefor implicit,falsefor explicit
-
SMTPSClient
Constructor for SMTPSClient.- Parameters:
proto- the protocol.implicit- The security mode,truefor implicit,falsefor explicitencoding- the encoding- Since:
- 3.3
-
-
Method Details
-
_connectAction_
Because there are so many connect() methods, the _connectAction_() method is provided as a means of performing some action immediately after establishing a connection, rather than reimplementing all the connect() methods.- Overrides:
_connectAction_in classSMTP- Throws:
IOException- If it is thrown by _connectAction_().- See Also:
-
execTLS
The TLS command execution.- Returns:
- TRUE if the command and negotiation succeeded.
- Throws:
IOException- If an I/O error occurs while sending the command or performing the negotiation.
-
getEnabledCipherSuites
Returns the names of the cipher suites which could be enabled for use on this connection. When the underlyingSocketis not anSSLSocketinstance, returns null.- Returns:
- An array of cipher suite names, or
null.
-
getEnabledProtocols
Returns the names of the protocol versions which are currently enabled for use on this connection. When the underlyingSocketis not anSSLSocketinstance, returns null.- Returns:
- An array of protocols, or
null.
-
getHostnameVerifier
Gets the currently configuredHostnameVerifier.- Returns:
- A HostnameVerifier instance.
- Since:
- 3.4
-
getKeyManager
Gets theKeyManagerinstance.- Returns:
- The current
KeyManagerinstance.
-
getTrustManager
Gets the currently configuredTrustManager.- Returns:
- A TrustManager instance.
-
isEndpointCheckingEnabled
Return whether or not endpoint identification using the HTTPS algorithm on Java 1.7+ is enabled. The default behavior is for this to be disabled.- Returns:
- True if enabled, false if not.
- Since:
- 3.4
-
setEnabledCipherSuites
Controls which particular cipher suites are enabled for use on this connection. Called before server negotiation.- Parameters:
cipherSuites- The cipher suites.
-
setEnabledProtocols
Controls which particular protocol versions are enabled for use on this connection. I perform setting before a server negotiation.- Parameters:
protocolVersions- The protocol versions.
-
setEndpointCheckingEnabled
Automatic endpoint identification checking using the HTTPS algorithm is supported on Java 1.7+. The default behavior is for this to be disabled.- Parameters:
enable- Enable automatic endpoint identification checking using the HTTPS algorithm on Java 1.7+.- Since:
- 3.4
-
setHostnameVerifier
Override the defaultHostnameVerifierto use.- Parameters:
newHostnameVerifier- The HostnameVerifier implementation to set ornullto disable.- Since:
- 3.4
-
setKeyManager
Sets aKeyManagerto use.- Parameters:
newKeyManager- The KeyManager implementation to set.- See Also:
-
setTrustManager
Override the defaultTrustManagerto use.- Parameters:
newTrustManager- The TrustManager implementation to set.- See Also:
-