Documentation
¶
Index ¶
- Constants
- func Asset(name string) ([]byte, error)
- func AssetDigest(name string) ([sha256.Size]byte, error)
- func AssetDir(name string) ([]string, error)
- func AssetInfo(name string) (os.FileInfo, error)
- func AssetNames() []string
- func AssetString(name string) (string, error)
- func Digests() (map[string][sha256.Size]byte, error)
- func InviteUserEmail(sender, senderEmail, recipient, recipientEmail string, data InviteUserData) (msg *mail.SGMailV3, err error)
- func MustAsset(name string) []byte
- func MustAssetString(name string) string
- func Render(name string, data interface{}) (text, html string, err error)
- func RestoreAsset(dir, name string) error
- func RestoreAssets(dir, name string) error
- type EmailManager
- type InviteUserData
Constants ¶
const ( UserInviteRE = "You have been invited to collaborate on %s" UserInviteWithNameRE = "%s has invited you to collaborate on %s" )
Subjects for creating emails on demand.
const AssetDebug = false
AssetDebug is true if the assets were built with the debug flag enabled.
Variables ¶
This section is empty.
Functions ¶
func Asset ¶
Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.
func AssetDigest ¶
AssetDigest returns the digest of the file with the given name. It returns an error if the asset could not be found or the digest could not be loaded.
func AssetDir ¶
AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:
data/
foo.txt
img/
a.png
b.png
then AssetDir("data") would return []string{"foo.txt", "img"}, AssetDir("data/img") would return []string{"a.png", "b.png"}, AssetDir("foo.txt") and AssetDir("notexist") would return an error, and AssetDir("") will return []string{"data"}.
func AssetInfo ¶
AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.
func AssetString ¶
AssetString returns the asset contents as a string (instead of a []byte).
func InviteUserEmail ¶
func InviteUserEmail(sender, senderEmail, recipient, recipientEmail string, data InviteUserData) (msg *mail.SGMailV3, err error)
InviteUserEmail creates a new user invite email, ready for sending by rendering the text and html templates with the supplied data then constructing a sendgrid email.
func MustAsset ¶
MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables.
func MustAssetString ¶
MustAssetString is like AssetString but panics when Asset would return an error. It simplifies safe initialization of global variables.
func Render ¶
Render returns the text and html executed templates for the specified name and data. Ensure that the extension is not supplied to the render method.
func RestoreAsset ¶
RestoreAsset restores an asset under the given directory.
func RestoreAssets ¶
RestoreAssets restores an asset under the given directory recursively.
Types ¶
type EmailManager ¶
type EmailManager struct {
// contains filtered or unexported fields
}
EmailManager allows the BFF to send rich emails using the SendGrid service.
func New ¶
func New(conf config.EmailConfig) (m *EmailManager, err error)
func (*EmailManager) SendUserInvite ¶
func (m *EmailManager) SendUserInvite(user *management.User, inviter *management.User, org *models.Organization, inviteURL *url.URL) (err error)
SendUserInvite sends an email to a user inviting them to join an organization.
type InviteUserData ¶
type InviteUserData struct {
UserName string // The name of the user being invited
UserEmail string // The email address of the user being invited
InviterName string // The name of the user sending the invite
InviterEmail string // The email address of the user sending the invite
Organization string // The name of the relevant organization
InviteURL string // The invite URL that the recipient uses to accept the invite
}
InviteUserData to complete user invite email templates.
func (InviteUserData) Subject ¶ added in v1.7.3
func (d InviteUserData) Subject() string
Source Files