Skip to content

Commit 2f9296c

Browse files
Updates on documentation
1 parent c5150cb commit 2f9296c

File tree

3 files changed

+13
-10
lines changed

3 files changed

+13
-10
lines changed

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"description": "Laravel package to validate an email by using MailboxValidator API.",
44
"type": "library",
55
"license": "LGPL-3.0-or-later",
6-
"keywords": ["laravel","mailboxvalidator","email validation","disposable", "laravel 5", "laravel 6", "laravel 7", "laravel 8", "laravel 9", "laravel 10", "laravel 11"],
6+
"keywords": ["laravel","mailboxvalidator","email validation","disposable", "laravel 5", "laravel 6", "laravel 7", "laravel 8", "laravel 9", "laravel 10", "laravel 11", "laravel 12"],
77
"authors": [
88
{
99
"name": "MailboxValidator",

license.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2024 MailboxValidator.com
3+
Copyright (c) 2025 MailboxValidator.com
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

readme.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,15 @@ This module can be useful in many types of projects, for example
99
- to perform fraud check
1010
- and so on
1111

12-
*Note: This extension works in Laravel 5, Laravel 6, Laravel 7, Laravel 8, Laravel 9, Laravel 10 and Laravel 11.*
12+
*Note: This extension works in Laravel 5, Laravel 6, Laravel 7, Laravel 8, Laravel 9, Laravel 10, Laravel 11 and Laravel 12.*
1313

1414
## Installation
1515

1616
Open the terminal, locate to your project root and run the following command :
1717

18-
`composer require mailboxvalidator-laravel/validation`
18+
````console
19+
composer require mailboxvalidator-laravel/validation
20+
```
1921

2022

2123

@@ -27,9 +29,9 @@ service provider manually into the providers section:
2729

2830
In the terminal, type the following command to publish the modified config file:
2931

30-
``
32+
```console
3133
php artisan vendor:publish --provider=MailboxValidatorLaravel\Validation\ValidationServiceProvider --force
32-
``
34+
```
3335

3436

3537

@@ -40,9 +42,10 @@ An API key is required for this module to function.
4042
Go to https://www.mailboxvalidator.com/plans#api to sign up for FREE API plan and you'll be given an API key.
4143

4244
After that, please save your API key in your web application environement file like this:
43-
``
45+
46+
```
4447
MBV_API_KEY = 'PASTE_YOUR_API_KEY_HERE'
45-
``
48+
```
4649

4750
## Functions
4851

@@ -66,7 +69,7 @@ Check the email address from the form and validate it whether is a disposable em
6669

6770
## Usage
6871

69-
To use this package to validate the email coming from form submission, you will just need to include `'|disposable'`in Validator function in app\Http\Controllers\Auth\RegisterController.php . A step by step tutorial is included [here](https://www.mailboxvalidator.com/resources/articles/how-to-use-mailboxvalidator-laravel-email-validation-package-to-validate-email-during-registration/).
72+
To use this package to validate the email coming from form submission, you will just need to include `'|disposable'`in Validator function in `app\Http\Controllers\Auth\RegisterController.php` . A step by step tutorial is included [here](https://www.mailboxvalidator.com/resources/articles/how-to-use-mailboxvalidator-laravel-email-validation-package-to-validate-email-during-registration/).
7073

7174
To print the validation result on single email, you will first need to include this line on top of your file: `use MailboxValidatorLaravel\Validation\ValidateEmail;` . Then, initialite the ValidateEmail class by using this line: `$validate = new ValidateEmail();`. Lastly, just call `$validate->GetValidateDisposable('email_tobe_validate','your_api_key');` into a variable and print out the variable. For example, your controller file might be looks like this:
7275

@@ -106,4 +109,4 @@ class ViewValidateResultController extends Controller
106109

107110
## Copyright
108111

109-
Copyright (C) 2018-2024 by MailboxValidator.com, support@mailboxvalidator.com
112+
Copyright (C) 2018-2025 by MailboxValidator.com, support@mailboxvalidator.com

0 commit comments

Comments
 (0)