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

A

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

Called once for every RCPT TO during a SMTP exchange.

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

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 or replaces the specified command.

addFactory(AuthenticationHandlerFactory) - Method in class org.subethamail.smtp.auth.MultipleAuthenticationHandlerFactory

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

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

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

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

The factory interface for creating authentication handlers.

available() - Method in class org.subethamail.smtp.io.ReceivedHeaderStream

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

C

checkCRLFTerminator() - Method in class org.subethamail.smtp.io.CRLFOutputStream

Ensure that the stream is CRLF terminated.

checkThreshold(int) - Method in class org.subethamail.smtp.io.ThresholdingOutputStream

Checks whether reading count bytes would cross the limit.

close() - Method in class org.subethamail.smtp.client.SMTPClient

Logs but otherwise ignores errors

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

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

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

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

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

Close the client socket if it is open

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

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

Create a command handler with a specific set of commands.

CommandRegistry - Enum in org.subethamail.smtp.server

Enumerates all the Commands made available in this release.

connect(String, int) - Method in class org.subethamail.smtp.client.SmartClient

Connects to the specified server and issues the initial HELO command.

connect(String, int) - Method in class org.subethamail.smtp.client.SMTPClient

Establishes a connection to host and port.

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

create() - Method in class org.subethamail.smtp.auth.LoginAuthenticationHandlerFactory

create() - Method in class org.subethamail.smtp.auth.MultipleAuthenticationHandlerFactory

create() - Method in class org.subethamail.smtp.auth.PlainAuthenticationHandlerFactory

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

Create a fresh instance of your handler.

create(MessageContext) - Method in class org.subethamail.smtp.helper.SimpleMessageListenerAdapter

create(MessageContext) - Method in class org.subethamail.smtp.helper.SmarterMessageListenerAdapter

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

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

create() - Method in interface org.subethamail.smtp.server.SessionIdFactory

Returns a new identifier.

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

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

Override this method if you want to create your own server sockets.

createSocket() - Method in class org.subethamail.smtp.client.SMTPClient

Returns a new unconnected socket.

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

Create a SSL socket that wraps the existing socket.

CRLFOutputStream - Class in org.subethamail.smtp.io

A Filter for use with SMTP or other protocols in which lines must end with CRLF.

CRLFOutputStream(OutputStream) - Constructor for class org.subethamail.smtp.io.CRLFOutputStream

Constructor that wraps an OutputStream.

CRLFTerminatedReader - Class in org.subethamail.smtp.io

A Reader for use with SMTP or other protocols in which lines must end with CRLF.

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

CRLFTerminatedReader(InputStream, String) - Constructor for class org.subethamail.smtp.io.CRLFTerminatedReader

CRLFTerminatedReader.MaxLineLengthException - Exception in org.subethamail.smtp.io

CRLFTerminatedReader.MaxLineLengthException() - Constructor for exception org.subethamail.smtp.io.CRLFTerminatedReader.MaxLineLengthException

CRLFTerminatedReader.MaxLineLengthException(String) - Constructor for exception org.subethamail.smtp.io.CRLFTerminatedReader.MaxLineLengthException

CRLFTerminatedReader.TerminationException - Exception in org.subethamail.smtp.io

CRLFTerminatedReader.TerminationException(int) - Constructor for exception org.subethamail.smtp.io.CRLFTerminatedReader.TerminationException

CRLFTerminatedReader.TerminationException(String, int) - Constructor for exception org.subethamail.smtp.io.CRLFTerminatedReader.TerminationException

D

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

Called when the DATA part of the SMTP exchange begins.

DataCommand - Class in org.subethamail.smtp.command

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

dataEnd() - Method in class org.subethamail.smtp.client.SmartClient

Last step after writing data

dataStart() - Method in class org.subethamail.smtp.client.SmartClient

Prelude to writing data

dataWrite(byte[], int) - Method in class org.subethamail.smtp.client.SmartClient

Actually write some data

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.

DeferredFileOutputStream - Class in org.subethamail.smtp.io

This works like a ByteArrayOutputStream until a certain size is reached, then creates a temp file and acts like a buffered FileOutputStream.

DeferredFileOutputStream(int) - Constructor for class org.subethamail.smtp.io.DeferredFileOutputStream

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

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

deliver(InputStream) - Method in interface org.subethamail.smtp.helper.SmarterMessageListener.Receiver

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

done() - Method in interface org.subethamail.smtp.helper.SmarterMessageListener.Receiver

Called at the end of the SMTP exchange, even if no data was delivered.

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

Called after all other methods are completed.

DotTerminatedInputStream - Class in org.subethamail.smtp.io

An InputStream class that terminates the stream when it encounters a US-ASCII encoded dot CR LF byte sequence immediately following a CR LF line end.

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

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

DotTerminatedOutputStream - Class in org.subethamail.smtp.io

DotTerminatedOutputStream makes possible to end mail data with a "CRLF .

DotTerminatedOutputStream(OutputStream) - Constructor for class org.subethamail.smtp.io.DotTerminatedOutputStream

DotUnstuffingInputStream - Class in org.subethamail.smtp.io

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

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

DropConnectionException - Exception in org.subethamail.smtp

A type of RejectException that additionally causes the server to close the connection to the client.

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

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

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

dumpMessage(PrintStream) - Method in class org.subethamail.wiser.WiserMessage

Dumps the rough contents of the message for debugging purposes

dumpMessages(PrintStream) - Method in class org.subethamail.wiser.Wiser

For debugging purposes, dumps a rough outline of the messages to the output stream.

E

EasyAuthenticationHandlerFactory - Class in org.subethamail.smtp.auth

This a convenient class that saves you setting up the factories that we know about; you can always add more afterwards.

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

EhloCommand - Class in org.subethamail.smtp.command

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

EmailUtils - Class in org.subethamail.smtp.util

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

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.

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

Safely calls done() on a message hander, if one exists

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

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

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

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

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

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

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

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

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

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

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

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

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

execute(String, Session) - 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, Session) - Method in interface org.subethamail.smtp.server.Command

execute(String, Session) - Method in class org.subethamail.smtp.server.RequireTLSCommandWrapper

extractEmailAddress(String, int) - Static method in class org.subethamail.smtp.util.EmailUtils

Extracts the email address within a <> after a specified offset.

ExtraDotOutputStream - Class in org.subethamail.smtp.io

Adds extra dot if dot occurs in message body at beginning of line (according to RFC1939) Compare also org.apache.james.smtpserver.SMTPInputStream

ExtraDotOutputStream(OutputStream) - Constructor for class org.subethamail.smtp.io.ExtraDotOutputStream

Constructor that wraps an OutputStream.

F

flush() - Method in class org.subethamail.smtp.io.ThresholdingOutputStream

from(String) - Method in class org.subethamail.smtp.client.SmartClient

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

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

G

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

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

getAsciiBytes(String) - Static method in class org.subethamail.smtp.util.TextUtils

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

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

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

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

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

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

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

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

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

The backlog is the Socket backlog.

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

Provide access to the base input stream.

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

null means all interfaces

getBindpoint() - Method in class org.subethamail.smtp.client.SMTPClient

Returns the local socket address.

getBytes(String, String) - Static method in class org.subethamail.smtp.util.TextUtils

getCode() - Method in class org.subethamail.smtp.client.SMTPClient.Response

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

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

Returns the command object corresponding to the specified command name.

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

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

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

Get's the raw message DATA.

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

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

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

Deprecated. use SMTPServer.enableTLS

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

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

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:

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

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

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

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

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

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

Simple state

getHeloHost() - Method in class org.subethamail.smtp.client.SmartClient

Returns the HELO name of this system.

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

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

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

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

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

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

getHostPort() - Method in class org.subethamail.smtp.client.SMTPClient

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

If the authentication process was successful, this returns the identity of the user.

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

getInputStream() - Method in class org.subethamail.smtp.io.DeferredFileOutputStream

Closes the output stream and creates an InputStream on the same data.

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

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

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

getMessage() - Method in class org.subethamail.smtp.client.SMTPClient.Response

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

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

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

Returns the name of the command in upper case.

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

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

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

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

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

getRecipientCount() - Method in class org.subethamail.smtp.client.SmartClient

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

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

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

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

getResponse() - Method in exception org.subethamail.smtp.client.SMTPException

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

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

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

Creates the JavaMail Session object for use in WiserMessage

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

Returns an identifier of the session which is reasonably unique within an extended time period.

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

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

Returns the first accepted recipient if there is exactly one accepted recipient, otherwise it returns null.

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

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

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

This method is only used by the start tls command

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

The string reported to the public as the software running here.

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

getStringAscii(byte[]) - Static method in class org.subethamail.smtp.util.TextUtils

Converts the specified bytes to String using US-ASCII encoding.

