| java.lang.Object org.clapper.curn.plugins.EmailOutputPlugIn
EmailOutputPlugIn | public class EmailOutputPlugIn implements MainConfigItemPlugIn,PreFeedOutputPlugIn,PostOutputPlugIn(Code) | | The EmailOutputPlugIn handles emailing the output from a
curn run, if one or more email addresses are specified in the
configuration file. It intercepts the following main ([curn])
section configuration parameters:
Parameter |
Meaning |
Default |
MailOutputTo |
One or more comma- or blank-separated email addresses to receive
an email containing the output. |
None |
MailFrom |
The email address to use as the sender of the message. |
The user running curn, and the current machine. |
MailSubject |
The subject to use for email messages. |
"RSS Feeds" |
MailIndividualArticles |
If set to true (or yes or 1),
curn will send each RSS article individually--i.e.,
one article per email. Otherwise, it sends all the articles from
all feeds in a single email. |
false (i.e., send one email with all articles) |
version: $Revision: 7041 $ |
EmailOutputPlugIn | public EmailOutputPlugIn()(Code) | | Default constructor (required).
|
getPlugInName | public String getPlugInName()(Code) | | Get a displayable name for the plug-in.
the name |
getPlugInSortKey | public String getPlugInSortKey()(Code) | | Get the sort key for this plug-in.
the sort key string. |
initPlugIn | public void initPlugIn() throws CurnException(Code) | | Initialize the plug-in. This method is called before any of the
plug-in methods are called.
throws: CurnException - on error |
runMainConfigItemPlugIn | public void runMainConfigItemPlugIn(String sectionName, String paramName, CurnConfig config) throws CurnException(Code) | | Called immediately after curn has read and processed a
configuration item in the main [curn] configuration section. All
configuration items are passed, one by one, to each loaded plug-in.
If a plug-in class is not interested in a particular configuration
item, this method should simply return without doing anything. Note
that some configuration items may simply be variable assignment;
there's no real way to distinguish a variable assignment from a
blessed configuration item.
Parameters: sectionName - the name of the configuration section wherethe item was found Parameters: paramName - the name of the parameter Parameters: config - the CurnConfig object throws: CurnException - on error See Also: CurnConfig |
runPostOutputPlugIn | public void runPostOutputPlugIn(Collection<OutputHandler> outputHandlers) throws CurnException(Code) | | Called after curn has flushed all output handlers. A
post-output plug-in is a useful place to consolidate the output from
all output handlers. For instance, such a plug-in might pack all the
output into a zip file, or email it.
Parameters: outputHandlers - a Collection of theOutputHandler objects (useful forobtaining the output files, for instance). throws: CurnException - on error See Also: OutputHandler |
runPreFeedOutputPlugIn | public void runPreFeedOutputPlugIn(FeedInfo feedInfo, RSSChannel channel, OutputHandler outputHandler) throws CurnException(Code) | | Called immediately before a parsed feed is passed to an output
handler. This method cannot affect the feed's processing. (The time
to stop the processing of a feed is in one of the other, preceding
phases.) This method will be called multiple times for each feed if
there are multiple output handlers.
Parameters: feedInfo - the FeedInfo object for the feed thathas been downloaded and parsed. Parameters: channel - the parsed channel data. The plug-in is freeto edit this data; it's receiving a copythat's specific to the output handler. Parameters: outputHandler - the OutputHandler that is about to becalled. This object is read-only. throws: CurnException - on error See Also: RSSChannel See Also: FeedInfo |
|
|