WebToDate/Rozesílání e-mailem/Reference: Porovnání verzí

Z WebToDate
Skočit na navigaciSkočit na vyhledávání
 
(Nejsou zobrazeny 2 mezilehlé verze od stejného uživatele.)
Řádek 74: Řádek 74:
</code>
</code>


====Zápis registrace====
=====Zápis registrace=====
Po zápisu registrace, ať už se jedná o registraci z formuláře umístěného na nějaké staticky generované stránce nebo ze stránky ''/scripts/modules/mailinglist/list.php'', je třeba uživateli zobrazit nějakou stránku potvrzující přijetí této registrace. Tato stránka se definuje v nastavení '''Zápis registrace'''.
Po zápisu registrace, ať už se jedná o registraci z formuláře umístěného na nějaké staticky generované stránce nebo ze stránky ''/scripts/modules/mailinglist/list.php'', je třeba uživateli zobrazit nějakou stránku potvrzující přijetí této registrace. Tato stránka se definuje v nastavení '''Zápis registrace'''.


Řádek 91: Řádek 91:
</code>
</code>


 
=====E-maily=====
====E-maily====
Třetí nastavení '''E-maily''' definuje funkce týkající se funkcí pro aktivaci odběru (uživatel obdrží po registraci e-mail, klikem na URL v&nbsp;e-mailu aktivuje registrovaný odběr) a odhlášení z&nbsp;odběru.
Třetí nastavení '''E-maily''' definuje funkce týkající se funkcí pro aktivaci odběru (uživatel obdrží po registraci e-mail, klikem na URL v&nbsp;e-mailu aktivuje registrovaný odběr) a odhlášení z&nbsp;odběru.


Řádek 455: Řádek 454:




V&nbsp;předloze aktivačního e-mailu lze použít klíčová slova <nowiki><!--WTD_MLIST(LIST)--> (název odběru) a <!--WTD_MLIST(ACTURL)--></nowiki> (aktivační URL), v&nbsp;těle e-mailu tak může být např. kód
V&nbsp;předloze aktivačního e-mailu lze použít klíčová slova <nowiki><!--WTD_MLIST(SUBNAME)--> (název odběru) a <!--WTD_MLIST(ACTURL)--></nowiki> (aktivační URL), v&nbsp;těle e-mailu tak může být např. kód


<code>
<code>
  <nowiki>Odběr <!--WTD_MLIST(LIST)--> aktivujete kliknutím na odkaz: <!--WTD_MLIST(ACTURL)-->.</nowiki>
  <nowiki>Odběr <!--WTD_MLIST(SUBNAME)--> aktivujete kliknutím na odkaz: <!--WTD_MLIST(ACTURL)-->.</nowiki>
</code>
</code>


Řádek 466: Řádek 465:


<code>
<code>
  <nowiki><!--WTD_IF(ACTIVATED,"<p>Vaše registrace do newsletteru <!--WTD_MLIST(LIST)--> byla úspěšně aktivována.</p>")--></nowiki>
  <nowiki><!--WTD_IF(ACTIVATED,"<p>Vaše registrace do newsletteru <!--WTD_MLIST(SUBNAME)--> byla úspěšně aktivována.</p>")--></nowiki>
  <nowiki><!--WTD_IF(ERROR,"<p class="wtd-error">Při aktivaci registrace do newsletteru nastala chyba.</p>")--></nowiki>
  <nowiki><!--WTD_IF(ERROR,"<p class="wtd-error">Při aktivaci registrace do newsletteru nastala chyba.</p>")--></nowiki>
</code>
</code>


neboli je funkční klíčové slovo pro název aktivovaného odběru <nowiki><!--WTD_MLIST(LIST)--></nowiki>a podmíněné vkládání kódu podle toho, zda odběr byl aktivován nebo došlo k&nbsp;chybě.
neboli je funkční klíčové slovo pro název aktivovaného odběru <nowiki><!--WTD_MLIST(SUBNAME)--></nowiki>a podmíněné vkládání kódu podle toho, zda odběr byl aktivován nebo došlo k&nbsp;chybě.





