Свойства и методы объекта V7Mail

[СветланаТ]

Введение
Внешняя компонента V7Plus.dll (релиз 001-003) состоит из четырех объектов V7Mail, V7SysInfo, V7HttpReader и XMLParser. В релиз 004 компоненты добавлен объект для работы с текстовыми файлами - V7TextFile.

Инициализация внешней компоненты может осуществляется с помощью метода ЗагрузитьВнешнююКомпоненту(<ИмяФайлаКомпоненты>)" где

<ИмяФайлаКомпоненты> - имя файла внешней компоненты "V7Plus.dll".

Если не указан пусть поиска, файл компоненты ищется последовательно в каталоге пользователя, в каталоге информационной базы, и в каталоге c исполняемым файлом 1С:Предприятия.

[СветланаТ]

Свойства и методы объекта V7Mail
Назначение и порядок использования
Объект компоненты предназначен для расширения функциональности 1С:Предприятия в части работы с электронной почтой. Он позволяет работать как с программой "1C:Электронная Почта", так и с любым почтовым клиентом, работающим через MAPI (например Outlook Express, Outlook ). С помощью объекта V7Mail можно создавать, посылать и принимать сообщения, причем сообщение может иметь несколько адресатов и присоединенных файлов.

Для осуществления доступа к методам и свойствам объекта V7Mail необходимо вызвать функциюСоздатьОбъект, передав ей строку "AddIn.V7Mail" в качестве параметра, и получить ссылку на объект, которая присваивается переменной, через которую и будет осуществляться доступ.

Например:

Почта = СоздатьОбъект("AddIn.V7Mail");

Работа с почтой начинается с установки соединения с помощью метода Подключиться, который инициализирует сеанс работы с почтой. Если параметры подключения не заданы, то они берутся со страницы свойств компоненты. Для организации сеанса с параметрами подключения, отличающимися от заданных на странице свойств компоненты, необходимо указать эти параметры в методе Подключиться. Если подключение прошло успешно, можно начать работу с сообщениями.

Для инициализации процесса создания нового сообщения используется метод НовоеСообщение. Далее, с помощью метода ДобавитьАдрес можно задать один или несколько адресов, по которым будет отправлено сообщение. Формат адреса зависит от почтового клиента, выбранного в параметрах подключения. При необходимости, можно присоединить к сообщению один или несколько файлов, воспользовавшись методом ДобавитьФайл. Заголовок и текст сообщения задаются в соответствующих атрибутах сообщения.

Отправка сообщения осуществляется с помощью метода Послать. Для успешной отправки сообщения необходимо, чтобы для него был задан хотя бы один адресат. Метод Послать предоставляет возможность просмотра и редактирования сообщения перед отправкой (только в случае работы с клиентом MAPI ). Для этого необходимо передать в качестве параметра <Просмотр> 1.

Процесс приема сообщений инициализируется методом ВыбратьСообщения. Если в полученной выборке присутствует хотя бы одно сообщение - он возвращает 1, в противном случае - 0. Если выбрано хотя бы одно сообщение, то можно организовать цикл их получения с помощью метода ПолучитьСообщение, который последовательно выбирает их из полученной выборки. Если возвращаемое значение равно 0, то сообщений больше нет. После получения сообщения доступны для чтения адрес отправителя и заголовок сообщения. Для получения доступа к тексту и присоединенным файлам сообщения, его необходимо прочитать с помощью метода ПрочитатьСообщение. Этот метод изменяет статус сообщения на прочитанное, и оно не попадает в последующие выборки.

Если необходимо, чтобы сообщение попадало в последующие выборки, можно не изменять статус сообщения, передав в качестве параметра 0. Текст сообщения хранится в атрибуте Текст, а полные пути к присоединенным файлам можно получить, организовав цикл с помощью метода ПолучитьФайл. Если присоединенных файлов больше нет, метод ПолучитьФайл возвращает 0. Файлы копируются во временный каталог и удаляются при переходе на следующее сообщение (ПолучитьСообщение).

Завершается работа с почтой с помощью метода Отключиться.

[СветланаТ]

Настройка параметров объекта
Настройка параметров объекта V7Mail производится в диалоге системных настроек, который вызывается при выборе пункта "Параметры" раздела меню "Сервис".

На закладке "Электронная почта" вынесены следующие настройки:

[СветланаТ]

Тип почты
"MAPI" или "1C:Электронная Почта" - позволяет установить тип электронной почты, с которой будет работать компонента. Если этот параметр не задан, при инициализации сеанса работы с почтой в методе Подключиться следует указать его значение (см. описание метода Подключиться).

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

[СветланаТ]