getStringUtf8(byte[]) - Static method in class org.subethamail.smtp.util.TextUtils

Converts the specified bytes to String using UTF-8 encoding.

getThreshold() - Method in class org.subethamail.smtp.io.ThresholdingOutputStream

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

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

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

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

getUtf8Bytes(String) - Static method in class org.subethamail.smtp.util.TextUtils

getValidator() - Method in class org.subethamail.smtp.auth.EasyAuthenticationHandlerFactory

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

H

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

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

HelloCommand - Class in org.subethamail.smtp.command

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

HelpCommand - Class in org.subethamail.smtp.command

Provides a help system for people to interact with.

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

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

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

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

isSuccess() - Method in class org.subethamail.smtp.client.SMTPClient.Response

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

isValidEmailAddress(String) - Static method in class org.subethamail.smtp.util.EmailUtils

J

joinTogether(Collection<String>, String) - Static method in class org.subethamail.smtp.util.TextUtils

L

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

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

LAST_WAS_CR - Static variable in class org.subethamail.smtp.io.CRLFOutputStream

LAST_WAS_LF - Static variable in class org.subethamail.smtp.io.CRLFOutputStream

LAST_WAS_OTHER - Static variable in class org.subethamail.smtp.io.CRLFOutputStream

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

LoginAuthenticationHandlerFactory - 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.

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

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.

mark(int) - Method in class org.subethamail.smtp.io.ReceivedHeaderStream

markSupported() - Method in class org.subethamail.smtp.io.ReceivedHeaderStream

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.

messages - Variable in class org.subethamail.wiser.Wiser

MultipleAuthenticationHandlerFactory - Class in org.subethamail.smtp.auth

This handler combines the behavior of several other authentication handler factories.

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

MultipleAuthenticationHandlerFactory(Collection<AuthenticationHandlerFactory>) - Constructor for class org.subethamail.smtp.auth.MultipleAuthenticationHandlerFactory

N

NoopCommand - Class in org.subethamail.smtp.command

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

normalizeEmail(String) - Static method in class org.subethamail.smtp.util.EmailUtils

Normalize the domain-part to lowercase.

O

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

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

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

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

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

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

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

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

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

output - Variable in class org.subethamail.smtp.io.ThresholdingOutputStream

P

PlainAuthenticationHandlerFactory - 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.

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

position() - Method in exception org.subethamail.smtp.io.CRLFTerminatedReader.TerminationException

Q

quit() - Method in class org.subethamail.smtp.client.SmartClient

Quit and close down the connection.

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

Triggers the shutdown of the thread and the closing of the connection.

QuitCommand - Class in org.subethamail.smtp.command

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

R

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

read(char[], int, int) - Method in class org.subethamail.smtp.io.CRLFTerminatedReader

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

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

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

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

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

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

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

read(byte[]) - Method in class org.subethamail.smtp.io.ReceivedHeaderStream

readLine() - Method in class org.subethamail.smtp.io.CRLFTerminatedReader

Read a line of text which is terminated by CRLF.

ready() - Method in class org.subethamail.smtp.io.CRLFTerminatedReader

ReceiptCommand - Class in org.subethamail.smtp.command

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

receive() - Method in class org.subethamail.smtp.client.SmartClient

Returns the server response.

receive() - Method in class org.subethamail.smtp.client.SMTPClient

Note that the response text comes back without trailing newlines.

receiveAndCheck() - Method in class org.subethamail.smtp.client.SMTPClient

If response is not success, throw an exception

ReceivedHeaderStream - Class in org.subethamail.smtp.io

Prepends a Received: header at the beginning of the input stream.

ReceivedHeaderStream(InputStream, String, InetAddress, String, String, String, String) - Constructor for class org.subethamail.smtp.io.ReceivedHeaderStream

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

Called once for every RCPT TO during a SMTP exchange.

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(String) - Constructor for exception org.subethamail.smtp.RejectException

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

RequireTLSCommandWrapper - Class in org.subethamail.smtp.server

Verifies the presence of a TLS connection if TLS is required.

RequireTLSCommandWrapper(Command) - Constructor for class org.subethamail.smtp.server.RequireTLSCommandWrapper

reset() - Method in class org.subethamail.smtp.io.ReceivedHeaderStream

ResetCommand - Class in org.subethamail.smtp.command

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

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

Some state is associated with each particular message (senders, recipients, the message handler).

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

Reset the SMTP protocol to the initial state, which is the state after a server issues a 220 service ready greeting.

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

