Documentation

Mail

Table of Contents

$addparams  : string
Additional parameters for sending the mail.
$attachments  : array<string|int, mixed>
Collection of all attachments.
$bcc  : array<string|int, mixed>
Collection of all BCC (Blind Copy Carbon) mail-addresses.
$cc  : array<string|int, mixed>
Collection of all CC (Copy Carbon) mail-addresses.
$contentHTML  : string|HTML
The formatted content (HTML) of the mail.
$contentPlain  : string
The plain content (non HTML) content of the mail.
$receivers  : array<string|int, mixed>
Collection of all receivers.
$replyTo  : string
The mail-address on which should be answered.
$sender  : string
The sender of the mail.
$smtp  : string
Configuration for smtp.
$subject  : string
The subject of the mail.
addAttachment()  : void
For add attachment.
addBcc()  : bool
For add a new BCC.
addCc()  : bool
For adding a new cc.
addReceiver()  : bool
For adding a receiver.
clear()  : void
Clear all the information.
isFile()  : bool
Check file exists or not.
isSMTP()  : bool
Set SMPT status.
isValidEmail()  : bool
Check is email is valid.
prepareAttachment()  : mixed
For preparing an attachment to send with mail.
send()  : mixed
For send the mail.
sendSMTP()  : bool
Send mail over SMTP.
setaddParams()  : void
For set additional parameter for the mail function (4th parameter).
setContentHTML()  : void
For the formatted content (HTML) of the mail.
setContentPlain()  : void
For set the plain content of the mail.
setReplyTo()  : bool
For set reply_to in mail.
setSender()  : bool
For set sender in mail.
setSubject()  : bool
For set subject in mail.

Properties

$addparams

Additional parameters for sending the mail.

private string $addparams = ''
Tags
since
1.9.0

$attachments

Collection of all attachments.

private array<string|int, mixed> $attachments = []
Tags
since
1.9.0

$bcc

Collection of all BCC (Blind Copy Carbon) mail-addresses.

private array<string|int, mixed> $bcc = []
Tags
since
1.9.0

$cc

Collection of all CC (Copy Carbon) mail-addresses.

private array<string|int, mixed> $cc = []
Tags
since
1.9.0

$contentHTML

The formatted content (HTML) of the mail.

private string|HTML $contentHTML = ''
Tags
since
1.9.0

$contentPlain

The plain content (non HTML) content of the mail.

private string $contentPlain = ''
Tags
since
1.9.0

$receivers

Collection of all receivers.

private array<string|int, mixed> $receivers = []
Tags
since
1.9.0

$replyTo

The mail-address on which should be answered.

private string $replyTo = ''
Tags
since
1.9.0

$sender

The sender of the mail.

private string $sender = ''
Tags
since
1.9.0

$smtp

Configuration for smtp.

private string $smtp = []
Tags
since
1.9.0

$subject

The subject of the mail.

private string $subject = ''
Tags
since
1.9.0

Methods

addAttachment()

For add attachment.

public addAttachment(resource $file) : void
Parameters
$file : resource
Tags
since
1.9.0
Return values
void

addBcc()

For add a new BCC.

public addBcc(string $bcc) : bool
Parameters
$bcc : string
Tags
since
1.9.0
Return values
bool

addCc()

For adding a new cc.

public addCc(string $cc) : bool
Parameters
$cc : string
Tags
since
1.9.0
Return values
bool

addReceiver()

For adding a receiver.

public addReceiver(string $email) : bool
Parameters
$email : string
Tags
since
1.9.0
Return values
bool

clear()

Clear all the information.

public clear() : void
Tags
since
1.9.0
Return values
void

isFile()

Check file exists or not.

public isFile() : bool
Tags
since
1.9.0
Return values
bool

isSMTP()

Set SMPT status.

public isSMTP([ $status = false ]) : bool
Parameters
$status : = false
Tags
since
1.9.0
Return values
bool

isValidEmail()

Check is email is valid.

public isValidEmail(string $email) : bool
Parameters
$email : string
Tags
since
1.9.0
Return values
bool

prepareAttachment()

For preparing an attachment to send with mail.

public prepareAttachment(mixed $attachment) : mixed
Parameters
$attachment : mixed
Tags
since
1.9.0
Return values
mixed

send()

For send the mail.

public send() : mixed
Tags
since
1.9.0
Return values
mixed

sendSMTP()

Send mail over SMTP.

public sendSMTP( $to, mixed $from, mixed $message) : bool
Parameters
$to :

sender email $from from email $message message to be send

$from : mixed
$message : mixed
Tags
since
1.9.0
Return values
bool

setaddParams()

For set additional parameter for the mail function (4th parameter).

public setaddParams(mixed $params) : void
Parameters
$params : mixed
Tags
since
1.9.0
Return values
void

setContentHTML()

For the formatted content (HTML) of the mail.

public setContentHTML(string $content) : void
Parameters
$content : string
Tags
since
1.9.0
Return values
void

setContentPlain()

For set the plain content of the mail.

public setContentPlain(string $content) : void
Parameters
$content : string
Tags
since
1.9.0
Return values
void

setReplyTo()

For set reply_to in mail.

public setReplyTo(mixed $email) : bool
Parameters
$email : mixed
Tags
since
1.9.0
Return values
bool

setSender()

For set sender in mail.

public setSender(mixed $email) : bool
Parameters
$email : mixed
Tags
since
1.9.0
Return values
bool

setSubject()

For set subject in mail.

public setSubject(string $subject) : bool
Parameters
$subject : string

The subject of the mail.

Tags
since
1.9.0
Return values
bool

Search results