Changeset 95 for trunk/Packages/Common/Mail.php

Timestamp:

Dec 6, 2021, 11:33:48 AM (3 years ago)

Author:

chronos

Message:

• Modified: Updated Common package.
• Added: Explicit types for better type checking.
• Fixed: Support for php 8.0.

File:

• trunk/Packages/Common/Mail.php (modified) (10 diffs)

trunk/Packages/Common/Mail.php

@@ -9 +9 @@
 class Mail
 {
-  var $Priorities;
-  var $Subject;
-  var $From;
-  var $Recipients;
-  var $Bodies;
-  var $Attachments;
-  var $AgentIdent;
-  var $Organization;
-  var $ReplyTo;
-  var $Headers;
+  public string $Subject;
+  public string $From;
+  public array $Recipients;
+  public array $Bodies;
+  public array $Attachments;
+  public string $AgentIdent;
+  public string $Organization;
+  public string $ReplyTo;
+  public array $Headers;
+  private array $Priorities;
+  private string $Boundary;
 
   function __construct()
@@ -28 +29 @@
   }
 
-  function Clear()
+  function Clear(): void
   {
     $this->Bodies = array();
@@ -41 +42 @@
   }
 
-  function AddToCombined($Address)
+  function AddToCombined(string $Address): void
   {
     $this->Recipients[] = array('Address' => $Address, 'Type' => 'SendCombined');
   }
 
-  function AddTo($Address, $Name)
+  function AddTo(string $Address, string $Name): void
   {
     $this->Recipients[] = array('Address' => $Address, 'Name' => $Name, 'Type' => 'Send');
   }
 
-  function AddCc($Address, $Name)
+  function AddCc(string $Address, string $Name): void
   {
     $this->Recipients[] = array('Address' => $Address, 'Name' => $Name, 'Type' => 'Copy');
   }
 
-  function AddBcc($Address, $Name)
+  function AddBcc(string $Address, string $Name): void
   {
     $this->Recipients[] = array('Address' => $Address, 'Name' => $Name, 'Type' => 'HiddenCopy');
   }
 
-  function AddBody($Content, $MimeType = 'text/plain', $Charset = 'utf-8')
+  function AddBody(string $Content, string $MimeType = 'text/plain', string $Charset = 'utf-8'): void
   {
     $this->Bodies[] = array('Content' => $Content, 'Type' => strtolower($MimeType),
@@ -67 +68 @@
   }
 
-  function Organization($org)
+  function Organization(string $org): void
   {
     if (trim($org != '')) $this->xheaders['Organization'] = $org;
   }
 
-  function Priority($Priority)
+  function Priority(int $Priority): bool
   {
     if (!intval($Priority)) return false;
 
-    if (!isset($this->priorities[$Priority - 1])) return false;
-
-    $this->xheaders['X-Priority'] = $this->priorities[$Priority - 1];
+    if (!isset($this->Priorities[$Priority - 1])) return false;
+
+    $this->xheaders['X-Priority'] = $this->Priorities[$Priority - 1];
     return true;
   }
 
-  function AttachFile($FileName, $FileType, $Disposition = DISPOSITION_ATTACHMENT)
+  function AttachFile($FileName, $FileType, $Disposition = DISPOSITION_ATTACHMENT): void
   {
     $this->Attachments[] = array('FileName' => $FileName, 'FileType' => $FileType,
@@ -88 +89 @@
   }
 
-  function AttachData($FileName, $FileType, $Data, $Disposition = DISPOSITION_ATTACHMENT)
+  function AttachData($FileName, $FileType, $Data, $Disposition = DISPOSITION_ATTACHMENT): void
   {
     $this->Attachments[] = array('FileName' => $FileName, 'FileType' => $FileType,
@@ -94 +95 @@
   }
 
-  function Send()
+  function Send(): bool
   {
     if (count($this->Bodies) == 0) throw new Exception(T('Mail message need at least one text body'));
@@ -144 +145 @@
     if ($this->Subject == '') throw new Exception(T('Mail message missing Subject'));
 
-
     $res = mail($To, $this->Subject, $Body, $Headers);
     return $res;
   }
 
-  function ValidEmail($Address)
-  {
-    if (ereg(".*<(.+)>", $Address, $regs)) $Address = $regs[1];
-    if (ereg("^[^@  ]+@([a-zA-Z0-9\-]+\.)+([a-zA-Z0-9\-]{2}|net|com|gov|mil|org|edu|int)\$", $Address))
+  function ValidEmail(string $Address): bool
+  {
+    if (preg_match(".*<(.+)>", $Address, $regs)) $Address = $regs[1];
+    if (preg_match("^[^@  ]+@([a-zA-Z0-9\-]+\.)+([a-zA-Z0-9\-]{2}|net|com|gov|mil|org|edu|int)\$", $Address))
       return true;
       else return false;
   }
 
-  function CheckAdresses($Addresses)
+  function CheckAdresses(array $Addresses): void
   {
     foreach ($Addresses as $Address)
     {
       if (!$this->ValidEmail($Address))
-  throw new Exception(sprintf(T('Mail message invalid address %s'), $Address));
-    }
-  }
-
-  private function ContentEncoding($Charset)
+      {
+        throw new Exception(sprintf(T('Mail message invalid address %s'), $Address));
+      }
+    }
+  }
+
+  private function ContentEncoding($Charset): string
   {
     if ($Charset != CHARSET_ASCII) return '8bit';
@@ -172 +174 @@
   }
 
-  private function BuildAttachment($Body)
+  private function BuildAttachment($Body): string
   {
     if (count($this->Attachments) > 0)
@@ -206 +208 @@
   }
 
-  private function BuildBody()
+  private function BuildBody(): string
   {
     $Result = '';
@@ -219 +221 @@
       $this->Headers['Content-Transfer-Encoding'] = $this->ContentEncoding($this->Bodies[0]['Charset']);
     }
-
 
     foreach ($this->Bodies as $Body)