Skip to content

Commit 6d577b6

Browse files
Update README.md
1 parent 009f22a commit 6d577b6

1 file changed

Lines changed: 26 additions & 3 deletions

File tree

README.md

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

3-
MailboxValidator CakePHP Email Validation Package provides an easy way to call the MailboxValidator API which validates if an email address is valid.
3+
MailboxValidator CakePHP Email Validation Package enables user to easily validate if an email address is valid, a type of disposable email or free email.
4+
5+
This package 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

@@ -33,6 +40,22 @@ Configure::write('MBV_API_KEY','PASTE_YOUR_API_KEY_HERE');
3340

3441

3542

43+
Functions
44+
---------
45+
46+
### single (email_address)
47+
48+
Performs email validation on the supplied email address.
49+
50+
### disposable (email_address)
51+
52+
Check if the supplied email address is from a disposable email provider.
53+
54+
### free (email_address)
55+
56+
Check if the supplied email address is from a free email provider.
57+
58+
3659

3760
## Usage
3861

@@ -59,7 +82,7 @@ After that, add a new rule to your form field. For example, if you want to valid
5982
```php
6083
->add('email', 'disposable', [
6184
'rule' => 'disposable',
62-
'provider' => 'mbv',
85+
'provider' => 'mbv',
6386
'message' => 'Invalid email address. Please enter a non-disposable email address.',
6487
])
6588
```
@@ -83,4 +106,4 @@ The validators available to validate the email are: single, free and disposable.
83106

84107
## Copyright
85108

86-
Copyright (C) 2018 by MailboxValidator.com, support@mailboxvalidator.com
109+
Copyright (C) 2018-2020 by MailboxValidator.com, support@mailboxvalidator.com

0 commit comments

Comments
 (0)