Klasa Parameters

namespace Kei\Webas\VPS\EmailMailinglist

Za jej pomocą stworzysz część konfiguracji listy mailingowej nazwany w panelu Webas jako Parametry

Klasa implementuje interfejs DumperInterface


Charakterystyka

Metody obiektu - zapoznaj się z opisem pod tabelą.

__construct()
return Parameters

Konstruktor dzięki, któremu utworzysz obiekt z domyślną konfiguracją parametrów listy mailingowej

::Factory()
return Parameters

Statyczna metoda zwracająca instancję klasy. Wzorzec projektowy Fabryka.

setParametersType($a)
return $this

$a → Ustawia wartość kto może wysyłać wiadomości na listę. Użyj obiektu \Kei\Webas\VPS\EmailMailinglist\ParametersType.

getParametersType()
return ParametersType

Zwraca wartość podmiotu uprawnionego do wysyłania wiadomości na liste..

setReplyto($a)
return $this

$a → Wskazanie, jaki adres będzie się podpowiadał przy odpowiadaniu na wiadomość z listy (nagłówek Reply-To). Użyj obiektu \Kei\Webas\VPS\EmailMailinglist\ReplyToType.

getReplyto()
return ReplyToType

Zwraca adres podpowiedzi przy odpowiadaniu na wiadomość (nagłówek Reply-To)

setAutosubscribeEnabled($a)
return $this

$a → (true|false) Umożliwienie zapisu na listę dowolnemu użytkownikowi, który wyśle na jej adres wiadomość z tematem SUBSCRIBE.

getAutosubscribeEnabled()
return bool

Zwraca status opcji umozliwiającej zapis na listę dowolnemu użytkownikowi.

*dump()
return Array

Zobacz więcej tutaj DumperInterface

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


Przykłady wykorzystania metod

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

// Nowy obiekty Parameters
$parameters = new \Kei\Webas\VPS\EmailMailinglist\Parameters;
$parameters->setParametersType(\Kei\Webas\VPS\EmailMailinglist\ParametersType::Factory()->setOpenedList());

// Dodanie nowej subskrypcji
$webas->EmailMailinglist()->
    Add("zaq12wsx", "example.pl")->
        setParametersValue($parameters)->
        setAddressesValue(\Kei\Webas\VPS\EmailMailinglist\Addresses::Factory()->
            setAccountsList(["lorem@wp.pl", "loremlipsum@example.pl"]))->
    execute();

Klasa Parameters · NiceAPI dla PHP 5.6