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 |
|
Return |
|
className
Returns the class name, used for DAL access.
Syntax |
$ClassName = $Newsletter->className; |
Return |
|
dbPackage
Returns the database package, used for DAL access.
Syntax |
$DbPackage = $Newsletter->dbPackage; |
Return |
|
delete
Deletes this object, therefore the hook 'OBJ_DeleteNewsletter' is triggered.
Syntax |
$Newsletter->delete; |
Hook |
|
exportXMLElements
Exports recipients of the newsletter to the xml SAX driver.
Syntax |
$Object->exportXMLElements($Driver, $hAllAttributes); |
Input |
|
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 |
|
Return |
|
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 |
|
Return |
|
Hook |
|
sendNewsletter
sends a newsletter to each campaign recipient.
Syntax |
$Newsletter->sendNewsletter; $Newsletter->sendNewsletter( $Servlet ); |
Input |
|
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 |
|
Hook |
|