A B C D E F G H I L M N O P Q R S T U V W

A

AbstractMessageHandler - Class in org.subethamail.smtp.server

A simple base class to make implementing message handlers easier.

AbstractMessageHandler(MessageContext, AuthenticationHandler) - Constructor for class org.subethamail.smtp.server.AbstractMessageHandler

accept(String, String) - Method in interface org.subethamail.smtp.MessageListener

Called once for every RCPT TO during a SMTP exchange.

accept(String, String) - Method in class org.subethamail.wiser.Wiser

Always accept everything

addCommand(Command) - Method in class org.subethamail.smtp.server.CommandHandler

Adds a new command to the map.

addPlugin(AuthenticationHandler) - Method in class org.subethamail.smtp.auth.PluginAuthenticationHandler

addRecipient() - Method in class org.subethamail.smtp.server.Session

announceTLS() - Method in class org.subethamail.smtp.server.SMTPServer

asArray(ByteBuffer) - Static method in class org.subethamail.smtp.server.SMTPCodecDecoder

auth(String, StringBuilder, ConnectionContext) - Method in class org.subethamail.smtp.auth.DummyAuthenticationHandler

auth(String, StringBuilder, ConnectionContext) - Method in class org.subethamail.smtp.auth.LoginAuthenticationHandler

auth(String, StringBuilder, ConnectionContext) - Method in class org.subethamail.smtp.auth.PlainAuthenticationHandler

auth(String, StringBuilder, ConnectionContext) - Method in class org.subethamail.smtp.auth.PluginAuthenticationHandler

auth(String, StringBuilder, ConnectionContext) - Method in interface org.subethamail.smtp.AuthenticationHandler

Initially called using an input string in the RFC2554 form: "AUTH [initial-response]".

auth(String, StringBuilder, ConnectionContext) - Method in class org.subethamail.smtp.server.AbstractMessageHandler

AUTH_CANCEL_COMMAND - Static variable in class org.subethamail.smtp.command.AuthCommand

AuthCommand - Class in org.subethamail.smtp.command

AuthCommand() - Constructor for class org.subethamail.smtp.command.AuthCommand

Creates a new instance of AuthCommand

AuthenticationHandler - Interface in org.subethamail.smtp

The interface that enables challenge-response communication necessary for SMTP AUTH.

AuthenticationHandlerFactory - Interface in org.subethamail.smtp

B

Base64 - Class in org.subethamail.smtp.util

A very fast and memory efficient class to encode and decode to and from BASE64 in full accordance with RFC 2045.

On Windows XP sp1 with 1.4.2_04 and later ;), this encoder and decoder is about 10 times faster on small arrays (10 - 1000 bytes) and 2-3 times as fast on larger arrays (10000 - 1000000 bytes) compared to sun.misc.Encoder()/Decoder().

On byte arrays the encoder is about 20% faster than Jakarta Commons Base64 Codec for encode and about 50% faster for decoding large arrays.

Base64() - Constructor for class org.subethamail.smtp.util.Base64

BaseCommand - Class in org.subethamail.smtp.server

BaseCommand(String, String) - Constructor for class org.subethamail.smtp.server.BaseCommand

BaseCommand(String, String, String) - Constructor for class org.subethamail.smtp.server.BaseCommand

BaseContext - Interface in org.subethamail.smtp.server

Interface which provides a basic context interface.

C

CharTerminatedInputStream - Class in org.subethamail.smtp.server.io

An InputStream class that terminates the stream when it encounters a particular byte sequence.

CharTerminatedInputStream(InputStream, char[]) - Constructor for class org.subethamail.smtp.server.io.CharTerminatedInputStream

A constructor for this object that takes a stream to be wrapped and a terminating character sequence.

checkClientTrusted(X509Certificate[], String) - Method in class org.subethamail.smtp.server.io.DummySSLSocketFactory.DummyTrustManager

checkServerTrusted(X509Certificate[], String) - Method in class org.subethamail.smtp.server.io.DummySSLSocketFactory.DummyTrustManager

close() - Method in class org.subethamail.smtp.server.io.CharTerminatedInputStream

close() - Method in class org.subethamail.smtp.server.io.DotUnstuffingInputStream

close() - Method in class org.subethamail.smtp.server.io.SharedTmpFileInputStream

Command - Interface in org.subethamail.smtp.server

Describes a SMTP command

CommandException - Exception in org.subethamail.smtp.server

CommandException(String, Throwable) - Constructor for exception org.subethamail.smtp.server.CommandException

CommandException(String) - Constructor for exception org.subethamail.smtp.server.CommandException

CommandException() - Constructor for exception org.subethamail.smtp.server.CommandException

CommandException(Throwable) - Constructor for exception org.subethamail.smtp.server.CommandException

CommandHandler - Class in org.subethamail.smtp.server

This class manages execution of a SMTP command.

CommandHandler() - Constructor for class org.subethamail.smtp.server.CommandHandler

Populates a default set of commands based on what is in the CommandRegistry.

