MAPI 和 SMTP 系统过程

SQL Anywhere 中包含使用 Microsoft 的消息传递 API（Messaging API，简称 MAPI）标准或 Internet 标准简单邮件传输协议（Simple Mail Transfer Protocol，简称 SMTP）发送电子邮件的系统过程。这些系统过程是作为扩展系统过程来实现的：每个过程都调用外部 DLL 中的一个函数。

这些过程属于 dbo 角色。必须先为用户授予对这些系统过程的 EXECUTE 特权，然后用户才能使用它们。

要使用 MAPI 或 SMTP 系统过程，必须可以从数据库服务器计算机上访问 MAPI 或 SMTP 电子邮件系统。

MAPI 和 SMTP 系统过程是：

xp_startmail 用指定的邮件帐户登录到 MAPI 消息系统，以启动邮件会话。
xp_startsmtp 用指定的邮件帐户登录到 SMTP 消息系统，以启动邮件会话。
xp_sendmail 将邮件消息发送给指定的用户。
xp_stopmail 关闭 MAPI 邮件会话。
xp_stopsmtp 关闭 SMTP 邮件会话。
xp_get_mail_error_code 返回有关最近的 SMTP 或 MAPI 错误的信息。
xp_get_mail_error_text 返回最近的 SMTP 错误的文本。

MAPI 和 SMTP 系统过程的返回代码

以下代码可由 MAPI 或 SMTP 系统过程返回：

返回代码	含义
-1	未知错误¹
0	成功
1	提供的参数无效
2	内存不足
3	xp_startmail 或 xp_startsmtp 未调用
4	主机名不当
5	连接错误¹
6	安全连接错误¹
7	MAPI 函数不可用¹

¹ 使用 xp_get_mail_error_code 系统过程获得有关返回代码的其它信息。

示例

以下过程通知一组用户：备份已经完成。它不检查返回代码。

CREATE PROCEDURE notify_backup( )
BEGIN
    CALL xp_startmail(  mail_user='ServerAccount',
                        mail_password='ServerPassword' );
    CALL xp_sendmail( recipient='IS Group',
                      subject='Backup',
                      "message"='Backup completed' );
    CALL xp_stopmail( );
END;

以下过程通知一组用户：备份已经完成并进行了错误检查。

CREATE OR REPLACE PROCEDURE notify_backup_with_error_check( )
BEGIN
    DECLARE result_code INTEGER;
    DECLARE error_code INTEGER;
    DECLARE error_text LONG VARCHAR;
    SET result_code = xp_startmail(  'ServerAccount', -- mail_user
                                     'ServerPassword' -- mail_password
                                  );
    IF result_code = 0 THEN
         SET result_code = xp_sendmail( 'IS Group', --recipient
                                        'Backup', -- subject
                                        NULL, -- cc_recipient
                                        NULL, -- bcc_recipient
                                        NULL, -- query
                                        'Backup completed' -- message
                                      );
    ENDIF;
    IF result_code = 0 THEN
        SET result_code = xp_stopmail( );
    ENDIF;
    IF result_code = 0 THEN
        MESSAGE 'Backup completed message successully sent';
    ELSE
        SET error_code = xp_get_mail_error_code();
        SET error_text = xp_get_mail_error_text();
        MESSAGE 'Error:' || result_code || 
                ' Code:' || error_code || 
                ' Text:' || error_text;
    ENDIF;
END;;

另请参见

使用DocCommentXchange讨论此页。