Klasa Edit

namespace Kei\Webas\Dedicated\EmailAccount

Klasa służy do edycji podanego konta pocztowego analogicznie jak w panelu Webas pod adresem https://webas12345.tld.pl/EmailAccount/Edit/domena.pl/nazwa-konta.

Klasa dziedziczy bezpośrednio z obiektu AbstractActionResult.

Dostępne metody klasy

__construct($a, $b)	Konstruktor dzięki któremu utworzysz nowy obiekt klasy. $a → Nazwa konta do edycji $b → Domena konta pocztowego
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
setName($a) return $this	$a → Nazwa konta pocztowego
getName() return string	Zwraca nazwę konta pocztowego
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 Edit*	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...

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

Klasa Edit

namespace Kei\Webas\Dedicated\EmailAccount

Dostępne metody klasy

__construct($a, $b)

setKeepMail($a)

return $this

getKeepMail()

return bool

setForwards($a)

return $this

getForwards()

return Array

setForwardLimit($a)

return $this

getForwardLimit()

return int

setAliasesLimit($a)

return $this

getAliasesLimit()

return int

setAliases($a)

return $this

getAliases()

return Array

setDescription($a)

return $this

getDescription()

return string

setDomain($a)

return $this

getDomain()

return string

setName($a)

return $this

getName()

return string

setPassword($a)

return $this

getPassword()

return string|null

setProfile($a)

return $this

getProfile()

return Profile

setExpirationDate($a)

return $this

getExpirationDate()

return string

setNotificationSettingsValue($a)

return $this

getNotificationSettingsValue()

return NotificationSettings

setSmsNotificationValue1($a)

return $this

getSmsNotificationValue1()

return SmsNotification

setSmsNotificationValue2($a)

return $this

getSmsNotificationValue2()

return SmsNotification

setAutoresponderValue($a)

return $this

getAutoresponderValue()

return mixed

*execute()

return Edit

*getActionResult()

return bool

Wyjątki

Przykłady wykorzystania

Newsletter NiceAPI

Produkt

Wsparcie

Kontakt

Dołącz do nas

Menu