zero-to-prod / validate-email
Validates an email
Fund package maintenance!
Github
Installs: 10 200
Dependents: 2
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Language:Dockerfile
Requires
- php: >=7.1
- zero-to-prod/package-helper: ^1.1.3
- zero-to-prod/regex-email: ^71.0
Requires (Dev)
- phpunit/phpunit: <12.0
Suggests
- zero-to-prod/data-model: Type-safe DTOs
- zero-to-prod/data-model-factory: Factories for a DataModel.
- zero-to-prod/transformable: Transform a class into different types.
README
Contents
- Introduction
- Requirements
- Installation
- Documentation Publishing
- Usage
- Local Development
- Contributing
Introduction
Validates an email.
Requirements
- PHP 7.1 or higher.
Installation
Install Zerotoprod\ValidateEmail
via Composer:
composer require zero-to-prod/validate-email
This will add the package to your project’s dependencies and create an autoloader entry for it.
Documentation Publishing
You can publish this README to your local documentation directory.
This can be useful for providing documentation for AI agents.
This can be done using the included script:
# Publish to default location (./docs/zero-to-prod/validate-email) vendor/bin/zero-to-prod-validate-email # Publish to custom directory vendor/bin/zero-to-prod-validate-email /path/to/your/docs
Automatic Documentation Publishing
You can automatically publish documentation by adding the following to your composer.json
:
{ "scripts": { "post-install-cmd": [ "zero-to-prod-validate-email" ], "post-update-cmd": [ "zero-to-prod-validate-email" ] } }
Usage
Returns true if the value is a valid email.
Zerotoprod\ValidateEmail\ValidateEmail::isEmail('john@example.com')
Contributing
Contributions, issues, and feature requests are welcome! Feel free to check the issues page if you want to contribute.
- Fork the repository.
- Create a new branch (
git checkout -b feature-branch
). - Commit changes (
git commit -m 'Add some feature'
). - Push to the branch (
git push origin feature-branch
). - Create a new Pull Request.