Konfiguracja smailera
Konfiguracja składowana jest w pliku w formacie YAML. Każda obsługiwana instancja bazy SOWY posiada własny plik konfiguracyjny YAML, którego część dotyczy konfiguracji smailera. Plik ten znajduje się w indywidualnym podkatalogu konkretnej bazy SOWY:
W przypadku systemu SOWA1: /home/sowa/sowa1/katalogi/nazwa_bazy/etc/config.yml
W przypadku systemu SOWA2: /home/sowa/sowa2/katalogi/nazwa_bazy/etc/config.yml
W przypadku systemu SOWASQL: /home/sowa/sowa_sql/katalogi/nazwa_bazy/etc/config.yml
Gdzie nazwa_bazy to nazwa konkretnej bazy SOWY, np. gniezno_mbp_ks.
Struktura konfiguracji dla smailera wygląda następująco:
---
services:
smailer: enabled
# w tym mapowaniu mogą wystąpić także informacje o innych realizowanych usługach
smailer:
config:
atrybut_ogolny_1: wartość atrybutu ogólnego 1
atrybut_smtp_1: wartość atrybutu SMTP 1
atrybut_smtp_2: wartość atrybutu SMTP 2
spool:
atrybut_spool_1: wartość atrybutu kolejki 1
senders:
powiadomienia@adres.biblioteki.pl:
atrybut_smtp_3: wartość atrybutu SMTP 3
atrybut_smtp_1: wartość atrybutu SMTP 1
filia1@adres.biblioteki.pl
atrybut_smtp_3: wartość atrybutu SMTP 3
W mapowaniu "senders" kolejnymi kluczami są adresy kont mailowych. Pełna konfiguracja serwera SMTP dla wysyłki poczty dla danego konta mailowego powstaje w wyniku połączenia wszystkich atrybutów SMTP z "config" z atrybutami przypisanymi do tego konta, przy czym jeśli ten sam atrybut występuje w obu miejscach, wówczas pierwszeństwo ma atrybut przypisany do konta. Atrybuty ogólne dotyczą wszystkich skonfigurowanych w pliku kont mailowych.
Atrybuty ogólne
Atrybuty ogólne służą do sterowania działaniem narzędzia, zwykle nie ma konieczności ich ustawiania.
| Opcja | Opis | Wyjaśnienia |
|---|---|---|
| testing | Adres email, na który wysyłane są wszystkie maile | Jeśli ustawione - wówczas maile zamiast do adresatów będą przesyłane na podany w tej opcji adres e-mail. Służy do testowania i instalacji deweloperskich. |
| purge | Czyszczenie kolejki po wykonaniu akcji | Ma znaczenie dla opcji testing, która domyślnie zostawia pliki maili w kolejce. Aby się ich pozbyć, trzeba włączyć opcję purge (np. ustawić jej wartość na 1) |
| timeout | Czas oczekiwania na serwer SMTP (w sekundach) | Domyślnie jest to 10 sekund, ale niektóre serwery SMTP dość długo zestawiają połączenie. Może zajść konieczność zwiększenia czasu oczekiwania. |
| log_level | Poziom logowania błędów | Domyślna jest wartość "info". Dostępne sa ponadto opcje: "error" (tylko komunikaty o błędach), "debug" (szczegółowe komunikaty komunikacji z serwerem SMTP) |
Atrybuty konfiguracji kolejek
Pozwalają na sterowanie obsługą kolejki maili. Ustawia się je zawsze w drzewie konfiguracji pod smailer:config:spool
| Opcja | Opis | Wyjaśnienia |
|---|---|---|
| deferred_retry_time | Czas w sekundach, po jakim ponawiana jest próba wysyłki | W razie niepowodzenia przy wysyłaniu maila jest on odkładany do kolejki defer. Opcja ta pozwala określić jak często ponawiana jest próba wysyłki takich maili. Domyślnie jest to godzina (3600 sekund). |
| deferred_retry_count | Liczba prób wysyłki maila | Określa ile razy smailer podejmuje próbę wysyłki maila z kolejki defer. Domyślnie jest to 100. |
| sent_drop_keep_time | Czas w godzinach, po jakim maile wysłane/odrzucone są kasowane | Wysłane lub odrzucone maile są składowane w kolejkach send i drop. Opcja ta pozwala określić czas (w godzinach), po jakim pliki wysłanych lub odrzuconych maili są usuwane z dysku. Domyślnie 168 godzin (tydzień) |
| max_messages_per_session | Maksymalna liczba maili wysłanych w ramach jednej sesji z serwerem | Jest to istotne ustawienie zwłaszcza w przypadku wysyłki mali z monitami, które są generowane w nocy i może być ich jednorazowo nawet kilka setek. Dzięki tej opcji w ramach jednej sesji z serwerem SMTP wysyłanych jest tylko określona liczba (domyślnie 20) maili. Po czym połączenie jest zamykane i otwierane na nowo. |
| sms_morning_hour | Godzina, po której wysyłane są SMSy | Obie te opcje służą do ograniczenia czasu w ciągu dnia, kiedy możliwe jest wysyłanie SMSów. Z oczywistych względów domyślne ustawienia pomijają godziny nocne. Wysyłka domyślnie jest dostępna między godziną 8 a 22. SMSy nadane poza tymi godzinami oczekują w kolejce na wysłanie. |
| sms_evening_hour | Godzina, do której wysyłane są SMSy |
Atrybuty SMTP
Konfigurują parametry wysyłki dla konkretnego konta mailowego (gdy umieszczone są pod smailer:senders:(adres konta)), lub wszystkich kont (gdy umieszczone są pod smailer:config)
| Opcja | Opis | Wyjaśnienie |
|---|---|---|
| name | Nazwa nadawcy | Określa nazwę opisową nadawcy. Wartość ta będzie wyświetlana w e-mailu w polu nadawcy [domyślnie: adres e-mail] |
| smtp | Adres serwera SMTP | Jest to adres serwera służącego do wysyłki poczty. Ważne: nie mylić tego adresu z adresem do obierania poczty (czyli POP lub IMAP). |
| port | Numer portu serwera SMTP | Port, na którym działa serwer SMTP. Domyślnie przyjmowane jest 25, ale dla większości serwerów z szyfrowaniem jest to inny port (465 dla SSL lub 587 dla TLS) i należy to wskazać. |
| auth | Rodzaj autoryzacji | Metoda autoryzacji w serwerze, dostępne są Login (standardowa metoda na większości serwerów) oraz NTML (dla serwerów MS Exchange). Wartość Failsafe stosowana jest w przypadku serwerów nie przyjmujących wartości Login. [domyślnie: Login] |
| crypt | Sposób szyfrowania transmisji | Metoda szyfrowania transmisji, dostępne są Plain (brak szyfrowania), SSL oraz TLS [domyślnie: Plain] |
| login | Nazwa użytkownika | O ile do konta trzeba się logować - tutaj jest podawany jego login. Często jest on tożsamy z adresem e-mail. |
| passwd | Hasło użytkownika | O ile do konta trzeba się logować - tutaj jest podawane hasło. |
| reply_to | Adres do odpowiedzi zwrotnych | Adres e-mail, który będzie się pojawiać u odbiorcy maila, jako adres, na który należy kierować odpowiedzi lub zwroty |
| cc | Adres "do wiadomości" | Spowoduje, że każdy wysyłany mail będzie dodatkowo wysłany do wiadomości na podany adres email (zostanie on dodany do nagłówka CC wysyłanego maila). Informacja ta będzie widoczna dla odbiorcy maila. |
| bcc | Adres "ukryte do wiadomości" | Spowoduje, że każdy wysyłany mail będzie dodatkowo wysłany do wiadomości na podany adres email (zostanie on dodany do nagłówka BCC wysyłanego maila). Informacja ta będzie ukryta przed odbiorcą maila. |
| sms_gate | Parametry bramki SMS | Zestaw opcji konfigurujących wysyłkę wiadomości SMS przez konkretne API usługodawcy bramki SMS. Obecnie obsługiwana jest bramka SMSAPI. Opcje podaje się w postaci mapowania: api: SMSAPI |
Przykładowa konfiguracja
---
services:
smailer: enabled
smailer:
config:
smtp: smtp.mail.com
crypt: TLS
port: 587
auth: Login
timeout: 30
senders:
biblioteka@biblioteka.miasto.pl:
name: 'Biblioteka Miejska im. Patrona'
login: biblioteka
passwd: xyzABC123
filia1@biblioteka.miasto.pl:
name: 'Filia nr 1 Bilbioteki Miejskiej im. Patrona'
login: filia1
passwd: zyxCBA321