Interface Inx_Api_Subscription_SubscriptionLogEntryRowSet

Description

An Inx_Api_Subscription_SubscriptionLogEntryRowSet can be used to determine whether recipients have been unsubscribed from or subscribed to a list.

An Inx_Api_Subscription_SubscriptionLogEntryRowSet can be used to determine whether recipients have been unsubscribed from or subscribed to a list. It can also contain information about the recipient, if she/he exists. <P/> The following information can be retrieved using the SubscriptionLogEntryRowSet:

  • The log entry type: Describes the message of the entry. May be one of:
    • BLACKLISTED: The recipient could not be subscribed because of a blacklist entry.
    • DUPLICATE_SUBSCRIPTION: The recipient could not be subscribed because she/he is already subscribed.
    • INVALID_ADRESS_ERROR: The recipient could not be subscribed because the email address
    • LIST_UNSUBSCRIBE_HEADER_UNSUBSCRIPTION: The recipient was unsubscribed using header unsubscription.
    • MANUAL_SUBSCRIPTION: The recipient was subscribed by an Inxmail user.
    • MANUAL_UNSUBSCRIPTION: The recipient was unsubscribed by an Inxmail user.
    • NOT_IN_LIST_UNSUBSCRIPTION: The recipient could not be unsubscribed because she/he is not subscribed.
    • PENDING_SUBSCRIPTION: The subscription of the recipient is in progress (Double Opt In).
    • PENDING_SUBSCRIPTION_DONE: The subscription of the recipient is verified (Double Opt In).
    • PENDING_UNSUBSCRIPTION: The unsubscription of the recipient is in progress (Double Opt Out).
    • PENDING_UNSUBSCRIPTION_DONE: The unsubscription of the recipient is verified (Double Opt Out).
    • SUBSCRIPTION_EMAIL_MISSMATCH: The recipient could not be subscribed because of an email address mismatch.
    • SUBSCRIPTION_ID_NOT_VALID: An invalid subscription verification was received (Double Opt In).
    • SUBSCRIPTION_INTERNAL_ERROR: The recipient could not be subscribed due to an internal error.
    • SUBSCRIPTION_TIMED_OUT: The subscription of the recipient timed out (Double Opt In).
    • SUBSCRIPTION_VERIFICATION_BOUNCED: A subscription verification mail bounced.
    • UNSUBSCRIPTION_EMAIL_MISSATCH: The recipient could not be unsubscribed because of an email address
    • UNSUBSCRIPTION_ID_NOT_VALID: An invalid unsubscription verification was received (Double Opt Out).
    • UNSUBSCRIPTION_INTERNAL_ERROR: The recipient could not be unsubscribed due to an internal error.
    • UNSUBSCRIPTION_TIMED_OUT: The subscription of the recipient timed out (Double Opt Out).
    • UNSUBSCRIPTION_VERIFICATION_BOUNCED: An unsubscription verification mail bounced.
    • VERIFIED_SUBSCRIPTION: A recipient subscription has been verified.
    • VERIFIED_UNSUBSCRIPTION: A recipient unsubscription has been verified.
    • VERIFIED_UNSUBSCRIPTION_NOT_IN_LIST: A recipient unsubscription has been verified regarding a list of which the recipient is not a member (neither subscribed, nor unsubscribed).
    • PENDING_UNSUBSCRIPTION_NOT_IN_LIST: The unsubscription of the recipient is in progress (Double Opt Out). This unsubscription request regards a list of which the recipient is not a member (neither subscribed, nor unsubscribed).
    • PENDING_UNSUBSCRIPTION_DONE_NOT_IN_LIST: A recipient unsubscription (Double Opt Out) has been verified regarding a list of which the recipient is not a member (neither subscribed, nor unsubscribed).
    • LIST_UNSUBSCRIBE_HEADER_UNSUBSCRIPTION_NOT_IN_LIST The recipient was unsubscribed using header unsubscription. This unsubscription request regards a list of which the recipient is not a member (neither subscribed, nor unsubscribed).
    • DUPLICATE_UNSUBSCRIPTION: The recipient could not be unsubscribed because she/he is already unsubscribed.
    • NOT_IN_SYSTEM_UNSUBSCRIPTION: The recipient could not be unsubscribed because she/he is not known to the system.
    • UNKNOWN_SUBSCRIPTIONTYPE: The log entry type is unknown.
  • The log message: The message associated with the log entry.
  • The datetime of the entry: When was the log entry created?
  • The email address: The email address of the recipient involved in the log entry.
  • The sending id: The sending id of the mailing which triggered the unsubscription.
  • The recipient id: The id of the recipient involved in the log entry.
  • The recipient state: The state of the recipient involved in the log entry. May be one of:
    • RECIPIENT_STATE_EXISTENT: If the recipient exists.
    • RECIPIENT_STATE_UNKNOWN_OR_DELETED: If the recipient was deleted or the state is unknown.
  • Possibly some attributes queried in the Inx_Api_Subscription_SubscriptionManager which can be retrieved using the getter methods.
