Тема: Объект DocInput: свойства и методы

Объект DocInput - объект из пакета Internet Solutions Pack фирмы NetManage, поставляемого в составе Delphi 2.01. Он предназначен для описания входной информции для документа, передаваемого элементу управления. Все элементы управления для работы с Интернетом, имеющиеся в данном пакете, имеют доступ к объекту через соответствующее свойство, могут хранить в нем документы и передавать его от одного элемента управления другому. Объект DocInput имеет следующие свойства:

BytesTotal, BytesTransferred, DocLink, FileName, Headers, PushStreamMode, State и Suspended.

BytesTotal - счетчик общего количества байт передаваемого элемента. Значение по умолчанию и начальное значение равно нулю. Тип данных - Long. Данное свойство времени выполнения и только для чтения. Значение данного свойства получается из свойства заголовка "content-length" (длина содержимого). Это значение используется элементом управления для определения размера (объема) передаваемой информации. С помощью него также возможно управление буфером, который вы используете для "сборки" данных после их передачи.

Свойство BytesTranferred является свойством, передаваемым вам при наступлении события OnDocInput. Данное свойство времени выполнения, только для чтения и имеет тип long. При начале новой передачи значение свойства обнуляется. Обновляется в начале события OnDocInput. Значение данного свойства отражает величину последней передачи, когда другие передачи не осуществлялись. Свойство BytesTransferred может использоваться для показа линейки прогресса или для утверждения того, насколько фактически переданный размер соответствует ожидаемому.

Свойство DocLink сообщает получающему элементу управления о том, что источник не будет посылать документ через поток данных или входной файл. Оно ссылается на свойство DocOutput.DocLink, которое становится источником при передаче данных. Данное свойство является read/write-свойством (для чтения и записи) и доступно только во время выполнения программы. Свойство имеет тип DocLink. Это строковый тип, имеющий значение по умолчанию ''. Если значению данного свойства присваивается величина, отличная от '', свойство FileName автоматически устанавливается в ''. Данное свойство используется для определения источника, являющегося internet-компонентом с указывающим на объект свойством DocOutput.DocLink, т.е. они используются в парах.

Свойство FileName является read/write-свойством (для чтения и записи) только времени выполнения и имеет строковый тип. Значение по умолчанию ''. Это должно быть правильным именем файла. Данное свойство может быть установлено при его передаче в качестве аргумента объекту DocInput. Если значению данного свойства присваивается величина, отличная от '', свойство DocLink автоматически устанавливается в ''.

Свойство Headers является свойстом только для чтения и времени выполнения. "headers" - коллекция элементов DocHeader, которые определяют передаваемый документ. Содержимое свойства headers должно быть изменено перед вызовом метода GetDoc. Каждый DocHeader представляет собой MultiPurpose Internet Mail Extension (MIME). Mime является механизмом для определения и описания формата тела сообщения Интернет (Internet Message Bodies). (Для получения дополнительной информации смотри документ rfc1341). Используемые headers (заголовки) зависят от используемого протокола, но существуют два заголовка, независимые от протокола:

1. content-type (тип содержимого)
   content type указывает спецификацию MIME для следующего за заголовком документа. Примером этого является "text/plain".
2. content-length (размер содержимого)
   content length указывает размер документа в байтах.

Свойтво state является свойством только для чтения и времени выполнения, и имеет перечислимый тип DocStateConstants. Значение по умолчанию icDocNone. Свойство state элемента управления обновляет себя каждый раз при наступлении события DocInput.

Свойство suspended является свойством только для чтения и времени выполнения, и имеет логический тип. Устанавливается вызывом метода suspend. При установке значения, равного True, передача приостанавливается.

Свойство PushStream является read/write-свойством (для чтения и записи) только времени выполнения и имеет логический тип. Значение по умолчанию - False. Если свойству FileName или DocLink присваивается значение, отличное от '', то свойство PushStream становится недоступным.

Объект DocInput имеет 4 метода: GetData, PushStream, SetData и Suspend.

Метод GetData сообщает объекту DocInput об извлечении текущего блока данных в момент наступления события DocOutput. Данный метод может быть вызван только в течение события OnDocInput, и только когда свойство State установлено в icDocData(3). При использовании свойства FileName или DocLink, данный метод позволяет исследовать данные во время их передачи. Метод PushStream может быть вызван только если PushStreamMode установлен в True и когда данные доступны. PushStream устанавливает свойство State на основе следующего шага передачи документа и активизирует в нужный момент событие DocInput. Затем происходит возврат до следующего вызова PushStream. Перед вызовом PushStream должен быть вызван SetData.

