ePages 6.17.39 - DE_EPAGES/Newsletter/API/Object/NewsletterCampaign.pm

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

object interface for NewsletterCampaign.

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

Functions

addAddressee
addCustomer
className
dbPackage
delete
existsAddressee
exportXMLElements
getAddressee
insert
set

addAddressee

This function adds an addressee to the newsletter campaign.

Syntax
my $Addressee = $NewsletterCampaign->addAddressee($hInfo);
Input
$hInfo (ref.hash)
attributes of new addressee
  • Name - name of addressee (optional) - varchar(255)
  • EMail - email address - varchar(255)
  • User - user object (optional) - object
  • Unsubscribed - subscription status (optional) - integer
  • SubscribedInCheckout - subscription is not confirmed and was
    done during order process or registration (optional) - boolean
Return
$Addressee (DE_EPAGES::Newsletter::API::Object::NewsletterAddressee)
addressee object

addCustomer

This function adds a customer to a newsletter campaign.

Syntax
$NewsletterCampaign->addCustomer($Customer);
Input
$Customer (object)
customer object

className

Returns the class name, used for DAL access.

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

dbPackage

Returns the database package, used for DAL access.

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

delete

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

Syntax
$NewsletterCampaign->delete;
Hook
OBJ_DeleteNewsletterCampaign
hook parameter keys :
  • Object - this object - object
  • NewsletterCampaignID - Identifier of Newsletter Campaign - int

existsAddressee

This function tests if the newsletter campaign own a certain addressee.

Syntax
$Exists = $NewsletterCampaign->existsAddressee($EMailAddress);
Input
$hInfo (ref.hash)
attributes of new addressee
  • EMail - email address - varchar(255)
Return
$Exists (boolean)
true if the addressee exists

exportXMLElements

Exports addressees of the newsletter campaign 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

getAddressee

This function returns a certain addressee of the newsletter campaign.

Syntax
my $Addresse = $NewsletterCampaign->getAddressee($EMail);
Input
$EMail (string)
email address
Return
$Addressee (DE_EPAGES::Newsletter::API::Object::NewsletterAddressee)
addressee exists

insert

Insert this info as object, afterwards the hook 'OBJ_InsertNewsletterCampaign' is triggered. Before insert this info the hook OBJ_BeforeInsertNewsletterCampaign is triggered.

Syntax
$NewsletterCampaign = DE_EPAGES::Newsletter::API::Object::NewsletterCampaign->insert($hInfo);
Example
my $Class = LoadClassByAlias('NewsletterCampaign');
my $NewsletterCampaign = $Class->insertObject($hInfo);
Input
$hInfo (ref.hash)
attributes of new object
Return
$NewsletterCampaign (object)
new object
Hook
OBJ_InsertNewsletterCampaign
hook parameter keys :
  • Object - this object - object
  • NewsletterCampaignID - Identifier of Newsletter Campaign - int
OBJ_BeforeInsertNewsletterCampaign
hook parameter keys :
  • Object - this object - object
  • NewsletterCampaignID - Identifier of Newsletter Campaign - int

set

This function triggers hooks 'OBJ_BeforeUpdateNewsletterCampaign' and 'OBJ_AfterUpdateNewsletterCampaign'.

Syntax
$NewsletterCampaign->set($hValues, $LanguageID);
Input
$hValues (ref.hash)
attribute name => value hash
$LanguageID (int)
(optional; required for localized attributes) language id
Hook
OBJ_BeforeUpdateNewsletterCampaign
hook parameter keys :
  • Object - this object - object
  • NewsletterCampaignID - Identifier of Newsletter Campaign - int
  • Values - new values for object - ref.hash
  • LanguageID - values of this language will be updated - int
OBJ_AfterUpdateNewsletterCampaign
hook parameter keys :
  • Object - this object - object
  • NewsletterCampaignID - Identifier of Newsletter Campaign - int
  • Values - updated values - ref.hash
  • LanguageID - values updated of this language - int