<P/> A SubscriptionLogEntryRowSet object maintains a cursor pointing to its current row of data. Initially the cursor is positioned before the first row. The next() method moves the cursor to the next row (recipient), and because it returns false when there are no more rows in the SubscriptionLogEntryRowSet object, it can be used in a while loop to iterate through the result set. <p/> Be sure to call next() before the first retrieval statement on the row set. As stated above, initially the cursor is before the first row, thus no data can be retrieved from the row set before calling next(). Doing so will trigger an Inx_Api_DataException. <P/> The SubscriptionLogEntryRowSet interface provides getter methods (getString, getInteger, and so on) for retrieving attribute values from the current row. Values can be retrieved using the attribute object if they were included in the query. <p/> The following snippet shows how to retrieve the email address of all (un)subscriptions in the row set, thus also illustrating how to iterate over a SubscriptionLogEntryRowSet:
 $oRecipientContext = $oSession->createRecipientContext();
 $oSubscriptionManager = $oSession->getSubscriptionManager();
 $oSubscriptionLogEntryRowSet = $oSubscriptionManager->getAllLogEntries( $oRecipientContext, null );

 while( $oSubscriptionLogEntryRowSet->next() )
 {
 	echo $oSubscriptionLogEntryRowSet->getEmailAddress()."<br>";
 }

 $oSubscriptionLogEntryRowSet->close();
<p/> <strong>Note:</strong> An Inx_Api_Subscription_SubscriptionLogEntryRowSet object <strong>must</strong> be closed once it is not needed anymore to prevent memory leaks and other potentially harmful side effects. <p/> For more information about the (un)subscription of recipients, see the Inx_api_Subscritpion_SubscriptionManager and Inx_Api_Recipient_RecipientContext</i> documentation.

Located in /Api/Subscription/SubscriptionLogEntryRowSet.php (line 118)

Inx_Api_InxRowSet
   |
   --Inx_Api_Recipient_ReadOnlyRecipientRowSet
      |
      --Inx_Api_Subscription_SubscriptionLogEntryRowSet
Class Constant Summary
Method Summary
string getEntryDatetime ()
int getListId ()
string getLogMessage ()
the getSendingId ()
int getType ()
Methods
getEmailAddress (line 465)

Returns the email address associated with this entry.

Returns the email address associated with this entry.

  • return: email address associated with this entry.
  • throws: Inx_Api_DataException if no row is selected (e.g. you forgot to call next()).
the getEmailAddress ()
getEntryDatetime (line 457)

Returns the datetime of the entry.

Returns the datetime of the entry.

  • return: the datetime. The datetime will be returned as ISO 8601 formatted datetime string.
  • throws: Inx_Api_DataException if no row is selected (e.g. you forgot to call next()).
string getEntryDatetime ()
getListId (line 398)

Returns the id of the list associated with this entry.

Returns the id of the list associated with this entry.

  • return: the id of the list associated with this entry.
  • throws: Inx_Api_DataException if no row is selected (e.g. you forgot to call next()).
