Klasa FilterSettings

namespace Kei\Webas\Dedicated\AntyspamSettings

Klasa agregująca pola grupy Ustawienia filtrów ze strony https://webas12345.tld.pl/AntyspamSettings.

Klasa implementuje interfejs DumperInterface

Grupa ta zawiera takie pola edycji jak:

• Obsługa RBLa wewnętrznego → metoda get/setRblForced
• Obsługa RBL zewnętrznych → metoda get/setRbl
• Obsługa SPF → metoda get/setSpf
• Obsługa GREYLIST → metoda get/setGreylist
• Filtr Sender-Auth → metoda get/setSenderAuth

Powyższe nazwy metod opisane są w tabeli poniżej.

---

Dostępne metody klasy

::Factory() return FilterSettings	Statyczna metoda zwracająca instancję klasy. Wzorzec projektowy Fabryka.
setGreylist($greylist) return FilterSettings	Obsługa GREYLIST $greylist → jedna z wartości YesNoEnum
getGreylist() return YesNoEnum value	Obsługa GREYLIST Zwraca przypisaną wartość do tego pola.
setRbl($rbl) return FilterSettings	Obsługa RBL zewnętrznych $rbl → jedna z wartości YesNoEnum
getRbl() return YesNoEnum value	Obsługa RBL zewnętrznych Zwraca przypisaną wartość do tego pola.
setRblForced($rbl_forced) return FilterSettings	Obsługa RBLa wewnętrznego $rbl_forced → jedna z wartości YesNoEnum
getRblForced() return YesNoEnum value	Obsługa RBLa wewnętrznego Zwraca przypisaną wartość do tego pola.
setSenderAuth($sender_auth) return FilterSettings	Filtr Sender-Auth $sender_auth → jedna z wartości SenderAuthFilterEnum
getSenderAuth() return SenderAuthFilterEnum value	Filtr Sender-Auth Zwraca przypisaną wartość do tego pola.
setSpf($spf) return FilterSettings	Obsługa SPF $sender_auth → jedna z wartości YesNoEnum
getSpf() return YesNoEnum value	Obsługa SPF Zwraca przypisaną wartość do tego pola.

---

Wyjątki

Wyjątki jakie zwraca ta klasa:

• \Kei\Webas\Dedicated\AntyspamSettings\Exception\WrongTypeException

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 tej klasy w innych instancjach klas dziedziczących

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

// Przygotowanie obiektu FilterSettings do późniejszego wykorzystania...
$fsv = \Kei\Webas\Dedicated\AntyspamSettings\FilterSettings::Factory()->
        setGreylist(\Kei\Webas\Dedicated\YesNoEnum::Yes)->
        setSpf(\Kei\Webas\Dedicated\YesNoEnum::No);


// Wykorzystanie obiektu FilterSettings...
$result = $webas->AntyspamSettings()->
    Edit()->
    setSendmailLimitsValue(\Kei\Webas\Dedicated\AntyspamSettings\SendmailLimits::Factory()->
        setSendmailTimeLimit(null))->
    setFilterSettingsValue($fsv)->
    execute();

\Kei\Library\Out::vd($result->getActionResult());