This class handle emails (pop and/or aliases and even wrapper for internal classes) of hosted users. More...

Public Member Functions
	m_mail ()
	Constructeur. More...

	hook_menu ()
	Hook called by menu class to add the email menu to the left pane. More...

	get_total_size_for_domain ($domain)

	catchall_getinfos ($domain_id)

	catchall_del ($domain_id)

	catchall_set ($domain_id, $target)

	hook_quota_get ()
	get_quota (hook for quota class), returns the number of used service for a quota-bound service More...

	alternc_password_policy ()
	Password policy kind used in this class (hook for admin class) More...

	enum_domains ($uid=-1)
	Returns the list of mail-hosting domains for a user. More...

	available ($mail)
	available: tells if an email address can be installed in the server check the domain part (is it mine too), the syntax, and the availability. More...

	enum_domain_mails ($dom_id=null, $search="", $offset=0, $count=30, $show_systemmails=false)
	function used to list every mail address hosted on a domain. More...

	hook_mail_get_details ($detail)

	create ($dom_id, $mail, $type="", $dontcheck=false)
	Function used to insert a new mail into the db should be used by the web interface, not by third-party programs. More...

	get_details ($mail_id)
	function used to get every information we can on a mail More...

	is_it_my_mail ($mail_id)
	Check if an email is mine ... More...

	hook_dom_del_mx_domain ($dom_id)
	Hook called when the DOMAIN class will delete a domain. More...

	get_account_by_mail_id ($mail_id)
	return the alternc account's ID of the mail_id More...

	delete ($mail_id)
	Function used to delete a mail from the db should be used by the web interface, not by third-party programs. More...

	undelete ($mail_id)
	Function used to undelete a pending deletion mail from the db should be used by the web interface, not by third-party programs. More...

	set_passwd ($mail_id, $pass, $canbeempty=false)
	set the password of an email address. More...

	enable ($mail_id)
	Enables an email address. More...

	disable ($mail_id)
	Disables an email address. More...

	set_details ($mail_id, $islocal, $quotamb, $recipients, $delivery="dovecot", $dontcheck=false)
	Function used to update an email settings should be used by the web interface, not by third-party programs. More...

	add_wrapper ($dom_id, $m, $delivery)
	A wrapper used by mailman class to create it's needed addresses @ param : $dom_id , the domain id associated to a given address @ param : $m , the left part of the mail address being created @ param : $delivery , the delivery used to deliver the mail. More...

	create_alias ($dom_id, $m, $alias, $type="", $dontcheck=false)
	A function used to create an alias for a specific address @ param : $dom_id , the domain sql identifier @ param : $m , the alias we want to create @ param : $alias , the already existing aliased address @ param : $type, the type of the alias created. More...

	del_wrapper ($mail_id)
	A wrapper used by mailman class to create it's needed addresses @ param : $mail_id , the mysql id of the mail address we want to delete of the email for the current acccount. More...

	alternc_export_conf ()
	Export the mail information of an account. More...

	enum_slave_account ()
	Return the list of allowed slave accounts (secondary-mx) More...

	check_slave_account ($login, $pass)
	Check for a slave account (secondary mx) More...

	echo_domain_list ($format=null)
	Out (echo) the complete hosted domain list : More...

	add_slave_account ($login, $pass)
	Add a slave account that will be allowed to access the mxdomain list. More...

	del_slave_account ($login)
	Remove a slave account. More...

	hook_dom_add_slave_domain ($domain_id, $target_domain)
	hook function called by AlternC when a domain is created for the current user account using the SLAVE DOMAIN feature This function create a CATCHALL to the master domain More...

	hook_dom_add_mx_domain ($domain_id)
	hook function called by AlternC when a domain is created for the current user account This function create a postmaster mail which is an alias to LOGIN @ FQDN wich is a dynamic alias to the alternc's account mail More...

	hook_variable_set ($name, $old, $new)
	hook function called by variables when a variable is changed @access private More...

	set_dns_autoconf ($domain, $uid=-1)
	Add dns entries for autodiscover / autoconf on the domain. More...

	del_dns_autoconf ($domain)
	delete the autoconf / autodiscover vhosts when removing a domain as MX More...

	set_dns_spf ($domain, $spf, $previous=-1, $uid=-1, $login=-1)
	Set or UPDATE the DNS record for the domain $dom(str) to be $spf account's login is current and if not it's $login. More...

	del_dns_spf ($domain)
	delete the SPF entries in the sub_domaine table for a domain called by del_domain or del_mx_domain by hooks : More...

	set_dns_dmarc ($domain, $dmarc, $previous=-1, $uid=-1, $login=-1)
	Set or UPDATE the DNS record for the domain $dom(str) to be $dmarc account's login is current and if not it's $login. More...

	del_dns_dmarc ($domain)
	delete the DMARC entries in the sub_domaine table for a domain called by del_domain or del_mx_domain by hooks : More...

	hook_updatedomains_dns_pre ()
	Hook launched before doing anything dns-related. More...

	hook_updatedomains_dns_post ()
	Hook launched after doing anything dns-related. More...

	dkim_add ($domain, $uid)
	Add a domain into OpenDKIM configuration. More...

	dkim_del ($domain)
	Delete a domain from OpenDKIM configuration. More...

	dkim_get_entry ($domain)
	return the content of the TXT information to be added into the DB for DKIM subdomains More...

Public Attributes
	$domains
	domain list for this account @access private More...

	$specialchars = array('"', "'", '\\', '/')
	If an email has those chars, 'not nice in shell env' ;) we don't store the email in $mail/u/{user}_domain, but in $mail/_/{address_id}_domain @access private. More...

	$forbiddenchars = array('"', "'", '\\', '/', '?', '!', '*', '$', '\|', '#', '+')
	If an email has those chars, we will ONLY allow RECIPIENTS, NOT POP/IMAP for DOVECOT ! Since Dovecot doesn't allow those characters @access private. More...

	$total
	Number of results for a pager display @access public. More...

	$srv_postfix

	$srv_dovecot

	$cache_domain_mail_size = array()

	$enum_domains = array()

	$shouldreloaddkim
	Manage DKIM when adding / removing a domain MX management. More...

Private Attributes
	$isitmy_cache = array()

Detailed Description

This class handle emails (pop and/or aliases and even wrapper for internal classes) of hosted users.

This class is directly using the following alternc MySQL tables: address = any used email address will be defined here, mailbox = pop/imap mailboxes, recipient = redirection from an email to another and indirectly the domain class, to know domain names from their id in the DB. This class is also defining a few hooks, search ->invoke in the code.

Copyright: AlternC-Team 2000-2017 https://alternc.com/

Definition at line 32 of file m_mail.php.

Member Function Documentation

◆ add_slave_account()

m_mail::add_slave_account	(	$login,
		$pass
	)

Add a slave account that will be allowed to access the mxdomain list.

Parameters

string	$login	the login to add
string	$pass	the password to add

Returns: boolean TRUE if the account has been created, or FALSE if an error occurred.

Definition at line 898 of file m_mail.php.

                                               {
         global $db, $msg;
         $db->query("SELECT * FROM mxaccount WHERE login= ? ;", array($login));
         if ($db->next_record()) {
             $msg->raise("ERROR", "mail", _("The slave MX account was not found"));
             return false;
         }
         $db->query("INSERT INTO mxaccount (login,pass) VALUES (?, ?);", array($login, $pass));
         return true;
     }

◆ add_wrapper()

m_mail::add_wrapper	(	$dom_id,
		$m,
		$delivery
	)