Aktuální verze z 20. 10. 2009, 13:52

Administrační rozhraní

Nabídka modulu

Nabídka modulu vypadá následovně:

Nástroje

Jednoduchý odběr
Registrační formulář

Nastavení

Globální
Registrace odběru
Zápis registrace
E-maily

Administrace

Předvolby
Práva
Odběry
Uživatelé
Historie

Data

Odběry
Odeslat
Export


K administrační části modulu mají přístup pouze administrátoři WebToDate s výjimkou funkcí Odběry a Odeslat v sekci Data nabídky, které mohou být zpřístupněny i členům jiných týmů.

Nastavení

V této sekci nabídky lze nastavit vzhled následujících stránek:

Globální nastavení

  1. Registrace odběru – jedná se o samostatnou dynamickou stránku na adrese /scripts/modules/mailinglist/list.php, kde se může nacházet registrační formulář se zaškrtávacími okénky pro volbu odběrů, které chce uživatel dostávat.
  2. Zápis registrace – nastavení definuje, jaká stránka se uživateli zobrazí po tom, co se zaregistroval k nějakým odběrům.
  3. E-maily – nastavují se parametry automaticky odesílaných aktivačních e-mailů a předlohy pro potvrzení aktivace a potvrzení odhlášení odběru.
Registrace odběru

V nastavení Registrace odběru se vybírá předloha pro tuto stránku a styl pro seznam odběrů.

Předloha je zde stránka, na kterou se vloží kód formuláře pro registrace. Generickou podobu tohoto formuláře lze vytvořit jako tělo nového fragmentu pomocí funkce NástrojeRegistrační formulář. Ve formuláři by se mělo nacházet mimo jiné klíčové slovo <!--WTD_MLIST(LIST)-->, které reprezentuje seznam odběrů. Tento seznam je formátován stylem, který se vybírá jako Styl seznamu odběrů v tomto nastavení.

Pro tento styl můžete použít následující kód – změny v HTML jsou samozřejmě možné, je ale třeba zachovat hodnotu atributu name a klíčová slova modulu.

Tělo stylu:

<input type="checkbox" name="mlist[]" value="<!--WTD_MLIST(SUBID)-->" <!--WTD_MLIST(SUBVALUE)-->> <!--WTD_MLIST(SUBNAME)-->

Separátor:

<br />

Zápis registrace

Po zápisu registrace, ať už se jedná o registraci z formuláře umístěného na nějaké staticky generované stránce nebo ze stránky /scripts/modules/mailinglist/list.php, je třeba uživateli zobrazit nějakou stránku potvrzující přijetí této registrace. Tato stránka se definuje v nastavení Zápis registrace.

Možnosti zde jsou:

  • Volající stránka – po zápisu se uživateli zobrazí ta samá stránka, ze která zápis registrace vyvolal
  • Jiná – zobrazí se stránka ve zde zvolené předloze.

Obvyklejší způsob je vytvořit samostatnou stránku, ve které je vložen nějaký potvrzující text. V kódu předlohy může být uvedeno např.

<!--WTD_IF(SUBSCRIBED,"Registrace byla uložena.")-->
<!--WTD_IF(NOTSUBSCRIBED,"Registrace nebyla úspěšná.")-->

E-maily

Třetí nastavení E-maily definuje funkce týkající se funkcí pro aktivaci odběru (uživatel obdrží po registraci e-mail, klikem na URL v e-mailu aktivuje registrovaný odběr) a odhlášení z odběru.

Tato nastavení jsou:

  • E-mail od - e-mailová adresa odesílatele aktivačních e-mailů
  • Předloha pro aktivační e-maily - vybírá se předloha pro tělo aktivačních e-mailů
  • Formát aktivačních e-mailů - volba formátu aktivačních e-mailů text / HTML
  • Předmět aktivačního e-mailu - předmět (subject) aktivačních e-mailů
  • Stránka potvrzení aktivace - předloha pro stránku potvrzující aktivaci odběru
  • Stránka odhlášení z e-mailu - předloha pro stránku potvrzující odhlášení z odběru

