mbxs

Documentation

Overview

Package mbxs provides functions and types for working with IMAP mailboxes used by applications in this module.

Index

• func InList(needle string, haystack []string, ignoreCase bool) bool
• type MailboxCheckResult
• type MailboxCheckResults
  • func (mcr MailboxCheckResults) GotMail() bool
  • func (mcr MailboxCheckResults) MessagesFoundSummary() string
  • func (mcr MailboxCheckResults) TotalMessagesFound() int

Functions

func InList

func InList(needle string, haystack []string, ignoreCase bool) bool

InList is a helper function to emulate Python's `if "x" in list:` functionality. The caller can optionally ignore case of compared items.

Types

type MailboxCheckResult

type MailboxCheckResult struct {
	MailboxName string
	ItemsFound  int
}

MailboxCheckResult notes how many mail items were found for a specific mailbox

type MailboxCheckResults

type MailboxCheckResults []MailboxCheckResult

MailboxCheckResults represents a collection of all results from mailbox checks.

func (MailboxCheckResults) GotMail

func (mcr MailboxCheckResults) GotMail() bool

GotMail returns true if mail was found in checked mailboxes or false if not.

func (MailboxCheckResults) MessagesFoundSummary

func (mcr MailboxCheckResults) MessagesFoundSummary() string

MessagesFoundSummary returns a one-line summary of the mail items found in checked mailboxes.

func (MailboxCheckResults) TotalMessagesFound

func (mcr MailboxCheckResults) TotalMessagesFound() int

TotalMessagesFound returns a count of all messages found across all checked mailboxes.