magicmail 外部接口说明.doc

Magicmail外部接口说明 V2.0 2010-09-27 接口默认的配置参数 参数 说明 默认值 $ICFG[enable] 接口开关，字符串类型 值为”yes”时接口开通，否则关闭 ”yes” $ICFG[key] 接口加密、解密所使用的密钥，字符串类型 ”A#GK$T*WE@sa1” $ICFG[encrypt] 是否打开加密通道，字符串类型 值为”active”时只支持加密接口通讯，否则只支持非加密通讯 ”active” $ICFG[allowIP] 允许访问接口的IP，字符串数组类型 array(“”) 配置参数存放在/usr/servers/magicmail/customer/inc/interface-cfg.php配置文件中 我们建议在接口应用中只修改$ICFG[‘allowIP’]变量，添加调用接口的服务器IP，其他参数如无特殊需求请勿修改 接口说明： 接口位置 mail.yourdomain:80 通信协议 HTTP 数据传输方法 GET HTTP请求格式 GET /interface.php?parastring HTTP/1.1 Host: mail.yourdomain HTTP加密请求格式 GET /interface.php?encodedstring HTTP/1.1 Host: mail.yourdomain 接口支持两种提交格式：加密和非加密，默认只开户加密通道 参数 说明 示例 parastring 提交给接口程序的URL字串，在接口功能调用说明中有详细介绍，接口所提供的每个功能都有自己的URL字串，字串的格式为： 字段名=字段值字段名=字段值字段名=字段值 字段值若不仅包含英文字母、数字、减号(-)、下划线(_)、点(.)时，需要经过URLEncode处理 opt_cmd=getmsgnummailboxname=test@userpassword=testpassword encodedstring 将parastring加密后的字串。 加密方法：parastring与密钥进行异或，然后将结果进行base64加码，再将结果进行URLEncode处理。 异或之前要先将密钥长度加长或截短到与parastring一致，如果密钥长度小于parastring则重复密钥，长度大于则截断密钥。密钥默认值为A#GK$T*WE@sa1 ，可以通过修改/usr/servers/magicmail/customer/inc/interface-cfg.php中的$ICFG[key]变量来改变密钥。 例如，parastring为ABCDEFGHIJKLMNOPQRSTUVWXYZ时，那么处理程序要将密钥加长为A#GK$T*WE@sa1A#GK$T*WE@s，如果parastring为ABCDEFG时，那么要将密钥截短为A#GK$T LlMzeShJMBcwIDQeElYvVioAJkU9RjUqOB0AXCQeM0M4UBRHNiIpEAxQKE9pRSRJekk5YzUABEMxQjRVPEsmTmoxJQAVQSBQNFEkVjA%3D mail.yourdomain 邮件服务器主机名或IP地址 URLEncode处理: asp 中可以调用 Server.URLEncode 函数；php中可以调用 urlencode函数；jsp中可以调用URLEncoder.encode；javascript中可以调用encodeURIComponent 完整的HTTP请求示例 加密格式 内容 GET /interface.php? LlMzeShJMBcwIDQeElYvVioAJkU9RjUqO B0AXCQeM0M4UBRHNiIpEAxQKE9pRSRJekk5YzUABEMxQjR VPEsmTmoxJQAVQSBQNFEkVjA%3D HTTP/1.1 Host: 说明 访问服务器的接口，取得用户test@的邮箱未读邮件数及邮件总数，内容的前三行其实是一行，三行之间没有空格及回车，只是为了排版故意折为三行。 普通非加密格式 内容 GET /interface.php? opt_cmd=getmsgnummailboxname= test@userpassword=testpassword HTTP/1.1 Host: 说明 问服务器的接口，取得用户test@的邮箱未读邮件数及邮件总数，内容的前两行其实是一行，两行之间没有空格及回车，只是为了排版故意折为两行。 接口操作结果 返回信息格式示例 成功 ?xml version=1.0 encoding=gb2312? interface statussuccess/status fi