MediaWiki REL1_34
EmailBlacklist Class Reference

Email Blacklisting. More...

Inheritance diagram for EmailBlacklist:
Collaboration diagram for EmailBlacklist:

Public Member Functions

 checkUser (User $user)
 Checks a User object for a blacklisted email address.
 
 filter (array $links, Title $title, $preventLog=false)
 
- Public Member Functions inherited from BaseBlacklist
 __construct ( $settings=[])
 Constructor.
 
 clearCache ()
 Clear all primary blacklist cache keys.
 
 getBlacklists ()
 Fetch local and (possibly cached) remote blacklists.
 
 getLocalBlacklists ()
 Returns the local blacklist.
 
 getRegexEnd ( $batchSize)
 Returns the end of the regex for matches.
 
 getRegexStart ()
 Returns the start of the regex for matches.
 
 getWhitelists ()
 Returns the (local) whitelist.
 
 warmCachesForFilter (Title $title, array $entries)
 

Protected Member Functions

 getBlacklistType ()
 Returns the code for the blacklist implementation.
 

Additional Inherited Members

- Static Public Member Functions inherited from BaseBlacklist
static addBlacklistType ( $type, $class)
 Adds a blacklist class to the registry.
 
static getBlacklistTypes ()
 Return the array of blacklist types currently defined.
 
static getEmailBlacklist ()
 
static getInstance ( $type)
 Returns an instance of the given blacklist.
 
static getSpamBlacklist ()
 
static getTypeFromTitle (Title $title)
 Returns the type of blacklist from the given title.
 
static isLocalSource (Title $title)
 Check if the given local page title is a spam regex source.
 
- Public Attributes inherited from BaseBlacklist
int $expiryTime = 900
 
array $files = []
 Array of blacklist sources.
 
int $warningChance = 100
 Chance of receiving a warning when the filter is hit.
 
int $warningTime = 600
 
- Protected Attributes inherited from BaseBlacklist
bool array $regexes = false
 Array containing regexes to test against.
 

Detailed Description

Email Blacklisting.

Definition at line 6 of file EmailBlacklist.php.

Member Function Documentation

◆ checkUser()

EmailBlacklist::checkUser ( User $user)

Checks a User object for a blacklisted email address.

Parameters
User$user
Returns
bool True on valid email

Definition at line 32 of file EmailBlacklist.php.

References BaseBlacklist\getBlacklists(), User\getEmail(), BaseBlacklist\getWhitelists(), and wfDebugLog().

◆ filter()

EmailBlacklist::filter ( array $links,
Title $title,
$preventLog = false )
Parameters
array$links
Title$title
bool$preventLog
Returns
mixed

Reimplemented from BaseBlacklist.

Definition at line 13 of file EmailBlacklist.php.

◆ getBlacklistType()

EmailBlacklist::getBlacklistType ( )
protected

Returns the code for the blacklist implementation.

Returns
string

Reimplemented from BaseBlacklist.

Definition at line 22 of file EmailBlacklist.php.


The documentation for this class was generated from the following file: