blomstra/email-conversations

Start discussions and reply to discussions via email

0.1.0-beta.11 2023-02-15 09:54 UTC

Requires

• php: ^8.0
• blomstra/conversations: ^0.1.0
• flarum/approval: *
• flarum/core: ^1.6.3
• flarum/mentions: *
• flarum/subscriptions: *
• flarum/tags: *
• fof/upload: ^1.2
• league/html-to-markdown: ^5.1
• mailgun/mailgun-php: ^3.5.5
• nyholm/psr7: ^1.5
• symfony/http-client: ^6.0

MIT

• Team Blomstra

• flarum

README

A Flarum extension.

Features

• Allow users to register (and confirm) additional email addresses that can be associated with their account
• Start new discussions via email
• Reply to notification emails
• HTML formatted emails are converted to Markdown and formatted according to the current TextFormatter configuration
• Specify a Tag for new discussions started by email
• Option to have new discussions started via email automatically flagged for moderator approval/tag re-assignment, etc
• Option to auto subscribe to discussions participated in via email

What do I need to know?

At present, you must be using Mailgun to send your email notifications (using the built in Mailgun provider). Support for other services might be added in the future, but for now this will be the only provider option.

If you're also using fof/pretty-mail, this is supported, but you are required to make minor updates to your templates.

Your email sending domain DNS must have the correct MX records configured for Mailgun to be able to receive inbound mail. Don't worry about configuring routes, etc, as the extension will configure this for you.

Installation

Install with composer:

composer require blomstra/email-conversations:"*"

blomstra/conversations and blomstra/email-conversations will be installed together.

• Enable Conversations first, and review the permissions to see the post source. By default this is set to admin and mod groups.
• Enable Email Conversations.
• Visit {YOUR_FORUM}/admin#/mail and click Create Mailgun incoming route.
• Configure the extension settings as per your requirements {YOUR_FORUM}/admin#/extension/blomstra-email-conversations.
• If you're using fof/pretty-mail: In each of your HTML templates, add the variable $notificationId somewhere in the content. Somewhere in the <footer> element is recommended.
• Send a test email to your forum (The email address is the one configured in your email settings tab). The subject line will become the discussion title, the email body will become the post content.

Updating

composer update blomstra/email-conversations
php flarum migrate
php flarum cache:clear

Screenshots

Admin panel

Post header

Post header for moderators

Additional email addresses in user settings

Integration with fof/pretty-mail

If you are using fof/pretty-mail, it is required that you update your templates to include $notificationId, somewhere within the visible portion of the mail.

Links

• Packagist
• GitHub
• Discuss