emailbee

Documentation

Overview

Package emailbee is a Bee that is able to send emails.

Index

• type EmailBee
  • func (mod *EmailBee) Action(action bees.Action) []bees.Placeholder
  • func (mod *EmailBee) ReloadOptions(options bees.BeeOptions)
• type EmailBeeFactory
  • func (factory *EmailBeeFactory) Actions() []bees.ActionDescriptor
  • func (factory *EmailBeeFactory) Description() string
  • func (factory *EmailBeeFactory) Events() []bees.EventDescriptor
  • func (factory *EmailBeeFactory) ID() string
  • func (factory *EmailBeeFactory) Image() string
  • func (factory *EmailBeeFactory) LogoColor() string
  • func (factory *EmailBeeFactory) Name() string
  • func (factory *EmailBeeFactory) New(name, description string, options bees.BeeOptions) bees.BeeInterface
  • func (factory *EmailBeeFactory) Options() []bees.BeeOptionDescriptor

Types

type EmailBee

type EmailBee struct {
	bees.Bee
	// contains filtered or unexported fields
}

EmailBee is a Bee that is able to send emails.

func (*EmailBee) Action

func (mod *EmailBee) Action(action bees.Action) []bees.Placeholder

Action triggers the action passed to it.

func (*EmailBee) ReloadOptions

func (mod *EmailBee) ReloadOptions(options bees.BeeOptions)

ReloadOptions parses the config options and initializes the Bee.

type EmailBeeFactory

type EmailBeeFactory struct {
	bees.BeeFactory
}

EmailBeeFactory is a factory for EmailBees.

func (*EmailBeeFactory) Actions

func (factory *EmailBeeFactory) Actions() []bees.ActionDescriptor

Actions describes the available actions provided by this Bee.

func (*EmailBeeFactory) Description

func (factory *EmailBeeFactory) Description() string

Description returns the description of this Bee.

func (*EmailBeeFactory) Events

func (factory *EmailBeeFactory) Events() []bees.EventDescriptor

Events describes the available events provided by this Bee.

func (*EmailBeeFactory) ID

func (factory *EmailBeeFactory) ID() string

ID returns the ID of this Bee.

func (*EmailBeeFactory) Image

func (factory *EmailBeeFactory) Image() string

Image returns the filename of an image for this Bee.

func (*EmailBeeFactory) LogoColor

func (factory *EmailBeeFactory) LogoColor() string

LogoColor returns the preferred logo background color (used by the admin interface).

func (*EmailBeeFactory) Name

func (factory *EmailBeeFactory) Name() string

Name returns the name of this Bee.

func (*EmailBeeFactory) New

func (factory *EmailBeeFactory) New(name, description string, options bees.BeeOptions) bees.BeeInterface

New returns a new Bee instance configured with the supplied options.

func (*EmailBeeFactory) Options

func (factory *EmailBeeFactory) Options() []bees.BeeOptionDescriptor

Options returns the options available to configure this Bee.