Interface Inx_Api_List_ListContextManager

Description

An Inx_Api_List_ListContext corresponds to a list in Inxmail, like a mailing list or the system list.

An Inx_Api_List_ListContext corresponds to a list in Inxmail, like a mailing list or the system list. The Inx_Api_List_ListContextManager is used to access and manipulate these lists. There are four different types of lists:

  • Standard lists: Inx_Api_List_StandardListContext
  • Filter lists: Inx_Api_List_FilterListContext
  • The system list: Inx_Api_List_SystemListContext
  • The administration list: Inx_Api_List_AdminListContext
New mailing lists are created using createStandardList() or createFilterList().

The following snippet creates a new standard mailing list:

 $oListContextManager = $session->getListContextManager();
 $oStandardListContext = $oListContextManager->createStandardList();
 $oStandardListContext->updateName( "New List" );
 $oStandardListContext->commitUpdate();
Special lists, like the system or administration list, can be retrieved using the findByName($sName) method. Both, Inx_Api_List_SystemListContext and Inx_Api_List_AdminListContext provide a constant with their predefined, immutable name which can be used to retrieve the list context. The following snippet illustrates this:
 $oListContextManager = $oSession->getListContextManager();
 $systemListContext = $oListContextManager->findByName( Inx_Api_List_SystemListContext::NAME );
 $adminListContext  = $oListContextManager->findByName( Inx_Api_List_AdminListContext::NAME );

For more information on lists, see the Inx_Api_List_ListContext documentation.

  • version: $Revision: 9497 $ $Date: 2007-12-19 17:03:25 +0200 (Tr, 19 Grd 2007) $ $Author: aurimas $
  • see: Inx_Api_List_ListContext
  • since: API 1.0

Located in /Api/List/ListContextManager.php (line 47)

Inx_Api_BOManager
   |
   --Inx_Api_List_ListContextManager
Method Summary
Methods
createFilterList (line 75)

Creates an Inx_Api_List_FilterListContext object.

Creates an Inx_Api_List_FilterListContext object. The list will not be created on the server until commitUpdate() has been called.

  • return: an Inx_Api_List_FilterListContext object.
  • access: public
Inx_Api_List_FilterListContext createFilterList ()
createStandardList (line 66)

Creates an Inx_Api_List_StandardListContext object.

Creates an Inx_Api_List_StandardListContext object. The list will not be created on the server until commitUpdate() has been called.

  • return: an Inx_Api_List_StandardListContext object.
  • access: public
Inx_Api_List_StandardListContext createStandardList ()
findByName (line 57)

Returns the Inx_Api_List_ListContext with the specified list name.

Returns the Inx_Api_List_ListContext with the specified list name. The list name is case insensitive.

  • return: the list context, or null if no list can be found.
  • access: public
Inx_Api_List_ListContext findByName (string $sListName)
  • string $sListName: the name of the list to find.

Inherited Methods

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:26 +0200 by phpDocumentor 1.3.2