Download the PHP package justinholtweb/pigeon without Composer
On this page you can find all versions of the php package justinholtweb/pigeon. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download justinholtweb/pigeon
More information about justinholtweb/pigeon
Files in justinholtweb/pigeon
Package pigeon
Short Description Two-way threaded messaging for Craft CMS 5 — customer support inboxes and user-to-user conversations with email, control panel, and on-site notifications.
License proprietary
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 pigeon
Pigeon
Two-way threaded messaging for Craft CMS 5. Pigeon gives your site a conversation inbox: customers ask a question, your team is notified and replies, and the customer is notified back — with the whole thread saved for both sides. It also supports private user-to-user direct messages between logged-in Craft users.
- Guest ↔ admin support threads — visitors message you without an account and return via a private, expiring link emailed to them.
- User ↔ user direct messages — logged-in users start conversations with each other.
- Three notification channels — queued email, a control-panel dashboard widget + nav badge, and on-site unread counts.
- Built on a
Threadelement — filterable CP inbox, search, statuses, and Trash for free. - Attachments, internal notes, assignment, statuses, read receipts.
Requirements
- Craft CMS 5.4.0 or later
- PHP 8.2 or later
Installation
From your project directory:
Then visit Settings → Plugins → Pigeon to configure it.
Concepts
- Thread — a conversation. Either
support(guest/customer ↔ staff) ordirect(user ↔ user). Has a status:open,pending(awaiting staff), orclosed. - Participant — a party on a thread. A Craft user (by
userId) or a guest (byemail+ a hashed access token). Each participant tracks its own read state. - Message — an entry in a thread. May be a normal message, an internal note (visible to staff only), or a system event.
Notifications
Every new message fans out from one place. Other participants who opted in receive a queued email — staff get a control-panel link, users get a front-end link, and guests get a freshly minted token link. Run the queue to deliver:
Staff also see a Pigeon Inbox dashboard widget and a nav badge counting threads that need a reply.
Front-end
Pigeon exposes craft.pigeon for logged-in users:
Built-in routes (self-contained example templates — copy and restyle as you like):
| Route | Who | Purpose |
|---|---|---|
pigeon/threads |
logged-in user | List your threads + start one |
pigeon/threads/<id> |
logged-in user | View & reply |
pigeon/t/<token> |
guest | View & reply via emailed link |
Public "contact support" form
Drop this anywhere (or copy templates/_front/contact-form.twig):
The guest is emailed a private link to follow the conversation; your support recipients are alerted to the new thread.
Action endpoints
| Action | Login | Purpose |
|---|---|---|
pigeon/guest/start |
anonymous | Guest starts a support thread |
pigeon/guest/reply |
anonymous (token) | Guest replies |
pigeon/guest/request-link |
anonymous | Re-email an expired link |
pigeon/threads/start |
user | Start a support or direct thread |
pigeon/messages/reply |
user | Reply to a thread you're in |
pigeon/admin/reply · /status · /assign |
staff | Control-panel actions |
Permissions
- Access Pigeon (
pigeon:accessPlugin) — read the inbox. - Manage threads (
pigeon:manageThreads) — reply, add notes, change status.- Assign threads (
pigeon:assignThreads).
- Assign threads (
- Manage settings (
pigeon:manageSettings).
Anti-spam
Guest forms are protected by a per-IP fixed-window rate limit and an optional honeypot field, both configurable in settings.
Development
The repo ships a DDEV environment and a Codeception suite that boots a real Craft installation against a scratch pigeon_test database.
The suite drops and reinstalls the test database on every run, and each test runs in a transaction that is rolled back afterwards.
License
See LICENSE.md.