MAPI
Для этого типа электронной почты необходимо указать следующие параметры:

Конфигурация подключения (строковое выражение) - конфигурация подключения (например - "Outlook").

Пароль (строковое выражение) - пароль абонента.

Указывать параметры не обязательно, т.к. если они не заданы или заданы неправильно, то при инициализации сеанса работы с почтой методом Подключиться без параметров выбирается конфигурация подключения, заданная по умолчанию почтовым клиентом "MAPI".

Если нужно организовать сеанс работы с почтой с параметрами подключения, отличными от заданных в конфигурации подключения клиента MAPI, то нужно задать эти параметры на странице свойств компоненты ("Сервис/Параметры/Электронная почта") или в методе Подключиться.

[СветланаТ]

1C:Электронная почта
Для этого типа электронной почты необходимо указать следующие параметры:

Имя пользователя (строковое выражение) - почтовое имя абонента в системе "1С:Электронная Почта" (например - "ИМЯ.УЗЕЛ", где Имя - локальное имя пользователя, УЗЕЛ - наименование почтового узла).

Пароль (строковое выражение) - пароль абонента в системе "1С:Электронная Почта".

Каталог почтового узла (строковое выражение) - путь к сетевому почтовому узлу (диск должен быть обязательно подключен).

В случае использования программы "1С:Электронная Почта" параметры подключения должны быть обязательно определены либо на странице свойств компоненты, либо при инициализации сеанса работы с почтой с помощью метода Подключиться. Все параметры являются обязательными и не могут быть пропущены. При нажатии кнопки Применить компонента пытается установить соединение с почтовым узлом и, если соединение установлено, сохраняет параметры подключения.

В случае использования программы "1С:Электронная Почта" необходимо дополнительно использовать dll-файлы "1cml32.dll" и "unizip32.dll", которые следует поместить в каталог с файлом программы (наПример: "C:\Program Files\1cv77\BIN") или каталог базы данных.

Внимание!!! Если до использования метода Подключить уже запущена программа "1C:Электронная Почта", соединение с почтовым узлом не может быть установлено, а в табло сообщений об этом выводится соответствующее сообщение.

[СветланаТ]

Описание атрибутов и методов объекта V7Mail
Атрибуты
Заголовок
Синтаксис:

Заголовок

Англоязычный синоним:

Subject

Описание:

Заголовок сообщения (строковое выражение).

Текст
Синтаксис:

Текст

Англоязычный синоним:

Text



Описание:

Текст сообщения (строковое выражение).


ДатаОтправки
Синтаксис:

ДатаОтправки

Англоязычный синоним:

DatеSend

Описание:

Дата отправки письма в формате "ГГГГ/ММ/ДД ЧЧ:ММ", где ГГГГ - год, ММ - месяц, ДД - день; ЧЧ - час, ММ - минута отправки письма.

[СветланаТ]

Методы

Подключиться
Инициализация сеанса работы с почтой

Синтаксис:

Подключиться()

Подключиться("1C", <ИмяАбонента>, <Пароль>, <КаталогПочтовогоУзла>)

Подключиться("MAPI", <КонфигурацияПодключения>, <Пароль>)

Англоязычный синоним:

Logon

Параметры:

<ИмяАбонента> (строковое выражение) - почтовое имя абонента в системе "1С:Электронная Почта"

<Пароль> (строковое выражение) - пароль

<КаталогПочтовогоУзла> (строковое выражение) - каталог почтового узла (диск должен быть обязательно подключен)

            <КонфигурацияПодключения> (строковое выражение) - название используемой конфигурации подключения

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

Нет

Описание:

1.Метод Подключиться инициализирует сеанс работы с почтой в соответствии с выбранным на закладке свойств компоненты типом почты и параметрами подключения.

2.Метод Подключиться инициализирует сеанс работы с "1С:Электронная Почта" с выбранными параметрами подключения.

3.Метод Подключиться инициализирует сеанс работы с почтой MAPI с соответствующими параметрами подключения и паролем.

[СветланаТ]

Отключиться
Завершить сеанса работы с почтой

Синтаксис:

Отключиться()

Англоязычный синоним:

Logoff

Параметры:

Нет

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

Нет

Описание:

Метод Отключиться завершает сеанс работы с почтой инициализированный методом Подключиться.

[СветланаТ]

НовоеСообщение
Создать новое сообщение

Синтаксис:

НовоеСообщение()

Англоязычный синоним:

NewMessage

Параметры:

Нет

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

Нет

Описание:

Метод НовоеСообщение инициализирует создание нового сообщения. После инициализации происходит заполнение его реквизитов с последующим вызовом метода Послать.