Sometimes you might want to exclude particular e-mail addresses or whole address ranges from Inxmail.
Sometimes you might want to exclude particular e-mail addresses or whole address ranges from Inxmail. For this purpose, there is a 'blacklist' of addresses, which can not be added to the Inxmail recipient list, neither by import nor by subscription or in any other ways. You can activate the blacklist feature from the
$oListContextManager = $oSession->getListContextManager(); $oSystemListContext = $oListContextManager->findByName( Inx_Api_List_SystemListContext::NAME ); $oSystemListContext->enableFeature( Inx_Api_Features::BLACKLIST_FEATURE_ID );Using an Inx_Api_Blacklist_BlacklistEntry, you can block individual addresses or complete address ranges. A few examples:
$oBlacklistManager = $oSession->getBlacklistManager(); $oBlacklistEntry = $oBlacklistManager->createBlacklistEntry(); $oBlacklistEntry->updateDescription( "All *test.com users" ); $oBlacklistEntry->updatePattern( "*test.com" ); $oBlacklistEntry->commitUpdate();Note: The selectAfter, selectBefore and selectBetween methods expect an ISO 8601 formatted date string. This date string can be created as in the following snippet:
$dateString = date('c');Note: The usage of the blacklist requires the api user right: Inx_Api_UserRights::BLACKLIST_FEATURE_USE
For more information on blacklist entries, see the Inx_Api_Blacklist_BlacklistEntry documentation.
Located in /Api/Blacklist/BlacklistManager.php (line 53)
Inx_Api_BOManager | --Inx_Api_Blacklist_BlacklistManager
Creates a new Inx_Api_Blacklist_BlacklistEntry.
Creates a new Inx_Api_Blacklist_BlacklistEntry.
Returns the Inx_Api_Blacklist_BlacklistEntry with the specified pattern.
Returns the Inx_Api_Blacklist_BlacklistEntry with the specified pattern. The pattern is case insensitive.
Returns a result set containing all blacklist entries in the system which were created or changed after the specified date.
Returns a result set containing all blacklist entries in the system which were created or changed after the specified date.
Returns a result set containing all blacklist entries in the system which were created or changed before the specified date.
Returns a result set containing all blacklist entries in the system which were created or changed before the specified date.
Returns a result set containing all blacklist entries in the system which were created or changed between the specified dates.
Returns a result set containing all blacklist entries in the system which were created or changed between the specified dates.
Inherited From Inx_Api_BOManager
Inx_Api_BOManager::get()
Inx_Api_BOManager::remove()
Inx_Api_BOManager::selectAll()
Documentation generated on Thu, 17 Sep 2015 14:27:21 +0200 by phpDocumentor 1.3.2