ePages 6.12.0 - DE_EPAGES/ShopMailType/API/Object/ShopMailType.pm

Package DE_EPAGES::ShopMailType::API::Object::ShopMailType

object interface for ShopMailType.

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

Functions

delete
deleteSelf
from
insert
set
to

delete

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

Syntax
$ShopMailType->delete;
Hook
OBJ_DeleteShopMailType
hook parameter keys :
  • Object - this object - object
  • ShopMailTypeID - Shop mail type id - int

deleteSelf

Deletes the object at database tables.

Syntax
$ShopMailType->deleteSelf;

from

returns FROM address string of the mail

Syntax
$FROM = $ShopMailType->from( $FROM );
Example
$FROM = $ShopMailType->from( $FROM);
Input
$FROM (string (optional))
FROM address
Return
$FROM (string)
FROM address

insert

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

Syntax
$ShopMailType = DE_EPAGES::ShopMailType::API::Object::ShopMailType->insert($hInfo);
Example
my $Class = LoadClassByAlias('ShopMailType');
my $ShopMailType = $Class->insertObject($hInfo);
Input
$Package (string)
class package
$hInfo (ref.hash)
attributes of new object
Return
$ShopMailType (object)
new object
Hook
OBJ_InsertShopMailType
hook parameter keys :
  • Object - this object - object
  • ShopMailTypeID - Shop mail type id - int

set

This function triggers hooks 'OBJ_BeforeUpdateShopMailType' and 'OBJ_AfterUpdateShopMailType'.

Syntax
$ShopMailType->set($hValues, $LanguageID);
Input
$hValues (ref.hash)
attribute name => value hash
$LanguageID (int)
(optional; required for localized attributes) language id
Hook
OBJ_BeforeUpdateShopMailType
hook parameter keys :
  • Object - this object - object
  • ShopMailTypeID - Shop mail type id - int
  • Values - new values for object - ref.hash
  • LanguageID - values of this language will be updated - int
OBJ_AfterUpdateShopMailType
hook parameter keys :
  • Object - this object - object
  • ShopMailTypeID - Shop mail type id - int
  • Values - updated values - ref.hash
  • LanguageID - values updated of this language - int

to

returns the TO address string of this MailType. returns $TO if defined $TO. returns the value of the attribute 'TO' if it is defined. sets and returns the TO field to the shop attribute 'MailFrom' if the MailTypeTemplate has a TO field

Syntax
$TO = $ShopMailType->to($TO);
Example
$TO = $ShopMailType->to($TO);
Input
$TO (string (optional))
TO address
Return
$TO (string)
TO address