Klasa Templates

namespace Kei\Webas\Dedicated\EmailMailinglist

Za jej pomocą stworzysz szablony wiadomości wysyłanych do subskrybentów listy mailingowej. Analogia do zakładki nazwanej w panelu Webas jako Szablony

Klasa implementuje interfejs DumperInterface


Charakterystyka

Metody obiektu - zapoznaj się z opisem pod tabelą.

__construct()
return Templates

Konstruktor z domyślnie pustą listą szablonów (ich treścią)

::Factory()
return Templates

Statyczna metoda zwracająca instancję klasy. Wzorzec projektowy Fabryka.

::ImportTemplates()
return Templates

Statyczna metoda pozwala na zaimportowanie domyślnych treści szablonów, zaproponowanych przez panel Webas.

setSubscribeMailSubject($txt)
return $this

Temat wiadomości, jaka zostanie wysłana do użytkownika jako potwierdzenie zapisu na listę.
$txt → Podaj treść jaka zostanie użyta w temacie.

getSubscribeMailSubject()
return string

Zwraca temat wiadomości wiadomości

setSubscribeMailBody($txt)
return $this

Szablon wiadomości, jaka zostanie wysłana do użytkownika jako potwierdzenie zapisu na listę.
$txt → Podaj treść jaka zostanie użyta.

getSubscribeMailBody()
return string

Zwraca treść szablonu wiadomości

setSubscribeRequestMailSubject($txt)
return $this

Zgłoszenie nowego adresu (temat)
$txt → Podaj treść tematu zgłoszenia.

getSubscribeRequestMailSubject()
return string

Zwraca temat zgłoszenia nowego adresu

setSubscribeRequestMailBody($txt)
return $this

Szablon wiadomości, jaka zostanie wysłana do użytkownika, który zgłosi chęć zapisu na listę. Będzie ona zawierać link potwierdzający.
$txt → Podaj treść wiadomości zgłoszenia.

getSubscribeRequestMailBody()
return string

Zwraca treść wiadomości zgłoszenia nowego adresu

setUnsubscribeMailSubject($txt)
return $this

Rezygnacja z subskrybcji listy (temat)
$txt → Podaj treść tematu zgłoszenia.

getUnsubscribeMailSubject()
return string

Zwraca temat szablonu rezygnacji z subskrypcji

setUnsubscribeMailBody($txt)
return $this

Szablon wiadomości, jaka zostanie wysłana do użytkownika jako potwierdzenie wypisu z listy.
$txt → Podaj treść wiadomości.

getUnsubscribeMailBody()
return string

Zwraca treść wiadomości

setUnsubscribeRequestMailSubject($txt)
return $this

Zgłoszenie rezygnacji (temat)
$txt → Podaj treść tematu rezygnacji z subskrypcji.

getUnsubscribeRequestMailSubject()
return string

Zwraca temat zgłoszenia rezygnacji z subskrypcji

setUnsubscribeMailBody($txt)
return $this

Szablon wiadomości, jaka zostanie wysłana do użytkownika, który zgłosi chęć wypisu z listy. Będzie ona zawierać link potwierdzający.
$txt → Podaj treść wiadomości.

getUnsubscribeMailBody()
return string

Zwraca treść wiadomości zgłoszenia rezygnacji

*dump()
return Array

Zobacz więcej tutaj DumperInterface

Gwiazdka przed nazwą metody oznacza iż ta metoda jest własnością klasy rodzica (dziedziczącej).


Przykłady wykorzystania metod

W poniższym przykładzie pominięto autoryzację do serwera. Obiekt Client znajduje się w zmiennej $webas. Więcej o autoryzacji przeczytasz w dziale jak rozpocząć ?

Nie zawijaj wierszy<?php
// Autoryzacja...

// Nowy obiekty Templates wraz z domyślnymi treściami
$tpls = \Kei\Webas\Dedicated\EmailMailinglist\Templates::ImportTemplates();
$tpls->setSubscribeMailSubject("Witamy na naszej liście <MAILINGLIST_EMAIL> !");

// Dodanie nowej subskrypcji
$webas->EmailMailinglist()->
    Add("zaq12wsx", "example.pl")->
        setTemplatesValue($tpls)->
    execute();

Klasa Templates · NiceAPI dla PHP 5.6