clarkwinkelmann/flarum-ext-external-email-validation

通过调用外部API验证电子邮件

1.0.0 2021-06-21 15:03 UTC

This package is auto-updated.

Last update: 2024-09-21 22:07:22 UTC


README

License Latest Stable Version Total Downloads Donate

此扩展为Flarum的电子邮件验证添加了一个规则,该规则将使用外部API请求来验证电子邮件。

此规则将应用于任何需要与UserValidator进行比较的电子邮件的地方,包括注册和电子邮件更改请求。

外部API请求的格式可以根据不同的需求进行自定义。

数据可以通过两种方式之一传递:通过查询字符串或通过HTTP正文。

响应可以通过两种方式之一读取:响应中的JSON键或HTTP状态码。

此外,还可以从响应中的JSON键中可选地读取错误消息。否则,可以在扩展设置中提供默认错误消息。

要在模板中注入电子邮件值到URIBody设置中,请在模板中使用以下字符串之一

  • {{ email | urlencode }}:此值将通过PHP的urlencode()方法替换
  • {{ email | json }}:此值将通过PHP的json_encode()方法替换。这意味着将包含JSON字符串分隔符!
  • {{ email | raw }}:此值将替换为未经修改的电子邮件值。如果您不知道自己在做什么,请不要在URI或JSON有效负载中使用此值。

安装

composer require clarkwinkelmann/flarum-ext-external-email-validation

支持

此扩展处于最小维护状态。

它是为了一个客户而开发的,并作为开源软件发布,以造福社区。我可能会免费发布简单的错误修复或兼容性更新。

您可以通过此链接联系我,以赞助额外功能或更新。

通过Flarum社区线程提供“尽力而为”的支持。

集成测试

此扩展具有集成测试,这些测试依赖于本地运行的网络服务器。

运行composer test:server以在端口8000上启动PHP开发服务器,并将docroot设置为fixtures文件夹。

然后您可以像常规Flarum集成测试一样运行composer test:setupcomposer test

链接