Klasa EmailAlias

namespace Kei\Webas\VPS

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

---

Charakterystyka

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

Index	Lista zasobów w postaci tabeli danych
Add	Dodanie jednej pozycji listy
Edit	Edycja wybranego aliasu
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\VPS\EmailAlias zwraca obiekt \Kei\Webas\VPS\EmailAlias\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\EmailAlias\Exception\AccountNotFoundException
• \Kei\Webas\VPS\EmailAlias\Exception\ResultException
• \Kei\Webas\VPS\EmailAlias\Exception\ValidationException
• \Kei\Webas\VPS\EmailAlias\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 aliasów w domenie 'example.pl'
$table = $webas->EmailAlias()->Index()->setSearch("", \Kei\Webas\VPS\EmailAlias\Index::buildSearchParams("example.pl"))->paginate();
\Kei\Library\Out::pd($table);
        
// Utworzenie nowego aliasu
$webas->EmailAlias()->
    Add("tester1", "example.com", "postmaster@example.com")->
execute();
        
// Edycja istniejącego aliasu
$webas->EmailAlias()->
Edit("tester1", "example.com")->
    setTargetAccount("postmasterd@example.com")->
execute();
        
// Usunięcie aliasu pocztowego
$webas->EmailAlias()->
    Remove(["tester1@example.com"])->
execute();