Download the PHP package devsrealm/csskiller-plugin-mail-contract without Composer
On this page you can find all versions of the php package devsrealm/csskiller-plugin-mail-contract. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download devsrealm/csskiller-plugin-mail-contract
More information about devsrealm/csskiller-plugin-mail-contract
Files in devsrealm/csskiller-plugin-mail-contract
Package csskiller-plugin-mail-contract
Short Description CSS Killer Mail Contract Plugin
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package csskiller-plugin-mail-contract
CSS Killer Mail Contract Plugin
A secure email-based terms acceptance plugin for CSS Killer CMS. This plugin provides a complete solution for collecting user consent through email verification, with built-in token management, audit trails, and automated cleanup.
Features
- Secure Email Verification: Generate cryptographically secure tokens for email confirmation
- Terms Acceptance Flow: Complete workflow from form submission to confirmation
- Token Management: Automatic expiration (24 hours), status tracking, and cleanup
- Audit Trail: Permanent records of confirmed acceptances for compliance
- Responsive UI: Modern, mobile-friendly templates using Tailwind CSS
- Console Commands: Automated cleanup of expired tokens
- RESTful API: JSON endpoints for integration with other systems
Requirements
- PHP 8.2 or higher
- CSS Killer CMS
- Composer for dependency management
Installation
-
Install via Composer:
-
Enable the plugin in your CSS Killer CMS admin panel
- Configure your email settings in the CMS configuration
Usage
Basic Terms Acceptance Flow
- Display Terms Form: Direct users to
/termsto show the acceptance form - Submit Email: User enters their email and submits the form
- Email Confirmation: System sends a secure confirmation link via email
- Confirm Acceptance: User clicks the link to confirm their acceptance
- Success Page: User sees confirmation of successful acceptance
API Endpoints
The plugin provides the following REST endpoints under the /terms route:
GET /terms
Displays the terms acceptance form.
POST /terms/submit
Submits the terms acceptance request.
Request Body:
Response:
GET /terms/confirm?token=<token>
Confirms the terms acceptance using the token from the email link.
GET /terms/status?email=<email>
Retrieves the status of tokens for a given email address.
Response:
Console Commands
Cleanup Expired Tokens
Remove expired pending tokens while preserving confirmed tokens for audit purposes:
This command:
- Removes tokens that have expired and are still pending
- Preserves all confirmed tokens as permanent audit records
- Should be run periodically (e.g., via cron job)
Programmatic Usage
Using the TokenSignatureService
Configuration
Environment Variables
No additional environment variables are required beyond standard CSS Killer CMS configuration.
Email Configuration
The plugin uses PHP's built-in mail() function by default. For production use, you should configure a proper email service in your CMS settings.
Token Settings
- Token Expiry: 24 hours (configurable in
TokenSignatureService::TOKEN_EXPIRY_HOURS) - Token Length: 64 characters (32 bytes of random data, hex-encoded)
- Storage: Tokens are stored in the CMS
system_globaltable with contextMAIL_SIGN
Security Features
- Cryptographically Secure Tokens: Uses
random_bytes()for token generation - Token Expiration: Automatic expiration prevents indefinite validity
- Single-Use Tokens: Tokens can only be confirmed once
- IP Tracking: Records IP addresses for audit purposes
- Metadata Storage: Stores user agent, timestamps, and custom metadata
- Audit Preservation: Confirmed tokens are never deleted for compliance
Templates
The plugin includes the following templates (located in src/templates/):
terms-form.html- The main terms acceptance formterms-success.html- Success confirmation pageterms-error.html- Error display page
Templates use the CSS Killer CMS template system and can be customized by overriding them in your theme.
Database Storage
Tokens are stored in the system_global table with:
context:MAIL_SIGNkey: The token stringvalue_json: JSON data containing email, status, expiry, metadata, etc.
Compliance & GDPR
- Audit Trail: All confirmations are permanently stored
- Data Minimization: Only necessary data is collected
- Consent Records: Permanent proof of user consent
- Cleanup: Automated removal of unconfirmed/expired data
Development
Project Structure
Extending the Plugin
Custom Email Templates
Override the email sending in TermsAcceptanceController::sendConfirmationEmail() to use your preferred email service.
Additional Metadata
Pass additional metadata when generating tokens:
Custom Validation
Extend the controller to add custom validation logic before token generation.
License
This plugin is licensed under the GNU Affero General Public License v3.0.
Support
For support and contributions, please contact the maintainer or create an issue in the project repository.
Changelog
Version 1.0.0
- Initial release
- Basic terms acceptance flow
- Token management service
- Console cleanup command
- Responsive templates