CommandHandler(Collection<Command>) - Constructor for class org.subethamail.smtp.server.CommandHandler

Pass in a Collection of Command objects.

CommandRegistry - Enum in org.subethamail.smtp.server

Enumerates all the Commands made available in this release.

ConnectionContext - Interface in org.subethamail.smtp.server

This context is used for managing information about a connection.

ConnectionHandler - Class in org.subethamail.smtp.server

The IoHandler that handles a connection.

ConnectionHandler(SMTPServer) - Constructor for class org.subethamail.smtp.server.ConnectionHandler

ConnectionHandler.Context - Class in org.subethamail.smtp.server

ConnectionHandler.Context(SMTPServer, IoSession) - Constructor for class org.subethamail.smtp.server.ConnectionHandler.Context

containsCommand(String) - Method in class org.subethamail.smtp.server.CommandHandler

Does the map contain the named command?

CONTEXT_ATTRIBUTE - Static variable in class org.subethamail.smtp.server.ConnectionHandler

create() - Method in interface org.subethamail.smtp.AuthenticationHandlerFactory

create(MessageContext) - Method in interface org.subethamail.smtp.MessageHandlerFactory

Called for the exchange of a single message during an SMTP conversation.

create(MessageContext) - Method in class org.subethamail.smtp.server.MessageListenerAdapter

create() - Method in class org.subethamail.wiser.Wiser.AuthHandlerFactory

createSocket(Socket, String, int, boolean) - Method in class org.subethamail.smtp.server.io.DummySSLSocketFactory

createSocket(InetAddress, int, InetAddress, int) - Method in class org.subethamail.smtp.server.io.DummySSLSocketFactory

createSocket(InetAddress, int) - Method in class org.subethamail.smtp.server.io.DummySSLSocketFactory

createSocket(String, int, InetAddress, int) - Method in class org.subethamail.smtp.server.io.DummySSLSocketFactory

createSocket(String, int) - Method in class org.subethamail.smtp.server.io.DummySSLSocketFactory

createSocket() - Method in class org.subethamail.smtp.server.io.DummySSLSocketFactory

Credential - Class in org.subethamail.smtp.auth

Holds the identity of a logged in user.

Credential(String) - Constructor for class org.subethamail.smtp.auth.Credential

Creates a new instance of Credential

D

data(InputStream) - Method in interface org.subethamail.smtp.MessageHandler

Called when the DATA part of the SMTP exchange begins.

data(InputStream) - Method in class org.subethamail.smtp.server.DefaultMessageHandler

Implementation of the data receiving portion of things.

DataCommand - Class in org.subethamail.smtp.command

DataCommand() - Constructor for class org.subethamail.smtp.command.DataCommand

DataEndCommand - Class in org.subethamail.smtp.command

Data command splitted to adapt to MINA framework.

DataEndCommand() - Constructor for class org.subethamail.smtp.command.DataEndCommand

decode(IoSession, ByteBuffer, ProtocolDecoderOutput) - Method in class org.subethamail.smtp.server.SMTPCodecDecoder

decode(char[]) - Static method in class org.subethamail.smtp.util.Base64

Decodes a BASE64 encoded char array.

decode(byte[]) - Static method in class org.subethamail.smtp.util.Base64

Decodes a BASE64 encoded byte array.

decode(String) - Static method in class org.subethamail.smtp.util.Base64

Decodes a BASE64 encoded String.

decodeFast(char[]) - Static method in class org.subethamail.smtp.util.Base64

Decodes a BASE64 encoded char array that is known to be resonably well formatted.

decodeFast(byte[]) - Static method in class org.subethamail.smtp.util.Base64

Decodes a BASE64 encoded byte array that is known to be resonably well formatted.

decodeFast(String) - Static method in class org.subethamail.smtp.util.Base64

Decodes a BASE64 encoded string that is known to be resonably well formatted.

DEFAULT_CHARSET - Static variable in class org.subethamail.smtp.server.SMTPServer

DEFAULT_DATA_DEFERRED_SIZE - Static variable in class org.subethamail.smtp.server.SMTPServer

4 megs by default.

DefaultMessageHandler - Class in org.subethamail.smtp.server

Default class that extends the AbstractMessageHandler class.

DefaultMessageHandler(MessageContext, AuthenticationHandler) - Constructor for class org.subethamail.smtp.server.DefaultMessageHandler

DefaultMessageHandler.Delivery - Class in org.subethamail.smtp.server

Needed by this class to track which listeners need delivery.

DefaultMessageHandler.Delivery(MessageListener, String) - Constructor for class org.subethamail.smtp.server.DefaultMessageHandler.Delivery

deliver(String, String, InputStream) - Method in interface org.subethamail.smtp.MessageListener

When message data arrives, this method will be called for every recipient this listener accepted.

deliver(String, String, InputStream) - Method in class org.subethamail.wiser.Wiser

Cache the messages in memory.

dispose(IoSession) - Method in class org.subethamail.smtp.server.SMTPCodecDecoder

dispose() - Method in class org.subethamail.wiser.WiserMessage

