Class yii\symfonymailer\Message

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

Psalm Types

Name Value
PsalmFileOptions array{fileName?: string, contentType?: string}
PsalmAddressList array<integer|string, string>|string

Public Properties

Hide inherited properties

Property Type Description Defined By
$bcc PsalmAddressList The type defined by the message interface is not strict enough. yii\symfonymailer\Message
$symfonyEmail \Symfony\Component\Mime\Email Symfony email instance. yii\symfonymailer\Message

Public Methods

Hide inherited methods

Method Description Defined By
__clone() yii\symfonymailer\Message
__construct() yii\symfonymailer\Message
__sleep() 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
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
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

Property Details

Hide inherited properties

$bcc public property

The type defined by the message interface is not strict enough.

public PsalmAddressList $bcc null
$symfonyEmail public property

Symfony email instance.

public \Symfony\Component\Mime\Email $symfonyEmail null

Method Details

Hide inherited methods

__clone() public method

public __clone( ): mixed

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

            
__construct() public method

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

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

            
__sleep() public method

public __sleep( ): array

                public function __sleep(): array
{
    return ['email', 'charset'];
}

            
addHeader() public method

public addHeader( string $name, string $value ): self
$name string
$value string

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

            
attach() public method

public attach( string $fileName, PsalmFileOptions $options = [] ): $this
$fileName string
$options PsalmFileOptions

                public function attach($fileName, array $options = []): self
{
    $this->email->attachFromPath(
        $fileName,
        $options['fileName'] ?? $fileName,
        $options['contentType'] ?? FileHelper::getMimeType($fileName)
    );
    return $this;
}

            
attachContent() public method

public attachContent( resource|string $content, PsalmFileOptions $options = [] ): $this
$content resource|string
$options PsalmFileOptions

                public function attachContent($content, array $options = []): self
{
    $this->email->attach($content, $options['fileName'] ?? null, $options['contentType'] ?? null);
    return $this;
}

            
embed() public method

public embed( string $fileName, PsalmFileOptions $options = [] ): string
$fileName string
$options PsalmFileOptions

                public function embed($fileName, array $options = []): string
{
    $name = $options['fileName'] ?? $fileName;
    $this->email->embedFromPath(
        $fileName,
        $name,
        $options['contentType'] ?? FileHelper::getMimeType($fileName)
    );
    return 'cid:' . $name;
}

            
embedContent() public method

public embedContent( resource|string $content, PsalmFileOptions $options = [] ): string
$content resource|string
$options PsalmFileOptions

                public function embedContent($content, array $options = []): string
{
    if (empty($options['fileName'])) {
        throw new InvalidConfigException('A valid file name must be passed when embedding content');
    }
    $this->email->embed($content, $options['fileName'], $options['contentType'] ?? null);
    return 'cid:' . $options['fileName'];
}

            
getBcc() public method

public getBcc( ): mixed

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

            
getCc() public method

public getCc( ): mixed

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

            
getCharset() public method

public getCharset( ): string

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

            
getDate() public method

public getDate( ): DateTimeImmutable|null

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

            
getFrom() public method

public getFrom( ): mixed

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

            
getHeader() public method

public getHeader( string $name ): array
$name string

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

            
getPriority() public method

public getPriority( ): integer

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

            
getReplyTo() public method

public getReplyTo( ): mixed

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

            
getReturnPath() public method

public getReturnPath( ): string

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

            
getSender() public method

public getSender( ): string

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

            
getSubject() public method

public getSubject( ): string

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

            
getSymfonyEmail() public method

Returns a Symfony email instance.

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

Symfony email instance.

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

            
getTo() public method

public getTo( ): mixed

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

            
setBcc() public method

public setBcc( PsalmAddressList $bcc ): $this
$bcc PsalmAddressList

The type defined by the message interface is not strict enough

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

            
setCc() public method

public setCc( PsalmAddressList $cc ): $this
$cc PsalmAddressList

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

            
setCharset() public method

public setCharset( mixed $charset ): self
$charset mixed

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

            
setDate() public method

public setDate( DateTimeInterface $date ): self
$date DateTimeInterface

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

            
setFrom() public method

public setFrom( array<integer|string, string>|string $from ): self
$from array<integer|string, string>|string

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

            
setHeader() public method

public setHeader( string $name, string|list<string> $value ): self
$name string
$value string|list<string>

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

            
setHeaders() public method

public setHeaders( array<string, string|list<string>> $headers ): $this
$headers array<string, string|list<string>>

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

            
setHtmlBody() public method

public setHtmlBody( mixed $html ): self
$html mixed

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

            
setPriority() public method

public setPriority( integer $priority ): self
$priority integer

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

            
setReplyTo() public method

public setReplyTo( PsalmAddressList $replyTo ): $this
$replyTo PsalmAddressList

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

            
setReturnPath() public method

public setReturnPath( string $address ): self
$address string

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

            
setSender() public method

public setSender( string $address ): self
$address string

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

            
setSubject() public method

public setSubject( mixed $subject ): self
$subject mixed

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

            
setTextBody() public method

public setTextBody( mixed $text ): self
$text mixed

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

            
setTo() public method

public setTo( PsalmAddressList $to ): $this
$to PsalmAddressList

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

            
toString() public method

public toString( ): string

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