Класс Mailer

Граф наследования:Mailer:

Открытые члены
	prepareConfiguration (Context $context)
	setMIMEBody ($body)
	setMIMEHeader ($headers)
	sendMailBySmtp (string $sourceTo, string $subject, string $message, string $additional_headers, string $additional_parameters)

Открытые статические члены
static	getInstance (Context $context)
static	checkConnect (Context $context, \Bitrix\Main\ErrorCollection $errors)
static	closeConnections ()

Поля данных
const	KEEP_ALIVE_ALWAYS = 'keep_alive_always'
const	KEEP_ALIVE_NONE = 'keep_alive_none'
const	KEEP_ALIVE_OPTIONAL = 'keep_alive_optional'

Защищенные члены
	getActualConfiguration (Context $context)

Подробное описание

См. определение в файле mailer.php строка 20

Методы

checkConnect()

checkConnect ( Context $context, \Bitrix\Main\ErrorCollection $errors )

static

Returns true if Login, Password and Server parameters is right Returns false if any errors in connection was detected

Аргументы

Context	$context
\Bitrix\Main\ErrorCollection	$errors

Возвращает

bool

Исключения

PHPMailer\PHPMailer\Exception

См. определение в файле mailer.php строка 332

closeConnections()

closeConnections ( )

static

Closes all instances connections

См. определение в файле mailer.php строка 398

getActualConfiguration()

getActualConfiguration ( Context $context )

protected

См. определение в файле mailer.php строка 35

getInstance()

getInstance ( Context $context )

static

Returns instance of current class

Аргументы

Context

$context

Возвращает

Mailer|null

Исключения

Bitrix\Main\ArgumentException

Исключения

PHPMailer\PHPMailer\Exception

См. определение в файле mailer.php строка 283

prepareConfiguration()

prepareConfiguration

(

Context

$context

)

Prepare PHPMailer configuration from bitrix/.settings.php

Аргументы

array | null

$configuration

Возвращает

bool

См. определение в файле mailer.php строка 62

sendMailBySmtp()

sendMailBySmtp	(	string	$sourceTo,
		string	$subject,
		string	$message,
		string	$additional_headers,
		string	$additional_parameters )

Send mail via smtp connection

Аргументы

string	$to
string	$subject
string	$message
string	$additional_headers
string	$additional_parameters

Возвращает

bool

Исключения

PHPMailer\PHPMailer\Exception

См. определение в файле mailer.php строка 155

setMIMEBody()

setMIMEBody

(

$body

)

Set prepared MIME body data

Аргументы

$body

См. определение в файле mailer.php строка 130

setMIMEHeader()

setMIMEHeader

(

$headers

)

Set prepared MIME header

Аргументы

$headers

См. определение в файле mailer.php строка 139

Поля

KEEP_ALIVE_ALWAYS

const KEEP_ALIVE_ALWAYS = 'keep_alive_always'

См. определение в файле mailer.php строка 26

KEEP_ALIVE_NONE

const KEEP_ALIVE_NONE = 'keep_alive_none'

См. определение в файле mailer.php строка 27

KEEP_ALIVE_OPTIONAL

const KEEP_ALIVE_OPTIONAL = 'keep_alive_optional'

См. определение в файле mailer.php строка 28

---

Объявления и описания членов класса находятся в файле:

• C:/bitrix/modules/main/lib/mail/smtp/mailer.php