售前咨询
4008-753-365 , (021) 6695-7999
* 在线交谈可咨询售前、售后等问题,在您开始接入 SUBMAIL 产品时,售前顾问和售后技术支持工程师可帮助您解决遇到的任何使用问题
售前顾问咨询 09:00 - 20:00 (24x7)
购物车
在线商务咨询
咨询热线:4008 753 365 (021) 6695 7999
返回顶部

SUBMAIL C# SDK

 

   概览

 

支持NET版本:4.5 以上

代码编码格式:utf-8

引入方式:直接将 SDK 中的 Submaill.dllNewtonsoft.Json.dll 导入

依赖第三方库 Newtonsoft.Json.dll
 

   下载
SUBMAIL_CSHARP_SDK
SUBMAIL C# SDK 2.1 (支持 Voice/verify API)
前往 GitHub 下载

 

   文件目录索引
Submail/AppConfig 目录
   
AppConfigs.cs
配置接口文件
 
MailAppConfig.cs
邮件配置文件
MessageConfig.cs
短信配置文件
VoiceAppConfig.cs
语音验证配置文件
 
Submail/Lib 目录
   
AddressBookMail.cs
邮件地址薄,订阅和添加联系人到目标地薄
 
AddressBookMessage.cs
短信地址薄,订阅和添加联系人到目标地薄
ISender.cs
发送接口
 
SendBase.cs
Message,Mail,Voice 的基类
 
Mail.cs
邮件 API
 
Message.cs
短信 API
MailSend.cs
mail/send
MailXSend.cs
mail/xsend
MessageXSend.cs
message/xsend
MessageMultiSend.cs
message/multixsend
VoiceVerify.cs
语音验证码 API
Submail/Utility 目录
 

HttpWebHelper.cs

处理HTTP请求

RequestHelper.cs

处理请求数据

SignatureHelper.cs

处理请求数据

SubMailTest 目录
 

AddressBookMailDemo.cs

邮件地址薄测试程序

AddressBookMessageDemo.cs

短信地址薄测试程序

MailSendDemo.cs

邮件 send 测试程序

MailSendXDemo.cs

邮件 xsend 测试程序

MessageMultiXSendDemo.cs

短信 multixsend 测试程序

MessageSendXDemo.cs

短信 xsend 测试程序

VoiceSendDemo.cs

语音验证 voiceverify 测试程序

 

   开始使用

 

 

SDK Class 索引

 

MAILSend
mail/send API
MAILXSend
mail/xsend API
MessageXsend
message/xsend API
MessageMultiXsend
message/multixsend API
AddressBookMail
邮件地址簿 API
AddressBookMessage
短信地址簿 API
VoiceVerify
voice/verify API

 

   MAILSend 

 

初始化

 

IAppConfigs mailconfig = new MailAppConfig("AppID","AppKey");
MailSend submail = new MailSend(mailConfig);

 

使用指引

方法
描述
示例
AddTo:name:
添加邮件地址到 To 数组,第一个必选参数:邮件地址。第二个可选参数:收件人姓名
submail.AddTo("leo@submail.cn","Leo");
AddAddressbook:
添加地址薄标识到 addressbook 数组
submail.AddAddressbook('subscribe');
SetSender:name:
设置发件人,第一个必选参数:邮件地址。第二个可选参数:显示名称
submail.SetSender('leo@submail.cn','Leo');
SetReply:
设置回复地址
submail.SetReply('leo@submail.cn');
AddCc:name
添加抄送地址
submail.AddCc('leo@submail.cn');
AddBcc:name
添加密送地址
submail.AddBcc('leo@submail.cn');
SetSubject:
设置邮件标题
submail.SetSubject('test SDK');
SetText:
设置文本邮件内容
submail.SetText('test SDK text');
SetHtml:
设置 HTML 邮件内容
submail.SetHtml('test SDK html ');
AddVar
添加文本变量到 vars 数组
submail.AddVar('name','leo');
AddLink
添加超链接变量到 links 数组
submail.AddLink('developer','http://submail.cn/chs/developer');
AddHeaders
添加自定义邮件头指令到 headers 数组
submail.AddHeaders('X-Mailer','My App');
AddAttachment:
添加附件到 attachments 数组
submail.AddAttachment('/path/to/file.txt');
Send:
发送邮件
submail.Send();

 

代码示例

使用 MAILSend 类提交 mail/send 发送一封简单的邮件



MailAppConfig("AppID","AppKey");
MailSend submail = new MailSend(mailConfig);
submail.AddTo("youremail@XXX.com", "yourname");
submail.AddCc("youremail@XXX.com", "yourname");
submail.AddBcc("youremail@XXX.com", "yourname");
submail.SetSender("youremail@XXX.com", "yourname");
submail.SetReply("reply@XXX.com");
submail.SetSubject("test");
submail.SetText("test text");
submail.AddAttachment(@"C:\attachment.txt");
 
