lms-notify.php umożliwia komunikację z klientami na wiele sposobów wyzwalaną różnymi zdarzeniami. Skrypt jest wielofunkcyjny - włączenie określonego zadania następuje poprzez określenie parametrem uruchomieniowym skryptu typów zadań. Do wysyłania poczty i sms-ów używane są standardowe mechanizmy dostępne w LMS.
W treści i temacie wiadomości można używać następujących zmiennych:
Przykład 4-2. Lms-notify.php: Przykład szablonu
UWAGA! Ta wiadomość została wygenerowana automatycznie. Uprzejmie informujemy iż na Pani/Pana koncie figuruje zaległość w opłatach za internet w wysokości %B zł. Jeżeli porozumieli się już Państwo z administratorami w kwestii opłaty za bieżący miesiąc czyli %date-m %date-y roku, prosimy o zignorowanie tej wiadomości. W wypadku gdy uważają Państwo iż zaległość ta jest nieporozumieniem prosimy o jak najszybszy kontakt. Wszelkie informacje na temat Państwa rozliczeń mogą Państwo znaleźć pod adresem http://www.naszasiec.pl/mojekonto/ Jeżeli chcieliby Państwo uregulować zaległości prosimy o kontakt: Dział Rozliczeń ASK NaszaSiec Gwidon Mniejważny telefon: 0-606666666 e-mail: gwidonm@naszasiec.pl -- Amatorska Sieć Komputerowa NaszaSiec http://www.naszasiec.pl/
Poniżej parametry uruchomieniowe charakterystyczne dla skryptu lms-notify.php:
Konfigurację konta SMTP oraz backendu SMS określamy standardowymi sekcjami konfiguracyjnymi LMS, tj. odpowiednio mail i sms. Wszystkie ustawienia składają się z dwóch członów oddzielonych znakiem podkreślenia („_”):
Przykład: ustawienie wiadomości używanej przy powiadomieniach o wystawieniu faktur będzie miało postać invoices_message.
Poniżej opisano obsługiwane ustawienia w postaci drugiego członu nazwy ustawienia).
| Nazwa | Opis | Wartość domyślna | Przykład |
|---|---|---|---|
| limit | Limit salda klienta wyzwalający powiadomienia | 0 | debtors_limit=-50 |
| message | Treść wiadomości z powiadomieniem | … notification | invoices_message=Powiadomienie |
| subject | Temat wiadomości z powiadomieniem | … notification | reminder_subject=to jest temat listu |
| days | Liczba dni wyzwalająca powiadomienia, np. dla contracts liczba dni od dnia dzisiejszego za które upływa ważność zobowiązania klienta o najpóźniejsze dacie obowiązywania do | 0 | contracts_days=31 |
| file | Nazwa pliku do której zapisywane są reguły z adresami IP (ma zastosowanie dla kanału powiadomień www) | /etc/rc.d/messages.sh | messages_file=/etc/rc.d/rc.messages.sh |
| header | Wiersz nagłówka pliku w którym są zapisywane reguły z adresami IP (ma zastosowanie dla kanału powiadomień www) | #!/bin/bash\n\nipset flush $type\n | messages_header=#!/bin/bash\n\nPATH=„/bin:/sbin:/usr/bin:/usr/sbin”\n\nipset create messages_tmp hash:net\n„ |
| rule | Reguła z adresem IP - symbol specjalny %i za który podstawiany jest adres IP komputera klienckiego (ma zastosowanie dla kanału powiadomień www) | ipset add … %i\n | messages_rule=ipset add messages_tmp %i\n |
| footer | (ma zastosowanie dla kanału powiadomień www) | pusty | messages_footer=ipset swap messages_tmp messages\nipset destroy messages_tmp\n |
Poniżej przedstawiono ustawienia niezależne od typu powiadomienia.
| Nazwa | Opis | Wartość domyślna | Przykład |
|---|---|---|---|
| mailfrom (wymagana dla kanału mail) | Adres e-mail z którego zostanie wysłany e-mail. Proszę pamiętać, że na niektórych MTA (np. exim) konto to musi istnieć w systemie. | pusta | mailfrom=info@firma.pl |
| mailfname (opcjonalny) | Nazwa nadawcy maila. | pusta | mailfname=Administratorzy |
| smtp_host (opcjonalny) | Serwer SMTP, przez który ma zostać wysłana wiadomość. | pusty | smtp_host=smtp.firma.pl |
| smtp_port (opcjonalny) | Port serwera SMTP | pusty | smtp_port = 25 |
| smtp_auth (opcjonalny) | Sposób autoryzacji. Dozwolone wartości: LOGIN, PLAIN, CRAM-MD5, NTLM. | pusta | smtp_auth=PLAIN |
| smtp_user (opcjonalny) | Login do autoryzacji SMTP. | pusty | smtp_user=admin |
| smtp_pass (opcjonalny) | Hasło do konta zdefiniowanego w opcji smtp_user. | puste | smtp_pass=password |
| debug_email (opcjonalny) | Adres e-mail do debugowania. Gdy ustawiony, cała poczta zostaje wysłana na dany email zamiast do klientów. Przydatne do debugowania i sprawdzania czy wszystko działa OK. | nie ustawiony | debug_email=user@firma.pl |
| service (opcjonalny) | Nazwa backendu sms, który ma być używany do wysyłki sms-ów | pusty | service=smstools |
| debug_phone (opcjonalny) | Numer telefonu na który mają być wysyłane wszystkie sms-y (zamiast do klientów) | pusty | debug_phone=666666666 |
Uwaga! Brak ustawień smtp_… powoduje użycie ustawień z sekcji konfiguracyjnej mail.
Brak ustawienia service powoduje wysyłkę sms-ów w oparciu o domyślny backend sms-owy określony w sekcji konfiguracyjnej sms.