hudson.tasks

Class Mailer.DescriptorImpl

java.lang.Object

hudson.model.Descriptor<T>

hudson.tasks.BuildStepDescriptor<Publisher>

hudson.tasks.Mailer.DescriptorImpl

All Implemented Interfaces:

Saveable, OnMaster

Enclosing class:

Mailer

@Extension
public static final class Mailer.DescriptorImpl
extends BuildStepDescriptor<Publisher>

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Descriptor

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor and Description
DescriptorImpl()

Method Summary

Modifier and Type	Method and Description
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject json)
javax.mail.Session	createSession() Creates a JavaMail session.
FormValidation	doAddressCheck(String value)
FormValidation	doCheckDefaultSuffix(String value)
FormValidation	doCheckSmtpServer(String value)
FormValidation	doSendTestMail(String smtpServer, String adminAddress, boolean useSmtpAuth, String smtpAuthUserName, Secret smtpAuthPasswordSecret, boolean useSsl, String smtpPort, String charset, String sendTestMailTo) Send an email to the admin address
String	getAdminAddress() Deprecated. as of 1.4 Use JenkinsLocationConfiguration instead
String	getCharset()
String	getDefaultSuffix()
String	getDisplayName()
String	getReplyToAddress()
String	getSmtpAuthPassword()
Secret	getSmtpAuthPasswordSecret()
String	getSmtpAuthUserName()
String	getSmtpHost()
String	getSmtpPort()
String	getSmtpServer()
String	getUrl() Deprecated. as of 1.4 Use JenkinsLocationConfiguration instead
boolean	getUseSsl()
boolean	isApplicable(Class<? extends AbstractProject> jobType)
Publisher	newInstance(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData)
void	setAdminAddress(String adminAddress) Deprecated. as of 1.4 Use JenkinsLocationConfiguration instead
void	setCharset(String chaset)
void	setDefaultSuffix(String defaultSuffix)
void	setHudsonUrl(String hudsonUrl) Deprecated. as of 1.4 Use JenkinsLocationConfiguration instead
void	setReplyToAddress(String address)
void	setSmtpAuth(String userName, String password)
void	setSmtpHost(String smtpHost)
void	setSmtpPort(String smtpPort)
void	setUseSsl(boolean useSsl)

Methods inherited from class hudson.tasks.BuildStepDescriptor

filter

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DescriptorImpl

public DescriptorImpl()

Method Detail

getDisplayName

public String getDisplayName()

Overrides:

getDisplayName in class Descriptor<Publisher>

getDefaultSuffix

public String getDefaultSuffix()

getReplyToAddress

public String getReplyToAddress()

setReplyToAddress

public void setReplyToAddress(String address)

createSession

public javax.mail.Session createSession()

Creates a JavaMail session.

Returns:

mail session based on the underlying session parameters.

configure

public boolean configure(org.kohsuke.stapler.StaplerRequest req,
                         net.sf.json.JSONObject json)
                  throws Descriptor.FormException

Overrides:

configure in class Descriptor<Publisher>

Throws:

Descriptor.FormException

getSmtpServer

public String getSmtpServer()

getAdminAddress

public String getAdminAddress()

Deprecated. as of 1.4 Use JenkinsLocationConfiguration instead

Returns:

administrator mail address

getUrl

public String getUrl()

Deprecated. as of 1.4 Use JenkinsLocationConfiguration instead

Returns:

Jenkins base URL

getSmtpAuthUserName

public String getSmtpAuthUserName()

getSmtpAuthPassword

public String getSmtpAuthPassword()

getSmtpAuthPasswordSecret

public Secret getSmtpAuthPasswordSecret()

getUseSsl

public boolean getUseSsl()

getSmtpPort

public String getSmtpPort()

getSmtpHost

public String getSmtpHost()

getCharset

public String getCharset()

setDefaultSuffix

public void setDefaultSuffix(String defaultSuffix)

setHudsonUrl

public void setHudsonUrl(String hudsonUrl)

Deprecated. as of 1.4 Use JenkinsLocationConfiguration instead

Parameters:

hudsonUrl - Jenkins base URL to set

setAdminAddress

public void setAdminAddress(String adminAddress)

Deprecated. as of 1.4 Use JenkinsLocationConfiguration instead

Parameters:

adminAddress - Jenkins administrator mail address to set

setSmtpHost

public void setSmtpHost(String smtpHost)

setUseSsl

public void setUseSsl(boolean useSsl)

setSmtpPort

public void setSmtpPort(String smtpPort)

setCharset

public void setCharset(String chaset)

setSmtpAuth

public void setSmtpAuth(String userName,
                        String password)

newInstance

public Publisher newInstance(org.kohsuke.stapler.StaplerRequest req,
                             net.sf.json.JSONObject formData)
                      throws Descriptor.FormException

Overrides:

newInstance in class Descriptor<Publisher>

Throws:

Descriptor.FormException

doAddressCheck

public FormValidation doAddressCheck(@QueryParameter
                                     String value)

doCheckSmtpServer

public FormValidation doCheckSmtpServer(@QueryParameter
                                        String value)

doCheckDefaultSuffix

public FormValidation doCheckDefaultSuffix(@QueryParameter
                                           String value)

doSendTestMail

public FormValidation doSendTestMail(@QueryParameter
                                     String smtpServer,
                                     @QueryParameter
                                     String adminAddress,
                                     @QueryParameter
                                     boolean useSmtpAuth,
                                     @QueryParameter
                                     String smtpAuthUserName,
                                     @QueryParameter
                                     Secret smtpAuthPasswordSecret,
                                     @QueryParameter
                                     boolean useSsl,
                                     @QueryParameter
                                     String smtpPort,
                                     @QueryParameter
                                     String charset,
                                     @QueryParameter
                                     String sendTestMailTo)
                              throws IOException

Send an email to the admin address

Parameters:

smtpServer - name of the SMTP server to use for mail sending

adminAddress - Jenkins administrator mail address

useSmtpAuth - if set to true SMTP is used without authentication (username and password)

smtpAuthUserName - plaintext username for SMTP authentication

smtpAuthPasswordSecret - plaintext password for SMTP authentication

useSsl - if set to true SSL is used

smtpPort - port to use for SMTP transfer

charset - charset of the underlying MIME-mail message

sendTestMailTo - mail address to send test mail to

Returns:

response with http status code depending on the result of the mail sending

Throws:

IOException - in case the active jenkins instance cannot be retrieved

isApplicable

public boolean isApplicable(Class<? extends AbstractProject> jobType)

Specified by:

isApplicable in class BuildStepDescriptor<Publisher>