Předloha pro aktivační e-maily je předloha pro tělo e-mailu, který se odesílá uživateli ihned po registraci v případě, že je toto v definici odběru, ke kterému se uživatel registruje, zvoleno. V předloze možno použít např. kód

<!--WTD_MLIST(LIST)--> aktivujete kliknutím na odkaz: <!--WTD_MLIST(ACTURL)-->.

který se při odeslání převede v e-mailu na text

Zasílání novinek aktivujete kliknutím na odkaz: http://www.mujserver.cz/scripts/modules/mailinglist/activation.php?userid=49&listid=1&lid=1&code=49252&verif=658448418407.


Stránka potvrzení aktivace je stránka, která se zobrazí po kliku na výše uvedené URL. Možný kód této předlohy je např.

<h3>Potvrzení aktivace</h3>
<!--WTD_IF(ACTIVATED,"<p>Vaše registrace do newsletteru <!--WTD_MLIST(LIST)--> byla úspěšně aktivována.</p>")-->
<!--WTD_IF(ERROR,"<p class="wtd-error">Při aktivaci registrace do newsletteru nastala chyba.</p>")-->


Stránku Stránka odhlášení z e-mailu založte jako předlohu, vhodný kód pro modul zobrazující potvrzení odhlášení je zhruba následující:

<div>
<!--WTD_IF(BADCODE,"CHYBA!<br />Chybné ID nebo registrační kód.")-->
<!--WTD_IF(UNSUBSCRIBED,"Odhlášení proběhlo úspěšně.<br />Váš e-mail byl odhlášen z odběru <!--WTD_MLIST(SUBNAME)-->.")-->
</div>

Nejvhodnější je opět tento kód vložit do těla nějakého fragmentu a fragment vložit na vhodnou oblast na předloze.

Nástroje

Funkce Nástroje obsahuje možnosti generování registračních formulářů jako fragmentů, kde v těle fragmentu je výchozí HTML kód s vhodnými klíčovými slovy, který lze způsobem vyžadovaným grafickým designem prezentace upravit a pak použít pro registrace uživatelů.

Jedná se o následující nástroje:

  • Jednoduchý odběr – vygeneruje formulář obsahující pouze pole pro zadání e-mailu. V hidden polích formuláře jsou uvedeny všechny v databázi aktuálně existující odběry, takže když se tento formulář bez úprav použije, uživatel se pomocí něj zaregistruje ke všem odběrům najednou.
  • Registrační formulář – vygeneruje kód formuláře vhodného pro použití v předloze registrační stránky /scripts/modules/mailinglist/list.php.

Administrace

Předvolby

Ve formuláři Předvolby se nastavuje zejména přihlašovací režim a e-mailová adresa, ze které budou všechny e-maily odesílány. Tento formulář je vhodné nastavit co nejdříve po instalaci modulu.

Všechny předvolby v tomto formuláři jsou:

  • Přihlašovací režim - definuje, kteří návštěvníci webu se mohou registrovat k odběrům
  • E-mail od - e-mailová adresa odesílatele pro rozesílání odběrů
  • Zasílat e-maily na skrytou adresu - pokud je vyplněno, každý e-mail, který modul posílá, má ještě v hlavičce Bcc na uvedenou adresu (s výjimkou funkce Test, kterou se testuje rozeslání odběru na jednu zvolenou testovací adresu)
  • Tvar registračního kódu - součástí zápisu registrace k odběru je generování aktivačních kódů (náhodných unikátních řetězců), které se rovněž zapisují do databáze. Aktivační kód lze vypsat v potvrzovací stránce (klíčové slovo <!--WTD_MLIST(CODE)-->), zároveň je součástí aktivačních URL pro e-maily. Tato volba definuje, v jakém tvaru se tyto řetězce generují.

