ePages 7.38.0 - DE_EPAGES/ShopNewsletter/API/Newsletter.pm

Package DE_EPAGES::ShopNewsletter::API::Newsletter

Returns template snippets for the newsletter.

@EXPORT_OK
AddUnsubscribe
InsertCouponSnippet
AddProductsAndCatalogs
AddShopLogo
GetShopLogo
GetSubscribeCount
GetUnsubscribeCount

Functions

AddProductsAndCatalogs
AddShopLogo
AddUnsubscribe
GetShopLogo
GetSubscribeCount
GetUnsubscribeCount
InsertCouponSnippet

AddProductsAndCatalogs

Returns the template with the selected catalog and product objects.

Syntax
$Promotion = AddProductsAndCatalogs( $Newsletter, $LanguageID, $IsHtml,
                $aProducts, $aCategories );
Input
$Newsletter (object)
newsletter object
$LanguageID (integer)
language id
$IsHtml (boolean)
is html allowed
$aProducts (ref.array)
list of products
$aCategories (ref.array)
list of categories
$ForceSSL (boolean)
force SSL as server protocol
Return
$Promotion (string)
promotion code

AddShopLogo

Returns the template snippet for the shop logo.

Syntax
$LogoCode = AddShopLogo( $Newsletter, $LanguageID, $IsHtml );
Input
$Newsletter (object)
newsletter object
$LanguageID (integer)
language id
$IsHtml (boolean)
is html allowed
Return
$LogoCode (string)
logo code

AddUnsubscribe

Returns the template snippet for unsubscribing the newsletter.

Syntax
$UnsubscribeCode = AddUnsubscribe( $Newsletter, $LanguageID, $IsHtml );
Input
$Newsletter (object)
newsletter object
$LanguageID (integer)
language id
$IsHtml (boolean)
is html allowed
Return
$UnsubscribeCode (string)
unsubscribe code

GetShopLogo

Returns the url and source of the shop logo.

Syntax
$hShopLogo = GetShopLogo( $Shop, $Newsletter );
Input
$Newsletter (object)
newsletter object
Return
$hResult (ref.hash)
logo url, source
  • URL - logo url - string
  • LogoSrc - logo source - string

GetSubscribeCount

Returns the amount of subscribers to the given newsletter.

Syntax
$SubscribeCount = GetSubscribeCount($NewsletterID);
Input
$NewsletterID (integer)
ID of the newsletter
Return
$SubscribeCount (integer)
Amount of subscribers

GetUnsubscribeCount

Returns the amount of Unsubscribers to the given newsletter.

Syntax
$UnsubscribeCount = GetUnsubscribeCount($NewsletterID);
Input
$NewsletterID (integer)
ID of the newsletter
Return
$UnsubscribeCount (integer)
Amount of unsubscribers

InsertCouponSnippet

Returns the template snippet for a Coupon.

Syntax
$CouponSnippet = InsertCouponSnippet( $Newsletter, $LanguageID, $IsHtml );
Input
$Newsletter (object)
newsletter object
$LanguageID (integer)
language id
$IsHtml (boolean)
is html allowed
Return
$CouponSnippet (string)
coupon code