string resultMessage = string.Empty;
if(submail.Send(out resultMessage)==false)
{
    Console.WriteLine(resultMessage);
}

 

   MAILXSend  类

 

初始化类

 

IAppConfig mailConfig = new MailAppConfig("AppID","AppKey");
MailXSend submail = new MailXSend(mailConfig);

 

使用指引

方法
描述
示例
AddTo
添加邮件地址到 To 数组,第一个必选参数:邮件地址。第二个可选参数:收件人姓名
submail.AddTo("leo@submail.cn","Leo");
AddAddressbook
添加地址薄标识到 addressbook 数组
submail.AddAddressbook('subscribe');
SetSender
设置发件人,第一个必选参数:邮件地址。第二个可选参数:显示名称
submail.SetSender('leo@submail.cn','Leo');
SetReply
设置回复地址
submail.SetReply('leo@submail.cn');
AddCc
添加抄送地址
submail.AddCc('leo@submail.cn');
AddBcc
添加密送地址
submail.AddBcc('leo@submail.cn');
SetSubject
设置邮件标题
submail.SetSubject('test SDK');
SetProject
设置邮件项目标识
submail.SetProject('ThJBE4');
AddVar
添加文本变量到 vars 数组
submail.AddVar('name','leo');
AddLink
添加超链接变量到 links 数组
submail.AddLink('developer','http://submail.cn/chs/developer');
AddHeaders
添加自定义邮件头指令到 headers 数组
submail.AddHeaders('X-Mailer','My App');
GetSender()
获取发送方式
submail.GetSender();
XSend
发送邮件
submail.XSend();

 

代码示例

使用 MAILXsend 类提交 mail/xsend 发送一封邮件。


IAppConfig mailConfig = new MailAppConfig("AppId","AppKey");
MailXSend submail =new MailXSend(mailConfig);

submail.AddTo("youremail@mail.com", "yourname");
 submail.SetSender("youremail@email.com","name");
 submail.SetProject("7pfhZ3");
 submail.AddHeaders("X-Accept","zh-cn");
 submail.AddHeaders("X-Mailer","leo App");
 string resultMessage = string.Empty;
 if(submail.XSend(out resultMessage) == false)
 {
     Consle.WriteLine(resultMessage);
 }

 

   MESSAGEXsend()

 

初始化类

 

IAppConfig messageConfig = new MessageAppConfig("AppID","AppKey");
MessageXSend submail = new MessageXSend(messageConfig);

 

使用指引

方法
描述
示例
AddTo
添加11位手机号码到 To 数组
submail.AddTo('138xxxxxxxx');
AddAddressbook
添加地址薄标识到 addressbook 数组
submail.AddAddressbook('subscribe');
SetProject
设置短信项目标记
submail.SetSender('leo@submail.cn','Leo');
AddVar
添加文本变量到 vars 数组
submail.AddVar('name','leo');
getSender
获取发送方式
submail.GetSender();
XSend
发送短信
submail.XSend();

 

代码示例

使用 MESSAGEXsend 类提交 message/xsend 发送一条触发短信。

 

            IAppConfig appConfig = new MessageAppConfig("AppID","AppKey");
            MessageXSend messageXsend = new MessageXSend(appConfig);
            messageXsend.AddTo("your phone number");
            messageXsend.SetProject("MApf82");
            messageXsend.AddVar("code","你好");
            string returnMessage = string.Empty;
            if (messageXSend.XSend(out.returnMessage) == false)
            {
                Console.WriteLine(returnMessage);
            }
 

   AddressBookMail

 

初始化类

 

IAppConfigs mailconfig = new MailAppConfig("AppID","AppKey");
AddressBookMail addressBookMail = new AddressBookMail(mailConfig);

 

使用指引

方法
描述
示例
SetAddress
设置邮件地址,第一个必选参数:邮件地址。第二个可选参数:收件人姓名
addressBookMail.SetAddress("leo@submail.cn","Leo");
SetAddressbook
设置目标地址薄标识
addressBookMail.SetAddressbook('subscribe')
subscribe
订阅或添加联系人
addressBookMail.subscribe();
unsubscribe
退订或移除联系人
addressBookMail.unsubscribe();
GetSender()
获取发送方式
addressBookMail.GetSender();

 

代码示例

使用 ADDRESSBOOKMail 类提交 addressbook/mail/subscribe 请求,添加订阅联系人或向目标地址薄中添加联系人


IAppConfig mailConfig = new MailAppConfig("AppID","AppKey");
AddressBookMail addressBookMail = new AddressBookMail(mailConfig);
addressBookMail.SetAddress("leo12@submail.cn", "leo");
addressBookMail.SetAddressBook("61RgC3");
string outMessage = string.Empty;
bool issuccess = addressBookMail.Subscribe(out outMessage);
if (!issuccess)
 {
       Console.WriteLine(outMessage);

 }  

 