A wrapper used by mailman class to create it's needed addresses @ param : $dom_id , the domain id associated to a given address @ param : $m , the left part of the mail address being created @ param : $delivery , the delivery used to deliver the mail.

Definition at line 744 of file m_mail.php.

                                                  {
         global $msg, $mail;
         $msg->log("mail", "add_wrapper", "creating $delivery $m address");
  
         $mail_id = $mail->create($dom_id, $m, $delivery);
         $this->set_details($mail_id, 1, 0, '', $delivery);
         // FIXME return error code
     }

References set_details().

◆ alternc_export_conf()

m_mail::alternc_export_conf ( )

Export the mail information of an account.

Returns: : str, string containing the complete configuration of the email for the current acccount.

Definition at line 794 of file m_mail.php.

                                    {
         global $msg;
         $msg->log("mail", "export");
         $domain = $this->enum_domains();
         $str = "<mail>\n";
         foreach ($domain as $d) {
             $str.="  <domain>\n    <name>" . xml_entities($d["domain"]) . "</name>\n";
             $s = $this->enum_domain_mails($d["id"]);
             if (count($s)) {
                 while (list($key, $val) = each($s)) {
                     $str.="    <address>\n";
                     $str.="      <name>" . xml_entities($val["address"]) . "</name>\n";
                     $str.="      <enabled>" . xml_entities($val["enabled"]) . "</enabled>\n";
                     if (is_array($val["islocal"])) {
                         $str.="      <islocal>1</islocal>\n";
                         $str.="      <quota>" . $val["quota"] . "</quota>\n";
                         $str.="      <path>" . $val["path"] . "</path>\n";
                     } else {
                         $str.="      <islocal>0</islocal>\n";
                     }
                     if (!empty($val["recipients"])) {
                         $r = explode("\n", $val["recipients"]);
                         foreach ($r as $recip) {
                             $str.="      <recipients>" . $recip . "<recipients>\n";
                         }
                     }
                     $str.="    </address>\n";
                 }
             }
             $str.="  </domain>\n";
         }
         $str.="</mail>\n";
         return $str;
     }

References enum_domain_mails(), and enum_domains().

◆ alternc_password_policy()

m_mail::alternc_password_policy ( )

Password policy kind used in this class (hook for admin class)

Returns: array an array of policykey => "policy name (for humans)"

Definition at line 209 of file m_mail.php.

                                        {
         return array("pop" => _("Email account password"));
     }

◆ available()

m_mail::available ( $mail )

available: tells if an email address can be installed in the server check the domain part (is it mine too), the syntax, and the availability.

Parameters

$mail string email to check

Returns: boolean true if the email can be installed on the server

Definition at line 254 of file m_mail.php.

                               {
         global $db, $msg, $dom;
         $msg->log("mail", "available");
         list($login, $domain) = explode("@", $mail, 2);
         // Validate the domain ownership & syntax
         if (!($dom_id = $dom->get_domain_byname($domain))) {
             return false;
         }
         // Validate the email syntax:
         if (!filter_var($mail, FILTER_VALIDATE_EMAIL)) {
             $msg->raise("ERROR", "mail", _("The email you entered is syntaxically incorrect"));
             return false;
         }
         // Check the availability
         $db->query("SELECT a.id FROM address a WHERE a.domain_id= ? AND a.address= ?;", array($dom_id, $login));
         if ($db->next_record()) {
             return false;
         } else {
             return true;
         }
     }

◆ catchall_del()

m_mail::catchall_del ( $domain_id )

Parameters

string $domain_id

Definition at line 152 of file m_mail.php.

                                       {
         $catch = $this->catchall_getinfos($domain_id);
         if (empty($catch['mail_id'])) {
             return false;
         }
         return $this->delete($catch['mail_id']);
     }

References catchall_getinfos().

Referenced by catchall_set().

◆ catchall_getinfos()

m_mail::catchall_getinfos ( $domain_id )

Parameters

string $domain_id

Definition at line 121 of file m_mail.php.

                                            {
         global $dom, $db;
         $rr = array(
             'mail_id' => '',
             'domain' => $dom->get_domain_byid($domain_id),
             'target' => '',
             'type' => '',
         );
  
         $db->query("select r.recipients as dst, a.id mail_id from address a, recipient r where a.domain_id = ? and r.address_id = a.id and a.address='';", array($domain_id));
         if ($db->next_record()) {
             $rr['target'] = $db->f('dst');
             $rr['mail_id'] = $db->f('mail_id');
         }
  
         // Does it redirect to a specific mail or to a domain
         if (empty($rr['target'])) {
             $rr['type'] = 'none';
         } elseif (substr($rr['target'], 0, 1) == '@') {
             $rr['type'] = 'domain';
         } else {
             $rr['type'] = 'mail';
         }
  
         return $rr;
     }

Referenced by catchall_del().

◆ catchall_set()

m_mail::catchall_set	(	$domain_id,
		$target
	)

Parameters

string	$domain_id
string	$target

Definition at line 165 of file m_mail.php.

                                                {
         global $msg;
         $target = rtrim($target);
         if (strlen($target) > 0 && substr_count($target, '@') == 0) { // Pas de @
             $target = '@' . $target;
         }
  
         if (substr($target, 0, 1) == '@') { // the first character is @
             // FIXME validate domain
         } else { // it MUST be an email
             if (!filter_var($target, FILTER_VALIDATE_EMAIL)) {
                 $msg->raise("ERROR", "mail", _("The email you entered is syntaxically incorrect"));
                 return false;
             }
         }
         $this->catchall_del($domain_id);
         return $this->create_alias($domain_id, '', $target, "catchall", true);
     }

References catchall_del(), and create_alias().

Referenced by hook_dom_add_slave_domain().

◆ check_slave_account()

m_mail::check_slave_account	(	$login,
		$pass
	)

Check for a slave account (secondary mx)

Parameters

string	$login	the login to check
string	$pass	the password to check

Returns: boolean TRUE if the password is correct, or FALSE if an error occurred.

Definition at line 854 of file m_mail.php.

                                                 {
         global $db;
         $db->query("SELECT * FROM mxaccount WHERE login= ? AND pass= ?;", array($login, $pass));
         if ($db->next_record()) {
             return true;
         }
         return false;
     }

◆ create()

m_mail::create	(	$dom_id,
		$mail,
		$type = `""`,
		$dontcheck = `false`
	)

Function used to insert a new mail into the db should be used by the web interface, not by third-party programs.

This function calls the hook "hooks_mail_cancreate" which must return FALSE if the user can't create this email, and raise and error accordingly

Parameters

$dom_id	integer A domain_id (owned by the user) (will be the part at the right of the @ in the email)
$mail	string the left part of the email to create (something@dom_id)

Returns: an hashtable containing the database id of the newly created mail, or false if an error occured ($msg is filled accordingly)

