Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- addListener(SmtpServerListener) - Method in class ch.astorm.smtp4j.SmtpServer
-
Registers the specified
listenerto the server's events. - at(String) - Method in class ch.astorm.smtp4j.util.MimeMessageBuilder
-
Defines the sent date.
- at(Date) - Method in class ch.astorm.smtp4j.util.MimeMessageBuilder
-
Defines the sent date.
- attachment(File) - Method in class ch.astorm.smtp4j.util.MimeMessageBuilder
-
Adds the specified
fileas attachment. - attachment(String, File) - Method in class ch.astorm.smtp4j.util.MimeMessageBuilder
-
Adds the specified
fileas attachment wit the givenname. - attachment(String, String, InputStream) - Method in class ch.astorm.smtp4j.util.MimeMessageBuilder
-
Adds the specified
fileas attachment wit the givennameandmimeType.
B
- bcc(Address) - Method in class ch.astorm.smtp4j.util.MimeMessageBuilder
-
Adds the
addressto theBCCrecipients. - bcc(String...) - Method in class ch.astorm.smtp4j.util.MimeMessageBuilder
-
Adds the
addressto theBCCrecipients. - body(String) - Method in class ch.astorm.smtp4j.util.MimeMessageBuilder
-
Defines the message body.
- body(String, Charset) - Method in class ch.astorm.smtp4j.util.MimeMessageBuilder
-
Defines the message body.
- build() - Method in class ch.astorm.smtp4j.SmtpServerBuilder
-
Builds the
SmtpServer. - build() - Method in class ch.astorm.smtp4j.util.MimeMessageBuilder
-
Builds the
MimeMessage.
C
- cc(Address) - Method in class ch.astorm.smtp4j.util.MimeMessageBuilder
-
Adds the
addressto theCCrecipients. - cc(String...) - Method in class ch.astorm.smtp4j.util.MimeMessageBuilder
-
Adds the
addressto theCCrecipients. - ch.astorm.smtp4j - package ch.astorm.smtp4j
- ch.astorm.smtp4j.core - package ch.astorm.smtp4j.core
- ch.astorm.smtp4j.protocol - package ch.astorm.smtp4j.protocol
- ch.astorm.smtp4j.util - package ch.astorm.smtp4j.util
- close() - Method in class ch.astorm.smtp4j.SmtpServer
-
Closes this
SmtpServerinstance and releases all the resources associated to it. - CODE_BAD_COMMAND_SEQUENCE - Static variable in class ch.astorm.smtp4j.protocol.SmtpProtocolConstants
-
Error code when a bad sequence of command has been received.
- CODE_COMMAND_UNKNOWN - Static variable in class ch.astorm.smtp4j.protocol.SmtpProtocolConstants
-
Error code when a command is unknown.
- CODE_CONNECT - Static variable in class ch.astorm.smtp4j.protocol.SmtpProtocolConstants
-
Code of the first reply of the SMTP server.
- CODE_INTERMEDIATE_REPLY - Static variable in class ch.astorm.smtp4j.protocol.SmtpProtocolConstants
-
Code when the command is accepted, but in intermediate state (data).
- CODE_NOT_SUPPORTED - Static variable in class ch.astorm.smtp4j.protocol.SmtpProtocolConstants
-
Code when the command is not supported.
- CODE_OK - Static variable in class ch.astorm.smtp4j.protocol.SmtpProtocolConstants
-
Code when the command is accepted by the server.
- COLON - Static variable in class ch.astorm.smtp4j.protocol.SmtpProtocolConstants
-
Colon separator.
- create(String, List<String>, String, List<SmtpExchange>) - Static method in class ch.astorm.smtp4j.core.SmtpMessage
-
Creates a new
SmtpMessagewith the specified parameters. - createSession() - Method in class ch.astorm.smtp4j.SmtpServer
-
Creates a new
Sessioninstance that will send messages to this server. - CRLF - Static variable in class ch.astorm.smtp4j.protocol.SmtpProtocolConstants
-
Line/command break.
D
- DATA - Enum constant in enum class ch.astorm.smtp4j.protocol.SmtpCommand.Type
- DEFAULT_PORT - Static variable in class ch.astorm.smtp4j.SmtpServer
-
Default SMTP port.
- DefaultSmtpMessageHandler - Class in ch.astorm.smtp4j.core
-
Simple
SmtpMessageHandlerthat stores the received messages in a list. - DefaultSmtpMessageHandler() - Constructor for class ch.astorm.smtp4j.core.DefaultSmtpMessageHandler
- DOT - Static variable in class ch.astorm.smtp4j.protocol.SmtpProtocolConstants
-
Data dot-line separator.
E
- EHLO - Enum constant in enum class ch.astorm.smtp4j.protocol.SmtpCommand.Type
- EXPAND - Enum constant in enum class ch.astorm.smtp4j.protocol.SmtpCommand.Type
F
- from(Address) - Method in class ch.astorm.smtp4j.util.MimeMessageBuilder
-
Defines the From address.
- from(String) - Method in class ch.astorm.smtp4j.util.MimeMessageBuilder
-
Defines the From address.
G
- getAttachments() - Method in class ch.astorm.smtp4j.core.SmtpMessage
-
Returns the attachments of the MIME message.
- getBody() - Method in class ch.astorm.smtp4j.core.SmtpMessage
-
Returns the content of the MIME message.
- getContentType() - Method in class ch.astorm.smtp4j.core.SmtpAttachment
-
Returns the Content Type.
- getFilename() - Method in class ch.astorm.smtp4j.core.SmtpAttachment
-
Returns the file name.
- getFrom() - Method in class ch.astorm.smtp4j.core.SmtpMessage
-
Returns the
Fromheader of the MIME message. - getListeners() - Method in class ch.astorm.smtp4j.SmtpServer
-
Returns the listeners of this server.
- getMessageHandler() - Method in class ch.astorm.smtp4j.SmtpServer
-
Returns the current
SmtpMessageHandler. - getMimeMessage() - Method in class ch.astorm.smtp4j.core.SmtpMessage
-
Returns the
MimeMessageparsed from the content. - getParameter() - Method in class ch.astorm.smtp4j.protocol.SmtpCommand
-
Returns the command's parameter.
- getPort() - Method in class ch.astorm.smtp4j.SmtpServer
-
Returns the port on which the
SmtpServerlisten to. - getRawMimeContent() - Method in class ch.astorm.smtp4j.core.SmtpMessage
-
Returns the internal raw content received by the SMTP server to parse as
MimeMessage. - getReceivedData() - Method in class ch.astorm.smtp4j.protocol.SmtpExchange
-
Returns the data received by smtp4j.
- getRecipients(Message.RecipientType) - Method in class ch.astorm.smtp4j.core.SmtpMessage
-
Returns all the recipients of the given
type. - getRepliedData() - Method in class ch.astorm.smtp4j.protocol.SmtpExchange
-
Returns the response sent back by smtp4j:
- getSentDate() - Method in class ch.astorm.smtp4j.core.SmtpMessage
-
Returns the sent date.
- getSessionProperties() - Method in class ch.astorm.smtp4j.SmtpServer
-
Returns the basic
Propertiesthat can be used forSession. - getSmtpExchanges() - Method in class ch.astorm.smtp4j.core.SmtpMessage
-
Returns the raw SMTP exchanges to create this message.
- getSourceFrom() - Method in class ch.astorm.smtp4j.core.SmtpMessage
-
Returns the
Fromparameter specified during the protocol exchange. - getSourceRecipients() - Method in class ch.astorm.smtp4j.core.SmtpMessage
-
Returns the list of
Toparameters specified during the protocol exchange. - getSubject() - Method in class ch.astorm.smtp4j.core.SmtpMessage
-
Returns the
Subjectheader of the MIME message. - getType() - Method in class ch.astorm.smtp4j.protocol.SmtpCommand
-
Returns the command's type.
H
- handle(BufferedReader, PrintWriter, SmtpTransactionHandler.MessageReceiver) - Static method in class ch.astorm.smtp4j.protocol.SmtpTransactionHandler
-
Handles the SMTP protocol communication.
- HELP - Enum constant in enum class ch.astorm.smtp4j.protocol.SmtpCommand.Type
I
- isClosed() - Method in class ch.astorm.smtp4j.SmtpServer
-
Returns true if the server has been closed or is not started yet.
- isRunning() - Method in class ch.astorm.smtp4j.SmtpServer
-
Returns true if the
SmtpServeris started and is actually listening for new messages.
M
- MAIL_FROM - Enum constant in enum class ch.astorm.smtp4j.protocol.SmtpCommand.Type
- matches(String) - Method in enum class ch.astorm.smtp4j.protocol.SmtpCommand.Type
- messageReader() - Method in class ch.astorm.smtp4j.core.DefaultSmtpMessageHandler
- messageReader() - Method in interface ch.astorm.smtp4j.core.SmtpMessageHandler
-
Returns a new
SmtpMessageReaderthat loops over the received messages. - MimeMessageBuilder - Class in ch.astorm.smtp4j.util
-
Provides methods to easily create a
MimeMessagethat can be sent to an SMTP server. - MimeMessageBuilder(SmtpServer) - Constructor for class ch.astorm.smtp4j.util.MimeMessageBuilder
-
Creates a new
MimeMessageBuilderby creating a newSessionfrom the givenserver. - MimeMessageBuilder(Session) - Constructor for class ch.astorm.smtp4j.util.MimeMessageBuilder
-
Creates a new
MimeMessageBuilderwith the givensession.
N
- NOOP - Enum constant in enum class ch.astorm.smtp4j.protocol.SmtpCommand.Type
- notifyClose(SmtpServer) - Method in class ch.astorm.smtp4j.core.DefaultSmtpMessageHandler
- notifyClose(SmtpServer) - Method in interface ch.astorm.smtp4j.core.SmtpServerListener
-
Invoked when the
serverhas been closed. - notifyMessage(SmtpServer, SmtpMessage) - Method in class ch.astorm.smtp4j.core.DefaultSmtpMessageHandler
- notifyMessage(SmtpServer, SmtpMessage) - Method in interface ch.astorm.smtp4j.core.SmtpServerListener
-
Invoked when the
serverhas received a message. - notifyStart(SmtpServer) - Method in class ch.astorm.smtp4j.core.DefaultSmtpMessageHandler
- notifyStart(SmtpServer) - Method in interface ch.astorm.smtp4j.core.SmtpServerListener
-
Invoked when the
serverhas been started and is ready to receive messages.
O
- openStream() - Method in class ch.astorm.smtp4j.core.SmtpAttachment
-
Opens a new
InputStreamon this attachment. - openStream() - Method in interface ch.astorm.smtp4j.core.SmtpAttachment.StreamProvider
-
Returns a new
InputStream.
P
- parse(String) - Static method in class ch.astorm.smtp4j.protocol.SmtpCommand
-
Parses the
lineand creates a newSmtpCommand.
Q
- QUIT - Enum constant in enum class ch.astorm.smtp4j.protocol.SmtpCommand.Type
R
- readMessage() - Method in interface ch.astorm.smtp4j.core.SmtpMessageHandler.SmtpMessageReader
-
Reads the next available
SmtpMessage. - readMessages(long, TimeUnit) - Method in class ch.astorm.smtp4j.core.DefaultSmtpMessageHandler
- readMessages(long, TimeUnit) - Method in interface ch.astorm.smtp4j.core.SmtpMessageHandler
-
Retrieves the received messages and clears the list.
- readReceivedMessages() - Method in class ch.astorm.smtp4j.SmtpServer
-
Returns all the (newly) received messages.
- readReceivedMessages(long, TimeUnit) - Method in class ch.astorm.smtp4j.SmtpServer
-
Returns all the (newly) received messages.
- receivedMessageReader() - Method in class ch.astorm.smtp4j.SmtpServer
-
Returns a new
SmtpMessageHandler.SmtpMessageReaderto read incoming messages. - receiveMessage(SmtpMessage) - Method in interface ch.astorm.smtp4j.protocol.SmtpTransactionHandler.MessageReceiver
-
Invoked when a message is received.
- RECIPIENT - Enum constant in enum class ch.astorm.smtp4j.protocol.SmtpCommand.Type
- removeListener(SmtpServerListener) - Method in class ch.astorm.smtp4j.SmtpServer
-
Removes the specified
listenerof the server's event notifications. - RESET - Enum constant in enum class ch.astorm.smtp4j.protocol.SmtpCommand.Type
S
- send() - Method in class ch.astorm.smtp4j.util.MimeMessageBuilder
-
Builds and send the message.
- SmtpAttachment - Class in ch.astorm.smtp4j.core
-
Attachment of an
SmtpMessage. - SmtpAttachment(String, String, SmtpAttachment.StreamProvider) - Constructor for class ch.astorm.smtp4j.core.SmtpAttachment
-
Creates a new
SmtpAttachementwith the specified parameters. - SmtpAttachment.StreamProvider - Interface in ch.astorm.smtp4j.core
-
Provides an
InputStreamto read the attachment content. - SmtpCommand - Class in ch.astorm.smtp4j.protocol
-
List of SMTP commands.
- SmtpCommand(SmtpCommand.Type, String) - Constructor for class ch.astorm.smtp4j.protocol.SmtpCommand
-
Creates a new
SmtpCommand. - SmtpCommand.Type - Enum Class in ch.astorm.smtp4j.protocol
-
Represents the SMTP command types.
- SmtpExchange - Class in ch.astorm.smtp4j.protocol
-
Protocol exchange data between smtp4j and the sender.
- SmtpExchange(List<String>, String) - Constructor for class ch.astorm.smtp4j.protocol.SmtpExchange
- SmtpMessage - Class in ch.astorm.smtp4j.core
-
Represents an SMTP message.
- SmtpMessage(String, List<String>, MimeMessage, String, List<SmtpExchange>) - Constructor for class ch.astorm.smtp4j.core.SmtpMessage
-
Creates a new
SmtpMessagewith the specified parameters. - SmtpMessageHandler - Interface in ch.astorm.smtp4j.core
-
Represents a message handler that will process any incoming message.
- SmtpMessageHandler.SmtpMessageReader - Interface in ch.astorm.smtp4j.core
-
Represents a simple
SmtpMessageiterator. - SmtpProtocolConstants - Class in ch.astorm.smtp4j.protocol
-
Constants for the SMTP protocol.
- SmtpProtocolConstants() - Constructor for class ch.astorm.smtp4j.protocol.SmtpProtocolConstants
- SmtpProtocolException - Exception in ch.astorm.smtp4j.protocol
-
Exception thrown when there is an error during the protocol exchange.
- SmtpProtocolException(String) - Constructor for exception ch.astorm.smtp4j.protocol.SmtpProtocolException
- SmtpProtocolException(String, Throwable) - Constructor for exception ch.astorm.smtp4j.protocol.SmtpProtocolException
- SmtpServer - Class in ch.astorm.smtp4j
-
Simple SMTP server.
- SmtpServer(int) - Constructor for class ch.astorm.smtp4j.SmtpServer
-
Creates a new
SmtpServerwith aDefaultSmtpMessageHandlerinstance to handle received messages. - SmtpServer(int, SmtpMessageHandler, ThreadFactory) - Constructor for class ch.astorm.smtp4j.SmtpServer
-
Creates a new
SmtpServer. - SmtpServerBuilder - Class in ch.astorm.smtp4j
-
Helper to build a new
SmtpServer. - SmtpServerBuilder() - Constructor for class ch.astorm.smtp4j.SmtpServerBuilder
- SmtpServerListener - Interface in ch.astorm.smtp4j.core
-
Represents a server listener.
- SmtpTransactionHandler - Class in ch.astorm.smtp4j.protocol
-
Handles the SMTP protocol.
- SmtpTransactionHandler.MessageReceiver - Interface in ch.astorm.smtp4j.protocol
-
Represents a message receiver within the SMTP transaction.
- SP - Static variable in class ch.astorm.smtp4j.protocol.SmtpProtocolConstants
-
Command-parameter separator.
- start() - Method in class ch.astorm.smtp4j.SmtpServer
-
Starts the server.
- start() - Method in class ch.astorm.smtp4j.SmtpServerBuilder
-
Builds the
SmtpServerand starts it. - subject(String) - Method in class ch.astorm.smtp4j.util.MimeMessageBuilder
-
Defines the message subject.
- subject(String, Charset) - Method in class ch.astorm.smtp4j.util.MimeMessageBuilder
-
Defines the message subject.
T
- to(Address) - Method in class ch.astorm.smtp4j.util.MimeMessageBuilder
-
Adds the
addressto theTOrecipients. - to(String...) - Method in class ch.astorm.smtp4j.util.MimeMessageBuilder
-
Adds the
addressto theTOrecipients. - toRecipient(Message.RecipientType, Address) - Method in class ch.astorm.smtp4j.util.MimeMessageBuilder
-
Adds the
addressto the specified recipienttype. - toRecipient(Message.RecipientType, String...) - Method in class ch.astorm.smtp4j.util.MimeMessageBuilder
-
Adds the
addressto the specified recipienttype.
U
- UNKNOWN - Enum constant in enum class ch.astorm.smtp4j.protocol.SmtpCommand.Type
V
- valueOf(String) - Static method in enum class ch.astorm.smtp4j.protocol.SmtpCommand.Type
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class ch.astorm.smtp4j.protocol.SmtpCommand.Type
-
Returns an array containing the constants of this enum class, in the order they are declared.
- VERIFY - Enum constant in enum class ch.astorm.smtp4j.protocol.SmtpCommand.Type
W
- withListener(SmtpServerListener) - Method in class ch.astorm.smtp4j.SmtpServerBuilder
-
Adds the specified
listeneronce de server is build. - withMessageHandler(SmtpMessageHandler) - Method in class ch.astorm.smtp4j.SmtpServerBuilder
-
Defines the
SmtpMessageHandlerto be applied for the received messages. - withPort(int) - Method in class ch.astorm.smtp4j.SmtpServerBuilder
-
Defines the port on which the
SmtpServerwill listen to. - withThreadFactory(ThreadFactory) - Method in class ch.astorm.smtp4j.SmtpServerBuilder
-
Defines the
ThreadFactoryto use to handle the SMTP messages.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form