Klasa Remove

namespace Kei\Webas\Dedicated\EmailMailinglist

Klasa służy do usunięcia jednego lub większej ilości list mailingowych.

Klasa dziedziczy bezpośrednio z obiektu AbstractActionResult.


Dostępne metody klasy

__construct($names)

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

  • $names (string|array) - Podaj jeden lub większą ilość (jako tablicę) list mailingowych. Nazwy powinny być pełnymi adresami e-mail.

*execute()
return Remove

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

// Usunięcie list mailingowych
$webas->EmailMailinglist()->
    Remove(["zaq12wsx@example.pl"])->
execute();

Klasa Remove · NiceAPI dla PHP 5.6