API docs     >     Mailings     >     MailingMgr

MailingMgr->getList

Description

getList ( $mailingId = 0, $filter = array(), $maxLevel = 0, $permissionsForRoleId = 0, $filterArray )
Gets a list of Mailings

Parameters

$mailingId
int
(optional) Id of the parent Mailing from which the list will be created
$filter
array
(optional, may be combined) If SUBNODES, only subnodes of the specified Mailing will be returned
if TRASHCAN, only items in the Trash will be returned
if PUBLISHED, the working copy will be returned
$maxLevel
int
(optional) Specifies the maximum level of nodes to get
$permissionsForRoleId
int
(optional) If '1' then return all Usergroups and Permissions for this Usergroup
$filterArray
array
Array of filters for the SQL query

Returns

array|false
Array of Mailings or FALSE in case of an error
  1. Array(                                          array  Array of n Mailings
  2.     [0] => Array(
  3.         [LFT] => 2                              int Id of the left node in the nested set tree structure
  4.         [RGT] => 3                              int Id of the right node in the nested set tree structure
  5.         [VERSIONPUBLISHED] => 999999            int Published version (either a specific version or 999999 if set to 'ALWAYS_LATEST_APPROVED_VERSION')
  6.         [ID] => 5                               int Id
  7.         [LEVEL] => 2                            int Level in tree
  8.         [PARENT] => 1                           int Parent Id
  9.         [PNAME] => 'test_mailing'               string Permanent name
  10.         [VERSION] => 4                          int Version
  11.         [ACTIVE] => 0                           int 1 if active, 0 if inactive
  12.         [HIDDEN] => 0                           int 1 if hidden, 0 if visible
  13.         [LOCKED] => 0                           int 1 if locked by an User, 0 if not
  14.         [HASCHANGED] => 0                       int 1 if changed since last approval, 0 if not
  15.         [TEMPLATEID] => 2                       int Template Id
  16.         [CREATEDTS] => 1331209629               int Timestamp of the creation
  17.         [CHANGEDTS] => 1339411813               int Timestamp of the last change
  18.         [CREATEDBY] => 1                        int Id of the User who created the Object
  19.         [CHANGEDBY] => 1                        int Id of the last User who touched the Object
  20.         [OID] => 5                              int Id
  21.         [NAME] => 'test mailing'                string Name
  22.         [TITLE] => 'Test Mailing Title'         string Title (dynamic Property)
  23.         [DESCRIPTION] => 'Test Mailing Desc'    string Description (dynamic Property)
  24.         [FROM_EMAIL] => 'sl@nexttuesday.de'     string Sender Email address
  25.         [FROM_NAME] => 'sl'                     string Sender name
  26.         [SUBJECT] => 'gfdgfdgfdg'               string Email subject
  27.         [FALLBACK_TEXT] => 'gsdgfdgfdgfdgfdgd'  string Fallback Email text
  28.         [RREAD] => 1                            int 1 if User owns Permissions to read this Object, 0 if not
  29.         [RWRITE] => 1                           int 1 if User owns Permissions to write this Object, 0 if not
  30.         [RDELETE] => 1                          int 1 if User owns Permissions to delete this Object, 0 if not
  31.         [RSUB] => 1                             int 1 if User owns Permissions to create subnodes under this Object, 0 if not
  32.         [RSTAGE] => 1                           int 1 if User owns Permissions to publish/approve this Object, 0 if not
  33.         [RMODERATE] => 0                        int 1 if User owns Permissions to moderate Comments of this Object, 0 if not
  34.         [RCOMMENT] => 0                         int 1 if User owns Permissions to add Comments to this Object, 0 if not
  35.         [RSEND] => 1                            int 1 if User owns Permissions to send this Object, 0 if not
  36.         [LASTAPPROVED] => 3                     int Latest approved version
  37.         [SELECTED] => 1                         int 1 if node is the current node, 0 if not
  38.         [SHOW] => 1                             int 1 if node is currently visible in the tree, 0 if not
  39.         [SUBOPEN] => 1                          int 1 if node has opened subnodes, 0 if not
  40.         [SHOWSUB] => 0                          int 1 if node has visible subnodes, 0 if not
  41.         [CHILDREN] => NULL                      int Count of children of this node or NULL
  42.         [FIRST] => 1                            int 1 if node is the first node on the current level, 0 if not
  43.         [LAST] => 1                             int 1 if node is the last node on the current level, 0 if not
  44.         [HASSUBNODES] => 0                      int 1 if node has subnodes, 0 if not
  45.     )
  46.     ...
  47. )