PHP Класс Pop\Mail\Mail

Автор: Nick Sagona, III ([email protected])
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$attachments array File attachments
$group boolean Send as group flag
$headers array Mail headers
$message Message Message body
$params string Mail parameters
$queue Queue Sending queue
$subject string Subject

Открытые методы

Метод Описание
__construct ( string $subj = null, mixed $rcpts = null ) : Mail Constructor
add ( string $email, string $name = null ) : Mail Add a recipient to the queue
addRecipients ( mixed $rcpts ) : Mail Add recipients to the queue
attachFile ( string $file ) : Mail Attach a file to the mail object.
bcc ( string $email, string $name = null ) : Mail Alias to set the bcc headers
cc ( string $email, string $name = null ) : Mail Alias to set the cc headers
from ( string $email, string $name = null, boolean $replyTo = true ) : Mail Alias to set the from and reply-to headers
getAttachments ( ) : array Get attachments
getBoundary ( ) : string Get MIME boundary
getCharset ( ) : string Get character set
getEol ( ) : string Get EOL
getHeader ( string $name ) : string Get the mail header
getHeaders ( ) : array Get the mail header
getHtml ( ) : string Get HTML part of the message.
getMessage ( ) : Message Get the mail message
getQueue ( ) : Queue Get the mail queue
getSubject ( ) : string Get the subject
getText ( ) : string Get text part of the message.
replyTo ( string $email, string $name = null, boolean $from = true ) : Mail Alias to set the reply-to and from headers
saveTo ( string $to = null, string $format = null ) : Mail Save mail message or messages in a folder to be sent at a later date.
send ( ) : void Send mail message or messages.
sendAsGroup ( boolean $group ) : Mail Set the send as group flag
sendFrom ( string $from = null, boolean $delete = false ) : Mail Send mail message or messages that are saved in a folder.
setBoundary ( string $bnd = null ) : Mail Set MIME boundary
setCharset ( string $chr ) : Mail Set character set
setEol ( string $eol = Mail::CRLF ) : Mail Set EOL
setHeader ( string $name, string $value ) : Mail Set a mail header
setHeaders ( array $headers ) : Mail Set mail headers
setHtml ( string $html ) : Mail Set HTML part of the message.
setParams ( mixed $params = null ) : Mail Set parameters
setSubject ( string $subj ) : Mail Set the subject
setText ( string $text ) : Mail Set text part of the message.
to ( string $email, string $name = null ) : Mail Alias to add a recipient to the queue

Защищенные методы

Метод Описание
buildHeaders ( ) : string Build headers
getEmailFromFile ( string $filename ) : array Get email data from file

Описание методов

__construct() публичный Метод

Instantiate the mail object.
public __construct ( string $subj = null, mixed $rcpts = null ) : Mail
$subj string
$rcpts mixed
Результат Mail

add() публичный Метод

Add a recipient to the queue
public add ( string $email, string $name = null ) : Mail
$email string
$name string
Результат Mail

addRecipients() публичный Метод

Add recipients to the queue
public addRecipients ( mixed $rcpts ) : Mail
$rcpts mixed
Результат Mail

attachFile() публичный Метод

Attach a file to the mail object.
public attachFile ( string $file ) : Mail
$file string
Результат Mail

bcc() публичный Метод

Alias to set the bcc headers
public bcc ( string $email, string $name = null ) : Mail
$email string
$name string
Результат Mail

buildHeaders() защищенный Метод

Build headers
protected buildHeaders ( ) : string
Результат string

cc() публичный Метод

Alias to set the cc headers
public cc ( string $email, string $name = null ) : Mail
$email string
$name string
Результат Mail

from() публичный Метод

Alias to set the from and reply-to headers
public from ( string $email, string $name = null, boolean $replyTo = true ) : Mail
$email string
$name string
$replyTo boolean
Результат Mail

getAttachments() публичный Метод

Get attachments
public getAttachments ( ) : array
Результат array