int getListId ()
getLogMessage (line 390)

Returns the whole log message as string.

Returns the whole log message as string.

  • return: the log message as string.
  • throws: Inx_Api_DataException if no row is selected (e.g. you forgot to call next()).
string getLogMessage ()
getRecipientId (line 474)

Returns the id of the recipient associated with this entry, if the recipient exists.

Returns the id of the recipient associated with this entry, if the recipient exists.

  • return: id of the recipient associated with this entry, if the recipient exists.
  • throws: Inx_Api_DataException if the recipient does not exists or the recipient state is unknown. May also occur if no row is selected (e.g. you forgot to call next()).
the getRecipientId ()
getRecipientState (line 486)

Returns the state of the recipient associated with the current log entry.

Returns the state of the recipient associated with the current log entry. May be one of:

  • RECIPIENT_STATE_UNKNOWN_OR_DELETED - if the recipient state is unknown or the recipient was deleted.
  • RECIPIENT_STATE_EXISTENT - if the recipient exists.

  • return: recipient state.
  • throws: Inx_Api_DataException if the recipient state cannot be determined.
the getRecipientState ()
getSendingId (line 495)

Returns the sending id associated with this entry. be returned.

Returns the sending id associated with this entry. If no sending id is present, SENDING_ID_UNKNOWN will be returned.

  • return: sending id associated with this entry.
  • throws: Inx_Api_DataException if no row is selected (e.g. you forgot to call next()).
the getSendingId ()
getType (line 449)

Returns the type of the entry.

Returns the type of the entry. May be one of:

  • BLACKLISTED: The recipient could not be subscribed because of a blacklist entry.
  • DUPLICATE_SUBSCRIPTION: The recipient could not be subscribed because she/he is already subscribed.
  • INVALID_ADRESS_ERROR: The recipient could not be subscribed because the email address is not conform to the RFC standard.
  • LIST_UNSUBSCRIBE_HEADER_UNSUBSCRIPTION: The recipient was unsubscribed using header unsubscription.
  • MANUAL_SUBSCRIPTION: The recipient was subscribed by an Inxmail user.
  • MANUAL_UNSUBSCRIPTION: The recipient was unsubscribed by an Inxmail user.
  • NOT_IN_LIST_UNSUBSCRIPTION: The recipient could not be unsubscribed because she/he is not subscribed.
  • PENDING_SUBSCRIPTION: The subscription of the recipient is in progress (Double Opt In).
  • PENDING_SUBSCRIPTION_DONE: The subscription of the recipient is verified (Double Opt In).
  • PENDING_UNSUBSCRIPTION: The unsubscription of the recipient is in progress (Double Opt Out).
  • PENDING_UNSUBSCRIPTION_DONE: The unsubscription of the recipient is verified (Double Opt Out).
  • SUBSCRIPTION_EMAIL_MISSMATCH: The recipient could not be subscribed because of an email address mismatch.
  • SUBSCRIPTION_ID_NOT_VALID: An invalid subscription verification was received (Double Opt In).
  • SUBSCRIPTION_INTERNAL_ERROR: The recipient could not be subscribed due to an internal error.
  • SUBSCRIPTION_TIMED_OUT: The subscription of the recipient timed out (Double Opt In).
  • SUBSCRIPTION_VERIFICATION_BOUNCED: A subscription verification mail bounced.
  • UNSUBSCRIPTION_EMAIL_MISSATCH: The recipient could not be unsubscribed because of an email address
  • UNSUBSCRIPTION_ID_NOT_VALID: An invalid unsubscription verification was received (Double Opt Out).
  • UNSUBSCRIPTION_INTERNAL_ERROR: The recipient could not be unsubscribed due to an internal error.
  • UNSUBSCRIPTION_TIMED_OUT: The subscription of the recipient timed out (Double Opt Out).
  • UNSUBSCRIPTION_VERIFICATION_BOUNCED: An unsubscription verification mail bounced.
  • VERIFIED_SUBSCRIPTION: A recipient subscription has been verified.
  • VERIFIED_UNSUBSCRIPTION: A recipient unsubscription has been verified.
  • VERIFIED_UNSUBSCRIPTION_NOT_IN_LIST: A recipient unsubscription has been verified regarding a list of which the recipient is not a member (neither subscribed, nor unsubscribed).
  • PENDING_UNSUBSCRIPTION_NOT_IN_LIST: The unsubscription of the recipient is in progress (Double Opt Out). This unsubscription request regards a list of which the recipient is not a member (neither subscribed, nor unsubscribed).
  • PENDING_UNSUBSCRIPTION_DONE_NOT_IN_LIST: A recipient unsubscription (Double Opt Out) has been verified regarding a list of which the recipient is not a member (neither subscribed, nor unsubscribed).
  • LIST_UNSUBSCRIBE_HEADER_UNSUBSCRIPTION_NOT_IN_LIST The recipient was unsubscribed using header unsubscription. This unsubscription request regards a list of which the recipient is not a member (neither subscribed, nor unsubscribed).
  • DUPLICATE_UNSUBSCRIPTION: The recipient could not be unsubscribed because she/he is already unsubscribed.
  • NOT_IN_SYSTEM_UNSUBSCRIPTION: The recipient could not be unsubscribed because she/he is not known to the system.
  • UNKNOWN_SUBSCRIPTIONTYPE: The log entry type is unknown.

  • return: the type of this entry.
  • throws: Inx_Api_DataException if no row is selected (e.g. you forgot to call next()).
