Convert an SES secret key to an SMTP password
Examples
<?php
require_once 'vendor/autoload.php';
use Skyzyx\Ses\SesPassword;
$password = SesPassword::convert($secrey_key);
Installation
Using Composer:
composer require skyzyx/convert-ses-secret-to-password=^1.0
And include it in your scripts:
require_once 'vendor/autoload.php';
Testing
Firstly, run composer install --optimize-autoloader
to download and install the dependencies.
You can run the tests as follows:
bin/phpunit
API Reference
The API Reference is generated by a tool called Sami. You should install it locally on your system with:
Once it's installed, you can generate updated documentation by running the following command in the root of the repository.
bin/sami.php update docs/sami-config.php -v
GPG Signing
Each release (i.e., git tag) is GPG-signed. You can easily verify the contents using Keybase.
keybase dir verify
If you're more familiar with traditional GPG signing, view SIGNED.md
for the information you need to do the verification.
Contributing
Here's the process for contributing:
- Fork convert-ses-secret-to-password to your GitHub account.
- Clone your GitHub copy of the repository into your local workspace.
- Write code, fix bugs, and add tests with 100% code coverage.
- Commit your changes to your local workspace and push them up to your GitHub copy.
- You submit a GitHub pull request with a description of what the change is.
- The contribution is reviewed. Maybe there will be some banter back-and-forth in the comments.
- If all goes well, your pull request will be accepted and your changes are merged in.
Authors, Copyright & Licensing
- Copyright (c) 2015 Ryan Parman.
See also the list of contributors who participated in this project.
Licensed for use under the terms of the MIT license.
Coding Standards
PSR-0/1/2 are a solid foundation, but are not an entire coding style by themselves. I have taken the time to document all of the nitpicky patterns and nuances of my personal coding style. It goes well-beyond brace placement and tabs vs. spaces to cover topics such as docblock annotations, ternary operations and which variation of English to use. It aims for thoroughness and pedanticism over hoping that we can all get along.