使用 ADDRESSBOOKMail 类 发送 addressbook/mail/unsubscribe 请求,添加退订联系人或从目标地址薄中移除联系人


IAppConfig mailConfig = new MailAppConfig("AppID","AppKey");
AddressBookMail addressBookMail = new AddressBookMail(mailConfig);
addressBookMail.SetAddress("leo12@submail.cn", "leo");
 string outMessage = string.Empty;
bool issuccess = addressBookMail.UnSubscribe(out outMessage);
if (!issuccess)
 {
      Console.WriteLine(outMessage);
 }

 

ADDRESSBOOKMessage

 

初始化类

 

IAppConfig appConfig = new MessageConfig("AppId", "AppKey");
AddressBookMessage addressbook = new AddressBookMessage(config);

 

使用指引

方法
描述
示例
SetAddress
设置联系人11位手机号码
addressbook.SetAddress('138xxxxxxxx');
SetAddressbook
设置目标地址薄标识
addressbook.SetAddressbook('subscribe')
Subscribe
订阅或添加联系人
addressbook.subscribe();
Unsubscribe
退订或移除联系人
addressbook.unsubscribe();
GetSender
获取发送方式
addressbook.GetSender();

 

代码示例

使用 ADDRESSBOOKMessage 类 发送 addressbook/message/subscribe 请求,添加订阅联系人或向目标地址薄中添加联系人


IAppConfig appConfig = new MessageConfig("AppId", "AppKey");
AddressBookMessage addressBookMessage = new AddressBookMessage(appConfig);
string returnMessage = string.Empty;
addressBookMessage.SetAddress("your phone number");
if (addressBookMessage.Subscribe(out returnMessage) == false)
 {
       Console.WriteLine(returnMessage);
 }
 


 

 

使用 ADDRESSBOOKMessage 类发送 addressbook/message/unsubscribe 请求,添加退订联系人或从目标地址薄中移除联系人


IAppConfig appConfig = new MessageConfig("AppId", "AppKey");
AddressBookMessage addressBookMessage = new AddressBookMessage(appConfig);
string returnMessage = string.Empty;
addressBookMessage.SetAddress("your phone number");
if (addressBookMessage.UnSubscribe(out returnMessage) == false)
{
        Console.WriteLine(returnMessage);
}
 

 

MessageMultiXSend 

 

初始化类

 

IAppConfig appConfig = new MessageConfig("AppId", "AppKey");
MessageMultiXSend messageMultiSend = new MessageMultiXSend(appConfig);

 

使用指引

方法
描述
示例
getSender
获取发送方式
messageMultiSend.GetSender();
SetProject
设置短信项目标记
messageMultiSend.SetProject('MApf82')
SetMulti
设置多个发送对象信息
messageMultiSend.SetMulti(new List<MultiMessageItem>);
MultiXSend
同时向多个联系人发送短信
messageMultiSend.MultiSender();

 

代码示例

使用 MessageMultiXSend同时向多个联系人发送短信


IAppConfig appConfig = new MessageConfig("AppId", "AppKey");
MessageMultiXSend messageMultiSend = new MessageMultiXSend(appConfig);
messageMultiSend.SetProject("MApf82");
Dictionary<string, string> vars = new Dictionary<string, string>();
 vars.Add("code", "你好");
messageMultiSend.SetMulti(new List<MultiMessageItem>) {
     new MultiMessageItem() { to="one phone number"},
    new MultiMessageItem() { to="another phone number", vars = vars}
 });
string returnMessage = string.Empty;
if (messageMultiSend.MultiXSend(out returnMessage) == false)
 {
       Console.WriteLine(returnMessage);
 }

 

VoiceVerify 

 

初始化类

 

IAppConfig appConfig = new VoiceAppConfig("APP_ID","APP_Key");
VoiceVerify VoiceVerify = new VoiceVerify (appConfig);

 

使用指引

方法
描述
示例
AddTo
添加11位手机号码
VoiceVerify.AddTo('138xxxxxxxx');
SetCode
设置语音播报的4位数字验证码
VoiceVerify.SetCode('1234');
GetSender
获取发送方式
VoiceVerify.GetSender();
VoiceVerify
发送语音验证码,进行语言验证
VoiceVerify.VoiceVerify();

 

代码示例


IAppConfig appConfig = new VoiceAppConfig("APP_ID","APP_Key");
voiceVerify voiceVerify = new voiceVerify(appConfig);
voiceVerify.AddTo("XXXXXXXXXXX");

// 此数字为语音播报的4位数字验证码
 voiceVerify.SetCode("1234");

string returnMessage = string.Empty;
if (voiceVerify.Verify(out returnMessage) == false)
 {
       Console.WriteLine(returnMessage);
 }