DotUnstuffingInputStream - Class in org.subethamail.smtp.server.io

Removes the dot-stuffing happening during the NNTP and SMTP message transfer

DotUnstuffingInputStream(InputStream) - Constructor for class org.subethamail.smtp.server.io.DotUnstuffingInputStream

DummyAuthenticationHandler - Class in org.subethamail.smtp.auth

Implements a dummy AUTH mechanism.
Will always allow to login without asking for any parameter.

DummyAuthenticationHandler() - Constructor for class org.subethamail.smtp.auth.DummyAuthenticationHandler

DummySSLSocketFactory - Class in org.subethamail.smtp.server.io

DummySSLSocketFactory() - Constructor for class org.subethamail.smtp.server.io.DummySSLSocketFactory

DummySSLSocketFactory.DummyTrustManager - Class in org.subethamail.smtp.server.io

DummySSLSocketFactory.DummyTrustManager() - Constructor for class org.subethamail.smtp.server.io.DummySSLSocketFactory.DummyTrustManager

E

EhloCommand - Class in org.subethamail.smtp.command

EhloCommand() - Constructor for class org.subethamail.smtp.command.EhloCommand

encodeToByte(byte[], boolean) - Static method in class org.subethamail.smtp.util.Base64

Encodes a raw byte array into a BASE64 byte[] representation i accordance with RFC 2045.

encodeToChar(byte[], boolean) - Static method in class org.subethamail.smtp.util.Base64

Encodes a raw byte array into a BASE64 char[] representation i accordance with RFC 2045.

encodeToString(byte[], boolean) - Static method in class org.subethamail.smtp.util.Base64

Encodes a raw byte array into a BASE64 String representation i accordance with RFC 2045.

equals(Object) - Method in class org.subethamail.smtp.server.HelpMessage

exceptionCaught(IoSession, Throwable) - Method in class org.subethamail.smtp.server.ConnectionHandler

execute(String, ConnectionContext) - Method in class org.subethamail.smtp.command.AuthCommand

execute(String, ConnectionContext) - Method in class org.subethamail.smtp.command.DataCommand

execute(String, ConnectionContext) - Method in class org.subethamail.smtp.command.DataEndCommand

execute(String, ConnectionContext) - Method in class org.subethamail.smtp.command.EhloCommand

execute(String, ConnectionContext) - Method in class org.subethamail.smtp.command.HelloCommand

execute(String, ConnectionContext) - Method in class org.subethamail.smtp.command.HelpCommand

execute(String, ConnectionContext) - Method in class org.subethamail.smtp.command.MailCommand

execute(String, ConnectionContext) - Method in class org.subethamail.smtp.command.NoopCommand

execute(String, ConnectionContext) - Method in class org.subethamail.smtp.command.QuitCommand

execute(String, ConnectionContext) - Method in class org.subethamail.smtp.command.ReceiptCommand

execute(String, ConnectionContext) - Method in class org.subethamail.smtp.command.ResetCommand

execute(String, ConnectionContext) - Method in class org.subethamail.smtp.command.StartTLSCommand

execute(String, ConnectionContext) - Method in class org.subethamail.smtp.command.VerifyCommand

execute(String, ConnectionContext) - Method in class org.subethamail.smtp.server.BaseCommand

This is the main method that you need to override in order to implement a command.

execute(String, ConnectionContext) - Method in interface org.subethamail.smtp.server.Command

extractEmailAddress(String, int) - Method in class org.subethamail.smtp.server.BaseCommand

F

finalize() - Method in class org.subethamail.wiser.WiserMessage

finishDecode(IoSession, ProtocolDecoderOutput) - Method in class org.subethamail.smtp.server.SMTPCodecDecoder

from(String) - Method in interface org.subethamail.smtp.MessageHandler

Called first, after the MAIL FROM during a SMTP exchange.

from(String) - Method in class org.subethamail.smtp.server.DefaultMessageHandler

G

getAcceptedIssuers() - Method in class org.subethamail.smtp.server.io.DummySSLSocketFactory.DummyTrustManager

getActiveHandler() - Method in class org.subethamail.smtp.auth.PluginAuthenticationHandler

getArgPredicate(String) - Method in class org.subethamail.smtp.server.BaseCommand

getArgs(String) - Method in class org.subethamail.smtp.server.BaseCommand

getAuthenticationHandler() - Method in class org.subethamail.smtp.server.MessageListenerAdapter

Holds the AuthenticationHandler instantiation logic.

getAuthenticationHandlerFactory() - Method in class org.subethamail.smtp.server.MessageListenerAdapter

Returns the auth handler factory

getAuthenticationMechanisms() - Method in class org.subethamail.smtp.auth.DummyAuthenticationHandler

getAuthenticationMechanisms() - Method in class org.subethamail.smtp.auth.LoginAuthenticationHandler

getAuthenticationMechanisms() - Method in class org.subethamail.smtp.auth.PlainAuthenticationHandler

getAuthenticationMechanisms() - Method in class org.subethamail.smtp.auth.PluginAuthenticationHandler