int getType ()

Inherited Methods

Inherited From Inx_Api_Recipient_ReadOnlyRecipientRowSet

Inx_Api_Recipient_ReadOnlyRecipientRowSet::getBoolean()
Inx_Api_Recipient_ReadOnlyRecipientRowSet::getContext()
Inx_Api_Recipient_ReadOnlyRecipientRowSet::getDate()
Inx_Api_Recipient_ReadOnlyRecipientRowSet::getDatetime()
Inx_Api_Recipient_ReadOnlyRecipientRowSet::getDouble()
Inx_Api_Recipient_ReadOnlyRecipientRowSet::getInteger()
Inx_Api_Recipient_ReadOnlyRecipientRowSet::getMetaData()
Inx_Api_Recipient_ReadOnlyRecipientRowSet::getObject()
Inx_Api_Recipient_ReadOnlyRecipientRowSet::getString()
Inx_Api_Recipient_ReadOnlyRecipientRowSet::getTime()

Inherited From Inx_Api_InxRowSet

Inx_Api_InxRowSet::afterLastRow()
Inx_Api_InxRowSet::beforeFirstRow()
Inx_Api_InxRowSet::close()
Inx_Api_InxRowSet::getRow()
Inx_Api_InxRowSet::getRowCount()
Inx_Api_InxRowSet::next()
Inx_Api_InxRowSet::previous()
Inx_Api_InxRowSet::setRow()
Class Constants
BLACKLISTED = 17 (line 269)

The SubscriptionInformation State for a subscription blocked by a blacklist agent.

The SubscriptionInformation State for a subscription blocked by a blacklist agent.

  • since: API 1.9.0
DUPLICATE_SUBSCRIPTION = 7 (line 189)

The SubscriptionInformation state for duplicate subscriptions.

The SubscriptionInformation state for duplicate subscriptions.

  • since: API 1.9.0
DUPLICATE_UNSUBSCRIPTION = 26 (line 348)

The SubscriptionInformation state for a member who is already unsubscribed from this list.

The SubscriptionInformation state for a member who is already unsubscribed from this list.

  • since: API 1.10.1
INVALID_ADRESS_ERROR = 18 (line 277)

The SubscriptionInformation state for an invalid mail address.

The SubscriptionInformation state for an invalid mail address.

  • since: API 1.9.0
LIST_UNSUBSCRIBE_HEADER_UNSUBSCRIPTION = 21 (line 301)