Možnosti nastavení hodnoty Přihlašovací režim jsou následující:

  • Anonymní uživatelé – registrace jsou povoleny všem anonymním uživatelům. S uživatelskými údaji (konkrétně s e-mailovou adresou) se nijak aktivně nepracuje.
  • Rozpoznávat anonymní uživatele – registrace jsou povoleny všem anonymním uživatelům. S uživatelskými údaji (konkrétně s e-mailovou adresou) se pracuje aktivně. To znamená, že pokud již v nějakém modulu uživatel adresu zadal, je mu předvyplněna (za klíčové slovo <!--WTD_USER(EMAIL)--> v registračním formuláři), naopak když ji zde zadá, je uložena do záznamu anonymního uživatele v databázi.
  • Rozpoznávat registrované uživatele – registrace jsou povoleny pouze registrovaným uživatelům. Pokud je uživatel registrován a registrace je rozpoznána (pomocí cookies), je automaticky přihlášen, jinak je před zápisem registrace přesměrován na přihlašovací stránku modulu Registrace a personalizace.
  • Vyžadovat přihlášení vždy – registrace jsou povoleny pouze registrovaným uživatelům. Je vyžadováno přihlášení k modulu Registrace a personalizace, pokud není (v rámci session) uživatel přihlášen, je přesměrován na přihlašovací stránku.

Poslední dva režimy se v předvolbách zobrazují, jen pokud je modul Registrace a personalizace instalován.


Práva

V nabídce Práva lze zpřístupnit některé funkce modulu i jiným týmům než Administrátoři, toto se nastavuje formou běžnou ve všech modulech. Členové zde nastavených týmů pak mají přístupné v sekci Data nabídky modulu funkce Odběry a Odeslat.


Odběry

V nabídce Odběry se spravuje seznam odběrů. V horní části okna je seznam existujících odběrů, pomocí odkazu Přidat se vyvolá formulář pro přidání nového odběru.

Ve formuláři lze zadat:

  • Název – název jak se zobrazuje ve formuláři pro registrace na stránce /scripts/modules/mailinglist/list.php.
  • Popis – pouze interní údaj, neexistuje pro něj klíčové slovo v prezentační části
  • Jazyk
  • Volbu Zobrazit v seznamu odběrů – ovlivňuje, zda se tento odběr na stránce /scripts/modules/mailinglist/list.php nabízí.
  • Volbu Registrace vyžaduje aktivaci - je-li zaškrtnuto, je požadováno potvrzení registrace z aktivačního e-mailu nebo ruční aktivace z administračního rozhraní modulu
  • Volbu Odesílat aktivační e-mail - je-li zaškrtnuto, odesílá se aktivační e-mail

Odběry lze přidávat vždy, mazat jen pokud k odběru neexistuje žádná registrace. Měnit ve formuláři existující odběr lze vždy, výjimkou je pole Zobrazit v seznamu odběrů, toto nastavení lze zrušit jen v případě, že k danému odběru neexistuje žádná registrace.


Uživatelé

Pomocí nabídky Uživatelé lze zobrazit a prohledávat seznam registrací a tyto registrace případně i měnit. V seznamu uživatelů v pravé horní části okna jsou sloupce s e-mailovými adresami, datem registrace a datem poslední změny registrace. Pomocí odkazu Vyhledat lze tento seznam filtrovat. Možnosti vyhledávání jsou na následujícím otisku obrazovky, možné je i vybrat třídění seznamu.

Klepnutím na e-mailovou adresu nebo telefonní číslo se ve spodním rámci otevírá formulář pro úpravy registrace. V záložce Uživatel lze případně měnit e-mailovou adresu, telefonní číslo a jeho předvolbu a preferovaný formát e-mailu.

V záložce Odběry jsou tři sloupce:

  • Odběry - obsahuje názvy odběrů
  • Registrovaný - vyznačuje, zda je uživatel k odběru registrován
  • Aktivní - vyznačuje, zda je pro uživatele odběr aktivován, tj. zda se na jeho adresu při rozeslání odběru e-maily skutečně odesílají.

Pokud je v definici příslušného odběru volba Registrace vyžaduje aktivaci zaškrtnutá, je po registraci z prezentační části u uživatele u daného odběru zaškrtnuto Registrovaný, ale není zaškrtnuto Aktivní. Je-li volba Registrace vyžaduje aktivaci nezaškrtnutá, jsou ihned po registraci volby Registrovaný a Aktivní zaškrtnuty.

