diff --git a/README.md b/README.md index 262ce63..41f9ac0 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,11 @@ LaravelEmailSniperLink::getSniperLinkQuick('receiver@gmail.com', 'optional-from- LaravelEmailSniperLink::getSniperLink('receiver@gmail.com', 'optional-from-email@gmail.com') ``` -In the future I may add helper functions. The `LaravelEmailSniperLink` class has more static methods as well which might be useful for you +The `LaravelEmailSniperLink` class has more static methods as well which might be useful for you. + +Some helper functions are also available. For now there are 2. `email_sniper_link_quick(string $receiverEmail, ?string $fromEmail = null)` and `email_sniper_link(string $receiverEmail, ?string $fromEmail = null)`. + +```php ## Testing diff --git a/src/helpers.php b/src/helpers.php index f398b2a..17aea5a 100644 --- a/src/helpers.php +++ b/src/helpers.php @@ -12,6 +12,9 @@ function sniper_link_quick(string $receiverEmail, ?string $fromEmail = null): ?s } if (! function_exists('email_sniper_link')) { + /** + * @throws \Detection\Exception\MobileDetectException + */ function sniper_link_quick(string $receiverEmail, ?string $fromEmail = null): ?string { return LaravelEmailSniperLink::getSniperLink($receiverEmail, $fromEmail);