Message Class Reference

Inheritance diagram for Message:

Public Member Functions
	__construct ($charset='utf-8')
	setMessageType ($type)
	setBody ($body)
	setSubject ($subject)
	getSubject ()
	getBody ()
	setFrom ($fromAddress)
	addTo ($toAddress)
	addCc ($ccAddress)
	addBcc ($bccAddress)
	setReplyTo ($replyToAddress)
	getRawMessage ()
	setBodyHtml ($html)
	setBodyText ($text)

Additional Inherited Members
Data Fields inherited from MessageInterface
const	TYPE_TEXT = 'text/plain'
const	TYPE_HTML = 'text/html'

Detailed Description

Definition at line 11 of file Message.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$charset = 'utf-8'

)

Initialize dependencies.

Parameters

string

$charset

Definition at line 30 of file Message.php.

    {
        $this->zendMessage = new \Zend\Mail\Message();
        $this->zendMessage->setEncoding($charset);
    }

Member Function Documentation

addBcc()

addBcc

(

$bccAddress

)

{Add bcc address

Parameters

string | array

$bccAddress

Returns

$this

}

Implements MessageInterface.

Definition at line 120 of file Message.php.

    {
        $this->zendMessage->addBcc($bccAddress);
        return $this;
    }

addCc()

addCc

(

$ccAddress

)

{Add cc address

Parameters

string | array

$ccAddress

Returns

$this

}

Implements MessageInterface.

Definition at line 111 of file Message.php.

    {
        $this->zendMessage->addCc($ccAddress);
        return $this;
    }

addTo()

addTo

(

$toAddress

)

{Add to address

Parameters

string | array

$toAddress

Returns

$this

}

Implements MessageInterface.

Definition at line 102 of file Message.php.

    {
        $this->zendMessage->addTo($toAddress);
        return $this;
    }

getBody()

getBody

(

)

{Get message body

Returns

string

}

Implements MessageInterface.

Definition at line 85 of file Message.php.

    {
        return $this->zendMessage->getBody();
    }

getRawMessage()

getRawMessage

(

)

{Get message source code.

Returns

string

}

Implements MailMessageInterface.

Definition at line 138 of file Message.php.

    {
        return $this->zendMessage->toString();
    }

getSubject()

getSubject

(

)

{Get message subject

Returns

string

}

Implements MessageInterface.

Definition at line 77 of file Message.php.

    {
        return $this->zendMessage->getSubject();
    }

setBody()

setBody

(

$body

)

{Set message body

Parameters

mixed

$body

Returns

$this

Deprecated:

See also

\Magento\Framework\Mail\MailMessageInterface::setBodyHtml

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

}

Deprecated:

See also

\Magento\Framework\Mail\Message::setBodyText

\Magento\Framework\Mail\Message::setBodyHtml

Implements MessageInterface.

Definition at line 56 of file Message.php.

    {
        if (is_string($body) && $this->messageType === MailMessageInterface::TYPE_HTML) {
            $body = self::createHtmlMimeFromString($body);
        }
        $this->zendMessage->setBody($body);
        return $this;
    }

setBodyHtml()

setBodyHtml

(

$html

)

{Set mail message body in HTML format.

Parameters

string

$html

Returns

$this

}

Implements MailMessageInterface.

Definition at line 162 of file Message.php.

    {
        $this->setMessageType(self::TYPE_HTML);
        return $this->setBody($html);
    }

setBodyText()

setBodyText

(

$text

)

{Set mail message body in text format.

Parameters

string

$text

Returns

$this

}

Implements MailMessageInterface.

Definition at line 171 of file Message.php.

    {
        $this->setMessageType(self::TYPE_TEXT);
        return $this->setBody($text);
    }

setFrom()

setFrom

(

$fromAddress

)

{Set from address

Parameters

string | array

$fromAddress

Returns

$this

}

Implements MessageInterface.

Definition at line 93 of file Message.php.

    {
        $this->zendMessage->setFrom($fromAddress);
        return $this;
    }

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()

}

Deprecated:

See also

\Magento\Framework\Mail\Message::setBodyText

\Magento\Framework\Mail\Message::setBodyHtml

Implements MessageInterface.

Definition at line 43 of file Message.php.

    {
        $this->messageType = $type;
        return $this;
    }

setReplyTo()

setReplyTo

(

$replyToAddress

)

{Set reply-to address

Parameters

string | array

$replyToAddress

Returns

$this

}

Implements MessageInterface.

Definition at line 129 of file Message.php.

    {
        $this->zendMessage->setReplyTo($replyToAddress);
        return $this;
    }

setSubject()

setSubject

(

$subject

)

{Set message subject

Parameters

string

$subject

Returns

$this

}

Implements MessageInterface.

Definition at line 68 of file Message.php.

    {
        $this->zendMessage->setSubject($subject);
        return $this;
    }

---

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

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