SUBMAIL SWIFT
SDK
概览
更新 IOS 9.0 与 SWIFT 2.0支持
支持iOS版本:iOS7
以上
代码编码格式:utf-8
需要手动指定 Submail-Bridging-Header.h
文件的路径,在 Xcode
工程的 Build Settings
中找到 Objective-C Bridging Header
选项,添加“$PROJECT_NAME/Submail/Utils/Submail-Bridging-Header.h”
,如图:
下载
SUBMAIL_SWIFT_SDK_MAIL_AND_MESSAGE_WITH_ADDRESSBOOK
邮件、短信和地址薄
文件目录索引
Config目录 | 处理用户的配置信息 | |
---|---|---|
Config.swift | MailConfig 与 MessageConfig 的父类 | |
Demo 目录 | 代码示例目录 | |
AddressbookMailSubscribeDemo.swift | 邮件地址薄,订阅和添加联系人到目标地址薄 | |
AddressbookMailUnSubscribeDemo.swift | 邮件地址薄,退订和从目标地址薄移除联系人 | |
AddressbookMessageSubscribeDemo.swift | 短信地址薄,订阅和添加联系人到目标地址薄 | |
AddressbookMessageUnSubscribeDemo.swift | 短信地址薄,退订和从目标地址薄移除联系人 | |
MailSendDemo.swift | mail/send API 代码示例和使用指引 | |
MailXSendDemo.swift | mail/xsend API 代码示例和使用指引 | |
MessageXSendDemo.swift | message/xsend API 代码示例和使用指引 | |
Lib 目录 | SDK 资源目录 | |
AddressbookMail.swift | 邮件地址薄 API | |
AddressbookMessage.swift | 短信地址薄 API | |
Mail.swift | 邮件 API | |
MailSend.swift | mail/send API | |
MailXSend.swift | mail/xsend API | |
Message.swift | 短信 API | |
MessageXSend.swift | message/xsend API | |
Utils 目录 | md5 和 sha1 的扩展 | |
NSString+Helper.m | 实现了md5 和 sha1 的扩展 | |
NSString+Helper.h | 实现了 md5 和 sha1 的扩展接口 | |
Submail-Bridging-Header.h | Swift 调用 OC 接口的头文件 |
开始使用
导入以下第三方库文件
AFNetworking2.4.1
SDK Class
索引
MailSend.swift | mail/send API |
---|---|
MailXSend.swift | mail/xsend API |
MessageXSend.swift | message/xsend API |
AddressbookMail.swift | 邮件地址簿 API |
AddressbookMessage.swift | 短信地址簿 API |
MailSend
类
初始化类
var submail = MailSend(config: MailConfig())
使用指引
方法 | 描述 | 示例 |
---|---|---|
add_to | 添加邮件地址到 To 数组,第一个必选参数:邮件地址。第二个可选参数:收件人姓名 | submail.add_to("leo@submail.cn", "leo") |
add_addressbook | 添加地址薄标识到 addressbook 数组 | submail.add_addressbook("subscribe") |
set_from | 设置发件人,第一个必选参数:邮件地址。第二个可选参数:显示名称 | submail.set_from("leo@submail.cn", "leo") |
set_reply | 设置回复地址 | submail.set_reply("leo@submail.cn") |
add_cc | 添加抄送地址 | submail.add_cc("leo@submail.cn") |
add_bcc | 添加密送地址 | submail.add_bcc("leo@submail.cn") |
set_subject | 设置邮件标题 | submail.set_subject("test SDK") |
set_text | 设置文本邮件内容 | submail.set_text("test SDK text") |
set_html | 设置 HTML 邮件内容 | submail.set_html("test SDK html") |
add_var | 添加文本变量到 vars 数组 | submail.add_var("name","leo") |
add_link | 添加超链接变量到 links 数组 | submail.add_link("developer","http://submail.cn/chs/developer") |
add_headers | 添加自定义邮件头指令到 headers 数组 | submail.add_headers("X-Mailer","My App") |
add_attachment | 添加附件到 attachments 数组 | submail.add_attachment("//path//to//file.txt") |
send() | 发送邮件 | submail.send() |
代码示例
使用 MailSend
类提交 mail/send 发送一封简单的邮件
import Foundation
public class MailSendDemo {
public class func demo() {
var submail = MailSend(config: MailConfig())
submail.add_to("leo@submail.cn", "leo")
submail.set_from("no-reply@submail.cn", "SUBMAIL")
submail.set_subject("testSDK")
submail.set_text("test SDK text")
submail.set_html("test SDK html")
submail.send()
}
}
MailXSend
类
初始化类
var submail = MailXSend(config: MailConfig())
使用指引
方法 | 描述 | 示例 |
---|---|---|
add_to | 添加邮件地址到 To 数组,第一个必选参数:邮件地址。第二个可选参数:收件人姓名 | submail.add_to("leo@submail.cn", "leo") |
add_addressbook | 添加地址薄标识到 addressbook 数组 | submail.add_addressbook("subscribe") |
set_from | 设置发件人,第一个必选参数:邮件地址。第二个可选参数:显示名称 | submail.set_from("leo@submail.cn", "leo") |
set_reply | 设置回复地址 | submail.set_reply("leo@submail.cn") |
add_cc | 添加抄送地址 | submail.add_cc("leo@submail.cn") |
add_bcc | 添加密送地址 | submail.add_bcc("leo@submail.cn") |
set_subject | 设置邮件标题 | submail.set_subject("test SDK"); |
set_project | 设置邮件项目标识 | submail.set_project ("THJBE4") |
add_var | 添加文本变量到 vars 数组 | submail.add_var("name", "leo") |
add_link | 添加超链接变量到 links 数组 | submail.add_link("developer","http://submail.cn/chs/developer") |
add_headers | 添加自定义邮件头指令到 headers 数组 | submail.add_headers("X-Mailer","My App") |
xsend() | 发送邮件 | submail.xsend() |
代码示例
使用 MailXSend
类提交 mail/xsend
发送一封邮件。
import Foundation
public class MailXSendDemo {
public class func demo() {
var submail = MailXSend(config: MailConfig())
submail.add_to("leo@submail.cn", "leo")
submail.set_from("no-reply@submail.cn", "SUBMAIL")
submail.set_project("wAWzY4")
submail.add_var("name", "leo")
submail.add_var("age", "32")
submail.add_link("developer", "http://submail.cn/chs/developer")
submail.add_link("store", "http://submail.cn/chs/store")
submail.add_headers("X-Accept", "zh-cn")
submail.add_headers("X-Mailer", "leo App")
submail.xsend()
}
}
MessageXSend
类
初始化类
var submail = MessageXSend(config: MessageConfig())
使用指引
方法 | 描述 | 示例 |
---|---|---|
add_to | 添加11位手机号码到 To 数组 | submail.add_to("138xxxxxxxx") |
add_addressbook | 添加地址薄标识到 addressbook 数组 | submail.add_addressbook("subscribe") |
set_project | 设置短信项目标记 | submail.set_project("THJBE4") |
add_var | 添加文本变量到 vars 数组 | submail.add_var("name", "leo") |
xsend() | 发送短信 | submail.xsend() |
代码示例
使用 MessageXSend
类提交 message/xsend
发送一条触发短信。
import Foundation
public class MessageXSendDemo {
public class func demo() {
var submail = MessageXSend(config: MessageConfig())
submail.add_to("138********")
submail.set_project("kZ9Ky3")
submail.add_var("code", "198276")
submail.xsend()
}
}
AddressbookMail
类
初始化类
var addressbook = AddressbookMail(config: MailConfig())
使用指引
方法 | 描述 | 示例 |
---|---|---|
set_address | 设置邮件地址,第一个必选参数:邮件地址。第二个可选参数:收件人姓名 | submail.set_address("leo@submail.cn", "leo") |
set_addressbook | 设置目标地址薄标识 | submail.set_addressbook("subscribe") |
subscribe() | 订阅或添加联系人 | submail.subscribe() |
unsubscribe() | 退订或移除联系人 | submail.unsubscribe() |
代码示例
使用 AddressbookMail
类提交 addressbook/mail/subscribe
请求,添加订阅联系人或向目标地址薄中添加联系人
import Foundation
public class AddressbookMailSubscribeDemo {
public class func demo() {
var addressbook = AddressbookMail(config: MailConfig())
addressbook.set_address("leo@submail.cn", "leo")
addressbook.subscribe()
}
}
使用 AddressbookMail
类 发送 addressbook/mail/unsubscribe
请求,添加退订联系人或从目标地址薄中移除联系人
import Foundation
public class AddressbookMailUnsubscribeDemo {
public class func demo() {
var addressbook = AddressbookMail(config: MailConfig())
addressbook.set_address("leo@submail.cn", "leo")
addressbook.unsubscribe()
}
}
AddressbookMessage
类
初始化类
var addressbook = new AddressbookMessage(config: MessageConfig())
使用指引
方法 | 描述 | 示例 |
---|---|---|
set_address | 设置联系人11位手机号码 | submail.set_address("138xxxxxxxx") |
set_addressbook | 设置目标地址薄标识 | submail.add_addressbook("subscribe") |
subscribe() | 订阅或添加联系人 | submail.subscribe() |
unsubscribe() | 退订或移除联系人 | submail.unsubscribe() |
代码示例
使用 AddressbookMessage
类 发送 addressbook/message/subscribe
请求,添加订阅联系人或向目标地址薄中添加联系人
import Foundation
public class AddressbookMessageSubscribeDemo {
public class func demo() {
var addressbook = AddressbookMessage(config: MessageConfig())
addressbook.set_address("138xxxxxxxx")
addressbook.subscribe()
}
}
使用 AddressbookMessage
类发送 addressbook/message/unsubscribe
请求,添加退订联系人或从目标地址薄中移除联系人
import Foundation
public class AddressbookMessageUnsubscribeDemo {
public class func demo() {
var addressbook = AddressbookMessage(config: MessageConfig())
addressbook.set_address("138xxxxxxxx")
addressbook.unsubscribe()
}
}