torfs-ict / crembl
Crembl API 包装器,允许您通过 Crembl 网络服务发送常规(或已注册)邮件。
1.0.0
2017-01-05 17:50 UTC
Requires
- php: >=7.0.0
- guzzlehttp/guzzle: ^6.2
- jms/serializer: ^1.4
This package is auto-updated.
Last update: 2024-09-21 20:23:09 UTC
README
Crembl 网络服务的 API 包装器。
请注意,我们与 Crembl 和 bpost 没有任何关联。有关此 API 包装器的问题可以在我们的 GitHub 页面 上提出,而有关实际 API 的问题应向 Crembl 投诉。
使用方法
在使用此 API 之前,请务必查看官方的 文档。该 API 只有三个方法
- 创建任务(即要发送的文档):
createTask
。 - 上传现有任务的文件:
uploadFile
或uploadFileFromString
。 - 检索现有任务的信息:
getTaskInfo
。
错误处理
每当发生错误时,客户端将抛出一个类型为 Crembl\Exception
的异常,您可以通过调用 getInfo()
方法找到实际错误信息。
示例
use bpost\Crembl\Client; use bpost\Crembl\Config\TaskConfig; $client = new Client('<secret>');
创建任务
$task = new TaskConfig(); $task ->setDocumentTypeRegular() ->setAddresseeLine1('Microsoft Belgium') ->setAddresseeLine2('Corporate Village - Bayreuth Building') ->setAddressCountry('BE') ->setAddressZipCode('1935') ->setAddressCity('Zaventem') ->setAddressStreetName('Leonardo Da Vincilaan') ->setAddressStreetNumber('3'); $id = $client->createTask($task);
返回 Crembl API 生成的 id,例如 A12345678910111213141516171819209
。
上传文件
$success = $client->uploadFile($id, __DIR__ . '/myletter.pdf');
在成功的情况下返回 TRUE
,否则抛出错误。
检索任务信息
$task = $client->getTaskInfo($id); var_dump($task);
返回类型为 Crembl\Task\Info
的对象。