Klasa Add

namespace Kei\Webas\VPS\EmailAlias

Klasa służy do dodania nowego aliasu do konta pocztowego analogicznie jak w panelu Webas pod adresem https://webas12345.tld.pl/EmailAlias/Add.

Klasa dziedziczy bezpośrednio z obiektu AbstractActionResult.


Dostępne metody klasy

__construct($a, $b, $c)

Konstruktor dzięki któremu utworzysz nowy obiekt klasy.

  • $a → Nazwa aliasu. Np. jan, nazwa powinna mieć od 2 do 32 znaków.
  • $b → Domena konta pocztowego
  • $c → Konto pocztowe docelowe

setDomain($a)
return $this

$a → Domena konta pocztowego

getDomain()
return string

Zwraca domenę konta pocztowego

setName($a)
return $this

$a → Nazwa aliasu. Np. jan, nazwa powinna mieć od 2 do 32 znaków.

getName()
return string

Zwraca nazwę aliasu

setTargetAccount($a)
return $this

$a → Konto pocztowe docelowe

getTargetAccount()
return int

Zwraca docelowe konto pocztowe do jakiego przypięty jest alias

*execute()
return Add

Bezparametrowa metoda zatwierdzająca i wykonująca akcję opisaną główną funkcją tej klasy.

*getActionResult()
return bool

Bezparametrowa metoda zwracająca status ostatniej operacji.

Gwiazdka przed nazwą metody oznacza iż ta metoda jest własnością klasy rodzica (dziedziczącej).


Wyjątki

Przejdź do pełnej listy wyjątków

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

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

// Utworzenie nowego aliasu
$webas->EmailAlias()->
    Add("tester1", "example.com", "postmaster@example.com")->
execute();

Klasa Add · NiceAPI dla PHP 5.6