Definition at line 350 of file m_mail.php.

                                                                     {
         global $msg, $db, $quota, $dom, $hooks;
         $msg->log("mail", "create", $mail);
  
         // Validate the domain id
         if (!($domain = $dom->get_domain_byid($dom_id))) {
             return false;
         }
  
         // Validate the email syntax:
         $m = $mail . "@" . $domain;
         if (!filter_var($m, FILTER_VALIDATE_EMAIL) && !$dontcheck) {
             $msg->raise("ERROR", "mail", _("The email you entered is syntaxically incorrect"));
             return false;
         }
  
         // Call other classes to check we can create it:
         $cancreate = $hooks->invoke("hook_mail_cancreate", array($dom_id, $mail));
         if (in_array(false, $cancreate, true)) {
             return false;
         }
  
         // Check the quota:
         if (($type=="")&&!$quota->cancreate("mail")) {
             $msg->raise("ALERT", "mail", _("You cannot create email addresses: your quota is over"));
             return false;
         }
         // Already exists?
         $db->query("SELECT * FROM address WHERE domain_id= ? AND address= ? ;", array($dom_id, $mail));
         if ($db->next_record()) {
             if ($db->f("type") == "mailman")
                 $msg->raise("ERROR", "mail", _("This email address already exists in mailman"));
             else
                 $msg->raise("ERROR", "mail", _("This email address already exists"));
  
             return false;
         }
         // Create it now
         $db->query("INSERT INTO address (domain_id, address,type) VALUES (?, ?, ?);", array($dom_id, $mail, $type));
         if (!($id = $db->lastid())) {
             $msg->raise("ERROR", "mail", _("An unexpected error occured when creating the email"));
             return false;
         }
         return $id;
     }

◆ create_alias()

m_mail::create_alias	(	$dom_id,
		$m,
		$alias,
		$type = `""`,
		$dontcheck = `false`
	)

A function used to create an alias for a specific address @ param : $dom_id , the domain sql identifier @ param : $m , the alias we want to create @ param : $alias , the already existing aliased address @ param : $type, the type of the alias created.

Parameters

string	$m
string	$alias
string	$dom_id

Definition at line 764 of file m_mail.php.

                                                                                {
         global $msg, $mail;
         $msg->log("mail", "create_alias", "creating $m alias for $alias type $type");
  
         $mail_id = $mail->create($dom_id, $m, $type, $dontcheck);
         if (!$mail_id) {
             return false;
         }
         $this->set_details($mail_id, 0, 0, $alias, "dovecot", $dontcheck);
         return true;
     }

References set_details().

Referenced by catchall_set(), and hook_dom_add_mx_domain().

◆ del_dns_autoconf()

m_mail::del_dns_autoconf ( $domain )

delete the autoconf / autodiscover vhosts when removing a domain as MX

Definition at line 1037 of file m_mail.php.

                                        {
         global $db, $L_FQDN, $cuid;
         $db->query("UPDATE sub_domaines SET web_action='DELETE' WHERE domaine= ? AND type='autodiscover' AND sub='autoconfig';", array($domain));
         $db->query("UPDATE sub_domaines SET web_action='DELETE' WHERE domaine= ? AND type='autodiscover' AND sub='autodiscover';", array($domain));        
     }

Referenced by hook_dom_del_mx_domain().

◆ del_dns_dmarc()

m_mail::del_dns_dmarc ( $domain )

delete the DMARC entries in the sub_domaine table for a domain called by del_domain or del_mx_domain by hooks :

Definition at line 1125 of file m_mail.php.

                                     {
         global $db;
         $db->query("UPDATE sub_domaines SET web_action='DELETE' WHERE domaine= ? AND type='txt' AND sub='_dmarc' AND valeur LIKE lower('v=DMARC1;%');", array($domain));
     }

Referenced by hook_dom_del_mx_domain().

◆ del_dns_spf()

m_mail::del_dns_spf ( $domain )

delete the SPF entries in the sub_domaine table for a domain called by del_domain or del_mx_domain by hooks :

Definition at line 1079 of file m_mail.php.

                                   {
         global $db;
         $db->query("UPDATE sub_domaines SET web_action='DELETE' WHERE domaine= ? AND type='txt' AND sub='' AND valeur LIKE 'v=spf1 %';", array($domain));
     }

Referenced by hook_dom_del_mx_domain().

◆ del_slave_account()

m_mail::del_slave_account ( $login )

Remove a slave account.

Parameters

string $login the login to delete

Definition at line 914 of file m_mail.php.

                                        {
         global $db;
         $db->query("DELETE FROM mxaccount WHERE login= ? ;", array($login));
         return true;
     }

◆ del_wrapper()

m_mail::del_wrapper ( $mail_id )

A wrapper used by mailman class to create it's needed addresses @ param : $mail_id , the mysql id of the mail address we want to delete of the email for the current acccount.

Definition at line 782 of file m_mail.php.

                                    {
         global $msg;
         $msg->log("mail", "del_wrapper");
         $this->delete($mail_id);
     }

◆ delete()

m_mail::delete ( $mail_id )

Function used to delete a mail from the db should be used by the web interface, not by third-party programs.

Parameters

$mail_id integer the number of the email to delete

Returns: boolean if the email has been properly deleted or false if an error occured ($msg is filled accordingly)

Definition at line 506 of file m_mail.php.

                               {
         global $msg, $db, $hooks;
         $msg->log("mail", "delete");
  
         $mail_id = intval($mail_id);
  
         if (!$mail_id) {
             $msg->raise("ERROR", "mail", _("The email you entered is syntaxically incorrect"));
             return false;
         }
         // Validate that this email is owned by me...
         if (!($mail = $this->is_it_my_mail($mail_id))) {
             return false;
         }
  
         $mailinfos = $this->get_details($mail_id);
         $hooks->invoke('hook_mail_delete', array($mail_id, $mailinfos['address'] . '@' . $mailinfos['domain']));
  
         // Search for that address:
         $db->query("SELECT a.id, a.type, a.mail_action, m.mail_action AS mailbox_action, NOT ISNULL(m.id) AS islocal FROM address a LEFT JOIN mailbox m ON m.address_id=a.id WHERE a.id= ? ;", array($mail_id));
         if (!$db->next_record()) {
             $msg->raise("ERROR", "mail", _("The email %s does not exist, it can't be deleted"), $mail);
             return false;
         }
         if ($db->f("mail_action") != "OK" || ($db->f("islocal") && $db->f("mailbox_action") != "OK")) { // will be deleted soon ...
             $msg->raise("ERROR", "mail", _("The email %s is already marked for deletion, it can't be deleted"), $mail);
             return false;
         }
         $mail_id = $db->f("id");
  
         if ($db->f("islocal")) {
             // If it's a pop/imap mailbox, mark it for deletion
             $db->query("UPDATE address SET mail_action='DELETE', enabled=0 WHERE id= ?;", array($mail_id));
             $db->query("UPDATE mailbox SET mail_action='DELETE' WHERE address_id= ?;", array($mail_id));
         } else {
             // If it's only aliases, delete it NOW.
             $db->query("DELETE FROM address WHERE id= ? ;", array($mail_id));
             $db->query("DELETE FROM mailbox WHERE address_id= ? ;", array($mail_id));
             $db->query("DELETE FROM recipient WHERE address_id= ? ;", array($mail_id));
         }
         return true;
     }

References get_details(), and is_it_my_mail().

◆ disable()

m_mail::disable ( $mail_id )

Disables an email address.

Parameters

$mail_id integer Email ID

Returns: boolean true if the email has been enabled.

Definition at line 651 of file m_mail.php.

                                {
         global $db, $msg;
         $msg->log("mail", "disable");
         if (!($email = $this->is_it_my_mail($mail_id))) {
             return false;
         }
         if (!$db->query("UPDATE address SET `enabled`=0 where id= ? ;", array($mail_id))) {
             return false;
         }
         return true;
     }

References is_it_my_mail().

◆ dkim_add()

m_mail::dkim_add	(	$domain,
		$uid
	)

Add a domain into OpenDKIM configuration.

