A few typos in README
This commit is contained in:
Denis Gurov
2022-02-11 18:09:16 +01:00
committed by GitHub
parent 9aab2ceed6
commit d51b279b5f
+5 -5
View File
@@ -19,7 +19,7 @@ This library aims to support RFCs:
## Supported versions
**Curent major version with full support is v3**
**Current major version with full support is v3**
| Version | Released | EOL | Only critical bug fixes | Full |
| ---- | :----: | :----: | :----: | :----: |
@@ -46,7 +46,7 @@ composer require egulias/email-validator
## Getting Started ##
`EmailValidator`requires you to decide which (or combination of them) validation/s strategy/ies you'd like to follow for each [validation](#available-validations).
`EmailValidator` requires you to decide which (or combination of them) validation/s strategy/ies you'd like to follow for each [validation](#available-validations).
A basic example with the RFC validation
```php
@@ -64,12 +64,12 @@ $validator->isValid("example@example.com", new RFCValidation()); //true
1. [RFCValidation](/src/Validation/RFCValidation.php): Standard RFC-like email validation.
2. [NoRFCWarningsValidation](/src/Validation/NoRFCWarningsValidation.php): RFC-like validation that will fail when warnings* are found.
3. [DNSCheckValidation](/src/Validation/DNSCheckValidation.php): Will check if there are DNS records that signal that the server accepts emails. This does not entails that the email exists.
3. [DNSCheckValidation](/src/Validation/DNSCheckValidation.php): Will check if there are DNS records that signal that the server accepts emails. This does not entail that the email exists.
5. [MultipleValidationWithAnd](/src/Validation/MultipleValidationWithAnd.php): It is a validation that operates over other validations performing a logical and (&&) over the result of each validation.
6. [MessageIDValidation](/src/Validation/MessageIDValidation.php): Follows [RFC2822 for message-id](https://tools.ietf.org/html/rfc2822#section-3.6.4) to validate that field, that has some differences in the domain part.
7. [Your own validation](#how-to-extend): You can extend the library behaviour by implementing your own validations.
*warnings: Warnings are deviations from the RFC that in a broader interpretation are acceptded.
*warnings: Warnings are deviations from the RFC that in a broader interpretation are accepted.
```php
<?php
@@ -84,7 +84,7 @@ $multipleValidations = new MultipleValidationWithAnd([
new RFCValidation(),
new DNSCheckValidation()
]);
//ietf.org has MX records signaling a server with email capabilites
//ietf.org has MX records signaling a server with email capabilities
$validator->isValid("example@ietf.org", $multipleValidations); //true
```