Klasa EmailAccount

namespace Kei\Webas\VPS

Klasa do zarządzania kontami pocztowymi. Funkcjonalne odwzorowanie panelu na stronie https://webas12345.tld.pl/EmailAccount.

UWAGA!

Klasa ta zawiera bardzo ważną podklasę \Kei\Webas\VPS\EmailAccount\Profile. Koniecznie zapoznaj się z nią jeśli jeszcze tego nie zrobiłeś.

---

Charakterystyka

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

Index	Lista zasobów w postaci tabeli danych
Add	Dodanie jednej pozycji listy
AddMany	Dodanie większej ilości kont pocztowych
Edit	Edycja wybranego konta pocztowego
Remove	Usunięcie jednej lub więcej pozycji listy
Block	Zablokowanie wybranej domeny
Unblock	Odblokowanie wybranej domeny

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\VPS\EmailAccount zwraca obiekt \Kei\Webas\VPS\EmailAccount\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\VPS\EmailAccount\Exception\AccountNotFoundException
• \Kei\Webas\VPS\EmailAccount\Exception\ProfileNotFoundException
• \Kei\Webas\VPS\EmailAccount\Exception\ResultException
• \Kei\Webas\VPS\EmailAccount\Exception\ValidationException
• \Kei\Webas\VPS\EmailAccount\Exception\WrongTypeException

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

• \Kei\Webas\VPS\Exception\DefaultPaginatorActionException
• \Kei\Webas\VPS\Exception\InfoTableColumnCountException
• \Kei\Webas\VPS\Exception\InitialCookieNotFoundException
• \Kei\Webas\VPS\Exception\ServiceNumberFormatException
• \Kei\Webas\VPS\Exception\UncountableResultsException
• \Kei\Webas\VPS\Exception\WebasAuthenticationException
• \Kei\Webas\VPS\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 kont pocztowych spełniających warunki istnienia w domenie 'example.pl'
$table = $webas->EmailAccount()->Index()->setSearch("", \Kei\Webas\VPS\EmailAccount\Index::buildSearchParams("example.pl"))->paginate();
\Kei\Library\Out::pd($table);

// Utworzenie nowego konta pocztowego 'loremlipsum2@example.pl'
$webas->EmailAccount()->
    Add("loremlipsum2", "example.pl", "8k55HFBz6A")->
        setForwards(['someaccount@gmail.com', 'abc@wp.pl'])->
        setAliases(['zaqwsx', 'homesweethome'])->
    execute();

// Edycja wybranego konta poczty
$handle = $webas->EmailAccount()->Edit("loremlipsum", "example.pl");
$handle->
    setAutoresponderValue(\Kei\Webas\VPS\EmailAccount\AutoresponderService::Factory()->
        setAutoresponderServiceEnabled("noname@wp.pl", "treść maila")->
        setAutoresponderWhitelist(['somename@onet.pl', 'radiohead@wp.pl']))->
    execute();

// Utworzenie wielu kont pocztowych na raz.
$webas->EmailAccount()->
    AddMany(["zaq1", "zaq2"], "example.pl", "8k55HFBz6A")->
execute();

// Blokada kont pocztowych
$webas->EmailAccount()->
    Block(["zaq1@wp.pl", "zaq2@wp.pl"])->
execute();

// Odblokowanie kont pocztowych
$webas->EmailAccount()->
    Unblock(["zaq1@wp.pl", "zaq2@wp.pl"])->
execute();

// Usunięcie wskazanych kont
$webas->EmailAccount()->
    Remove(["zaq1@wp.pl", "zaq2@wp.pl"])->
execute();