alpsbase

Documentation

Index

• Variables
• func RegisterViewer(viewer Viewer)
• type Attachment
• type ComposeRenderData
• type IMAPMessage
  • func (msg *IMAPMessage) Attachments() []IMAPPartNode
  • func (msg *IMAPMessage) HasFlag(flag string) bool
  • func (msg *IMAPMessage) PartByID(id string) *IMAPPartNode
  • func (msg *IMAPMessage) PartByPath(path []int) *IMAPPartNode
  • func (msg *IMAPMessage) PartTree() *IMAPPartNode
  • func (msg *IMAPMessage) TextPart() *IMAPPartNode
  • func (msg *IMAPMessage) URL() *url.URL
• type IMAPPartNode
  • func (node IMAPPartNode) IsText() bool
  • func (node IMAPPartNode) PathString() string
  • func (node IMAPPartNode) String() string
  • func (node IMAPPartNode) URL(raw bool) *url.URL
• type MailboxInfo
  • func (mbox *MailboxInfo) URL() *url.URL
• type MailboxRenderData
• type MailboxStatus
  • func (mbox *MailboxStatus) URL() *url.URL
• type MessageRenderData
• type OutgoingMessage
  • func (msg *OutgoingMessage) ToString() string
  • func (msg *OutgoingMessage) WriteTo(w io.Writer) error
• type Settings
• type SettingsRenderData
• type Viewer

Variables

var ErrViewUnsupported = fmt.Errorf("cannot generate message view: unsupported part")

ErrViewUnsupported is returned by Viewer.ViewMessagePart when the message part isn't supported.

Functions

func RegisterViewer

func RegisterViewer(viewer Viewer)

RegisterViewer registers a message part viewer.

Types

type Attachment

type Attachment interface {
	MIMEType() string
	Filename() string
	Open() (io.ReadCloser, error)
}

type ComposeRenderData

type ComposeRenderData struct {
	alps.BaseRenderData
	Message *OutgoingMessage
}

type IMAPMessage

type IMAPMessage struct {
	*imap.Message

	Mailbox string
}

func (*IMAPMessage) Attachments

func (msg *IMAPMessage) Attachments() []IMAPPartNode

func (*IMAPMessage) HasFlag

func (msg *IMAPMessage) HasFlag(flag string) bool

func (*IMAPMessage) PartByID

func (msg *IMAPMessage) PartByID(id string) *IMAPPartNode

func (*IMAPMessage) PartByPath

func (msg *IMAPMessage) PartByPath(path []int) *IMAPPartNode

func (*IMAPMessage) PartTree

func (msg *IMAPMessage) PartTree() *IMAPPartNode

func (*IMAPMessage) TextPart

func (msg *IMAPMessage) TextPart() *IMAPPartNode

func (*IMAPMessage) URL

func (msg *IMAPMessage) URL() *url.URL

type IMAPPartNode

type IMAPPartNode struct {
	Path     []int
	MIMEType string
	Filename string
	Children []IMAPPartNode
	Message  *IMAPMessage
}

func (IMAPPartNode) IsText

func (node IMAPPartNode) IsText() bool

func (IMAPPartNode) PathString

func (node IMAPPartNode) PathString() string

func (IMAPPartNode) String

func (node IMAPPartNode) String() string

func (IMAPPartNode) URL

func (node IMAPPartNode) URL(raw bool) *url.URL

type MailboxInfo

type MailboxInfo struct {
	*imap.MailboxInfo
}

func (*MailboxInfo) URL

func (mbox *MailboxInfo) URL() *url.URL

type MailboxRenderData

type MailboxRenderData struct {
	alps.BaseRenderData
	Mailbox            *MailboxStatus
	Inbox              *MailboxStatus
	Mailboxes          []MailboxInfo
	Messages           []IMAPMessage
	PrevPage, NextPage int
	Query              string
}

type MailboxStatus

type MailboxStatus struct {
	*imap.MailboxStatus
}

func (*MailboxStatus) URL

func (mbox *MailboxStatus) URL() *url.URL

type MessageRenderData

type MessageRenderData struct {
	alps.BaseRenderData
	Mailboxes   []MailboxInfo
	Mailbox     *MailboxStatus
	Inbox       *MailboxStatus
	Message     *IMAPMessage
	Part        *IMAPPartNode
	View        interface{}
	MailboxPage int
	Flags       map[string]bool
}

type OutgoingMessage

type OutgoingMessage struct {
	From        string
	To          []string
	Subject     string
	InReplyTo   string
	Text        string
	Attachments []Attachment
}

func (*OutgoingMessage) ToString

func (msg *OutgoingMessage) ToString() string

func (*OutgoingMessage) WriteTo

func (msg *OutgoingMessage) WriteTo(w io.Writer) error

type Settings

type Settings struct {
	MessagesPerPage int
}

type SettingsRenderData

type SettingsRenderData struct {
	alps.BaseRenderData
	Settings *Settings
}

type Viewer

type Viewer interface {
	// ViewMessagePart renders a message part. The returned value is displayed
	// in a template. ErrViewUnsupported is returned if the message part isn't
	// supported.
	ViewMessagePart(*alps.Context, *IMAPMessage, *message.Entity) (interface{}, error)
}

Viewer is a message part viewer.