Pobieranie wiadomości mail ze wskazanego folderu. Endpoint odpowiedzialny za pobieranie maili z wybranego folderu w module poczty.

Endpointy obsługujące żądanie:

  • https://api.5ways.com - Ekspert

Uprawnienia:

  • Admin, Ekspert, specjalista, praktykant - GET

Pola zasobu

MailReceivedMysqlMessage

Klucz Typ danych Opis
id string Unikalny identyfikator wiadomości.
mail_server_id string Identyfikator serwera pocztowego.
user_id string Identyfikator użytkownika.
client_id string Identyfikator klienta.
customer_id string Identyfikator instancji.
mail_thread_id string Identyfikator wątku wiadomości.
timestamp string Znacznik czasu wiadomości.
mail_date string Data wiadomości.
mail_address string Adres email nadawcy.
mail_name string Nazwa nadawcy.
receiver_mail_address string Adres email odbiorcy.
cc_receiver_mail_address string Adresy email odbiorców w kopii.
bcc_receiver_mail_address string Adresy email odbiorców w ukrytej kopii.
mail_subject string Temat wiadomości.
mail_body string Treść wiadomości.
has_attachments string Czy wiadomość ma załączniki.
missing_attachments_count string Liczba brakujących załączników.
priority string Priorytet wiadomości.
is_remove string Czy wiadomość jest usunięta.
tags string Tagi wiadomości.
is_read string Czy wiadomość została przeczytana.
msg_unique_identifier string Unikalny identyfikator wiadomości.
api_msg_identifier string Identyfikator wiadomości w API.
in_reply_to_msg_uid string UID wiadomości, na którą jest odpowiedź.
x_gm_thrid string ID wątku Gmail.
mail_sent_mysql_messages_ids array ID powiązanych wysłanych wiadomości.
reference string Referencje wiadomości.
created string Data utworzenia rekordu.
modified string Data modyfikacji rekordu.

MailSentMysqlMessage

Klucz Typ danych Opis
id string Unikalny identyfikator wiadomości.
mail_server_id string Identyfikator serwera pocztowego.
user_id string Identyfikator użytkownika.
client_id string Identyfikator klienta.
customer_id string Identyfikator instancji.
mail_address string Adres email odbiorcy.
cc_mail_addresses array Adresy email odbiorców w kopii.
bcc_mail_addresses array Adresy email odbiorców w ukrytej kopii.
mail_name string Nazwa odbiorcy.
sender_mail_address string Adres email nadawcy.
mail_subject string Temat wiadomości.
mail_body string Treść wiadomości.
priority string Priorytet wiadomości.
tags string Tagi wiadomości.
status string Status wiadomości.
timestamp string Znacznik czasu wiadomości.
created string Data utworzenia rekordu.
modified string Data modyfikacji rekordu.

Institution

Klucz Typ danych Opis
id string Unikalny identyfikator urzędu.
issue_initiator_id string Identyfikator klienta.
name string Nazwa urzędu.
email string Adres email urzędu.
phone string Numer telefonu urzędu.
city string Miasto urzędu.
post_code string Kod pocztowy urzędu.
address string Adres urzędu.

MailFolderLink

Klucz Typ danych Opis
folder_id string Identyfikator folderu.
mail_id string Identyfikator wiadomości email.

Pobieranie wiadomości mailowych

GET /rest/mail_message?folder_id={id_folderu}

Pobiera wiadomości email ze wskazanego folderu w parametrze folder_id.

W zależności od rodzaju wiadomości email nazwa modelu zwracanego przez zasób różni się:

  • Odebrane => MailReceivedMysqlMessage
  • Wysłane => MailSentMysqlMessage

UWAGA: Parametr folder_id w adresie URL jest wymagany.

Wiadomości odebrane

Wiadomości odebrane pobierane z zasobu MailReceivedMysqlMessage.

Odpowiedź
HTTP/1.1 200 OK
{
  "MailReceivedMysqlMessage": {
    "id": "",
    "mail_server_id": "",
    "user_id": "",
    "client_id": "",
    "customer_id": "",
    "mail_thread_id": "",
    "timestamp": "",
    "mail_date": null,
    "mail_address": "",
    "mail_name": "",
    "receiver_mail_address": null,
    "cc_receiver_mail_address": null,
    "bcc_receiver_mail_address": null,
    "mail_subject": "",
    "mail_body": "",
    "has_attachments": "",
    "missing_attachments_count": "",
    "priority": "",
    "is_remove": "",
    "tags": "",
    "is_read": "",
    "msg_unique_identifier": "",
    "api_msg_identifier": null,
    "in_reply_to_msg_uid": "",
    "x_gm_thrid": "",
    "mail_sent_mysql_messages_ids": null,
    "reference": "",
    "created": "1970-01-01T00:00:00+00:00",
    "modified": "1970-01-01T00:00:00+00:00"
  },
  "MailFolderLink": {
    "folder_id": null,
    "mail_id": null
  }
}

Wiadomości z folderu "Urzędy" (OFFICES)

HTTP/1.1 200 OK
{
  "MailReceivedMysqlMessage": {
    "id": "",
    "mail_server_id": "",
    "user_id": "",
    "client_id": "",
    "customer_id": "",
    "mail_thread_id": "",
    "timestamp": "",
    "mail_date": null,
    "mail_address": "",
    "mail_name": "",
    "receiver_mail_address": null,
    "cc_receiver_mail_address": null,
    "bcc_receiver_mail_address": null,
    "mail_subject": "",
    "mail_body": "",
    "has_attachments": "",
    "missing_attachments_count": "",
    "priority": "",
    "is_remove": "",
    "tags": "",
    "is_read": "",
    "msg_unique_identifier": "",
    "api_msg_identifier": null,
    "in_reply_to_msg_uid": "",
    "x_gm_thrid": "",
    "mail_sent_mysql_messages_ids": null,
    "reference": "",
    "created": "1970-01-01T00:00:00+00:00",
    "modified": "1970-01-01T00:00:00+00:00"
  },
  "Institution": {
      "id": "",
      "issue_initiator_id": null,
      "name": "",
      "email": "",
      "phone": "",
      "city": "",
      "post_code": "",
      "address": ""
  },
  "MailFolderLink": {
    "folder_id": null,
    "mail_id": null
  }
}

Wiadomości wysłane

Wiadomości odebrane pobierane z zasobu MailSentMysqlMessage.

Odpowiedź
HTTP/1.1 200 OK
{
  "MailSentMysqlMessage": {
    "id": "",
    "mail_server_id": "",
    "user_id": "",
    "client_id": "",
    "customer_id": "",
    "mail_address": "",
    "cc_mail_addresses": null,
    "bcc_mail_addresses": null,
    "mail_name": "",
    "sender_mail_address": "",
    "mail_subject": "",
    "mail_body": "",
    "priority": "",
    "tags": null,
    "status": "",
    "timestamp": "",
    "created": "1970-01-01T00:00:00+00:00",
    "modified": "1970-01-01T00:00:00+00:00"
  },
  "IssueInitiator": {
    "name": null,
    "first_name": null,
    "last_name": null
  },
  "MailFolderLink": {
    "folder_id": null,
    "mail_id": null
  }
}