org.apache.tools.mail
Class MailMessage
java.lang.Object
org.apache.tools.mail.MailMessage
public class MailMessage
extends java.lang.Object
A class to help send SMTP email.
This class is an improvement on the sun.net.smtp.SmtpClient class
found in the JDK. This version has extra functionality, and can be used
with JVMs that did not extend from the JDK. It's not as robust as
the JavaMail Standard Extension classes, but it's easier to use and
easier to install, and has an Open Source license.
It can be used like this:
String mailhost = "localhost"; // or another mail host
String from = "Mail Message Servlet <MailMessage@server.com>";
String to = "to@you.com";
String cc1 = "cc1@you.com";
String cc2 = "cc2@you.com";
String bcc = "bcc@you.com";
MailMessage msg = new MailMessage(mailhost);
msg.setPort(25);
msg.from(from);
msg.to(to);
msg.cc(cc1);
msg.cc(cc2);
msg.bcc(bcc);
msg.setSubject("Test subject");
PrintStream out = msg.getPrintStream();
Enumeration enum = req.getParameterNames();
while (enum.hasMoreElements()) {
String name = (String)enum.nextElement();
String value = req.getParameter(name);
out.println(name + " = " + value);
}
msg.sendAndClose();
Be sure to set the from address, then set the recepient
addresses, then set the subject and other headers, then get the
PrintStream, then write the message, and finally send and close.
The class does minimal error checking internally; it counts on the mail
host to complain if there's any malformatted input or out of order
execution.
An attachment mechanism based on RFC 1521 could be implemented on top of
this class. In the meanwhile, JavaMail is the best solution for sending
email with attachments.
Still to do:
- Figure out how to close the connection in case of error
1.1, 2000/03/19, added angle brackets to address, helps some servers
version 1.0, 1999/12/29
MailMessage() - Constructs a new MailMessage to send an email.
|
MailMessage(String host) - Constructs a new MailMessage to send an email.
|
MailMessage(String host, int port) - Constructs a new MailMessage to send an email.
|
void | bcc(String bcc) - Sets the bcc address.
|
void | cc(String cc) - Sets the cc address.
|
void | from(String from) - Sets the from address.
|
PrintStream | getPrintStream() - Returns a PrintStream that can be used to write the body of the message.
|
void | replyto(String rto) - Sets the replyto address
This method may be
called multiple times.
|
void | sendAndClose() - Sends the message and closes the connection to the server.
|
void | setHeader(String name, String value) - Sets the named header to the given value.
|
void | setPort(int port) - Set the port to connect to the SMTP host.
|
void | setSubject(String subj) - Sets the subject of the mail message.
|
void | to(String to) - Sets the to address.
|
DEFAULT_HOST
public static final String DEFAULT_HOST
default mailhost
DEFAULT_PORT
public static final int DEFAULT_PORT
default port for SMTP: 25
MailMessage
public MailMessage()
throws IOException
Constructs a new MailMessage to send an email.
Use localhost as the mail server with port 25.
MailMessage
public MailMessage(String host)
throws IOException
Constructs a new MailMessage to send an email.
Use the given host as the mail server with port 25.
host
- the mail server to use
MailMessage
public MailMessage(String host,
int port)
throws IOException
Constructs a new MailMessage to send an email.
Use the given host and port as the mail server.
host
- the mail server to useport
- the port to connect to
bcc
public void bcc(String bcc)
throws IOException
Sets the bcc address. Does NOT set any header since it's a *blind* copy.
This method may be called multiple times.
cc
public void cc(String cc)
throws IOException
Sets the cc address. Also sets the "Cc" header. This method may be
called multiple times.
from
public void from(String from)
throws IOException
Sets the from address. Also sets the "From" header. This method should
be called only once.
getPrintStream
public PrintStream getPrintStream()
throws IOException
Returns a PrintStream that can be used to write the body of the message.
A stream is used since email bodies are byte-oriented. A writer can
be wrapped on top if necessary for internationalization.
This is actually done in Message.java
- a printstream containing the data and the headers of the email
replyto
public void replyto(String rto)
Sets the replyto address
This method may be
called multiple times.
rto
- the replyto address
sendAndClose
public void sendAndClose()
throws IOException
Sends the message and closes the connection to the server.
The MailMessage object cannot be reused.
setHeader
public void setHeader(String name,
String value)
Sets the named header to the given value. RFC 822 provides the rules for
what text may constitute a header name and value.
name
- name of the headervalue
- contents of the header
setPort
public void setPort(int port)
Set the port to connect to the SMTP host.
port
- the port to use for connection.
setSubject
public void setSubject(String subj)
Sets the subject of the mail message. Actually sets the "Subject"
header.
subj
- the subject of the mail message
to
public void to(String to)
throws IOException
Sets the to address. Also sets the "To" header. This method may be
called multiple times.
Copyright B) 2000-2008 Apache Software Foundation. All Rights Reserved.