GuardPost-ObjectiveC 0.1.1

GuardPost-ObjectiveC 0.1.1

测试已测试
Lang语言 Obj-CObjective C
许可证 MIT
发布上次发布2014年12月

匿名 维护。



  • Sam Davies

这是一个对 Mailgun 的 Guardpost 邮件验证服务的Objective-C实现

如何安装

安装 GuardPost-ObjectiveC 最简单的方法是使用 Cocoapods。将以下内容添加到您的 Podfile 中:

pod 'Guardpost-ObjectiveC', :git => '[email protected]:sammyd/GuardPost-ObjectiveC.git'

然后运行

pod install

或者您也可以克隆此仓库并使用 Classes 子目录中定义的类。请注意,AFNetworking 是此工具的依赖。

如何使用

GuardPost 提供了 2 个 API 方法 - 邮件验证和邮件列表解析。在使用这些 API 之前,您需要设置 API 密钥。GuardPost 是由 MailGun 提供的服务,因此您需要注册一个账户才能使用。GuardPost 服务是免费的 - 要注册免费账户,请访问 此处

一旦注册,您需要获取您的 公共 API 密钥(形式为'pubkey-...)。要将它设置在您的应用程序中,您需要调用以下方法一次

[GPGuardPost setPublicAPIKey:@"pubkey-your-key-here"];

这是一个静态方法 - 一旦设置,它将在整个应用程序生命周期中用于所有对 GuardPost API 的调用。因此,在 AppDelegate 或主视图控制器的 viewDidLoad 中设置它是一个好主意。

验证电子邮件

要验证电子邮件,请使用 +validateAddress:success:failure: 方法。它接受一个用于验证的地址字符串,以及两个块 - 一个在成功 API 调用事件中被调用,另一个用于失败。例如

[GPGuardPost validateAddress:self.emailField.text success:^(BOOL validity, NSString *suggestion) {
    NSLog(@"API call successful");
} failure:^(NSError *error) {
    NSLog(@"There was an error: %@", [error localizedDescription]);
}];

成功块有两个参数

  • validity 是一个 BOOL,指定发送的电子邮件地址是否有效
  • suggestion 是一个 NSString,包含对电子邮件地址的建议,或者为 nil。请注意,有效的电子邮件地址可以有非 nil 的建议,同样无效的地址不一定有建议。

错误块有一个 NSError 参数。

解析电子邮件地址列表

一个电子邮件地址字段可以由逗号或分号分隔的电子邮件地址字符串组成。但是,解析列表并不总是简单的。因此,mailgun 提供了 +parseListOfAddresses:success:failure 方法。提供一个包含地址列表的字符串,此方法也有成功和失败回调块。失败块与电子邮件验证形式相同。

成功块包含2个 NSArray 参数 - 第一个用于解析后的电子邮件地址列表,第二个用于列表字符串中无法解析的部分。注意,这些电子邮件地址只进行了语法解析,可以通过调用 validateAddress 方法进行额外的验证。

示例代码

Samples 子目录中有一个名为 GuardPostExample 的示例应用。这是一个基本的电子邮件验证应用,它接收一个电子邮件并报告它是否有效。

为了尝试此应用,您需要提供自己的API密钥。有一个名为 GPSettings-Sample.plist 的plist文件。将其复制为 GPSettings.plist 并用您的公钥更新 MailGunPublicAPIKey 键。

或者,更新源代码以包含您的公钥。

更多信息

本项目是对由mailgun提供的优秀GuardPost API的接口。该API的文档可以在这里找到。

开发

您可以随时提出问题或发送pull请求。所有贡献都欢迎!

关于

此项目由Sam Davies编写。您应该在iwantmyreal.name的博客上看看,并在twitter @iwantmyrealname或ADN @samd上关注他。