Flamingo
New in 3.21.1 (Pro). Two dispatcher tools work with Flamingo 2.6.4:
| Tool | Default | Purpose |
|---|---|---|
flamingo-read | On | Status, messages, contacts and channels (6 operations) |
flamingo-write | Off | Spam, not spam, trash and restore a message (4 operations) |
Enable the write tool under Tools > Plugins > Flamingo.
Requirements
Section titled “Requirements”- An active EMCP Pro licence.
- Flamingo 2.6.4 exactly; another version answers
unsupported_version. Contact Form 7 is optional. - An administrator (
manage_options) with Flamingo’s message permissions. Contacts need Flamingo’s contact permission, channels its options permission, and each message and contact is checked individually.
Read operations
Section titled “Read operations”| Operation | What it does |
|---|---|
status | Version, whether Contact Form 7 is active and whether the trash is enabled |
list-messages | Messages by status (publish by default, flamingo-spam, trash), newest first, paged: ID, status, date, subject, channel, version |
get-message | One message by id; with include_details: true also its submitted fields |
list-contacts | Contacts by status, paged: ID, status, date |
get-contact | One contact by id; with include_details: true also name and email |
list-channels | Form channels: ID, slug, name |
Lists cover up to 5,000 messages or contacts per status (scope_too_large beyond).
Submitted fields leave out any key that looks like a password, secret, token, auth value, API key, credit card or CVV, at every nesting level up to ten, and objects are omitted. Internal request data and spam-check payloads are never returned. A secret typed into a free-text field cannot be detected.
Write operations
Section titled “Write operations”Every write needs the message’s version and confirm: true; dry_run: true validates first.
| Operation | What it does |
|---|---|
spam | Mark a message as spam |
unspam | Mark a spam message as not spam |
trash | Move a message to the trash |
restore | Bring a trashed message back to the status it had before |
Rules and refusals
Section titled “Rules and refusals”- Messages carrying Akismet data are refused (
external_side_effect): moderate them in Flamingo, which reports them to Akismet. - When the site’s trash is turned off,
trashis refused (trash_disabled), because Flamingo would delete the message permanently. spamandunspamon a trashed message are refused (invalid_transition): restore it first.- A message changed since your read answers
conflict. There is no permanent delete.
History
Section titled “History”Every change can be undone from History, which sets the previous status back through Flamingo with a conflict check. If a hook fails after the status changed, EMCP tries to put the status back and records a recovery entry (partial_write).
