Klasa Identity

namespace Kei\Webas\Dedicated\EmailMailinglist

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

Klasa implementuje interfejs DumperInterface


Charakterystyka

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

__construct($a, $b, $c)
return Identity

Konstruktor dzięki, któremu utworzysz obiekt z domyślną konfiguracją identyfikacji listy mailingowej - adekwatnie do domyślnych ustawień panelu Webas.
$a → Twoja nazwa listy. Część adresu e-mail listy do znaku @. Np. dla listy news@tld.pl proszę wpisać: news
$b → Domena pod jaką ma zostać utworzona lista
$c → Dodatkowy opis listy, który będzie dodawany do adresu listy jako nadawcy (nagłówek From). Np. dla listy news@tld.pl można wpisać: Biuletyn Informacyjny. Domyślnie null

::Factory()
return Identity

Statyczna metoda zwracająca instancję klasy. Wzorzec projektowy Fabryka.
$a → Twoja nazwa listy. Część adresu e-mail listy do znaku @. Np. dla listy news@tld.pl proszę wpisać: news
$b → Domena pod jaką ma zostać utworzona lista
$c → Dodatkowy opis listy, który będzie dodawany do adresu listy jako nadawcy (nagłówek From). Np. dla listy news@tld.pl można wpisać: Biuletyn Informacyjny. Domyślnie null

setName($a)
return $this

$a → Twoja nazwa listy. Część adresu e-mail listy do znaku @. Np. dla listy news@tld.pl proszę wpisać: news

getName()
return string

Zwraca nazwę listy mailingowej.

setDomain($a)
return $this

$a → Domena pod jaką ma zostać utworzona lista

getDomain()
return string

Zwraca domenę listy mailingowej

setDescription($a)
return $this

$a → Dodatkowy opis listy, który będzie dodawany do adresu listy jako nadawcy (nagłówek From). Np. dla listy news@tld.pl można wpisać: Biuletyn Informacyjny.

getDescription()
return int

Zwraca opis listy mailingowej.

*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 Identity, który nadpisze nazwę zaq12wsx na moja_lista
$identity = \Kei\Webas\Dedicated\EmailMailinglist\Identity::Factory("moja_lista", "example.pl");

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

Klasa Identity · NiceAPI dla PHP 5.6