Przejdź do treści
Intum

Skrzynki e-mail

Aktualizacja: • 2 min czytania

Przejdź do sekcji

  1. Czym jest skrzynka e-mail?
  2. Tworzenie skrzynki
  3. Konfiguracja SMTP
  4. Weryfikacja
  5. Autoresponder
  6. Ograniczenie nadawców
  7. Skrzynka prywatna
  8. Ważne informacje

Endpointy

Metoda Ścieżka Opis
GET /mail/mailboxes.json Lista skrzynek
GET /mail/mailboxes/:id.json Pojedyncza skrzynka
POST /mail/mailboxes.json Utworzenie skrzynki
PATCH /mail/mailboxes/:id.json Aktualizacja skrzynki
DELETE /mail/mailboxes/:id.json Usunięcie skrzynki

Autoryzacja: Authorization: Bearer TOKEN (uprawnienie: mail)

Pola skrzynki

Pole Typ Wymagane Opis
name string tak Nazwa skrzynki
email string tak Adres e-mail
description string nie Opis
active boolean nie Czy aktywna
private boolean nie Czy prywatna (wymaga uprawnień admin)
footer string nie Stopka HTML
responsible_id integer nie ID odpowiedzialnego
responsible_type string nie Typ: Account::UserSetting, Account::Group, Organize::Team
department_id integer nie ID działu
smtp_kind string nie Dostawca: sendgrid, emaillabs, own
smtp_address string nie Adres serwera SMTP
smtp_port integer nie Port SMTP
smtp_username string nie Login SMTP
smtp_password string nie Hasło SMTP
smtp_ssl boolean nie SSL
use_autoresponse boolean nie Włącz autoresponder
autoresponse_subject string warunkowo Temat autoodpowiedzi (wymagany gdy autoresponder włączony)
autoresponse_content string warunkowo Treść autoodpowiedzi
select_senders boolean nie Ogranicz nadawców
sender_ids array nie ID dozwolonych nadawców

Tworzenie skrzynki

POST /mail/mailboxes.json
Authorization: Bearer TOKEN

{
  "mailbox": {
    "name": "Biuro",
    "email": "biuro@firma.pl",
    "footer": "<p>Pozdrawiamy, Zespół Firma</p>",
    "smtp_kind": "sendgrid",
    "smtp_username": "apikey",
    "smtp_password": "SG.xxx"
  }
}

Dodatkowe endpointy

Metoda Ścieżka Opis
GET /mail/my_mailboxes.json Skrzynki bieżącego użytkownika
POST /mail/mailboxes/turn_on_autoresponders Włącz autoresponder we wszystkich skrzynkach
POST /mail/mailboxes/turn_off_autoresponders Wyłącz autoresponder we wszystkich skrzynkach

Błędy (422)

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