Class: WindMail

Source Location: /mail/WindMail.php

Class WindMail

Class Overview

邮件发送类

Author(s):

Qian Su <aoxue.1988.su.qian@163.com>

Information Tags:

Version:	$Id: WindMail.php 3298 2012-01-06 12:48:26Z yishuo $
Copyright:	©2003-2103 phpwind.com
License:	http://www.windframework.com

Methods

[ Top ]

Constant Summary

BCC
CC
CONTENTDESCRIPT
CONTENTENCODE
CONTENTID
CONTENTLANGUAGE
CONTENTLOCATION
CONTENTPOSITION
CONTENTTYPE
CRLF
DATE
DIS_ATTACHMENT
DIS_INLINE
ENCODE_7BIT
ENCODE_8BIT
ENCODE_BASE64
ENCODE_BINARY
ENCODE_QP
FROM
LINELENGTH
MESSAGEID
MIME_ALTERNATIVE
MIME_HTML
MIME_MIXED
MIME_OCTETSTREAM
MIME_RELATED
MIME_TEXT
SEND_PHP
SEND_SEND
SEND_SMTP
SUBJECT
TO

[ Top ]

Method Summary

string	createBody()	创建邮件消息体
string	createHeader()	创建邮件头信息
array	getBcc()	取得暗送对象
array	getCc()	取得抄送的对象
string	getFrom()	取得发件人
void	getMailHeader()	返回邮件头信息值
array	getRecipients()	取得真实的收件人
string	getSubject()	取得邮件主题
array	getTo()	取得收件人
boolean	send()	发送邮件
void	setAttachment()	设置附件
void	setBcc()	设置暗送人
void	setBody()	设置邮件展示内容
void	setBodyText()	设置邮件文本展示内容
void	setCc()	设置抄送人
void	setCharset()	设置邮件字符
void	setContentEncode()	设置邮件编码
void	setContentType()	设置邮件类型
void	setDate()	设置邮件日期
void	setEmbed()	设置是否是内嵌资源
void	setFrom()	设置发件人
void	setMailHeader()	设置邮件头
void	setMessageId()	设置邮件消息ID
void	setSubject()	设置邮件主题
void	setTo()	设置收件人

[ Top ]

Methods

createBody [line 156]

string createBody(
)

创建邮件消息体

API Tags:

Access:

public

[ Top ]

createHeader [line 126]

string createHeader(
)

创建邮件头信息

API Tags:

Access:

public

[ Top ]

getBcc [line 269]

array getBcc(
)

取得暗送对象

API Tags:

Access:

public

[ Top ]

getCc [line 248]

array getCc(
)

取得抄送的对象

API Tags:

Access:

public

[ Top ]

getFrom [line 206]

string getFrom(
)

取得发件人

API Tags:

Access:

public

[ Top ]

getMailHeader [line 329]

void getMailHeader(
string
$name 
)

返回邮件头信息值

Parameters:

string

$name:

API Tags:

Access:

public

[ Top ]

getRecipients [line 516]

array getRecipients(
)

取得真实的收件人

API Tags:

Access:

public

[ Top ]

getSubject [line 287]

string getSubject(
)

取得邮件主题

API Tags:

Access:

public

[ Top ]

getTo [line 227]

array getTo(
)

取得收件人

API Tags:

Access:

public

[ Top ]

send [line 107]

boolean send(
[string
$type = self::SEND_SMTP], [array
$config = array()] 
)

发送邮件

Parameters:

string	$type:	发送类型
array	$config:	邮件发送器需要的配置数据

API Tags:

Access:

public

[ Top ]

setAttachment [line 530]

void setAttachment(
string
$stream, [string
$mime = self::MIME_OCTETSTREAM], [string
$disposition = self::DIS_ATTACHMENT], [string
$encode = self::ENCODE_BASE64], [string
$filename = null], [string
$cid = 0] 
)

设置附件

Parameters:

string	$stream:	附件名或者附件内容
string	$mime:	附件类型
string	$disposition:	附件展现方式
string	$encode:	附件编码
string	$filename:	文件名
string	$cid:	内容ID

API Tags:

Access:

public

[ Top ]

setBcc [line 258]

void setBcc(
string
$email, [string
$name = null] 
)

设置暗送人

Parameters:

string	$email:	暗送人邮箱
string	$name:	暗送人姓名

API Tags:

Access:

public

[ Top ]

setBody [line 539]

void setBody(
string
$body 
)

设置邮件展示内容

Parameters:

string

$body:

API Tags:

Access:

public

[ Top ]

setBodyText [line 547]

void setBodyText(
string
$bodyText 
)

设置邮件文本展示内容

Parameters:

string

$bodyText:

API Tags:

Access:

public

[ Top ]

setCc [line 237]

void setCc(
string
$email, [string
$name = null] 
)

设置抄送人

Parameters:

string	$email:	抄送人邮箱
string	$name:	抄送人姓名

API Tags:

Access:

public

[ Top ]

setCharset [line 555]

void setCharset(
string
$charset 
)

设置邮件字符

Parameters:

string

$charset:

API Tags:

Access:

public

[ Top ]

setContentEncode [line 354]

void setContentEncode(
[string
$encode = self::ENCODE_BASE64] 
)

设置邮件编码

Parameters:

string

$encode:

API Tags:

Access:

public

[ Top ]

setContentType [line 364]

void setContentType(
[string
$type = self::MIME_TEXT] 
)

设置邮件类型

Parameters:

string

$type:

API Tags:

Access:

public

[ Top ]

setDate [line 298]

void setDate(

$date, string
$data 
)

设置邮件日期

Parameters:

string	$data:
	$date:

API Tags:

Access:

public

[ Top ]

setEmbed [line 563]

void setEmbed(
[boolean
$embed = false] 
)

设置是否是内嵌资源

Parameters:

boolean

$embed:

API Tags:

Access:

public

[ Top ]

setFrom [line 194]

void setFrom(
string
$email, [string
$name = null] 
)

设置发件人

Parameters:

string	$email:	发件人邮箱
string	$name:	发件人姓名

API Tags:

Access:

public

[ Top ]

setMailHeader [line 310]

void setMailHeader(
string
$name, string
$value, [boolean
$append = true] 
)

设置邮件头

Parameters:

string	$name:	邮件头名称
string	$value:	邮件头对应的值
boolean	$append:	是否是追加

API Tags:

Access:

public

[ Top ]

setMessageId [line 337]

void setMessageId(
)

设置邮件消息ID

API Tags:

Access:

public

[ Top ]

setSubject [line 278]

void setSubject(
string
$subject 
)

设置邮件主题

Parameters:

string

$subject:

主题

API Tags:

Access:

public

[ Top ]

setTo [line 216]

void setTo(
string|array
$email, [string
$name = null] 
)

设置收件人

Parameters:

string\|array	$email:	收件人邮箱
string	$name:	收件人姓名

API Tags:

Access:

public

[ Top ]

Constants

BCC = 'Bcc' [line 62]

[ Top ]

CC = 'Cc' [line 61]

[ Top ]

CONTENTDESCRIPT = 'Content-Description' [line 70]

[ Top ]

CONTENTENCODE = 'Content-Transfer-Encoding' [line 67]

[ Top ]

CONTENTID = 'Content-ID' [line 68]

[ Top ]

CONTENTLANGUAGE = 'Content-Language' [line 72]

[ Top ]

CONTENTLOCATION = 'Content-Location' [line 71]

[ Top ]

CONTENTPOSITION = 'Content-Disposition' [line 69]

[ Top ]

CONTENTTYPE = 'Content-Type' [line 66]

[ Top ]

CRLF = "\n" [line 59]

[ Top ]

DATE = 'Date' [line 73]

[ Top ]

DIS_ATTACHMENT = 'attachment' [line 91]

[ Top ]

DIS_INLINE = 'inline' [line 92]

[ Top ]

ENCODE_7BIT = '7bit' [line 84]

[ Top ]

ENCODE_8BIT = '8bit' [line 85]

[ Top ]

ENCODE_BASE64 = 'base64' [line 87]

[ Top ]

ENCODE_BINARY = 'binary' [line 88]

[ Top ]

ENCODE_QP = 'quoted-printable' [line 86]

[ Top ]

FROM = 'From' [line 63]

[ Top ]

LINELENGTH = 72 [line 93]

[ Top ]

MESSAGEID = 'Message-Id' [line 65]

[ Top ]

MIME_ALTERNATIVE = 'multipart/alternative' [line 79]

[ Top ]

MIME_HTML = 'text/html' [line 78]

[ Top ]

MIME_MIXED = 'multipart/mixed' [line 80]

[ Top ]

MIME_OCTETSTREAM = 'application/octet-stream' [line 76]

[ Top ]

MIME_RELATED = 'multipart/related' [line 81]

[ Top ]

MIME_TEXT = 'text/plain' [line 77]

[ Top ]

SEND_PHP = 'php' [line 97]

[ Top ]

SEND_SEND = 'send' [line 98]

[ Top ]

SEND_SMTP = 'smtp' [line 96]

[ Top ]

SUBJECT = 'Subject' [line 64]

[ Top ]

TO = 'To' [line 60]

[ Top ]

Documentation generated on Fri, 30 Mar 2012 11:43:37 +0800 by phpDocumentor 1.4.4