Przejdź do końca metadanych
Przejdź do początku metadanych

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.

OpcjaOpisWyjaśnienia
testingAdres email, na który wysyłane są wszystkie maileJeś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.
purgeCzyszczenie kolejki po wykonaniu akcjiMa 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)
timeoutCzas 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_levelPoziom logowania błędówDomyś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

OpcjaOpisWyjaśnienia
deferred_retry_timeCzas w sekundach, po jakim ponawiana jest próba wysyłkiW 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_timeCzas w godzinach, po jakim maile wysłane/odrzucone są kasowaneWysł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_sessionMaksymalna liczba maili wysłanych w ramach jednej sesji z serweremJest 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_hourGodzina, po której wysyłane są SMSyObie 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_hourGodzina, 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)

OpcjaOpisWyjaśnienie
nameNazwa nadawcyOkreśla nazwę opisową nadawcy. Wartość ta będzie wyświetlana w e-mailu w polu nadawcy [domyślnie: adres e-mail]
smtpAdres serwera SMTPJest 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).
portNumer portu serwera SMTPPort, 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ć.
authRodzaj autoryzacjiMetoda 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]
cryptSposób szyfrowania transmisjiMetoda szyfrowania transmisji, dostępne są Plain (brak szyfrowania), SSL oraz TLS [domyślnie: Plain]
loginNazwa użytkownikaO ile do konta trzeba się logować - tutaj jest podawany jego login. Często jest on tożsamy z adresem e-mail.
passwdHasło użytkownikaO ile do konta trzeba się logować - tutaj jest podawane hasło.
reply_toAdres do odpowiedzi zwrotnychAdres e-mail, który będzie się pojawiać u odbiorcy maila, jako adres, na który należy kierować odpowiedzi lub zwroty
ccAdres "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.
bccAdres "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_gateParametry 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
login: login w systemie SMSAPI
md5: klucz md5 dostępu do API bramki
pro: 0 - wysyłanie wiadomości anonimowych, 1 - wysyłanie wiadomości zawierającą nazwę nadawcy
from: jeśli 'pro' jest ustawione na 1 - nazwa nadawcy do prezentacji na ekranie odbiorcy SMSa

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
  • No labels