Documentation ¶
Index ¶
- Constants
- Variables
- func GetIredMailVersion() (iredMailVersion, error)
- func ReadInConfig() error
- func SetConfigFile(path string)
- type Alias
- type Aliases
- type Domain
- type DomainAlias
- type DomainAliases
- type Domains
- type Forwarding
- type Forwardings
- type Mailbox
- type Mailboxes
- type Server
- func (s *Server) Alias(aliasEmail string) (Alias, error)
- func (s *Server) AliasAdd(aliasEmail string) error
- func (s *Server) AliasDelete(aliasEmail string) error
- func (s *Server) AliasForwardingAdd(aliasEmail, forwardingEmail string) error
- func (s *Server) AliasForwardingDelete(aliasEmail, forwardingEmail string) error
- func (s *Server) Aliases() (Aliases, error)
- func (s *Server) Close()
- func (s *Server) Domain(domainName string) (Domain, error)
- func (s *Server) DomainAdd(domain Domain) error
- func (s *Server) DomainAliasAdd(aliasDomain, domain string) error
- func (s *Server) DomainAliasDelete(aliasDomain string) error
- func (s *Server) DomainAliases() (DomainAliases, error)
- func (s *Server) DomainCatchallAdd(domain, catchallEmail string) error
- func (s *Server) DomainCatchallDelete(domain, catchallEmail string) error
- func (s *Server) DomainDelete(domain string) error
- func (s *Server) Domains() (Domains, error)
- func (s *Server) ForwardingAdd(mailboxEmail, destinationEmail string) error
- func (s *Server) ForwardingDelete(mailboxEmail, destinationEmail string) error
- func (s *Server) Forwardings() (Forwardings, error)
- func (s *Server) Mailbox(mailboxEmail string) (Mailbox, error)
- func (s *Server) MailboxAdd(mailboxEmail, password string, quota int, storageBasePath string) error
- func (s *Server) MailboxAliasAdd(alias, mailboxEmail string) error
- func (s *Server) MailboxAliasDelete(aliasEmail string) error
- func (s *Server) MailboxAliasDeleteAll(mailboxEmail string) error
- func (s *Server) MailboxDelete(mailboxEmail string) error
- func (s *Server) MailboxSetKeepCopy(mailboxEmail string, keepCopyInMailbox bool) error
- func (s *Server) MailboxSetPassword(mailboxEmail, password string) error
- func (s *Server) MailboxSetQuota(mailboxEmail string, quota int) error
- func (s *Server) Mailboxes() (Mailboxes, error)
Constants ¶
const (
// DomainDefaultSettings keep the defaut settings
DomainDefaultSettings = "default_user_quota:2048"
)
const (
// Version of iredmail-cli
Version = "0.2.6"
)
Variables ¶
var ( // ErrIredMailVersionNotSupported ... ErrIredMailVersionNotSupported = errors.New("iredMail version is not supported") )
Functions ¶
func GetIredMailVersion ¶ added in v0.2.2
func GetIredMailVersion() (iredMailVersion, error)
GetIredMailVersion retrievs the iredMail version
func ReadInConfig ¶ added in v0.2.6
func ReadInConfig() error
func SetConfigFile ¶ added in v0.2.6
func SetConfigFile(path string)
Types ¶
type Alias ¶
type Alias struct { Address string Domain string Active bool Forwardings }
Alias struct
type Domain ¶
type Domain struct { Domain string Description string Settings string Aliases DomainAliases Catchalls Forwardings }
Domain struct
type DomainAlias ¶ added in v0.2.2
DomainAlias struct
type DomainAliases ¶ added in v0.2.2
type DomainAliases []DomainAlias
DomainAliases ...
func (DomainAliases) FilterBy ¶ added in v0.2.2
func (a DomainAliases) FilterBy(filter string) DomainAliases
type Forwarding ¶
type Forwarding struct { Address string Domain string Forwarding string DestDomain string Active bool IsList bool IsAlias bool IsForwarding bool IsCopyKeptInMailbox bool }
Forwarding struct
type Forwardings ¶
type Forwardings []Forwarding
Forwardings ...
func (Forwardings) FilterBy ¶
func (forwardings Forwardings) FilterBy(filter string) Forwardings
FilterBy is method that filters Forwardings by a given string
type Mailbox ¶ added in v0.2.2
type Mailbox struct { Email string Name string Domain string PasswordHash string Quota int MailDir string MailboxAliases Forwardings Forwardings Forwardings }
Mailbox struct
type Server ¶
type Server struct { DB *sql.DB Data struct { Forwardings } }
func (*Server) AliasDelete ¶ added in v0.2.2
AliasDelete deletes an alias an its forwardings
func (*Server) AliasForwardingAdd ¶ added in v0.2.2
AliasForwardingAdd adds a new alias fowarding
func (*Server) AliasForwardingDelete ¶ added in v0.2.2
AliasForwardingDelete deletes an alias forwarding
func (*Server) DomainAliasAdd ¶ added in v0.2.2
DomainAliasAdd adds a new domain alias
func (*Server) DomainAliasDelete ¶ added in v0.2.2
DomainAliasDelete deletes a domain alias
func (*Server) DomainAliases ¶ added in v0.2.2
func (s *Server) DomainAliases() (DomainAliases, error)
DomainAliases returns all domainaliases
func (*Server) DomainCatchallAdd ¶ added in v0.2.2
DomainCatchallAdd adds a new catchall mailbox
func (*Server) DomainCatchallDelete ¶ added in v0.2.2
DomainCatchallDelete deletes a domain alias
func (*Server) DomainDelete ¶ added in v0.2.2
DomainDelete deletes a domain
func (*Server) ForwardingAdd ¶ added in v0.2.2
ForwardingAdd adds a new Forwarding
func (*Server) ForwardingDelete ¶ added in v0.2.2
ForwardingDelete deletes a forwarding
func (*Server) Forwardings ¶ added in v0.2.2
func (s *Server) Forwardings() (Forwardings, error)
Forwardings returns all forwardings (actual forwardings, without mailbox copy)
func (*Server) MailboxAdd ¶ added in v0.2.2
MailboxAdd adds a new mailbox
func (*Server) MailboxAliasAdd ¶ added in v0.2.2
MailboxAliasAdd adds a new mailbox alias
func (*Server) MailboxAliasDelete ¶ added in v0.2.2
MailboxAliasDelete deletes a mailbox alias
func (*Server) MailboxAliasDeleteAll ¶ added in v0.2.2
MailboxAliasDeleteAll delets all mailbox aliases of a mailbox
func (*Server) MailboxDelete ¶ added in v0.2.2
MailboxDelete delets a mailbox
func (*Server) MailboxSetKeepCopy ¶ added in v0.2.2
MailboxSetKeepCopy sets the keep-copy behavior if forwardings exist
func (*Server) MailboxSetPassword ¶ added in v0.2.4
MailboxSetPassword set the password of a mailbox
func (*Server) MailboxSetQuota ¶ added in v0.2.2
MailboxSetQuota sets the mailbox quota