Interface Inx_Api_Sending_SendingReport

Description

The Inx_Api_Sending_SendingReport object provides accumulated report data for an Inx_Api_Sending_Sending. Inx_Api_Sending_Sending::getReportData().

The Inx_Api_Sending_SendingReport object provides accumulated report data for an Inx_Api_Sending_Sending. It can be retrieved using the method Inx_Api_Sending_Sending::getReportData(). The following data can be accessed:

  • The number of mailings which have been opened
  • The number of recipients who clicked on any link of the mailing
  • The number of sent mails, including those which bounced
  • The number of sent mails, excluding those which bounced
  • The number of bounced mails
  • The number of mails which have not been sent
  • The average mail size

Located in /Api/Sending/SendingReport.php (line 28)


	
			
Method Summary
Methods
getAverageMailSize (line 78)

Returns the average size of the sent mails in bytes.

Returns the average size of the sent mails in bytes.

  • return: The average size of the sent mails in bytes.
  • access: public
int getAverageMailSize ()
getBouncedCount (line 64)

Returns the number of recipients who caused a bounce.

Returns the number of recipients who caused a bounce.

  • return: The number of recipients who caused a bounce.
  • access: public
int getBouncedCount ()
getClickedCount (line 43)

Returns the number of recipients who clicked a link of the mailing.

Returns the number of recipients who clicked a link of the mailing.

  • return: The number of recipients who clicked a link of the mailing.
  • access: public
int getClickedCount ()
getNotSentCount (line 71)

Returns the number of mails which have not yet been sent.

Returns the number of mails which have not yet been sent.

  • return: The number of mails which have not yet been sent.
  • access: public
int getNotSentCount ()
getOpenedCount (line 36)

Returns the number of recipients who opened the mailing.

Returns the number of recipients who opened the mailing.

  • return: The number of recipients who opened the mailing.
  • access: public
int getOpenedCount ()
getSentCountExcludingBounces (line 57)

Returns the number of sent mails, excluding those which bounced.

Returns the number of sent mails, excluding those which bounced.

  • return: The number of sent mails, excluding those which bounced.
  • access: public
int getSentCountExcludingBounces ()
getSentCountIncludingBounces (line 50)

Returns the number of sent mails, including those which bounced.

Returns the number of sent mails, including those which bounced.

  • return: The number of sent mails, including those which bounced.
  • access: public
int getSentCountIncludingBounces ()

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