energine
[ class tree: energine ] [ index: energine ] [ all elements ]

Class: Mail

Source Location: /framework/Mail.class.php

Class Overview

Object
   |
   --Mail

Отправщик сообщения


Author(s):

  • dr.Pavka

Variables

Constants

Methods


Inherited Constants

Inherited Variables

Inherited Methods

Class: Object

Object::__construct()
Пустой конструктор
Object::getConfigValue()
Нестатический метод-обёртка над Object::_getConfigValue - для удобства использования внутри производных классов.
Object::getTimer()
Возвращает значение счетчика времени выполнения.
Object::resetTimer()
Сбрасывает счетчик времени, возвращает предыдущее значение счетчика
Object::startTimer()
Запускает счетчик времени выполнения.
Object::stopTimer()
Останавливает счетчик времени выполнения.
Object::_getConfigValue()
Возвращает значение указанного параметра конфигурации.

Class Details

[line 22]
Отправщик сообщения



Tags:

author:   dr.Pavka
final:  


[ Top ]


Class Variables

$attachments = array()

[line 91]

Массив файлов для аттачмента



Tags:

access:   private

Type:   array


[ Top ]

$headers = array()

[line 75]

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



Tags:

access:   private

Type:   array


[ Top ]

$MIMEBoundary =

[line 35]

MimeBoundary



Tags:

access:   private

Type:   string


[ Top ]

$replyTo = array()

[line 83]

Reply-to



Tags:

access:   private

Type:   string


[ Top ]

$sender =

[line 51]

Адрес отправителя

Формат: Имя отправителя




Tags:

access:   private

Type:   string


[ Top ]

$subject =  false

[line 43]

Тема письма



Tags:

access:   private

Type:   string


[ Top ]

$text =  false

[line 67]

Текст сообщения



Tags:

access:   private

Type:   string


[ Top ]

$to = array()

[line 59]

Перечень получателей



Tags:

access:   private

Type:   array


[ Top ]



Class Methods


constructor __construct [line 98]

void __construct( )

Конструктор класса



Tags:

access:   public


Overrides Object::__construct() (Пустой конструктор)

[ Top ]

method addAttachment [line 208]

void addAttachment( mixed $file, [ $fileName = false])

Добавить аттач



Tags:

access:   public


Parameters:

mixed   $file  
   $fileName  

[ Top ]

method addReplyTo [line 161]

Mail addReplyTo( $email, [ $name = false])

Добавление reply-to заголовка



Tags:

access:   public


Parameters:

   $email  
   $name  

[ Top ]

method addTo [line 138]

Mail addTo( $email, [ $name = false])

Добавляет получателя к списку получателей



Tags:

access:   public


Parameters:

   $email  
   $name  

[ Top ]

method clearRecipientList [line 149]

Mail clearRecipientList( )

Очищает список получателей



Tags:

access:   public


[ Top ]

method getText [line 196]

string getText( )

Возвращает текст сообщения



Tags:

access:   public


[ Top ]

method send [line 226]

boolean send( )

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



Tags:

access:   public


[ Top ]

method setFrom [line 112]

Mail setFrom( string $email, [string $name = false])

Устанавливает аттрибут от



Tags:

access:   public


Parameters:

string   $email  
string   $name  

[ Top ]

method setSubject [line 125]

Mail setSubject( string $subject)

Устанавливает тему письма



Tags:

access:   public


Parameters:

string   $subject  

[ Top ]

method setText [line 175]

Mail setText( string $text, [mixed $data = false])

Устанавливает текст сообщения



Tags:

access:   public


Parameters:

string   $text  
mixed   $data   данные для шаблонизатора

[ Top ]


Class Constants

EOL =  "\n"

[line 27]

End Of Line


[ Top ]


В создании документации нам помог: phpDocumentor