imap-service

Сервис получения электронных писем по протоколу IMAP

Описание

Осуществляет поиск писем с вложениями по заданным параметрам ИНН и/или ОГРН
Выдает список писем, в которых найдены ИНН или ОГРН в заголовке или теле письма

Установка

git clone git@gitlab.com:qqube/imap-service
cd imap-service
pipenv install --dev
pipenv shell

docker-compose -f build/docker-compose.yml up -d

Документация

http://localhost:5000/swagger/

Использование

В заголовочной части запросов обязательно указывать jwt token:
headers = {'Authorization': Bearer <access_token>}
Для проверки авторизации должен обязательно присутствовать один из
параметров inn или ogrn, либо оба параметра.

http://localhost:5000/mail

Параметры:

inn = ИНН

ogrn = ОГРН

page = номер страницы (по-умолчанию 1)

page_size = количество записей на одной странице (по-умолчанию 50)

path = папки для поиска писем, через запятую (по-умолчанию Inbox)

Возвращает:

Список писем в заголовке или теле которых присутствует заданные ИНН или ОГРН

http://localhost:5000/mail/[id]/

id - цифровой идентификатор письма

Параметры:

inn = ИНН

ogrn = ОГРН

page = номер страницы (по-умолчанию 1)

page_size = количество записей на одной странице (по-умолчанию 50)

path = папки для поиска писем, через запятую (по-умолчанию Inbox)

Если в начале значения параметра path указать знак !, то папки по-умолчанию игнорируются.

Возвращает:

Данные письма с идентификатором равным id

3. http://localhost:5000/mail/[id]/attachments/
   

id - цифровой идентификатор письма

Параметры:

inn = ИНН

ogrn = ОГРН

path = папки для поиска писем, через запятую (по-умолчанию Inbox)

Возвращает:

Файлы, прикрепленные к письму в виде zip-архива.

4. http://localhost:5000/mail/[id]/attachments/[id_attach]/
   

id - цифровой идентификатор письма
id_attach - строковый идентификатор файла в письме

Параметры:

inn = ИНН

ogrn = ОГРН

path = папки для поиска писем, через запятую (по-умолчанию Inbox)

Возвращает:

Файл, прикрепленные к письму, соответствующий идентификатору id_attach

Примеры:

1. http://localhost:5000/mail?inn=1234567890&ogrn=&page=1&page_size=50
   

Результат:

{
    "count": 1,
    "current": "http://localhost:5000/mail?inn=1234567890",
    "inn": "1234567890",
    "next": "",
    "ogrn": null,
    "page": 1,
    "page_size": 50,
    "previous": "",
    "results": [
                    {
                        "id": "20",
                        "body": "",
                        "date": "Sat, 10 Feb 2024 12:04:18 GMT",
                        "files": [
                            {
                                "id": "8dfa0771",
                                "name": "1234567890_022024_1.zip"
                            },
                            {
                                "id": "89sa82s0",
                                "name": "1234567890_022024_2.zip"
                            }
                        ],
                        "id": "19",
                        "sender": "1234567890@mail.ru",
                        "subject": "Fwd: ИНН 1234567890"
                    },
                    ....
                ]
}