PHP Class Jyxo\Mail\Email

Author: Jaroslav Hanslík
Inheritance: extends Jyxo\Spl\Object
Datei anzeigen Open project: jyxo/php Class Usage Examples

Public Methods

Method Description
addAttachment ( Attachment $attachment ) : self Adds an attachment.
addBcc ( Address $bcc ) : self Adds a blind carbon copy recipient.
addCc ( Address $cc ) : self Adds a carbon copy recipient.
addHeader ( Header $header ) : self Adds a custom header.
addReplyTo ( Address $replyTo ) : self Adds a 'ReplyTo' address.
addTo ( Address $to ) : self Adds a recipient.
getAttachments ( ) : array Returns attachments.
getBcc ( ) : array Returns list of blind carbon copy recipients.
getBody ( ) : Body Returns message body.
getCc ( ) : array Returns list of carbon copy recipients.
getConfirmReadingTo ( ) : Address | null Returns a reading confirmation address.
getFrom ( ) : Address | null Returns sender address.
getHeaders ( ) : array Returns custom headers.
getInReplyTo ( ) : string Returns Id of the message this is a response to.
getPriority ( ) : integer Returns message priority.
getReferences ( ) : array Returns references to previous messages in the thread.
getReplyTo ( ) : array Returns the 'ReplyTo' address.
getSubject ( ) : string Returns subject.
getTo ( ) : array Returns list of message recipients.
hasInlineAttachments ( ) : boolean Checks if the message contains any attachments.
setBody ( Body $body ) : self Sets message body.
setConfirmReadingTo ( Address $confirmReadingTo ) : self Sets a reading confirmation address.
setFrom ( Address $from ) : self Sets sender address.
setInReplyTo ( string $inReplyTo, array $references = [] ) : self Sets Id of the message this is a response to.
setPriority ( integer $priority ) : self Sets message priority.
setSubject ( string $subject ) : self Sets subject.

Method Details

addAttachment() public method

Adds an attachment.
public addAttachment ( Attachment $attachment ) : self
$attachment Jyxo\Mail\Email\Attachment Attachment
return self

addBcc() public method

Adds a blind carbon copy recipient.
public addBcc ( Address $bcc ) : self
$bcc Jyxo\Mail\Email\Address New recipient
return self

addCc() public method

Adds a carbon copy recipient.
public addCc ( Address $cc ) : self
$cc Jyxo\Mail\Email\Address New recipient
return self

addHeader() public method

Adds a custom header.
public addHeader ( Header $header ) : self
$header Jyxo\Mail\Email\Header Header
return self

addReplyTo() public method

Adds a 'ReplyTo' address.
public addReplyTo ( Address $replyTo ) : self
$replyTo Jyxo\Mail\Email\Address
return self

addTo() public method

Adds a recipient.
public addTo ( Address $to ) : self
$to Jyxo\Mail\Email\Address New recipient
return self

getAttachments() public method

Returns attachments.
public getAttachments ( ) : array
return array

getBcc() public method

Returns list of blind carbon copy recipients.
public getBcc ( ) : array
return array

getBody() public method

Returns message body.
public getBody ( ) : Body
return Jyxo\Mail\Email\Body

getCc() public method

Returns list of carbon copy recipients.
public getCc ( ) : array
return array

getConfirmReadingTo() public method

Returns a reading confirmation address.
public getConfirmReadingTo ( ) : Address | null
return Jyxo\Mail\Email\Address | null

getFrom() public method

Returns sender address.
public getFrom ( ) : Address | null
return Jyxo\Mail\Email\Address | null

getHeaders() public method

Returns custom headers.
public getHeaders ( ) : array
return array

getInReplyTo() public method

Returns Id of the message this is a response to.
public getInReplyTo ( ) : string
return string

getPriority() public method

Returns message priority.
public getPriority ( ) : integer
return integer

getReferences() public method

Returns references to previous messages in the thread.
public getReferences ( ) : array
return array

getReplyTo() public method

Returns the 'ReplyTo' address.
public getReplyTo ( ) : array
return array

getSubject() public method

Returns subject.
public getSubject ( ) : string
return string

getTo() public method

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

hasInlineAttachments() public method

Checks if the message contains any attachments.
public hasInlineAttachments ( ) : boolean
return boolean

setBody() public method

Sets message body.
public setBody ( Body $body ) : self
$body Jyxo\Mail\Email\Body Body
return self

setConfirmReadingTo() public method

Sets a reading confirmation address.
public setConfirmReadingTo ( Address $confirmReadingTo ) : self
$confirmReadingTo Jyxo\Mail\Email\Address Confirmation recipient
return self

setFrom() public method

Sets sender address.
public setFrom ( Address $from ) : self
$from Jyxo\Mail\Email\Address Message sender
return self

setInReplyTo() public method

Sets Id of the message this is a response to.
public setInReplyTo ( string $inReplyTo, array $references = [] ) : self
$inReplyTo string Message Id
$references array Previous mail references
return self

setPriority() public method

Sets message priority.
public setPriority ( integer $priority ) : self
$priority integer Priority
return self

setSubject() public method

Sets subject.
public setSubject ( string $subject ) : self
$subject string Subject
return self