ePages 6.17.9 - 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

addRecipient
className
dbPackage
delete
exportXMLElements
getRecipient
insert
sendNewsletter
sendTest
set

addRecipient

This function adds an recipient to the newsletter.

Syntax
my $Recipient = $Newsletter->addRecipient($hInfo);
Input
$hInfo (ref.hash)
attributes of new recipient
  • Name - name of addressee - varchar(255)
  • EMail - email address - varchar(255)
  • WasSent - newsletter was sent (optional) - integer
  • SentDate - date when newsletter was sent (optional) - DateTime
  • Result - sent result (optional) - integer
Return
$Addressee (DE_EPAGES::Newsletter::API::Object::NewsletterRecipient)
recipient object

className

Returns the class name, used for DAL access.

Syntax
$ClassName = $Newsletter->className;
Return
$ClassName (String)
class name

dbPackage

Returns the database package, used for DAL access.

Syntax
$DbPackage = $Newsletter->dbPackage;
Return
$DbPackage (String)
database package name

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

exportXMLElements

Exports recipients of the newsletter to the xml SAX driver.

Syntax
$Object->exportXMLElements($Driver, $hAllAttributes);
Input
$Driver (object)
export driver
$hAllAttributes (ref.hash)
all attributes of object,
see $Object->allAttributes

getRecipient

Returns a newsletter recipient by email address. Returns undef if there is no recipient with the given email address. If there are multiple recipients with the same email address, returns the first in the list. There is no unique index on the email column for backward compatibility.

Syntax
my $Recipient = $Newsletter->getRecipient($EMail);
Input
$EMail (string)
e-mail address
Return
$Recipient (DE_EPAGES::Newsletter::API::Object::NewsletterRecipient)
newsletter recipient object

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
$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
$Newsletter->sendNewsletter;
$Newsletter->sendNewsletter( $Servlet );
Input
$Servlet (DE_EPAGES::WebInterface::Servlet::BaseServlet)
(optional) current servlet

sendTest

sends a test email with the newsletter

Syntax
$Newsletter->sendTest();

set

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

Syntax
$Newsletter->set($hValues, $LanguageID);
Input
$hValues (ref.hash)
attribute name => value hash
$LanguageID (int)
(optional; required for localized attributes) language id
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