Definition at line 1178 of file m_mail.php.

                                     {
         global $db;
         $target_dir = "/etc/opendkim/keys/$domain";
         // Create a dkim key when it's not already there : 
         if (!file_exists($target_dir.'/alternc.txt')) {
             $this->shouldreloaddkim=true;
             if (! is_dir($target_dir)) mkdir($target_dir); // create dir
             $old_dir=getcwd();
             chdir($target_dir);
             // Generate the key, 2048 bits (better than 1024)
             // 2048 bits is also the default in recent Debian builds of opendkim
             // @see man opendkim-genkey
             exec('opendkim-genkey -b 2048 -r -d '.escapeshellarg($domain).' -s "alternc" ');
             chdir($old_dir);
             // opendkim must be owner of the key
             chown("$target_dir/alternc.private", 'opendkim');
             chgrp("$target_dir/alternc.private", 'opendkim');
             
             add_line_to_file("/etc/opendkim/KeyTable","alternc._domainkey.".$domain." ".$domain.":alternc:/etc/opendkim/keys/".$domain."/alternc.private");
             add_line_to_file("/etc/opendkim/SigningTable",$domain." alternc._domainkey.".$domain);
         }
  
         // Search for the subdomain entry, if it's not already there, create it:
         $db->query("SELECT id FROM sub_domaines WHERE domaine=? AND sub='alternc._domainkey';",array($domain));
         if (!$db->next_record()) {
             // Add subdomaine entry
             $dkim_key=$this->dkim_get_entry($domain);
             $db->query("INSERT INTO sub_domaines SET domaine=?, compte=?, sub='alternc._domainkey', type='dkim', valeur=?;",array($domain,$uid,$dkim_key));
             // no need to do DNS_ACTION="UPDATE" => we are in the middle of a HOOK, so dns WILL BE reloaded for this domain
         }
     }

References dkim_get_entry().

Referenced by hook_updatedomains_dns_pre().

◆ dkim_del()

m_mail::dkim_del ( $domain )

Delete a domain from OpenDKIM configuration.

Definition at line 1215 of file m_mail.php.

                                {
         global $db;
         $target_dir = "/etc/opendkim/keys/$domain";
         if (file_exists($target_dir)) {
             $this->shouldreloaddkim=true;
             @unlink("$target_dir/alternc.private");
             @unlink("$target_dir/alternc.txt");
             @rmdir($target_dir);
             del_line_from_file("/etc/opendkim/KeyTable","alternc._domainkey.".$domain." ".$domain.":alternc:/etc/opendkim/keys/".$domain."/alternc.private");
             del_line_from_file("/etc/opendkim/SigningTable",$domain." alternc._domainkey.".$domain);
         }
         $db->query("DELETE FROM sub_domaines WHERE domaine=? AND sub='alternc._domainkey';",array($domain));
         // No need to do DNS_ACTION="UPDATE" => we are in the middle of a HOOK
     }

Referenced by hook_dom_del_mx_domain(), and hook_updatedomains_dns_pre().

◆ dkim_get_entry()

m_mail::dkim_get_entry ( $domain )

return the content of the TXT information to be added into the DB for DKIM subdomains

Parameters

$domain string the name of the domain name

Returns: string the TXT entry (without quotes) or false if an error occurred

Definition at line 1238 of file m_mail.php.

                                      {
         global $msg;
         $key=file_get_contents("/etc/opendkim/keys/".$domain."/alternc.txt");
         // easy: monoline key
         if (preg_match('#alternc._domainkey IN TXT "(.*)"#',$key,$mat)) {
             return $mat[1];
         } else {
             // Need to parse a multiligne key:
             $inkey=false; $result="";
             $lines=explode("\n",$key);
             foreach($lines as $line) {
                 if (preg_match('#alternc._domainkey\s+IN\s+TXT\s+\‍( "(.*)"#',$line,$mat)) {
                     $result.=$mat[1]; $inkey=true; continue;
                 }
                 if ($inkey && preg_match('#^\s*"(.*)"\s*\‍)#',$line,$mat)) {
                     $result.=$mat[1]; $inkey=false; break;
                 }
                 if ($inkey && preg_match('#^\s*"(.*)"\s*$#',$line,$mat)) {
                     $result.=$mat[1]; $inkey=true; continue;
                 }
             }
             if ($result) 
                 return $result;
         }
         $msg->debug("mail","dkim_get_entry($domain) failed");
         return false;
     }

Referenced by dkim_add().

◆ echo_domain_list()

m_mail::echo_domain_list ( $format = null )

Out (echo) the complete hosted domain list :

Definition at line 867 of file m_mail.php.

                                               {
         global $db;
         $db->query("SELECT domaine FROM domaines WHERE gesmx=1 ORDER BY domaine");
         $lst = array();
         $tt = "";
         while ($db->next_record()) {
             $lst[] = $db->f("domaine");
             $tt.=$db->f("domaine");
         }
  
         // Generate an integrity check 
         $obj = array('integrity' => md5($tt), 'items' => $lst);
  
         switch ($format) {
         case "json":
             return json_encode($obj);
         default:
             foreach ($lst as $l) {
                 echo $l . "\n";
             }
             return true;
         } // switch
     }

◆ enable()

m_mail::enable ( $mail_id )

Enables an email address.

Parameters

$mail_id integer Email ID

Returns: boolean true if the email has been enabled.

Definition at line 633 of file m_mail.php.

                               {
         global $db, $msg;
         $msg->log("mail", "enable");
         if (!($email = $this->is_it_my_mail($mail_id))) {
             return false;
         }
         if (!$db->query("UPDATE address SET `enabled`=1 where id= ? ;", array($mail_id))) {
             return false;
         }
         return true;
     }

References is_it_my_mail().

◆ enum_domain_mails()

m_mail::enum_domain_mails	(	$dom_id = `null`,
		$search = `""`,
		$offset = `0`,
		$count = `30`,
		$show_systemmails = `false`
	)

function used to list every mail address hosted on a domain.

Parameters

$dom_id	integer the domain id.
$search	string search that string in recipients or address.
$offset	integer skip THAT much emails in the result.
$count	integer return no more than THAT much emails. -1 for ALL. Offset is ignored then.

Returns: an array of each mail hosted under the domain.

