| java.lang.Object
 org.apache.commons.net.smtp.SimpleSMTPHeader
| SimpleSMTPHeader | | public class SimpleSMTPHeader (Code) | | This class is used to construct a bare minimum
acceptable header for an email message. 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 main purpose of the class is to faciliatate the mail sending
process, by relieving the programmer from having to explicitly format
a simple message header. For example:
writer = client.sendMessageData();
if(writer == null) // failure
return false;
header =
new SimpleSMTPHeader("foobar@foo.com", "foo@bar.com" "Just testing");
header.addCC("bar@foo.com");
header.addHeaderField("Organization", "Foobar, Inc.");
writer.write(header.toString());
writer.write("This is just a test");
writer.close();
if(!client.completePendingCommand()) // failure
return false;
author:
Daniel F. Savarese
See Also: SMTPClient |
| Constructor Summary | |
| public | SimpleSMTPHeader(String from, String to, String subject)
Creates a new SimpleSMTPHeader instance initialized with the given
from, to, and subject header field values.
Parameters:
from - The value of the From: header field. |
| Method Summary | |
| public void | addCC(String address)
Add an email address to the CC (carbon copy or courtesy copy) list. | | public void | addHeaderField(String headerField, String value)
Adds an arbitrary header field with the given value to the article
header. | | public String | toString()
Converts the SimpleSMTPHeader to a properly formatted header in
the form of a String, including the blank line used to separate
the header from the article body. |
| SimpleSMTPHeader | | public SimpleSMTPHeader(String from, String to, String subject)(Code) | | Creates a new SimpleSMTPHeader instance initialized with the given
from, to, and subject header field values.
Parameters:
from - The value of the From: header field. Thisshould be the sender's email address.
Parameters:
to - The value of the To: header field. Thisshould be the recipient's email address.
Parameters:
subject - The value of the Subject: header field.This should be the subject of the message. |
| addCC | | public void addCC(String address)(Code) | | Add an email address to the CC (carbon copy or courtesy copy) list.
Parameters:
address - The email address to add to the CC list. |
| addHeaderField | | public void addHeaderField(String headerField, String value)(Code) | | Adds an arbitrary header field with the given value to the article
header. These headers will be written before the From, To, Subject, and
Cc fields when the SimpleSMTPHeader is convertered to a string.
An example use would be:
header.addHeaderField("Organization", "Foobar, Inc.");
Parameters:
headerField - The header field to add, not including the colon.
Parameters:
value - The value of the added header field. |
| toString | | public String toString()(Code) | | Converts the SimpleSMTPHeader to a properly formatted header in
the form of a String, including the blank line used to separate
the header from the article body. The header fields CC and Subject
are only included when they are non-null.
The message header in the form of a String. |
|
|