Class: WindPop3

Source Location: /mail/protocol/WindPop3.php

Class WindPop3

Class Overview

pop3协议

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

Author(s):

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

Information Tags:

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

Properties

Methods

[ Top ]

Constant Summary

CRLF

[ Top ]

Property Summary

WindSocket	$pop3
mixed	$request
mixed	$resonse
mixed	$seperate

[ Top ]

Method Summary

WindPop3	__construct()
void	__destruct()
Array	buildResponse()	外理响应内容
void	close()	结否会话,关闭pop3服务器
array	communicate()	进行一次网络传输通信
string	dele()	处理 server 标记删除，QUIT 命令执行时才真正删除
string	getList()	处理 server 返回指定邮件的大小等
void	getMailContent()	获取解析后的内容
string	login()	登陆pop3
string	noop()	处理 server 返回一个肯定的响应
string	open()	打开pop3服务器,建立连接
string	quit()	希望结束会话。如果 server 处于"处理" 状态，
void	request()	发送pop3命令
string	response()	验证请求
void	responseLine()	pop3响应请求
string	retr()	处处理 server 返回邮件的全部文本
string	rset()	处理撤消所有的 DELE 命令
string	stat()	处理请求 server 回送邮箱统计资料，如邮件数、邮件总字节数
string	top()	处理返回 n 号邮件的前 m 行内容，m 必须是自然数
string	uidl()	处理 server 返回用于该指定邮件的唯一标识，如果没有指定，返回所有的。

[ Top ]

Properties

WindSocket $pop3 = null [line 20]

API Tags:

Access:

protected

[ Top ]

mixed $request = array() [line 24]

API Tags:

Access:

protected

[ Top ]

mixed $resonse = array() [line 26]

API Tags:

Access:

protected

[ Top ]

mixed $seperate = ' ' [line 22]

API Tags:

Access:

protected

[ Top ]

Methods

Constructor __construct [line 28]

WindPop3 __construct(

$host, 
$port 
)

Parameters:

	$host:
	$port:

API Tags:

Access:

public

[ Top ]

Destructor __destruct [line 257]

void __destruct(
)

API Tags:

Access:

public

[ Top ]

buildResponse [line 163]

Array buildResponse(
string
$response 
)

外理响应内容

Parameters:

string

$response:

API Tags:

Access:

public

[ Top ]

close [line 141]

void close(
)

结否会话,关闭pop3服务器

API Tags:

Access:

public

[ Top ]

communicate [line 186]

array communicate(
string
$request, [boolean
$ifmulti = false], [baoolean
$ifbuild = false] 
)

进行一次网络传输通信

Parameters:

string	$request:	发竤的请求命令
boolean	$ifmulti:	是否返回多行响应文本，否则为一行
baoolean	$ifbuild:	是否对响应进行处理

API Tags:

Access:

public

[ Top ]

dele [line 96]

string dele(
int
$n 
)

处理 server 标记删除，QUIT 命令执行时才真正删除

Parameters:

int

$n:

指定邮件

API Tags:

Access:

public

[ Top ]

getList [line 76]

string getList(
[int
$n = null] 
)

处理 server 返回指定邮件的大小等

Parameters:

int

$n:

指定邮件

API Tags:

Access:

public

[ Top ]

getMailContent [line 240]

void getMailContent(
$content
$content, [$sep
$sep = "\n\n"] 
)

获取解析后的内容

Parameters:

$content	$content:
$sep	$sep:

API Tags:

Access:

public

[ Top ]

string login(
string
$username, string
$password 
)

登陆pop3

Parameters:

string	$username:	用户名
string	$password:	密码

API Tags:

Access:

public

[ Top ]

noop [line 123]

string noop(
)

处理 server 返回一个肯定的响应

API Tags:

Access:

public

[ Top ]

open [line 36]

string open(
)

打开pop3服务器,建立连接

API Tags:

Access:

public

[ Top ]

quit [line 134]

string quit(
)

希望结束会话。如果 server 处于"处理" 状态，

则现在进入"更新"状态，删除那些标记成删除的邮件。如果 server 处于"认可"状态，则结束会话时 server 不进入"更新"状态。

API Tags:

Access:

public

[ Top ]

request [line 195]

void request(
string
$request 
)

发送pop3命令

Parameters:

string

$request:

API Tags:

Access:

public

[ Top ]

response [line 206]

string response(
[boolean
$multi = false], [int
$timeout = null] 
)

验证请求

Parameters:

boolean	$multi:
int	$timeout:

API Tags:

Access:

public

[ Top ]

responseLine [line 151]

void responseLine(
[int
$timeout = null] 
)

pop3响应请求

Parameters:

int

$timeout:

API Tags:

Access:

public

[ Top ]

retr [line 87]

string retr(
int
$n 
)

处处理 server 返回邮件的全部文本

Parameters:

int

$n:

指定邮件

API Tags:

Access:

public

[ Top ]

rset [line 104]

string rset(
)

处理撤消所有的 DELE 命令

API Tags:

Access:

public

[ Top ]

stat [line 56]

string stat(
)

处理请求 server 回送邮箱统计资料，如邮件数、邮件总字节数

API Tags:

Access:

public

[ Top ]

top [line 114]

string top(
int
$n, [int
$m = null] 
)

处理返回 n 号邮件的前 m 行内容，m 必须是自然数

Parameters:

int	$n:	指定邮件
int	$m:	指定邮件前多少行

API Tags:

Access:

public

[ Top ]

uidl [line 65]

string uidl(
[int
$n = null] 
)

处理 server 返回用于该指定邮件的唯一标识，如果没有指定，返回所有的。

Parameters:

int

$n:

指定邮件

API Tags:

Access:

public

[ Top ]

Constants

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

[ Top ]

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

	mail protocol

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