notify/README.md

<div align="center">
<img
    width=40%
    src="assets/gopher-letter.svg"
    alt="notify logo"
/>

![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/nikoksr/notify?color=success&label=version&sort=semver)
[![Go Report Card](https://goreportcard.com/badge/github.com/nikoksr/notify)](https://goreportcard.com/report/github.com/nikoksr/notify)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/37fdff3c275c4a72a3a061f2d0ec5553)](https://www.codacy.com/gh/nikoksr/notify/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=nikoksr/notify&amp;utm_campaign=Badge_Grade)
[![Maintainability](https://api.codeclimate.com/v1/badges/b3afd7bf115341995077/maintainability)](https://codeclimate.com/github/nikoksr/notify/maintainability)
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fnikoksr%2Fnotify.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fnikoksr%2Fnotify?ref=badge_shield)
[![go.dev reference](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white&style=flat)](https://pkg.go.dev/github.com/nikoksr/notify)

</div>

> <p align="center">A dead simple Go library for sending notifications to various messaging services.</p>

<h1></h1>

## About <a id="about"></a>

*Notify* was born out of my own need to have my API servers running in production be able to notify me when critical errors occur. Of course, _Notify_ can be used for any other purpose as well. The library is kept as simple as possible for quick integration and ease of use.

## Disclaimer <a id="disclaimer"></a>

Any misuse of this library is your own liability and responsibility and cannot be attributed to the authors of this library.  See [license](LICENSE) for more.

Spamming through the use of this library **may get you permanently banned** on most supported platforms.

## Install <a id="install"></a>

```sh
go get -u github.com/nikoksr/notify
```

## Example usage <a id="usage"></a>

```go
// Create a telegram service. Ignoring error for demo simplicity.
telegramService, _ := telegram.New("your_telegram_api_token")

// Passing a telegram chat id as receiver for our messages.
// Basically where should our message be sent?
telegramService.AddReceivers(-1234567890)

// Create our notifications distributor.
notifier := notify.New()

// Tell our notifier to use the telegram service. You can repeat the above process
// for as many services as you like and just tell the notifier to use them.
// Inspired by http middlewares used in higher level libraries.
notifier.UseServices(telegramService)

// Send a test message.
_ = notifier.Send(
	context.Background(),
	"Subject/Title",
	"The actual message - Hello, you awesome gophers! :)",
)
```

## Supported services <a id="supported_services"></a>

> Please create feature requests for missing services (see #3 for example)

- *Amazon SES*
- *Discord*
- *Email*
- *Line*
- *Mailgun*
- *Microsoft Teams*
- *Plivo*
- *Pushbullet*
- *RocketChat*
- *SendGrid*
- *Slack*
- *Telegram*
- *TextMagic*
- *Twitter*
- *WeChat*
- *WhatsApp*

## Credits <a id="credits"></a>

- Amazon SES support: [aws/aws-sdk-go](https://github.com/aws/aws-sdk-go)
- Discord support: [bwmarrin/discordgo](https://github.com/bwmarrin/discordgo)
- Email support: [jordan-wright/email](https://github.com/jordan-wright/email)
- Line support: [line/line-bot-sdk-go](https://github.com/line/line-bot-sdk-go)
- Logo: [MariaLetta/free-gophers-pack](https://github.com/MariaLetta/free-gophers-pack)
- Mailgun support: [mailgun/mailgun-go](https://github.com/mailgun/mailgun-go)
- Microsoft Teams support: [atc0005/go-teams-notify](https://github.com/atc0005/go-teams-notify)
- Plivo support: [plivo/plivo-go](https://github.com/plivo/plivo-go)
- Pushbullet support: [cschomburg/go-pushbullet](https://github.com/cschomburg/go-pushbullet)
- RocketChat Support: [RocketChat/Rocket.Chat.Go.SDK](https://github.com/RocketChat/Rocket.Chat.Go.SDK)
- SendGrid support: [sendgrid/sendgrid-go](https://github.com/sendgrid/sendgrid-go)
- Slack support: [slack-go/slack](https://github.com/slack-go/slack)
- Telegram support: [go-telegram-bot-api/telegram-bot-api](https://github.com/go-telegram-bot-api/telegram-bot-api)
- TextMagic support: [textmagic/textmagic-rest-go-v2](https://github.com/textmagic/textmagic-rest-go-v2)
- Twitter: [dghubble/go-twitter](https://github.com/dghubble/go-twitter)
- WeChat: [silenceper/wechat](https://github.com/silenceper/wechat)
- WhatsApp: [Rhymen/go-whatsapp](https://github.com/Rhymen/go-whatsapp)

## Author <a id="author"></a>

**Niko Köser**

* Twitter: [@nikoksr](https://twitter.com/nikoksr)
* Github: [@nikoksr](https://github.com/nikoksr)

## Contributing <a id="contributing"></a>

Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/nikoksr/notify/issues). You can also take a look at the [contributing guide](https://github.com/nikoksr/notify/blob/main/CONTRIBUTING.md).

## Show your support <a id="support"></a>

Give a ⭐️ if you like this project!

## License <a id="license"></a>

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fnikoksr%2Fnotify.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fnikoksr%2Fnotify?ref=badge_large)
docs(readme): refactor readme 2021-01-26 11:45:14 +02:00			`<div align="center">`
			`<img`
			`width=40%`
			`src="assets/gopher-letter.svg"`
			`alt="notify logo"`
			`/>`

			`![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/nikoksr/notify?color=success&label=version&sort=semver)`
			`[![Go Report Card](https://goreportcard.com/badge/github.com/nikoksr/notify)](https://goreportcard.com/report/github.com/nikoksr/notify)`
docs(readme): fix codacy badge 2021-01-26 11:54:06 +02:00			`[![Codacy Badge](https://app.codacy.com/project/badge/Grade/37fdff3c275c4a72a3a061f2d0ec5553)](https://www.codacy.com/gh/nikoksr/notify/dashboard?utm_source=github.com&utm_medium=referral&utm_content=nikoksr/notify&utm_campaign=Badge_Grade)`
docs(readme): refactor readme 2021-01-26 11:45:14 +02:00			`[![Maintainability](https://api.codeclimate.com/v1/badges/b3afd7bf115341995077/maintainability)](https://codeclimate.com/github/nikoksr/notify/maintainability)`
docs(readme): add fossa badge to readme 2021-02-01 08:50:37 +02:00			`[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fnikoksr%2Fnotify.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fnikoksr%2Fnotify?ref=badge_shield)`
docs(readme): refactor readme 2021-01-26 11:45:14 +02:00			`[![go.dev reference](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white&style=flat)](https://pkg.go.dev/github.com/nikoksr/notify)`

			`</div>`

docs(readme): update description 2021-01-26 12:39:02 +02:00			`> <p align="center">A dead simple Go library for sending notifications to various messaging services.</p>`
docs(readme): refactor readme 2021-01-26 11:45:14 +02:00
			`<h1></h1>`

			`## About <a id="about"></a>`

docs(readme): reword some paragraphs and add missing libs to credits list 2021-02-12 20:20:07 +02:00			`Notify was born out of my own need to have my API servers running in production be able to notify me when critical errors occur. Of course, _Notify_ can be used for any other purpose as well. The library is kept as simple as possible for quick integration and ease of use.`
docs(readme): refactor readme 2021-01-26 11:45:14 +02:00
			`## Disclaimer <a id="disclaimer"></a>`

			`Any misuse of this library is your own liability and responsibility and cannot be attributed to the authors of this library. See [license](LICENSE) for more.`

			`Spamming through the use of this library may get you permanently banned on most supported platforms.`

			`## Install <a id="install"></a>`
docs: add readme, coc, and contrib guidelines 2021-01-25 06:05:59 +02:00
			```sh
			`go get -u github.com/nikoksr/notify`
			```

docs(readme): refactor readme 2021-01-26 11:45:14 +02:00			`## Example usage <a id="usage"></a>`
docs: add readme, coc, and contrib guidelines 2021-01-25 06:05:59 +02:00
			```go
docs(readme): reword some paragraphs and add missing libs to credits list 2021-02-12 20:20:07 +02:00			`// Create a telegram service. Ignoring error for demo simplicity.`
docs: add readme, coc, and contrib guidelines 2021-01-25 06:05:59 +02:00			`telegramService, _ := telegram.New("your_telegram_api_token")`

			`// Passing a telegram chat id as receiver for our messages.`
docs(readme): reword some paragraphs and add missing libs to credits list 2021-02-12 20:20:07 +02:00			`// Basically where should our message be sent?`
			`telegramService.AddReceivers(-1234567890)`
docs: add readme, coc, and contrib guidelines 2021-01-25 06:05:59 +02:00
docs(readme): change calling order in notify example 2021-05-27 12:46:11 +02:00			`// Create our notifications distributor.`
			`notifier := notify.New()`

docs: add readme, coc, and contrib guidelines 2021-01-25 06:05:59 +02:00			`// Tell our notifier to use the telegram service. You can repeat the above process`
			`// for as many services as you like and just tell the notifier to use them.`
docs(readme): reword some paragraphs and add missing libs to credits list 2021-02-12 20:20:07 +02:00			`// Inspired by http middlewares used in higher level libraries.`
docs(readme): Fix UseService usage The `UseService` has been renamed to `UseServices`. Signed-off-by: Prashanth Pai <mail@ppai.me> 2021-02-06 11:20:21 +02:00			`notifier.UseServices(telegramService)`
docs: add readme, coc, and contrib guidelines 2021-01-25 06:05:59 +02:00
docs(readme): reword some paragraphs and add missing libs to credits list 2021-02-12 20:20:07 +02:00			`// Send a test message.`
docs(readme): correct faulty telegram chat id 2021-01-25 06:16:08 +02:00			`_ = notifier.Send(`
refactor(send): Add context.Context to parameter list of Send method 2021-02-18 04:33:30 +02:00			`context.Background(),`
docs(readme): reword some paragraphs and add missing libs to credits list 2021-02-12 20:20:07 +02:00			`"Subject/Title",`
refactor(send): Add context.Context to parameter list of Send method 2021-02-18 04:33:30 +02:00			`"The actual message - Hello, you awesome gophers! :)",`
docs: add readme, coc, and contrib guidelines 2021-01-25 06:05:59 +02:00			`)`
			```

docs(readme): add list of supported services 2021-01-26 12:31:14 +02:00			`## Supported services <a id="supported_services"></a>`

refactor(send): Add context.Context to parameter list of Send method 2021-02-18 04:33:30 +02:00			`> Please create feature requests for missing services (see #3 for example)`

docs: Update README with new supported Amazon SES service 2021-02-16 01:11:23 +02:00			`- Amazon SES`
docs(readme): add list of supported services 2021-01-26 12:31:14 +02:00			`- Discord`
			`- Email`
docs: add line service to readme 2021-02-23 12:19:07 +02:00			`- Line`
docs: Update README with new supported Mailgun service 2021-02-10 19:23:34 +02:00			`- Mailgun`
docs(readme): add notes about Microsoft Teams support 2021-01-29 20:26:10 +02:00			`- Microsoft Teams`
feat(service): Add Plivo service Added support for Plivo as a backend service with unit tests and documentation. Signed-off-by: Prashanth Pai <mail@ppai.me> 2021-02-06 11:00:42 +02:00			`- Plivo`
			`- Pushbullet`
docs: add rocketchat service to readme 2021-03-10 19:37:32 +02:00			`- RocketChat`
docs: Update README with new supported SendGrid service 2021-02-10 17:22:58 +02:00			`- SendGrid`
docs(readme): add notes about slack support 2021-01-27 02:09:54 +02:00			`- Slack`
docs(readme): add notes about Microsoft Teams support 2021-01-29 20:26:10 +02:00			`- Telegram`
add: textmagic service 2021-05-06 16:53:59 +02:00			`- TextMagic`
feat(service): Add Plivo service Added support for Plivo as a backend service with unit tests and documentation. Signed-off-by: Prashanth Pai <mail@ppai.me> 2021-02-06 11:00:42 +02:00			`- Twitter`
feat: added support for WeChat 2021-03-21 18:54:10 +02:00			`- WeChat`
docs(readme): reorder supported services list alphabetically 2021-05-27 12:46:46 +02:00			`- WhatsApp`
docs(readme): add list of supported services 2021-01-26 12:31:14 +02:00
docs(readme): refactor readme 2021-01-26 11:45:14 +02:00			`## Credits <a id="credits"></a>`
docs: add readme, coc, and contrib guidelines 2021-01-25 06:05:59 +02:00
docs: Update README with new supported Amazon SES service 2021-02-16 01:11:23 +02:00			`- Amazon SES support: [aws/aws-sdk-go](https://github.com/aws/aws-sdk-go)`
docs(readme): add list of supported services 2021-01-26 12:31:14 +02:00			`- Discord support: [bwmarrin/discordgo](https://github.com/bwmarrin/discordgo)`
			`- Email support: [jordan-wright/email](https://github.com/jordan-wright/email)`
docs: add line service to readme 2021-02-23 12:19:07 +02:00			`- Line support: [line/line-bot-sdk-go](https://github.com/line/line-bot-sdk-go)`
docs(readme): reword some paragraphs and add missing libs to credits list 2021-02-12 20:20:07 +02:00			`- Logo: [MariaLetta/free-gophers-pack](https://github.com/MariaLetta/free-gophers-pack)`
			`- Mailgun support: [mailgun/mailgun-go](https://github.com/mailgun/mailgun-go)`
docs(readme): add notes about Microsoft Teams support 2021-01-29 20:26:10 +02:00			`- Microsoft Teams support: [atc0005/go-teams-notify](https://github.com/atc0005/go-teams-notify)`
docs(readme): reword some paragraphs and add missing libs to credits list 2021-02-12 20:20:07 +02:00			`- Plivo support: [plivo/plivo-go](https://github.com/plivo/plivo-go)`
			`- Pushbullet support: [cschomburg/go-pushbullet](https://github.com/cschomburg/go-pushbullet)`
docs: add rocketchat service to readme 2021-03-10 19:37:32 +02:00			`- RocketChat Support: [RocketChat/Rocket.Chat.Go.SDK](https://github.com/RocketChat/Rocket.Chat.Go.SDK)`
docs(readme): reword some paragraphs and add missing libs to credits list 2021-02-12 20:20:07 +02:00			`- SendGrid support: [sendgrid/sendgrid-go](https://github.com/sendgrid/sendgrid-go)`
docs(readme): add notes about slack support 2021-01-27 02:09:54 +02:00			`- Slack support: [slack-go/slack](https://github.com/slack-go/slack)`
docs(readme): add notes about Microsoft Teams support 2021-01-29 20:26:10 +02:00			`- Telegram support: [go-telegram-bot-api/telegram-bot-api](https://github.com/go-telegram-bot-api/telegram-bot-api)`
add: textmagic service 2021-05-06 16:53:59 +02:00			`- TextMagic support: [textmagic/textmagic-rest-go-v2](https://github.com/textmagic/textmagic-rest-go-v2)`
docs(readme): reword some paragraphs and add missing libs to credits list 2021-02-12 20:20:07 +02:00			`- Twitter: [dghubble/go-twitter](https://github.com/dghubble/go-twitter)`
feat: added support for WeChat 2021-03-21 18:54:10 +02:00			`- WeChat: [silenceper/wechat](https://github.com/silenceper/wechat)`
Alphabetical order in README.md Co-authored-by: Niko Köser <koeserniko@gmail.com> 2021-04-15 09:53:41 +02:00			`- WhatsApp: [Rhymen/go-whatsapp](https://github.com/Rhymen/go-whatsapp)`
docs: add readme, coc, and contrib guidelines 2021-01-25 06:05:59 +02:00
docs(readme): refactor readme 2021-01-26 11:45:14 +02:00			`## Author <a id="author"></a>`
docs: add readme, coc, and contrib guidelines 2021-01-25 06:05:59 +02:00
docs(readme): refactor readme 2021-01-26 11:45:14 +02:00			`Niko Köser`
docs: add readme, coc, and contrib guidelines 2021-01-25 06:05:59 +02:00
			`* Twitter: [@nikoksr](https://twitter.com/nikoksr)`
			`* Github: [@nikoksr](https://github.com/nikoksr)`

docs(readme): refactor readme 2021-01-26 11:45:14 +02:00			`## Contributing <a id="contributing"></a>`
docs: add readme, coc, and contrib guidelines 2021-01-25 06:05:59 +02:00
			`Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/nikoksr/notify/issues). You can also take a look at the [contributing guide](https://github.com/nikoksr/notify/blob/main/CONTRIBUTING.md).`

docs(readme): refactor readme 2021-01-26 11:45:14 +02:00			`## Show your support <a id="support"></a>`
docs: add readme, coc, and contrib guidelines 2021-01-25 06:05:59 +02:00
docs(readme): reword some paragraphs and add missing libs to credits list 2021-02-12 20:20:07 +02:00			`Give a ⭐️ if you like this project!`
docs: add readme, coc, and contrib guidelines 2021-01-25 06:05:59 +02:00
docs(readme): add fossa badge to readme 2021-02-01 08:50:37 +02:00			`## License <a id="license"></a>`

			`[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fnikoksr%2Fnotify.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fnikoksr%2Fnotify?ref=badge_large)`