Przejdź do treści
Intum

Filtry

Aktualizacja: • 2 min czytania

Przejdź do sekcji

  1. Czym są filtry?
  2. Jak działają filtry
  3. Warunki filtra
  4. Akcje filtra
  5. Tworzenie filtra
  6. Testowanie filtra
  7. Priorytet filtrów
  8. Ważne informacje

Endpointy

Metoda Ścieżka Opis
GET /mail/filters.json Lista filtrów
GET /mail/filters/:id.json Pojedynczy filtr
POST /mail/filters.json Utworzenie filtra
PATCH /mail/filters/:id.json Aktualizacja filtra
DELETE /mail/filters/:id.json Usunięcie filtra

Autoryzacja: Authorization: Bearer TOKEN (uprawnienie: mail)

Pola filtra

Pole Typ Wymagane Opis
name string tak Nazwa filtra
description string nie Opis
active boolean nie Czy aktywny (domyślnie true)
priority number nie Priorytet sprawdzania
condition_email_from string nie Warunek: e-mail nadawcy
condition_domain_from string nie Warunek: domena nadawcy
condition_subject string nie Warunek: temat zawiera
condition_email_to_id integer nie Warunek: ID skrzynki odbiorczej
condition_responsible_id integer nie Warunek: ID odpowiedzialnego
condition_responsible_type string nie Warunek: typ odpowiedzialnego
responsible_to_id integer nie Akcja: ID nowego odpowiedzialnego
responsible_to_type string nie Akcja: typ nowego odpowiedzialnego
forward_to string nie Akcja: przekieruj na adres e-mail
email_priority_to number nie Akcja: nowy priorytet (1-5)

Tworzenie filtra

POST /mail/filters.json
Authorization: Bearer TOKEN

{
  "filter": {
    "name": "VIP klienci",
    "condition_domain_from": "vip-firma.pl",
    "responsible_to_id": 5,
    "responsible_to_type": "Account::UserSetting",
    "email_priority_to": 3
  }
}

Testowanie filtra

POST /mail/filters/:id/run_test_filter.json

Sprawdza istniejące e-maile bez wykonywania akcji.

Błędy (422)

{"name": ["nie może być puste"]}