org.apache.commons.net.nntp
public class SimpleNNTPHeader extends Object
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;
Constructor Summary | |
---|---|
SimpleNNTPHeader(String from, String subject)
Creates a new SimpleNNTPHeader instance initialized with the given
from and subject header field values.
|
Method Summary | |
---|---|
void | addHeaderField(String headerField, String value)
Adds an arbitrary header field with the given value to the article
header. |
void | addNewsgroup(String newsgroup)
Adds a newsgroup to the article Newsgroups: field.
|
String | getFromAddress()
Returns the address used in the From: header field.
|
String | getNewsgroups()
Returns the contents of the Newsgroups: header field.
|
String | getSubject()
Returns the subject used in the Subject: header field.
|
Parameters: from The value of the From:
header field. This
should be the article poster's email address. subject The value of the Subject:
header field.
This should be the subject of the article.
header.addHeaderField("Organization", "Foobar, Inc.");
Parameters: headerField The header field to add, not including the colon. value The value of the added header field.
Newsgroups:
field.
Parameters: newsgroup The newsgroup to add to the article's newsgroup distribution list.
From:
header field.
Returns: The from address.
Newsgroups:
header field.
Returns: The comma-separated list of newsgroups to which the article is being posted.
Subject:
header field.
Returns: The subject.