Interface Inx_Api_Blacklist_BlacklistEntry

Description

An Inx_Api_Blacklist_BlacklistEntry can block individual addresses or complete address ranges so they can not be added to the Inxmail recipient list, neither by import nor by subscription or in any other ways.

An Inx_Api_Blacklist_BlacklistEntry can block individual addresses or complete address ranges so they can not be added to the Inxmail recipient list, neither by import nor by subscription or in any other ways. A few examples:

  • name@firm.com - The address 'name@firm.com' is blocked.
  • *@firm.com - All personnel of this firm is blocked.
  • *.tv - No addresses from Tuvalu.
  • spam* - All addresses beginning with 'spam' are blocked.
  • martin@* - All Martins are blocked.
Note: The usage of the blacklist requires the api user right: Inx_Api_UserRights::BLACKLIST_FEATURE_USE For an example on how to use the blacklist, see the Inx_Api_Blacklist_BlacklistManager documentation.

Located in /Api/Blacklist/BlacklistEntry.php (line 27)

Inx_Api_BusinessObject
   |
   --Inx_Api_Blacklist_BlacklistEntry
Class Constant Summary
Method Summary
string getDescription ()
int getHitCount ()
string getPattern ()
void updateDescription (string $sDescription)
void updatePattern (string $sPattern)
Methods
getDescription (line 84)

Returns the entry description.

Returns the entry description.

  • return: the entry description.
  • access: public
string getDescription ()
getHitCount (line 100)

Returns the number of addresses which were blocked by this entry.

Returns the number of addresses which were blocked by this entry.

  • return: the number of addresses which were blocked by this entry.
  • access: public
int getHitCount ()
getPattern (line 60)

Returns the email address pattern.

Returns the email address pattern.

  • return: the email address pattern
  • access: public
string getPattern ()
updateDescription (line 92)

Changes the entry description.

Changes the entry description.

  • access: public
void updateDescription (string $sDescription)
  • string $sDescription: the new entry description.
updatePattern (line 76)

Changes the email address pattern.

Changes the email address pattern. A few examples:

  • name@firm.com - The address 'name@firm.com' is blocked.
  • *@firm.com - All personnel of this firm is blocked.
  • *.tv - No addresses from Tuvalu.
  • spam* - All addresses beginning with 'spam' are blocked.
  • martin@* - All Martins are blocked.

  • access: public
void updatePattern (string $sPattern)
  • string $sPattern: the new email address pattern

Inherited Methods

Inherited From Inx_Api_BusinessObject

Inx_Api_BusinessObject::commitUpdate()
Inx_Api_BusinessObject::getId()
Inx_Api_BusinessObject::reload()
Class Constants
ATTRIBUTE_DESCRIPTION = 1 (line 44)

Constant of descriptionn attribute. Inx_Api_Blacklist_BlacklistEntry objects are fetched.

Constant of descriptionn attribute. Used to indicate a change of this attribute and to define the order in which Inx_Api_Blacklist_BlacklistEntry objects are fetched.

  • see: Inx_Api_Blacklist_BlacklistManager::selectAll(int, int)
ATTRIBUTE_HIT_COUNT = 2 (line 52)

Constant of hit count attribute. Inx_Api_Blacklist_BlacklistEntry objects are fetched.

Constant of hit count attribute. Used to indicate a change of this attribute and to define the order in which Inx_Api_Blacklist_BlacklistEntry objects are fetched.

  • see: Inx_Api_Blacklist_BlacklistManager::selectAll(int, int)
ATTRIBUTE_PATTERN = 0 (line 36)

Constant of pattern attribute. Inx_Api_Blacklist_BlacklistEntry objects are fetched.

Constant of pattern attribute. Used to indicate a change of this attribute and to define the order in which Inx_Api_Blacklist_BlacklistEntry objects are fetched.

  • see: Inx_Api_Blacklist_BlacklistManager::selectAll(int, int)

Documentation generated on Thu, 17 Sep 2015 14:27:21 +0200 by phpDocumentor 1.3.2