Klasa EmailMailinglist

namespace Kei\Webas\Dedicated

Klasa do zarządzania subskrypcjami list pocztowych w celu powiadamiania użytkowników poprzez ich skrzynki pocztowe. Funkcjonalne odwzorowanie panelu na stronie https://webas12345.tld.pl/EmailMailinglist.

---

Charakterystyka

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

Index	Lista zasobów w postaci tabeli danych
Add	Dodanie jednej pozycji listy
Edit	Edycja wybranej subskrypcji
Remove	Usunięcie jednej lub więcej pozycji listy

Każda z powyższych metod zwraca odpowiadający jej obiekt klasy znajdujący się w tej samej przestrzeni nazw i nazywający się tak samo jak metoda do której się odnosi.

Np. metoda Edit klasy \Kei\Webas\Dedicated\EmailMailinglist zwraca obiekt \Kei\Webas\Dedicated\EmailMailinglist\Edit itd.

Po kliknięciu w jedną z powyższych metod przejdziesz do strony charakteryzującej odpowiadający jej obiekt.

---

Wyjątki

Wyjątki jakie zwraca ta klasa oraz pozostałe klasy powiązane są następujące:

• \Kei\Webas\Dedicated\EmailMailinglist\Exception\AccountNotFoundException
• \Kei\Webas\Dedicated\EmailMailinglist\Exception\ResultException
• \Kei\Webas\Dedicated\EmailMailinglist\Exception\ValidationException
• \Kei\Webas\Dedicated\EmailMailinglist\Exception\WrongTypeException

oraz wyjątki standardowe dla wszystkich obiektów położonych wyżej w hierarchii:

• \Kei\Webas\Dedicated\Exception\DefaultPaginatorActionException
• \Kei\Webas\Dedicated\Exception\InfoTableColumnCountException
• \Kei\Webas\Dedicated\Exception\InitialCookieNotFoundException
• \Kei\Webas\Dedicated\Exception\ServiceNumberFormatException
• \Kei\Webas\Dedicated\Exception\UncountableResultsException
• \Kei\Webas\Dedicated\Exception\WebasAuthenticationException
• \Kei\Webas\Dedicated\Exception\WebasConnectionException

Pamiętaj o tym, aby zawsze być przygotowanym na zwrócenie wyjątku przez skrypt PHP niezależnie od tego jak bardzo małoprawdopodobnym uważasz jego wystąpienie.

---

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

// Pobranie wszystkich dodanych list mailingowych w domenie 'example.pl'
$table = $webas->EmailMailinglist()->Index()->setSearch("", \Kei\Webas\Dedicated\EmailAccount\Index::buildSearchParams("example.pl"))->paginate();
\Kei\Library\Out::pd($table);

// Dodanie nowej subskrypcji
$webas->EmailMailinglist()->
    Add("zaq12wsx", "example.pl")->
        setAddressesValue(\Kei\Webas\Dedicated\EmailMailinglist\Addresses::Factory()->
        setAccountsList(["lorem@wp.pl", "loremlipsum@example.pl"]))->
    execute();

// Edycja listy mailingowej
$eml = $webas->EmailMailinglist()->
    Edit("zaq12wsx", "example.pl")->
        setAddressesValue(\Kei\Webas\Dedicated\EmailMailinglist\Addresses::Factory()->
            setAccountsList(["lorem@wp.pl", "loremlipsum@example.pl"]))->
        setTemplatesValue($eml->getTemplatesValue()->
            setSubscribeMailSubject("zzssdd"))->
    execute();

// Usunięcie list mailingowych
$webas->EmailMailinglist()->
    Remove(["zaq12wsx@example.pl"])->
execute();