getAuthenticationMechanisms() - Method in interface org.subethamail.smtp.AuthenticationHandler

If your handler supports RFC 2554 at some degree, then it must return all the supported mechanisms here.

getAuthenticationMechanisms() - Method in class org.subethamail.smtp.server.AbstractMessageHandler

getBacklog() - Method in class org.subethamail.smtp.server.SMTPServer

The backlog is the Socket backlog.

getBindAddress() - Method in class org.subethamail.smtp.server.SMTPServer

null means all interfaces

getCode() - Method in exception org.subethamail.smtp.RejectException

getCommand() - Method in enum org.subethamail.smtp.server.CommandRegistry

getCommandFromString(String) - Method in class org.subethamail.smtp.server.CommandHandler

Given a string, find the Command object.

getCommandHandler() - Method in class org.subethamail.smtp.server.SMTPServer

The CommandHandler manages handling the SMTP commands such as QUIT, MAIL, RCPT, DATA, etc.

getConnectionTimeout() - Method in class org.subethamail.smtp.server.SMTPServer

What is the connection timeout?

getCredential() - Method in interface org.subethamail.smtp.MessageContext

getCredential() - Method in class org.subethamail.smtp.server.ConnectionHandler.Context

getData() - Method in class org.subethamail.wiser.WiserMessage

Get's the raw message DATA.

getDataDeferredSize() - Method in class org.subethamail.smtp.server.SMTPServer

Get the maximum size in bytes of a single message before it is dumped to a temporary file.

getDecoder() - Method in class org.subethamail.smtp.server.SMTPCodecFactory

getDecoderMaxLineLength() - Method in class org.subethamail.smtp.server.SMTPCodecFactory

Returns the allowed maximum size of the line to be decoded.

getDefault() - Static method in class org.subethamail.smtp.server.io.DummySSLSocketFactory

getDefaultCipherSuites() - Method in class org.subethamail.smtp.server.io.DummySSLSocketFactory

getEncoder() - Method in class org.subethamail.smtp.server.SMTPCodecFactory

getEncoderMaxLineLength() - Method in class org.subethamail.smtp.server.SMTPCodecFactory

Returns the allowed maximum size of the encoded line.

getEnvelopeReceiver() - Method in class org.subethamail.wiser.WiserMessage

Get's the RCPT TO:

getEnvelopeSender() - Method in class org.subethamail.wiser.WiserMessage

Get's the MAIL FROM:

getFormattedTopicList(StringBuilder) - Method in class org.subethamail.smtp.command.HelpCommand

getHasSeenHelo() - Method in class org.subethamail.smtp.server.Session

getHasSender() - Method in class org.subethamail.smtp.server.Session

getHelp(String) - Method in class org.subethamail.smtp.server.BaseCommand

getHelp() - Method in class org.subethamail.smtp.server.BaseCommand

getHelp(String) - Method in interface org.subethamail.smtp.server.Command

getHostName() - Method in class org.subethamail.smtp.server.SMTPServer

getId() - Method in class org.subethamail.smtp.auth.Credential

getImplementation() - Static method in class org.subethamail.smtp.Version

getInputStream() - Method in interface org.subethamail.smtp.server.BaseContext

getInputStream() - Method in class org.subethamail.smtp.server.ConnectionHandler.Context

getIOSession() - Method in interface org.subethamail.smtp.server.ConnectionContext

getIOSession() - Method in class org.subethamail.smtp.server.ConnectionHandler.Context

getListener() - Method in class org.subethamail.smtp.server.DefaultMessageHandler.Delivery

getListeners() - Method in class org.subethamail.smtp.server.AbstractMessageHandler

getMaxConnections() - Method in class org.subethamail.smtp.server.SMTPServer

What is the maximum amount of connections?

getMaxLineLength() - Method in class org.subethamail.smtp.server.SMTPCodecDecoder

Returns the allowed maximum size of the line to be decoded.

getMaxRecipients() - Method in class org.subethamail.smtp.server.SMTPServer

What is the maximum number of recipients for a single message ?

getMessageHandler(ConnectionContext) - Method in class org.subethamail.smtp.command.AuthCommand

getMessageHandler() - Method in class org.subethamail.smtp.server.Session

getMessageHandlerFactory() - Method in class org.subethamail.smtp.server.SMTPServer

All smtp data is eventually routed through the handlers.

getMessages() - Method in class org.subethamail.wiser.Wiser

getMimeMessage() - Method in class org.subethamail.wiser.WiserMessage

Generate a JavaMail MimeMessage.

getName() - Method in class org.subethamail.smtp.server.BaseCommand

getName() - Method in interface org.subethamail.smtp.server.Command

getName() - Method in class org.subethamail.smtp.server.HelpMessage

getName() - Method in class org.subethamail.smtp.server.SMTPServer

The name of the server software.

getNameVersion() - Method in class org.subethamail.smtp.server.SMTPServer

The name + version of the server software.

getNumberOfConnections() - Method in class org.subethamail.smtp.server.ConnectionHandler

