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

Открытые члены
	__construct (array $mailParams)
	canSend ()
	initSettings ()
	setAdditionalParameters ($additionalParameters='')
	setBody ($bodyPart)
	hasAttachment ()
	hasImageAttachment ($checkRelated=false)
	setAttachment ()
	setHeaders (array $headers)
	setSubject ($subject)
	setTo ($to)
	getBody ()
	getHeaders ()
	getMessageId ()
	getSubject ()
	getTo ()
	getAdditionalParameters ()
	getContext ()
	dump ()
	replaceImages ($text)
	replaceHrefs ($text)
	trackClick ($matches)

Открытые статические члены
static	createInstance (array $mailParams)
static	send ($mailParams)
static	is8Bit ($inputString)
static	encodeMimeString ($text, $charset)
static	encodeSubject ($text, $charset)
static	encodeHeaderFrom ($text, $charset)
static	getMailEol ()
static	toPunycode ($to)

Защищенные члены
	getReplacedImageCid ($matches)
	getReplacedImageSrc ($matches)
	imageTypeToMimeType ($type)
	addMessageIdToBody ($body, $isHtml, $messageId)
	filterHeaderEmails (array &$headers)

Статические защищенные данные
static	$emailHeaders = ['to', 'cc', 'bcc']

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

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

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

◆ __construct()

__construct ( array $mailParams )

Mail constructor.

Аргументы

array $mailParams Mail parameters.

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

Методы

◆ addMessageIdToBody()

addMessageIdToBody	(	$body,
		$isHtml,
		$messageId )

protected

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

◆ canSend()

canSend ( )

Return true if mail can be sent.

Возвращает: bool

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

◆ createInstance()

createInstance ( array $mailParams )

static

Create instance.

Аргументы

array $mailParams Mail parameters.

Возвращает: static

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

◆ dump()

dump ( )

Dump email data.

Возвращает: string

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

◆ encodeHeaderFrom()

encodeHeaderFrom	(		$text,
			$charset )

static

Encode header From.

Аргументы

string	$text	Text string.
string	$charset	Charset.

Возвращает: string

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

◆ encodeMimeString()

encodeMimeString	(		$text,
			$charset )

static

Encode mime string.

Аргументы

string	$text	Text string.
string	$charset	Charset.

Возвращает: string

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

◆ encodeSubject()

encodeSubject	(		$text,
			$charset )

static

Encode subject.

Аргументы

string	$text	Text string.
string	$charset	Charset.

Возвращает: string

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

◆ filterHeaderEmails()

filterHeaderEmails ( array & $headers )

protected

Filter header emails by blacklist.

Аргументы

array &$headers Headers. return void

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

◆ getAdditionalParameters()

getAdditionalParameters ( )

Get additional parameters.

Возвращает: mixed

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

◆ getBody()

getBody ( )

Get body.

Возвращает: string

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

◆ getContext()

getContext ( )

Get context instance.

Возвращает: Context|null

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

◆ getHeaders()

getHeaders ( )

Get headers.

Возвращает: string

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

◆ getMailEol()

getMailEol ( )

static

Get symbol of mail End-Of-Line.

Возвращает: string

Переопределяется в DummyMail.

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

◆ getMessageId()

getMessageId ( )

Get message ID.

Возвращает: string

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

◆ getReplacedImageCid()

getReplacedImageCid ( $matches )

protected

Аргументы

$matches

Возвращает: string

Исключения

Bitrix\Main\IO\FileNotFoundException

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

◆ getReplacedImageSrc()

getReplacedImageSrc ( $matches )

protected

Аргументы

$matches

Возвращает: string

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

◆ getSubject()

getSubject ( )

Get subject.

Возвращает: string

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

◆ getTo()

getTo ( )

Get to.

Возвращает: string

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

◆ hasAttachment()

hasAttachment ( )

Return true if mail has attachment.

Возвращает: bool

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

◆ hasImageAttachment()

hasImageAttachment ( $checkRelated = false )

Return true if mail has image attachment.

