hudson.plugins.emailext.plugins
Interface EmailContent

All Known Implementing Classes:

BuildNumberContent, BuildStatusContent, BuildURLContent, ChangesSinceLastBuildContent, ChangesSinceLastSuccessfulBuildContent, HudsonURLContent, ProjectNameContent, ProjectURLContent

public interface EmailContent

Method Summary

<P extends hudson.model.Project<P,B>,B extends hudson.model.Build<P,B>> java.lang.String	getContent(hudson.model.Build<P,B> build, EmailType emailType) 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".

getContent

<P extends hudson.model.Project<P,B>,B extends hudson.model.Build<P,B>> java.lang.String getContent(hudson.model.Build<P,B> build,
                                                                                                    EmailType emailType)

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

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.

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.