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

POP3

Метод позволяет получать письма с почтового сервера по протоколу POP3.

POP3 (англ. Post Office Protocol Version 3) - это протокол почтового отделения, версии 3. POP3 популярный протокол, который используется практически всеми программами и серверами работы с электронной почтой.
Протокол POP3 служит для получения почты, в отличие от протокола SMTP, который служит для отправки почты.

Параметры

Имя параметра Тип Обязательный Описание
HOST Строка Да Адрес почтового сервера. Например: pop.yandex.ru.
PORT Целое число Нет Порт, через который можно получить доступ к почтовому сервере. Значение по умолчанию: 110.
LOGIN Строка Да Имя пользователя для доступа к почтовому серверу.
PWD Строка Да Пароль пользователя для доступа к почтовому серверу.
MAX Целое число Нет Максимальное число писем, которое нужно получить с сервера. Используйте этот параметр, чтобы ограничить число получаемых писем, если их очень много. При этом, рекомендуется удалять полученные письма - REMOVE = TRUE, чтобы иметь возможность получить оставшиеся. Значение по умолчанию 0 - без ограничений.
HEADERSONLY Логический Нет При значении данного параметра TRUE, сервер вернет только заголовки писем, исключая содержимое. Рекомендуется использовать данный метод, если на сервере много писем, т.к. процесс получения всех писем может знаять длительное время, и в некоторых слаучая, почтовый сервер может оборвать соединение, что приведет к возникновению ошибки. Значение по умолчанию: FALSE.
INCLUDESOURCE Логический Нет При значении данного параметра TRUE в ответ будет включено содержимое письма как есть, в бинарном виде, в формате Base64. Значение по умолчанию: FALSE. Данный параметр игнорируется, если HEADERSONLY = TRUE.
TEXTONLY Логический Нет При значении данного параметра TRUE будет выдано только текстовое (text/plain, text/html) содержимое писем, multipart и файлы будут исключены из ответа. Значение по умолчанию: FALSE. Данный параметр игнорируется, если HEADERSONLY = TRUE.
REMOVE Логический Нет При значении данного параметра TRUE, полученные письма будут удалены с сервера. Значение по умолчанию: FALSE (письма не удаляются).

ВНИМАНИЕ. Если параметр REMOVE = TRUE все письма будут УДАЛЕНЫ с сервера! ВОССТАНОВИТЬ ДАННЫЕ ПОСЛЕ УДАЛЕНИЯ БУДЕТ НЕВОЗМОЖНО!

Описание частых ошибок протокола POP3

-ERR Unable to log on
Данная ошибка означает, что допущена ошибка в указании имени пользователя или пароля.

-ERR Unable to log on. Only one connection to a mailbox permitted at a time.
Данная ошибка означает, что одновременно только один пользователь может использовать одну учетную запись. Чаще всего такая ошибка происходит, если пользователь подключился к серверу, но не завершил соединение корректно и сервер считает, что пользователь все еще подключен. В таком случае следует подождать примерно 10-30 минут, когда сервер автоматически отключит пользователя и появится возможность вновь подключится к серверу.

Ограничения

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

Безопасность

FoxTools.Ru не сохраняет и не передает третьим лицам указываемые данные соединения с POP3-серверами.
FoxTools.ru не дает гарантий сохранности передаваемых серверу и обратно данных. Помните, что всю ответственность за использование данного сервиса несете вы и только вы.

Настоятельно не рекомендуется использовать данный метод в проектах JavaScript. Никогда не указывайте логин и пароль в коде JavaScript, т.к. код передается пользователю в открытом виде! Данный метод можно безопасно использовать в любых серверных технологиях: ASP .NET, PHP, Perl, Python и т.п.



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

Все команды к 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/Pop3/xml
http://api.foxtools.ru/v1/Pop3/json
http://api.foxtools.ru/v1/Pop3/text




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

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


Комментарий администратора

Временно отключен из-за плохой логики работы в API.