Klasa Edit

namespace Kei\Webas\Dedicated\EmailMailinglist

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

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 zapisanej listy
  • $b → Domena edytowanej listy mailingowej np. example.pl

setIdentityValue($a)
return $this

$a → Dane indentyfikacyjne tworzonej listy mailingowej. Użyj instancji klasy \Kei\Webas\Dedicated\EmailMailinglist\Identity.

getIdentityValue()
return Identity

Dane indentyfikacyjne tworzonej listy mailingowej.

setParametersValue($a)
return $this

$a → Parametry konfigurujące listę mailingową. Użyj instancji klasy \Kei\Webas\Dedicated\EmailMailinglist\Parameters.

getParametersValue()
return Parameters

Parametry konfigurujące listę mailingową.

setEditressesValue($a)
return $this

$a → Konfiguracja listy subskrybentów (zapisanych do otrzymywania powiadomień). Użyj instancji klasy \Kei\Webas\Dedicated\EmailMailinglist\Editresses.

getEditressesValue()
return Editresses

Zwraca listy subskrybentów (zapisanych do otrzymywania powiadomień).

setTemplatesValue($a)
return $this

$a → Kształt i treść szablonów reakcji na zdarzenia. Użyj instancji klasy \Kei\Webas\Dedicated\EmailMailinglist\Templates.

getTemplatesValue()
return Editresses

Zwraca obiekt opisujący kształt i treść szablonów reakcji na zdarzenia.

*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 listy mailingowej
$eml = $webas->EmailMailinglist()->
    Edit("zaq12wsx", "example.pl")->
        setAddressesValue(\Kei\Webas\Dedicated\EmailMailinglist\Addresses::Factory()->
            setAccountsList(["lorem@wp.pl", "loremlipsum@example.pl"]))->
        setTemplatesValue($eml->getTemplatesValue()->
            setSubscribeMailSubject("zzssdd"))->
    execute();

Klasa Edit · NiceAPI dla PHP 5.6