Registrační záznamy lze přidávat, mazat i měnit bez omezení.


Historie

Funkce Historie slouží k procházení historie rozesílání novinek. Při každém spuštění rozeslání se zde vytvoří nový záznam. Tento záznam obsahuje i stav, který je měněn na pozadí rozesílacím procesem. V horní části okna prohlížeče je tato historie seřazená od nejnovější k nejstarším položkám, seznam obsahuje název odběru, datum rozeslání a aktuální stav. Klepnutím na název se ve spodní části okna přechází na podrobnější informace.

Do databáze se ukládají pouze tyto sumární údaje. Pokud chcete zjistit konkrétní seznam adres, na které byly odeslány nějaké e-maily, použijte funkci Protokoly WebToDate.

Data

V této části nabídky modulu lze

  • Nastavit stránky definující rozesílaný obsah pro jednotlivé odběry
  • Spouštět rozesílací proces
  • Exportovat seznamy registrací

Odběry

Pod nabídkou Odběry se zde přímo v menu zobrazuje seznam existujících odběrů. Klepnutím na název odběru se zobrazí formulář pro nastavení stránek rozesílaných na tento odběr.

Nastavuje se zde stránka pro formát text a HTML (alespoň jedna musí být nastavena) a text, který bude generován jako předmět e-mailu. Stránky se vybírají ze stránek ve stromu kategorií, nejedná se tedy o předlohy.


Odeslat

Funkce Odeslat spouští průvodce odesláním daného odběru. V prvním kroku se zobrazí následující formulář.

Nejprve se vybere Seznam uživatelů. Možnosti jsou:

  • Odběr – zde se vybírá konkrétní seznam adres registrovaných (a aktivních) k danému odběru s možností "všichni" tj. uživatelé registrovaní ke všem odběrům
  • Registrovaní – tato možnost umožňuje rozeslat e-maily uživatelům registrovaným v modulu Registrace a personalizace, a to buďto všem, nebo vybrané skupině uživatelů tohoto modulu.
  • Anonymní – e-maily se odešlou na všechny adresy posbírané v rámci fungování všech modulů WebToDate nastavených do režimu práce s uživateli "anonymní s rozpoznáváním".

V druhé volbě Zaslat stránky se vybírá, zda se zasílají stránky pro vybraný odběr (to má smysl pouze v případě, že v poli Seznam uživatelů je vybrán konkrétní odběr) nebo stránky svázané s jiným odběrem (je třeba zvolit pro všechny ostatní volby v poli Seznam uživatelů).

Dále lze zvolit Formát e-mailu. Výchozí volba je podle uživatele, tj. odesílá se formát dle preferencí formátu v registracích, lze ale vynutit všem textový nebo HTML formát.

Pro volbu HTML formátu má smysl poslední volba Vkládat externí objekty do HTML e-mailu. Pokud je toto zvoleno, obrázky se vloží přímo do těla e-maily, v opačném případě se vloží pouze odkazy na obrázky vedoucí na www prezentaci.

Tato funkce nevkládá např. externí CSS styly. Pokud tedy potřebujete v HTML e-mailu využívat CSS styly, vložte definici stylů přímo do šablony stránky.

Po potvrzení se zobrazí druhý krok, ve kterém lze zkontrolovat nastavení a spustit vlastní rozesílání.

Je možné zde změnit předmět e-mailu (přebírá se z nastavení DataOdběry). Pomocí tlačítka Náhled lze zkontrolovat rozesílané stránky. Tlačítko Test zobrazí dialog, ve kterém lze zadat jednu e-mailovou adresu, funkce odešle cílový e-mail na tuto adresu. Tlačítko Spustit rozesílání e-mailů spouští rozesílací proces, stav tohoto procesu si můžete zkontrolovat pomocí funkce AdministraceHistorie.


Export

