jenkins.plugins.mailer.tasks

Class MailAddressFilter

java.lang.Object

jenkins.plugins.mailer.tasks.MailAddressFilter

All Implemented Interfaces:

ExtensionPoint, Describable<MailAddressFilter>

public abstract class MailAddressFilter
extends Object
implements Describable<MailAddressFilter>, 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

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
MailAddressFilter()

Method Summary

Modifier and Type	Method and Description
static DescriptorExtensionList<MailAddressFilter,MailAddressFilterDescriptor>	all()
static ExtensionList<MailAddressFilter>	allExtensions()
static Set<javax.mail.internet.InternetAddress>	filterRecipients(Run<?,?> build, TaskListener listener, Set<javax.mail.internet.InternetAddress> recipients) Returns a copy of the given set of recipients excluding addresses that are filtered out.
MailAddressFilterDescriptor	getDescriptor()
static Set<javax.mail.internet.InternetAddress>	getFilteredRecipients(AbstractBuild<?,?> build, BuildListener listener, Set<javax.mail.internet.InternetAddress> recipients) Deprecated.
boolean	isFiltered(AbstractBuild<?,?> build, BuildListener listener, javax.mail.internet.InternetAddress address) Deprecated.
boolean	shouldFilter(Run<?,?> build, TaskListener 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

shouldFilter

public boolean shouldFilter(Run<?,?> build,
                            TaskListener listener,
                            javax.mail.internet.InternetAddress address)

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

Parameters:

build - the current build.

listener - the task listener

address - email address

Returns:

true if given InternetAddress is to be excluded from the recipients

isFiltered

@Deprecated
public boolean isFiltered(AbstractBuild<?,?> build,
                                      BuildListener listener,
                                      javax.mail.internet.InternetAddress address)

Deprecated.

filterRecipients

public static Set<javax.mail.internet.InternetAddress> filterRecipients(Run<?,?> build,
                                                                        TaskListener listener,
                                                                        Set<javax.mail.internet.InternetAddress> recipients)

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

Parameters:

build - the current build.

listener - the task listener

recipients - set of recipients

Returns:

filtered list of recipients

getFilteredRecipients

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

Deprecated.

getDescriptor

public MailAddressFilterDescriptor getDescriptor()

Specified by:

getDescriptor in interface Describable<MailAddressFilter>

all

public static DescriptorExtensionList<MailAddressFilter,MailAddressFilterDescriptor> all()

Returns:

all of the registered MailAddressFilter descriptors

allExtensions

public static ExtensionList<MailAddressFilter> allExtensions()