voicemail

Documentation

Index

• type Box
  • func (box *Box) MarshalAsterisk(e *astconf.Encoder) error
  • func (box *Box) Options() (options []string)
• type Section
  • func (section *Section) SectionName() string

Types

type Box

type Box struct {
	// Extension is the number of the mailbox.
	Extension string

	// Name is the name of the mailbox.
	Name string

	// Password is the password used to retrieve messages.
	Password string

	// PasswordIsChangeable enables self-service voicemail password changes.
	PasswordIsChangeable bool

	// EmailAddresses are the set of recipients that will receive email
	// messages.
	EmailAddresses []string

	// PagerEmailAddress is the email address that will receive pager
	// notifications.
	PagerEmailAddress string

	// Timezone assigns a particular timezone message to the mailbox.
	Timezone string

	// Locale declares a particular locale to use for date and time strings.
	Locale string

	// SendToPager causes the voicemail to be sent to the pager address.
	SendToPager bool

	// Format overrides the default audio format that will be attached
	// to an email.
	Format string

	// SayCallerID causes the caller to be identified before playing back a
	// message.
	SayCallerID bool

	// SkipEnvelope prevents the envelope (date/time) from being presented
	//  to the user before playing back a message.
	SkipEnvelope bool

	// EmailOnly causes messages to be deleted from the server after they
	// have been sent via email.
	EmailOnly bool
}

Box holds settings for a voicemail mailbox.

func (*Box) MarshalAsterisk

func (box *Box) MarshalAsterisk(e *astconf.Encoder) error

MarshalAsterisk marshals the mailbox to an asterisk encoder.

func (*Box) Options

func (box *Box) Options() (options []string)

Options returns an options string representing the mailbox options.

type Section

type Section struct {
	Context   string `astconf:"-"`
	Mailboxes []Box
}

Section is a mailbox section with a common context.

func (*Section) SectionName

func (section *Section) SectionName() string

SectionName returns the name of the voicemail context section.