Письмо

Иерархия типа

graph BT;
Письмо-->ЗаголовкиПисьма;
ЗаголовкиПисьма-->Объект;

Сообщение электронной почты.

Сравнение ссылочное

Примеры

знч Сообщение = новый Письмо("sender@1c.ru")    
Сообщение.ДобавитьПолучателей("recipient@1c.ru")    
Сообщение.ДобавитьПолучателейКопии("ivanov@1c.ru")
Сообщение.Важность = ВажностьСообщенияЭлектроннойПочты.Высокая
Сообщение.УстановитьТекстКакСтроку("Текст исходящего сообщения электронной почты.")
Сообщение.Тема = "Тема сообщения"

Конструкторы

Письмо

Письмо(
  Отправитель: АдресПочты|Строка,
  Получатели: АдресПочты|Строка|ЧитаемыйМассив<АдресПочты>,
  Тема: Строка? = Неопределено)

Создает сообщение электронной почты с отправителем Отправитель, получателями Получатели и темой Тема.

Свойства

Важность

Важность почтового сообщения. Значение данного свойства определяется значением заголовка “X-Priority”.

Вложения

Массив вложений.

ЕстьОшибкиВРазбореТелаПисьма

Признак, что при разборе тела письма (текст и вложения) возникли ошибки. Письмо может содержать ошибки

ИдСообщения

Значение заголовка “Message-ID”. Undefined, если заголовок не установлен.

Тема

Значение заголовка “Subject”. Undefined, если заголовок не установлен.

ТипСодержимого

Тип содержимого тела письма. Значение заголовка “Content-Type” (RFC 822) Undefined, если заголовок не установлен.

Частичное

Является ли письмо частичным (в случае, если большое сообщение было разбито на части).

Методы

ВБайты

ВБайты(): Байты

Возвращает байты письма сериализованного в формат eml.

ВПоток

ВПоток(): ПотокЧтения

Возвращает поток с письмом сериализованным в формат eml.

ВСтроку

ВСтроку(): Строка

Возвращает строковое представление сообщения.

ДобавитьЗаголовок

ДобавитьЗаголовок(
  Имя: Строка,
  Значение: Число|Строка|ЧитаемыйМассив<Число|Строка>
): Письмо

Добавляет значение Значение заголовка с именем Имя. Возвращает текущий экземпляр.

Исключения

ИсключениеНедопустимыйАргумент - Если передано невалидное имя или значение заголовка (см RFC2822 раздел 2.2).

ДобавитьОбратныеАдреса

ДобавитьОбратныеАдреса(ОбратныеАдреса: АдресПочты|Строка|ЧитаемыйМассив<АдресПочты>): Письмо

Добавляет обратный адрес ОбратныеАдреса для сообщения. Возвращает текущий экземпляр.

ДобавитьПолучателей

ДобавитьПолучателей(Получатели: АдресПочты|Строка|ЧитаемыйМассив<АдресПочты>): Письмо

Добавляет получателя или получателей Получатели. Возвращает текущий экземпляр.

ДобавитьПолучателейКопии

ДобавитьПолучателейКопии(Получатели: АдресПочты|Строка|ЧитаемыйМассив<АдресПочты>): Письмо

Добавляет получателя или получателей Получатели копии сообщения. Возвращает текущий экземпляр.

ДобавитьПолучателейСкрытойКопии

ДобавитьПолучателейСкрытойКопии(Получатели: АдресПочты|Строка|ЧитаемыйМассив<АдресПочты>): Письмо

Добавляет получателя или получателей Получатели скрытой копии сообщения. Возвращает текущий экземпляр.

ИзБайт

Статический ИзБайт(БайтыПисьма: Байты): Письмо

Создает письмо из байтов письма в eml формате.

ОчиститьЗаголовки

ОчиститьЗаголовки(): Письмо

Удаляет все заголовки сообщения. Возвращает текущий экземпляр.

ПолучитьВсеЗаголовки

ПолучитьВсеЗаголовки(Имя: Строка): ЧитаемыйМассив<Строка>

Возвращает массив со всеми значениями заголовка Имя. Если заголовка нет - пустой массив.

ПолучитьПервыйЗаголовок

ПолучитьПервыйЗаголовок(Имя: Строка): Строка?

Возвращает значение заголовка по его имени Имя или Undefined, если значения нет или заголовок отсутствует. Если есть несколько значений заголовка, то вернется первое по порядку.

ПолучитьТекст

ПолучитьТекст(): ЧитаемыйМассив<ЧастьТекстаПисьма>

Возвращает текст письма.

ПолучитьТекстКакСтроку

ПолучитьТекстКакСтроку(): Строка

Возвращает текст письма в виде строки, при наличии нескольких частей текста письма, приоритет отдается html-тексту.

ПриложитьДанные