Pomocí funkce Export lze exportovat vybrané údaje z registrační databáze modulu. Formulář je rozdělen na dvě záložky. První záložka exportního formuláře se nazývá Tabulka. Lze v ní specifikovat:

  • Které sloupce vybrané SQL tabulky se exportují
  • Které záznamy tabulky se exportují
  • V jakém pořadí se exportují

V prvé řadě se ve sloupci Vybrat pomocí zaškrtávacích políček vyznačí sloupce, které se mají exportovat.

Výchozí stav formuláře je takový, že není vybrán žádný sloupec. Přinejmenším je proto třeba použít tlačítko Vše a tím vybrat všechny sloupce tabulky.

Dále lze specifikovat kritéria pro export, v podstatě vyhledávací podmínku, která vybere určitou množinu záznamů tabulky. V příslušném řádku formuláře se ve sloupci Splňující podmínku vybere operátor (tj. např. =, >, < apod.) a ve stejném řádku ve sloupci Vzhledem k se zadá příslušná hodnota. Těchto omezujících podmínek lze zadat několik, ve spodní části formuláře je radiopřepínač specifikující, zda se více zadaných podmínek spojuje logickou spojkou "a zároveň" nebo logickou spojkou "nebo". Operátor LIKE znamená, že zadaný řetězec se vyskytuje kdekoliv v textu. Pokud není zadaná žádná omezující podmínka, exportují se všechny záznamy.

Další možností je specifikovat řazení záznamů do exportovaného souboru. Lze vybrat dva sloupečky, podle kterých se řadí (ve formuláři sloupce Primárně a Sekundárně), v posledním sloupci formuláře lze pak specifikovat, zda se jedná o vzestupné nebo sestupné řazení. Není-li žádné řazení vybráno, záznamy se exportují v pořadí, v jakém se nacházejí v SQL tabulce.

Ve druhé záložce Soubor se specifikuje formát exportovaného souboru, jeho název a volba, zda soubor v případě jeho existence kompletně přepsat nebo připojit data na konec souboru.

Název výstupního souboru zadávejte včetně přípony, vytváří se soubor podle přesně zadaného jména. Pomocí tlačítka Test lze ověřit, zda soubor se zadaným jménem již existuje a export se jej pokusí přepsat nebo takový soubor neexistuje a bude se zakládat nový.

Exportovaný soubor je exportní funkcí uložen do adresáře pro export (wwwroot/data/katalogy/export/).

Zvolit lze jeden z podporovaných formátů exportovaného souboru, poznámky k jednotlivým formátům jsou v následující tabulce.

DBF
Maximální délka názvu sloupce je 10 znaků. Pokud má v SQL databázi daný sloupec název s větší délkou, je název pole v exportovaném souboru oříznut na 10 znaků.
Texty jsou v exportovaném DBF souboru v takovém kódování, v jakém jsou uloženy v SQL databázi.
XML Konvence ohledně pojmenování XML elementů v exportovaném souboru je následující:
  • Název kořenového elementu je stejný jako název exportované datové tabulky (tedy MLISTUSER)
  • Elementy oddělující jednotlivé řádky (původní záznamy v SQL tabulce) se vždy jmenují <row>
  • Elementy pro jednotlivá pole jsou pojmenována stejně jako názvy sloupců v datové tabulce, tedy např. <EMAIL> apod., názvy nemají délkový limit jak je tomu u DBF souborů.
Výstupní kódování je vždy utf-8.
CSV Lze zvolit jako oddělovač polí čárku nebo středník, záznamy jsou vždy odděleny znakem pro konec řádky.
Do exportovaného CSV souboru se ve výchozím nastavení negenerují názvy sloupců, ale pouze vlastní data. V exportním formuláři je ale k dispozici volba umožňující zahrnout názvy sloupců do exportovaného souboru.
Texty jsou v CSV souboru v takovém kódování, v jakém jsou uloženy v SQL databázi.
Data se exportují ve formátu 2005-05-04 11:41:00 (stejně jako v XML formátu).

Veřejné skripty

Prezentační skripty

