KingbaseES命令行邮件客户端使用指南.pdf

KingbaseES 命令行邮件客户端使用指南 金仓数据库管理系统 KingbaseES 文档版本：V9（V009R001C001B0024） 发布日期：2023 年 10 月 12 日 北京人大金仓信息技术股份有限公司 目 目 录 录 第 1 章 前言 1 1.1 适用读者 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1.2 相关文档 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1.3 术语 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1.4 手册约定 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 第 2 章 邮件客户端工具 3 2.1 客户端配置文件 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 2.2 发送邮件 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 2.3 工具的限制条件 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 版权声明 6 服务周期承诺 7 I 第 1 章 前言 1 第 章 前言 本文描述了 KingbaseES 内置的命令行邮件客户端的使用方法。 前言部分包含以下主题： • 适用读者 • 相关文档 • 术语 • 手册约定 1.1 适用读者 本文面向所有使用 KingbaseES 的用户，主要是数据库管理员 (DBAs) 和应用程序开发人员。 1.2 相关文档 1.3 术语 1.4 术语 定义 SMTP （Simple Mail Transfer Protocol）简单邮件传输协议是基于 TCP/IP 的网络协议。 手册约定 本文档中可能出现“注意、提示、警告、另请参阅”等标志，它们所代表的含义如下： 1 第 1 章 前言 注意: 用于突出重要/关键信息、最佳实践等。 提示: 用于突出小窍门、捷径等。 警告: 用于传递设备或环境安全警示信息，若不避免，可能会导致设备损坏、数据丢失、设备性能降低或其 它不可预知的结果。 另请参阅: 用于突出参考、参阅等。 以下程序代码书写约定适用于本文档： 符号 说明 [] 表示包含一个或多个可选项。不需要输入中括号本身。 {} 表示包含两个以上（含两个）的候选，必须在其中选取一个。不需要输入花括号本身。 | 分割中括号或者花括号中的两个或两个以上选项。不需要输入“|”本身。 ... 表示其之前的元素可以被重复。 斜体 表示占位符或者需要提供特定值的变量。 大写 表示系统提供的元素，以便与用户定义的元素相互区分。除出现在方括号中的元素外，应当按 照顺序逐字输入。当然，部分元素在系统中是大小写不敏感的，因此用户可以根据系统说明以 小写形式输入。 小写 表示由用户提供的元素。 2 第 2 章 邮件客户端工具 2 第 章 邮件客户端工具 本章节包含以下内容： • 客户端配置文件 • 发送邮件 • 工具的限制条件 数据库系统管理人员可以通过命令行邮件客户端，发送数据库系统的通报、告警等关键信息。 客户端支持 SMTP 协议，适配常见的邮件服务器。 常用配置信息保存在邮件客户端配置文件中，命令行调用时简洁明了。 一次调用发送一封电子邮件。 2.1 客户端配置文件 配置文件模板位于安装目录./share/sys_mail.conf; 客户端工具默认读取此目录的配置文件。 # smtp-security - none smtp-security=none # smtp-auth - login smtp-auth=login # mail-attachement-size-limit, fixed in MB，1~1024 可选范围 mail-attachement-size-limit=10 # log-path log-path=/tmp/ # smtp-from 发送邮件的源邮箱地址 smtp-from=from@abc.com # smtp-server 邮件服务器的 IP 地址和域名地址 smtp-server=192.168.1.2 # smtp-server 邮件服务器的工作端口，默认值 25 3 第 2 章 邮件客户端工具 smtp-port=25 # smtp-user 邮件服务器的登录用户名 # 注意：smtp-user 跟 smp-from 是不同的概念，具体与邮件服务器本身设置和要求有关，多数场景下是同样的字符串。 smtp-user=from@abc.com # smtp-pass 邮件服务器的登录密码或授权码，base64 后的字符串 # 大多数互联网邮件服务提供商，必须使用授权码供第三方邮件客户端登录 smtp-pass=pwd # smtp-to 邮件的接收方，多个邮件地址以【,】分隔 smtp-to=target@dest.com 发送邮件 2.2 命令行客户端工具由一个二进制文件构成，包含在 KingbaseES 安装包中。 命令行客户端工具位于安装目录./bin/sys_mail。 命令行客户端选项包含： sys_mail // -f 指定其他的配置文件，默认读取工具当前目录的../share/sys_mail.conf // 此选项默认为 ../share/sys_mail.conf 可不提供 -f other.conf // -s 邮件主题 -s 'mail subject' // -b 邮件内容， 与-B 选项互斥，只能二选一 -b 'mail // -B \nbody' 邮件内容来源文件， 与-b 选项互斥，只能二选一 -B input.txt // -a 邮件附件，可选参数，可重复，支持数目 0~9 -a 邮件附件 // 可选参数，是邮件的接收邮箱 target@abc.com // 可选参数， 支持以空格分开的多个接收邮箱 target2@abc.com 使用示例： ./sys_mail -s 'Kingbase 告警来自集群 192.168.1.34' -b " 告警：数据库系统备机 192.168.1.34 的存储空间剩余不足 1G，请尽快处理" 4 第 2 章 邮件客户端工具 2.3 工具的限制条件 邮件主题 <= 128 个字节 邮件正文 <= 8192 字节 附件的数量 0 <= X <=9 附件的大小在 sys_mail.conf 中配置附件大小，默认 <=10M 收件人的数量 1<= X <= 128 5 版权声明 版权声明 北京人大金仓信息技术股份有限公司（简称：人大金仓）版权所有，并保留对本手册及本声明的一切权利。 未得到人大金仓的书面许可，任何人不得以任何方式或形式对本手册内的任何部分进行复制、摘录、备份、修 改、传播、翻译成其他语言、将其全部或部分用于商业用途。 免责声明 本手册内容依据现有信息制作，由于产品版本升级或其他原因，其内容有可能变更。人大金仓保留在没有任何通 知或者提示的情况下对手册内容进行修改的权利。 本手册仅作为使用指导，人大金仓在编写本手册时已尽力保证其内容准确可靠，但并不确保手册内容完全没有错 误或遗漏，本手册中的所有信息也不构成任何明示或暗示的担保。 技术支持 • 人大金仓官方网站：http://www.kingbase.com.cn/ • 人大金仓文档中心：http://help.kingbase.com.cn/ • 全国服务热线：400-601-1188 • 人大金仓技术支持与反馈信箱：support@kingbase.com.cn 6 服务周期承诺 服务周期承诺 由于市场需求在不断变化，技术创新和发展的进程不断加剧，产品的版本更迭不可避免。人大金仓对于产品版本 生命周期的有效管理，有助于您提前规划项目，更好地从产品服务终止上过渡。 表 1: KingbaseES 产品生命周期里程碑 关键里程碑点 定义 产品发布日期 产品正式发布版本，即 GA（general availability）版本的发布日期。 停止销售日期 正式停止销售的日期，版本停止接受订单日。该日之后，产品将不再销售。 停止功能升级日期 在该日期之后，不再提供新特性和新硬件支持。但依旧提供错误修复、安全修复、功 能维护等服务。 停止功能维护日期 在该日期之后，不再维护功能，修复问题。但依旧提供安全修复等服务 停止安全维护日期 在该日期之后，不再发布补丁版本修复中高风险漏洞，仅提供有限的支持。 产品服务终止日期 停止提供产品服务和支持的日期。包括软件维护版本，缺陷修复，以及针对该产品的 所有服务支持（包括服务热线和远程/现场支持）。 服务周期策略 金仓数据库管理系统 KingbaseES 产品确保以下的服务周期： 1）产品自发布之日起至产品停止功能升级（包含新特性、新硬件支持）之日不少于 5 年。 2）产品停止功能升级之日起至产品停止功能维护（主要包括问题修复）之日不少于 4 年。 3）产品功能维护停止之日起至产品停止安全维护（包括中高风险漏洞修复）之日不少于 2 年。 服务终止策略 金仓数据库管理系统 KingbaseES 产品确保在销售后，至少提供 6 年的服务支持。 注意: 人大金仓将会综合各方因素来确定产品服务终止日期。并将在实际产品服务终止日期之前至少 90 天，通过公 7 服务周期承诺 开方式宣布产品服务终止日期。 8