ИнтернетПочта.ПолучитьЗаголовки (InternetMail.GetHeaders)

ИнтернетПочта (InternetMail)

ПолучитьЗаголовки (GetHeaders)

Синтаксис:

ПолучитьЗаголовки(<ПараметрыОтбора>)

Параметры:

<ПараметрыОтбора> (необязательный)

Тип: Структура.
В качестве ключей структуры используются названия свойств письма, по которым осуществляется отбор.
Значения могут быть выражения следующих типов: Строка, Дата, Число, Булево.
Тип значения определяется ключом. Например, если требуется отобрать письма до определённой даты, то в качестве значения необходимо использовать выражения типа Дата.
Если в качестве значения используется строка, то регистр не имеет значения.
Если заданы несколько ключей, то они применяются последовательно по логическому И.
Если в структуре передано неподдерживаемое значение ключа, оно игнорируется, ошибки при этом не возникает.

ОтправленОтвет (Answered) - Булево. Отобрать сообщения, у которых установлен флаг – Answered;
Недавние (Recent) - Булево. Отобрать сообщения, пришедшие в рамках текущей IMAP-сессии.
СлепыеКопии (Bcc) - Строка. Отобрать сообщения, которые имеют “строка” в поле Bcc;
Копии (Cc) - Строка. Отобрать сообщения, которые имеют “строка” в поле Cc;
Получатели (To) - Строка. Отобрать сообщения, которые имеют “строка” в поле To;
ДатаОтправления (PostDating) - Дата. Отобрать сообщения, у которых значение поле Date: равно “Дата”;
Отправитель (From) - Строка. Отобрать все сообщения у которых встречается “строка”в поле From;
ДоДатыОтправления (BeforeDateOfPosting) - Дата. Отобрать сообщения, у которых значение поле Date: перед “дата”;
ПослеДатыОтправления (AfterDateOfPosting) - Дата. Отобрать сообщения, у которых значение поля Date: после значения “Дата”;
Тема (Subject) - Строка. Отобрать сообщения, в заголовке которых встречается заданная строка;
Текст (Text) - Строка. Отобрать сообщения, в любых текстовых полях которого встречается заданная строка;
ТелоСообщения (Body) - Строка. Отобрать сообщения, в теле которых встречается строка – “строка”;
Удаленные (Deleted) - Булево. Отобрать сообщения, которые должны быть удалены или не должны быть удалены;
УстановленФлаг (Flagged) - Булево. Отобрать сообщения, которые помечены флагом или не помечены флагом;
Прочитанные (Seen) - Булево. Отобрать сообщения, которые были прочитаны или не прочитаны;
Новые (New) - Булево. Отобрать новые или старые сообщения.

Пример:

ПараметрыОтбораIMAP = Новый Структура;
ПараметрыОтбораIMAP.Вставить("Новые", Истина);
ПараметрыОтбораIMAP.Вставить("Тема", "привет");
Почта.ПолучитьЗаголовки(ПараметрыОтбораIMAP);

Строковые значения критериев отбора отправляются в кодировке US-ASCII, если содержат только символы ANSI и в кодировке UTF-8 - в противном случае. Не все IMAP-серверы поддерживают UTF-8, поэтому сервер может выдать соответствующую ошибку.

Возвращаемое значение:

Тип: Массив.

Описание:

Формирует массив, содержащий объекты типа ИнтернетПочтовоеСообщение. Каждый объект содержит только следующие поля:

Заголовок,
Размер,
ИдентификаторСообщения,
Тема,
Отправитель,
ОбратныйАдрес,
Получатели,
Копии,
СлепыеКопии,
ДатаОтправления.

Выбираются заголовки всех сообщений, находящихся на сервере.

Доступность:

Тонкий клиент, мобильный клиент, сервер, толстый клиент, внешнее соединение, мобильное приложение(клиент), мобильное приложение(сервер).

Примечание:

Полученный массив может быть передан в качестве параметра методу Выбрать. Метод Выбрать получает указанные сообщения полностью, и возвращает их в массиве.
Для IMAP протокола заголовки будут выбраны из IMAP почтового ящика (ТекущийПочтовыйЯщик).
Внимание! Фильтрация заголовков работает только при работе по протоколу IMAP. При работе по протоколу POP3 отбор писем не выполняется - метод вернет полный массив сообщений, даже если установлены параметры отбора.

Пример:

Профиль = Новый ИнтернетПочтовыйПрофиль;
// ...

// заполнение профиля

// ...

Почта = Новый ИнтернетПочта;
Почта.Подключиться(Профиль);
Заголовки = Почта.ПолучитьЗаголовки();
Если Заголовки.Количество() = 0 Тогда
    Предупреждение(НСтр("ru='На сервере нет сообщений!';"
     + " en='There are no messages on the server!'"),
     ,НСтр("ru='Нет сообщений';" en='No messages'"));
КонецЕсли;

// выбираем из массива Заголовки сообщения,
// которые необходимо получить полностью

Письма = Почта.Выбрать(Истина, Заголовки);

// Письма и Заголовки содержат одинаковый
// набор полных сообщений

Почта.Отключиться();

См. также:

ИнтернетПочта, метод Выбрать

Оглавление | Родительский раздел Платформа 8.3.13.1809