getBoundary() публичный Метод

Get MIME boundary
public getBoundary ( ) : string
Результат string

getCharset() публичный Метод

Get character set
public getCharset ( ) : string
Результат string

getEmailFromFile() защищенный Метод

Get email data from file
protected getEmailFromFile ( string $filename ) : array
$filename string
Результат array

getEol() публичный Метод

Get EOL
public getEol ( ) : string
Результат string

getHeader() публичный Метод

Get the mail header
public getHeader ( string $name ) : string
$name string
Результат string

getHeaders() публичный Метод

Get the mail header
public getHeaders ( ) : array
Результат array

getHtml() публичный Метод

Get HTML part of the message.
public getHtml ( ) : string
Результат string

getMessage() публичный Метод

Get the mail message
public getMessage ( ) : Message
Результат Message

getQueue() публичный Метод

Get the mail queue
public getQueue ( ) : Queue
Результат Queue

getSubject() публичный Метод

Get the subject
public getSubject ( ) : string
Результат string

getText() публичный Метод

Get text part of the message.
public getText ( ) : string
Результат string

replyTo() публичный Метод

Alias to set the reply-to and from headers
public replyTo ( string $email, string $name = null, boolean $from = true ) : Mail
$email string
$name string
$from boolean
Результат Mail

saveTo() публичный Метод

Save mail message or messages in a folder to be sent at a later date.
public saveTo ( string $to = null, string $format = null ) : Mail
$to string
$format string
Результат Mail

send() публичный Метод

This method depends on the server being set up correctly as an SMTP server and sendmail being correctly defined in the php.ini file.
public send ( ) : void
Результат void

sendAsGroup() публичный Метод

Set the send as group flag
public sendAsGroup ( boolean $group ) : Mail
$group boolean
Результат Mail

sendFrom() публичный Метод

This method depends on the server being set up correctly as an SMTP server and sendmail being correctly defined in the php.ini file.
public sendFrom ( string $from = null, boolean $delete = false ) : Mail
$from string
$delete boolean
Результат Mail

setBoundary() публичный Метод

Set MIME boundary
public setBoundary ( string $bnd = null ) : Mail
$bnd string
Результат Mail

setCharset() публичный Метод

Set character set
public setCharset ( string $chr ) : Mail
$chr string
Результат Mail

setEol() публичный Метод

Set EOL
public setEol ( string $eol = Mail::CRLF ) : Mail
$eol string
Результат Mail

setHeader() публичный Метод

Set a mail header
public setHeader ( string $name, string $value ) : Mail
$name string
$value string
Результат Mail

setHeaders() публичный Метод

Set mail headers
public setHeaders ( array $headers ) : Mail
$headers array
Результат Mail

setHtml() публичный Метод

Set HTML part of the message.
public setHtml ( string $html ) : Mail
$html string
Результат Mail

setParams() публичный Метод

Set parameters
public setParams ( mixed $params = null ) : Mail
$params mixed
Результат Mail

setSubject() публичный Метод

Set the subject
public setSubject ( string $subj ) : Mail
$subj string
Результат Mail

setText() публичный Метод

Set text part of the message.
public setText ( string $text ) : Mail
$text string
Результат Mail

to() публичный Метод

Alias to add a recipient to the queue
public to ( string $email, string $name = null ) : Mail
$email string
$name string
Результат Mail

Описание свойств

$attachments защищенное свойство

File attachments
protected array $attachments
Результат array

$group защищенное свойство

Send as group flag
protected bool $group
Результат boolean

$headers защищенное свойство

Mail headers
protected array $headers
Результат array

$message защищенное свойство

Message body
protected Message,Pop\Mail $message
Результат Message

$params защищенное свойство

Mail parameters
protected string $params
Результат string

$queue защищенное свойство

Sending queue
protected Queue,Pop\Mail $queue
Результат Queue

$subject защищенное свойство

Subject
protected string $subject
Результат string