Interface Inx_Api_Util_Utilities

Description

The Inx_Api_Util_Utilities class provides utility methods that can be used for special activities.

The Inx_Api_Util_Utilities class provides utility methods that can be used for special activities.

  • version: $Revision: 9497 $ $Date: 2007-12-19 17:03:25 +0200 (Tr, 19 Grd 2007) $ $Author: aurimas $
  • since: API 1.1.0

Located in /Api/Util/Utilities.php (line 15)


	
			
Method Summary
bool existsTestRecipient (int $iIdToCheck)
void tellAFriend (Inx_Api_List_ListContext $oListContext, int $iMailingId, int $iRecipientId, bool $blTakeProfile, string $sEmail, string $sTextIntro, string $sHtmlIntro)
Methods
existsTestRecipient (line 43)

Checks whether the given test recipient id exists.

Checks whether the given test recipient id exists.

  • return: true if the given test recipient id exists, false otherwise.
  • since: API 1.6.0
  • access: public
bool existsTestRecipient (int $iIdToCheck)
  • int $iIdToCheck: the test recipient id to check.
tellAFriend (line 33)

Forwards a mailing to someone different from the original recipient.

Forwards a mailing to someone different from the original recipient. The mailing may be personalized for the original recipient, and introductory information (e.g. who forwarded the mail, and who to subscribe) may be added.

  • throws: Inx_Api_Util_TellAFriendException if the mail could not be forwarded.
  • since: API 1.1.0
  • access: public
void tellAFriend (Inx_Api_List_ListContext $oListContext, int $iMailingId, int $iRecipientId, bool $blTakeProfile, string $sEmail, string $sTextIntro, string $sHtmlIntro)
  • Inx_Api_List_ListContext $oListContext: the list to which the mail was sent.
  • int $iMailingId: the mailing to forward.
  • int $iRecipientId: the original recipient.
  • bool $blTakeProfile:
    1. true
    if the mailing shall be personalized for the original recipient,
    1. false
    otherwise.
  • string $sEmail: the address of the recipient to whom the mail shall be forwarded.
  • string $sTextIntro: introductory text, plain text format.
  • string $sHtmlIntro: introductory text, HTML format.

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