Klasa AddMany

namespace Kei\Webas\Dedicated\EmailAccount

Klasa służy do dodania wielu nowych kont pocztowych za jednym razem analogicznie jak w panelu Webas pod adresem https://webas12345.tld.pl/EmailAccount/AddMany.

Klasa dziedziczy bezpośrednio z obiektu AbstractActionResult.


Dostępne metody klasy

__construct($a, $b, $c,
$d, $e)

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

  • $a → Nazwy kont jako tablica lub jedna nazwa jako ciąg tekstowy. Np. jan, nazwa powinna mieć od 2 do 32 znaków.
  • $b → Domena konta pocztowego
  • $c → Hasło. Hasło powinno mieć od 6 do 24 znaków oraz zawierać przynajmniej jedną cyfrę lub jeden ze znaków specjalnych: ~ ! @ # % ^ & * ( ) _ \ = \ - ; , . / < > ? : [ ] { }.
  • $d → Profil konta pocztowego. Użyj instancji klasy \Kei\Webas\Dedicated\EmailAccount\Profile Domyślnie null
  • $e → Opis do konta pocztowego. Domyślnie: null

setKeepMail($a)
return $this

$a → (true|false) Wiadomości przechowywane na koncie pocztowym

getKeepMail()
return bool

Zwraca informację czy wiadomości są przechowywane na koncie pocztowym

setForwards($a)
return $this

$a → Adres/y (jeden lub tablica adresów) przekierowania wiadomości e-mail z konta. Ta metoda działa dobrze w parze z metodą setKeepMail() do której jako pierwszy parametr przekazana zostanie wartość false

getForwards()
return Array

Zwraca listę adresów przekierowań

setForwardLimit($a)
return $this

$a → Limit adresów przekierowań. Liczba adresów e-mail jakie może utworzyć właściciel konta pocztowego z poziomu panelu Webmail. Limit nie dotyczy operacji wykonywanych poprzez narzędzie WebasPanel.

getForwardLimit()
return int

Zwraca limit adresów przekierowań.

setAliasesLimit($a)
return $this

$a → Limit aliasów. Liczba aliasów pocztowych jakie może utworzyć właściciel konta pocztowego z poziomu panelu Webmail. Limit nie dotyczy operacji wykonywanych poprzez narzędzie WebasPanel.

getAliasesLimit()
return int

Zwraca limit aliasów.

setAliases($a)
return $this

$a → Alias/y (jeden lub tablica adresów) konta pocztowego.

getAliases()
return Array

Zwraca listę aliasów konta pocztowego

setDescription($a)
return $this

$a → Opis do konta pocztowego

getDescription()
return string

Zwraca opis do konta pocztowego

setDomain($a)
return $this

$a → Domena konta pocztowego

getDomain()
return string

Zwraca domenę konta pocztowego

setNames($a)
return $this

$a → Nazwy kont pocztowych jako tablica

getNames()
return Array

Zwraca nazwy kont pocztowych

setPassword($a)
return $this

$a → Ustawia hasło do konta pocztowego

getPassword()
return string|null

Zwraca hasło. Uwaga! Nie ma możliwości odczytania hasła, które zostało ustawione wcześniej i zapisane na serwerze.

setProfile($a)
return $this

$a → Ustawia profil konta pocztowego. Użyj instancji klasy \Kei\Webas\Dedicated\EmailAccount\Profile

getProfile()
return Profile

Zwraca ustawiony profil w postaci obiektu \Kei\Webas\Dedicated\EmailAccount\Profile

setExpirationDate($a)
return $this

$a → Data wygaśnięcia konta. Format daty to RRRR-mm-dd

getExpirationDate()
return string

Zwraca hasło. Uwaga! Nie ma możliwości odczytania hasła, które zostało ustawione wcześniej i zapisane na serwerze.

setNotificationSettingsValue($a)
return $this

$a → Powiadomienie poprzez SMS - konfiguracja. Użyj obiektu \Kei\Webas\Dedicated\EmailAccount\NotificationSettings

getNotificationSettingsValue()
return NotificationSettings

Zwraca aktualną konfigurację powiadomień SMS w postaci obiektu \Kei\Webas\Dedicated\EmailAccount\NotificationSettings

setSmsNotificationValue1($a)
return $this

$a → Powiadomienie poprzez SMS - pierwszy adresat. Użyj obiektu \Kei\Webas\Dedicated\EmailAccount\SmsNotification

getSmsNotificationValue1()
return SmsNotification

Zwraca aktualną konfigurację pierwszego adresata powiadomień SMS w postaci obiektu \Kei\Webas\Dedicated\EmailAccount\SmsNotification

setSmsNotificationValue2($a)
return $this

$a → Powiadomienie poprzez SMS - drugi adresat. Użyj obiektu \Kei\Webas\Dedicated\EmailAccount\SmsNotification

getSmsNotificationValue2()
return SmsNotification

Zwraca aktualną konfigurację drugiego adresata powiadomień SMS w postaci obiektu \Kei\Webas\Dedicated\EmailAccount\SmsNotification

setAutoresponderValue($a)
return $this

$a → Konfiguracja auto-odpowiedzi. Użyj obiektu \Kei\Webas\Dedicated\EmailAccount\AutoresponderService

getAutoresponderValue()
return mixed

Zwraca aktualną konfigurację auto-odpowiedzi w postaci obiektu \Kei\Webas\Dedicated\EmailAccount\AutoresponderService

*execute()
return AddMany

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

// Dodanie konta pocztowego bez ustawionego profilu - domyślne ustawienia panelu Webas
$webas->EmailAccount()->AddMany(["acc1.example.pl", "acc2.example.pl"], 'addedmany1', "8k55HFBz6A")->execute();

// Dodanie wielu kont pocztowych z wykrozystaniem profilu 'abc'
$profile = \Kei\Webas\Dedicated\EmailAccount\Profile::load("abc");
$webas->EmailAccount()->AddMany(["acc1.example.pl", "acc2.example.pl"], 'addedmany1', "8k55HFBz6A", "opis", $profile)->execute();

Klasa AddMany · NiceAPI dla PHP 5.6