hudson.plugins.emailext.plugins
Interface EmailContent

All Known Implementing Classes:

BuildLogContent, BuildNumberContent, BuildStatusContent, BuildURLContent, ChangesSinceLastBuildContent, ChangesSinceLastSuccessfulBuildContent, EnvContent, FailedTestsContent, HudsonURLContent, ProjectNameContent, ProjectURLContent, SVNRevisionContent

public interface EmailContent

Nested Class Summary

static class

EmailContent.Args

Method Summary

java.util.List<java.lang.String>	getArguments() These are the arguments accepted when generating the content for this token.
<P extends hudson.model.AbstractProject<P,B>,B extends hudson.model.AbstractBuild<P,B>> java.lang.String	getContent(hudson.model.AbstractBuild<P,B> build, ExtendedEmailPublisher publisher, EmailType emailType, java.util.Map<java.lang.String,?> args) This method returns the generated content that should replace the token.
java.lang.String	getHelpText() This is a string that will be rendered in the help section of the plugin.
java.lang.String	getToken() This is the token that will be replaced by the content when the email is sent.
boolean	hasNestedContent() Specifies whether or not the content returned by this object can have nested tokens in it that need to be resolved before sending the email.

Method Detail

getToken

java.lang.String getToken()

This is the token that will be replaced by the content when the email is sent. If the email has a string like "$REPLACE_ME", then the implementation of this method should return "REPLACE_ME".

getArguments

java.util.List<java.lang.String> getArguments()

These are the arguments accepted when generating the content for this token.

getHelpText

java.lang.String getHelpText()

This is a string that will be rendered in the help section of the plugin. It describes what the content does and what it puts in the email.

getContent

<P extends hudson.model.AbstractProject<P,B>,B extends hudson.model.AbstractBuild<P,B>> java.lang.String getContent(hudson.model.AbstractBuild<P,B> build,
                                                                                                                    ExtendedEmailPublisher publisher,
                                                                                                                    EmailType emailType,
                                                                                                                    java.util.Map<java.lang.String,?> args)
                            throws java.io.IOException,
                                   java.lang.InterruptedException

This method returns the generated content that should replace the token.

Parameters:

publisher - TODO

args - the arguments for generating the content

Throws:

java.io.IOException

java.lang.InterruptedException

hasNestedContent

boolean hasNestedContent()

Specifies whether or not the content returned by this object can have nested tokens in it that need to be resolved before sending the email.