public abstract class MailAddressResolver extends Object implements hudson.ExtensionPoint
This is an extension point of Jenkins. Plugins that contribute a new implementation
of this class should put Extension
on your implementation class, like this:
@Extension
class MyMailAddressResolver extends MailAddressResolver
{
...
}
User identity in Jenkins is global, and not specific to a particular job. As a result, mail address resolution
only receives User
, which by itself doesn't really have that much information in it.
So the common technique for a mail address resolution is to define your own UserProperty
types and
add it to User
objects where more context is available. For example, an SCM
implementation
can have a lot more information about a particular user during a check out, so that would be a good place
to capture information as UserProperty
, which then later used by a MailAddressResolver
.
Mail address resolution is a potentially time consuming process. It can considerably slow down operations relaying on mail address resolution, especially on Jenkins instances having registered several resolvers. Searching through all projects is generally a bad idea. See JENKINS-16437 for more details.
Modifier and Type | Field and Description |
---|---|
static List<MailAddressResolver> |
LIST
Deprecated.
as of 1.286
Use
all() for read access and Extension for registration. |
Constructor and Description |
---|
MailAddressResolver() |
Modifier and Type | Method and Description |
---|---|
static hudson.ExtensionList<MailAddressResolver> |
all()
Returns all the registered
MailAddressResolver descriptors. |
abstract String |
findMailAddressFor(hudson.model.User u)
Infers e-mail address of the given user.
|
static String |
resolve(hudson.model.User u)
Try to resolve email address using resolvers.
|
static String |
resolveFast(hudson.model.User u)
Try to resolve user email address fast enough to be used from UI
|
public static final List<MailAddressResolver> LIST
all()
for read access and Extension
for registration.MailAddressResolver
implementations.public abstract String findMailAddressFor(hudson.model.User u)
This method is called when a User
without explicitly configured e-mail
address is used, as an attempt to infer e-mail address.
The normal strategy is to look at the projects that the user
is participating
, then use the repository information to infer the e-mail address.
When multiple resolvers are installed, they are consulted in order and the search will be over when an address is inferred by someone.
Since MailAddressResolver
is singleton, this method can be invoked concurrently
from multiple threads.
public static String resolve(hudson.model.User u)
UserProperty
, then it will be used with
the highest priority.public static String resolveFast(hudson.model.User u)
This implementation does not trigger MailAddressResolver
extension point.
u
- A user, for whom the email should be resolvedpublic static hudson.ExtensionList<MailAddressResolver> all()
MailAddressResolver
descriptors.Copyright © 2014. All rights reserved.