Skip to content

Commit 9a621a4

Browse files
author
MailboxValidator
committed
Update readme.md
1 parent 388c0e5 commit 9a621a4

1 file changed

Lines changed: 25 additions & 26 deletions

File tree

readme.md

Lines changed: 25 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
# MailboxValidator Laravel Email Validation Package
22

3-
MailboxValidator Laravel Email Validation Package provides an easy way to call the MailboxValidator API which validates if an email address is valid.
3+
MailboxValidator Laravel Email Validation Package enables user to easily validate if an email address is a type of disposable email or not.
4+
5+
This module can be useful in many types of projects, for example
6+
7+
- to validate an user's email during sign up
8+
- to clean your mailing list prior to email sending
9+
- to perform fraud check
10+
- and so on
411

512

613

@@ -37,39 +44,31 @@ After that, please save your API key in your web application environement file l
3744
MBV_API_KEY = 'PASTE_YOUR_API_KEY_HERE'
3845
``
3946

47+
## Functions
4048

49+
### GetValidateDisposable (email_address)
4150

42-
## Usage
43-
44-
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/).
45-
46-
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.
47-
48-
## Result Fields
49-
50-
##### email_address
51+
Check if the supplied email address is from a disposable email provider.
5152

52-
The input email address.
53+
#### Return Fields
5354

54-
##### is_disposable
55+
| Field Name | Description |
56+
| ----------------- | ------------------------------------------------------------ |
57+
| email_address | The input email address. |
58+
| is_disposable | Whether the email address is a temporary one from a disposable email provider. Return values: True, False |
59+
| credits_available | The number of credits left to perform validations. |
60+
| error_code | The error code if there is any error. See error table in the below section. |
61+
| error_message | The error message if there is any error. See error table in the below section. |
5562

56-
Whether the email address is a temporary one from a disposable email provider.
63+
### ValidateDisposable
5764

58-
Return values: True, False.
65+
Check the email address from the form and validate it whether is a disposable email or not.
5966

60-
##### credits_available
61-
62-
The number of credits left to call the API.
63-
64-
##### error_code
65-
66-
The error code if there is any error. See error table below.
67-
68-
##### error_message
69-
70-
The error message if there is any error. See error table below.
67+
## Usage
7168

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/).
7270

71+
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.
7372

7473
## Errors
7574

@@ -86,4 +85,4 @@ The error message if there is any error. See error table below.
8685

8786
## Copyright
8887

89-
Copyright (C) 2018 by MailboxValidator.com, [email protected]
88+
Copyright (C) 2018-2020 by MailboxValidator.com, [email protected]

0 commit comments

Comments
 (0)