Email Template

2022.11.02 — Posted by Webb & Flow


Az email template-ek listáját az Editor / Email Templates menü alatt érjük el:

Itt lehet új template-et létrehozni, illetve meglévőt szerkeszteni.

Az új email template-ek alapértelmezetten EDM típusú levelek, ezt később a szerkesztés oldalon át lehet állítani.

EDM típusú levél

Az EDM típusú leveleket az email listákra feliratkozott profilokkal való kommunikácira lehet használni. Ezeket a leveleket a rendszer küldi az email listákon beállított szabályoknak megfelelően, ezért nem kell API-n keresztül indítani, azonban nem is lehet szabadon paraméterezni, mindig egy meghatározott paraméter listát generál a rendszer, a küldés módjától függően (lásd lentebb). Az email listák szerkesztő felületein, ahol email template-et lehet kiválasztani, kizárólag az EDM típusú template-ek jelennek meg.

Az EDM típusú levelekeket a rendszer általában tömegesen küldi ki, több különböző címzettnek (de mindegyiknek külön, személyre szabott szöveggel).

EDM típusú levelet nem érdemes API-n keresztül küldeni.

System típusú levél

A System típusú levél az EDM ellentettje, amit kifejezetten API-n keresztüli, alkalmankénti küldésre van tervezve. Ezeknek a fő célja valamilyen szoftverből való email küldés, ezért a System levelek küldése az EDM-ektől függetlenül történik.

Ilyen levél lehet például a regisztrációt megerősítő levél, vagy a szoftver valamilyen folyamatának teljesüléséről értesítő üzenet.

A System típusnak van egy speciális Priority System típusa. Ezeknek a kiküldése az EDM és a System levelektől függetlenül történik azért, hogy a lehető leggyorsabban megérkezik a címzetthez.

Priority System típust csak azoknak a leveleknek érdemes választani, amiknek a megérkezése idő kritikus. Ezek tipikusan azok a levelek, amikben valamilyen CTA vagy információ található, ami nélkül a felhasználó nem tud tovább lépni.

Ilyen lehet például:

  • regisztráció validáló link
  • elfelejtett jelszó beállítását indító link
  • belépéshez, vagy más, authentikációhoz kötött művelethez kiküldött, egyszer használatos kód vagy azonosító

Azok a levelek, amikre nincs szüksége a felhasználónak a továbblépéshez, lehetőleg normál System típusúak legyenek.

Ilyenek lehetnek:

  • regisztráció, jelszó csere, belépés, vagy más esemény megtörténtét jelző email
  • notifikációs levelek

Szerkesztés

Az Email Template szerkesztő felület hat részre bontható:

Content

Itt lehet az email tartalmi részét beállítani, azaz a Subject mezőt, a layout-ot, illetve a szöveg törzsét. Az oldalon van egy preview funkció, amivel meg lehet nézni, hogy hogy fog kinézni a levél a küldéskor. Itt lehetőség van a változók értékeinek behelyettesítésére is (teszt adatokkal), amennyiben azokat a Parameters fülön beállítjuk

Amennyiben az email body-t markdown formázással szeretnénk megadni, a Body Type mezőben be kell állítani. Alapértelmezetten a body típusa HTML. Ha be van állítva a MarkDown típus, akkor figyelni kell, hogy a konvertálás még a változók behelyettesítése előtt történik, így biztosan nem okoz problémát, ha egy konstansban, block-ban, vagy paraméterben html szöveg van. Emiatt viszont a konstansoknál és block-oknál szintén be kell külön állítani, ha MarkDown szöveg van bele rakva, a paraméterekben pedig mindenképpen html kódot kell küldeni, amennyiben azt szeretnénk.

Debug

Meg lehet határozni, hogy az adott template-ű levelek végül eljuthatnak-e a címzettnek.

Constants

Azonos, mint a Design Layout constants füle. Amennyiben felveszünk olyan néven egy konstanst, ami a kiválasztott layout-ban is szerepel, felüldefiniáljuk azt.

A Value type mezőben lehet megadni, hogy az értékek MarkDown formában vannak-e. A body-hoz hasonlóan itt is a HTML az alapértelmezett.

Blocks

Azonos, mint a Design Layout blocks füle. Amennyiben felveszünk olyan néven egy blokkot, ami a kiválasztott layout-ban is szerepel, felüldefiniáljuk azt.

A Value type mezőben lehet megadni, hogy az érték MarkDown formában van-e. A body-hoz hasonlóan itt is a HTML az alapértelmezett.

Parameters

Fel lehet sorolni azokat a paramétereket, amiket az email a küldéskor kapni fog, illetve a profil személyes adatait is felvehetjük, amennyiben teszt adatot szeretnénk megadni a preview funkcióhoz. System típusú leveleknél a paraméterhez felvehetünk alapértelmezett értéket is, amit akkor használ a rendszer, ha az email küldéskor az adott paraméter az API híváskor nincs megadva. Amennyiben meg van adva, de üres az értéke, azt az üres értéket fogja figyelembe venni a rendszer.

Settings

Itt lehet beállítani, hogy milyen típusú a levél (EDM vagy System), illetve, hogy mi legyen a kiküldött email ReplyTo mezejének értéke. Amennyiben ez nincs megadva, a projekt default ReplyTo értéke lesz használva, illetve EDM levelek esetén az email listában megadott érték, és annak a hiányában a projekt default értéke.

Kód szintaxis

Az egyes mezőkbe írható kódok működését lásd a Template dokumentációban.