YStudio Y++

邮件类

Y++ / YStudio 开发文档 · 一点滴

类对象支持库(不是扁平命令)。路径:支持库 → 扩展类库 → 邮件类。

类型名必须写完整「邮件类」。声明时自动创建,一般无需再调 创建*。

硬约束

  1. 类型名必须写「邮件类」。
  2. SMTP/收发相关参数(服务器、端口、账号)按方法签名填写。

快速开始

邮件类 m
// 置服务器 / 发送:见下方命令介绍

邮件类/创建

共 1 条。

创建邮件

  • 签名:通用 创建邮件()
  • 说明:邮件会话。一般直接写「邮件类 mail」,不必先调本命令。

邮件类/方法

共 34 条。

置服务器

  • 签名:无 置服务器(文本 主机, 整数 端口, [整数 模式=0])
  • 说明:设置 SMTP 主机/端口/模式。模式:0明文、1=SMTPS、2=STARTTLS。
  • 参数一│文本 主机: SMTP 主机名或 IP
  • 参数二│整数 端口: 如 25/465/587
  • 参数三│[整数 模式=0]: 0明文、1直连TLS、2 STARTTLS

置账号

  • 签名:无 置账号(文本 用户, 文本 密码)
  • 说明:设置 AUTH LOGIN 用户名与密码;用户为空则不认证。
  • 参数一│文本 用户: 登录名,常为邮箱
  • 参数二│文本 密码: 密码或应用专用密码

置发件人

  • 签名:无 置发件人(文本 地址, [文本 显示名=""])
  • 说明:设置 From 地址与可选显示名。
  • 参数一│文本 地址: 发件邮箱
  • 参数二│[文本 显示名=”“]: 显示名,可空

清空收件人

  • 签名:无 清空收件人()
  • 说明:清空收件人/抄送/密送列表。

添加收件人

  • 签名:逻辑 添加收件人(文本 地址)
  • 说明:追加一个 To 地址。
  • 参数一│文本 地址: 收件邮箱

添加抄送

  • 签名:逻辑 添加抄送(文本 地址)
  • 说明:追加一个 Cc 地址。
  • 参数一│文本 地址: 抄送邮箱

添加密送

  • 签名:逻辑 添加密送(文本 地址)
  • 说明:追加一个 Bcc 地址。
  • 参数一│文本 地址: 密送邮箱

置主题

  • 签名:无 置主题(文本 主题)
  • 说明:设置邮件主题(支持中文,自动 RFC2047)。
  • 参数一│文本 主题: 主题文本

置正文

  • 签名:无 置正文(文本 内容)
  • 说明:设置纯文本正文。
  • 参数一│文本 内容: 纯文本

置正文HTML

  • 签名:无 置正文HTML(文本 HTML)
  • 说明:设置 HTML 正文(有 HTML 时优先作为 multipart 主体)。
  • 参数一│文本 HTML: HTML 片段或整页

清空附件

  • 签名:无 清空附件()
  • 说明:清空已添加的附件路径。

添加附件

  • 签名:逻辑 添加附件(文本 路径)
  • 说明:追加本地文件为附件(发送时读取;过大将失败)。
  • 参数一│文本 路径: 本地文件路径

置超时

  • 签名:无 置超时(整数 毫秒)
  • 说明:设置连接/读写超时毫秒;≤0 按 30000。
  • 参数一│整数 毫秒: 超时

取超时

  • 签名:整数 取超时()
  • 说明:取当前超时毫秒。

置校验证书

  • 签名:无 置校验证书(整数 开启)
  • 说明:TLS 是否校验服务器证书;1校验、0不校验(仅调试)。
  • 参数一│整数 开启: 1校验、0跳过

发送

  • 签名:逻辑 发送()
  • 说明:按当前配置发送一封邮件;成功返回真。

取错误

  • 签名:文本 取错误()
  • 说明:取最近一次失败原因。

重置

  • 签名:无 重置()
  • 说明:断开收信、清空配置与错误信息,恢复默认超时等。

置收信服务器

  • 签名:无 置收信服务器(文本 主机, 整数 端口, [整数 模式=1], [整数 协议=0])
  • 说明:设置收信主机。模式:0明文 1直连TLS 2=STARTTLS;协议:0=POP3 1=IMAP。
  • 参数一│文本 主机
  • 参数二│整数 端口: POP3 常 110/995,IMAP 常 143/993
  • 参数三│[整数 模式=1]
  • 参数四│[整数 协议=0]: 0=POP3,1=IMAP

置邮箱

  • 签名:无 置邮箱(文本 名称)
  • 说明:IMAP 邮箱名,默认 INBOX;须在 收信连接 前设置。
  • 参数一│文本 名称: 如 INBOX、Sent

取邮箱

  • 签名:文本 取邮箱()
  • 说明:取当前 IMAP 邮箱名。

收信连接

  • 签名:通用 收信连接()
  • 说明:按置收信服务器/置账号连接 POP3 或 IMAP。

收信断开

  • 签名:通用 收信断开()
  • 说明:断开收信连接(IMAP 会 LOGOUT)。

是否已收信连接

  • 签名:通用 是否已收信连接()
  • 说明:收信会话是否仍连接。

取邮件数

  • 签名:整数 取邮件数()
  • 说明:当前邮箱邮件总数(须已收信连接)。

取邮件

  • 签名:通用 取邮件(整数 索引)
  • 说明:按 1 起索引拉取一封到本地缓存,再取主题/正文等。
  • 参数一│整数 索引: 从 1 起

删除邮件

  • 签名:通用 删除邮件(整数 索引)
  • 说明:标记删除(POP3 DELE / IMAP \Deleted+EXPUNGE)。索引从 1 起。
  • 参数一│整数 索引

取邮件主题

  • 签名:文本 取邮件主题()
  • 说明:最近一次取邮件 的主题(已解码)。

取邮件发件人

  • 签名:文本 取邮件发件人()
  • 说明:最近一次取邮件 的 From。

取邮件收件人

  • 签名:文本 取邮件收件人()
  • 说明:最近一次取邮件 的 To。

取邮件日期

  • 签名:文本 取邮件日期()
  • 说明:最近一次取邮件 的 Date 头。

取邮件正文

  • 签名:文本 取邮件正文()
  • 说明:纯文本正文;无则可能为空。

取邮件正文HTML

  • 签名:文本 取邮件正文HTML()
  • 说明:HTML 正文(若有)。

取邮件原文

  • 签名:文本 取邮件原文()
  • 说明:原始 RFC822 全文。

易错对照

错误 正确
类型写成「邮件」 必须「邮件类」

相关

HTTP类 · 编码类