Class: WindImap

Source Location: /mail/protocol/WindImap.php

Class WindImap

Class Overview

imap协议封装

Located in /mail/protocol/WindImap.php [line 13]

Author(s):

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

Information Tags:

Version:	$Id: WindImap.php 2973 2011-10-15 19:22:48Z yishuo $
Copyright:	©2003-2103 phpwind.com
License:	http://www.windframework.com

Properties

Methods

[ Top ]

Constant Summary

ALL
ANSWERED
BCC
BODY
BODYSTRUCTUR
CC
CONTENTENCODE
CONTENTTYPE
CRLF
DATE
DELETED
DELIVERED
DRAFT
FAST
FLAG
FLAGGED
FLAGS
FROM
FULL
HEADER
INTERNALDATE
MESSAGEID
MIMEVERSION
RECEIVED
RECENT
REPLY
RETURNPATH
RFC822
RFC822HEADER
RFC822SIZE
RFC822TEXT
SEEN
SH_ALL
SH_ANSWERED
SH_BCC
SH_BEFORE
SH_BODY
SH_DELETED
SH_FLAGGED
SH_FROM
SH_KEYWORD
SH_NEW
SH_RECENT
SH_SEEN
SH_SINCE
SH_TEXT
SH_TO
SH_UNANSWERED
SH_UNDELETED
SH_UNFLAGGED
SH_UNKEYWORD
SH_UNSEEN
SLIENT
SUBEJCT
S_MESSAGES
S_RECENT
S_UIDNEXT
S_UIDVALIDITY
S_UNSEEN
TAG
TEXT	**body中的section*****
TO
UID

[ Top ]

Property Summary

WindSocket	$imap
mixed	$request
mixed	$resonse
mixed	$seperate

[ Top ]

Method Summary

void	capability()	返回IMAP服务器支持的功能列表，
void	check()	在邮箱设置一个检查点,确保内存中的磁盘缓冲数据都被写到了磁盘上。
void	close()	结束对当前Folder（文件夹/邮箱）的访问，
string	communicate()	一次imap会号
string	copy()	把邮件从一个邮箱复制到另一个邮箱
void	create()	创建指定名字的新邮箱。邮箱名称通常是带路径的文件夹全名。
string	delete()	除指定名字的文件夹。文件夹名字通常是带路径的文件夹全名，
string	examine()	以只读方式打开邮箱
void	expunge()	不关闭邮箱的情况下删除所有的标志为、DELETED的邮件。
void	fetch()	读取邮件的文本信息，且仅用于显示的目的。
string	fetchBySection()	返回邮件的中的某一指定部分，返回的部分用section来表示，
string	fetchHeader()	读取邮件的头信息
string	fetchHeaderFields()	读取邮件的头的字段信息,可能造成不安全，慎用
string	fetchHeaderNotFields()	读取邮件的头已排除字段信息
string	fetchMime()	读取邮件的MIME
string	fetchPartialOfSection()	返回邮件的中的某一指定部分，返回的部分用section来表示，
string	fetchText()	读取邮件的Text
string	folderOfmail()	LIST命令用于列出邮箱中已有的文件夹，有点像操作系统的列目录命令
string	getTag()	取得imap会号中的标签
string	login()	登陆
void	logout()	结束本次IMAP会话。
string	lsub()	修正了LIST命令，LIST返回用户$HOME目录下所有的文件，
string	open()	打开一个imap连接
string	rename()	RENAME命令可以修改文件夹的名称，它使用两个参数：当前邮箱名和新邮箱名，
void	request()	发送imap会话请求命令
string	response()	验证请求
void	responseLine()	imap会话响应请求
string	search()	根据搜索条件在处于活动状态的邮箱中搜索邮件，然后显示匹配的邮件编号。
void	select()	选定某个邮箱（Folder），表示即将对该邮箱（Folder）内的邮件作操作。
void	setTag()	在imap会话中设置新标答
string	status()	查询邮箱的当前状态
string	store()	修改指定邮件的属性，包括给邮件打上已读标记、删除标记等
string	stripStore()	修改指定邮件的属性，包括给邮件打上已读标记、删除标记等
void	subscribe()	在客户机的活动邮箱列表中增加一个邮箱
void	uid()	UID号是唯一标识邮件系统中邮件的32位证书。
WindImap	__construct()
void	__destruct()
void	unsubscribe()	来从活动列表中去掉一个邮箱

