File	Doc	Category	Size	Date	Package
SMTPClient.java	API Doc	Apache Commons NET 1.4.1 API	25369	Sat Dec 03 10:05:48 GMT 2005	org.apache.commons.net.smtp

SMTPClient

• java.lang.Object
  • SMTP

try {
int reply;
client.connect("mail.foobar.com");
System.out.print(client.getReplyString());

// After connection attempt, you should check the reply code to verify
// success.
reply = client.getReplyCode();

if(!SMTPReply.isPositiveCompletion(reply)) {
client.disconnect();
System.err.println("SMTP server refused connection.");
System.exit(1);
}

// Do useful stuff here.
...
} catch(IOException e) {
if(client.isConnected()) {
try {
client.disconnect();
} catch(IOException f) {
// do nothing
}
}
System.err.println("Could not connect to server.");
e.printStackTrace();
System.exit(1);
}

Fields Summary

Constructors Summary

Methods Summary
public boolean	addRecipient(RelayPath path) Add a recipient for a message using the SMTP RCPT command, specifying a forward relay path. The sender must be set first before any recipients may be specified, otherwise the mail server will reject your commands. param path The forward relay path pointing to the recipient. return True if successfully completed, false if not. exception 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. exception IOException If an I/O error occurs while either sending a command to the server or receiving a reply from the server. return SMTPReply.isPositiveCompletion(rcpt(path.toString()));
public boolean	addRecipient(java.lang.String address) Add a recipient for a message using the SMTP RCPT command, the recipient's email address. The sender must be set first before any recipients may be specified, otherwise the mail server will reject your commands. param address The recipient's email address. return True if successfully completed, false if not. exception 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. exception IOException If an I/O error occurs while either sending a command to the server or receiving a reply from the server. return SMTPReply.isPositiveCompletion(rcpt("<" + address + ">"));
public boolean	completePendingCommand() At least one SMTPClient method ({@link #sendMessageData sendMessageData }) does not complete the entire sequence of SMTP commands to complete a transaction. These types of commands require some action by the programmer after the reception of a positive intermediate command. After the programmer's code completes its actions, it must call this method to receive the completion reply from the server and verify the success of the entire transaction. For example, writer = client.sendMessage(); if(writer == null) // failure return false; header = new SimpleSMTPHeader("foobar@foo.com", "foo@foobar.com", "Re: Foo"); writer.write(header.toString()); writer.write("This is just a test"); writer.close(); if(!client.completePendingCommand()) // failure return false; return True if successfully completed, false if not. exception 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. exception IOException If an I/O error occurs while either sending a command to the server or receiving a reply from the server. return SMTPReply.isPositiveCompletion(getReply());
public java.lang.String	listHelp() Fetches the system help information from the server and returns the full string. return The system help string obtained from the server. null if the information could not be obtained. exception 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. exception IOException If an I/O error occurs while either sending a command to the server or receiving a reply from the server. if (SMTPReply.isPositiveCompletion(help())) return getReplyString(); return null;
public java.lang.String	listHelp(java.lang.String command) Fetches the help information for a given command from the server and returns the full string. param command The command on which to ask for help. return The command help string obtained from the server. null if the information could not be obtained. exception 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. exception IOException If an I/O error occurs while either sending a command to the server or receiving a reply from the server. if (SMTPReply.isPositiveCompletion(help(command))) return getReplyString(); return null;
public boolean	login(java.lang.String hostname) Login to the SMTP server by sending the HELO command with the given hostname as an argument. Before performing any mail commands, you must first login. param hostname The hostname with which to greet the SMTP server. return True if successfully completed, false if not. exception 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. exception IOException If an I/O error occurs while either sending a command to the server or receiving a reply from the server. return SMTPReply.isPositiveCompletion(helo(hostname));
public boolean	login() Login to the SMTP server by sending the HELO command with the client hostname as an argument. Before performing any mail commands, you must first login. return True if successfully completed, false if not. exception 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. exception IOException If an I/O error occurs while either sending a command to the server or receiving a reply from the server. String name; InetAddress host; host = getLocalAddress(); name = host.getHostName(); if (name == null) return false; return SMTPReply.isPositiveCompletion(helo(name));
public boolean	logout() Logout of the SMTP server by sending the QUIT command. return True if successfully completed, false if not. exception 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. exception IOException If an I/O error occurs while either sending a command to the server or receiving a reply from the server. return SMTPReply.isPositiveCompletion(quit());
public boolean	reset() Aborts the current mail transaction, resetting all server stored sender, recipient, and mail data, cleaing all buffers and tables. return True if successfully completed, false if not. exception 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. exception IOException If an I/O error occurs while either sending a command to the server or receiving a reply from the server. return SMTPReply.isPositiveCompletion(rset());
public java.io.Writer	sendMessageData() Send the SMTP DATA command in preparation to send an email message. This method returns a DotTerminatedMessageWriter instance to which the message can be written. Null is returned if the DATA command fails. You must not issue any commands to the SMTP server (i.e., call any (other methods) until you finish writing to the returned Writer instance and close it. The SMTP protocol uses the same stream for issuing commands as it does for returning results. Therefore the returned Writer actually writes directly to the SMTP connection. After you close the writer, you can execute new commands. If you do not follow these requirements your program will not work properly. You can use the provided {@link org.apache.commons.net.smtp.SimpleSMTPHeader} class to construct a bare minimum header. To construct more complicated headers you should refer to RFC 822. When the Java Mail API is finalized, you will be able to use it to compose fully compliant Internet text messages. The DotTerminatedMessageWriter takes care of doubling line-leading dots and ending the message with a single dot upon closing, so all you have to worry about is writing the header and the message. Upon closing the returned Writer, you need to call {@link #completePendingCommand completePendingCommand() } to finalize the transaction and verify its success or failure from the server reply. return A DotTerminatedMessageWriter to which the message (including header) can be written. Returns null if the command fails. exception 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. exception IOException If an I/O error occurs while either sending a command to the server or receiving a reply from the server. if (!SMTPReply.isPositiveIntermediate(data())) return null; return new DotTerminatedMessageWriter(_writer);
public boolean	sendNoOp() Sends a NOOP command to the SMTP server. This is useful for preventing server timeouts. return True if successfully completed, false if not. exception 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. exception IOException If an I/O error occurs while either sending a command to the server or receiving a reply from the server. return SMTPReply.isPositiveCompletion(noop());
public boolean	sendShortMessageData(java.lang.String message) A convenience method for sending short messages. This method fetches the Writer returned by {@link #sendMessageData sendMessageData() } and writes the specified String to it. After writing the message, this method calls {@link #completePendingCommand completePendingCommand() } to finalize the transaction and returns its success or failure. param message The short email message to send. return True if successfully completed, false if not. exception 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. exception IOException If an I/O error occurs while either sending a command to the server or receiving a reply from the server. Writer writer; writer = sendMessageData(); if (writer == null) return false; writer.write(message); writer.close(); return completePendingCommand();
public boolean	sendSimpleMessage(java.lang.String sender, java.lang.String recipient, java.lang.String message) A convenience method for a sending short email without having to explicitly set the sender and recipient(s). This method sets the sender and recipient using {@link #setSender setSender } and {@link #addRecipient addRecipient }, and then sends the message using {@link #sendShortMessageData sendShortMessageData }. param sender The email address of the sender. param recipient The email address of the recipient. param message The short email message to send. return True if successfully completed, false if not. exception 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. exception IOException If an I/O error occurs while either sending a command to the server or receiving a reply from the server. if (!setSender(sender)) return false; if (!addRecipient(recipient)) return false; return sendShortMessageData(message);
public boolean	sendSimpleMessage(java.lang.String sender, java.lang.String[] recipients, java.lang.String message) A convenience method for a sending short email without having to explicitly set the sender and recipient(s). This method sets the sender and recipients using {@link #setSender setSender } and {@link #addRecipient addRecipient }, and then sends the message using {@link #sendShortMessageData sendShortMessageData }. param sender The email address of the sender. param recipients An array of recipient email addresses. param message The short email message to send. return True if successfully completed, false if not. exception 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. exception IOException If an I/O error occurs while either sending a command to the server or receiving a reply from the server. boolean oneSuccess = false; int count; if (!setSender(sender)) return false; for (count = 0; count < recipients.length; count++) { if (addRecipient(recipients[count])) oneSuccess = true; } if (!oneSuccess) return false; return sendShortMessageData(message);
public boolean	setSender(RelayPath path) Set the sender of a message using the SMTP MAIL command, specifying a reverse relay path. The sender must be set first before any recipients may be specified, otherwise the mail server will reject your commands. param path The reverse relay path pointing back to the sender. return True if successfully completed, false if not. exception 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. exception IOException If an I/O error occurs while either sending a command to the server or receiving a reply from the server. return SMTPReply.isPositiveCompletion(mail(path.toString()));
public boolean	setSender(java.lang.String address) Set the sender of a message using the SMTP MAIL command, specifying the sender's email address. The sender must be set first before any recipients may be specified, otherwise the mail server will reject your commands. param address The sender's email address. return True if successfully completed, false if not. exception 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. exception IOException If an I/O error occurs while either sending a command to the server or receiving a reply from the server. return SMTPReply.isPositiveCompletion(mail("<" + address + ">"));
public boolean	verify(java.lang.String username) Verify that a username or email address is valid, i.e., that mail can be delivered to that mailbox on the server. param username The username or email address to validate. return True if the username is valid, false if not. exception 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. exception IOException If an I/O error occurs while either sending a command to the server or receiving a reply from the server. int result; result = vrfy(username); return (result == SMTPReply.ACTION_OK || result == SMTPReply.USER_NOT_LOCAL_WILL_FORWARD);