getNumberOfConnections() - Method in class org.subethamail.smtp.server.SMTPServer

Number of connections in the handler.

getPlugins() - Method in class org.subethamail.smtp.auth.PluginAuthenticationHandler

getPort() - Method in class org.subethamail.smtp.server.SMTPServer

get the port the server is running on.

getPrivateInputStream(boolean, InputStream) - Method in class org.subethamail.smtp.server.AbstractMessageHandler

Provides a private unstuffed InputStream for each invocation unless useCopy is false in which case the data stream is unstuffed and returned.

getRecipient() - Method in class org.subethamail.smtp.server.DefaultMessageHandler.Delivery

getRecipientCount() - Method in class org.subethamail.smtp.server.Session

getRemoteAddress() - Method in interface org.subethamail.smtp.server.BaseContext

getRemoteAddress() - Method in class org.subethamail.smtp.server.ConnectionHandler.Context

getServer() - Method in class org.subethamail.wiser.Wiser

getSession() - Method in interface org.subethamail.smtp.server.ConnectionContext

getSession() - Method in class org.subethamail.smtp.server.ConnectionHandler.Context

getSession() - Method in class org.subethamail.wiser.Wiser

Creates the JavaMail Session object for use in WiserMessage

getSMTPServer() - Method in interface org.subethamail.smtp.server.BaseContext

getSMTPServer() - Method in class org.subethamail.smtp.server.ConnectionHandler.Context

getSpecification() - Static method in class org.subethamail.smtp.Version

getSSLContext() - Method in class org.subethamail.smtp.server.io.DummySSLSocketFactory

getSupportedCipherSuites() - Method in class org.subethamail.smtp.server.io.DummySSLSocketFactory

getTokenizedString(StringBuilder, Collection<String>, String) - Static method in class org.subethamail.smtp.server.BaseCommand

H

handleAuthChallenge(ConnectionContext, String) - Method in class org.subethamail.smtp.server.CommandHandler

Executes an auth command.

handleCommand(ConnectionContext, String) - Method in class org.subethamail.smtp.server.CommandHandler

Calls the execute method on a command.

handleCommand(ConnectionContext, String, Command) - Method in class org.subethamail.smtp.server.CommandHandler

Calls the execute method on a command.

hashCode() - Method in class org.subethamail.smtp.server.HelpMessage

hasTooManyConnections() - Method in class org.subethamail.smtp.server.SMTPServer

Are we over the maximum amount of connections ?

HelloCommand - Class in org.subethamail.smtp.command

HelloCommand() - Constructor for class org.subethamail.smtp.command.HelloCommand

HelpCommand - Class in org.subethamail.smtp.command

HelpCommand() - Constructor for class org.subethamail.smtp.command.HelpCommand

HelpMessage - Class in org.subethamail.smtp.server

HelpMessage(String, String, String) - Constructor for class org.subethamail.smtp.server.HelpMessage

HelpMessage(String, String) - Constructor for class org.subethamail.smtp.server.HelpMessage

I

InvalidCommandNameException - Exception in org.subethamail.smtp.server

InvalidCommandNameException() - Constructor for exception org.subethamail.smtp.server.InvalidCommandNameException

InvalidCommandNameException(String) - Constructor for exception org.subethamail.smtp.server.InvalidCommandNameException

InvalidCommandNameException(String, Throwable) - Constructor for exception org.subethamail.smtp.server.InvalidCommandNameException

InvalidCommandNameException(Throwable) - Constructor for exception org.subethamail.smtp.server.InvalidCommandNameException

isActive() - Method in class org.subethamail.smtp.server.Session

isAuthenticated() - Method in class org.subethamail.smtp.server.Session

isAuthenticating() - Method in class org.subethamail.smtp.server.Session

isDataMode() - Method in class org.subethamail.smtp.server.Session

isPowerOfTwo(int) - Method in class org.subethamail.smtp.server.SMTPServer

Demonstration : if x is a power of 2, it can't share any bit with x-1.

isRunning() - Method in class org.subethamail.smtp.server.SMTPServer

Is the server running after start() has been called?

isValidEmailAddress(String) - Method in class org.subethamail.smtp.server.BaseCommand

L

last - Variable in class org.subethamail.smtp.server.io.DotUnstuffingInputStream

An array to hold the last two bytes read off the stream.

login(String, String) - Method in interface org.subethamail.smtp.auth.UsernamePasswordValidator

LoginAuthenticationHandler - Class in org.subethamail.smtp.auth

Implements the SMTP AUTH LOGIN mechanism.
You are only required to plug your UsernamePasswordValidator implementation for username and password validation to take effect.

LoginAuthenticationHandler(UsernamePasswordValidator) - Constructor for class org.subethamail.smtp.auth.LoginAuthenticationHandler

Creates a new instance of LoginAuthenticationHandler

LoginFailedException - Exception in org.subethamail.smtp.auth

Exception expected to be thrown by a validator (i.e UsernamePasswordValidator)

LoginFailedException() - Constructor for exception org.subethamail.smtp.auth.LoginFailedException

