An Inx_Api_Sending_Sending represents a sending of a mailing to a set of recipients. individual sendings, corresponding to the sending of the mailing to one specific recipient. usually only sent once. objects, use the Inx_Api_Sending_SendingHistoryManager.
An Inx_Api_Sending_Sending represents a sending of a mailing to a set of recipients. Each sending may contain many individual sendings, corresponding to the sending of the mailing to one specific recipient. A regular mailing is usually only sent once. A trigger mailing on the other hand, may be sent many times. To retrieve Sending objects, use the Inx_Api_Sending_SendingHistoryManager. Accessible sending data
The following data regarding sendings can be accessed:
You can fetch accumulated report data of a sending using the getReportData() method. Be aware that this method performs a separate server call. The Inx_Api_Sending_SendingReport object contains the following data:
Alternatives for accessing sending recipients
If you need to know, for example, which recipients opened the mailing, you should retrieve an Inx_Api_Sending_IndividualSendingRowSet or an Inx_Api_Sending_SendingRecipientRowSet:
$oSendingHistoryManager = $oSession->getSendingHistoryManager(); $oLastSending = $oSendingHistoryManager->findLastSendingForMailing( $iMailingId ); $oIndividualSendings = $oLastSending->findIndividualSendings(); $aRecipientIds = array(); while( $oIndividualSendings->next() ) { if( $oIndividualSendings->hasOpened() ) { $aRecipientIds[] = $oIndividualSendings->getRecipientId(); } } $oIndividualSendings->close(); $oRecipientContext = $oSession->createRecipientContext(); $oLastOpening = $oRecipientContext->getMetaData()->getUserAttribute( 'LastOpening' ); $oRecipients = $oRecipientContext->findByIds( $aRecipientIds ); $oNow = strtotime('now'); while( $oRecipients->next() ) { $oRecipients->updateDatetime( $oLastOpening, $oNow ); $oRecipients->commitRowUpdate(); } $oRecipients->close();For more information on how to retrieve
Located in /Api/Sending/Sending.php (line 103)
Inx_Api_ReadOnlyBusinessObject | --Inx_Api_Sending_Sending
Returns an Inx_Api_DataAccess_ClickDataRowSet containing all clicks on links in the mailing of this sending.
Returns an Inx_Api_DataAccess_ClickDataRowSet containing all clicks on links in the mailing of this sending. The returned row set contains data about the related clicks and is read only. The returned data can also contain attribute information about the recipients that performed these clicks.
Returns the Inx_Api_GeneralMailing_GeneralMailing corresponding to this sending. returned if the mailing type of the sending is not compatible with Inx_Api_GeneralMailing_GeneralMailingManager or if the corresponding Inx_Api_GeneralMailing_GeneralMailing could not be found (e. method performs a separate server call.
Returns the Inx_Api_GeneralMailing_GeneralMailing corresponding to this sending. A null value is returned if the mailing type of the sending is not compatible with Inx_Api_GeneralMailing_GeneralMailingManager or if the corresponding Inx_Api_GeneralMailing_GeneralMailing could not be found (e.g. the object was deleted). Be aware that this method performs a separate server call.
Returns an Inx_Api_Sending_IndividualSendingRowSet containing data related to the sending of mails to individual recipients. mail, clicked a link of the mail or caused a bounce and what the sending state is.
Returns an Inx_Api_Sending_IndividualSendingRowSet containing data related to the sending of mails to individual recipients. The Inx_Api_Sending_IndividualSendingRowSet can be used to determine whether a recipient opened the mail, clicked a link of the mail or caused a bounce and what the sending state is. Use this method if you are interested in the reaction of a couple of recipients and don't need to access their meta data. If you are only interested in the reaction of one or a few recipients use hasOpened($iRecipientId), hasClicked($iRecipientId) and hasBounced($iRecipientId). If you need to access recipient meta data (i.e. recipient column data and status), use findSendingRecipients($oRc, $aAttrs) instead.
Returns an Inx_Api_Recipient_RecipientRowSet containing recipient meta data (i. status). that any recipients which are not existing anymore (with respect to their ID) are not included in the result.
Returns an Inx_Api_Recipient_RecipientRowSet containing recipient meta data (i.e. recipient column data and status). This row set allows the manipulation of recipients but contains no information on the sending. Be aware that any recipients which are not existing anymore (with respect to their ID) are not included in the result. Use this method if you are not interested in the reaction of the recipients or need to manipulate them. If you need to consider the reaction of the recipients, use findIndividualSendings()<i> or
<i>findSendingRecipients($oRc, $aAttrs), depending on whether you need to access recipient meta data.
If you need to consider the reaction of the recipients and need to manipulate them, you have to do this in two stages:
Returns an Inx_Api_Sending_SendingRecipientRowSet containing data related to the sending of mails to individual recipients, including meta date of these recipients. determine whether a recipient opened the mail, clicked a link of the mail or caused a bounce and what the sending state is. access is read-only.
Returns an Inx_Api_Sending_SendingRecipientRowSet containing data related to the sending of mails to individual recipients, including meta date of these recipients. The Inx_Api_Sending_SendingRecipientRowSet can be used to determine whether a recipient opened the mail, clicked a link of the mail or caused a bounce and what the sending state is. It may also be used to access meta data (i.e. recipient column data and status) of the recipient. The access is read-only. Use this method if you are interested in the reaction of a couple of recipients and need access to their meta data. If you are only interested in the reaction of one or a few recipients use hasOpened($iRecipientId), hasClicked($iRecipientId) and hasBounced($iRecipientId). If you do not need to access recipient meta data (i.e. recipient column data and status), use findIndividualSendings() instead.
If you need to manipulate recipients use findRecipients($oRc) to get a fully featured Inx_Api_Recipient_RecipientRowSet. This row set contains no information on the sending though.
Returns the end date of this sending.
Returns the end date of this sending. This date corresponds to the end of the sending of the last mail.
The end date is returned as ISO-8601 formatted datetime string.
Returns the ID of the list containing the mailing being sent.
Returns the ID of the list containing the mailing being sent.
Returns the ID of the mailing being sent.
Returns the ID of the mailing being sent.
Returns the date when this sending has been modified last.
Returns the date when this sending has been modified last.
The modification date is returned as ISO-8601 formatted datetime string. The following events are considered as modifications:
Returns an Inx_Api_Sending_SendingReport object containing accumulated report data regarding this sending.
Returns an Inx_Api_Sending_SendingReport object containing accumulated report data regarding this sending. Be aware that this method performs a separate server call.
Returns the start date of this sending. which the first mail is being sent. sent.
Returns the start date of this sending. Please note, that this date does not specify the actual point in time at which the first mail is being sent. The mailing has to be prepared for each recipient before the first mail is sent.
The start date is returned as ISO-8601 formatted datetime string.
Returns the state of this sending.
Returns the state of this sending.
Returns the total size of the sending in bytes.
Returns the total size of the sending in bytes. This is the accumulation of the size of all sent mails.
Returns the type of the mailing being sent.
Returns the type of the mailing being sent.
Returns a bool indicating whether the specified recipient caused a bounce during the sending of the mail.
Returns a bool indicating whether the specified recipient caused a bounce during the sending of the mail.
Returns a bool indicating whether the specified recipient clicked a link of the mail sent by this sending.
Returns a bool indicating whether the specified recipient clicked a link of the mail sent by this sending.
Returns a bool indicating whether the specified recipient opened the mail sent by this sending.
Returns a bool indicating whether the specified recipient opened the mail sent by this sending.
Returns a bool indicating whether the mailing sent by this sending has been deleted.
Returns a bool indicating whether the mailing sent by this sending has been deleted.
Returns a bool indicating whether the protocol for this sending has been deleted. protocol has been deleted it is not possible to determine how a specific recipient reacted on the mail.
Returns a bool indicating whether the protocol for this sending has been deleted. After the protocol has been deleted it is not possible to determine how a specific recipient reacted on the mail.
Inherited From Inx_Api_ReadOnlyBusinessObject
Inx_Api_ReadOnlyBusinessObject::getId()
Inx_Api_ReadOnlyBusinessObject::reload()
Documentation generated on Thu, 17 Sep 2015 14:27:30 +0200 by phpDocumentor 1.3.2