evodelavega / sendgrid-web
一个简单的API包装器,专注于sendgrid的Web API
dev-master
2014-09-30 14:33 UTC
Requires
- php: >=5.3.0
- lib-curl: *
This package is not auto-updated.
Last update: 2024-09-24 02:57:47 UTC
README
sendgrid Web API的包装器(获取弹跳列表、统计数据、无效电子邮件等...)
用法
使用API非常简单:只需创建一个Config
实例,通过传递一个包含user
和pass
键的数组(如果需要,还可以包含可选的baseUrl
和output
键)。然后,将此对象传递给您需要使用的任何API类。每个类都实现了基本的API调用,作为方法实现,并提供了一些辅助方法。例如,Block
API有一个delete
调用,用于删除电子邮件地址。此包装器实现了一个deleteEmail
方法,该方法对应于此调用,同时还实现了一个deleteEmails
方法。此方法允许您传递一个电子邮件地址数组,而不是逐个调用API。
example.php
文件需要包含您想要使用的配置的example_params.json
文件。该json文件已添加到.gitignore,因此无需担心意外提交。以下是一个此类json文件的示例
{"user": "username", "pass": "MyPassword", "baseUrl": "https://my.sendgrid.url/api/"}
请注意baseUrl参数的格式。