The thread for each session runs on this and shuts down when the quitting member goes true.

S

send(String) - Method in class org.subethamail.smtp.client.SMTPClient

Sends a message to the server, ie "HELO foo.example.com".

sendAndCheck(String) - Method in class org.subethamail.smtp.client.SMTPClient

If response is not success, throw an exception

sendReceive(String) - Method in class org.subethamail.smtp.client.SMTPClient

Sends a message to the server, ie "HELO foo.example.com".

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

Sends the response to the client

sentFrom() - Method in class org.subethamail.smtp.client.SmartClient

sentTo() - Method in class org.subethamail.smtp.client.SmartClient

Session - Class in org.subethamail.smtp.server

The thread that handles a connection.

Session(SMTPServer, ServerThread, Socket) - Constructor for class org.subethamail.smtp.server.Session

Creates the Runnable Session object.

SessionIdFactory - Interface in org.subethamail.smtp.server

SessionIdFactory creates reasonable unique identifiers which are applicable to identify a session in the log files.

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

This is called by the AuthCommand when a session is successfully authenticated.

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

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

setBindpoint(SocketAddress) - Method in class org.subethamail.smtp.client.SMTPClient

Sets the local socket address.

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

Set the number of milliseconds that the server will wait for client input.

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

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

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

Deprecated. use SMTPServer.setEnableTLS(boolean)

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

If set to true, TLS will be supported.

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

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

setHeloHost(String) - Method in class org.subethamail.smtp.client.SmartClient

Sets the domain name or address literal of this system, which name will be sent to the server in the parameter of the HELO and EHLO commands.

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

If set to true, TLS will not be advertised in the EHLO string.

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.

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

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

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

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

Set the maximum number of recipients allowed for each message.

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

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

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

The port that the server should listen on.

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

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

Sets the SessionIdFactory which will allocate a unique identifier for each mail sessions.

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

Initializes our reader, writer, and the i/o filter chains based on the specified socket.

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

Changes the publicly reported software information.

setTlsPeerCertificates(Certificate[]) - Method in class org.subethamail.smtp.server.Session

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

SimpleMessageListener - Interface in org.subethamail.smtp.helper

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

SimpleMessageListenerAdapter - Class in org.subethamail.smtp.helper

MessageHandlerFactory implementation which adapts to a collection of MessageListeners.

SimpleMessageListenerAdapter(SimpleMessageListener) - Constructor for class org.subethamail.smtp.helper.SimpleMessageListenerAdapter

Initializes this factory with a single listener.

SimpleMessageListenerAdapter(Collection<SimpleMessageListener>) - Constructor for class org.subethamail.smtp.helper.SimpleMessageListenerAdapter

Initializes this factory with the listeners.

SimpleMessageListenerAdapter(Collection<SimpleMessageListener>, int) - Constructor for class org.subethamail.smtp.helper.SimpleMessageListenerAdapter

Initializes this factory with the listeners.

skip(long) - Method in class org.subethamail.smtp.io.ReceivedHeaderStream

SmartClient - Class in org.subethamail.smtp.client

A somewhat smarter abstraction of an SMTP client which doesn't require knowing anything about the nitty gritty of SMTP.

SmartClient() - Constructor for class org.subethamail.smtp.client.SmartClient

Creates an unconnected client.

SmartClient(String, int, String) - Constructor for class org.subethamail.smtp.client.SmartClient

Connects to the specified server and issues the initial HELO command.

SmartClient(String, int, SocketAddress, String) - Constructor for class org.subethamail.smtp.client.SmartClient

Connects to the specified server and issues the initial HELO command.

SmarterMessageListener - Interface in org.subethamail.smtp.helper

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

SmarterMessageListener.Receiver - Interface in org.subethamail.smtp.helper

Interface which accepts delivery of a message.

SmarterMessageListenerAdapter - Class in org.subethamail.smtp.helper

MessageHandlerFactory implementation which adapts to a collection of SmarterMessageListeners.

SmarterMessageListenerAdapter(SmarterMessageListener) - Constructor for class org.subethamail.smtp.helper.SmarterMessageListenerAdapter

Initializes this factory with a single listener.

SmarterMessageListenerAdapter(Collection<SmarterMessageListener>) - Constructor for class org.subethamail.smtp.helper.SmarterMessageListenerAdapter

Initializes this factory with the listeners.