ПриложитьДанные(
  Данные: Байты|ПотокЧтения|Строка,
  Название: Строка = "",
  ТипСодержимого: Строка = "",
  Ид: Строка = "",
  ВстроенноеВТекст: Булево = Ложь
): ВложениеПисьма

Добавляет и возвращает вложение сообщения на основе указанных данных Данные и параметров Название и ТипСодержимого. Если Ид не указан, то будет сгенерирован случайный Ууид. ВстроенноеВТекст отвечает за расположение в письме вложения, если Истина, то вложение может быть отображено в тексте письма.

Примеры

метод ДобавитьФайлВоВложение(Письмо: Письмо)
    пер ФайлЛогов1 = новый Файл("C:/logs/1.log")
    исп ПотокФайла1 = ФайлЛогов1.ОткрытьПотокЧтения()
    Письмо.ПриложитьДанные(ПотокФайла1, "SystemInitializationLogs.txt")

    пер ФайлЛогов2 = новый Файл("C:\\logs\\2.log")
    исп ПотокФайла2 = ФайлЛогов2.ОткрытьПотокЧтения()
    Письмо.ПриложитьДанные(ПотокФайла2, "2.log")
;

ПриложитьФайл

ПриложитьФайл(
  Файл: Файл|Строка,
  Название: Строка = "",
  ТипСодержимого: Строка = "",
  Ид: Строка = "",
  ВстроенноеВТекст: Булево = Ложь
): ВложениеПисьма

Добавляет и возвращает вложение сообщения на основе файла Файл и параметров Название и ТипСодержимого. Если Название не заполнен, то названием будет имя приложенного файла.

Примеры

метод ЗаполнитьПисьмоДиректору(): Письмо
    пер Письмо = ШаблонПисьмаДиректору()
    Письмо.УстановитьТекстКакСтроку(ПолучитьТекст(), ВидТекстаПисьма.Html)
    // Картинка будет отображаться в тексте письма.
    Письмо.ПриложитьФайл(Файл = "img.png",
        Название = "my_image.png",
        ТипСодержимого = "image/png",
        Ид = "my_image.png",
        ВстроенноеВТекст = Истина)
    возврат Письмо
;
    
метод ПолучитьТекст(): String
    return "<div><img border=\"0\" hspace=\"0\" alt=\"\" align=\"baseline\" apple-inline=\"yes\"" +
    "id=\"my_image.png\" height=\"836\" width=\"643\" apple-width=\"yes\"" +
     "apple-height=\"yes\" style=\"display:block\" src=\"cid:my_image.png\"></div>"
;

УдалитьВложение

УдалитьВложение(Ид: Строка)

Удаляет вложение с идентификатором Ид из сообщения.

УдалитьЗаголовок

УдалитьЗаголовок(Имя: Строка): Письмо

Удаляет все заголовки с именем Имя. Возвращает текущий экземпляр.

УстановитьЗаголовок

УстановитьЗаголовок(
  Имя: Строка,
  Значение: Число|Строка|ЧитаемыйМассив<Число|Строка>
): Письмо

Устанавливает заголовок с именем Имя и значениями Значение. Если заголовок с таким именем уже существует, то перед установкой все существующие значения заголовка будут удалены.

Исключения

ИсключениеНедопустимыйАргумент - Если передано невалидное имя или значение заголовка (см RFC2822 раздел 2.2).

УстановитьОбратныеАдреса

УстановитьОбратныеАдреса(ОбратныеАдреса: АдресПочты|Строка|ЧитаемыйМассив<АдресПочты>): Письмо

Устанавливает обратный адрес ОбратныеАдреса или несколько адресов.

УстановитьОтправителя

УстановитьОтправителя(Отправитель: АдресПочты|Строка): Письмо

Устанавливает отправителя сообщения Отправитель.

УстановитьПолучателей

УстановитьПолучателей(Получатели: АдресПочты|Строка|ЧитаемыйМассив<АдресПочты>): Письмо

Устанавливает получателя или получателей Получатели сообщения.

УстановитьПолучателейКопии

УстановитьПолучателейКопии(Получатели: АдресПочты|Строка|ЧитаемыйМассив<АдресПочты>): Письмо

Устанавливает получателя или получателей Получатели копии сообщения.

УстановитьПолучателейСкрытойКопии

УстановитьПолучателейСкрытойКопии(Получатели: АдресПочты|Строка|ЧитаемыйМассив<АдресПочты>): Письмо

Устанавливает получателя или получателей Получатели скрытой копии сообщения.

УстановитьТекстКакСтроку

УстановитьТекстКакСтроку(
  Текст: Строка,
  ВидТекста: ВидТекстаПисьма = ВидТекстаПисьма.ПростойТекст
): Письмо

Устанавливает текст письма и его вид.

Список унаследованных методов

Объект

Список унаследованных свойств

ЗаголовкиПисьма