Class yii\symfonymailer\Message

Inheritanceyii\symfonymailer\Message » yii\mail\BaseMessage
Source Code https://github.com/yiisoft/yii2-symfonymailer/blob/master/src/Message.php

Public Methods

Hide inherited methods

Method Description Defined By
__clone() yii\symfonymailer\Message
__construct() yii\symfonymailer\Message
addHeader() yii\symfonymailer\Message
attach() yii\symfonymailer\Message
attachContent() yii\symfonymailer\Message
embed() yii\symfonymailer\Message
embedContent() yii\symfonymailer\Message
getBcc() yii\symfonymailer\Message
getCc() yii\symfonymailer\Message
getCharset() yii\symfonymailer\Message
getDate() yii\symfonymailer\Message
getFrom() yii\symfonymailer\Message
getHeader() yii\symfonymailer\Message
getHtmlBody() yii\symfonymailer\Message
getPriority() yii\symfonymailer\Message
getReplyTo() yii\symfonymailer\Message
getReturnPath() yii\symfonymailer\Message
getSender() yii\symfonymailer\Message
getSubject() yii\symfonymailer\Message
getSymfonyEmail() Returns a Symfony email instance. yii\symfonymailer\Message
getTextBody() yii\symfonymailer\Message
getTo() yii\symfonymailer\Message
setBcc() yii\symfonymailer\Message
setCc() yii\symfonymailer\Message
setCharset() yii\symfonymailer\Message
setDate() yii\symfonymailer\Message
setFrom() yii\symfonymailer\Message
setHeader() yii\symfonymailer\Message
setHeaders() yii\symfonymailer\Message
setHtmlBody() yii\symfonymailer\Message
setPriority() yii\symfonymailer\Message
setReplyTo() yii\symfonymailer\Message
setReturnPath() yii\symfonymailer\Message
setSender() yii\symfonymailer\Message
setSubject() yii\symfonymailer\Message
setTextBody() yii\symfonymailer\Message
setTo() yii\symfonymailer\Message
toString() yii\symfonymailer\Message

Method Details

Hide inherited methods

__clone() public method

public mixed __clone ( )

                public function __clone()
{
    $this->email = clone $this->email;
}

            
__construct() public method

public mixed __construct ( mixed $config = [] )
$config mixed

                public function __construct($config = [])
{
    $this->email = new Email();
    parent::__construct($config);        
}

            
addHeader() public method

public self addHeader ( mixed $name, mixed $value )
$name mixed
$value mixed

                public function addHeader($name, $value): self
{
    $this->email->getHeaders()->addTextHeader($name, $value);
    return $this;
}

            
attach() public method

public attach ( mixed $fileName, array $options = [] )
$fileName mixed
$options array

                public function attach($fileName, array $options = [])
{
    $file = [];
    if (!empty($options['fileName'])) {
        $file['name'] = $options['fileName'];
    } else {
        $file['name'] = $fileName;
    }
    if (!empty($options['contentType'])) {
        $file['contentType'] = $options['contentType'];
    } else {
        $file['contentType'] = mime_content_type($fileName);
    }
    $this->email->attachFromPath($fileName, $file['name'], $file['contentType']);
    return $this;
}

            
attachContent() public method

public attachContent ( mixed $content, array $options = [] )
$content mixed
$options array

                public function attachContent($content, array $options = [])
{
    $file = [];
    if (!empty($options['fileName'])) {
        $file['name'] = $options['fileName'];
    } else {
        $file['name'] = null;
    }
    if (!empty($options['contentType'])) {
        $file['contentType'] = $options['contentType'];
    } else {
        $file['contentType'] = null;
    }
    $this->email->attach($content, $file['name'], $file['contentType']);
    return $this;
}

            
embed() public method

public embed ( mixed $fileName, array $options = [] )
$fileName mixed
$options array

                public function embed($fileName, array $options = [])
{
    $file = [];
    if (!empty($options['fileName'])) {
        $file['name'] = $options['fileName'];
    } else {
        $file['name'] = $fileName;
    }
    if (!empty($options['contentType'])) {
        $file['contentType'] = $options['contentType'];
    } else {
        $file['contentType'] = mime_content_type($fileName);
    }
    $this->email->embedFromPath($fileName, $file['name'], $file['contentType']);
    return 'cid:' . $file['name'];
}

            
embedContent() public method

public embedContent ( mixed $content, array $options = [] )
$content mixed
$options array

                public function embedContent($content, array $options = [])
{
    $file = [];
    if (!empty($options['fileName'])) {
        $file['name'] = $options['fileName'];
    } else {
        $file['name'] = null;
    }
    if (!empty($options['contentType'])) {
        $file['contentType'] = $options['contentType'];
    } else {
        $file['contentType'] = null;
    }
    $this->email->embed($content, $file['name'], $file['contentType']);
    return 'cid:' . $file['name'];
}

            
getBcc() public method

public mixed getBcc ( )

                public function getBcc()
{
    return $this->convertAddressesToStrings($this->email->getBcc());
}

            
getCc() public method

public mixed getCc ( )

                public function getCc()
{
    return $this->convertAddressesToStrings($this->email->getCc());
}

            
getCharset() public method

public string getCharset ( )

                public function getCharset(): string
{
    return $this->charset;
}

            
getDate() public method

