mail

Documentation

Overview

Package mail implements a GUI email client.

Index

• Variables
• func IMAPToMailAddresses(as []imap.Address) []*mail.Address
• type AddressTextField
  • func NewAddressTextField(parent ...tree.Node) *AddressTextField
  • func (at *AddressTextField) Init()
  • func (t *AddressTextField) SetAddress(v mail.Address) *AddressTextField
  • func (at *AddressTextField) WidgetValue() any
• type App
  • func NewApp(parent ...tree.Node) *App
  • func (a *App) Compose()
  • func (a *App) Delete()
  • func (a *App) Forward()
  • func (a *App) GetMail()
  • func (a *App) Init()
  • func (a *App) Label()
  • func (a *App) MakeToolbar(p *tree.Plan)
  • func (a *App) MarkAsRead()
  • func (a *App) MarkAsUnread()
  • func (a *App) Reply()
  • func (a *App) ReplyAll()
  • func (a *App) Send() error
• type Attachment
• type AttachmentButton
  • func NewAttachmentButton(parent ...tree.Node) *AttachmentButton
  • func (ab *AttachmentButton) Init()
  • func (t *AttachmentButton) SetAttachment(v *Attachment) *AttachmentButton
  • func (ab *AttachmentButton) WidgetValue() any
• type CacheMessage
  • func (cm *CacheMessage) ToDisplay() *displayMessage
• type DisplayMessageFrame
  • func NewDisplayMessageFrame(parent ...tree.Node) *DisplayMessageFrame
  • func (dmf *DisplayMessageFrame) Init()
  • func (t *DisplayMessageFrame) SetMessage(v *CacheMessage) *DisplayMessageFrame
  • func (dmf *DisplayMessageFrame) WidgetValue() any
• type Label
  • func (lb *Label) UIDSet() imap.UIDSet
• type MessageListItem
  • func NewMessageListItem(parent ...tree.Node) *MessageListItem
  • func (mi *MessageListItem) Init()
  • func (t *MessageListItem) SetMessage(v *CacheMessage) *MessageListItem
  • func (mi *MessageListItem) WidgetValue() any
• type SendMessage
• type SettingsData

Variables

var Settings = &SettingsData{
	SettingsBase: core.SettingsBase{
		Name: "Mail",
		File: filepath.Join(core.TheApp.DataDir(), "Cogent Mail", "settings.toml"),
	},
}

Settings is the currently active global Cogent Mail settings instance.

Functions

func IMAPToMailAddresses

func IMAPToMailAddresses(as []imap.Address) []*mail.Address

IMAPToMailAddresses converts the given [imap.Address]es to [mail.Address]es.

Types

type AddressTextField

type AddressTextField struct {
	core.TextField
	Address mail.Address
}

AddressTextField represents a mail.Address with a core.TextField.

func NewAddressTextField

func NewAddressTextField(parent ...tree.Node) *AddressTextField

NewAddressTextField returns a new AddressTextField with the given optional parent: AddressTextField represents a mail.Address with a core.TextField.

func (*AddressTextField) Init

func (at *AddressTextField) Init()

func (*AddressTextField) SetAddress

func (t *AddressTextField) SetAddress(v mail.Address) *AddressTextField

SetAddress sets the [AddressTextField.Address]

func (*AddressTextField) WidgetValue

func (at *AddressTextField) WidgetValue() any

type App

type App struct {
	core.Frame
	// contains filtered or unexported fields
}

App is an email client app.

func NewApp

func NewApp(parent ...tree.Node) *App

NewApp returns a new App with the given optional parent: App is an email client app.

func (*App) Compose

func (a *App) Compose()

Compose opens a dialog to send a new message.

func (*App) Delete

func (a *App) Delete()

Delete moves the current message to the trash.

func (*App) Forward

func (a *App) Forward()

Forward opens a dialog to forward the current message to others.

func (*App) GetMail

func (a *App) GetMail()

func (*App) Init

func (a *App) Init()

func (*App) Label

func (a *App) Label()

Label opens a dialog for changing the labels (mailboxes) of the current message.

func (*App) MakeToolbar

func (a *App) MakeToolbar(p *tree.Plan)

func (*App) MarkAsRead

func (a *App) MarkAsRead()

MarkAsRead marks the current message as read.

func (*App) MarkAsUnread

func (a *App) MarkAsUnread()

MarkAsUnread marks the current message as unread.

func (*App) Reply

func (a *App) Reply()

