org.subethamail.smtp

Interface MessageContext

All Known Implementing Classes:

Session

public interface MessageContext

Interface which provides context to the message handlers.

Author:

Jeff Schnitzer

Method Summary

Modifier and Type	Method and Description
Optional<AuthenticationHandler>	getAuthenticationHandler()
Optional<String>	getHelo()
SocketAddress	getRemoteAddress()
default String	getSessionId() Returns the unique id of the session associated with this message.
SMTPServer	getSMTPServer()
Certificate[]	getTlsPeerCertificates() Returns the identity of the peer which was established as part of the TLS handshake as defined by SSLSession.getPeerCertificates().

Method Detail

getSMTPServer

SMTPServer getSMTPServer()

Returns:

the SMTPServer object.

getRemoteAddress

SocketAddress getRemoteAddress()

Returns:

the IP address of the remote server.

Note that the returned object is always an instance of InetSocketAddress so you can cast the returned object to that class for more information. In subethasmtp 6.x the method return type will be changed to InetSocketAddress.

getSessionId

default String getSessionId()

Returns the unique id of the session associated with this message.

getAuthenticationHandler

Optional<AuthenticationHandler> getAuthenticationHandler()

Returns:

the handler instance that was used to authenticate.

getHelo

Optional<String> getHelo()

Returns:

the host name or address literal the client supplied in the HELO or EHLO command, or empty if neither of these commands were received yet. Note that SubEthaSMTP (along with some MTAs, but contrary to RFC 5321) accept mail transactions without these commands.

getTlsPeerCertificates

Certificate[] getTlsPeerCertificates()

Returns the identity of the peer which was established as part of the TLS handshake as defined by SSLSession.getPeerCertificates().

In order to get this information, override SMTPServer.createSSLSocket(java.net.Socket) and call setNeedClientAuth(true) on the created socket.

Returns:

an ordered array of peer certificates, with the peer's own certificate first followed by any certificate authorities, or null (?) when no such information is available

See Also:

SSLSession.getPeerCertificates()