public ?\DateTimeImmutable getDate ( )

                public function getDate(): ?DateTimeImmutable
{
    return $this->email->getDate();
}

            
getFrom() public method

public mixed getFrom ( )

                public function getFrom()
{
    return $this->convertAddressesToStrings($this->email->getFrom());
}

            
getHeader() public method

public array getHeader ( mixed $name )
$name mixed

                public function getHeader($name): array
{
    $headers = $this->email->getHeaders();
    if (!$headers->has($name)) {
        return [];
    }
    $values = [];
    /** @var HeaderInterface $header */
    foreach ($headers->all($name) as $header) {
        $values[] = $header->getBodyAsString();
    }
    return $values;
}

            
getHtmlBody() public method

public string getHtmlBody ( )

                public function getHtmlBody(): string
{
    return (string) $this->email->getHtmlBody();
}

            
getPriority() public method

public integer getPriority ( )

                public function getPriority(): int
{
    return $this->email->getPriority();
}

            
getReplyTo() public method

public mixed getReplyTo ( )

                public function getReplyTo()
{
    return $this->convertAddressesToStrings($this->email->getReplyTo());
}

            
getReturnPath() public method

public string getReturnPath ( )

                public function getReturnPath(): string
{
    $returnPath = $this->email->getReturnPath();
    return $returnPath === null ? '' : $returnPath->getAddress();
}

            
getSender() public method

public string getSender ( )

                public function getSender(): string
{
    $sender = $this->email->getSender();
    return $sender === null ? '' : $sender->getAddress();
}

            
getSubject() public method

public string getSubject ( )

                public function getSubject(): string
{
    return (string) $this->email->getSubject();
}

            
getSymfonyEmail() public method

Returns a Symfony email instance.

public \Symfony\Component\Mime\Email getSymfonyEmail ( )
return \Symfony\Component\Mime\Email

Symfony email instance.

                public function getSymfonyEmail(): Email
{
    return $this->email;
}

            
getTextBody() public method

public string getTextBody ( )

                public function getTextBody(): string
{
    return (string) $this->email->getTextBody();
}

            
getTo() public method

public mixed getTo ( )

                public function getTo()
{
    return $this->convertAddressesToStrings($this->email->getTo());
}

            
setBcc() public method

public self setBcc ( mixed $bcc )
$bcc mixed

                public function setBcc($bcc): self
{
    $this->email->bcc(...$this->convertStringsToAddresses($bcc));
    return $this;
}

            
setCc() public method

public self setCc ( mixed $cc )
$cc mixed

                public function setCc($cc): self
{
    $this->email->cc(...$this->convertStringsToAddresses($cc));
    return $this;
}

            
setCharset() public method

public self setCharset ( mixed $charset )
$charset mixed

                public function setCharset($charset): self
{
    $this->charset = $charset;
    return $this;
}

            
setDate() public method

public self setDate ( DateTimeInterface $date )
$date DateTimeInterface

                public function setDate(DateTimeInterface $date): self
{
    $this->email->date($date);
    return $this;
}

            
setFrom() public method

public self setFrom ( mixed $from )
$from mixed

                public function setFrom($from): self
{
    $this->email->from(...$this->convertStringsToAddresses($from));
    return $this;
}

            
setHeader() public method

public self setHeader ( mixed $name, mixed $value )
$name mixed
$value mixed

                public function setHeader($name, $value): self
{
    $headers = $this->email->getHeaders();
    if ($headers->has($name)) {
        $headers->remove($name);
    }
    foreach ((array) $value as $v) {
        $headers->addTextHeader($name, $v);
    }
    return $this;
}

            
setHeaders() public method

public self setHeaders ( mixed $headers )
$headers mixed

                public function setHeaders($headers): self
{
    foreach ($headers as $name => $value) {
        $this->setHeader($name, $value);
    }
    return $this;
}

            
setHtmlBody() public method

public self setHtmlBody ( mixed $html )
$html mixed

                public function setHtmlBody($html): self
{
    $this->email->html($html, $this->charset);
    return $this;
}

            
setPriority() public method

public self setPriority ( integer $priority )
$priority integer

                public function setPriority(int $priority): self
{
    $this->email->priority($priority);
    return $this;
}

            
setReplyTo() public method

public self setReplyTo ( mixed $replyTo )
$replyTo mixed

                public function setReplyTo($replyTo): self
{
    $this->email->replyTo(...$this->convertStringsToAddresses($replyTo));
    return $this;
}

            
setReturnPath() public method

public self setReturnPath ( string $address )
$address string

                public function setReturnPath(string $address): self
{
    $this->email->returnPath($address);
    return $this;
}

            
setSender() public method

public self setSender ( string $address )
$address string

                public function setSender(string $address): self
{
    $this->email->sender($address);
    return $this;
}

            
setSubject() public method

public self setSubject ( mixed $subject )
$subject mixed

                public function setSubject($subject): self
{
    $this->email->subject($subject);
    return $this;
}

            
setTextBody() public method

public self setTextBody ( mixed $text )
$text mixed

                public function setTextBody($text): self
{
    $this->email->text($text, $this->charset);
    return $this;
}

            
setTo() public method

public self setTo ( mixed $to )
$to mixed

                public function setTo($to): self
{
    $this->email->to(...$this->convertStringsToAddresses($to));
    return $this;
}

            
toString() public method

public string toString ( )

                public function toString(): string
{
    return $this->email->toString();
}