Reply opens a dialog to reply to the current message.

func (*App) ReplyAll

func (a *App) ReplyAll()

ReplyAll opens a dialog to reply to all people involved in the current message.

func (*App) Send

func (a *App) Send() error

Send sends the current message

type Attachment

type Attachment struct {
	Filename string
	Data     []byte
}

Attachment represents an email attachment when reading a message.

type AttachmentButton

type AttachmentButton struct {
	core.Button
	Attachment *Attachment
}

AttachmentButton represents an Attachment with a core.Button.

func NewAttachmentButton

func NewAttachmentButton(parent ...tree.Node) *AttachmentButton

NewAttachmentButton returns a new AttachmentButton with the given optional parent: AttachmentButton represents an Attachment with a core.Button.

func (*AttachmentButton) Init

func (ab *AttachmentButton) Init()

func (*AttachmentButton) SetAttachment

func (t *AttachmentButton) SetAttachment(v *Attachment) *AttachmentButton

SetAttachment sets the [AttachmentButton.Attachment]

func (*AttachmentButton) WidgetValue

func (ab *AttachmentButton) WidgetValue() any

type CacheMessage

type CacheMessage struct {
	imap.Envelope

	// Filename is the unique filename of the cached message contents.
	Filename string

	// Flags are the IMAP flags associated with the message.
	Flags []imap.Flag

	// Labels are the labels associated with the message.
	// Labels are many-to-many, similar to gmail. All labels
	// also correspond to IMAP mailboxes.
	Labels []Label
	// contains filtered or unexported fields
}

CacheMessage contains the data stored for a cached message in the cached messages file. It contains basic information about the message so that it can be displayed in the mail list in the GUI.

func (*CacheMessage) ToDisplay

func (cm *CacheMessage) ToDisplay() *displayMessage

ToDisplay converts the CacheMessage to a [displayMessage] with the given additional [readMessageParsed] data.

type DisplayMessageFrame

type DisplayMessageFrame struct {
	core.Frame
	Message *CacheMessage
}

DisplayMessageFrame is a frame that displays the metadata and contents of a message.

func NewDisplayMessageFrame

func NewDisplayMessageFrame(parent ...tree.Node) *DisplayMessageFrame

NewDisplayMessageFrame returns a new DisplayMessageFrame with the given optional parent: DisplayMessageFrame is a frame that displays the metadata and contents of a message.

func (*DisplayMessageFrame) Init

func (dmf *DisplayMessageFrame) Init()

func (*DisplayMessageFrame) SetMessage

func (t *DisplayMessageFrame) SetMessage(v *CacheMessage) *DisplayMessageFrame

SetMessage sets the [DisplayMessageFrame.Message]

func (*DisplayMessageFrame) WidgetValue

func (dmf *DisplayMessageFrame) WidgetValue() any

type Label

type Label struct {
	Name string
	UID  imap.UID
}

Label represents a Label associated with a message. It contains the name of the Label and the UID of the message in the IMAP mailbox corresponding to the Label.

func (*Label) UIDSet

func (lb *Label) UIDSet() imap.UIDSet

UIDSet returns an imap.UIDSet that contains just the UID of the message in the IMAP mailbox corresponding to the Label.

type MessageListItem

type MessageListItem struct {
	core.Frame
	Message *CacheMessage
}

MessageListItem represents a CacheMessage with a core.Frame for the message list.

func NewMessageListItem

func NewMessageListItem(parent ...tree.Node) *MessageListItem

NewMessageListItem returns a new MessageListItem with the given optional parent: MessageListItem represents a CacheMessage with a core.Frame for the message list.

func (*MessageListItem) Init

func (mi *MessageListItem) Init()

func (*MessageListItem) SetMessage

func (t *MessageListItem) SetMessage(v *CacheMessage) *MessageListItem

SetMessage sets the [MessageListItem.Message]

func (*MessageListItem) WidgetValue

func (mi *MessageListItem) WidgetValue() any

type SendMessage

type SendMessage struct {
	From        []*mail.Address `display:"inline"`
	To          []*mail.Address `display:"inline"`
	Subject     string
	Attachments []core.Filename `display:"inline"`
	// contains filtered or unexported fields
}

SendMessage represents the data necessary for the user to send a message.

type SettingsData

type SettingsData struct {
	core.SettingsBase

	// Accounts are the email accounts the user is signed into.
	Accounts []string
}

SettingsData is the data type for the global Cogent Mail settings.