jenkins.plugins.mailer.tasks

Class MailAddressFilter

java.lang.Object

jenkins.plugins.mailer.tasks.MailAddressFilter

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<MailAddressFilter>

public abstract class MailAddressFilter
extends Object
implements hudson.model.Describable<MailAddressFilter>, hudson.ExtensionPoint

Checks email addresses if they should be excluded from sent emails.

This is an extension point of Jenkins. Plugins that contribute a new implementation of this class should extend Extension on your implementation class, like this:

 @Extension
 class MyMailAddressFilter extends MailAddressFilter {
    ...
     @Extension
     public static class DescriptorImpl extends MailAddressFilterDescriptor {
         @Override
         public String getDisplayName() {
             return "myMailAddressFilterExtension";
         }
     }
 }
 

Since:

1.9

Author:

Mudiaga Obada

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
MailAddressFilter()

Method Summary

Methods

Modifier and Type	Method and Description
static hudson.DescriptorExtensionList<MailAddressFilter,MailAddressFilterDescriptor>	all() Returns all the registered MailAddressFilter descriptors
static hudson.ExtensionList<MailAddressFilter>	allExtensions()
MailAddressFilterDescriptor	getDescriptor()
static Set<javax.mail.internet.InternetAddress>	getFilteredRecipients(hudson.model.AbstractBuild<?,?> build, hudson.model.BuildListener listener, Set<javax.mail.internet.InternetAddress> recipients) Returns a copy of the given set of recipients excluding addresses that our filtered out.
abstract boolean	isFiltered(hudson.model.AbstractBuild<?,?> build, hudson.model.BuildListener listener, javax.mail.internet.InternetAddress address) Checks if a given email should be excluded from the recipients of an email.

Methods inherited from class java.lang.Object

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

Constructor Detail

MailAddressFilter

public MailAddressFilter()

Method Detail

isFiltered

public abstract boolean isFiltered(hudson.model.AbstractBuild<?,?> build,
                 hudson.model.BuildListener listener,
                 javax.mail.internet.InternetAddress address)

Checks if a given email should be excluded from the recipients of an email.

Parameters:

build -

Returns:

true if given InternetAddress is to be excluded from the recipients

getFilteredRecipients

public static Set<javax.mail.internet.InternetAddress> getFilteredRecipients(hudson.model.AbstractBuild<?,?> build,
                                                             hudson.model.BuildListener listener,
                                                             Set<javax.mail.internet.InternetAddress> recipients)

Returns a copy of the given set of recipients excluding addresses that our filtered out.

Parameters:

build -

listener -

recipients -

Returns:

getDescriptor

public MailAddressFilterDescriptor getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<MailAddressFilter>

all

public static hudson.DescriptorExtensionList<MailAddressFilter,MailAddressFilterDescriptor> all()

Returns all the registered MailAddressFilter descriptors

allExtensions

public static hudson.ExtensionList<MailAddressFilter> allExtensions()