Alternc_Api_Object_Mail Class Reference

Domain Api of AlternC, used by alternc-api package. More...

Inheritance diagram for Alternc_Api_Object_Mail:

Public Member Functions
	__construct ($service)
	listDomains ($options)
	API Method from legacy class method mail->enum_domains() More...
	isAvailable ($options)
	API Method from legacy class method mail->available() More...
	getAll ($options)
	API Method from legacy class method $mail->enum_domain_mails ($dom_id = null, $search="", $offset=0, $count=30, $show_systemmails=false) More...
	create ($options)
	API Method from legacy class method $mail->create ($dom_id, $mail,$type="",$dontcheck=false){. More...
	get ($options)
	API Method from legacy class method $mail->get_details($mail_id) More...
	account ($options)
	API Method from legacy class method $mail->get_account_by_mail_id($mail_id) More...
	delete ($options)
	API Method from legacy class method $mail->delete($mail_id) More...
	undelete ($options)
	API Method from legacy class method $mail->undelete($mail_id) More...
	passwd ($options)
	API Method from legacy class method $mail->delete($mail_id) More...
	enable ($options)
	API Method from legacy class method $mail->enable($mail_id) More...
	disable ($options)
	API Method from legacy class method $mail->disable($mail_id) More...
	update ($options)
	API Method from legacy class method $mail-> set_details ($mail_id, $islocal, $quotamb, $recipients,$delivery="dovecot",$dontcheck=false) More...
	login ($options)
	API Method for email authentication. More...
	check_password ($password, $hash)

Public Attributes
const	ERR_INVALID_ARGUMENT = 111201
const	ERR_ALTERNC_FUNCTION = 111202
const	ERR_NOT_FOUND = 111203

Protected Member Functions
	alterncLegacyErrorManager ()
	return a proper Alternc_Api_Response from an error class and error string from AlternC legacy class More...
	offsetAndCount ($options, $max)
	ensure that offset & count are set properly from $options. More...

Protected Attributes
	$mail
	$admin
	$cuid
	$isAdmin
	$db

Detailed Description

Domain Api of AlternC, used by alternc-api package.

Definition at line 6 of file Mail.php.

Constructor & Destructor Documentation

__construct()

Alternc_Api_Object_Mail::__construct

(

$service

)

Reimplemented from Alternc_Api_Legacyobject.

Definition at line 10 of file Mail.php.

                                   {
        global $mail;
        parent::__construct($service);
        $this->mail = $mail;
    }

References $mail.

Member Function Documentation

account()

Alternc_Api_Object_Mail::account

(

$options

)

API Method from legacy class method $mail->get_account_by_mail_id($mail_id)

Parameters

$options

a hash with parameters transmitted to legacy call mandatory parameters: mail_id

Returns

Alternc_Api_Response whose content is

Definition at line 138 of file Mail.php.

                               {
        $mandatory = array("mail_id");
        $missing = "";
        foreach ($mandatory as $key) {
            if (!isset($options[$key])) {
                $missing.=$key . " ";
            }
        }
        if ($missing) {
            return new Alternc_Api_Response(array("code" => self::ERR_INVALID_ARGUMENT, "message" => "Missing or invalid argument: " . $missing));
        }
        $did = $this->mail->get_account_by_mail_id($options["mail_id"]);
        if (!$did) {
            return $this->alterncLegacyErrorManager();
        } else {
            return new Alternc_Api_Response(array("content" => $did));
        }
    }

References $key, and Alternc_Api_Legacyobject\alterncLegacyErrorManager().

alterncLegacyErrorManager()

Alternc_Api_Legacyobject::alterncLegacyErrorManager ( )

protectedinherited

return a proper Alternc_Api_Response from an error class and error string from AlternC legacy class

Definition at line 38 of file Legacyobject.php.

                                                   {
        global $err;
        return new Alternc_Api_Response(array("code" => self::ERR_ALTERNC_FUNCTION, "message" => "[" . $err->clsid . "] " . $err->error));
    }

References $err.

Referenced by account(), Alternc_Api_Object_Account\add(), Alternc_Api_Object_Domain\add(), Alternc_Api_Object_Ftp\add(), Alternc_Api_Object_Mysql\add(), Alternc_Api_Object_Ssl\aliasAdd(), Alternc_Api_Object_Ssl\aliasDel(), Alternc_Api_Object_Policy\check(), create(), Alternc_Api_Object_Account\del(), Alternc_Api_Object_Domain\del(), Alternc_Api_Object_Ftp\del(), Alternc_Api_Object_Mysql\del(), delete(), disable(), enable(), Alternc_Api_Object_Ssl\finalize(), Alternc_Api_Object_Account\find(), Alternc_Api_Object_Ftp\find(), Alternc_Api_Object_Mysql\find(), Alternc_Api_Object_Policy\find(), Alternc_Api_Object_Domain\get(), get(), Alternc_Api_Object_Subdomain\get(), getAll(), Alternc_Api_Object_Ssl\getCertificate(), Alternc_Api_Object_Ssl\importCert(), isAvailable(), Alternc_Api_Object_Ftp\isFtp(), listDomains(), Alternc_Api_Object_Account\lock(), Alternc_Api_Object_Mysql\lock(), Alternc_Api_Object_Ssl\newCsr(), passwd(), Alternc_Api_Object_Subdomain\set(), Alternc_Api_Object_Account\setAdmin(), Alternc_Api_Object_Mysql\setAdmin(), Alternc_Api_Object_Ssl\share(), undelete(), Alternc_Api_Object_Account\unlock(), Alternc_Api_Object_Mysql\unlock(), Alternc_Api_Object_Account\unsetAdmin(), Alternc_Api_Object_Mysql\unsetAdmin(), Alternc_Api_Object_Account\update(), Alternc_Api_Object_Domain\update(), Alternc_Api_Object_Ftp\update(), update(), Alternc_Api_Object_Mysql\update(), and Alternc_Api_Object_Policy\update().

check_password()

Alternc_Api_Object_Mail::check_password	(		$password,
			$hash
	)

Definition at line 337 of file Mail.php.

                                                 {
      if ($hash == '') { // no password
     return FALSE;
   }
 
      if ($hash{0} != '{') { // plaintext or crypt() password ? 
   if ($hash{0} == '$' ) {
     if (crypt($password,$hash)==$hash) 
       return TRUE;
   } else { // plaintext ? (NOT RECOMMENDED !!!)
     if ($password == $hash)
       return TRUE;
   }
   return FALSE;
      }
      
      if (substr($hash,0,7) == '{crypt}') {
   if (crypt($password, substr($hash,7)) == substr($hash,7))
     return TRUE;
   return FALSE;
      }
      elseif (substr($hash,0,5) == '{MD5}') {
   $encrypted_password = '{MD5}' . base64_encode(md5( $password,TRUE));
      }
      elseif (substr($hash,0,6) == '{SHA1}') {
   $encrypted_password = '{SHA}' . base64_encode(sha1( $password, TRUE ));
      }
      elseif (substr($hash,0,6) == '{SSHA}') {
   $salt = substr(base64_decode(substr($hash,6)),20);
   $encrypted_password = '{SSHA}' . base64_encode(sha1( $password.$salt, TRUE ). $salt);
      } else {
   echo "Unsupported password hash format";
   return FALSE;
      }
      
      if ($hash == $encrypted_password)
   return TRUE;
      
      return FALSE;
    }

References $password, and elseif.

Referenced by login().

create()

Alternc_Api_Object_Mail::create

(

$options

)

API Method from legacy class method $mail->create ($dom_id, $mail,$type="",$dontcheck=false){.

Parameters

$options

a hash with parameters transmitted to legacy call mandatory parameters: non-mandatory:

Returns

Alternc_Api_Response whose content is

Definition at line 84 of file Mail.php.

                              {
        $defaults = array("type" => "");
        $mandatory = array("dom_id", "mail");
        $missing = "";
        foreach ($mandatory as $key) {
            if (!isset($options[$key])) {
                $missing.=$key . " ";
            }
        }
        if ($missing) {
            return new Alternc_Api_Response(array("code" => self::ERR_INVALID_ARGUMENT, "message" => "Missing or invalid argument: " . $missing));
        }
        foreach ($defaults as $key => $value) {
            if (!isset($options[$key])) {
                $options[$key] = $value;
            }
        }
        $did = $this->mail->create($options["dom_id"], $options["mail"], $options["type"]);
        if (!$did) {
            return $this->alterncLegacyErrorManager();
        } else {
            return new Alternc_Api_Response(array("content" => $did));
        }
    }

References $key, $value, and Alternc_Api_Legacyobject\alterncLegacyErrorManager().

delete()

Alternc_Api_Object_Mail::delete

(

$options

)

API Method from legacy class method $mail->delete($mail_id)

Parameters

$options

a hash with parameters transmitted to legacy call mandatory parameters: mail_id

Returns

Alternc_Api_Response whose content is

Definition at line 162 of file Mail.php.

                              {
        $mandatory = array("mail_id");
        $missing = "";
        foreach ($mandatory as $key) {
            if (!isset($options[$key])) {
                $missing.=$key . " ";
            }
        }
        if ($missing) {
            return new Alternc_Api_Response(array("code" => self::ERR_INVALID_ARGUMENT, "message" => "Missing or invalid argument: " . $missing));
        }
        $did = $this->mail->delete($options["mail_id"]);
        if (!$did) {
            return $this->alterncLegacyErrorManager();
        } else {
            return new Alternc_Api_Response(array("content" => $did));
        }
    }

References $key, and Alternc_Api_Legacyobject\alterncLegacyErrorManager().

disable()

Alternc_Api_Object_Mail::disable

(

$options

)

API Method from legacy class method $mail->disable($mail_id)

Parameters

$options

a hash with parameters transmitted to legacy call mandatory parameters: mail_id

Returns

Alternc_Api_Response whose content is

Definition at line 258 of file Mail.php.

                               {
        $mandatory = array("mail_id");
        $missing = "";
        foreach ($mandatory as $key) {
            if (!isset($options[$key])) {
                $missing.=$key . " ";
            }
        }
        if ($missing) {
            return new Alternc_Api_Response(array("code" => self::ERR_INVALID_ARGUMENT, "message" => "Missing or invalid argument: " . $missing));
        }
        $did = $this->mail->disable($options["mail_id"]);
        if (!$did) {
            return $this->alterncLegacyErrorManager();
        } else {
            return new Alternc_Api_Response(array("content" => $did));
        }
    }

References $key, and Alternc_Api_Legacyobject\alterncLegacyErrorManager().

enable()

Alternc_Api_Object_Mail::enable

(

$options

)

API Method from legacy class method $mail->enable($mail_id)

Parameters

$options

a hash with parameters transmitted to legacy call mandatory parameters: mail_id

Returns

Alternc_Api_Response whose content is

Definition at line 234 of file Mail.php.

                              {
        $mandatory = array("mail_id");
        $missing = "";
        foreach ($mandatory as $key) {
            if (!isset($options[$key])) {
                $missing.=$key . " ";
            }
        }
        if ($missing) {
            return new Alternc_Api_Response(array("code" => self::ERR_INVALID_ARGUMENT, "message" => "Missing or invalid argument: " . $missing));
        }
        $did = $this->mail->enable($options["mail_id"]);
        if (!$did) {
            return $this->alterncLegacyErrorManager();
        } else {
            return new Alternc_Api_Response(array("content" => $did));
        }
    }

References $key, and Alternc_Api_Legacyobject\alterncLegacyErrorManager().

get()

Alternc_Api_Object_Mail::get

(

$options

)

API Method from legacy class method $mail->get_details($mail_id)

Parameters

$options

a hash with parameters transmitted to legacy call mandatory parameters: mail_id

Returns

Alternc_Api_Response whose content is

Definition at line 114 of file Mail.php.

                           {
        $mandatory = array("mail_id");
        $missing = "";
        foreach ($mandatory as $key) {
            if (!isset($options[$key])) {
                $missing.=$key . " ";
            }
        }
        if ($missing) {
            return new Alternc_Api_Response(array("code" => self::ERR_INVALID_ARGUMENT, "message" => "Missing or invalid argument: " . $missing));
        }
        $did = $this->mail->get_details($options["mail_id"]);
        if (!$did) {
            return $this->alterncLegacyErrorManager();
        } else {
            return new Alternc_Api_Response(array("content" => $did));
        }
    }

References $key, and Alternc_Api_Legacyobject\alterncLegacyErrorManager().

getAll()

Alternc_Api_Object_Mail::getAll

(

$options

)

API Method from legacy class method $mail->enum_domain_mails ($dom_id = null, $search="", $offset=0, $count=30, $show_systemmails=false)

Parameters

$options

a hash with parameters transmitted to legacy call mandatory parameters: non-mandatory:

Returns

Alternc_Api_Response whose content is

Definition at line 62 of file Mail.php.

                              {
        $defaults = array("dom_id" => null, "search" => "", "offset" => 0, "count" => 30, "show_systemmails" => false);
        foreach ($defaults as $key => $value) {
            if (!isset($options[$key])) {
                $options[$key] = $value;
            }
        }
        $did = $this->mail->enum_domain_mails($options["dom_id"], $options["search"], $options["offset"], $options["count"], $options["show_systemmails"]);
        if (!$did) {
            return $this->alterncLegacyErrorManager();
        } else {
            return new Alternc_Api_Response(array("content" => $did));
        }
    }

References $key, $value, and Alternc_Api_Legacyobject\alterncLegacyErrorManager().

isAvailable()

Alternc_Api_Object_Mail::isAvailable

(

$options

)

API Method from legacy class method mail->available()

Parameters

$options

a hash with parameters transmitted to legacy call mandatory parameters: mail(str)

Returns

Alternc_Api_Response telling TRUE or FALSE

Definition at line 43 of file Mail.php.

                                   {
        if (!isset($options["mail"])) {
            return new Alternc_Api_Response(array("code" => self::ERR_INVALID_ARGUMENT, "message" => "Missing or invalid argument: " . "mail"));
        }
        $did = $this->mail->available($options["mail"]);
        if (!$did) {
            return $this->alterncLegacyErrorManager();
        } else {
            return new Alternc_Api_Response(array("content" => $did));
        }
    }

References Alternc_Api_Legacyobject\alterncLegacyErrorManager().

listDomains()

Alternc_Api_Object_Mail::listDomains

(

$options

)

API Method from legacy class method mail->enum_domains()

Parameters

$options

a hash with parameters transmitted to legacy call

Returns

Alternc_Api_Response whose content is the list of hosted domains for mails on this server (no more details as of now)

Definition at line 22 of file Mail.php.

                                   {
        global $cuid;
        $sql = "";
        $uid = $cuid;
        if ($this->isAdmin && isset($options["uid"])) {
            $uid = intval($options["uid"]);
        }
 
        $did = $this->mail->enum_domains($uid);
        if (!$did) {
            return $this->alterncLegacyErrorManager();
        } else {
            return new Alternc_Api_Response(array("content" => $did));
        }
    }

References Alternc_Api_Legacyobject\$cuid, $uid, and Alternc_Api_Legacyobject\alterncLegacyErrorManager().

login()

Alternc_Api_Object_Mail::login

(

$options

)

API Method for email authentication.

Parameters

$options

a hash with email and password parameters.

Returns

Alternc_Api_Response whose content is true / false if the auth to this email was successfull.

Definition at line 315 of file Mail.php.

                             {
        global $cuid;
        $uid = $cuid;
        if ($this->isAdmin && isset($options["uid"])) {
            $uid = intval($options["uid"]);
        }
   if (!isset($options["email"]) || !isset($options["password"])) {
     return new Alternc_Api_Response(array("code" => self::ERR_INVALID_ARGUMENT, "message" => "Missing email or password argument"));
   }
   list($address,$domain)=explode("@",$options["email"],2);
   $stmt = $this->db->prepare("SELECT enabled,password FROM domaines d,address a WHERE a.domain_id=d.id AND address=? AND domaine=?;");
   $stmt->execute(array($address,$domain));
   $me = $stmt->fetch(PDO::FETCH_OBJ);
        if ($me && $me->enabled) {
     // Check password : 
     return new Alternc_Api_Response(array("content" => $this->check_password($options["password"],$me->password)  ));
        } else {
            return new Alternc_Api_Response(array("content" => false));
        }
    }

References Alternc_Api_Legacyobject\$cuid, $domain, $uid, and check_password().

offsetAndCount()

Alternc_Api_Legacyobject::offsetAndCount (   $options,   $max  )

protectedinherited

ensure that offset & count are set properly from $options.

Definition at line 45 of file Legacyobject.php.

                                                      {
        $offset = -1;
        $count = -1;
        if (isset($options["count"]))
            $count = intval($options["count"]);
        if (isset($options["offset"]))
            $offset = intval($options["offset"]);
        if ($offset != -1 || $count != -1) {
            if ($offset < 0 || $offset > $max)
                $offset = 0;
            if ($count < 0 || $count > 1000)
                $count = 1000;
        }
        return array($offset, $count);
    }

Referenced by Alternc_Api_Object_Account\find(), Alternc_Api_Object_Domain\find(), Alternc_Api_Object_Ftp\find(), and Alternc_Api_Object_Mysql\find().

passwd()

Alternc_Api_Object_Mail::passwd

(

$options

)

API Method from legacy class method $mail->delete($mail_id)

Parameters

$options

a hash with parameters transmitted to legacy call mandatory parameters: mail_id, password

Returns

Alternc_Api_Response whose content is

Definition at line 210 of file Mail.php.

                              {
        $mandatory = array("mail_id", "password");
        $missing = "";
        foreach ($mandatory as $key) {
            if (!isset($options[$key])) {
                $missing.=$key . " ";
            }
        }
        if ($missing) {
            return new Alternc_Api_Response(array("code" => self::ERR_INVALID_ARGUMENT, "message" => "Missing or invalid argument: " . $missing));
        }
        $did = $this->mail->set_passwd($options["mail_id"], $options["password"]);
        if (!$did) {
            return $this->alterncLegacyErrorManager();
        } else {
            return new Alternc_Api_Response(array("content" => $did));
        }
    }

References $key, and Alternc_Api_Legacyobject\alterncLegacyErrorManager().

undelete()

Alternc_Api_Object_Mail::undelete

(

$options

)

API Method from legacy class method $mail->undelete($mail_id)

Parameters

$options

a hash with parameters transmitted to legacy call mandatory parameters: mail_id

Returns

Alternc_Api_Response whose content is

Definition at line 186 of file Mail.php.

                                {
        $mandatory = array("mail_id");
        $missing = "";
        foreach ($mandatory as $key) {
            if (!isset($options[$key])) {
                $missing.=$key . " ";
            }
        }
        if ($missing) {
            return new Alternc_Api_Response(array("code" => self::ERR_INVALID_ARGUMENT, "message" => "Missing or invalid argument: " . $missing));
        }
        $did = $this->mail->undelete($options["mail_id"]);
        if (!$did) {
            return $this->alterncLegacyErrorManager();
        } else {
            return new Alternc_Api_Response(array("content" => $did));
        }
    }

References $key, and Alternc_Api_Legacyobject\alterncLegacyErrorManager().

update()

Alternc_Api_Object_Mail::update

(

$options

)

API Method from legacy class method $mail-> set_details ($mail_id, $islocal, $quotamb, $recipients,$delivery="dovecot",$dontcheck=false)

Parameters

$options

a hash with parameters transmitted to legacy call mandatory parameters: non-mandatory:

Returns

Alternc_Api_Response whose content is

Definition at line 284 of file Mail.php.

                              {
        $defaults = array("delivery" => "dovecot");
        $mandatory = array("mail_id", "islocal", "quotamb", "recipients");
        $missing = "";
        foreach ($mandatory as $key) {
            if (!isset($options[$key])) {
                $missing.=$key . " ";
            }
        }
        if ($missing) {
            return new Alternc_Api_Response(array("code" => self::ERR_INVALID_ARGUMENT, "message" => "Missing or invalid argument: " . $missing));
        }
        foreach ($defaults as $key => $value) {
            if (!isset($options[$key])) {
                $options[$key] = $value;
            }
        }
        $did = $this->mail->set_details($options["mail_id"], $options["islocal"], $options["quotamb"], $options["recipients"], $options["delivery"]);
        if (!$did) {
            return $this->alterncLegacyErrorManager();
        } else {
            return new Alternc_Api_Response(array("content" => $did));
        }
    }

References $key, $value, and Alternc_Api_Legacyobject\alterncLegacyErrorManager().

Member Data Documentation

$admin

Alternc_Api_Legacyobject::$admin

protectedinherited

Definition at line 11 of file Legacyobject.php.

Referenced by Alternc_Api_Legacyobject\__construct().

$cuid

Alternc_Api_Legacyobject::$cuid

protectedinherited

Definition at line 12 of file Legacyobject.php.

Referenced by Alternc_Api_Legacyobject\__construct(), Alternc_Api_Object_Domain\find(), Alternc_Api_Object_Domain\get(), Alternc_Api_Object_Subdomain\get(), listDomains(), login(), and Alternc_Api_Object_Subdomain\set().

$db

Alternc_Api_Legacyobject::$db

protectedinherited

Definition at line 14 of file Legacyobject.php.

$isAdmin

Alternc_Api_Legacyobject::$isAdmin

protectedinherited

Definition at line 13 of file Legacyobject.php.

Referenced by Alternc_Api_Legacyobject\__construct().

$mail

Alternc_Api_Object_Mail::$mail

protected

Definition at line 8 of file Mail.php.

Referenced by __construct().

ERR_ALTERNC_FUNCTION

const Alternc_Api_Legacyobject::ERR_ALTERNC_FUNCTION = 111202

inherited

Definition at line 17 of file Legacyobject.php.

ERR_INVALID_ARGUMENT

const Alternc_Api_Legacyobject::ERR_INVALID_ARGUMENT = 111201

inherited

Definition at line 16 of file Legacyobject.php.

ERR_NOT_FOUND

const Alternc_Api_Legacyobject::ERR_NOT_FOUND = 111203

inherited

Definition at line 18 of file Legacyobject.php.

---

The documentation for this class was generated from the following file:

• lib/Alternc/Api/Object/Mail.php