| java.lang.Object
 org.apache.commons.net.nntp.SimpleNNTPHeader
| SimpleNNTPHeader | | public class SimpleNNTPHeader (Code) | | This class is used to construct the bare minimum
acceptable header for most news readers. 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 article posting
process, by relieving the programmer from having to explicitly format
an article header. For example:
writer = client.postArticle();
if(writer == null) // failure
return false;
header = new SimpleNNTPHeader("foobar@foo.com", "Just testing");
header.addNewsgroup("alt.test");
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: NNTPClient |
| Constructor Summary | |
| public | SimpleNNTPHeader(String from, String subject)
Creates a new SimpleNNTPHeader instance initialized with the given
from and subject header field values.
Parameters:
from - The value of the From: header field. |
| Method Summary | |
| public void | addHeaderField(String headerField, String value)
Adds an arbitrary header field with the given value to the article
header. | | public void | addNewsgroup(String newsgroup)
Adds a newsgroup to the article Newsgroups: field. | | public String | getFromAddress()
Returns the address used in the From: header field. | | public String | getNewsgroups()
Returns the contents of the Newsgroups: header field. | | public String | getSubject()
Returns the subject used in the Subject: header field. | | public String | toString()
Converts the SimpleNNTPHeader to a properly formatted header in
the form of a String, including the blank line used to separate
the header from the article body. |
| SimpleNNTPHeader | | public SimpleNNTPHeader(String from, String subject)(Code) | | Creates a new SimpleNNTPHeader instance initialized with the given
from and subject header field values.
Parameters:
from - The value of the From: header field. Thisshould be the article poster's email address.
Parameters:
subject - The value of the Subject: header field.This should be the subject of the article. |
| 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 after the From, Newsgroups,
and Subject fields when the SimpleNNTPHeader 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. |
| addNewsgroup | | public void addNewsgroup(String newsgroup)(Code) | | Adds a newsgroup to the article Newsgroups: field.
Parameters:
newsgroup - The newsgroup to add to the article's newsgroupdistribution list. |
| getFromAddress | | public String getFromAddress()(Code) | | Returns the address used in the From: header field.
The from address. |
| getNewsgroups | | public String getNewsgroups()(Code) | | Returns the contents of the Newsgroups: header field.
The comma-separated list of newsgroups to which the articleis being posted. |
| getSubject | | public String getSubject()(Code) | | Returns the subject used in the Subject: header field.
The subject. |
| toString | | public String toString()(Code) | | Converts the SimpleNNTPHeader 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 article header in the form of a String. |
|
|