Аргументы

bool $checkRelated Check image as related.

Возвращает: bool

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

◆ imageTypeToMimeType()

imageTypeToMimeType ( $type )

protected

Аргументы

$type

Возвращает: string

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

◆ initSettings()

initSettings ( )

Init settings.

Возвращает: void

Переопределяется в DummyMail.

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

◆ is8Bit()

is8Bit ( $inputString )

static

Return true if input string is in 8bit charset.

Аргументы

string $inputString Input string.

Возвращает: bool

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

◆ replaceHrefs()

replaceHrefs ( $text )

Replace href attribute in links. All href of links in html will be added by protocol and domain.

Аргументы

string $text Text.

Возвращает: mixed

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

◆ replaceImages()

replaceImages ( $text )

Replace images. All src of images in html will be added by protocol and domain.

Аргументы

string $text Html text.

Возвращает: string

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

◆ send()

send ( $mailParams )

static

Send email.

Аргументы

array $mailParams Mail parameters.

Возвращает: bool

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

◆ setAdditionalParameters()

setAdditionalParameters ( $additionalParameters = '' )

Set additional parameters.

Аргументы

string $additionalParameters Additional parameters.

Возвращает: void

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

◆ setAttachment()

setAttachment ( )

Set attachment.

Возвращает: void

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

◆ setBody()

setBody ( $bodyPart )

Set body.

Аргументы

string $bodyPart Html or text of body.

Возвращает: void

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

◆ setHeaders()

setHeaders ( array $headers )

Set headers.

Аргументы

array $headers Headers.

Возвращает: $this

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

◆ setSubject()

setSubject ( $subject )

Set subject.

Аргументы

string $subject Subject.

Возвращает: $this

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

◆ setTo()

setTo ( $to )

Set to.

Аргументы

string $to To.

Возвращает: $this

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

◆ toPunycode()

toPunycode ( $to )

static

Converts an international domain in the email to Punycode.

Аргументы

string $to Email address, possibly with a comment

Возвращает: string

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

◆ trackClick()

trackClick ( $matches )

Track click. All href of links in html will be wrapped by tracking url for click-detecting.

Аргументы

array $matches Result of preg_match call.

Возвращает: string

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

Поля

◆ $additionalParameters

$additionalParameters

protected

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

◆ $attachment

$attachment

protected

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

◆ $bitrixDirectory

$bitrixDirectory

protected

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

◆ $blacklistCheckedEmails

$blacklistCheckedEmails = []

protected

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

◆ $blacklistedEmails

$blacklistedEmails = []

protected

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

◆ $body

$body

protected

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

◆ $charset

$charset

protected

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

◆ $contentTransferEncoding

$contentTransferEncoding = '8bit'

protected

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

◆ $contentType

$contentType

protected

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

◆ $context

$context

protected

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

◆ $emailHeaders

$emailHeaders = ['to', 'cc', 'bcc']

staticprotected

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

◆ $eol

$eol

protected

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

◆ $filesReplacedFromBody

$filesReplacedFromBody

protected

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

◆ $generateTextVersion

$generateTextVersion

protected

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

◆ $headers

$headers = []

protected

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

◆ $messageId

$messageId

protected

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

◆ $multipart

$multipart

protected

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

◆ $multipartRelated

$multipartRelated

protected

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

◆ $settingAttachImages

$settingAttachImages

protected

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

◆ $settingConvertNewLineUnixToWindows

$settingConvertNewLineUnixToWindows

protected

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

◆ $settingMailAdditionalParameters

$settingMailAdditionalParameters

protected

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

◆ $settingMailAddMessageId

$settingMailAddMessageId

protected

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

◆ $settingMailConvertMailHeader

$settingMailConvertMailHeader

protected

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

◆ $settingMailEncodeBase64

$settingMailEncodeBase64

protected

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

◆ $settingMailEncodeQuotedPrintable

$settingMailEncodeQuotedPrintable

protected

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

◆ $settingMailFillToEmail

$settingMailFillToEmail