SmarterMessageListenerAdapter(Collection<SmarterMessageListener>, int) - Constructor for class org.subethamail.smtp.helper.SmarterMessageListenerAdapter

Initializes this factory with the listeners.

SMTPClient - Class in org.subethamail.smtp.client

A very low level abstraction of the STMP stream which knows how to handle the raw protocol for lines, whitespace, etc.

SMTPClient() - Constructor for class org.subethamail.smtp.client.SMTPClient

Creates an unconnected client.

SMTPClient(String, int) - Constructor for class org.subethamail.smtp.client.SMTPClient

Establishes a connection to host and port.

SMTPClient(String, int, SocketAddress) - Constructor for class org.subethamail.smtp.client.SMTPClient

Establishes a connection to host and port from the specified local socket address.

SMTPClient.Response - Class in org.subethamail.smtp.client

Result of an SMTP exchange.

SMTPClient.Response(int, String) - Constructor for class org.subethamail.smtp.client.SMTPClient.Response

SMTPException - Exception in org.subethamail.smtp.client

SMTPException(SMTPClient.Response) - Constructor for exception org.subethamail.smtp.client.SMTPException

SMTPServer - Class in org.subethamail.smtp.server

Main SMTPServer class.

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

Simple constructor.

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

Constructor with AuthenticationHandlerFactory.

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

Complex constructor.

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

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

startOfLine - Variable in class org.subethamail.smtp.io.CRLFOutputStream

StartTLSCommand - Class in org.subethamail.smtp.command

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

statusLast - Variable in class org.subethamail.smtp.io.CRLFOutputStream

Counter for number of last (0A or 0D).

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

T

TextUtils - Class in org.subethamail.smtp.util

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

ThresholdingOutputStream - Class in org.subethamail.smtp.io

This is an OutputStream wrapper which takes notice when a threshold (number of bytes) is about to be written.

ThresholdingOutputStream(OutputStream, int) - Constructor for class org.subethamail.smtp.io.ThresholdingOutputStream

thresholdReached(int, int) - Method in class org.subethamail.smtp.io.DeferredFileOutputStream

thresholdReached(int, int) - Method in class org.subethamail.smtp.io.ThresholdingOutputStream

Called when the threshold is about to be exceeded.

TimeBasedSessionIdFactory - Class in org.subethamail.smtp.server

TimeBasedSessionIdFactory is a very simple SessionIdFactory, which assigns numeric identifiers based on the current milliseconds time, amending it as necessary to make it unique.

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

TMPFILE_PREFIX - Static variable in class org.subethamail.smtp.io.DeferredFileOutputStream

TMPFILE_SUFFIX - Static variable in class org.subethamail.smtp.io.DeferredFileOutputStream

to(String) - Method in class org.subethamail.smtp.client.SmartClient

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

toString() - Method in class org.subethamail.smtp.client.SMTPClient.Response

toString() - Method in class org.subethamail.smtp.client.SMTPClient

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

Implementation of toString()

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 tool for unit testing applications that send mail.

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

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

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

Convenience constructor

WiserMessage - Class in org.subethamail.wiser

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

write(int) - Method in class org.subethamail.smtp.io.CRLFOutputStream

Writes a byte to the stream Fixes any naked CR or LF to the RFC 2821 mandated CFLF pairing.

write(byte[], int, int) - Method in class org.subethamail.smtp.io.CRLFOutputStream

write(int) - Method in class org.subethamail.smtp.io.DotTerminatedOutputStream

write(byte[], int, int) - Method in class org.subethamail.smtp.io.DotTerminatedOutputStream

write(int) - Method in class org.subethamail.smtp.io.ExtraDotOutputStream

Writes a byte to the stream, adding dots where appropriate.

write(byte[], int, int) - Method in class org.subethamail.smtp.io.ThresholdingOutputStream

write(byte[]) - Method in class org.subethamail.smtp.io.ThresholdingOutputStream

write(int) - Method in class org.subethamail.smtp.io.ThresholdingOutputStream

writeChunk(byte[], int, int) - Method in class org.subethamail.smtp.io.CRLFOutputStream

Provides an extension point for ExtraDotOutputStream to be able to add dots at the beginning of new lines.

writeChunk(byte[], int, int) - Method in class org.subethamail.smtp.io.ExtraDotOutputStream

Overrides super writeChunk in order to add a "." if the previous chunk ended with a new line and a new chunk starts with "."

writeTerminatingSequence() - Method in class org.subethamail.smtp.io.DotTerminatedOutputStream

Writes ".

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