{"id":29150463,"url":"https://github.com/humanmade/falcon","last_synced_at":"2025-06-30T23:10:39.785Z","repository":{"id":4854493,"uuid":"6009061","full_name":"humanmade/Falcon","owner":"humanmade","description":"Connect WordPress to your inbox, and party like it's '88","archived":false,"fork":false,"pushed_at":"2021-09-15T04:53:00.000Z","size":647,"stargazers_count":104,"open_issues_count":11,"forks_count":20,"subscribers_count":22,"default_branch":"master","last_synced_at":"2024-04-14T05:13:32.835Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"sgotre/sphp-osx","license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/humanmade.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-09-29T12:59:30.000Z","updated_at":"2023-12-15T08:14:42.000Z","dependencies_parsed_at":"2022-08-27T11:33:48.426Z","dependency_job_id":null,"html_url":"https://github.com/humanmade/Falcon","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/humanmade/Falcon","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/humanmade%2FFalcon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/humanmade%2FFalcon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/humanmade%2FFalcon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/humanmade%2FFalcon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/humanmade","download_url":"https://codeload.github.com/humanmade/Falcon/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/humanmade%2FFalcon/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262864258,"owners_count":23376461,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-30T23:10:38.963Z","updated_at":"2025-06-30T23:10:39.730Z","avatar_url":"https://github.com/humanmade.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Falcon\n\n![](https://38.media.tumblr.com/73f719a60ed916ff6790f5ebe6b96d24/tumblr_mzvqty8GWZ1rpe379o1_500.gif)\n\nFor a long time, WordPress has had a pretty dysfunctional relationship with\nemail. The Post by Email feature was neglected, then finally reinvigorated and\nmoved to a plugin. Notifications for comments aren't the greatest, and\nnotifications for new posts are non-existent.\n\nThis is annoying for most sites, but makes internal communication sites like P2\nsuper annoying to use.\n\nYou know what has great email notifications? GitHub. They stay out of your way,\nintegrate perfectly with email clients, and are just generally kick-ass.\n\nYou know what **now** has great email notifications? WordPress.\n\n![](http://i.imgur.com/RNY5qQj.png)\n\n\n## Neato! How do I set this up?\n\nTwo steps!\n\n### Step 1: Pick an email provider\n\nYou'll need to pick an email provider that we support. Right now, we have\nhandlers for:\n\n* [Amazon SES](https://aws.amazon.com/ses/) (see [setup instructions](docs/amazon-ses.md))\n* [Mandrill](https://mandrill.com/)\n* [Postmark](https://postmarkapp.com/)\n* WP Mail (message sending only, no replies)\n\nIf you haven't got one already, I'd personally recommend Postmark, as setting up is a wee bit easier.\n\nSet aside a domain to handle emails. `notifications.example.com` is a good\nexample. We'll be sending emails from `reply@` from this domain, and you'll be\nreplying to the same email (but with a plus address bit for authentication).\n\n(Wish we had support for another handler? Let us know, or try making a handler\nyourself! You'll find the code for it in `library/Falcon/Handler`.)\n\n### Step 2: Install and set up the plugin\n\nClone the plugin from GitHub and drop it into your WP plugins directory.\nEnable it on your site, then head to the settings page and set your preferences.\nIf you're following the steps from above, set both your Reply-To and From email\naddress to `reply@notifications.example.com` (obviously with your domain\ninstead).\n\nPick your email handler and follow the guide to set it up.\n\nYou're done! Welcome to a new world of WP.\n\n\n## Hey, I have some questions...\n\n### What about formatting?\n\nFalcon sends out the full HTML in a neatly formatted email, similar to GitHub's\nemail notifications. We also convert the HTML over to a text representation\nsimilar to Markdown for clients that don't support HTML or prefer a text\nversion of their notifications.\n\n### What if I use multisite?\n\nWow, do we have a treat for you? Falcon is built from the ground up to work\nbeautifully with multisite. There's just one trick: you'll need to Network\nActivate it. Doing this will put Falcon into \"network mode\", and activate some\nspecial tools just for you.\n\nFirst up, head to your Network Admin, then to the Falcon settings page. You'll\nnotice that you can enable or disable Falcon per-site, so go ahead and do that\nnow. Keep in mind that any new sites will need to be turned on here when you\nadd them.\n\nOnce you've saved this, head over to your profile page to set your own settings.\nIf you're running in network mode, you'll notice Falcon's settings have been\nsuperpowered with a grid that looks something like this:\n\n![](http://i.imgur.com/rQlThgE.png)\n\nSweet, huh?\n\nEmails will always be sent from the network-wide email address, with the same\napplying to your reply-to address. However, Falcon will use each site's data\nwhen sending emails and handling replies, so no need to worry about conflicts.\n\n**Privacy:** Users will only ever receive notifications for sites they're able\nto access. If you have several levels of users on your network, rest assured\nthat Falcon won't expose any secrets.\n\n\n## Cool, but what's the low-down on the internals?\n\nFalcon is built essentially to be a facilitator of communication. Internally,\nFalcon has two sides:\n\n* **Connectors**: These connect events on your site (like posts being published\n  or comments being posted) to Falcon, and turn the events into emails to be\n  sent to the users.\n* **Handlers**: These take emails prepared by Connectors and send them off to\n  email providers (like Mandrill or Postmark).\n\nThe same then applies in reverse when receiving emails. Handlers are responsible\nfor parsing out incoming emails and passing them to Falcon, then Falcon passes\nthese off to the relevant Connectors to add into the system.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhumanmade%2Ffalcon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhumanmade%2Ffalcon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhumanmade%2Ffalcon/lists"}