| Name | spf-validator JSON |
| Version |
1.4.0
JSON |
| download |
| home_page | None |
| Summary | Validates Sender Policy Framework (SPF) strings to ensure they are formatted correctly. |
| upload_time | 2025-11-01 19:55:55 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT License |
| keywords |
spf
sender policy framework
email
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# spf-validator
spf-validator is a Python package for validating Sender Policy Framework strings and records to ensure they are formatted correctly.
The validation returns a list of strings where each string, if any, is an issue with the SPF record.
## Installation
Use pip to install:
```python
pip install spf-validator
```
## Usage
There are two main functions in the package: `validate_spf_string` and `validate_domain_spf`. Both of these will return a list of strings where each string, if any, is an issue with the SPF record.
To validate an SPF string, use `validate_spf_string` by passing it the string.
To use:
```python
from spf_validator import validator
issues_list = validator.validate_spf_string('v=spf1 a mx include:_spf.google.com ~all')
```
To validate an SPF record on a given domain, use `validate_domain_spf` by passing it the domain. This will retrieve the TXT records for the domain, locate the SPF record, and validate it.
To use:
```python
from spf_validator import validator
issues_list = validator.validate_domain_spf('google.com')
```
## Contributing
Community made feature requests, patches, bug reports, and contributions are always welcome.
Please review [our contributing guidelines](https://github.com/fpcorso/spf-validator/blob/main/CONTRIBUTING.md) if you decide to make a contribution.
## License
This project is licensed under the MIT License. See [LICENSE](https://github.com/fpcorso/spf-validator/blob/main/LICENSE) for more details.
Raw data
{
"_id": null,
"home_page": null,
"name": "spf-validator",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "spf, sender policy framework, email",
"author": null,
"author_email": "Frank Corso <frank@frankcorso.me>",
"download_url": "https://files.pythonhosted.org/packages/e1/26/189986afe0420653fe460af9e665f003fbb92f956e9a9da904dfbb0be993/spf_validator-1.4.0.tar.gz",
"platform": null,
"description": "# spf-validator\n\nspf-validator is a Python package for validating Sender Policy Framework strings and records to ensure they are formatted correctly.\n\nThe validation returns a list of strings where each string, if any, is an issue with the SPF record.\n\n## Installation\n\nUse pip to install:\n\n```python\npip install spf-validator\n```\n\n## Usage\n\nThere are two main functions in the package: `validate_spf_string` and `validate_domain_spf`. Both of these will return a list of strings where each string, if any, is an issue with the SPF record.\n\nTo validate an SPF string, use `validate_spf_string` by passing it the string.\n\nTo use:\n\n```python\nfrom spf_validator import validator\n\nissues_list = validator.validate_spf_string('v=spf1 a mx include:_spf.google.com ~all')\n```\n\nTo validate an SPF record on a given domain, use `validate_domain_spf` by passing it the domain. This will retrieve the TXT records for the domain, locate the SPF record, and validate it.\n\nTo use:\n\n```python\nfrom spf_validator import validator\n\nissues_list = validator.validate_domain_spf('google.com')\n```\n\n## Contributing\n\nCommunity made feature requests, patches, bug reports, and contributions are always welcome.\n\nPlease review [our contributing guidelines](https://github.com/fpcorso/spf-validator/blob/main/CONTRIBUTING.md) if you decide to make a contribution.\n\n## License\n\nThis project is licensed under the MIT License. See [LICENSE](https://github.com/fpcorso/spf-validator/blob/main/LICENSE) for more details.\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Validates Sender Policy Framework (SPF) strings to ensure they are formatted correctly.",
"version": "1.4.0",
"project_urls": {
"Repository": "https://github.com/fpcorso/spf-validator"
},
"split_keywords": [
"spf",
" sender policy framework",
" email"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "0d99772c16b57c96330e991249223d47f9083c84ecc5ce913805ccff68d81761",
"md5": "e407f7bcbbac06d8a808c4adb2cdc623",
"sha256": "8b56dc9882696263f906ba1296db6a78b34907a74c42de1359efd34baef7ecdc"
},
"downloads": -1,
"filename": "spf_validator-1.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e407f7bcbbac06d8a808c4adb2cdc623",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 5035,
"upload_time": "2025-11-01T19:55:53",
"upload_time_iso_8601": "2025-11-01T19:55:53.718550Z",
"url": "https://files.pythonhosted.org/packages/0d/99/772c16b57c96330e991249223d47f9083c84ecc5ce913805ccff68d81761/spf_validator-1.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "e126189986afe0420653fe460af9e665f003fbb92f956e9a9da904dfbb0be993",
"md5": "f152731885e23fb80a647c629981b894",
"sha256": "f105d0461e5e27c0a61f7d11d692456975792bd20ba2984032475891321c0808"
},
"downloads": -1,
"filename": "spf_validator-1.4.0.tar.gz",
"has_sig": false,
"md5_digest": "f152731885e23fb80a647c629981b894",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 5334,
"upload_time": "2025-11-01T19:55:55",
"upload_time_iso_8601": "2025-11-01T19:55:55.015628Z",
"url": "https://files.pythonhosted.org/packages/e1/26/189986afe0420653fe460af9e665f003fbb92f956e9a9da904dfbb0be993/spf_validator-1.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-11-01 19:55:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fpcorso",
"github_project": "spf-validator",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "spf-validator"
}
