PHP 클래스 Phalcon\Mailer\Message

파일 보기 프로젝트 열기: phalcon/incubator

보호된 프로퍼티들

프로퍼티 타입 설명
$failedRecipients array An array of email which failed send to recipients.
$manager Manager
$message Swift_Message

공개 메소드들

메소드 설명
__construct ( Manager $manager ) Create a new Message using $mailer for sending from SwiftMailer
attachment ( string $file, array $options = [] ) Attach a file to the message.
attachmentData ( string $data, string $name, array $options = [] ) : Message Attach in-memory data as an attachment.
bcc ( string | array $email, string | null $name = null ) Set the Bcc addresses of this message.
cc ( string | array $email, string | null $name = null ) Set the Cc addresses of this message.
charset ( string $charset ) Set the character set of this message.
content ( mixed $content, string $contentType = self::CONTENT_TYPE_HTML, string $charset = null ) Set the body of this message, either as a string, or as an instance of {@link \Swift_OutputByteStream}.
contentType ( string $contentType ) Set the Content-type of this message.
embed ( string $file ) : string Embed a file in the message and get the CID.
embedData ( string $data, string $name, string $contentType = null ) : string Embed in-memory data in the message and get the CID.
from ( string | array $email, string | null $name = null ) Set the from address of this message.
getBcc ( ) : array Get the Bcc addresses of this message.
getCc ( ) : array Get the Cc address of this message.
getCharset ( ) : string Get the character set of this message.
getContent ( ) : string Get the body of this message as a string.
getContentType ( ) : string Get the Content-type of this message.
getFailedRecipients ( ) : array An array of email which failed send to recipients.
getFormat ( ) : string Get the format of this message (i.e. flowed or fixed).
getFrom ( ) : string Get the from address of this message.
getManager ( ) : Manager Return a {@link \Phalcon\Mailer\Manager} instance
getMessage ( ) : Swift_Message Return a {@link \Swift_Message} instance
getPriority ( ) : integer Get the priority of this message.
getReadReceiptTo ( ) : string Get the addresses to which a read-receipt will be sent.
getReplyTo ( ) : string Get the reply-to address of this message.
getReturnPath ( ) : string Get the return-path (bounce address) of this message.
getSender ( ) : string Get the sender of this message.
getSubject ( ) : string Get the subject of this message.
getTo ( ) : array Get the To addresses of this message.
priority ( integer $priority ) Set the priority of this message.
replyTo ( string | array $email, string | null $name = null ) Set the reply-to address of this message.
send ( ) : integer Send the given Message like it would be sent in a mail client.
sender ( string | array $email, string | null $name = null ) Set the sender of this message.
setFormat ( string $format ) : string Set the format of this message (flowed or fixed).
setReadReceiptTo ( array $email ) Ask for a delivery receipt from the recipient to be sent to $addresses
setReturnPath ( string $email ) Set the return-path (the bounce address) of this message.
subject ( string $subject ) Set the subject of this message.
to ( string | array $email, string | null $name = null ) Set the to addresses of this message.

보호된 메소드들

메소드 설명
createAttachmentViaData ( string $data, string $name ) : Swift_Attachment Create a Swift Attachment instance from data.
createAttachmentViaPath ( string $file ) : Swift_Attachment Create a Swift new Attachment from a filesystem path.
createEmbedViaData ( string $data, string | null $name = null ) : Swift_Image Create a Swift new Image.
createEmbedViaPath ( string $file ) : Swift_Image Create a Swift new Image from a filesystem path.
normalizeEmail ( $email ) : array | string Normalize IDN domains.
prepareAttachment ( Swift_Attachment $attachment, array $options = [] ) Prepare and attach the given attachment.

메소드 상세

__construct() 공개 메소드

Create a new Message using $mailer for sending from SwiftMailer
public __construct ( Manager $manager )
$manager Manager

attachment() 공개 메소드

Events: - mailer:beforeAttachFile - mailer:afterAttachFile
또한 보기: Phalcon\Mailer\Message::createAttachmentViaPath()
또한 보기: Phalcon\Mailer\Message::prepareAttachment()
public attachment ( string $file, array $options = [] )
$file string
$options array optional

attachmentData() 공개 메소드

Attach in-memory data as an attachment.
또한 보기: Phalcon\Mailer\Message::createAttachmentViaData()
또한 보기: Phalcon\Mailer\Message::prepareAttachment()
public attachmentData ( string $data, string $name, array $options = [] ) : Message
$data string
$name string
$options array optional
리턴 Message

