Szablony wiadomości email

System eDokumenty - od wersji 3.6.22 - posiada mechanizm umożliwiający tworzenie szablonów HTML dla wysyłanych wiadomości email.

Jak to działa

Mechanizm szablonów dla wiadomości email funkcjonuje w oparciu o bibliotekę Flexy. Umożliwia on wykorzystanie podczas tworzenia wiadomości wybranego, przygotowanego wcześniej szablonu - przypisanego do danego konta pocztowego (domyślnie), bądź wybranego ręcznie na formularzu wiadomości email. Szablon to w zasadzie plik HTML/Flexy zawierający dowolne elementy (np. tabele, obrazki), style (np. tło, rodzaj i wielkość czcionki, itd.) oraz predefiniowane zmienne.

Jeśli podczas tworzenia wiadomości, na formularzu dokonana zostanie zmiana konta, z którego wiadomość zostanie wysłana, bądź bezpośrednio wybrany zostanie jeden z dostępnych szablonów, treść wiadomości zostanie przeładowana z zastosowaniem właściwego szablonu zachowując prawidłową stopkę, cytowaną wiadomość (np. dla odpowiedzi, podczas przekazywania wiadomości), oraz wprowadzoną treść.

Tworzenie nowego szablonu

Wszystkie pliki z szablonami dla wiadomości email powinny mieć rozszerzenie .tpl i znajdować się w katalogu public_html/apps/edokumenty/var/tpl/emails/.

W systemie eDokumenty szablony są identyfikowane nazwami plików z obciętym rozszerzeniem (np. plik nowy_szablon.tpl będzie wyświetlany na liście wyboru szablonu pod nazwą nowy_szablon).

Szablony są parsowane przez silnik Flexy (więcej o Flexy przeczytasz tutaj), a ich wynikowa zawartość traktowana jest jako HTML.

W szablonach można wykorzystywać także predefiniowane zmienne, których wartość jest generowana automatycznie w zależności od kontekstu użycia szablonu:

text - treść wiadomości wprowadzona przez użytkownika

footer - stopka wiadomości, właściwa dla danego konta, bądź użytkownika jeśli stopka dla konta nie została określona

quoted - treść cytowanej wiadomości wraz z nagłówkiem - w przypadku tworzenia odpowiedzi lub przekazywania wiadomości

W każdej wersji systemu eDokumenty instalowany jest domyślnie wykorzystywany szablon o nazwie default. Nie jest zalecana jakakolwiek modyfikacja tego pliku, ani jego usuwanie. Domyślny szablon jest używany w przypadku braku możliwości użycia szablonu oczekiwanego w danym kontekście (np. brak właściwego pliku, brak uprawnień do pliku). Zmiany powinny być wprowadzane na zasadzie dodawania nowych szablonów. Możliwe jest wskazanie innego szablonu domyślnego poprzez modufikację stałej EMAIL_DEFAULT_TEMPLATE w pliku konfiguracyjnym config.inc:

define('EMAIL_DEFAULT_TEMPLATE', 'default');

Linkowanie grafiki

W szablonie można oczywiście umieszczać elementy graficzne (tag IMG) bądź też określać w definicji stylów obrazy wykorzystywane jako tło. Należy jednak pamiętać, że elementy te muszą być linkowane jako zasoby zewnętrzne, tzn. nie przesyłane wraz z wiadomością. Grafikę najczęściej publikuje się na serwerze obsługującym witrynę internetową.

Wykorzystanie szablonu w korespondencji

Domyślnie dla

Przykładowy szablon Flexy

Mechanizm szablonów dla wiadomości email działa w oparciu o bibliotekę Flexy.

W szablonach można skorzystać z trzech parametrów:

• text : właściwa treść wiadomości
• footer : stopka wiadomości (przechowywana jak do tej pory)
• quoted : treść cytowana (np. treść poprzedniej wiadomości na akcji Odpowiedz, lub treść oryginalnej wiadomości na akcji Przekaż)

Wdrożenie:

1. Obrazki używane w szablonach należy udostępnić w sieci (np. wrzucić na serwer www).
2. W szablonach należy poprawić ścieżki w tagach IMG (tymczasowo grafika do szablonów umieszczona jest na naszym serwerze betasoft.pl)
3. Szablony należy skopiować do katalogu public_html/apps/edokumenty/var/tpl/emails/
4. Na koniec, w konfiguracji kont należy wybrać na pierwszej zakładce odpowiedni szablon z listy.