The SubscriptionInformation state for an unsubscription received via an unsubscription header.

The SubscriptionInformation state for an unsubscription received via an unsubscription header.

  • since: API 1.9.0
LIST_UNSUBSCRIBE_HEADER_UNSUBSCRIPTION_NOT_IN_LIST = 25 (line 341)

The SubscriptionInformation state for unsubscriptions through a list unsubscribe header link where the recipient is not a member of the list (neither subscribed nor unsubscribed). property UnsubscribeNotInList is activated.

The SubscriptionInformation state for unsubscriptions through a list unsubscribe header link where the recipient is not a member of the list (neither subscribed nor unsubscribed). This state will only be used if the list property UnsubscribeNotInList is activated.

MANUAL_SUBSCRIPTION = 5 (line 173)

The SubscriptionInformation state for forced subscriptions.

The SubscriptionInformation state for forced subscriptions.

  • since: API 1.9.0
MANUAL_UNSUBSCRIPTION = 6 (line 181)

The SubscriptionInformation state for forced unsubscriptions.

The SubscriptionInformation state for forced unsubscriptions.

  • since: API 1.9.0
NOT_IN_LIST_UNSUBSCRIPTION = 8 (line 197)

The SubscriptionInformation state for unsubscription of unknown list members.

The SubscriptionInformation state for unsubscription of unknown list members.

  • since: API 1.9.0
NOT_IN_SYSTEM_UNSUBSCRIPTION = 27 (line 359)

The SubscriptionInformation state for an unsubscription request regarding a member who is not known to the system. possible that the recipient was deleted because she/he was no longer subscribed to any list. configured using the subscription manager option 'Delete recipient from system if the recipient is not subscribed to another list'.

The SubscriptionInformation state for an unsubscription request regarding a member who is not known to the system. This can happen when the recipient was manually deleted or was never part of the system. It is also possible that the recipient was deleted because she/he was no longer subscribed to any list. This can be configured using the subscription manager option 'Delete recipient from system if the recipient is not subscribed to another list'.

  • since: API 1.10.1
PENDING_SUBSCRIPTION = 3 (line 153)

The SubscriptionInformation State for pending subscriptions.

The SubscriptionInformation State for pending subscriptions.

PENDING_SUBSCRIPTION_DONE = 29 (line 373)

The SubscriptionInformation state for a verified subscription (Double Opt In).

The SubscriptionInformation state for a verified subscription (Double Opt In).

  • since: API 1.10.1
PENDING_UNSUBSCRIPTION = 4 (line 159)

The SubscriptionInformation State for pending unsubscriptions.

The SubscriptionInformation State for pending unsubscriptions.

PENDING_UNSUBSCRIPTION_DONE = 28 (line 366)

The SubscriptionInformation state for a verified unsubscription (Double Opt Out).

The SubscriptionInformation state for a verified unsubscription (Double Opt Out).

  • since: API 1.10.1
PENDING_UNSUBSCRIPTION_DONE_NOT_IN_LIST = 24 (line 331)

The SubscriptionInformation state for confirmed pending unsubscriptions where the recipient is not a member of the list (neither subscribed nor unsubscribed). UnsubscribeNotInList is activated.

The SubscriptionInformation state for confirmed pending unsubscriptions where the recipient is not a member of the list (neither subscribed nor unsubscribed). This state will only be used if the list property UnsubscribeNotInList is activated.

PENDING_UNSUBSCRIPTION_NOT_IN_LIST = 23 (line 321)

The SubscriptionInformation state for unverified unsubscriptions where the recipient is not a member of the list (neither subscribed nor unsubscribed). activated.

The SubscriptionInformation state for unverified unsubscriptions where the recipient is not a member of the list (neither subscribed nor unsubscribed). This state will only be used if the list property UnsubscribeNotInList is activated.

RECIPIENT_STATE_EXISTENT = 1 (line 133)

State for existent recipient.

State for existent recipient.

RECIPIENT_STATE_UNKNOWN_OR_DELETED = 0 (line 126)

