MessageInterface Interface Reference

Inheritance diagram for MessageInterface:

Public Member Functions
	setSubject ($subject)
	getSubject ()
	setBody ($body)
	getBody ()
	setFrom ($fromAddress)
	addTo ($toAddress)
	addCc ($ccAddress)
	addBcc ($bccAddress)
	setReplyTo ($replyToAddress)
	setMessageType ($type)

Data Fields
const	TYPE_TEXT = 'text/plain'
const	TYPE_HTML = 'text/html'

Detailed Description

Mail Message interface

@api

Deprecated:

in favor of MailMessageInterface to avoid temporal coupling (setMessageType + setBody)

See also

\Magento\Framework\Mail\MailMessageInterface

Since

100.0.2

Definition at line 16 of file MessageInterface.php.

Member Function Documentation

addBcc()

addBcc

(

$bccAddress

)

Add bcc address

Parameters

string | array

$bccAddress

Returns

$this

Implemented in Message.

addCc()

addCc

(

$ccAddress

)

Add cc address

Parameters

string | array

$ccAddress

Returns

$this

Implemented in Message.

addTo()

addTo

(

$toAddress

)

Add to address

Parameters

string | array

$toAddress

Returns

$this

Implemented in Message.

getBody()

getBody

(

)

Get message body

Returns

string

Implemented in Message.

getSubject()

getSubject

(

)

Get message subject

Returns

string

Implemented in Message.

setBody()

setBody

(

$body

)

Set message body

Parameters

mixed

$body

Returns

$this

Deprecated:

See also

\Magento\Framework\Mail\MailMessageInterface::setBodyHtml

\Magento\Framework\Mail\MailMessageInterface::setBodyText()

Implemented in Message.

setFrom()

setFrom

(

$fromAddress

)

Set from address

Parameters

string | array

$fromAddress

Returns

$this

Implemented in Message.

setMessageType()

setMessageType

(

$type

)

Set message type

Parameters

string

$type

Returns

$this

Deprecated:

See also

\Magento\Framework\Mail\MailMessageInterface::setBodyHtml

\Magento\Framework\Mail\MailMessageInterface::getBodyHtml

\Magento\Framework\Mail\MailMessageInterface::setBodyText()

\Magento\Framework\Mail\MailMessageInterface::getBodyText()

Implemented in Message.

setReplyTo()

setReplyTo

(

$replyToAddress

)

Set reply-to address

Parameters

string | array

$replyToAddress

Returns

$this

Implemented in Message.

setSubject()

setSubject

(

$subject

)

Set message subject

Parameters

string

$subject

Returns

$this

Implemented in Message.

Field Documentation

TYPE_HTML

const TYPE_HTML = 'text/html'

Deprecated:

Definition at line 27 of file MessageInterface.php.

TYPE_TEXT

const TYPE_TEXT = 'text/plain'

Types of message

Deprecated:

Definition at line 22 of file MessageInterface.php.

---

The documentation for this interface was generated from the following file:

• vendor/magento/framework/Mail/MessageInterface.php