Creates a new instance of LoginFailedException

LoginFailedException(String) - Constructor for exception org.subethamail.smtp.auth.LoginFailedException

Creates a new instance of LoginFailedException

M

MailCommand - Class in org.subethamail.smtp.command

MailCommand() - Constructor for class org.subethamail.smtp.command.MailCommand

main(String[]) - Static method in class org.subethamail.smtp.Version

A simple main method that prints the version and exits

main(String[]) - Static method in class org.subethamail.wiser.Wiser

A main() for this class.

MessageContext - Interface in org.subethamail.smtp

Interface which provides context to the message handlers.

MessageHandler - Interface in org.subethamail.smtp

The interface that defines the conversational exchange of a single message on an SMTP connection.

MessageHandlerFactory - Interface in org.subethamail.smtp

The primary interface to be implemented by clients of the SMTP library.

MessageListener - Interface in org.subethamail.smtp

This is an interface for processing the end-result messages that is higher-level than the MessageHandler and related factory.

MessageListenerAdapter - Class in org.subethamail.smtp.server

MessageHandlerFactory implementation which adapts to a collection of MessageListeners.

MessageListenerAdapter(Collection<MessageListener>) - Constructor for class org.subethamail.smtp.server.MessageListenerAdapter

Initializes this factory with the listeners.

messageReceived(IoSession, Object) - Method in class org.subethamail.smtp.server.ConnectionHandler

N

NoopCommand - Class in org.subethamail.smtp.command

NoopCommand() - Constructor for class org.subethamail.smtp.command.NoopCommand

O

org.subethamail.smtp - package org.subethamail.smtp

org.subethamail.smtp.auth - package org.subethamail.smtp.auth

org.subethamail.smtp.command - package org.subethamail.smtp.command

org.subethamail.smtp.server - package org.subethamail.smtp.server

org.subethamail.smtp.server.io - package org.subethamail.smtp.server.io

org.subethamail.smtp.util - package org.subethamail.smtp.util

org.subethamail.wiser - package org.subethamail.wiser

P

PlainAuthenticationHandler - Class in org.subethamail.smtp.auth

Implements the SMTP AUTH PLAIN mechanism.
You are only required to plug your UsernamePasswordValidator implementation for username and password validation to take effect.

PlainAuthenticationHandler(UsernamePasswordValidator) - Constructor for class org.subethamail.smtp.auth.PlainAuthenticationHandler

Creates a new instance of PlainAuthenticationHandler

PluginAuthenticationHandler - Class in org.subethamail.smtp.auth

This handler makes it possible to sum the capabilities of two or more handlers types.
Hence, you can design a single handler for each authentication mechanism and decide how many authentication mechanisms to support by simply plugging them here.

PluginAuthenticationHandler() - Constructor for class org.subethamail.smtp.auth.PluginAuthenticationHandler

Creates a new instance of PluginAuthenticationHandler

Q

quit() - Method in class org.subethamail.smtp.server.Session

QuitCommand - Class in org.subethamail.smtp.command

QuitCommand() - Constructor for class org.subethamail.smtp.command.QuitCommand

R

read() - Method in class org.subethamail.smtp.server.io.CharTerminatedInputStream

Read a byte off this stream.

read() - Method in class org.subethamail.smtp.server.io.DotUnstuffingInputStream

Read through the stream, checking for '\r\n.'

read(byte[], int, int) - Method in class org.subethamail.smtp.server.io.DotUnstuffingInputStream

Read through the stream, checking for '\r\n.'

ReceiptCommand - Class in org.subethamail.smtp.command

ReceiptCommand() - Constructor for class org.subethamail.smtp.command.ReceiptCommand

recipient(String) - Method in interface org.subethamail.smtp.MessageHandler

Called once for every RCPT TO during a SMTP exchange.

recipient(String) - Method in class org.subethamail.smtp.server.DefaultMessageHandler

RejectException - Exception in org.subethamail.smtp

Thrown to reject an SMTP command with a specific code.

RejectException() - Constructor for exception org.subethamail.smtp.RejectException

RejectException(int, String) - Constructor for exception org.subethamail.smtp.RejectException

reset() - Method in class org.subethamail.smtp.server.Session

Executes a full reset() of the session which requires a new HELO command to be sent

reset(boolean) - Method in class org.subethamail.smtp.server.Session

ResetCommand - Class in org.subethamail.smtp.command

ResetCommand() - Constructor for class org.subethamail.smtp.command.ResetCommand

resetMessageState() - Method in interface org.subethamail.smtp.MessageHandler

This method is called whenever a RSET command is sent.

resetMessageState() - Method in class org.subethamail.smtp.server.DefaultMessageHandler

resetState() - Method in class org.subethamail.smtp.auth.DummyAuthenticationHandler

resetState() - Method in class org.subethamail.smtp.auth.LoginAuthenticationHandler

resetState() - Method in class org.subethamail.smtp.auth.PlainAuthenticationHandler

resetState() - Method in class org.subethamail.smtp.auth.PluginAuthenticationHandler

