public class ExtendedEmailPublisher
extends hudson.tasks.Notifier
implements hudson.matrix.MatrixAggregatable
Publisher
that sends notification e-mail.hudson.tasks.Publisher.DescriptorExtensionListImpl
Modifier and Type | Field and Description |
---|---|
boolean |
attachBuildLog
True to attach the log from the build to the email.
|
String |
attachmentsPattern
The project wide set of attachments.
|
boolean |
compressBuildLog
True to compress the log from the build before attaching to the email
|
List<EmailTrigger> |
configuredTriggers
This is the list of email theTriggers that the project has configured
|
String |
contentType
The contentType of the emails for this project (text/html, text/plain,
etc).
|
static String |
DEFAULT_BODY_TEXT |
static String |
DEFAULT_EMERGENCY_REROUTE_TEXT |
static String |
DEFAULT_SUBJECT_TEXT |
String |
defaultContent
The default body of the emails for this project.
|
String |
defaultSubject
The default subject of the emails for this project.
|
boolean |
disabled
If true, disables the publisher from running.
|
String |
from
From value for the e-mail
|
MatrixTriggerMode |
matrixTriggerMode
How to theTrigger the email if the project is a matrix project.
|
static String |
PROJECT_DEFAULT_BODY_TEXT |
static String |
PROJECT_DEFAULT_SUBJECT_TEXT |
String |
recipientList
A comma-separated list of email recipient that will be used for every
theTrigger.
|
String |
replyTo
Reply-To value for the e-mail
|
boolean |
saveOutput
If true, save the generated email content to email-ext-message.[txt|html]
|
Constructor and Description |
---|
ExtendedEmailPublisher() |
ExtendedEmailPublisher(String project_recipient_list,
String project_content_type,
String project_default_subject,
String project_default_content,
String project_attachments,
String project_presend_script,
int project_attach_buildlog,
String project_replyto,
String project_from,
boolean project_save_output,
List<EmailTrigger> project_triggers,
MatrixTriggerMode matrixTriggerMode)
Deprecated.
|
ExtendedEmailPublisher(String project_recipient_list,
String project_content_type,
String project_default_subject,
String project_default_content,
String project_attachments,
String project_presend_script,
int project_attach_buildlog,
String project_replyto,
String project_from,
boolean project_save_output,
List<EmailTrigger> project_triggers,
MatrixTriggerMode matrixTriggerMode,
boolean project_disabled,
List<GroovyScriptPath> classpath) |
Modifier and Type | Method and Description |
---|---|
hudson.matrix.MatrixAggregator |
createAggregator(hudson.matrix.MatrixBuild matrixbuild,
hudson.Launcher launcher,
hudson.model.BuildListener buildlistener) |
void |
debug(PrintStream p,
String format,
Object... args) |
static ExtendedEmailPublisherDescriptor |
descriptor() |
List<GroovyScriptPath> |
getClasspath() |
List<EmailTrigger> |
getConfiguredTriggers()
Get the list of configured email theTriggers for this project.
|
ExtendedEmailPublisherDescriptor |
getDescriptor() |
MatrixTriggerMode |
getMatrixTriggerMode() |
String |
getPostsendScript() |
String |
getPresendScript() |
static hudson.model.Run<?,?> |
getPreviousRun(hudson.model.Run<?,?> run,
hudson.model.TaskListener listener)
Looks for a previous build, so long as that is in fact completed.
|
Collection<? extends hudson.model.Action> |
getProjectActions(hudson.model.AbstractProject<?,?> project) |
hudson.tasks.BuildStepMonitor |
getRequiredMonitorService() |
List<org.jenkinsci.plugins.tokenmacro.TokenMacro> |
getRuntimeMacros(ExtendedEmailPublisherContext context) |
boolean |
isExecuteOnMatrixNodes() |
boolean |
needsToRunAfterFinalized() |
boolean |
perform(hudson.model.AbstractBuild<?,?> build,
hudson.Launcher launcher,
hudson.model.BuildListener listener) |
boolean |
prebuild(hudson.model.AbstractBuild<?,?> build,
hudson.model.BuildListener listener) |
Object |
readResolve() |
void |
setClasspath(List<GroovyScriptPath> classpath) |
void |
setMatrixTriggerMode(MatrixTriggerMode matrixTriggerMode) |
void |
setPostsendScript(String postsendScript) |
void |
setPresendScript(String presendScript) |
public static final String DEFAULT_SUBJECT_TEXT
public static final String DEFAULT_BODY_TEXT
public static final String DEFAULT_EMERGENCY_REROUTE_TEXT
public static final String PROJECT_DEFAULT_SUBJECT_TEXT
public static final String PROJECT_DEFAULT_BODY_TEXT
public String recipientList
public List<EmailTrigger> configuredTriggers
public String contentType
public String defaultSubject
public String defaultContent
public String attachmentsPattern
public boolean attachBuildLog
public boolean compressBuildLog
public String replyTo
public String from
public boolean saveOutput
public boolean disabled
public MatrixTriggerMode matrixTriggerMode
public ExtendedEmailPublisher()
@Deprecated public ExtendedEmailPublisher(String project_recipient_list, String project_content_type, String project_default_subject, String project_default_content, String project_attachments, String project_presend_script, int project_attach_buildlog, String project_replyto, String project_from, boolean project_save_output, List<EmailTrigger> project_triggers, MatrixTriggerMode matrixTriggerMode)
@DataBoundConstructor public ExtendedEmailPublisher(String project_recipient_list, String project_content_type, String project_default_subject, String project_default_content, String project_attachments, String project_presend_script, int project_attach_buildlog, String project_replyto, String project_from, boolean project_save_output, List<EmailTrigger> project_triggers, MatrixTriggerMode matrixTriggerMode, boolean project_disabled, List<GroovyScriptPath> classpath)
public List<GroovyScriptPath> getClasspath()
public void setClasspath(List<GroovyScriptPath> classpath)
public void setPresendScript(String presendScript)
@DataBoundSetter public void setPostsendScript(String postsendScript)
public String getPresendScript()
public String getPostsendScript()
public List<EmailTrigger> getConfiguredTriggers()
public MatrixTriggerMode getMatrixTriggerMode()
public void setMatrixTriggerMode(MatrixTriggerMode matrixTriggerMode)
public Collection<? extends hudson.model.Action> getProjectActions(hudson.model.AbstractProject<?,?> project)
getProjectActions
in interface hudson.tasks.BuildStep
getProjectActions
in class hudson.tasks.BuildStepCompatibilityLayer
public void debug(PrintStream p, String format, Object... args)
public boolean prebuild(hudson.model.AbstractBuild<?,?> build, hudson.model.BuildListener listener)
prebuild
in interface hudson.tasks.BuildStep
prebuild
in class hudson.tasks.BuildStepCompatibilityLayer
public boolean perform(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener) throws InterruptedException, IOException
perform
in interface hudson.tasks.BuildStep
perform
in class hudson.tasks.BuildStepCompatibilityLayer
InterruptedException
IOException
public List<org.jenkinsci.plugins.tokenmacro.TokenMacro> getRuntimeMacros(ExtendedEmailPublisherContext context)
public boolean isExecuteOnMatrixNodes()
public boolean needsToRunAfterFinalized()
needsToRunAfterFinalized
in class hudson.tasks.Publisher
public hudson.tasks.BuildStepMonitor getRequiredMonitorService()
getRequiredMonitorService
in interface hudson.tasks.BuildStep
@CheckForNull public static hudson.model.Run<?,?> getPreviousRun(@Nonnull hudson.model.Run<?,?> run, hudson.model.TaskListener listener)
getRequiredMonitorService()
does not wait for the
previous build, so in the case of parallel-capable jobs, we need to
behave sensibly when a later build actually finishes before an earlier
one.run
- a run for which we may be sending maillistener
- a listener to which we may print warnings in case the
actual previous build is still in progresspublic ExtendedEmailPublisherDescriptor getDescriptor()
getDescriptor
in interface hudson.model.Describable<hudson.tasks.Publisher>
getDescriptor
in class hudson.tasks.Notifier
public static ExtendedEmailPublisherDescriptor descriptor()
public hudson.matrix.MatrixAggregator createAggregator(hudson.matrix.MatrixBuild matrixbuild, hudson.Launcher launcher, hudson.model.BuildListener buildlistener)
createAggregator
in interface hudson.matrix.MatrixAggregatable
public Object readResolve()
Copyright © 2016–2020. All rights reserved.