FastOS
API
首页
教程
API
相关下载
社区
在线调试工具
接口规范
云主机服务
云虚拟主机
云数据库
企业邮局
相关代码
消息推送
其它服务
端口转发
# 1、企业邮局描述 企业邮局能够使企业使用自己的独立域名做为电子邮箱的后缀,并且域名管理员能够管理域名下的邮箱用户。 # 2、运行平台 系统支持管理多平台创建的云主机,如:WinWebMail、Winmail等邮件服务器软件 当前支持软件对应表格如下: |平台名称|简称| | ------------ | ------------ | |WinWebMail Server|WinWebMail| ## 2.1、使用前准备 ### 2.1.1 运行环境 FastOSAPI采用WinWebMail做为企业邮局服务器,下载地址为:http://www.winwebmail.com/ ### 2.1.2 WinWebMail的安装及配置 [点击此处跳转到安装配置教程](/doc/course/winwebmail.html "点击此处跳转到安装配置教程") # 3、接口目录 ##3.1 接口目录列表 |接口名称|接口描述| | ------------ | ------------ | |[EMail.AddUserDomain](#4、EMail.AddUserDomain "EMail.AddUserDomain")|创建域名及管理员邮箱| |[EMail.GetUsersByDomain](#5、EMail.GetUsersByDomain "EMail.GetUsersByDomain")|获取域名下用户列表| |[EMail.GetUserNumByDomain](#6、EMail.GetUserNumByDomain "EMail.GetUserNumByDomain")|根据域名获取用户数| |[EMail.GetManageDomainInfo](#7、EMail.GetManageDomainInfo "EMail.GetManageDomainInfo")|获取域名信息| |[EMail.DelDomain](#8、EMail.DelDomain "EMail.DelDomain")|删除域名操作,应注意,**删除域名的同时会删除域名下的所有用户及邮件数据**| |[EMail.CheckDomainExists](#9、EMail.CheckDomainExists "EMail.CheckDomainExists")|判断域名是否存在| |[EMail.ChaDomainMaxSize](#10、EMail.ChaDomainMaxSize "EMail.ChaDomainMaxSize")|修改域名最大可用容量| |[EMail.ChaDomainMaxUser](#11、EMail.ChaDomainMaxUser "EMail.ChaDomainMaxUser")|修改域名最大可用容量| |[EMail.ChaDomainEndDate](#12、EMail.ChaDomainEndDate "EMail.ChaDomainEndDate")|修改域名到期日期| |[EMail.AddUser](#13、EMail.AddUser "EMail.AddUser")|添加邮箱用户| |[EMail.CheckUserExists](#14、EMail.CheckUserExists "EMail.CheckUserExists")|判断用户是否存在| |[EMail.GetUserStateByName](#15、EMail.GetUserStateByName "EMail.GetUserStateByName")|判断用户是否禁用| |[EMail.GetUserSize](#16、EMail.GetUserSize "EMail.GetUserSize")|获取用户最大容量| |[EMail.ChangeSizeState](#17、EMail.ChangeSizeState "EMail.ChangeSizeState")|修改用户密码| |[EMail.IsDomainManager](#18、EMail.IsDomainManager "EMail.IsDomainManager")|判断是否为域名管理员| ##3.2错误代码 |代码|描述| | ------------ | ------------ | |601001|域名格式有误| |601002|管理员账号格式有误,应为完整的邮箱账号,如:manager@yourdomain.com,且不能是:admin@yourdomain.com| |601003|管理员账号的域名部分需与Domain一致| |601004|密码格式有误,应在6~15位之间任意字符| |601005|请输入域名最大可分配容量,单位:MB| |601006|最大用户数必须大于0| |601007|到期时间格式错误,正确格式为int类型:yyyyMMdd,如:20220916| |601008|系统未检测到WinWebMail,请检查astOSAPI服务端的WinWebMail安装路径是否正确| |601009|WinWebMail的访问域名未设置,请检查FastOSAPI服务端的配置是否正确| |601010|WinWebMail的web配置文件web.config不存在,请检查是否已配置| |601011|WinWebMail未设置接口秘钥| |601012|FastOSAPI访问WinWebMail接口出错| |601013|用户名格式错误,应为完整的邮箱账号,如:service@yourdomain.com,且不能是:admin@yourdomain.com| |601014|域名不存在| |601015|该域名已超过最大用户数| |601016|超过可分配空间| |601017|分配空间应大于0,单位:MB| |601018|域名已经存在| |601019|用户已经存在| |601020|用户不存在| # 4、EMail.AddUserDomain ### 4.1 接口描述 创建域名及管理员邮箱 ### 4.2 接口参数 |接口名称|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |Domain|String|-|必填|域名,如:yourdomain.com| |UserName|String|-|必填|域名管理员邮箱,应为完整的邮箱账号,如:manager@yourdomain.com,且不能是:admin@yourdomain.com| |UserPass|String|-|必填|管理员登陆密码,应在6~15位之间任意字符| |MaxUser|Int|-|必填|最大用户数量,需大于0,单位:MB| |MaxSize|Int|-|必填|域名最大可分配空间容量,需大于0,单位:MB| |EndDate|Int|-|必填|到期时间,正确格式为int类型:yyyyMMdd,如:20220916| ### 4.3 接口示例 ` http://yourhost:2390/api/service/EMail.AddUserDomain?Domain=test2.com&UserName=manage%40test2.com&UserPass=123456&MaxUser=20&MaxSize=500&EndDate=20230920 ` ### 4.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":"success"} ``` # 5、EMail.GetUsersByDomain ### 5.1接口描述 获取域名下用户列表 ### 5.2接口参数 |接口名称|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |Domain|String|-|必填|域名,如:yourdomain.com| ### 5.3接口示例 ` http://yourhost:2390/api/service/EMail.GetUsersByDomain?_RPW_IsAsyn=0&Domain=test2.com&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220922212303703&_RPW_Sign=3EF091EFAB5C1F0C1EB5995862B83A5F ` ### 5.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":["manage@test2.com"]} ``` # 6、EMail.GetUserNumByDomain ### 6.1接口描述 根据域名获取用户数 ### 6.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |Domain|String|-|必填|域名,如:yourdomain.com| ### 6.3接口示例 ` http://yourhost:2390/api/service/EMail.GetUserNumByDomain?_RPW_IsAsyn=0&Domain=test2.com&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220922212630817&_RPW_Sign=9628D20139D22B15D5FF5BE5B7D9AC11 ` ### 6.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":1} ``` # 7、EMail.GetManageDomainInfo ### 7.1接口描述 获取域名信息 ### 7.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |Domain|String|-|必填|域名,如:yourdomain.com| ### 7.3接口示例 ` http://yourhost:2390/api/EMail.GetManageDomainInfo? _RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220902144642822&_RPW_Sign=85FE60727C7E91EBF30D3BA0B9312737&VMName=cvm_1 ` ### 7.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":{"users":["manage@test2.com"],"MaxUser":20,"Domain":"test2.com","MaxSize":500,"EndDate":20230920,"AllSize":97,"Manager":"manage@test2.com"}} ``` # 8、EMail.DelDomain ### 8.1接口描述 删除域名操作,应注意,**删除域名的同时会删除域名下的所有用户及邮件数据** ### 8.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述 | ------------ | ------------ | ------------ | ------------ | ------------ | |Domain|String|-|必填|域名,如:yourdomain.com| ### 8.3接口示例 ` http://yourhost:2390/api/service/EMail.DelDomain? _RPW_IsAsyn=0&Domain=test2.com&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220923171258140&_RPW_Sign=956A13157EA2732E17235C01A87D47CE ` ### 8.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":""} ``` # 9、EMail.CheckDomainExists ### 9.1接口描述 判断域名是否存在 ### 9.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |Domain|String|-|必填|域名,如:yourdomain.com| ### 9.3接口示例 ` http://yourhost:2390/api/service/EMail.CheckDomainExists? _RPW_IsAsyn=0&Domain=test2.com&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220923171553675&_RPW_Sign=855522D57110E0D06A3406AFB17E49A0 ` ### 9.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":false} ``` # 10、EMail.ChaDomainMaxSize ### 10.1接口描述 修改域名最大可用容量 ### 10.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |Domain|String|-|必填|域名,如:yourdomain.com| |MaxSize|Int|-|必填|域名最大可分配容量,单位:MB| ### 10.3接口示例 ` http://yourhost:2390/api/service/EMail.ChaDomainMaxSize? _RPW_Sign=5F2B0C385E879862EB1F4FDFBDEADB1C&Domain=test2.com&MaxSize=2048&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220923171911163 ` ### 10.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":"success"} ``` # 11、EMail.ChaDomainMaxUser ### 11.1接口描述 修改域名最大可用容量 ### 11.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |Domain|String|-|必填|域名,如:yourdomain.com| |MaxUser|Int|-|必填|最大用户数量| ### 11.3接口示例 ` http://yourhost:2390/api/service/EMail.ChaDomainMaxUser? _RPW_Sign=DA98F20F2ECA2809FA80A0C81F70901B&_RPW_QueueId=20220923172143292&Domain=test2.com&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&MaxUser=1000 ` ### 11.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":"success"} ``` # 12、EMail.ChaDomainEndDate ### 12.1接口描述 修改域名到期日期 ### 12.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |Domain|String|-|必填|域名,如:yourdomain.com| |EndDate|Int|-|必填|到期时间,正确格式为int类型:yyyyMMdd,如:20220916| ### 12.3接口示例 ` http://yourhost:2390/api/service/EMail.ChaDomainMaxUser? _RPW_Sign=DA98F20F2ECA2809FA80A0C81F70901B&_RPW_QueueId=20220923172143292&Domain=test2.com&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&EndDate=20230916 ` ### 12.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":"success"} ``` # 13、EMail.AddUser ### 13.1接口描述 添加邮箱用户 ### 13.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |Domain|String|-|必填|域名,如:yourdomain.com| |UserName|String|-|必填|邮箱用户名,应为完整的邮箱账号,如:manager@yourdomain.com,且不能是:admin@yourdomain.com| |Password|String|-|必填|邮箱登陆密码,应在6~15位之间任意字符| |Size|Int|-|必填|邮箱空间容量,需大于0,单位:MB| ### 13.3接口示例 ` http://yourhost:2390/api/service/EMail.AddUser? _RPW_Sign=DA98F20F2ECA2809FA80A0C81F70901B&_RPW_QueueId=20220923172143292&Domain=test2.com&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&UserName=master@test2.com&Password=1233213&Size=200 ` ### 13.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":"success"} ``` # 14、EMail.CheckUserExists ### 14.1接口描述 判断用户是否存在 ### 14.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |UserName|String|-|必填|邮箱用户名,应为完整的邮箱账号,如:master@yourdomain.com| ### 14.3接口示例 ` http://yourhost:2390/api/service/EMail.CheckUserExists? _RPW_Sign=DA98F20F2ECA2809FA80A0C81F70901B&_RPW_QueueId=20220923172143292&_RPW_IsAsyn=0&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&UserName=master@test2.com ` ### 14.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":true} ``` # 15、EMail.GetUserStateByName ### 15.1接口描述 判断用户是否禁用 ### 15.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |UserName|String|-|必填|邮箱用户名,应为完整的邮箱账号,如:master@yourdomain.com| ### 15.3接口示例 ` http://yourhost:2390/api/service/EMail.GetUserStateByName? _RPW_IsAsyn=0&UserName=manage%40test1.com&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220923192522054&_RPW_Sign=A8183D0DD8E90292A45F42A69B45E222 ` ### 15.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":false} ``` # 16、EMail.GetUserSize ### 16.1接口描述 获取用户最大容量 ### 16.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |UserName|String|-|必填|邮箱用户名,应为完整的邮箱账号,如:master@yourdomain.com| ### 16.3接口示例 ` http://yourhost:2390/api/service/EMail.GetUserSize? RPW_IsAsyn=0&UserName=manage%40test1.com&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220923192755354&_RPW_Sign=9701871D111506139D662F1814F033ED ` ### 16.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":97.65625} ``` # 16、EMail.DelUser ### 16.1接口描述 删除用户 ### 16.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |UserName|String|-|必填|邮箱用户名,应为完整的邮箱账号,如:master@yourdomain.com| ### 16.3接口示例 ` http://yourhost:2390/api/service/EMail.DelUser? RPW_IsAsyn=0&UserName=manage%40test1.com&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220923192755354&_RPW_Sign=9701871D111506139D662F1814F033ED ` ### 16.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":"success"} ``` # 17、EMail.ChangeSizeState ### 17.1接口描述 修改用户密码 ### 17.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |UserName|String|-|必填|邮箱用户名,应为完整的邮箱账号,如:master@yourdomain.com| |MaxSize|Int|-|必填|邮箱最大容量,单位:MB| |State|Boolean|-|必填|是否禁用,false为不禁用,true为禁用| ### 17.3接口示例 ` http://yourhost:2390/api/service/EMail.ChangeUserPass? RPW_IsAsyn=0&UserName=manage%40test1.com&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220923192755354&_RPW_Sign=9701871D111506139D662F1814F033ED&Password=123123&MaxSize=102400&State=false ` ### 17.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":"success"} ``` # 18、EMail.IsDomainManager ### 18.1接口描述 判断是否为域名管理员 ### 18.2接口参数 |参数名|数据类型|默认值|是否必填|参数描述| | ------------ | ------------ | ------------ | ------------ | ------------ | |UserName|String|-|必填|邮箱用户名,应为完整的邮箱账号,如:master@yourdomain.com| ### 18.3接口示例 ` http://yourhost:2390/api/service/EMail.IsDomainManager? RPW_IsAsyn=0&UserName=master%40test1.com&_RPW_BindId=947DBDC3B36A406FBEA8076D7B811584&_RPW_QueueId=20220923192755354&_RPW_Sign=9701871D111506139D662F1814F033ED&Password=123123&MaxSize=102400&State=false ` ### 18.4接口返回成功示例 ```json {"aqid":"","state":true,"err":{"code":0,"msg":"success"},"count":0,"code":0,"msg":"success","data":false} ```