Метод SetData определяет следующий буфер передаваемых данных при наступлении события DocInput. SetData вызывается в течение события DocInput или перед вызовом SendDoc. Если метод используется перед вызовом SendDoc, он может служить альтернативой передачи параметров InputData в InputData. Тип должен быть определен как variant.

Метод Suspend передает форме команду suspend(true) или suspend(false). Если метод с параметром True был вызван дважды, то для продолжения передачи его необходимо дважды вызвать с параметром False.

Вот некоторый код примера, показывающий как можно использовать объект DocInput. Полный проект, содержащий данный код, вы можете найти в подкаталоге demos на CD-ROM с Delphi 2.01. Имя проекта SimpMail.dpr. Данные проект представляет собой большое пример использования свойтсва объекта headers. Также показано соответствующее использование события DocInput и свойства State.

{Очистка и новое заполнение заголовков MIME с помощью
свойства компонента DocInput. Может также использоваться
отдельный OLE объект DocInput. Для получения полной
информации о типах MIME смотри документ RFC1521/1522.}

procedure TMainForm.CreateHeaders;
begin

  with SMTP1 do
  begin
    DocInput.Headers.Clear;
    DocInput.Headers.Add('To', eTo.Text);
    DocInput.Headers.Add('From', eHomeAddr.Text);
    DocInput.Headers.Add('CC', eCC.Text);
    DocInput.Headers.Add('Subject', eSubject.Text);
    DocInput.Headers.Add('Message-Id', Format('%s_%s_%s',
      [Application.Title, DateTimeToStr(Now), eHomeAddr.Text]));
    DocInput.Headers.Add('Content-Type',
      'TEXT/PLAIN charset=US-ASCII');
  end;
end;

{Посылаем простое почтовое сообщение}

procedure TMainForm.SendMessage;
begin

  CreateHeaders;
  with SMTP1 do
    SendDoc(NoParam, DocInput.Headers, reMessageText.Text, '', '');
end;

{Посылаем файл, расположенный на диске. Оставляем пустым
параметр SendDoc InputData и определяем имя файла для
InputFile для посылки содержимого файла, расположенного
на диске. Для осуществления собственного кодирования
(Base64, UUEncode и др.), вы можете использовать событие
DocInput и методы GetData }

procedure TMainForm.SendFile(Filename: string);
begin

  CreateHeaders;
  with SMTP1 do
  begin
    DocInput.Filename := FileName;
    SendDoc(NoParam, DocInput.Headers, NoParam, DocInput.FileName, '');
  end;
end;

{Событие DocInput возникает при каждом изменении
состояния DocInput во время передачи почтового сообщения.
DocInput хранит всю информацию о текущей передаче,
включая заголовки, количество переданных байт и сами
данные сообщения. Хотя в этом примере и не показано,
для кодирования данных перед отправкой каждого блока
вы можете вызвать метод DocInput SetData,
если DocInput.State = icDocData. }

procedure TMainForm.SMTP1DocInput(Sender: TObject;

  const DocInput: Variant);
begin

  case DocInput.State of
    icDocBegin:
      SMTPStatus.SimpleText := 'Начало передачи документа';
    icDocHeaders:
      SMTPStatus.SimpleText := 'Посылаем заголовки';
    icDocData:
      if DocInput.BytesTotal > 0 then
        SMTPStatus.SimpleText :=
          Format('Послано данных: %d из %d байт (%d%%)',
          [Trunc(DocInput.BytesTransferred), Trunc(DocInput.BytesTotal),
          Trunc(DocInput.BytesTransferred / DocInput.BytesTotal * 100)])
      else
        SMTPStatus.SimpleText := 'Посылка...';
    icDocEnd:
      if SMTPError then
        SMTPStatus.SimpleText := 'Передача прервана'
      else
        SMTPStatus.SimpleText := Format('Почта послана %s
          (%d байт данных)',
          [eTo.Text, Trunc(DocInput.BytesTransferred)]);
  end;
  SMTPStatus.Update;
end;