resetState() - Method in interface org.subethamail.smtp.AuthenticationHandler

Since a so-designed handler has its own state, it seems reasonable to enable resetting its state.

resetState() - Method in class org.subethamail.smtp.server.AbstractMessageHandler

S

sendResponse(String) - Method in interface org.subethamail.smtp.server.ConnectionContext

sendResponse(String) - Method in class org.subethamail.smtp.server.ConnectionHandler.Context

sendResponse(IoSession, String) - Static method in class org.subethamail.smtp.server.ConnectionHandler

Session - Class in org.subethamail.smtp.server

A session describes events which happen during a SMTP session.

Session(MessageHandler) - Constructor for class org.subethamail.smtp.server.Session

sessionClosed(IoSession) - Method in class org.subethamail.smtp.server.ConnectionHandler

Session closed.

sessionCreated(IoSession) - Method in class org.subethamail.smtp.server.ConnectionHandler

sessionIdle(IoSession, IdleStatus) - Method in class org.subethamail.smtp.server.ConnectionHandler

Sends a response telling that the session is idle and closes it.

setActiveHandler(AuthenticationHandler) - Method in class org.subethamail.smtp.auth.PluginAuthenticationHandler

setAnnounceTLS(boolean) - Method in class org.subethamail.smtp.server.SMTPServer

Tells the server to announce the TLS support.

setAuthenticated(boolean) - Method in class org.subethamail.smtp.server.Session

setAuthenticating(boolean) - Method in class org.subethamail.smtp.server.Session

setAuthenticationHandlerFactory(AuthenticationHandlerFactory) - Method in class org.subethamail.smtp.server.MessageListenerAdapter

Sets the auth handler factory.

setBacklog(int) - Method in class org.subethamail.smtp.server.SMTPServer

The backlog is the Socket backlog.

setBindAddress(InetAddress) - Method in class org.subethamail.smtp.server.SMTPServer

null means all interfaces

setConnectionTimeout(int) - Method in class org.subethamail.smtp.server.SMTPServer

Set the connection timeout.

setCredential(Credential) - Method in interface org.subethamail.smtp.server.ConnectionContext

setCredential(Credential) - Method in class org.subethamail.smtp.server.ConnectionHandler.Context

setDataDeferredSize(int) - Method in class org.subethamail.smtp.server.SMTPCodecDecoder

setDataDeferredSize(int) - Method in class org.subethamail.smtp.server.SMTPServer

Set the maximum size in bytes of a single message before it is dumped to a temporary file.

setDataDeferredSize(int) - Method in class org.subethamail.wiser.Wiser

Set the size at which the mail will be temporary stored on disk.

setDataMode(boolean) - Method in class org.subethamail.smtp.server.Session

setDecoderMaxLineLength(int) - Method in class org.subethamail.smtp.server.SMTPCodecFactory

Sets the allowed maximum size of the line to be decoded.

setEncoderMaxLineLength(int) - Method in class org.subethamail.smtp.server.SMTPCodecFactory

Sets the allowed maximum size of the encoded line.

setHasSeenHelo(boolean) - Method in class org.subethamail.smtp.server.Session

setHasSender(boolean) - Method in class org.subethamail.smtp.server.Session

setHelp(HelpMessage) - Method in class org.subethamail.smtp.server.BaseCommand

setHostName(String) - Method in class org.subethamail.smtp.server.SMTPServer

The host name that will be reported to SMTP clients

setHostname(String) - Method in class org.subethamail.wiser.Wiser

The hostname that the server should listen on.

setId(String) - Method in class org.subethamail.smtp.auth.Credential

setInputStream(InputStream) - Method in class org.subethamail.smtp.server.ConnectionHandler.Context

setListeners(Collection<MessageListener>) - Method in class org.subethamail.smtp.server.AbstractMessageHandler

setMaxConnections(int) - Method in class org.subethamail.smtp.server.SMTPServer

Set's the maximum number of connections this server instance will accept.

setMaxLineLength(int) - Method in class org.subethamail.smtp.server.SMTPCodecDecoder

Sets the allowed maximum size of the line to be decoded.

setMaxRecipients(int) - Method in class org.subethamail.smtp.server.SMTPServer

Set the maximum number of recipients for a single message.

setMessageHandlerImpl(Class<? extends AbstractMessageHandler>) - Method in class org.subethamail.smtp.server.MessageListenerAdapter

Sets the AbstractMessageHandler implementation to use when creating the MessageHandler.

setPlugins(List<AuthenticationHandler>) - Method in class org.subethamail.smtp.auth.PluginAuthenticationHandler

setPort(int) - Method in class org.subethamail.smtp.server.SMTPServer

set the port the server is running on.

setPort(int) - Method in class org.subethamail.wiser.Wiser

The port that the server should listen on.

setReceiveBufferSize(int) - Method in class org.subethamail.smtp.server.ConnectionHandler

Sets the receive buffer size.

setReceiveBufferSize(int) - Method in class org.subethamail.smtp.server.SMTPServer

Sets the receive buffer size.

