hudson.tasks
Class Mailer

java.lang.Object
  extended by hudson.tasks.BuildStepCompatibilityLayer
      extended by hudson.tasks.Publisher
          extended by hudson.tasks.Notifier
              extended by hudson.tasks.Mailer
All Implemented Interfaces:
hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.Publisher>, hudson.tasks.BuildStep

public class Mailer
extends hudson.tasks.Notifier

Publisher that sends the build result in e-mail.

Author:
Kohsuke Kawaguchi

Nested Class Summary
static class Mailer.DescriptorImpl
           
static class Mailer.UserProperty
          Per user property that is e-mail address.
 
Nested classes/interfaces inherited from class hudson.tasks.Publisher
hudson.tasks.Publisher.DescriptorExtensionListImpl
 
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson
 
Nested classes/interfaces inherited from interface hudson.tasks.BuildStep
hudson.tasks.BuildStep.PublisherList
 
Field Summary
static boolean debug
          Debug probe point to be activated by the scripting console.
static Mailer.DescriptorImpl DESCRIPTOR
          Deprecated. as of 1.286 Use descriptor() to obtain the current instance.
 boolean dontNotifyEveryUnstableBuild
          If true, only the first unstable build will be reported.
protected static Logger LOGGER
           
 String recipients
          Whitespace-separated list of e-mail addresses that represent recipients.
 boolean sendToIndividuals
          If true, individuals will receive e-mails regarding who broke the build.
 
Fields inherited from interface hudson.tasks.BuildStep
BUILDERS, PUBLISHERS
 
Constructor Summary
Mailer()
           
 
Method Summary
static Mailer.DescriptorImpl descriptor()
           
 hudson.tasks.BuildStepMonitor getRequiredMonitorService()
          This class does explicit check pointing.
 boolean perform(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener)
           
static javax.mail.internet.InternetAddress StringToAddress(String strAddress, String charset)
           
 
Methods inherited from class hudson.tasks.Notifier
getDescriptor
 
Methods inherited from class hudson.tasks.Publisher
all, getProjectAction, needsToRunAfterFinalized, prebuild
 
Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer
getProjectAction, getProjectActions, perform, prebuild
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface hudson.tasks.BuildStep
getProjectAction, getProjectActions, prebuild
 

Field Detail

LOGGER

protected static final Logger LOGGER

recipients

public String recipients
Whitespace-separated list of e-mail addresses that represent recipients.


dontNotifyEveryUnstableBuild

public boolean dontNotifyEveryUnstableBuild
If true, only the first unstable build will be reported.


sendToIndividuals

public boolean sendToIndividuals
If true, individuals will receive e-mails regarding who broke the build.


DESCRIPTOR

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
@RestrictedSince(value="1.355")
public static Mailer.DescriptorImpl DESCRIPTOR
Deprecated. as of 1.286 Use descriptor() to obtain the current instance.

debug

public static boolean debug
Debug probe point to be activated by the scripting console.

Constructor Detail

Mailer

public Mailer()
Method Detail

perform

public boolean perform(hudson.model.AbstractBuild<?,?> build,
                       hudson.Launcher launcher,
                       hudson.model.BuildListener listener)
                throws IOException,
                       InterruptedException
Specified by:
perform in interface hudson.tasks.BuildStep
Overrides:
perform in class hudson.tasks.BuildStepCompatibilityLayer
Throws:
IOException
InterruptedException

getRequiredMonitorService

public hudson.tasks.BuildStepMonitor getRequiredMonitorService()
This class does explicit check pointing.


StringToAddress

public static javax.mail.internet.InternetAddress StringToAddress(String strAddress,
                                                                  String charset)
                                                           throws javax.mail.internet.AddressException,
                                                                  UnsupportedEncodingException
Throws:
javax.mail.internet.AddressException
UnsupportedEncodingException

descriptor

public static Mailer.DescriptorImpl descriptor()


Copyright © 2004-2013. All Rights Reserved.