Class Symbiosis::Domain::Mailbox
In: email/lib/symbiosis/domain/mailbox.rb
Parent: Object
Array Utmp EventMachine::Connection ApacheLogger StandardError CrontabFormatError Enumerable IPAddr ::IPAddr Host Range Domain ConfigFile Prosody Tinydns Apache Webalizer Directory IPListDirectory TemplateDirectory Domains Alert Crontab CrontabRecord StateDB Check Runner TCPConnection Test Process BlacklistDB Template Logtail Pattern Ports Blacklist Monitor ConfigFiles Utils Firewall Symbiosis dot/f_0.png

Methods

Included Modules

Symbiosis::Utils

Attributes

domain  [R] 
local_part  [R] 
mailboxes_dir  [R] 

Public Class methods

Set up a new mailbox object.

This does not actually create it on disc.

Check to see if a local part is valid.

Public Instance methods

Creates the mailbox. Returns self.

Returns the directory for the mailbox

If the local_user is set, then this returns ".", otherwise it returns "".

Sets the encrypt_password flag. This is set to true by default.

Returns true if the mailbox already exists.

Return the GID for this mailbox

Return the local_user (if set).

Sets the local_user parameter, which is used for local mailboxes.

Try to login to a mailbox using a password.

An ArgumentError is raised if login fails.

Returns true if login succeeds.

Returns the location of the Maildir

Returns the mailbox‘s password, or nil if one has not been set, or the mailbox doesn‘t exist.

Sets the password, creating the mailbox if needed. If the encrypt_password flag is set then the password is encrypted using Symbiosis::Domain#crypt_password

Returns the name of the mailbox password file.

Retuns any quota set. If nothing has been set for this mailbox, the domain‘s quota is used.

Sets the individual mailbox quota. Uses Symbiosis::Utils#parse_quota to check the argment. Returns an interpreted quota, i.e. an integer or nil. Creates the mailbox if needed.

This checks to see if the quota file updated by Dovecot/Exim4 needs to be removed, in case of quota changes.

Return the UID for this mailbox

Returns the username required for IMAP/POP3/SMTP authentication.

[Validate]