[ Top ]

Properties

WindSocket $imap = null [line 345]

API Tags:

Access:

protected

[ Top ]

mixed $request = array() [line 349]

API Tags:

Access:

protected

[ Top ]

mixed $resonse = array() [line 351]

API Tags:

Access:

protected

[ Top ]

mixed $seperate = ' ' [line 347]

API Tags:

Access:

protected

[ Top ]

Methods

capability [line 646]

void capability(
)

返回IMAP服务器支持的功能列表，

服务器收到客户机发送的CAPABILITY命令后将返回该服务器所支持的功能。

API Tags:

Access:

public

[ Top ]

check [line 604]

void check(
)

在邮箱设置一个检查点,确保内存中的磁盘缓冲数据都被写到了磁盘上。

API Tags:

Access:

public

[ Top ]

close [line 541]

void close(
)

结束对当前Folder（文件夹/邮箱）的访问，

关闭邮箱该邮箱中所有标志为DELETED的邮件就被从物理上删除

API Tags:

Access:

public

[ Top ]

communicate [line 707]

string communicate(
string
$request, [
&$response = null], string
$response 
)

一次imap会号

Parameters:

string	$request:	请求
string	$response:	响应
	&$response:

API Tags:

Access:

public

[ Top ]

copy [line 638]

string copy(
int
$soruce, string
$dst 
)

把邮件从一个邮箱复制到另一个邮箱

Parameters:

int	$soruce:	希望从活动邮箱中复制的邮件的标号
string	$dst:	望邮件被复制到的邮箱

API Tags:

Access:

public

[ Top ]

create [line 383]

void create(

$folder, string
$folder;, string
1 
)

创建指定名字的新邮箱。邮箱名称通常是带路径的文件夹全名。

Parameters:

string	$folder;:
string	1:
	$folder:

API Tags:

Access:

public

[ Top ]

delete [line 393]

string delete(
string
$folder 
)

除指定名字的文件夹。文件夹名字通常是带路径的文件夹全名，

当邮箱被删除后，其中的邮件也不复存在。

Parameters:

string

$folder:

API Tags:

Access:

public

[ Top ]

examine [line 558]

string examine(
string
$mailbox 
)

以只读方式打开邮箱

Parameters:

string

$mailbox:

邮箱

API Tags:

Access:

public

[ Top ]

expunge [line 549]

void expunge(
)

不关闭邮箱的情况下删除所有的标志为、DELETED的邮件。

EXPUNGE删除的邮件将不可以恢复。

API Tags:

Access:

public

[ Top ]

fetch [line 432]

void fetch(
int|string
$mail, [string
$datanames = self::ALL] 
)

读取邮件的文本信息，且仅用于显示的目的。

Parameters:

int\|string	$mail:	希望读取的邮件号或者邮冒号分隔的区段
string	$datanames:

API Tags:

Access:

public

[ Top ]

fetchBySection [line 494]

string fetchBySection(
int|string
$mail, [int|string
$section = self::TEXT] 
)

返回邮件的中的某一指定部分，返回的部分用section来表示，

section部分包含的信息通常是代表某一部分的一个数字或者是下面的某一个部分： HEADER, HEADER.FIELDS, HEADER.FIELDS.NOT, MIME, and TEXT。如果section部分是空的话，那就代表返回全部的信息，包括头信息。

Parameters:

int\|string	$mail:	希望读取的邮件号或者邮冒号分隔的区段
int\|string	$section:	返回的部分

API Tags:

Access:

public

[ Top ]

fetchHeader [line 441]

string fetchHeader(
int|string
$mail 
)

读取邮件的头信息

Parameters:

int|string

$mail:

希望读取的邮件号或者邮冒号分隔的区段

API Tags:

Access:

public

[ Top ]

fetchHeaderFields [line 451]

string fetchHeaderFields(
int|string
$mail, [string
$field = self::DATE] 
)

读取邮件的头的字段信息,可能造成不安全，慎用

Parameters:

int\|string	$mail:	希望读取的邮件号或者邮冒号分隔的区段
string	$field:	头字段(DATE\SUBJECT\FROM\TO\MESSAGEID\CONTENTTYPE)

API Tags:

Access:

public

[ Top ]

fetchHeaderNotFields [line 462]

string fetchHeaderNotFields(
int|string
$mail, [string
$field = self::DATE] 
)

读取邮件的头已排除字段信息

Parameters:

int\|string	$mail:	希望读取的邮件号或者邮冒号分隔的区段
string	$field:	头字段(DATE\SUBJECT\FROM\TO\MESSAGEID\CONTENTTYPE)

API Tags:

Access:

public

[ Top ]

fetchMime [line 472]

string fetchMime(
int|string
$mail 
)

读取邮件的MIME

Parameters:

int|string

$mail:

希望读取的邮件号或者邮冒号分隔的区段

API Tags:

Access:

public

[ Top ]

fetchPartialOfSection [line 509]

string fetchPartialOfSection(
int|string
$mail, int
$start, int
$end, [int:string
$section = self::TEXT] 
)

返回邮件的中的某一指定部分，返回的部分用section来表示，

Parameters:

int\|string	$mail:	希望读取的邮件号或者邮冒号分隔的区段
int	$start:	返回的部分的开始
int	$end:	返回的部分的结束
int:string	$section:	返回的部分

API Tags:

Access:

public

[ Top ]

fetchText [line 481]

string fetchText(
int|string
$mail 
)

读取邮件的Text

Parameters:

int|string

$mail:

希望读取的邮件号或者邮冒号分隔的区段

API Tags:

Access:

public

[ Top ]

folderOfmail [line 414]

string folderOfmail(
[string
$base = ''], [string
$template = '*'] 
)

LIST命令用于列出邮箱中已有的文件夹，有点像操作系统的列目录命令

Parameters:

string	$base:	用户登陆目录
string	$template:	显示的邮箱名。可以使用通配符"*"。

API Tags:

Access:

public

[ Top ]

getTag [line 723]

string getTag(
)

取得imap会号中的标签

API Tags:

Access:

public

[ Top ]

string login(
string
$username, string
$password 
)

登陆

Parameters:

string	$username:
string	$password:

API Tags:

Access:

public

[ Top ]

logout [line 653]

void logout(
)

结束本次IMAP会话。

API Tags:

Access:

public

[ Top ]

lsub [line 585]

string lsub(
string
$folder, string
$mailbox 
)

修正了LIST命令，LIST返回用户$HOME目录下所有的文件，

但LSUB命令只显示那些使用SUBSCRIBE命令设置为活动邮箱的文件

Parameters:

string	$folder:	邮箱路径
string	$mailbox:	邮箱名。

API Tags:

Access:

public

[ Top ]

open [line 363]

string open(
)

打开一个imap连接

API Tags:

Access:

public

[ Top ]

rename [line 404]

string rename(
string
$old, string
$new 
)

RENAME命令可以修改文件夹的名称，它使用两个参数：当前邮箱名和新邮箱名，

两个参数的命名符合标准路径命名规则。

Parameters:

string	$old:	当前邮箱名
string	$new:	新邮箱名，

API Tags:

Access:

public

[ Top ]

request [line 661]

void request(
string
$request 
)

发送imap会话请求命令

Parameters:

string

$request:

API Tags:

Access:

public

[ Top ]

response [line 684]

string response(
[
$endTag = '*'], [int
$timeout = null], boolean
$multi 
)

验证请求

Parameters:

boolean	$multi:
int	$timeout:
	$endTag:

API Tags:

Access:

public

[ Top ]

responseLine [line 671]

void responseLine(
[int
$timeout = null] 
)

imap会话响应请求

Parameters:

int

$timeout:

API Tags:

Access:

public

[ Top ]

search [line 615]

string search(
[string
$criteria = self::SH_ALL], [string
$value = null], string
$charset 
)

根据搜索条件在处于活动状态的邮箱中搜索邮件，然后显示匹配的邮件编号。

Parameters:

string	$criteria:	查询条件参数，明确查询的关键字
string	$value:	查询条件参数，明确查询的关键字的值
string	$charset:	字符集标志,缺省的标志符是US-ASCⅡ

API Tags:

Access:

public

[ Top ]

select [line 423]

void select(
string
$folder 
)

选定某个邮箱（Folder），表示即将对该邮箱（Folder）内的邮件作操作。

邮箱标志的当前状态也返回给了用户，同时返回的还有一些关于邮件和邮箱的附加信息。

Parameters:

string

$folder:

API Tags:

Access:

public

[ Top ]

setTag [line 715]

void setTag(
)

在imap会话中设置新标答

API Tags:

Access:

public

[ Top ]

status [line 595]

string status(
string
$mailbox, [string
$params = self::S_MESSAGES] 
)

查询邮箱的当前状态

Parameters:

string	$mailbox:	需要查询的邮箱名
string	$params:	客户机需要查询的项目列表,S_MESSAGES\S_RECENT\S_UIDNEXT\S_UIDVALIDITY\S_UNSEEN

API Tags:

Access:

public

[ Top ]

store [line 520]

string store(
INT|string
$mail, [string
$flags = self::FLAGS], [STRING|ARRAY
$attribute = self::ANSWERED] 
)

修改指定邮件的属性，包括给邮件打上已读标记、删除标记等

Parameters:

INT\|string	$mail:
string	$flags:	imap中的邮件标记,值为SLIENT和FLAGS两种类型
STRING\|ARRAY	$attribute:	标记属性(DELETED\ANSWERED\RECENT\DRAFT\FLAGGED)

API Tags:

Access:

public

[ Top ]

stripStore [line 532]

string stripStore(
INT|string
$mail, [string
$flags = self::FLAGS], [STRING|ARRAY
$attribute = self::DELETED] 
)

修改指定邮件的属性，包括给邮件打上已读标记、删除标记等

Parameters:

INT\|string	$mail:
string	$flags:	imap中的邮件标记,值为SLIENT和FLAGS两种类型
STRING\|ARRAY	$attribute:	标记属性(DELETED\ANSWERED\RECENT\DRAFT\FLAGGED)

API Tags:

Access:

public

[ Top ]

subscribe [line 566]

void subscribe(
string
$mailbox 
)

在客户机的活动邮箱列表中增加一个邮箱

Parameters:

string

$mailbox:

希望添加的邮箱名。

API Tags:

Access:

public

[ Top ]

uid [line 628]

void uid(
)

UID号是唯一标识邮件系统中邮件的32位证书。

通常这些命令都使用顺序号来标识邮箱中的邮件，使用UID可以使IMAP客户机记住不同IMAP会话中的邮件。

API Tags:

Access:

public

[ Top ]

Constructor __construct [line 355]

WindImap __construct(

$host, 
$port 
)

Parameters:

	$host:
	$port:

API Tags:

Access:

public

[ Top ]

Destructor __destruct [line 727]

void __destruct(
)

API Tags:

Access:

public

[ Top ]

unsubscribe [line 574]

void unsubscribe(
string
$mailbox 
)

来从活动列表中去掉一个邮箱

Parameters:

string

$mailbox:

希望去掉的邮箱名。

API Tags:

Access:

public

[ Top ]

Constants

ALL = 'ALL' [line 73]

[ Top ]

ANSWERED = '\Answered' [line 32]

[ Top ]

BCC = 'Bcc' [line 156]

[ Top ]

BODY = 'BODY' [line 78]

[ Top ]

BODYSTRUCTUR = 'BODYSTRUCTUR' [line 98]

[ Top ]

CC = 'Cc' [line 151]

[ Top ]

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

[ Top ]

CONTENTTYPE = 'Content-Type' [line 176]

[ Top ]

CRLF = "\r\n" [line 15]

[ Top ]

DATE = 'Date' [line 136]

[ Top ]

DELETED = '\Deleted' [line 42]

[ Top ]

DELIVERED = 'Delivered-To' [line 161]

[ Top ]

DRAFT = '\Draft' [line 47]

[ Top ]

FAST = 'FAST' [line 83]

[ Top ]

FLAG = 'FLAGS' [line 93]

[ Top ]

FLAGGED = '\Flagged' [line 37]

[ Top ]

FLAGS = 'FLAGS' [line 60]

[ Top ]

FROM = 'From' [line 141]

[ Top ]

FULL = 'FULL' [line 88]

[ Top ]

HEADER = 'HEADER' [line 339]

[ Top ]

INTERNALDATE = 'INTERNALDATE' [line 103]

[ Top ]

MESSAGEID = 'Message-Id' [line 191]

[ Top ]

MIMEVERSION = 'MIME-Version' [line 186]

[ Top ]

RECEIVED = 'Received' [line 196]

[ Top ]

RECENT = '\Recent' [line 52]

[ Top ]

REPLY = 'Reply-To' [line 166]

[ Top ]

RETURNPATH = 'Return-Path' [line 201]

[ Top ]

RFC822 = 'RFC822' [line 108]

[ Top ]

RFC822HEADER = 'RFC822.HEADER' [line 118]

[ Top ]

RFC822SIZE = 'RFC822.SIZE' [line 113]

[ Top ]

RFC822TEXT = 'RFC822.TEXT' [line 123]

[ Top ]

SEEN = '\seen' [line 27]

[ Top ]

SH_ALL = 'ALL' [line 237]

[ Top ]

SH_ANSWERED = 'ANSWERED' [line 247]

[ Top ]

SH_BCC = 'BCC' [line 252]

[ Top ]

SH_BEFORE = 'BEFORE' [line 257]

[ Top ]

SH_BODY = 'BODY' [line 262]

[ Top ]

SH_DELETED = 'DELETED' [line 267]

[ Top ]

SH_FLAGGED = 'FLAGGED' [line 272]

[ Top ]

SH_FROM = 'FROM' [line 277]

[ Top ]

SH_KEYWORD = 'KEYWORD' [line 282]

[ Top ]

SH_NEW = 'NEW' [line 242]

[ Top ]

SH_RECENT = 'RECENT' [line 287]

[ Top ]

SH_SEEN = 'SEEN' [line 292]

[ Top ]

SH_SINCE = 'SINCE' [line 297]

[ Top ]

SH_TEXT = 'TEXT' [line 302]

[ Top ]

SH_TO = 'TO' [line 307]

[ Top ]

SH_UNANSWERED = 'UNANSWERED' [line 312]

[ Top ]

SH_UNDELETED = 'UNDELETED' [line 317]

[ Top ]

SH_UNFLAGGED = 'UNFLAGGED' [line 332]

[ Top ]

SH_UNKEYWORD = 'UNKEYWORD' [line 322]

[ Top ]

SH_UNSEEN = 'UNSEEN' [line 327]

[ Top ]

SLIENT = 'FLAGS.SLIENT' [line 65]

[ Top ]

SUBEJCT = 'Subject' [line 171]

[ Top ]

S_MESSAGES = 'MESSAGES' [line 209]

[ Top ]

S_RECENT = 'RECENT' [line 214]

[ Top ]

S_UIDNEXT = 'UIDNEXT' [line 219]

[ Top ]

S_UIDVALIDITY = 'UIDVALIDITY' [line 224]

[ Top ]

S_UNSEEN = 'UNSEEN' [line 229]

[ Top ]

TAG = 'Tag' [line 20]

[ Top ]

TEXT = 'TEXT' [line 337]

****body中的section*******

[ Top ]

TO = 'To' [line 146]

[ Top ]

UID = 'UID' [line 128]

[ Top ]

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

	mail protocol

[ class tree: mail ] [ index: mail ] [ all elements ]