SUBMAIL OBJECTIVE-C
SDK
概览
支持iOS版本:iOS7
以上
代码编码格式:utf-8
引入方式:直接将 SUBMAIL 文件夹拖入工程,并添加 AFNetworking(2.4.1)
类库,在 SMConfig.h
中填入正确的配置参数
下载
SUBMAIL_OBJECTIVE_C_SDK_MAIL_AND_MESSAGE_WITH_ADDRESSBOOK | 邮件、短信和地址薄 | 下载 |
---|---|---|
文件目录索引
Submail/Config目录 | 处理用户的配置信息 | |
---|---|---|
SMConfig | 配置文件 | |
Demo 目录 | 代码示例目录 | |
AddressbookMailSubscribeDemo | 邮件地址薄,订阅和添加联系人到目标地址薄 | |
AddressbookMailUnSubscribeDemo | 邮件地址薄,退订和从目标地址薄移除联系人 | |
AddressbookMessageSubscribeDemo | 短信地址薄,订阅和添加联系人到目标地址薄 | |
AddressbookMessageUnSubscribeDemo | 短信地址薄,退订和从目标地址薄移除联系人 | |
MailSendDemo | mail/send API 代码示例和使用指引 | |
MailXSendDemo | mail/xsend API 代码示例和使用指引 | |
MessageXSendDemo | message/xsend API 代码示例和使用指引 | |
Submail 目录 | SDK 资源目录 | |
SMAddressBookMail | 邮件地址薄 API | |
SMAddressBookMessage | 短信地址薄 API | |
SMMail | 邮件 API | |
SMMailSend | mail/send API | |
SMMailXSend | mail/xsend API | |
SMMessage | 短信 API | |
SMMessageXSend | message/xsend API | |
Submail/Utils 目录 | md5 和 sha1 的扩展 | |
NSString+Helper | 实现了md5 和 sha1 的扩展 | |
NSDictionary+Helper | 实现了 NSDictionary 到 NSString 的扩展 |
开始使用
导入以下第三方库文件
AFNetworking2.4.1
SDK Class
索引
SMMailSend | mail/send API |
---|---|
SMMailXSend | mail/xsend API |
SMMessageXSend | message/xsend API |
SMAddressbookMail | 邮件地址簿 API |
SMAddressbookMessage | 短信地址簿 API |
SMMailSend
类
初始化类
SMMailSend *submail = [[SMMailSend alloc] init];
使用指引
方法 | 描述 |
---|---|
addTo:name: | 添加邮件地址到 To 数组,第一个必选参数:邮件地址。第二个可选参数:收件人姓名 |
addAddressBook: | 添加地址薄标识到 addressbook 数组 |
setSender:name: | 设置发件人,第一个必选参数:邮件地址。第二个可选参数:显示名称 |
setReply: | 设置回复地址 |
addCc:name: | 添加抄送地址 |
addBcc:name: | 添加密送地址 |
setSubject: | 设置邮件标题 |
setText: | 设置文本邮件内容 |
setHtml: | 设置 HTML 邮件内容 |
dictVar | 添加文本变量到 vars 数组 |
dictLink | 添加超链接变量到 links 数组 |
dictHeader | 添加自定义邮件头指令到 headers 数组 |
addAttachment: | 添加附件到 attachments 数组 |
send: | 发送邮件 |
代码示例
使用 SMMailSend
类提交 mail/send 发送一封简单的邮件
#import "MailSendDemo.h"
+ (void)demo {
SMMailSend *submail = [[SMMailSend alloc] init];
[submail addTo:@"leo@submail.cn" name:@"leo"];
[submail setSender:@"no-reply@submail.cn" name:@"SUBMAIL"];
submail.subject = @"testSDK";
submail.text = @"test SDK text";
submail.html = @"test SDK html";
[submail send:^(BOOL success, id responseObject) {
// your code
}];
}
@end
SMMailXSend
类
初始化类
SMMailXSend *submail = [[SMMailXSend alloc] init];
使用指引
方法 | 描述 |
---|---|
addTo:name: | 添加邮件地址到 To 数组,第一个必选参数:邮件地址。第二个可选参数:收件人姓名 |
addAddressBook: | 添加地址薄标识到 addressbook 数组 |
setSender:name: | 设置发件人,第一个必选参数:邮件地址。第二个可选参数:显示名称 |
setReply: | 设置回复地址 |
addCc:name: | 添加抄送地址 |
addBcc:name: | 添加密送地址 |
setSubject: | 设置邮件标题 |
setProject: | 设置邮件项目标识 |
dictVar | 添加文本变量到 vars 数组 |
dictLink | 添加超链接变量到 links 数组 |
dictHeader | 添加自定义邮件头指令到 headers 数组 |
xSend: | 发送邮件 |
代码示例
使用 SMMailXSend
类提交 mail/xsend
发送一封邮件。
#import "MailXSendDemo.h"
@implementation MailXSendDemo
+ (void)demo {
SMMailXSend *submail = [[SMMailXSend alloc] init];
[submail addTo:@"leo@submail.cn" name:@"leo"];
[submail setSender:@"no-reply@submail.cn" name:@"SUBMAIL"];
submail.project = @"wAWzY4";
[submail.dictVar setValue:@"leo" forKey:@"name"];
[submail.dictVar setValue:@"32" forKey:@"age"];
[submail.dictLink setValue:@"http://submail.cn/chs/developer" forKey:@"developer"];
[submail.dictLink setValue:@"http://submail.cn/chs/store" forKey:@"store"];
[submail.dictHeader setValue:@"zh-cn" forKey:@"X-Accept"];
[submail.dictHeader setValue:@"leo App" forKey:@"X-Mailer"];
[submail xSend:^(BOOL success, id responseObject) {
// your code
}];
}
@end
SMMessageXSend
类
初始化类
SMMessageXSend * submail = [[SMMessageXSend alloc] init];
使用指引
方法 | 描述 |
---|---|
aryTo | 添加11位手机号码到 To 数组 |
aryAddressBook | 添加地址薄标识到 addressbook 数组 |
setProject: | 设置短信项目标记 |
dictVar | 添加文本变量到 vars 数组 |
xSend: | 发送短信 |
代码示例
使用 SMMessageXSend
类提交 message/xsend
发送一条触发短信。
#import "MessageXSendDemo.h"
@implementation MessageXSendDemo
+ (void)demo {
SMMessageXSend * submail = [[SMMessageXSend alloc] init];
[submail.aryTo addObject:@"138********"];
submail.project = @"kZ9Ky3";
[submail.dictVar setValue:@"198276" forKey:@"code"];
[submail xSend:^(BOOL success, id responseObject) {
// your code
}];
}
@end
SMAddressbookMail
类
初始化类
SMAddressBookMail *addressbook = [[SMAddressBookMail alloc] init];
使用指引
方法 | 描述 |
---|---|
setAddress:name: | 设置邮件地址,第一个必选参数:邮件地址。第二个可选参数:收件人姓名 |
setAddressbook: | 设置目标地址薄标识 |
subscribe: | 订阅或添加联系人 |
unsubscribe: | 退订或移除联系人 |
代码示例
使用 SMAddressbookMail
类提交 addressbook/mail/subscribe
请求,添加订阅联系人或向目标地址薄中添加联系人
#import "AddressbookMailSubscribeDemo.h"
@implementation AddressbookMailSubscribeDemo
+ (void)demo {
SMAddressBookMail *addressbook = [[SMAddressBookMail alloc] init];
[addressbook setAddress:@"leo@submail.cn" name:@"leo"];
[addressbook subscribe:^(BOOL success, id responseObject) {
// your code
}];
}
@end
使用 SMAddressbookMail
类 发送 addressbook/mail/unsubscribe
请求,添加退订联系人或从目标地址薄中移除联系人
#import "AddressbookMailUnsubscribeDemo.h"
@implementation AddressbookMailUnsubscribeDemo
+ (void)demo {
SMAddressBookMail *addressbook = [[SMAddressBookMail alloc] init];
[addressbook setAddress:@"leo@apple.cn" name:@"leo"];
[addressbook unSubscribe:^(BOOL success, id responseObject) {
// your code
}];
}
@end
SMAddressbookMessage
类
初始化类
SMAddressBookMessage *addressbook = [[SMAddressBookMessage alloc] init];
使用指引
方法 | 描述 |
---|---|
setAddress:name: | 设置联系人11位手机号码 |
setAddressbook: | 设置目标地址薄标识 |
subscribe: | 订阅或添加联系人 |
unsubscribe: | 退订或移除联系人 |
代码示例
使用 SMAddressbookMessage
类 发送 addressbook/message/subscribe
请求,添加订阅联系人或向目标地址薄中添加联系人
#import "AddressbookMessageSubscribeDemo.h"
@implementation AddressbookMessageSubscribeDemo
+ (void)demo {
SMAddressBookMessage *addressbook = [[SMAddressBookMessage alloc] init];
[addressbook setAddress:@"18616761889"];
[addressbook subscribe:^(BOOL success, id responseObject) {
// your code
}];
}
@end
使用 SMAddressbookMessage
类发送 addressbook/message/unsubscribe
请求,添加退订联系人或从目标地址薄中移除联系人
#import "AddressbookMessageUnsubscribeDemo.h"
@implementation AddressbookMessageUnsubscribeDemo
+ (void)demo {
SMAddressBookMessage *addressbook = [[SMAddressBookMessage alloc] init];
[addressbook setAddress:@"18616761889"];
[addressbook unSubscribe:^(BOOL success, id responseObject) {
// your code
}];
}
@end