Внимание! Запущено тестирование FoxTools API v2.0!
Если у вас возникнут каки-либо вопросы по работе с API, вы можете оставлять их на форуме группы FoxTools.ru.

MIME

Парсер MIME. В отличие POP3, данный метод не получает письма с сервера, а лишь обрабатывает переданные иму данные.

MIME (Multipurpose Internet Mail Extensions) - это стандарт, описывающий передачу различных типов данных по электронной почте.

Параметры

Имя параметра Тип Обязательный Описание
TEXT Строка Да, если не указан BASE64 Данные MIME в текстовом виде. Ввиду особенностей кодирования данных, рекомендуется передавать MIME в бинарном виде в формате BASE64 в соответствующий параметр.
BASE64 (рекомендуется) Строка Да, если не указан TEXT Бинарные данные MIME в формате Base64, как есть. Рекомендуется использовать этот параметр вместо TEXT, чтобы не возникало проблем с кодировками текстовых данных.
HEADERSONLY Логический Нет При значении данного параметра TRUE, сервер вернет только заголовки, исключая содержимое. Значение по умолчанию: FALSE.
TEXTONLY Логический Нет При значении данного параметра TRUE будет выдано только текстовое (text/plain, text/html) содержимое письма, multipart и файлы будут исключены из ответа. Значение по умолчанию: FALSE. Данный параметр игнорируется, если HEADERSONLY = TRUE.

Примечания

Если указан параметр TEXT и BASE64, то используется только BASE64.

Ограничения

Данный метод работает только в режимах XML и JSON. Режим TEXT не поддерживается из-за сложной структуры данных.


Общие сведения

Все команды к API необходимо делать методом POST, на этот же адрес, на котором вы находитесь в данный момент (исключая корневой арес сайта). Тип содержимого (Content-Type) при запросах к API должен быть multipart/form-data.

Для доступа к API обязательно нужно передовать идентификатор и открытый ключ доступа, которые можно получить в личном кабинете на сайте http://foxtools.ru в свойствах подключенного к сервису сайта.

Параметры для доступа к API

Имя параметра Тип Обязательный Описание
ID Целое число Да Уникальный идентификатор сайта в системе.
KEY Guid Да Открытый ключ доступа к API.
CID Целое число Нет Пользовательский идентификатор. Данный параметр можно передавать, чтобы получать более детальную статистику использования сервера. Например, в этот параметр можно передавать идентификатор пользователя в вашей БД, чтобы знать, сколько раз пользователь использовал тот или иной сервис.
CGRP Целое число Нет Группа для пользовательских идентификаторов (CID). Вы можете использовать этот параметр для группировки статистических данных. Например, если в CID вы передаете идентификатор пользователя в вашей БД, то параметр CGRP может быть равен 1. Если в CID вы передаете идентификатор страницы на вашем сайте, то CGRP может быть равен 2. Таким образом, вы сможете выделять статистику для пользователей (CGRP = 1) и страниц (CGRP = 2).

Примечание. Регистр символов значения не имеет. Это касается любых параметров, как имен, так и значений.

Формат ответа

Выдача результата в API возможна в трех форматах: XML (по умолчанию), JSON, текстовой.
Для указания формата выдачи необходимо добавить к адресу страницы запроса имя желаемого формата, через слеш.

Например:
http://api.foxtools.ru/v1/MIME/xml
http://api.foxtools.ru/v1/MIME/json
http://api.foxtools.ru/v1/MIME/text




Дополнительная информация

Состояние: Работает
Использование: Бесплатно
Всего запросов: 0
Запросов сегодня: 0
Первый запрос: не было
Последний запрос: не было