Klasa AntyspamWhitelist

namespace Kei\Webas\Dedicated

Klasa służy do ustawiania oraz edycji uprzywilejowanych domen oraz skrzynek pocztowych.

---

Charakterystyka

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

Index	Lista zasobów w postaci tabeli danych
Add	Dodanie jednej lub więcej pozycji listy
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 Remove klasy \Kei\Webas\Dedicated\AntyspamWhitelist zwraca obiekt \Kei\Webas\Dedicated\AntyspamWhitelist\Remove 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\AntyspamWhitelist\Exception\ResourceNotFoundException
• \Kei\Webas\Dedicated\AntyspamWhitelist\Exception\ResultException
• \Kei\Webas\Dedicated\AntyspamWhitelist\Exception\ValidationException
• \Kei\Webas\Dedicated\AntyspamWhitelist\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...

// Lista wszystkich uprzywilejowanych elementów
$table = $webas->AntyspamWhitelist()->Index()->paginate();
\Kei\Library\Out::pd($table);


// Pobranie informacji o stanie wykorzystania
$handle = $webas->AntyspamWhitelist()->Add();
$limit = $handle->getLimit();
$usage = $handle->getUsage();
\Kei\Library\Out::p($limit);
\Kei\Library\Out::pd($usage);


// Dodanie nowego uprzywilejowanego elementu
$webas->AntyspamWhitelist()->
    Add('example.pl')->
    execute();


// Usunięcie elementu listy
$webas->AntyspamWhitelist()->
    Remove('example.pl')->
    execute();