State for missing recipient information.

State for missing recipient information. This state will be used when no attributes are specified in the query or in case of an unknown or deleted recipient.

SENDING_ID_UNKNOWN = 0 (line 382)

State for missing sending id information. log entry. available for unsubscription via certain methods (e.

State for missing sending id information. This state will be used when no sending id is present in the current log entry. Please note that the sending id is generally unknown for subscription log entries and is only available for unsubscription via certain methods (e.g. JSP based unsubscription).

  • since: API 1.12.1
SUBSCRIPTION_EMAIL_MISSMATCH = 11 (line 221)

The SubscriptionInformation state for subscriber email address != mail email address.

The SubscriptionInformation state for subscriber email address != mail email address.

  • since: API 1.9.0
SUBSCRIPTION_ID_NOT_VALID = 10 (line 213)

The SubscriptionInformation state for an invalid subscription verification.

The SubscriptionInformation state for an invalid subscription verification.

  • since: API 1.9.0
SUBSCRIPTION_INTERNAL_ERROR = 15 (line 253)

The SubscriptionInformation state for an error which occurred during the subscription.

The SubscriptionInformation state for an error which occurred during the subscription.

  • since: API 1.9.0
SUBSCRIPTION_TIMED_OUT = 9 (line 205)

The SubscriptionInformation state for a timed out subscription verification.

The SubscriptionInformation state for a timed out subscription verification.

  • since: API 1.9.0
SUBSCRIPTION_VERIFICATION_BOUNCED = 19 (line 285)

The SubscriptionInformation state for a bounced subscription verification.

The SubscriptionInformation state for a bounced subscription verification.

  • since: API 1.9.0
UNKNOWN_SUBSCRIPTIONTYPE = -1 (line 165)

The SubscriptionInformation State for an unknown subscription type.

The SubscriptionInformation State for an unknown subscription type.

UNSUBSCRIPTION_EMAIL_MISSMATCH = 14 (line 245)

The SubscriptionInformation state for member email address != mail email address.

The SubscriptionInformation state for member email address != mail email address.

  • since: API 1.9.0
UNSUBSCRIPTION_ID_NOT_VALID = 13 (line 237)

The SubscriptionInformation state for an invalid unsubscription verification.

The SubscriptionInformation state for an invalid unsubscription verification.

  • since: API 1.9.0
UNSUBSCRIPTION_INTERNAL_ERROR = 16 (line 261)

The SubscriptionInformation state for an error which occurred during the unsubscription.

The SubscriptionInformation state for an error which occurred during the unsubscription.

  • since: API 1.9.0
UNSUBSCRIPTION_TIMED_OUT = 12 (line 229)

The SubscriptionInformation state for a timed out unsubscription verification.

The SubscriptionInformation state for a timed out unsubscription verification.

  • since: API 1.9.0
UNSUBSCRIPTION_VERIFICATION_BOUNCED = 20 (line 293)

The SubscriptionInformation state for a bounced unsubscription verification.

The SubscriptionInformation state for a bounced unsubscription verification.

  • since: API 1.9.0
VERIFIED_SUBSCRIPTION = 1 (line 140)

The SubscriptionInformation State for verified subscriptions.

The SubscriptionInformation State for verified subscriptions.

VERIFIED_UNSUBSCRIPTION = 2 (line 147)

The SubscriptionInformation State for verified unsubscriptions.

The SubscriptionInformation State for verified unsubscriptions.

VERIFIED_UNSUBSCRIPTION_NOT_IN_LIST = 22 (line 311)

The SubscriptionInformation state for verified unsubscriptions where the recipient is not a member of the list (neither subscribed nor unsubscribed). activated.

The SubscriptionInformation state for verified unsubscriptions where the recipient is not a member of the list (neither subscribed nor unsubscribed). This state will only be used if the list property UnsubscribeNotInList is activated.

Documentation generated on Thu, 17 Sep 2015 14:27:31 +0200 by phpDocumentor 1.3.2