| KKmail 邮件组件参考手册 |
| POP3Message 对象 |
|
| POP3Message 对象是属于 KKmail
邮件主体的解释对象,它可以基于 POP3Client 对象创建或者创建一个独立的对象实例,如果由 POP3Client
对象创建此对象,在对象初始化的时候,便会向 POP3 服务器下载指定的邮件源码数据,然后进行进一步的解码; 如果以独立实例创建,则可以通过
POP3Message 对象对本地的 .eml 文件进行解码。通过本对象,可以创建邮件的附件对象(POP3Attachment)。 |
|
| 属性列表 |
| 属性 |
数据类型 |
描述 |
| AttachmentCount |
整数 |
[R] 返回当前邮件的附件个数 |
| From |
字符串 |
[R] 返回邮件的发送者地址 |
| FromAlias |
字符串 |
[R] 返回邮件的发送者别名 |
| Incept |
字符串 |
[R] 返回邮件的接收者地址 |
| InceptAlias |
字符串 |
[R] 返回邮件的接收者别名 |
| InvokePath |
字符串 |
[RW] 设置或读取调用 KKmail 的主应用程序路径,默认值位
KKmail 文件的所在路径 |
| LogFile |
字符串 |
[RW] 指定或返回日志记录文件,默认值为与 KKmail
文件相同目录里的 KKmail.log 文件 |
| Logging |
整数 |
[RW] 设置或读取是否启用日志记录:
0: 否 (默认值)
1: 是 |
| MailCurrentSize |
整数 |
[R] 返回邮件当前下载的字节数 |
| Mailer |
字符串 |
[R] 返回邮件头 X-Mailer 域信息 |
| MailHeader |
字符串 |
[R] 返回当前邮件的邮件头信息 |
| MailHtml |
字符串 |
[R] 返回邮件的超文本(HTML)内容 |
| MailSize |
整数 |
[R] 返回邮件的字节数, 当邮件在下载过程中, 此属性为邮件的预估大小 |
| MailSource |
字符串 |
[R] 返回邮件的源码 |
| MailText |
字符串 |
[R] 返回邮件的纯文本(TEXT)内容 |
| MessageDateTime |
字符串 |
[R] 返回邮件发送的日期,字符串格式 |
| MessageID |
字符串 |
[R] 返回邮件头 Message-ID
域信息。注意,此项一般是邮件发送程序自行添加上去的标识,与服务器赋予每一封邮件的唯一标识(UIDL 标记)完全没有关系。 |
| MIMEVersion |
字符串 |
[R] 返回邮件头 MIME-Version 域信息,目前是 1.0 |
| Priority |
整数 |
[R] 返回当前邮件的优先级: 1 高, 3 普通, 5 低 |
| RegKey |
字符串 |
[W] 设置 KKmail 注册码 |
| RegUser |
字符串 |
[W] 设置 KKmail 注册用户账号 |
| ReplyTo |
字符串 |
[R] 返回邮件指定回复的地址 |
| ReplyToAlias |
字符串 |
[R] 返回邮件指定回复的别名 |
| RetainCopy |
整数 |
[RW] 设置或返回当前邮件是否有在服务器上保留副本:
0 否
1 是 (默认值)
如果 POP3Message 对象为非空的实例, 则本属性是由 POP3Client 对象继承; 独立创建的 POP3Message 对象实例,是用作对本地 .eml 文件解释,没有与 POP3 服务器连接,因而本属性则是无意义的 |
| SecurityLevel |
整数 |
[W] 设置对邮件正文解码的安全等级:
0: 普通模式
1: 安全模式
如果启用 安全模式 对邮件进行解码,邮件的正文内容则只会返回纯文本数据,而将可能含有恶意脚本的 HTML 代码内容作为附件文件。如果
POP3Message 对象是基于 POP3Client 创建,则本属性是由 POP3Client 对象继承的 |
| Subject |
字符串 |
[R] 返回邮件的主题 |
| TimeoutSecond |
整数 |
[W] 设置跟服务器通讯的指令时限,单位:
秒,每个通讯指令超过此属性值,将会发生超时中断任务,默认值为 10 秒 |
| UIDL |
字符串 |
[R] 返回当前邮件在服务器中的唯一标识 |
说明: 以上属性项并非全部同时支持读与写: [R] 只读; [W] 只写; [RW] 可读写
|
| 方法 |
- OpenMessage
语法: OpenMessage plMailID
描述: 下载并打开指定索引的邮件
参数: plMailID, 整数, 需要被打开的邮件索引ID
|
- OpenAttachment
语法: OpenAttachment plAttachmentID
描述: 创建附件对象实例 返回: 创建成功返回一个
POP3Attachment 对象实例; 创建失败则返回 Nothing 参数: plAttachmentID, 整数, 需要被打开的
附件索引ID
|
- SaveToFile
语法: SaveToFile psFileName
描述: 将当前的邮件源码数据保存为本地的 .eml 邮件文件
参数: psFileName 保存的目标文件的路径与名称
|
- LoadFromFile
语法: LoadFromFile psFileName
描述: 加载本地现有的 .eml 文件到 POP3Message 对象实例中,进行解释。一般情况下,POP3Message
对象是独立创建的实例。
参数: psFileName 需要加载的邮件文件的路径与名称
|
| 示例 [显示↓] |
- 基于 POP3Client 对象创建的信件对象:
Dim myPop3 As Object Dim myMessage As Object
Dim myAttacthment As Object Set myPop3 = CreateObject("KKmail.POP3Client") myPop3.RegUser = "Duclika" myPop3.RegKey = "3963F1-493488B81F" myPop3.Logging = 1 myPop3.LogFile = App.Path & "\KKmail_POP3.log" myPop3.Host = "pop.163.com" myPop3.User = "Duclika@163.com" myPop3.Password = "mypassword" myPop3.RetainCopy = 1 If myPop3.ConnectToServer() = 0 Then '创建信件对象 Set myMessage = myPop3.MailMessage(1)
Text1.Text = myMessage.Subject
Text2.Text = myMessage.MailHtml
myMessage.SaveToFile App.Path & "\mymail.eml"
'创建附件对象,第二个附件 Set myAttacthment = myMessage.OpenAttachment(2)
....
.... Else MsgBox "连接POP3服务器失败" End If myPop3.ConnectClose Set myPop3 = Nothing
- 独立创建的 POP3Message 对象实例:
Dim myMessage As Object
Dim myAttacthment As Object
Set myMessage = CreateObject("KKmail.POP3Message")
myMessage.RegUser = "Duclika"
myMessage.RegKey = "3963F1-493488B81F"
myMessage.LoadFromFile App.Path & "\mymail2.eml"
Text1.Text = myMessage.Subject
Text2.Text = myMessage.MailHtml
'创建附件对象,第一个附件
Set myAttacthment = myMessage.OpenAttachment(1)
....
....
Set myMessage = Nothing
|
| 参阅 |
| POP3Client 对象 | POP3Attachment 对象 |
|
|
|