V adresáři /scripts/modules/mailinglist/ se nacházejí veřejně přístupné prezentační skripty modulu. Jedná se o následující skripty:

Skript Funkce
list.php Skript zobrazuje registrační formulář s možností změn registrací
subscribe.php Skript slouží pro zápisy registrací do databáze
unsubscribe.php Skript slouží pro odhlášení odběru z e-mailu
activation.php Skript slouží k aktivaci daného odběru


Klíčová slova modulu

V následujících tabulkách jsou uvedeny seznamy klíčových slov, která lze používat v předlohách nebo ve WebToDate stylech.

Klíčová slova použitelná v předloze pro registrační stránku list.php
Klíčové slovo Význam Poznámka
<!--WTD_USER(EMAIL)--> E-mailová adresa
<!--WTD_USER(GSM)--> Telefon
<!--WTD_USER(GSM_PREFIX)--> Tel. předvolba
<!--WTD_ MLIST(MAILFORMATTEXT)--> Formát e-mailu text Používá se v kódu

<input type="radio" name="mailformat" value="T" <!--WTD_MLIST(MAILFORMATTEXT)--> > Text

<!--WTD_ MLIST(MAILFORMATHTML)--> Formát e-mailu HTML Používá se v kódu

<input type="radio" name="mailformat" value="H" <!--WTD_MLIST(MAILFORMATHTML)--> > HTML

<!--WTD_MLIST(LIST)--> Seznam odběrů


Seznam odběrů v registračním formuláři zastoupený klíčovým slovem <!--WTD_MLIST(LIST)--> se formátuje jedním zvoleným stylem. Ve stylu se používají klíčová slova uvedená v následující tabulce.

Klíčová slova použitelná v těle stylu pro seznam odběrů v registrační stránce
Klíčové slovo Význam Poznámka
<!--WTD_MLIST(SUBNAME)--> Název odběru
<!--WTD_MLIST(SUBID)--> ID odběru
<!--WTD_MLIST(SUBVALUE)--> Hodnota atributu checked

Příklad těla takového stylu je

<input type="checkbox" name="mlist[]" value="<!--WTD_MLIST(SUBID)-->" <!--WTD_MLIST(SUBVALUE)-->> <!--WTD_MLIST(SUBNAME)-->


V předloze potvrzovací stránky registrace (subscribe.php) lze použít následující konstrukci

<!--WTD_IF(SUBSCRIBED,"Registrace byla uložena.")-->
<!--WTD_IF(NOTSUBSCRIBED,"Registrace nebyla úspěšná.")-->

Dále zde lze použít klíčová slova pro informace o provedené registraci:

<!--WTD_MLIST(GSM)--> - tel.číslo

<!--WTD_MLIST(GSM_PREFIX)--> - předvolba

<!--WTD_MLIST(EMAIL)--> - e-mail

<!--WTD_MLIST(CODE)--> - aktivační kód


V předloze aktivačního e-mailu lze použít klíčová slova <!--WTD_MLIST(SUBNAME)--> (název odběru) a <!--WTD_MLIST(ACTURL)--> (aktivační URL), v těle e-mailu tak může být např. kód

Odběr <!--WTD_MLIST(SUBNAME)--> aktivujete kliknutím na odkaz: <!--WTD_MLIST(ACTURL)-->.


V předloze stránky pro aktivaci (activation.php) lze použít následující konstrukci

<!--WTD_IF(ACTIVATED,"<p>Vaše registrace do newsletteru <!--WTD_MLIST(SUBNAME)--> byla úspěšně aktivována.</p>")-->
<!--WTD_IF(ERROR,"<p class="wtd-error">Při aktivaci registrace do newsletteru nastala chyba.</p>")-->

neboli je funkční klíčové slovo pro název aktivovaného odběru <!--WTD_MLIST(SUBNAME)-->a podmíněné vkládání kódu podle toho, zda odběr byl aktivován nebo došlo k chybě.


V předloze stránky potvrzující odhlášení z e-mailu (unsubscribe.php) lze použít následující konstrukci, které vkládají buď chybové hlášení, nebo potvrzení odhlášení:

