mailzeet/mailzeet-php

This is simple PHP Package to interact with MailZeet.

v0.1.7 2024-02-29 13:06 UTC

This package is auto-updated.

Last update: 2024-11-08 01:43:53 UTC


README

MailZeet website

MailZeet PHP SDK

Website · Contact · Documentation

PHP Version Build Status Latest Stable Version Total Downloads License

The MailZeet PHP SDK provides convenient access to the MailZeet API from applications written with PHP.

Requirements

PHP Requirements: PHP 7.4 and later.

Installation

You can install the package via composer:

composer require mailzeet/mailzeet-php

Documentation

See the php SDK documentation.

Development

1- Perform the tests

 composer test

2- Format and analyze your code before commit and push.

 composer format # Format your code with the required code style
 composer unused # check if there is an unused dependency
composer analyze # Analyze your code with phpstan

DEV Mode

You can set devMode to true when creating a new instance of the SDK to enable the dev mode. After enabling the dev mode, you can pass devBaseUrl to customize the base URL of the MailZeet API you want to use. In dev mode, the SDK will use the devBaseUrl instead of the default base URL https://api.mailzeet.com.

Notes

  • The project is based on the KISS principle.
  • Each time you make a change, you must run the tests and format your code.
  • Each time you make a change, you must update the documentation.
  • Each time you make a change, you must update the changelog.
  • Each time you make a change, you must add test cases.
  • Each time you make a change, you must update the version number.
  • Each time you make a change, you must update the API documentation.
  • Each time you make a change, you must update the README.md file.

Security Vulnerabilities

If you discover a security vulnerability within MailZeet PHP SDK, please send an e-mail to MailZeet Security via hello@mailzeet.com. All security vulnerabilities will be promptly addressed.

License

The MailZeet PHP SDK is open-sourced software licensed under the MIT license.