Download the PHP package barth/slacknewsletter without Composer
On this page you can find all versions of the php package barth/slacknewsletter. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download barth/slacknewsletter
More information about barth/slacknewsletter
Files in barth/slacknewsletter
Package slacknewsletter
Short Description Self managed newsletter for Slack
License proprietary
Informations about the package slacknewsletter
Slack Newsletter
This application allows you to generate a newsletter from your Slack channels. It goes through the channels looking for links, combines them into a html file, and sends it by email. It's ideal for keeping track of your finds when the historical Slack reaches its limit.
Installation & Configuration
-
Clone the project and launch
composer install
inside. -
Generate a Token on your slack workspace
-
In your
.env.local
, complete your smtp configuration, the receivers, and your Slack token like that : -
Choose your channels to browse and add them in
config/channels.json
. You can check out theconfig/channels.json.dist
to see how add a new channels -
(OPTIONNAL) : Pimp your newsletter by altering parameters in
config/package/parameters.yaml
- Configure your cron to execute command to browse, build, and send newsletter.
For example :
Build With
- Symfony 5.2
- symfony/console
- symfony/mailer
- symfony/yaml
- FlySystem from The Php League
- jolicode/slack-php-api
- Embed
- Carbon
Thank to theirs awesome work.
Customize the newsletter
If you want to customize the newsletter, all templates are in templates
folder.
Before testing rendering, you have to retrieve some messages :
The
-d
or--days
is to specified how many days to retrieve. You can have lots of data by this way.
To test the view in web-browser, launch a web server :
and go to http://127.0.0.1:8000/test/mail
But you probably have to send emails to test compatibility with emails viewer.
You can launch theses commands to avoid archivation of messages and builded news.
Contribute
First of all, thank you for contributing ♥
If you find any typo/misconfiguration/... please send a PR or open an issue.
Also, while creating your PR, please write a description which gives the context and/or explains why you are creating it.
TODOs
- [x] Make installation as simple as a
composer create-project barth/slacknewsletter
- [x] Browse private channel
- [x] Make sure it'll work with Slack App and provide a configuration guide
- [ ] Write Tests Suite
- [ ] Add translations
- [ ] Easily extend with other Team Collaboration Software (Discord, HipChat...)
All versions of slacknewsletter with dependencies
ext-iconv Version *
embed/embed Version ^3.3
frlnc/php-slack Version ^1.0
league/flysystem Version ^1.0
nesbot/carbon Version ^1.24
symfony/console Version *
symfony/flex Version ^1.0
symfony/framework-bundle Version *
symfony/swiftmailer-bundle Version ^3.2
symfony/twig-bundle Version ^4.0
symfony/dotenv Version *
symfony/yaml Version *