bcc() 공개 메소드

If multiple recipients will receive the message an array should be used. Example: ['[email protected]', '[email protected]' => 'A name'] If $name is passed and the first parameter is a string, this name will be associated with the address.
또한 보기: Swift_Message::setBcc()
public bcc ( string | array $email, string | null $name = null )
$email string | array
$name string | null optional

cc() 공개 메소드

If multiple recipients will receive the message an array should be used. Example: ['[email protected]', '[email protected]' => 'A name'] If $name is passed and the first parameter is a string, this name will be associated with the address.
또한 보기: Swift_Message::setCc()
public cc ( string | array $email, string | null $name = null )
$email string | array
$name string | null optional

charset() 공개 메소드

Set the character set of this message.
또한 보기: Swift_Message::setCharset()
public charset ( string $charset )
$charset string

content() 공개 메소드

Set the body of this message, either as a string, or as an instance of {@link \Swift_OutputByteStream}.
또한 보기: Swift_Message::setBody()
public content ( mixed $content, string $contentType = self::CONTENT_TYPE_HTML, string $charset = null )
$content mixed
$contentType string optional
$charset string optional

contentType() 공개 메소드

Set the Content-type of this message.
또한 보기: Swift_Message::setContentType()
public contentType ( string $contentType )
$contentType string

createAttachmentViaData() 보호된 메소드

Create a Swift Attachment instance from data.
또한 보기: Swift_Attachment::newInstance()
protected createAttachmentViaData ( string $data, string $name ) : Swift_Attachment
$data string
$name string optional
리턴 Swift_Attachment

createAttachmentViaPath() 보호된 메소드

Create a Swift new Attachment from a filesystem path.
또한 보기: Swift_Attachment::fromPath()
protected createAttachmentViaPath ( string $file ) : Swift_Attachment
$file string
리턴 Swift_Attachment

createEmbedViaData() 보호된 메소드

Create a Swift new Image.
또한 보기: Swift_Image::newInstance()
protected createEmbedViaData ( string $data, string | null $name = null ) : Swift_Image
$data string
$name string | null optional
리턴 Swift_Image

createEmbedViaPath() 보호된 메소드

Create a Swift new Image from a filesystem path.
또한 보기: Swift_Image::fromPath()
protected createEmbedViaPath ( string $file ) : Swift_Image
$file string
리턴 Swift_Image

embed() 공개 메소드

Embed a file in the message and get the CID.
public embed ( string $file ) : string
$file string
리턴 string

embedData() 공개 메소드

Embed in-memory data in the message and get the CID.
public embedData ( string $data, string $name, string $contentType = null ) : string
$data string
$name string
$contentType string
리턴 string

from() 공개 메소드

You may pass an array of addresses if this message is from multiple people. Example: ['[email protected]', '[email protected]' => 'A name'] If $name is passed and the first parameter is a string, this name will be associated with the address.
또한 보기: Swift_Message::setFrom()
public from ( string | array $email, string | null $name = null )
$email string | array
$name string | null optional

getBcc() 공개 메소드

Get the Bcc addresses of this message.
또한 보기: Swift_Message::getBcc()
public getBcc ( ) : array
리턴 array

getCc() 공개 메소드

Get the Cc address of this message.
또한 보기: Swift_Message::getCc()
public getCc ( ) : array
리턴 array

getCharset() 공개 메소드

Get the character set of this message.
또한 보기: Swift_Message::getCharset()
public getCharset ( ) : string
리턴 string

getContent() 공개 메소드

Get the body of this message as a string.
또한 보기: Swift_Message::getBody()
public getContent ( ) : string
리턴 string

getContentType() 공개 메소드

Get the Content-type of this message.
또한 보기: Swift_Message::getContentType()
public getContentType ( ) : string
리턴 string

getFailedRecipients() 공개 메소드

An array of email which failed send to recipients.
public getFailedRecipients ( ) : array
리턴 array

getFormat() 공개 메소드

Get the format of this message (i.e. flowed or fixed).
또한 보기: Swift_Message::getFormat()
public getFormat ( ) : string
리턴 string

getFrom() 공개 메소드

Get the from address of this message.
또한 보기: Swift_Message::getFrom()
public getFrom ( ) : string
리턴 string

getManager() 공개 메소드