protected

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

◆ $settingMaxFileSize

$settingMaxFileSize

protected

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

◆ $settingServerMsSmtp

$settingServerMsSmtp

protected

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

◆ $settingServerName

$settingServerName

protected

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

◆ $subject

$subject

protected

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

◆ $to

$to

protected

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

◆ $trackClickAvailable

$trackClickAvailable

protected

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

◆ $trackClickLink

$trackClickLink

protected

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

◆ $trackClickUrlParams

$trackClickUrlParams

protected

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

◆ $trackLinkProtocol

$trackLinkProtocol

protected

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

◆ $trackReadAvailable

$trackReadAvailable

protected

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

◆ $trackReadLink

$trackReadLink

protected

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

◆ $useBlacklist

$useBlacklist = true

protected

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

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

C:/bitrix/modules/main/lib/mail/mail.php

Защищенные данные
	$settingServerMsSmtp
	$settingMailFillToEmail
	$settingMailConvertMailHeader
	$settingMailAddMessageId
	$settingConvertNewLineUnixToWindows
	$settingMailAdditionalParameters
	$settingMaxFileSize
	$settingAttachImages
	$settingServerName
	$settingMailEncodeBase64
	$settingMailEncodeQuotedPrintable
	$eol
	$attachment
	$generateTextVersion
	$charset
	$contentType
	$messageId
	$filesReplacedFromBody
	$trackLinkProtocol
	$trackReadLink
	$trackClickLink
	$trackClickUrlParams
	$bitrixDirectory
	$trackReadAvailable
	$trackClickAvailable
	$contentTransferEncoding = '8bit'
	$to
	$subject
	$headers = []
	$body
	$additionalParameters
	$context
	$multipart
	$multipartRelated
	$blacklistedEmails = []
	$blacklistCheckedEmails = []
	$useBlacklist = true

Открытые члены

Открытые статические члены

Защищенные члены

Защищенные данные

Статические защищенные данные

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

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

◆ __construct()

Методы

◆ addMessageIdToBody()

◆ canSend()

◆ createInstance()

◆ dump()

◆ encodeHeaderFrom()

◆ encodeMimeString()

◆ encodeSubject()

◆ filterHeaderEmails()

◆ getAdditionalParameters()

◆ getBody()

◆ getContext()

◆ getHeaders()

◆ getMailEol()

◆ getMessageId()

◆ getReplacedImageCid()

◆ getReplacedImageSrc()

◆ getSubject()

◆ getTo()

◆ hasAttachment()

◆ hasImageAttachment()

◆ imageTypeToMimeType()

◆ initSettings()

◆ is8Bit()

◆ replaceHrefs()

◆ replaceImages()

◆ send()

◆ setAdditionalParameters()

◆ setAttachment()

◆ setBody()

◆ setHeaders()

◆ setSubject()

◆ setTo()

◆ toPunycode()

◆ trackClick()

Поля

◆ $additionalParameters

◆ $attachment

◆ $bitrixDirectory

◆ $blacklistCheckedEmails

◆ $blacklistedEmails

◆ $body

◆ $charset

◆ $contentTransferEncoding

◆ $contentType

◆ $context

◆ $emailHeaders

◆ $eol

◆ $filesReplacedFromBody

◆ $generateTextVersion

◆ $headers

◆ $messageId

◆ $multipart

◆ $multipartRelated

◆ $settingAttachImages

◆ $settingConvertNewLineUnixToWindows

◆ $settingMailAdditionalParameters

◆ $settingMailAddMessageId

◆ $settingMailConvertMailHeader

◆ $settingMailEncodeBase64

◆ $settingMailEncodeQuotedPrintable

◆ $settingMailFillToEmail

◆ $settingMaxFileSize

◆ $settingServerMsSmtp

◆ $settingServerName

◆ $subject

◆ $to

◆ $trackClickAvailable

◆ $trackClickLink

◆ $trackClickUrlParams

◆ $trackLinkProtocol

◆ $trackReadAvailable