Endpointy
| Metoda | Ścieżka | Opis |
|——–|———|——|
| GET | /mail/emails.json | Lista e-maili |
| GET | /mail/emails/:id.json | Pojedynczy e-mail |
| POST | /mail/emails.json | Wysłanie e-maila |
| PATCH | /mail/emails/:id.json | Aktualizacja e-maila |
| DELETE | /mail/emails/:id.json | Usunięcie e-maila |
Autoryzacja: Authorization: Bearer TOKEN (uprawnienie: mail)
Pola e-maila
| Pole | Typ | Wymagane | Opis |
|——|—–|———-|——|
| subject | string | tak | Temat wiadomości |
| from | string | nie | Adres nadawcy |
| to | string | tak | Adres odbiorcy |
| cc | string | nie | Kopia (Dw) |
| bcc | string | nie | Ukryta kopia (Udw) |
| content | string | tak | Treść wiadomości (HTML) |
| mailbox_id | integer | tak | ID skrzynki pocztowej |
| reply_to | string | nie | Adres do odpowiedzi |
| priority | number | nie | Priorytet (1-5) |
| send_status | string | nie | Status: sent, draft, future |
| template_id | integer | nie | ID szablonu |
| email_id | integer | nie | ID e-maila nadrzędnego (odpowiedź w wątku) |
| tags | array | nie | Tagi |
Wysłanie e-maila
POST /mail/emails.json
Authorization: Bearer TOKEN
{
"email": {
"subject": "Witaj",
"to": "klient@firma.pl",
"content": "<p>Treść wiadomości</p>",
"mailbox_id": 1
}
}
Odpowiedź w wątku
{
"email": {
"subject": "Re: Witaj",
"to": "klient@firma.pl",
"content": "<p>Odpowiedź</p>",
"mailbox_id": 1,
"email_id": 500
}
}
Dodatkowe endpointy
| Metoda | Ścieżka | Opis |
|——–|———|——|
| POST | /mail/emails/:id/add_connected_task.json | Powiąż z zadaniem |
| POST | /mail/emails/:id/remove_connected_task.json | Usuń powiązanie z zadaniem |
| POST | /mail/emails/:id/change_priority.json | Zmień priorytet |
| POST | /mail/emails/:id/snooze.json | Odłóż wątek |
| POST | /mail/emails/:id/archive_and_next.json | Archiwizuj i przejdź dalej |
| POST | /mail/emails/set_as_spam.json | Oznacz jako spam |
| POST | /mail/emails/unspam.json | Cofnij oznaczenie spam |
| POST | /mail/emails/save_draft.json | Zapisz szkic |
| GET | /mail/emails/:id/get_content.json | Pobierz treść e-maila |
| GET | /mail/emails/:id/attachments.json | Lista załączników |
Błędy (422)
{"subject": ["nie może być puste"]}