mirror of
https://github.com/d0zingcat/gocryptotrader.git
synced 2026-05-18 23:16:49 +00:00
3b8591bcc8
* Updated documentation tool Added templates Updated documentation using tool * Fixed incorrect version in web README * Added new templates to tool. Updated documents in templates across the code base. Used tool to regenerate documentation.
48 lines
1.3 KiB
Cheetah
48 lines
1.3 KiB
Cheetah
{{define "communications smtp" -}}
|
|
{{template "header" .}}
|
|
## SMSGlobal Communications package
|
|
|
|
### What is SMTP?
|
|
|
|
+ Simple Mail Transfer Protocol (SMTP) is an Internet standard for electronic mail (email) transmission
|
|
+ Please visit: [Wikipedia](https://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol) for more information
|
|
|
|
### Current Features
|
|
|
|
+ Sending of events to a list of recipients via email
|
|
|
|
### How to enable
|
|
|
|
+ [Enable via configuration](https://github.com/thrasher-/gocryptotrader/tree/master/config#enable-communications-via-config-example)
|
|
|
|
+ Individual package example below:
|
|
```go
|
|
import (
|
|
"github.com/thrasher-/gocryptotrader/communications/smtpservice"
|
|
"github.com/thrasher-/gocryptotrader/config"
|
|
)
|
|
|
|
s := new(smtpservice.SMTPservice)
|
|
|
|
// Define SMTPservice configuration
|
|
commsConfig := config.CommunicationsConfig{SMTPservice: config.SMTPConfig{
|
|
Name: "SMTPservice",
|
|
Enabled: true,
|
|
Verbose: false,
|
|
Host: "host",
|
|
Port: "port",
|
|
AccountName: "name",
|
|
AccountPassword: "password",
|
|
RecipientList: "something@something.com,somethingelse@something.com"
|
|
}}
|
|
|
|
s.Setup(commsConfig)
|
|
err := s.Connect
|
|
// Handle error
|
|
```
|
|
|
|
### Please click GoDocs chevron above to view current GoDoc information for this package
|
|
{{template "contributions"}}
|
|
{{template "donations"}}
|
|
{{end}}
|