<!--WTD_IF(BADCODE,"CHYBA!<br />Chybné ID nebo registrační kód.")-->
<!--WTD_IF(UNSUBSCRIBED,"Odhlášení proběhlo úspěšně.<br />Váš e-mail byl odhlášen z odběru <!--WTD_MLIST(SUBNAME)-->.")-->

Konkrétní texty či HTML kódy je samozřejmě možné měnit dle potřeby.

Dále ve stránce, která se rozesílá, lze vložit následující kód generující odkaz pro odhlášení:

<!--WTD_IF(UNSUBEMAIL,"Odhlásit z tohoto odběru se můžete pomocí stránky: http://www.neco.cz<!--WTD_MLIST(UNSUBURL)--> ")-->

Tento kód je při rozesílání nahrazován pro každého uživatele individuálně odkazem umožňujícím odhlášení (obsahuje volání skriptu unsubscribe.php).

Formulářová pole a další možné parametry prezentačních skriptů

Názvy formulářových polí je třeba přesně dodržet, jinak může být vyhledávací formulář nefunkční.

V názvech polí formulářů se rozlišují malá a velká písmena, zachovejte proto názvy polí vždy přesně tak, jak je příslušný pomocný nástroj vygeneroval.
Parametry skriptu subscribe.php pro zápis registrací
Název pole nebo parametru Význam Poznámka
email E-mail uživatele
gsm Tel. číslo
gsm_prefix Předvolba
mailformat Zvolený preferovaný formát Možné hodnoty jsou "T" pro text a "H" pro HTML
mlist[] Pole id odběrů Je třeba uvést včetně hranatých závorek
locale Zkratka jazyka Výběr jazyka potvrzovací stránky
tmplid ID předlohy ID předlohy potvrzovací stránky (pokud má být jiné než nastavené v předvolbách modulu)

Parametr mlist se ve formuláři použije např. následovně:

<input type="checkbox" name="mlist[]" value="2" >Zahraniční zpravodajství<br />
<input type="checkbox" name="mlist[]" value="3" >Domácí zpravodajství<br />

Pokud chceme použít statický formulář pro registraci k odběru např. z úvodní stránky www prezentace, lze použít cca následující HTML kód (registruje ke dvěma odběrům najednou):

<form action="/scripts/modules/mailinglist/subscribe.php" method="post">
Zasílat newsletter:<br/>
<input type="hidden" name="mlist[]" value="1" />
<input type="hidden" name="mlist[]" value="2" />
<input type="hidden" id="mailformat" name="mailformat" value="H">
<input type="hidden" name="locale" value="CS" />
<input type="text" name="email" /> <input type="submit" name="subscribe" value="Přihlásit" />
</form>

Pokud chceme sbírat GSM čísla k zasílání informací přes SMS, je analogický formulář možno vytvořit následovně:

<form action="/scripts/modules/mailinglist/subscribe.php" method="post">
Novinky přes SMS:<br/>
<input type="hidden" name="mlist[]" value="3" />
<input type="hidden" name="locale" value="CS" />
<input type="text" name="gsm" /> <input type="submit" name="subscribe" value="Přihlásit" />
</form>



Parametry skriptu unsubscribe.php pro odhlášení z odběru
Název pole nebo parametru Význam Poznámka
email E-mail uživatele
list ID odběru
rc Kryptované údaje k ověření platnosti požadavku


Parametry skriptu activation.php pro aktivaci odběru
Název pole nebo parametru Význam Poznámka
userid ID uživatele
listid ID odběru
lid Identifikace jazyka Definuje jazyk potvrzovací stránky
code Aktivační kód
verif Kryptované údaje k ověření platnosti


Skript pro zobrazení registračního formuláře list.php používá jako parametry z URL pouze standardní parametry pro přepínání jazyků locale, lid, dlocale, dlid. Pokud tedy např. vyvoláte URL /scripts/modules/mailinglist/list.php?dlocale=EN, zobrazí se jen seznam odběrů, které mají nastavený jazyk angličtina apod.