Klasa SendmailLimits

namespace Kei\Webas\Dedicated\AntyspamSettings

Klasa agregująca pola grupy Listy wysyłek (Sendmail) - domyślny czasowy limit wysyłek e-mail (Sendmail). Strona https://webas12345.tld.pl/AntyspamSettings.

Klasa implementuje interfejs DumperInterface

Grupa ta zawiera takie pola edycji jak:

  • Limit wysyłek → metoda get/setSendmailTimeLimit
  • Okres czasu → metoda getSendmailTimePeriod

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


Dostępne metody klasy

::Factory()
return SendmailLimits

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

setSendmailTimeLimit($p1,$p2)
return SendmailLimits

Limit wysyłek
$p1 → limit wysyłek. Liczba całkowita lub wartość NULL. NULL oznacza wartość brak limitów.
$p2 = TimePeriodEnum::Time1Hour → okres czasu. Jedna z wartości TimePeriodEnum

getSendmailTimeLimit()
return int|NULL

Limit wysyłek
Zwraca przypisaną wartość do tego pola.

getSendmailTimePeriod()
return int

Okres czasu
Zwraca jednostkę czasową dla limitu wysyłek


Wyjątki

Wyjątki jakie zwraca ta klasa:

  • \Kei\Webas\Dedicated\AntyspamSettings\Exception\ValidationException
  • \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 SmtpLimits do późniejszego wykorzystania...
$slv = \Kei\Webas\Dedicated\AntyspamSettings\SendmailLimits::Factory()->
        setSendmailTimeLimit(150, \Kei\Webas\Dedicated\AntyspamSettings\TimePeriodEnum::Time15Minutes);


// Wykorzystanie obiektu SmtpLimits...
$result = $webas->AntyspamSettings()->
    Edit()->
        setSendmailLimitsValue($slv)->
    execute();

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

Klasa SendmailLimits · NiceAPI dla PHP 5.6