Skip to main content

Usage Example


Python License

SafeMX is your first line of defense against email spoofing and phishing attacks. Effortlessly check your domain's SPF, DKIM, and DMARC records to ensure your emails are authenticated and secure.

Usage Example

Features

  • 🛡 SPF, DKIM, and DMARC record validation
  • ⚡ Fast, reliable, and easy to use
  • 🌐 JSON and console output formats for flexibility
  • 🚀 Cool modern design with easy setup and execution

🚀 Getting Started

Follow these simple steps to install and use SafeMX:

Prerequisites

  • Python 3.x
  • pip package manager

Installation

  1. Clone the repository:

    git clone https://github.com/MarkoGordic/SafeMX.git
    
  2. Navigate to the project directory:

    cd safemx
    
  3. Install the required dependencies:

    pip install -r requirements.txt
    

🛠️ Usage

Run SafeMX to check SPF, DMARC, and DKIM records for a domain. You can specify the output format (console or JSON).

Checking SPF, DMARC, and DKIM

  • To check SPF:

    python3 main.py example.com -spf
    
  • To check DMARC:

    python3 main.py example.com -dmarc
    
  • To check DKIM:

    python3 main.py example.com -dkim -selector default
    

Output Formats

  • Console Output (default):

    python3 main.py example.com -spf -dmarc
    
  • JSON Output:

    python3 main.py example.com -spf -dmarc --output json --outfile result.json
    

Example Output

Console Output:

[+] SPF record for example.com found!
    spf: "v=spf1 ip4:192.0.2.0/24 -all"
[+] DMARC record for example.com found!
    dmarc: "v=DMARC1; p=quarantine; adkim=s; aspf=s;"

JSON Output:

{
  "spf": {
    "record": "v=spf1 ip4:192.0.2.0/24 -all",
    "version": "v=spf1",
    "mechanisms": [
      {
        "type": "ip",
        "value": "ip4:192.0.2.0/24"
      },
      {
        "type": "all",
        "value": "-all"
      }
    ]
  },
  "dmarc": {
    "record": "v=DMARC1; p=quarantine; adkim=s; aspf=s;",
    "fields": {
      "v": "DMARC1",
      "p": "quarantine",
      "adkim": "s",
      "aspf": "s"
    }
  }
}

📜 License

SafeMX is open-source software licensed under the MIT License.

Metadata

Release files for safemx 0.1.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for safemx 0.1.7
File Size Uploaded Provenance Actions
safemx-0.1.7.tar.gz 9.6 kB Without provenance Details for safemx-0.1.7.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for safemx 0.1.7
File Interpreter ABI Platform Actions
safemx-0.1.7-py3-none-any.whl Python 3 none any Details for safemx-0.1.7-py3-none-any.whl

Total release size: 19.1 kB

Release files / safemx-0.1.7.tar.gz

Download URL safemx-0.1.7.tar.gz
Size 9.6 kB
Tags Source
SHA-256 checksum
How to use checksums
d252a50b84402f2a9295331b018a5e165dc66eaa33d859f5420ad141e1a66f8b
BLAKE2b-256 checksum
How to use checksums
4f9d422cfc39d145171bcad0012f8395f02806d17f330d5007c0010a98d45397
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.6

Release files / safemx-0.1.7-py3-none-any.whl

Download URL safemx-0.1.7-py3-none-any.whl
Size 9.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
621ddfa3d350704e80298e92264397345c9d18cda32a000ff16f3dd6a723a601
BLAKE2b-256 checksum
How to use checksums
1fba292bd2423ac7ab0d0f61f495005bb057173d27fafab0361c9193be437085
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.6

Security for safemx 0.1.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page