|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.kohsuke.jnt.JNMailingList
public final class JNMailingList
A mailing list of a project on java.net.
Nested Class Summary | |
---|---|
static class |
JNMailingList.MessagePerMonth
The number of messages posted per month. |
static interface |
JNMailingList.ProgressCallback
Appliation can implement this interface to receive progress reports on subscribing e-mail addresses to a mailing list. |
Method Summary | |
---|---|
void |
delete()
Deletes this mailing list. |
boolean |
equals(Object o)
|
String |
getDescription()
Gets the description of this list. |
List<JNMailingList.MessagePerMonth> |
getMessagesPerMonth()
Returns a list of JNMailingList.MessagePerMonth . |
String |
getName()
Gets the name of ths mailing list, such as "issues" or "cvs". |
String |
getPostAddress()
Gets the e-mail address to post to this list. |
JNProject |
getProject()
Gets the project to which this mailing list belongs. |
List<String> |
getSubscribers(SubscriptionMode mode)
Gets the list of subscriber e-mail addresses. |
int |
getTotalMessages()
Gets the total number of messages this list holds. |
int |
hashCode()
|
int |
massSubscribe(Collection<String> addresses,
SubscriptionMode mode,
JNMailingList.ProgressCallback callback)
Subscribes the specified e-mail addresses to this mailing list. |
int |
massSubscribe(String[] addresses,
SubscriptionMode mode,
JNMailingList.ProgressCallback callback)
Subscribes the specified e-mail addresses to this mailing list. |
int |
massSubscribe(String address,
SubscriptionMode mode)
Subscribes the specified e-mail address to this mailing list. |
int |
massUnsubscribe(Collection<String> addresses,
SubscriptionMode mode,
JNMailingList.ProgressCallback callback)
Unsubscribes the specified e-mail addresses from this mailing list. |
int |
massUnsubscribe(String[] addresses,
SubscriptionMode mode,
JNMailingList.ProgressCallback callback)
Unsubscribes the specified e-mail addresses from this mailing list. |
void |
subscribe(SubscriptionMode mode)
Subscribes yourself. |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public JNProject getProject()
public String getName()
public String getPostAddress()
public String getDescription() throws ProcessingException
In java.net, every mailing list can have a human-readable description associated with it. This method returns it.
TODO: check if the description can contain HTML.
ProcessingException
public int getTotalMessages() throws ProcessingException
ProcessingException
public List<String> getSubscribers(SubscriptionMode mode) throws ProcessingException
This is an admin operation that requires a priviledge.
ProcessingException
public void subscribe(SubscriptionMode mode) throws ProcessingException
ProcessingException
public int massSubscribe(String address, SubscriptionMode mode) throws ProcessingException
Doing this requires that you have a moderator permission on this mailing list.
mode
- the subscription mode that the specified e-mail address uses.
ProcessingException
public int massSubscribe(String[] addresses, SubscriptionMode mode, JNMailingList.ProgressCallback callback) throws ProcessingException
Convenience method to invoke massSubscribe(Collection,SubscriptionMode,ProgressCallback)
ProcessingException
public int massSubscribe(Collection<String> addresses, SubscriptionMode mode, JNMailingList.ProgressCallback callback) throws ProcessingException
Doing this requires that you have a moderator permission on this mailing list.
addresses
- collection of e-mail address of a Collection
of String
s.mode
- the subscription mode that the specified e-mail address uses.callback
- If not null, this interface receives progress indication.
ProcessingException
public int massUnsubscribe(String[] addresses, SubscriptionMode mode, JNMailingList.ProgressCallback callback) throws ProcessingException
Convenience method to invoke massUnsubscribe(Collection,SubscriptionMode,ProgressCallback)
ProcessingException
public int massUnsubscribe(Collection<String> addresses, SubscriptionMode mode, JNMailingList.ProgressCallback callback) throws ProcessingException
Doing this requires that you have a moderator permission on this mailing list.
addresses
- collection of e-mail address of a Collection
of String
s.mode
- the subscription mode that the specified e-mail addresses use.callback
- If not null, this interface receives progress indication.
ProcessingException
public void delete() throws ProcessingException
This is a priviledged operation.
ProcessingException
public List<JNMailingList.MessagePerMonth> getMessagesPerMonth() throws ProcessingException
JNMailingList.MessagePerMonth
.
Becaus of the way java.net is designed, this information is cheap to obtain.
JNMailingList.MessagePerMonth
.
ProcessingException
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |