PHP Class Webiny\Component\Mailer\Bridge\Sendgrid\Message

Inheritance: implements Webiny\Component\Mailer\Bridge\MessageInterface, use trait Webiny\Component\StdLib\StdLibTrait
Datei anzeigen Open project: Webiny/Framework

Public Methods

Method Description
__construct ( ConfigObject $config = null )
__invoke ( )
addAttachment ( File $file, string $fileName = '', string $type = 'plain/text' ) Attach a file to your message.
addBcc ( Email $email ) Appends one more address to the blind-copied list.
addCc ( Email $email ) Appends one more address to the copied list.
addHeader ( string $name, string $value, null | array $params = null ) Adds a header to the message.
addTo ( Email $email ) Appends one more recipient to the list.
getBcc ( ) : array Returns a list of defined bcc recipients.
getBody ( ) : string Returns the body of the message.
getCc ( ) : array Returns a list of addresses to whom the message will be copied to.
getContentTransferEncoding ( ) : string Get the defined encoding scheme.
getContentType ( ) : string Returns the defined content type of the message.
getFrom ( ) : Email Returns the person who sent the message.
getHeader ( string $name ) : mixed Get a header from the message.
getHeaders ( ) : array Get all headers from the message.
getReplyTo ( ) : Email | null Returns the reply-to address.
getReturnPath ( ) : string Returns the defined return-path.
getSender ( ) : Email Return the person who sent the message.
getSubject ( ) : string Get the current message subject.
getTo ( ) : array Returns a list of defined recipients.
setBcc ( array | Email $bcc ) Specifies the addresses of recipients who the message will be blind-copied to.
setBody ( string $content, string $type = 'text/html', string $charset = 'utf-8' ) : Webiny\Component\Mailer\MessageInterface Set the message body.
setCc ( array | Email $cc ) Specifies the addresses of recipients who will be copied in on the message.
setContentTransferEncoding ( string $encoding ) Specifies the encoding scheme in the message.
setContentType ( string $contentType ) Specifies the format of the message (usually text/plain or text/html).
setFrom ( Email $from ) Specifies the address of the person who the message is from.
setHeaders ( array | ArrayObject $headers ) Set multiple headers
setReplyTo ( Email $replyTo ) Define the reply-to address.
setReturnPath ( string $returnPath ) Defines the return path for the email.
setSender ( Email $sender ) Specifies the address of the person who physically sent the message.
setSubject ( string $subject ) Set the message subject.
setTo ( array | Email $to ) Specifies the addresses of the intended recipients.

Method Details

__construct() public method

public __construct ( ConfigObject $config = null )
$config Webiny\Component\Config\ConfigObject

__invoke() public method

public __invoke ( )

addAttachment() public method

Attach a file to your message.
public addAttachment ( File $file, string $fileName = '', string $type = 'plain/text' )
$file Webiny\Component\Storage\File\File File instance
$fileName string Optional name that will be set for the attachment.
$type string Optional MIME type of the attachment

addBcc() public method

Appends one more address to the blind-copied list.
public addBcc ( Email $email )
$email Webiny\Component\Mailer\Email

addCc() public method

Appends one more address to the copied list.
public addCc ( Email $email )
$email Webiny\Component\Mailer\Email

addHeader() public method

Adds a header to the message.
public addHeader ( string $name, string $value, null | array $params = null )
$name string Header name.
$value string Header value.
$params null | array Optional array of parameters.

addTo() public method

Appends one more recipient to the list.
public addTo ( Email $email )
$email Webiny\Component\Mailer\Email

getBcc() public method

Returns a list of defined bcc recipients.
public getBcc ( ) : array
return array

getBody() public method

Returns the body of the message.
public getBody ( ) : string
return string

getCc() public method

Returns a list of addresses to whom the message will be copied to.
public getCc ( ) : array
return array

getContentTransferEncoding() public method

Get the defined encoding scheme.
public getContentTransferEncoding ( ) : string
return string

getContentType() public method

Returns the defined content type of the message.
public getContentType ( ) : string
return string

getFrom() public method

Returns the person who sent the message.
public getFrom ( ) : Email
return Webiny\Component\Mailer\Email

getHeader() public method

Get a header from the message.
public getHeader ( string $name ) : mixed
$name string Header name.
return mixed

getHeaders() public method

Get all headers from the message.
public getHeaders ( ) : array
return array

getReplyTo() public method

Returns the reply-to address.
public getReplyTo ( ) : Email | null
return Webiny\Component\Mailer\Email | null

getReturnPath() public method

Returns the defined return-path.
public getReturnPath ( ) : string
return string

getSender() public method

Return the person who sent the message.
public getSender ( ) : Email
return Webiny\Component\Mailer\Email

getSubject() public method

Get the current message subject.
public getSubject ( ) : string
return string Message subject.

getTo() public method

Returns a list of defined recipients.
public getTo ( ) : array
return array

setBcc() public method

Other recipients will not be aware of these copies.
public setBcc ( array | Email $bcc )
$bcc array | Webiny\Component\Mailer\Email

setBody() public method

Set the message body.
public setBody ( string $content, string $type = 'text/html', string $charset = 'utf-8' ) : Webiny\Component\Mailer\MessageInterface
$content string The content of the body.
$type string Content type. Default 'text/html'.
$charset string Content body charset. Default 'utf-8'.
return Webiny\Component\Mailer\MessageInterface

setCc() public method

Specifies the addresses of recipients who will be copied in on the message.
public setCc ( array | Email $cc )
$cc array | Webiny\Component\Mailer\Email

setContentTransferEncoding() public method

Specifies the encoding scheme in the message.
public setContentTransferEncoding ( string $encoding )
$encoding string

setContentType() public method

Specifies the format of the message (usually text/plain or text/html).
public setContentType ( string $contentType )
$contentType string

setFrom() public method

Can be multiple persons/addresses.
public setFrom ( Email $from )
$from Webiny\Component\Mailer\Email

setHeaders() public method

Set multiple headers
public setHeaders ( array | ArrayObject $headers )
$headers array | Webiny\Component\StdLib\StdObject\ArrayObject\ArrayObject

setReplyTo() public method

Define the reply-to address.
public setReplyTo ( Email $replyTo )
$replyTo Webiny\Component\Mailer\Email

setReturnPath() public method

By default it should be set to the sender.
public setReturnPath ( string $returnPath )
$returnPath string

setSender() public method

Higher precedence than "from".
public setSender ( Email $sender )
$sender Webiny\Component\Mailer\Email

setSubject() public method

Set the message subject.
public setSubject ( string $subject )
$subject string Message subject.

setTo() public method

Specifies the addresses of the intended recipients.
public setTo ( array | Email $to )
$to array | Webiny\Component\Mailer\Email A list of recipients.