Definition at line 285 of file m_mail.php.

                                                                                                                   {
         global $db, $msg, $hooks;
         $msg->debug("mail", "enum_domains_mail");
  
         $query_args = array($dom_id);
         $search     = trim($search);
         $where      = " a.domain_id = ? ";
  
         if ($search) {
             $where .= " AND (a.address LIKE ? OR r.recipients LIKE ? )";
             array_push($query_args, "%" . $search . "%", "%" . $search . "%");
         }
         if (!$show_systemmails) {
             $where .= " AND type='' ";
         }
         $db->query("SELECT count(a.id) AS total FROM address a LEFT JOIN recipient r ON r.address_id=a.id WHERE " .  $where . ";", $query_args);
         $db->next_record();
         $this->total = $db->f("total");
         if ($count != -1) {
             $offset = intval($offset);
             $count = intval($count);
             $limit = " LIMIT $offset, $count "; 
         } else {
             $limit = "";
         }
         $db->query("SELECT a.id, a.address, a.password, a.`enabled`, a.mail_action, d.domaine AS domain, m.quota, m.quota*1024*1024 AS quotabytes, q.quota_dovecot as used, NOT ISNULL(m.id) AS islocal, a.type, r.recipients, m.lastlogin, a.domain_id
          FROM ((domaines d, address a LEFT JOIN mailbox m ON m.address_id=a.id) LEFT JOIN dovecot_quota q ON CONCAT(a.address,'@',d.domaine)  = q.user) LEFT JOIN recipient r ON r.address_id=a.id
          WHERE " . $where . " AND d.id=a.domain_id ORDER BY a.address ASC " . $limit . " ;", $query_args);
         if (!$db->next_record()) {
             $msg->raise("ERROR", "mail", _("No email found for this query"));
             return array();
         }
         $res = array();
         do {
             $details = $db->Record;
             // if necessary, fill the typedata with data from hooks ...
             if ($details["type"]) {
                 $result = $hooks->invoke("hook_mail_get_details", array($details)); // Will fill typedata if necessary
                 $details["typedata"] = implode("<br />", $result);
             }
             $res[] = $details;
         } while ($db->next_record());
         return $res;
     }

References $res.

Referenced by alternc_export_conf(), and hook_dom_del_mx_domain().

◆ enum_domains()

m_mail::enum_domains ( $uid = -1 )

Returns the list of mail-hosting domains for a user.

Returns: array indexed array of hosted domains

Definition at line 218 of file m_mail.php.

                                      {
         global $db, $msg, $cuid;
         $msg->debug("mail", "enum_domains");
         if ($uid == -1) {
             $uid = $cuid;
         }
         $db->query("
 SELECT
   d.id,
   d.domaine,
   IFNULL( COUNT(a.id), 0) as nb_mail
 FROM
   domaines d LEFT JOIN address a ON (d.id=a.domain_id AND a.type='')
 WHERE
   d.compte = ? 
   and d.gesmx = 1
 GROUP BY
   d.id
 ORDER BY
   d.domaine
 ;
 ", array($uid));
         $this->enum_domains = array();
         while ($db->next_record()) {
             $this->enum_domains[] = $db->Record;
         }
         return $this->enum_domains;
     }

References $enum_domains.

Referenced by alternc_export_conf(), and hook_menu().

◆ enum_slave_account()

m_mail::enum_slave_account ( )

Return the list of allowed slave accounts (secondary-mx)

Returns: array

Definition at line 834 of file m_mail.php.

                                   {
         global $db;
         $db->query("SELECT login,pass FROM mxaccount;");
         $res = array();
         while ($db->next_record()) {
             $res[] = $db->Record;
         }
         if (!count($res)) {
             return false;
         }
         return $res;
     }

References $res.

◆ get_account_by_mail_id()

m_mail::get_account_by_mail_id ( $mail_id )

return the alternc account's ID of the mail_id

Definition at line 488 of file m_mail.php.

                                               {
         global $db;
         $db->query("select compte as uid from domaines d, address a where a.domain_id = d.id and a.id = ? ;", array($mail_id));
         if (!$db->next_record()) {
             return false;
         }
         return $db->f('uid');
     }

◆ get_details()

m_mail::get_details ( $mail_id )

function used to get every information we can on a mail

Parameters

$mail_id integer

Returns: array a hashtable with all the informations for that email

Definition at line 402 of file m_mail.php.

                                    {
         global $db, $msg, $hooks;
         $msg->debug("mail", "get_details");
  
         $mail_id = intval($mail_id);
         // Validate that this email is owned by me...
         if (!($mail = $this->is_it_my_mail($mail_id))) {
             return false;
         }
  
         // We fetch all the informations for that email: these will fill the hastable : 
         $db->query("SELECT a.id, a.address, a.password, a.enabled, d.domaine AS domain, m.path, m.quota, m.quota*1024*1024 AS quotabytes, q.quota_dovecot AS used, NOT ISNULL(m.id) AS islocal, a.type, r.recipients, m.lastlogin, a.mail_action, m.mail_action AS mailbox_action FROM ((domaines d, address a LEFT JOIN mailbox m ON m.address_id=a.id) LEFT JOIN dovecot_quota q ON CONCAT(a.address,'@',d.domaine)  = q.user) LEFT JOIN recipient r ON r.address_id=a.id WHERE a.id= ? AND d.id=a.domain_id;", array($mail_id));
         if (!$db->next_record()) {
             return false;
         }
         $details = $db->Record;
         // if necessary, fill the typedata with data from hooks ...
         if ($details["type"]) {
             $result = $hooks->invoke("hook_mail_get_details", array($mail_id)); // Will fill typedata if necessary
             $details["typedata"] = implode("<br />", $result);
         }
         return $details;
     }

References is_it_my_mail().

Referenced by delete(), and set_details().

◆ get_total_size_for_domain()

m_mail::get_total_size_for_domain ( $domain )

Definition at line 102 of file m_mail.php.

                                                 {
         global $db;
         if (empty($this->cache_domain_mail_size)) {
             $db->query("SELECT SUBSTRING_INDEX(user,'@', -1) as domain, SUM(quota_dovecot) AS sum FROM dovecot_quota group by domain ;");
             while ($db->next_record()) {
                 $dd = $db->f('domain');
                 $this->cache_domain_mail_size[$dd] = $db->f('sum');
             }
         }
         if (isset($this->cache_domain_mail_size[$domain])) {
             return $this->cache_domain_mail_size[$domain];
         }
         return 0;
     }

◆ hook_dom_add_mx_domain()

m_mail::hook_dom_add_mx_domain ( $domain_id )

hook function called by AlternC when a domain is created for the current user account This function create a postmaster mail which is an alias to LOGIN @ FQDN wich is a dynamic alias to the alternc's account mail

Parameters

string $domain_id Domain that has just been created @access private

Definition at line 947 of file m_mail.php.

                                                 {
         global $msg, $mem, $db, $L_FQDN;
         $msg->log("mail", "hook_dom_add_mx_domain", $domain_id);
  
         $db->query("SELECT value FROM variable where name='mailname_bounce';");
         if (!$db->next_record()) {
             $msg->raise("ERROR", "mail", _("Problem: can't create default bounce mail"));
             return false;
         }
         $mailname = $db->f("value");
         // set spf & dmarc for this domain
         $db->query("SELECT domaine,compte FROM domaines WHERE id= ?;", array($domain_id));
         if ($db->next_record()) {
        $domaine=$db->Record["domaine"];
        $compte=$db->Record["compte"];
             $this->set_dns_autoconf($domaine,$compte);
             if ($spf = variable_get("default_spf_value")) {
                 $this->set_dns_spf($domaine, $spf);
             }
             if ($dmarc = variable_get("default_dmarc_value")) {
                 $this->set_dns_dmarc($domaine, $dmarc);
             }
         }
         return $this->create_alias($domain_id, 'postmaster', $mem->user['login'] . '@' . $mailname);
     }

References create_alias(), set_dns_autoconf(), set_dns_dmarc(), and set_dns_spf().

◆ hook_dom_add_slave_domain()

m_mail::hook_dom_add_slave_domain	(	$domain_id,
		$target_domain
	)

hook function called by AlternC when a domain is created for the current user account using the SLAVE DOMAIN feature This function create a CATCHALL to the master domain

Parameters

string	$domain_id	Domain that has just been created
string	$target_domain	Master domain @access private

Definition at line 930 of file m_mail.php.

                                                                    {
         global $msg;
         $msg->log("mail", "hook_dom_add_slave_domain", $domain_id);
         $this->catchall_set($domain_id, '@' . $target_domain);
         return true;
     }

References catchall_set().

◆ hook_dom_del_mx_domain()

m_mail::hook_dom_del_mx_domain ( $dom_id )

Hook called when the DOMAIN class will delete a domain.

OR when the DOMAIN class tells us we don't host the emails of this domain anymore.

Parameters

$dom	the ID of the domain to delete

Returns: boolean if the email has been properly deleted or false if an error occured ($msg is filled accordingly)

Definition at line 460 of file m_mail.php.

                                              {
         global $db;
         $list = $this->enum_domain_mails($dom_id, "", 0, -1);
         if (is_array($list)) {
             foreach ($list as $one) {
                 $this->delete($one["id"]);
             }
         }
         $db->query("SELECT domaine FROM domaines WHERE id= ? ;", array($dom_id));
         if (!$db->next_record()) {
             return false;
         }
         $domain=$db->Record["domaine"];
         $db->query("UPDATE sub_domaines SET web_action='DELETE' WHERE domaine= ? AND (type='defmx' OR type='defmx2');", array($domain));
         
         $this->del_dns_dmarc($domain);
         $this->del_dns_spf($domain);
         $this->del_dns_autoconf($domain);
         $this->dkim_del($domain);
         
         $db->query("UPDATE domaines SET dns_action='UPDATE' WHERE id= ? ;", array($dom_id));
         return true;
     }

References del_dns_autoconf(), del_dns_dmarc(), del_dns_spf(), dkim_del(), and enum_domain_mails().

◆ hook_mail_get_details()

m_mail::hook_mail_get_details ( $detail )

Definition at line 330 of file m_mail.php.

                                             {
         if ($detail['type'] == 'catchall') {
             return _(sprintf("Special mail address for catch-all. <a href='mail_manage_catchall.php?domain_id=%s'>Click here to manage it.</a>", $detail['domain_id']));
         }
     }

◆ hook_menu()

m_mail::hook_menu ( )

Hook called by menu class to add the email menu to the left pane.

Definition at line 83 of file m_mail.php.

                          {
         $obj = array(
             'title' => _("Email Addresses"),
             'link' => 'toggle',
             'pos' => 30,
             'links' => array(),
         );
  
         foreach ($this->enum_domains() as $d) {
             $obj['links'][] = array(
                 'txt' => htmlentities($d["domaine"]) . '&nbsp;' . htmlentities("(" . $d["nb_mail"] . ")"),
                 'url' => "mail_list.php?domain_id=" . urlencode($d['id']),
             );
         }
  
         return $obj;
     }

References enum_domains().

◆ hook_quota_get()

m_mail::hook_quota_get ( )

get_quota (hook for quota class), returns the number of used service for a quota-bound service

Parameters

$name string the named quota we want

Returns: the number of used service for the specified quota, or false if I'm not the one for the named quota

Definition at line 192 of file m_mail.php.

                               {
         global $db, $msg, $cuid, $quota;
         $msg->debug("mail", "getquota");
         $q = Array("name" => "mail", "description" => _("Email addresses"), "used" => 0);
         $db->query("SELECT COUNT(*) AS cnt FROM address a, domaines d WHERE a.domain_id=d.id AND d.compte= ? AND a.type='';", array($cuid));
         if ($db->next_record()) {
             $q['used'] = $db->f("cnt");
             $q['sizeondisk'] =  $quota->get_size_mail_sum_user($cuid)/1024;
         }
         return $q;
     }

◆ hook_updatedomains_dns_post()

m_mail::hook_updatedomains_dns_post ( )

Hook launched after doing anything dns-related.

Definition at line 1166 of file m_mail.php.

                                            {
         if ($this->shouldreloaddkim) {
             exec("service opendkim reload");
             $this->shouldreloaddkim=false;
         }
     }

◆ hook_updatedomains_dns_pre()

m_mail::hook_updatedomains_dns_pre ( )

Hook launched before doing anything dns-related.

Definition at line 1139 of file m_mail.php.

                                           {
         global $db;
         // for each domain where we don't have the MX or the DNS, remove the DKIM setup
         $this->shouldreloaddkim=false;
         $db->query("SELECT domaine,compte,gesdns,gesmx,dns_action FROM domaines WHERE dns_action!='OK';");
         $add=array();
         $del=array();
         while ($db->next_record()) {
             if ($db->Record["gesdns"]==0 || $db->Record["gesmx"]==0 || $db->Record['dns_action'] == 'DELETE') {
                 $del[]=$db->Record;
             } else {
                 $add[]=$db->Record;
             }
         }
         foreach($add as $domain) {
             $this->dkim_add($domain["domaine"],$domain["compte"]);
         }
         foreach($del as $domain) {
             $this->dkim_del($domain["domaine"]);
         }
     }

References dkim_add(), and dkim_del().

◆ hook_variable_set()

m_mail::hook_variable_set	(	$name,
		$old,
		$new
	)

hook function called by variables when a variable is changed @access private

Definition at line 979 of file m_mail.php.

                                                   {
         global $msg, $db;
         $msg->log("mail", "hook_variable_set($name,$old,$new)");      
  
         if ($name == "default_spf_value") {
             $new = trim($new);
             $old = trim($old);
             $db->query("SELECT domaine,login,compte FROM domaines, membres WHERE gesdns=1 AND gesmx=1 and membres.uid=domaines.compte;");
             $res=array();
             while ($db->next_record()) $res[]=$db->Record;
             foreach ($res as $record) {
                 $this->set_dns_spf($record["domaine"], $new, $old, $record["compte"], $record["login"]);
             }
         }
  
         if ($name == "default_dmarc_value") {
             $new = trim($new);
             $old = trim($old);
             $db->query("SELECT domaine,login,compte FROM domaines, membres WHERE gesdns=1 AND gesmx=1 and membres.uid=domaines.compte;");
             $res=array();
             while ($db->next_record()) $res[]=$db->Record;
             foreach ($res as $record) {
                 $this->set_dns_dmarc($record["domaine"], $new, $old, $record["compte"], $record["login"]);
             }
         }
     }

References $res, set_dns_dmarc(), and set_dns_spf().

◆ is_it_my_mail()

m_mail::is_it_my_mail ( $mail_id )

Check if an email is mine ...

Parameters

$mail_id integer the number of the email to check

Returns: string the complete email address if that's mine, false if not ($msg is filled accordingly)

Definition at line 436 of file m_mail.php.

                                      {
         global $msg, $db, $cuid;
         $mail_id = intval($mail_id);
         // cache it (may be called more than one time in the same page).
         if (isset($this->isitmy_cache[$mail_id])) {
             return $this->isitmy_cache[$mail_id];
         }
         $db->query("SELECT concat(a.address,'@',d.domaine) AS email FROM address a, domaines d WHERE d.id=a.domain_id AND a.id= ? AND d.compte= ?;", array($mail_id, $cuid));
         if ($db->next_record()) {
             return $this->isitmy_cache[$mail_id] = $db->f("email");
         } else {
             $msg->raise("ERROR", "mail", _("This email is not yours, you can't change anything on it"));
             return $this->isitmy_cache[$mail_id] = false;
         }
     }

Referenced by delete(), disable(), enable(), get_details(), set_passwd(), and undelete().

◆ m_mail()

m_mail::m_mail ( )

Constructeur.

Definition at line 73 of file m_mail.php.

                       {
         global $L_FQDN;
         $this->srv_postfix = variable_get('fqdn_postfix', $L_FQDN, 'FQDN name for humans for smtp services. If you change it, launch reload-certs', array('desc' => 'Name', 'type' => 'string'));
         $this->srv_dovecot = variable_get('fqdn_dovecot', $L_FQDN, 'FQDN name for humans for pop/imap services. If you change it, launch reload-certs', array('desc' => 'Name', 'type' => 'string'));
     }

◆ set_details()

m_mail::set_details	(	$mail_id,
		$islocal,
		$quotamb,
		$recipients,
		$delivery = `"dovecot"`,
		$dontcheck = `false`
	)

Function used to update an email settings should be used by the web interface, not by third-party programs.

Parameters

	$mail_id	integer the number of the email to delete
integer	$islocal	boolean is it a POP/IMAP mailbox ?
integer	$quotamb	integer if islocal=1, quota in MB
string	$recipients	string recipients, one mail per line.

Returns: boolean if the email has been properly edited or false if an error occured ($msg is filled accordingly)

Definition at line 675 of file m_mail.php.

                                                                                                                {
         global $msg, $db;
         $msg->log("mail", "set_details");
         if (!($me = $this->get_details($mail_id))) {
             return false;
         }
         if ($me["islocal"] && !$islocal) {
             // delete pop
             $db->query("UPDATE mailbox SET mail_action='DELETE' WHERE address_id= ? ;", array($mail_id));
         }
         if (!$me["islocal"] && $islocal) {
             // create pop
             $path = "";
             if ($delivery == "dovecot") {
                 $path = ALTERNC_MAIL . "/" . substr($me["address"] . "_", 0, 1) . "/" . $me["address"] . "_" . $me["domain"];
             }
             foreach ($this->forbiddenchars as $str) {
                 if (strpos($me["address"], $str) !== false) {
                     $msg->raise("ERROR", "mail", _("There is forbidden characters in your email address. You can't make it a POP/IMAP account, you can only use it as redirection to other emails"));
                     return false;
                 }
             }
             foreach ($this->specialchars as $str) {
                 if (strpos($me["address"], $str) !== false) {
                     $path = ALTERNC_MAIL . "/_/" . $me["id"] . "_" . $me["domain"];
                     break;
                 }
             }
             $db->query("INSERT INTO mailbox SET address_id= ? , delivery= ?, path= ? ;", array($mail_id, $delivery, $path));
         }
         if ($me["islocal"] && $islocal && $me["mailbox_action"] == "DELETE") {
             $db->query("UPDATE mailbox SET mail_action='OK' WHERE mail_action='DELETE' AND address_id= ? ;", array($mail_id));
         }
  
         if ($islocal) {
             if ($quotamb != 0 && $quotamb < (intval($me["used"] / 1024 / 1024) + 1)) {
                 $quotamb = intval($me["used"] / 1024 / 1024) + 1;
                 $msg->raise("ALERT", "mail", _("You set a quota smaller than the current mailbox size. Since it's not allowed, we set the quota to the current mailbox size"));
             }
             $db->query("UPDATE mailbox SET quota= ? WHERE address_id= ? ;", array($quotamb, $mail_id));
         }
  
         $recipients = preg_replace('/[\r\t\s]/', "\n", $recipients); // Handle space AND new line
         $r = explode("\n", $recipients);
         $red = "";
         foreach ($r as $m) {
             $m = trim($m);
             if ($m && ( filter_var($m, FILTER_VALIDATE_EMAIL) || $dontcheck)  // Recipient Email is valid
             && $m != ($me["address"] . "@" . $me["domain"])) {  // And not myself (no loop allowed easily ;) )
                 $red.=$m . "\n";
             }
         }
         $db->query("DELETE FROM recipient WHERE address_id= ? ;", array($mail_id));
         if (isset($red) && $red) {
             $db->query("INSERT INTO recipient SET address_id= ?, recipients= ? ;", array($mail_id, $red));
         }
         if (!$islocal && !$red) {
             $msg->raise("ALERT", "mail", _("Warning: you created an email which is not an alias, and not a POP/IMAP mailbox. This is certainly NOT what you want to do. To fix this, edit the email address and check 'Yes' in POP/IMAP account, or set some recipients in the redirection field."));
         }
         return true;
     }

References get_details().

Referenced by add_wrapper(), and create_alias().

◆ set_dns_autoconf()

m_mail::set_dns_autoconf	(	$domain,
		$uid = `-1`
	)

Add dns entries for autodiscover / autoconf on the domain.

Definition at line 1011 of file m_mail.php.

                                                {
         global $db, $L_FQDN, $cuid;
         $changed=false;
         if ($uid==-1) $uid=$cuid;
  
         $db->query("SELECT domaine,sub,type,valeur FROM sub_domaines WHERE domaine=? AND sub='autodiscover' AND type='autodiscover';",array($domain));
         if (!$db->next_record()) {
             $db->query("INSERT INTO sub_domaines SET domaine=?, compte=?, sub='autodiscover', type='autodiscover', valeur='';",array($domain,$uid));
             $changed=true;
         }
         $db->query("SELECT domaine,sub,type,valeur FROM sub_domaines WHERE domaine=? AND sub='autoconfig' AND type='autodiscover';",array($domain));
         if (!$db->next_record()) {
             $db->query("INSERT INTO sub_domaines SET domaine=?, compte=?, sub='autoconfig', type='autodiscover', valeur='';",array($domain,$uid));
             $changed=true;
         }
         if ($changed) {
             $db->query("UPDATE domaines SET dns_action='UPDATE' WHERE domaine= ?;", array($domain));
         }
         return $changed;
     }

Referenced by hook_dom_add_mx_domain().

◆ set_dns_dmarc()

m_mail::set_dns_dmarc	(	$domain,
		$dmarc,
		$previous = `-1`,
		$uid = `-1`,
		$login = `-1`
	)

Set or UPDATE the DNS record for the domain $dom(str) to be $dmarc account's login is current and if not it's $login.

don't change dmarc if current value is not $old @access private

Definition at line 1092 of file m_mail.php.

                                                                                     {
         global $db, $cuid, $mem, $L_FQDN, $msg;
         $msg->debug("mail","set_dns_dmarc($domain, $dmarc, $previous, $uid, $login)");
         // defaults
         if ($uid === -1) {
             $uid = intval($cuid);
         } else {
             $uid = intval($uid);
         }
         if ($login === -1) {
             $login = $mem->user["login"];
         }
         $dmarc = str_replace("%%ADMINMAIL%%", "admin@" . $L_FQDN, $dmarc);
         $dmarc = str_replace("%%USERMAIL%%", $login . "@" . $L_FQDN, $dmarc);
  
         // Search for the record in sub_domaines table
         $db->query("SELECT * FROM sub_domaines WHERE compte= ? AND domaine= ? AND sub='_dmarc' AND type='txt' AND valeur LIKE lower('v=DMARC1;%') AND web_action!='DELETE';", array($uid, $domain));
         if ($db->next_record()) {
             if ($previous !== -1 && $db->Record["valeur"] == "v=DMARC1;" . $dmarc) {
                 return; // skip, no change asked.
             }
             $db->query("UPDATE sub_domaines SET web_action='DELETE' WHERE id= ?;", array($db->Record["id"]));
         }
         $db->query("INSERT INTO sub_domaines SET compte= ?, domaine= ?, sub='_dmarc', type='txt', valeur= ?, web_action='UPDATE';", array($uid, $domain, "v=DMARC1;" . $dmarc));
         $db->query("UPDATE domaines SET dns_action='UPDATE' WHERE domaine= ?;", array($domain));
     }

Referenced by hook_dom_add_mx_domain(), and hook_variable_set().

◆ set_dns_spf()

m_mail::set_dns_spf	(	$domain,
		$spf,
		$previous = `-1`,
		$uid = `-1`,
		$login = `-1`
	)

Set or UPDATE the DNS record for the domain $dom(str) to be $spf account's login is current and if not it's $login.

don't change spf if current value is not $old @access private

Definition at line 1050 of file m_mail.php.

                                                                                 {
         global $db, $cuid, $mem, $msg;
         $msg->debug("mail","set_dns_spf($domain, $spf, $previous, $uid, $login)");
         // defaults
         if ($uid === -1) {
             $uid = intval($cuid);
         } else {
             $uid = intval($uid);
         }
         if ($login === -1) {
             $login = $mem->user["login"];
         }
         // Search for the record in sub_domaines table
         $db->query("SELECT * FROM sub_domaines WHERE compte= ? AND domaine= ? AND sub='' AND type='txt' AND valeur LIKE 'v=spf1 %' AND web_action!='DELETE';", array($uid, $domain));
         if ($db->next_record()) {
             if ($previous !== -1 && $db->Record["valeur"] == "v=spf1 " . $spf) {
                 return; // skip, no change asked.
             }
             $db->query("UPDATE sub_domaines SET web_action='DELETE' WHERE id= ? ;",array($db->Record["id"]));
         }
         $db->query("INSERT INTO sub_domaines SET compte= ?, domaine= ?, sub='', type='txt', valeur= ? , web_action='UPDATE';", array($uid, $domain, "v=spf1 " . $spf));
         $db->query("UPDATE domaines SET dns_action='UPDATE' WHERE domaine= ?;", array($domain));
     }

Referenced by hook_dom_add_mx_domain(), and hook_variable_set().

◆ set_passwd()

m_mail::set_passwd	(	$mail_id,
		$pass,
		$canbeempty = `false`
	)

set the password of an email address.

Parameters

$mail_id	integer email ID
$pass	string the new password.

Returns: boolean true if the password has been set, false else, raise an error.

Definition at line 607 of file m_mail.php.

                                                               {
         global $db, $msg, $admin;
         $msg->log("mail", "setpasswd");
  
         if (!($email = $this->is_it_my_mail($mail_id))) {
             return false;
         }
         if (!$admin->checkPolicy("pop", $email, $pass, $canbeempty)) {
             return false;
         }
         if ($canbeempty && empty($pass)) {
             return $db->query("UPDATE address SET password= ? where id = ? ;",
                               array(null, $mail_id ));
         } else if (!$db->query("UPDATE address SET password= ? where id = ? ;",
                                array(_dovecot_hash($pass), $mail_id ))) {
             return false;
         }
         return true;
     }

References is_it_my_mail().

◆ undelete()

m_mail::undelete ( $mail_id )

Function used to undelete a pending deletion mail from the db should be used by the web interface, not by third-party programs.

Parameters

$mail_id integer the email id

Returns: boolean if the email has been properly undeleted or false if an error occured ($msg is filled accordingly)

Definition at line 558 of file m_mail.php.

                                 {
         global $msg, $db;
         $msg->log("mail", "undelete");
  
         $mail_id = intval($mail_id);
  
         if (!$mail_id) {
             $msg->raise("ERROR", "mail", _("The email you entered does not exist"));
             return false;
         }
         // Validate that this email is owned by me...
         if (!($mail = $this->is_it_my_mail($mail_id))) {
             return false;
         }
  
         // Search for that address:
         $db->query("SELECT a.id, a.type, a.mail_action, m.mail_action AS mailbox_action, NOT ISNULL(m.id) AS islocal FROM address a LEFT JOIN mailbox m ON m.address_id=a.id WHERE a.id= ? ;", array($mail_id));
         if (!$db->next_record()) {
             $msg->raise("ERROR", "mail", _("The email %s does not exist, it can't be undeleted"), $mail);
             return false;
         }
         if ($db->f("type") != "") { // Technically special : mailman, sympa ... 
             $msg->raise("ERROR", "mail", _("The email %s is special, it can't be undeleted"), $mail);
             return false;
         }
         if ($db->f("mailbox_action") != "DELETE" || $db->f("mail_action") != "DELETE") { // will be deleted soon ...
             $msg->raise("ALERT", "mail", _("Sorry, deletion of email %s is already in progress, or not marked for deletion, it can't be undeleted"), $mail);
             return false;
         }
         $mail_id = $db->f("id");
  
         if ($db->f("islocal")) {
             // If it's a pop/imap mailbox, mark it for deletion
             $db->query("UPDATE address SET mail_action='OK', `enabled`=1 WHERE id= ?;", array($mail_id));
             $db->query("UPDATE mailbox SET mail_action='OK' WHERE address_id= ? ;", array($mail_id));
             return true;
         } else {
             $msg->raise("ERROR", "mail", _("-- Program Error -- The email %s can't be undeleted"), $mail);
             return false;
         }
     }

References is_it_my_mail().

Member Data Documentation

◆ $cache_domain_mail_size

m_mail::$cache_domain_mail_size = array()

Definition at line 66 of file m_mail.php.

◆ $domains

m_mail::$domains

domain list for this account @access private

Definition at line 38 of file m_mail.php.

◆ $enum_domains

m_mail::$enum_domains = array()

Definition at line 67 of file m_mail.php.

Referenced by enum_domains().

◆ $forbiddenchars

m_mail::$forbiddenchars = array('"', "'", '\\', '/', '?', '!', '*', '$', '|', '#', '+')

If an email has those chars, we will ONLY allow RECIPIENTS, NOT POP/IMAP for DOVECOT ! Since Dovecot doesn't allow those characters @access private.

Definition at line 54 of file m_mail.php.

◆ $isitmy_cache

m_mail::$isitmy_cache = array()

private

Definition at line 426 of file m_mail.php.

◆ $shouldreloaddkim

m_mail::$shouldreloaddkim

Manage DKIM when adding / removing a domain MX management.

Definition at line 1132 of file m_mail.php.

◆ $specialchars

m_mail::$specialchars = array('"', "'", '\\', '/')

If an email has those chars, 'not nice in shell env' ;) we don't store the email in $mail/u/{user}_domain, but in $mail/_/{address_id}_domain @access private.

Definition at line 46 of file m_mail.php.

◆ $srv_dovecot

m_mail::$srv_dovecot

Definition at line 65 of file m_mail.php.

◆ $srv_postfix

m_mail::$srv_postfix

Definition at line 64 of file m_mail.php.

◆ $total

m_mail::$total

Number of results for a pager display @access public.

Definition at line 61 of file m_mail.php.

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

bureau/class/m_mail.php

Public Member Functions

Public Attributes

Private Attributes

Detailed Description

Member Function Documentation

◆ add_slave_account()

◆ add_wrapper()

◆ alternc_export_conf()

◆ alternc_password_policy()

◆ available()

◆ catchall_del()

◆ catchall_getinfos()

◆ catchall_set()

◆ check_slave_account()

◆ create()

◆ create_alias()

◆ del_dns_autoconf()

◆ del_dns_dmarc()

◆ del_dns_spf()

◆ del_slave_account()

◆ del_wrapper()

◆ delete()

◆ disable()

◆ dkim_add()

◆ dkim_del()

◆ dkim_get_entry()

◆ echo_domain_list()

◆ enable()

◆ enum_domain_mails()

◆ enum_domains()

◆ enum_slave_account()

◆ get_account_by_mail_id()

◆ get_details()

◆ get_total_size_for_domain()

◆ hook_dom_add_mx_domain()

◆ hook_dom_add_slave_domain()

◆ hook_dom_del_mx_domain()

◆ hook_mail_get_details()

◆ hook_menu()

◆ hook_quota_get()

◆ hook_updatedomains_dns_post()

◆ hook_updatedomains_dns_pre()

◆ hook_variable_set()

◆ is_it_my_mail()

◆ m_mail()

◆ set_details()

◆ set_dns_autoconf()

◆ set_dns_dmarc()

◆ set_dns_spf()

◆ set_passwd()

◆ undelete()

Member Data Documentation

◆ $cache_domain_mail_size

◆ $domains

◆ $enum_domains

◆ $forbiddenchars

◆ $isitmy_cache

◆ $shouldreloaddkim

◆ $specialchars

◆ $srv_dovecot

◆ $srv_postfix

◆ $total