Interface Inx_Api_Inbox_InboxManager

Description

The Inx_Api_Inbox_InboxManager can be used to retrieve inbox messages.

The Inx_Api_Inbox_InboxManager can be used to retrieve inbox messages. There are different methods for the retrieval of inbox messages, for example you can retrieve messages by date. The following example returns an Inx_Api_BOResultSet containing all inbox messages in the system:

 $oInboxManager = $oSession->getInboxManager();
 $oBOResultSet = $oInboxManager->selectAll();

 for( $i = 0; $i < $oBOResultSet->size(); $i++ )
 {
 	$oInboxMessage = $oBOResultSet->get( $i );
 	echo $oInboxMessage->getSubject() . '<br>';
 }

 $oBOResultSet->close();
Note: The selectAll() method retrieves no recipient information but the id. If you wish to retrieve the recipient state or some of the recipients attributes, use the selectAll($oRecipientContext, $aAttributes) method instead. Note: The usage of the Inbox requires the api user right: Inx_Api_UserRights::ERRORMAIL_FEATURE_USE

For more information on inbox messages, see the Inx_Api_Inbox_InboxMessage documentation.

Located in /Api/Inbox/InboxManager.php (line 34)

Inx_Api_BOManager
   |
   --Inx_Api_Inbox_InboxManager
Method Summary
Inx_Api_BOResultSet selectAfter (string $sSearchDate, Inx_Api_Recipient_RecipientContext $rc, array $aAttributes)
Inx_Api_BOResultSet selectAllInboxMessages ([Inx_Api_Recipient_RecipientContext $rc = null], [array $aAttributes = null])
Inx_Api_BOResultSet selectBefore (string $sSearchDate, Inx_Api_Recipient_RecipientContext $rc, array $aAttributes)
Inx_Api_BOResultSet selectBetween (string $sStartDate, string $sStopDate, Inx_Api_Recipient_RecipientContext $rc, array $aAttributes)
Methods
selectAfter (line 65)

Returns a result set containing all inbox messages received after the specified date.

Returns a result set containing all inbox messages received after the specified date. The date has to be passed as ISO 8601 formatted datetime string. If the RecipientContext is not null and the Attribute array contains at least one element, the retrieved messages will contain information about the recipient state and the specified recipient attributes.

  • return: a BOResultSet containing all inbox messages matching the condition.
  • access: public
Inx_Api_BOResultSet selectAfter (string $sSearchDate, Inx_Api_Recipient_RecipientContext $rc, array $aAttributes)
  • string $sSearchDate: all inbox messages after this date will be selected.
  • Inx_Api_Recipient_RecipientContext $rc: the RecipientContext. See Inx_Api_Session::createRecipientContext().
  • array $aAttributes: an array of recipient attributes that will be fetched for later retrieval. See Inx_Api_Recipient_RecipientMetaData.
selectAllInboxMessages (line 97)

Returns a result set containing all inbox messages.

Returns a result set containing all inbox messages. If there are no messages, an empty result set will be returned. If the RecipientContext is not null and the Attribute array contains at least one element, the retrieved messages will contain information about the recipient state and the specified recipient attributes.

  • return: a BOResultSet containing all inbox messages matching the condition.
  • access: public
Inx_Api_BOResultSet selectAllInboxMessages ([Inx_Api_Recipient_RecipientContext $rc = null], [array $aAttributes = null])
  • Inx_Api_Recipient_RecipientContext $rc: the RecipientContext. See Inx_Api_Session::createRecipientContext().
  • array $aAttributes: an array of recipient attributes that will be fetched for later retrieval. See Inx_Api_Recipient_RecipientMetaData.
selectBefore (line 49)

Returns a result set containing all inbox messages received before the specified date.

Returns a result set containing all inbox messages received before the specified date. The date has to be passed as ISO 8601 formatted datetime string. If the RecipientContext is not null and the Attribute array contains at least one element, the retrieved messages will contain information about the recipient state and the specified recipient attributes.

  • return: a BOResultSet containing all inbox messages matching the condition.
  • access: public
Inx_Api_BOResultSet selectBefore (string $sSearchDate, Inx_Api_Recipient_RecipientContext $rc, array $aAttributes)
  • string $sSearchDate: all inbox messages before this date will be selected.
  • Inx_Api_Recipient_RecipientContext $rc: the RecipientContext. See Inx_Api_Session::createRecipientContext().
  • array $aAttributes: an array of recipient attributes that will be fetched for later retrieval. See Inx_Api_Recipient_RecipientMetaData.
selectBetween (line 82)

Returns a result set containing all inbox messages received between the specified date.

Returns a result set containing all inbox messages received between the specified date. The dates have to be passed as ISO 8601 formatted datetime string. If the RecipientContext is not null and the Attribute array contains at least one element, the retrieved messages will contain information about the recipient state and the specified recipient attributes.

  • return: a BOResultSet containing all inbox messages matching the condition.
  • access: public
Inx_Api_BOResultSet selectBetween (string $sStartDate, string $sStopDate, Inx_Api_Recipient_RecipientContext $rc, array $aAttributes)
  • string $sStartDate: the start date of the search.
  • string $sStopDate: the end date of the search.
  • Inx_Api_Recipient_RecipientContext $rc: the RecipientContext. See Inx_Api_Session::createRecipientContext().
  • array $aAttributes: an array of recipient attributes that will be fetched for later retrieval. See Inx_Api_Recipient_RecipientMetaData.

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