Klasa ProfileEmailAccount

namespace Kei\Webas\VPS

Klasa oferująca zarządzanie profilami skrzynek pocztowych. Funkcjonalne odwzorowanie panelu na stronie https://webas12345.tld.pl/ProfileEmailAccount.

UWAGA!

Klasa ta wykorzystuje bardzo ważną klasę \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
Edit	Edycja wybranego profilu domeny
Remove	Usunięcie profilu 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 Add klasy \Kei\Webas\VPS\ProfileEmailAccount zwraca obiekt \Kei\Webas\VPS\ProfileEmailAccount\Add 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\ProfileEmailAccount\Exception\ProfileNotFoundException
• \Kei\Webas\VPS\ProfileEmailAccount\Exception\ResultException
• \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 profili
$table = $webas->ProfileEmailAccount()->Index()->paginate();
\Kei\Library\Out::pd($table);

// Załadowanie profilu o nazwie 'base'
$profile = \Kei\Webas\VPS\EmailAccount\Profile::load("base");
\Kei\Library\Out::pd($profile);

// Dodanie nowego profilu
$webas->ProfileEmailAccount()->
    Add(new \Kei\Webas\VPS\EmailAccount\Profile("base2", "lorem lipsum"))->
execute();

// Edycja profilu 'base'
$webas->ProfileEmailAccount()->
    Edit("base", new \Kei\Webas\VPS\EmailAccount\Profile("base2sssss", "lorem lipsum22"))->
execute();

// Usunięcie wybranego profilu
$webas->ProfileEmailAccount()->Remove("base")->execute();