inbox

package

v4.1.1 Latest Latest Go to latest Published: Dec 27, 2023 License: MIT Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/antham/yogo

Links

Open Source Insights

Documentation ¶

Index ¶

type Inbox
- func NewInbox[M client.MailDoc](name string, enableDebugMode bool) (*Inbox[M], error)
type InboxItem
type Render
type Sender

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Inbox ¶

type Inbox[M client.MailDoc] struct {
	Name       string      `json:"name"`
	InboxItems []InboxItem `json:"mails"`
	// contains filtered or unexported fields
}

Inbox represents a mail collection

func NewInbox ¶

func NewInbox[M client.MailDoc](name string, enableDebugMode bool) (*Inbox[M], error)

NewInbox creates a new mail inbox

func (*Inbox[M]) Add ¶

func (i *Inbox[M]) Add(inboxItem InboxItem)

Add appends a mail to mail list

func (*Inbox[M]) Coloured ¶

func (i *Inbox[M]) Coloured() (string, error)

func (*Inbox[M]) Count ¶

func (i *Inbox[M]) Count() int

Count returns total number of mails available in inbox

func (*Inbox[M]) Delete ¶

func (i *Inbox[M]) Delete(position int) error

Delete an email

func (*Inbox[M]) Fetch ¶

func (i *Inbox[M]) Fetch(offset int) (Render, error)

Fetch retrieves the full email content from the given inbox email offset

func (*Inbox[M]) Flush ¶

func (i *Inbox[M]) Flush() error

Flush empties an inbox

func (*Inbox[M]) GetMails ¶

func (i *Inbox[M]) GetMails() []InboxItem

func (*Inbox[M]) JSON ¶

func (i *Inbox[M]) JSON() (string, error)

func (*Inbox[M]) ParseInboxPages ¶

func (i *Inbox[M]) ParseInboxPages(limit int) error

ParseInboxPages parses inbox email in given page

func (*Inbox[M]) Shrink ¶

func (i *Inbox[M]) Shrink(limit int)

Shrink reduces mails size to given value

type InboxItem ¶

type InboxItem struct {
	ID      string     `json:"id"`
	Sender  *Sender    `json:"sender,omitempty"`
	Subject string     `json:"subject"`
	Date    *time.Time `json:"date,omitempty"`
	Body    string     `json:"body,omitempty"`
	IsSPAM  bool       `json:"isSPAM"`
}

Inbox represents a mail sumup in an inbox

type Render ¶

type Render interface {
	Coloured() (string, error)
	JSON() (string, error)
}

type Sender ¶

type Sender struct {
	Mail string `json:"mail,omitempty"`
	Name string `json:"name,omitempty"`
}

Source Files ¶

View all Source files

inbox.go

Directories ¶

Path	Synopsis
internal
mail

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL