ePages 6.11.0 - DE_EPAGES/Newsletter/API/Object/Newsletter.pm

Package DE_EPAGES::Newsletter::API::Object::Newsletter

object interface for Newsletter.

Base
DE_EPAGES::Object::API::Object::Object

Functions

delete
deleteSelf
insert
sendNewsletter
sendTest
set

delete

Deletes this object, therefore the hook 'OBJ_DeleteNewsletter' is triggered.

Syntax
$Newsletter->delete;
Hook
OBJ_DeleteNewsletter
hook parameter keys :
  • Object - this object - object
  • NewsletterID - Newsletter Identifier - int

deleteSelf

Deletes the object at database tables.

Syntax
$Newsletter->deleteSelf;

insert

Insert this info as object, afterwards the hook 'OBJ_InsertNewsletter' is triggered.

Syntax
$Newsletter = DE_EPAGES::Newsletter::API::Object::Newsletter->insert($hInfo);
Example
my $Class = LoadClassByAlias('Newsletter');
my $Newsletter = $Class->insertObject($hInfo);
Input
$class (string)
class package
$hInfo (ref.hash)
attributes of new object
Return
$Newsletter (object)
new object
Hook
OBJ_InsertNewsletter
hook parameter keys :
  • Object - this object - object
  • NewsletterID - Newsletter Identifier - int

sendNewsletter

sends a newsletter to each campaign recipient

Syntax
$Object->sendNewsletter();

sendTest

sends a test email with the newsletter

Syntax
$Object->sendTest();

set

This function triggers hooks 'OBJ_BeforeUpdateNewsletter' and 'OBJ_AfterUpdateNewsletter'.

Syntax
$Newsletter->set($hValues, $LanguageID);
Hook
OBJ_BeforeUpdateNewsletter
hook parameter keys :
  • Object - this object - object
  • NewsletterID - Newsletter Identifier - int
  • Values - new values for object - ref.hash
  • LanguageID - values of this language will be updated - int
OBJ_AfterUpdateNewsletter
hook parameter keys :
  • Object - this object - object
  • NewsletterID - Newsletter Identifier - int
  • Values - updated values - ref.hash
  • LanguageID - values updated of this language - int