Interface Inx_Api_GeneralMailing_GeneralMailing

Description

A Inx_Api_GeneralMailing_GeneralMailing object represents a mailing of any type in Inxmail.

A Inx_Api_GeneralMailing_GeneralMailing object represents a mailing of any type in Inxmail. It provides common mailing attributes. For an example on how to retrieve mailings, see the Inx_Api_GeneralMailing_GeneralMailingQuery documentation.

  • author: chge, 13.08.2013
  • since: API 1.11.10

Located in /Api/GeneralMailing/GeneralMailing.php (line 15)

Inx_Api_ReadOnlyBusinessObject
   |
   --Inx_Api_GeneralMailing_GeneralMailing
Method Summary
Methods
findLastSending (line 75)

Returns the last Inx_Api_Sending_Sending of this mailing, or null if this mailing has not yet been sent.

Returns the last Inx_Api_Sending_Sending of this mailing, or null if this mailing has not yet been sent.

  • return: the last Sending of this mailing, or null.
  • access: public
Inx_Api_Sending_Sending findLastSending ()
findSendings (line 68)

Returns an Inx_Api_ROBOResultSet containing all sendings of this mailing or empty if it has not yet been sent.

Returns an Inx_Api_ROBOResultSet containing all sendings of this mailing or empty if it has not yet been sent.

  • return: a ROBOResultSet containing all sendings of this mailing or empty if it has not yet been sent.
  • access: public
Inx_Api_ROBOResultSet findSendings ()
getCreationDatetime (line 51)

Returns the creation date of this mailing.

Returns the creation date of this mailing.

  • return: the creation date of this mailing. The date will be returned as an ISO 8601 formatted date string.
  • access: public
string getCreationDatetime ()
getListContextId (line 37)

Returns the ID of the list context this mailing belongs to.

Returns the ID of the list context this mailing belongs to.

  • return: the ID of the list context this mailing belongs to.
  • access: public
int getListContextId ()
getMailingType (line 44)

Returns the Inx_Api_GeneralMailing_MailingType of this mailing.

Returns the Inx_Api_GeneralMailing_MailingType of this mailing.

  • return: the Inx_Api_GeneralMailing_MailingType of this mailing.
  • access: public
getModificationDatetime (line 59)

Returns the modification date of this mailing.

Returns the modification date of this mailing.

  • return: the modification date of this mailing. The date will be returned as an ISO 8601 formatted date string.
  • access: public
string getModificationDatetime ()
getName (line 23)

Returns the name of this mailing.

Returns the name of this mailing.

  • return: the name of this mailing.
  • access: public
string getName ()
getSubject (line 30)

Returns the subject of this mailing.

Returns the subject of this mailing.

  • return: the subject of this mailing.
  • access: public
string getSubject ()

Inherited Methods

Inherited From Inx_Api_ReadOnlyBusinessObject

Inx_Api_ReadOnlyBusinessObject::getId()
Inx_Api_ReadOnlyBusinessObject::reload()

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