Class SMTP
- Direct Known Subclasses:
SMTPClient
You should keep in mind that the SMTP server may choose to prematurely
close a connection for various reasons. The SMTP class will detect a
premature SMTP server connection closing when it receives a
SMTPReply.SERVICE_NOT_AVAILABLE response to a command.
When that occurs, the SMTP class method encountering that reply will throw
an
SMTPConnectionClosedException .
SMTPConectionClosedException
is a subclass of IOException
and therefore need not be
caught separately, but if you are going to catch it separately, its
catch block must appear before the more general IOException
catch block. When you encounter an
SMTPConnectionClosedException , you must disconnect the connection with
disconnect()
to properly clean up the system resources used by SMTP. Before
disconnecting, you may check the
last reply code and text with
getReplyCode ,
getReplyString ,
and getReplyStrings.
Rather than list it separately for each method, we mention here that every method communicating with the server and throwing an IOException can also throw a MalformedServerReplyException , which is a subclass of IOException. A MalformedServerReplyException will be thrown when the reply received from the server deviates enough from the protocol specification that it cannot be interpreted in a useful manner despite attempts to be as lenient as possible.
- Author:
- Daniel F. Savarese
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected ProtocolCommandSupport
A ProtocolCommandSupport object used to manage the registering of ProtocolCommandListeners and te firing of ProtocolCommandEvents.static final int
The default SMTP port (25).Fields inherited from class com.oroinc.net.SocketClient
_defaultPort_, _input_, _isConnected_, _output_, _socket_, _socketFactory_, _timeout_, NETASCII_EOL
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
Initiates control connections and gets initial reply.void
Adds a ProtocolCommandListener.int
data()
A convenience method to send the SMTP DATA command to the server, receive the reply, and return the reply code.void
Closes the connection to the SMTP server and sets to null some internal data so that the memory may be reclaimed by the garbage collector.int
A convenience method to send the SMTP VRFY command to the server, receive the reply, and return the reply code.int
getReply()
Fetches a reply from the SMTP server and returns the integer reply code.int
Returns the integer value of the reply code of the last SMTP reply.Returns the entire text of the last SMTP server response exactly as it was received, including all end of line markers in NETASCII format.String[]
Returns the lines of text from the last SMTP server response as an array of strings, one entry per line.int
A convenience method to send the SMTP HELO command to the server, receive the reply, and return the reply code.int
help()
A convenience method to send the SMTP HELP command to the server, receive the reply, and return the reply code.int
A convenience method to send the SMTP HELP command to the server, receive the reply, and return the reply code.int
A convenience method to send the SMTP MAIL command to the server, receive the reply, and return the reply code.int
noop()
A convenience method to send the SMTP NOOP command to the server, receive the reply, and return the reply code.int
quit()
A convenience method to send the SMTP QUIT command to the server, receive the reply, and return the reply code.int
A convenience method to send the SMTP RCPT command to the server, receive the reply, and return the reply code.void
Removes a ProtocolCommandListener.int
rset()
A convenience method to send the SMTP RSET command to the server, receive the reply, and return the reply code.int
A convenience method to send the SMTP SAML command to the server, receive the reply, and return the reply code.int
A convenience method to send the SMTP SEND command to the server, receive the reply, and return the reply code.int
sendCommand
(int command) Sends an SMTP command with no arguments to the server, waits for a reply and returns the numerical response code.int
sendCommand
(int command, String args) Sends an SMTP command to the server, waits for a reply and returns the numerical response code.int
sendCommand
(String command) Sends an SMTP command with no arguments to the server, waits for a reply and returns the numerical response code.int
sendCommand
(String command, String args) Sends an SMTP command to the server, waits for a reply and returns the numerical response code.int
A convenience method to send the SMTP SOML command to the server, receive the reply, and return the reply code.int
turn()
A convenience method to send the SMTP TURN command to the server, receive the reply, and return the reply code.int
A convenience method to send the SMTP VRFY command to the server, receive the reply, and return the reply code.Methods inherited from class com.oroinc.net.SocketClient
connect, connect, connect, connect, connect, connect, getDefaultPort, getDefaultTimeout, getLocalAddress, getLocalPort, getRemoteAddress, getRemotePort, getSoLinger, getSoTimeout, getTcpNoDelay, isConnected, setDefaultPort, setDefaultTimeout, setSocketFactory, setSoLinger, setSoTimeout, setTcpNoDelay, verifyRemote
-
Field Details
-
DEFAULT_PORT
public static final int DEFAULT_PORTThe default SMTP port (25).- See Also:
-
_commandSupport_
A ProtocolCommandSupport object used to manage the registering of ProtocolCommandListeners and te firing of ProtocolCommandEvents.
-
-
Constructor Details
-
SMTP
public SMTP()The default SMTP constructor. Sets the default port toDEFAULT_PORT
and initializes internal data structures for saving SMTP reply information.
-
-
Method Details
-
_connectAction_
Initiates control connections and gets initial reply.- Overrides:
_connectAction_
in classSocketClient
- Throws:
IOException
-
addProtocolCommandListener
Adds a ProtocolCommandListener. Delegates this task to _commandSupport_ .- Parameters:
listener
- The ProtocolCommandListener to add.
-
removeProtocolCommandistener
Removes a ProtocolCommandListener. Delegates this task to _commandSupport_ .- Parameters:
listener
- The ProtocolCommandListener to remove.
-
disconnect
Closes the connection to the SMTP server and sets to null some internal data so that the memory may be reclaimed by the garbage collector. The reply text and code information from the last command is voided so that the memory it used may be reclaimed.- Overrides:
disconnect
in classSocketClient
- Throws:
IOException
- If an error occurs while disconnecting.
-
sendCommand
Sends an SMTP command to the server, waits for a reply and returns the numerical response code. After invocation, for more detailed information, the actual reply text can be accessed by calling getReplyString or getReplyStrings .- Parameters:
command
- The text representation of the SMTP command to send.args
- The arguments to the SMTP command. If this parameter is set to null, then the command is sent with no argument.- Returns:
- The integer value of the SMTP reply code returned by the server in response to the command.
- Throws:
SMTPConnectionClosedException
- If the SMTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send SMTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
sendCommand
Sends an SMTP command to the server, waits for a reply and returns the numerical response code. After invocation, for more detailed information, the actual reply text can be accessed by calling getReplyString or getReplyStrings .- Parameters:
command
- The SMTPCommand constant corresponding to the SMTP command to send.args
- The arguments to the SMTP command. If this parameter is set to null, then the command is sent with no argument.- Returns:
- The integer value of the SMTP reply code returned by the server in response to the command.
- Throws:
SMTPConnectionClosedException
- If the SMTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send SMTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
sendCommand
Sends an SMTP command with no arguments to the server, waits for a reply and returns the numerical response code. After invocation, for more detailed information, the actual reply text can be accessed by calling getReplyString or getReplyStrings .- Parameters:
command
- The text representation of the SMTP command to send.- Returns:
- The integer value of the SMTP reply code returned by the server in response to the command.
- Throws:
SMTPConnectionClosedException
- If the SMTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send SMTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
sendCommand
Sends an SMTP command with no arguments to the server, waits for a reply and returns the numerical response code. After invocation, for more detailed information, the actual reply text can be accessed by calling getReplyString or getReplyStrings .- Parameters:
command
- The SMTPCommand constant corresponding to the SMTP command to send.- Returns:
- The integer value of the SMTP reply code returned by the server in response to the command.
- Throws:
SMTPConnectionClosedException
- If the SMTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send SMTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
getReplyCode
public int getReplyCode()Returns the integer value of the reply code of the last SMTP reply. You will usually only use this method after you connect to the SMTP server to check that the connection was successful sinceconnect
is of type void.- Returns:
- The integer value of the reply code of the last SMTP reply.
-
getReply
Fetches a reply from the SMTP server and returns the integer reply code. After calling this method, the actual reply text can be accessed from either calling getReplyString or getReplyStrings . Only use this method if you are implementing your own SMTP client or if you need to fetch a secondary response from the SMTP server.- Returns:
- The integer value of the reply code of the fetched SMTP reply.
- Throws:
SMTPConnectionClosedException
- If the SMTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send SMTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while receiving the server reply.
-
getReplyStrings
Returns the lines of text from the last SMTP server response as an array of strings, one entry per line. The end of line markers of each are stripped from each line.- Returns:
- The lines of text from the last SMTP response as an array.
-
getReplyString
Returns the entire text of the last SMTP server response exactly as it was received, including all end of line markers in NETASCII format.- Returns:
- The entire text from the last SMTP response as a String.
-
helo
A convenience method to send the SMTP HELO command to the server, receive the reply, and return the reply code.- Parameters:
hostname
- The hostname of the sender.- Returns:
- The reply code received from the server.
- Throws:
SMTPConnectionClosedException
- If the SMTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send SMTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
mail
A convenience method to send the SMTP MAIL command to the server, receive the reply, and return the reply code.- Parameters:
reversePath
- The reverese path.- Returns:
- The reply code received from the server.
- Throws:
SMTPConnectionClosedException
- If the SMTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send SMTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
rcpt
A convenience method to send the SMTP RCPT command to the server, receive the reply, and return the reply code.- Parameters:
forwardPath
- The forward path.- Returns:
- The reply code received from the server.
- Throws:
SMTPConnectionClosedException
- If the SMTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send SMTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
data
A convenience method to send the SMTP DATA command to the server, receive the reply, and return the reply code.- Returns:
- The reply code received from the server.
- Throws:
SMTPConnectionClosedException
- If the SMTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send SMTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
send
A convenience method to send the SMTP SEND command to the server, receive the reply, and return the reply code.- Parameters:
reversePath
- The reverese path.- Returns:
- The reply code received from the server.
- Throws:
SMTPConnectionClosedException
- If the SMTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send SMTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
soml
A convenience method to send the SMTP SOML command to the server, receive the reply, and return the reply code.- Parameters:
reversePath
- The reverese path.- Returns:
- The reply code received from the server.
- Throws:
SMTPConnectionClosedException
- If the SMTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send SMTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
saml
A convenience method to send the SMTP SAML command to the server, receive the reply, and return the reply code.- Parameters:
reversePath
- The reverese path.- Returns:
- The reply code received from the server.
- Throws:
SMTPConnectionClosedException
- If the SMTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send SMTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
rset
A convenience method to send the SMTP RSET command to the server, receive the reply, and return the reply code.- Returns:
- The reply code received from the server.
- Throws:
SMTPConnectionClosedException
- If the SMTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send SMTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
vrfy
A convenience method to send the SMTP VRFY command to the server, receive the reply, and return the reply code.- Parameters:
user
- The user address to verify.- Returns:
- The reply code received from the server.
- Throws:
SMTPConnectionClosedException
- If the SMTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send SMTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
expn
A convenience method to send the SMTP VRFY command to the server, receive the reply, and return the reply code.- Parameters:
name
- The name to expand.- Returns:
- The reply code received from the server.
- Throws:
SMTPConnectionClosedException
- If the SMTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send SMTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
help
A convenience method to send the SMTP HELP command to the server, receive the reply, and return the reply code.- Returns:
- The reply code received from the server.
- Throws:
SMTPConnectionClosedException
- If the SMTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send SMTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
help
A convenience method to send the SMTP HELP command to the server, receive the reply, and return the reply code.- Parameters:
command
- The command name on which to request help.- Returns:
- The reply code received from the server.
- Throws:
SMTPConnectionClosedException
- If the SMTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send SMTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
noop
A convenience method to send the SMTP NOOP command to the server, receive the reply, and return the reply code.- Returns:
- The reply code received from the server.
- Throws:
SMTPConnectionClosedException
- If the SMTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send SMTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
turn
A convenience method to send the SMTP TURN command to the server, receive the reply, and return the reply code.- Returns:
- The reply code received from the server.
- Throws:
SMTPConnectionClosedException
- If the SMTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send SMTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-
quit
A convenience method to send the SMTP QUIT command to the server, receive the reply, and return the reply code.- Returns:
- The reply code received from the server.
- Throws:
SMTPConnectionClosedException
- If the SMTP server prematurely closes the connection as a result of the client being idle or some other reason causing the server to send SMTP reply code 421. This exception may be caught either as an IOException or independently as itself.IOException
- If an I/O error occurs while either sending the command or receiving the server reply.
-