ePages 7.1.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

className
dbPackage
from
send
to

className

Returns the class name, used for DAL access.

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

dbPackage

Returns the database package, used for DAL access.

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

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

send

Sends an e-mail object using the current shop mail type if the ShopMailType is active or not. Sets Header, AdditionalText and Signature if they aren't set. Call afterwards SUPER::send.

Syntax
$Sent = $ShopMailType->send($Object, $hMailParams, $hRegionalParams, $hVars );
Example
$ShopMailType->send( $User, {
        HTMLAllowed => 1,
        TO => $User->get('EMail'),
    }, {
        Language => 'de',
        Locale => 'de_DE',
    }, { } );
Input
$Object (object)
send mail for object
$hMailParams (ref.hash)
e-mail options, see getMail
$hRegionalParams (ref.hash)
regional options, see getMail
$hVars (ref.hash)
TLE variables hash
Return
$Sent (boolean)
true if the mail was actually sent

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