Klasa WebmailCustomization

namespace Kei\Webas\Dedicated\SettingsPanel

Klasa służy do personalizacji wyglądu i ustawień klienta poczty webmail

Wykorzystywana jest w klasie \Kei\Webas\Dedicated\SettingsPanel\Add

Klasa implementuje interfejs DumperInterface

Dostępne metody klasy

::Factory() return WebmailCustomization	Statyczna metoda zwracająca instancję klasy. Wzorzec projektowy Fabryka.
setWebmailBaseColor($a) return $this	Domyślny motyw kolorystyczny. $a → Użyj enumeratora \Kei\Webas\Dedicated\WebmailColorPaletteEnum
getWebmailBaseColor() return string	Zwraca motyw kolorystyczny panelu poczty
setWebmailCompanyLabel($a) return $this	Adres URL do grafiki z logo firmy. $a → Podaj lokalizację do zewnętrznego żródła pliku obrazu (pamiętaj o https - zob. przykłady)
getWebmailCompanyLabel() return string	Zwraca ustawioną lokalizację pliku z logo firmy
setWebmailCompanyLabelVertical($a) return $this	Adres URL do grafiki z logo firmy (wersja zwinięta). $a → Podaj lokalizację do zewnętrznego żródła pliku obrazu (pamiętaj o https - zob. przykłady)
getWebmailCompanyLabelVertical() return string	Zwraca ustawioną lokalizację pliku z logo firmy w wersji zwiniętej
setWebmailCustomCss($a) return $this	Adres URL do dodatkowego arkusza styli CSS. $a → Podaj lokalizację do zewnętrznego żródła arkusza styli (pamiętaj o https - zob. przykłady)
getWebmailCustomCss() return string	Zwraca ustawioną lokalizację pliku CSS
setWebmailCustomJavascript($a) return $this	Adres URL do dodatkowego pliku javascript. $a → Podaj lokalizację do zewnętrznego żródła pliku javascript (pamiętaj o https - zob. przykłady)
getWebmailCustomJavascript() return string	Zwraca ustawioną lokalizację pliku javascript
setWebmailFavicon($a) return $this	Adres URL do ikony favicon. $a → Podaj lokalizację do zewnętrznego żródła pliku ikony (pamiętaj o https - zob. przykłady)
getWebmailFavicon() return string	Zwraca ustawioną lokalizację pliku ikony
setWebmailSkinLogo($a) return $this	Adres URL do grafiki z głównym logo. $a → Podaj lokalizację do zewnętrznego żródła pliku obrazu (pamiętaj o https - zob. przykłady)
getWebmailSkinLogo() return string	Zwraca ustawioną lokalizację pliku obrazu
setWebmailSkinLogoLoginForm($a) return $this	Adres URL do grafiki z dodatkowym logo. $a → Podaj lokalizację do zewnętrznego żródła pliku obrazu (pamiętaj o https - zob. przykłady)
getWebmailSkinLogoLoginForm() return string	Zwraca ustawioną lokalizację pliku obrazu
setWebmailSupportUrl($a) return $this	Adresu URL do własnej strony z pomocą. $a → Podaj lokalizację do zewnętrznego żródła pomocy (pamiętaj o https - zob. przykłady)
getWebmailSupportUrl() return string	Zwraca ustawioną lokalizację pomocy
setWebmailSystemBanners($a) return $this	Wyświetlaj domyślne logotypy Kei.pl. $a → Użyj enumeratora \Kei\Webas\YesNoEnum
getWebmailSystemBanners() return string	Zwraca informację nt. domyslnych logotypów Kei.pl
setWebmailWatermarkLogo($a) return $this	Adres URL do grafiki ze znakiem wodnym. $a → Podaj lokalizację do zewnętrznego żródła pomocy (pamiętaj o https - zob. przykłady
getWebmailWatermarkLogo() return string	Zwraca lokalizację pliku graficznego
dump() return Array*	Zobacz więcej tutaj DumperInterface

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

// TIPS&TRICKS //
/*
    Podawaj ścieżki do plików (obrazy, css, js) z wykorzystaniem https (o ile masz prawidłowy
    certyfikat), aby uniknąć blokowania niezabezpieczonej treści na zabezpieczonej stronie (WebAs)
*/

// Ustawienia personalizacji panelu Webmail
$webas->SettingsPanel()->
    Edit()->
    setWebmailCustomizationValue(\Kei\Webas\Dedicated\SettingsPanel\WebmailCustomization::Factory()->
        setWebmailSkinLogo('https://example.com/path/logo2.jpg')->
        setWebmailCustomCss('https://example.com/path/main.min.css')->
        setWebmailFavicon('https://example.com/path/favikonka.ico'))->
    execute();

Klasa WebmailCustomization

namespace Kei\Webas\Dedicated\SettingsPanel

Dostępne metody klasy

::Factory()

return WebmailCustomization

setWebmailBaseColor($a)

return $this

getWebmailBaseColor()

return string

setWebmailCompanyLabel($a)

return $this

getWebmailCompanyLabel()

return string

setWebmailCompanyLabelVertical($a)

return $this

getWebmailCompanyLabelVertical()

return string

setWebmailCustomCss($a)

return $this

getWebmailCustomCss()

return string

setWebmailCustomJavascript($a)

return $this

getWebmailCustomJavascript()

return string

setWebmailFavicon($a)

return $this

getWebmailFavicon()

return string

setWebmailSkinLogo($a)

return $this

getWebmailSkinLogo()

return string

setWebmailSkinLogoLoginForm($a)

return $this

getWebmailSkinLogoLoginForm()

return string

setWebmailSupportUrl($a)

return $this

getWebmailSupportUrl()

return string

setWebmailSystemBanners($a)

return $this

getWebmailSystemBanners()

return string

setWebmailWatermarkLogo($a)

return $this

getWebmailWatermarkLogo()

return string

*dump()

return Array

Wyjątki

Przykłady wykorzystania

Newsletter NiceAPI

Produkt

Wsparcie

Kontakt

Dołącz do nas

Menu