Return a {@link \Phalcon\Mailer\Manager} instance
public getManager ( ) : Manager
리턴 Manager

getMessage() 공개 메소드

Return a {@link \Swift_Message} instance
public getMessage ( ) : Swift_Message
리턴 Swift_Message

getPriority() 공개 메소드

The returned value is an integer where 1 is the highest priority and 5 is the lowest.
또한 보기: Swift_Message::getPriority()
public getPriority ( ) : integer
리턴 integer

getReadReceiptTo() 공개 메소드

Get the addresses to which a read-receipt will be sent.
또한 보기: Swift_Message::getReadReceiptTo()
public getReadReceiptTo ( ) : string
리턴 string

getReplyTo() 공개 메소드

Get the reply-to address of this message.
또한 보기: Swift_Message::getReplyTo()
public getReplyTo ( ) : string
리턴 string

getReturnPath() 공개 메소드

Get the return-path (bounce address) of this message.
또한 보기: Swift_Message::getReturnPath()
public getReturnPath ( ) : string
리턴 string

getSender() 공개 메소드

Get the sender of this message.
또한 보기: Swift_Message::getSender()
public getSender ( ) : string
리턴 string

getSubject() 공개 메소드

Get the subject of this message.
또한 보기: Swift_Message::getSubject()
public getSubject ( ) : string
리턴 string

getTo() 공개 메소드

Get the To addresses of this message.
또한 보기: Swift_Message::getTo()
public getTo ( ) : array
리턴 array

normalizeEmail() 보호된 메소드

Normalize IDN domains.
protected normalizeEmail ( $email ) : array | string
$email
리턴 array | string

prepareAttachment() 보호된 메소드

Prepare and attach the given attachment.
또한 보기: Swift_Message::attach()
protected prepareAttachment ( Swift_Attachment $attachment, array $options = [] )
$attachment Swift_Attachment
$options array optional

priority() 공개 메소드

The value is an integer where 1 is the highest priority and 5 is the lowest.
또한 보기: Swift_Message::setPriority()
public priority ( integer $priority )
$priority integer

replyTo() 공개 메소드

You may pass an array of addresses if replies will go to multiple people. Example: ['[email protected]', '[email protected]' => 'A name'] If $name is passed and the first parameter is a string, this name will be associated with the address.
또한 보기: Swift_Message::setReplyTo()
public replyTo ( string | array $email, string | null $name = null )
$email string | array
$name string | null optional

send() 공개 메소드

All recipients (with the exception of Bcc) will be able to see the other recipients this message was sent to. Recipient/sender data will be retrieved from the Message object. The return value is the number of recipients who were accepted for delivery. Events: - mailer:beforeSend - mailer:afterSend
또한 보기: Swift_Mailer::send()
public send ( ) : integer
리턴 integer

sender() 공개 메소드

This does not override the From field, but it has a higher significance.
또한 보기: Swift_Message::setSender()
public sender ( string | array $email, string | null $name = null )
$email string | array
$name string | null optional

setFormat() 공개 메소드

Set the format of this message (flowed or fixed).
또한 보기: Swift_Message::setFormat()
public setFormat ( string $format ) : string
$format string
리턴 string

setReadReceiptTo() 공개 메소드

Ask for a delivery receipt from the recipient to be sent to $addresses
또한 보기: Swift_Message::setReadReceiptTo()
public setReadReceiptTo ( array $email )
$email array

setReturnPath() 공개 메소드

Set the return-path (the bounce address) of this message.
또한 보기: Swift_Message::setReturnPath()
public setReturnPath ( string $email )
$email string

subject() 공개 메소드

Set the subject of this message.
또한 보기: Swift_Message::setSubject()
public subject ( string $subject )
$subject string

to() 공개 메소드

If multiple recipients will receive the message an array should be used. Example: ['[email protected]', '[email protected]' => 'A name'] If $name is passed and the first parameter is a string, this name will be associated with the address.
또한 보기: Swift_Message::setTo()
public to ( string | array $email, string | null $name = null )
$email string | array
$name string | null optional

프로퍼티 상세

$failedRecipients 보호되어 있는 프로퍼티

An array of email which failed send to recipients.
protected array $failedRecipients
리턴 array

$manager 보호되어 있는 프로퍼티

protected Manager,Phalcon\Mailer $manager
리턴 Manager

$message 보호되어 있는 프로퍼티

protected Swift_Message $message
리턴 Swift_Message