setReceiveBufferSize(int) - Method in class org.subethamail.wiser.Wiser

Set the receive buffer size.

setSSLFilter(SSLFilter) - Static method in class org.subethamail.smtp.command.StartTLSCommand

Ability to override the SSLFilter

SharedTmpFileInputStream - Class in org.subethamail.smtp.server.io

This class uses a temporary file to store big messages and asks JVM to delete them when destroyed.

SharedTmpFileInputStream(File) - Constructor for class org.subethamail.smtp.server.io.SharedTmpFileInputStream

SMTP_TERMINATOR - Static variable in class org.subethamail.smtp.server.AbstractMessageHandler

SMTPCodecDecoder - Class in org.subethamail.smtp.server

A ProtocolDecoder which decodes incoming SMTP data based on session context.

SMTPCodecDecoder(Charset, int) - Constructor for class org.subethamail.smtp.server.SMTPCodecDecoder

Creates a new instance with the specified charset and the specified thresholdBytes deferring size.

SMTPCodecFactory - Class in org.subethamail.smtp.server

A ProtocolCodecFactory that performs encoding and decoding between a text line data and a Java string object.

SMTPCodecFactory() - Constructor for class org.subethamail.smtp.server.SMTPCodecFactory

Creates a new instance with the current default Charset.

SMTPCodecFactory(Charset, int) - Constructor for class org.subethamail.smtp.server.SMTPCodecFactory

Creates a new instance with the specified Charset.

SMTPServer - Class in org.subethamail.smtp.server

Main SMTPServer class.

SMTPServer(MessageHandlerFactory) - Constructor for class org.subethamail.smtp.server.SMTPServer

The primary constructor.

SMTPServer(Collection<MessageListener>) - Constructor for class org.subethamail.smtp.server.SMTPServer

A convenience constructor that splits the smtp data among multiple listeners (and multiple recipients).

start() - Method in class org.subethamail.smtp.server.SMTPServer

Call this method to get things rolling after instantiating the SMTPServer.

start() - Method in class org.subethamail.wiser.Wiser

Starts the SMTP Server

startJMXService() - Method in class org.subethamail.smtp.server.SMTPServer

Starts the JMX service with a polling interval default of 1000ms.

startJMXService(int) - Method in class org.subethamail.smtp.server.SMTPServer

Start the JMX service.

StartTLSCommand - Class in org.subethamail.smtp.command

StartTLSCommand() - Constructor for class org.subethamail.smtp.command.StartTLSCommand

stop() - Method in class org.subethamail.smtp.server.SMTPServer

Shut things down gracefully.

stop() - Method in class org.subethamail.wiser.Wiser

Stops the SMTP Server

stopJMXService() - Method in class org.subethamail.smtp.server.SMTPServer

Stop the JMX service.

T

TooMuchDataException - Exception in org.subethamail.smtp

Thrown by message listeners if an input stream provides more data than the listener can handle.

TooMuchDataException() - Constructor for exception org.subethamail.smtp.TooMuchDataException

TooMuchDataException(String) - Constructor for exception org.subethamail.smtp.TooMuchDataException

toOutputString() - Method in class org.subethamail.smtp.server.HelpMessage

U

UnknownCommandException - Exception in org.subethamail.smtp.server

UnknownCommandException() - Constructor for exception org.subethamail.smtp.server.UnknownCommandException

UnknownCommandException(String) - Constructor for exception org.subethamail.smtp.server.UnknownCommandException

UnknownCommandException(String, Throwable) - Constructor for exception org.subethamail.smtp.server.UnknownCommandException

UnknownCommandException(Throwable) - Constructor for exception org.subethamail.smtp.server.UnknownCommandException

UsernamePasswordValidator - Interface in org.subethamail.smtp.auth

Use this when your authentication scheme uses a username and a password.

V

valueOf(String) - Static method in enum org.subethamail.smtp.server.CommandRegistry

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.subethamail.smtp.server.CommandRegistry

Returns an array containing the constants of this enum type, in the order they are declared.

VERB - Static variable in class org.subethamail.smtp.command.AuthCommand

VerifyCommand - Class in org.subethamail.smtp.command

VerifyCommand() - Constructor for class org.subethamail.smtp.command.VerifyCommand

Version - Class in org.subethamail.smtp

Provides version information from the manifest.

Version() - Constructor for class org.subethamail.smtp.Version

W

Wiser - Class in org.subethamail.wiser

Wiser is a smart mail testing application.

Wiser() - Constructor for class org.subethamail.wiser.Wiser

Create a new SMTP server with this class as the listener.

Wiser.AuthHandlerFactory - Class in org.subethamail.wiser

Creates the AuthHandlerFactory which logs the user/pass.

Wiser.AuthHandlerFactory() - Constructor for class org.subethamail.wiser.Wiser.AuthHandlerFactory

WiserMessage - Class in org.subethamail.wiser

This class wraps a received message and provides a way to generate a JavaMail MimeMessage from the data.

A B C D E F G H I L M N O P Q R S T U V W