Archangel::is_valid_email_address() - Code Metrics - Inspection of "WIP - rename variables, remove validation, cleanup..." - jacobemerick/archangel - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — master (#9)

by Jacob
created 2016-01-20 23:19 UTC
Archangel::is_valid_email_address() A

↳ Parent: Archangel::get_additional_headers()
Complexity

Conditions	2
Paths	2
Size

Total Lines	7
Code Lines	4
Duplication

Lines	0
Ratio	0 %
Importance

Changes	2
Bugs	0	Features	0
Metric	Value
c	2
b	0
f	0
dl	0
loc	7
rs	9.4285
cc	2
eloc	4
nc	2
nop	1
<?php

namespace Jacobemerick\Archangel;

/**
 * This is the main class for Archangel mailer
 * For licensing and examples:
 * @see https://github.com/jacobemerick/archangel
 *
 * @author jacobemerick (http://home.jacobemerick.com/)
 */

class Archangel
{

    /** @var string $subject */
    protected $subject;

    /** @var array $to */
    protected $to = array();

    /** @var array $cc */
    protected $cc = array();

    /** @var array $bcc */
    protected $bcc = array();

    /** @var array $headers */
    protected $headers = array();

    /** @var string $plainMessage */
    protected $plainMessage;

    /** @var string $htmlMessage */
    protected $htmlMessage;

    /** @var array $attachments */
    protected $attachments = array();

    /** @var string MAILER_PATTERN */
    const MAILER_PATTERN = "PHP/%s";

    /** @var string LINE_BREAK */
    const LINE_BREAK = "\r\n";

    /** @var string BOUNDARY_PATTERN */
    const BOUNDARY_PATTERN = "PHP-mixed-%s";

    /** @var string BOUNDARY_SALT */
    const BOUNDARY_SALT = "Boundary Salt";

    /** @var string ALTERNATIVE_BOUNDARY_PATTERN */
    const ALTERNATIVE_BOUNDARY_PATTERN = "PHP-alternative-%s";

    /** @var string ALTERNATIVE_BOUNDARY_SALT */
    const ALTERNATIVE_BOUNDARY_SALT = "Alternative Boundary Salt";

    /**
     * @param string $mailer
     */
    public function __construct($mailer = null)
    {
        if (is_null($mailer)) {
            $mailer = sprintf(self::MAILER_PATTERN, phpversion());
        }
        $this->headers['X-Mailer'] = $mailer;
    }

    /**
     * Setter method for adding recipients
     *
     * @param string $address email address for the recipient
     * @param string $title   name of the recipient (optional)

     * @return object instantiated $this
     */
    public function addTo($address, $title = '')

    {
        if (!empty($title)) {
            $address = sprintf('"%s" <%s>', $title, $address);
        }
        array_push($this->to, $address);

        return $this;
    }

    /**
     * Setter method for adding cc recipients
     *
     * @param string $address  email address for the cc recipient
     * @param string $title    name of the cc recipient (optional)
     *
     * @return object instantiated $this
     */
    public function addCC($address, $title = '')

    {
        if (!empty($title)) {
            $address = sprintf('"%s" <%s>', $title, $address);
        }
        array_push($this->cc, $address);

        return $this;
    }

    /**
     * Setter method for adding bcc recipients
     *
     * @param string $addres  email address for the bcc recipient
/**
 * @param array $germany
 * @param array $ireland
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param string $title   name of the bcc recipient (optional)
     *
     * @return object instantiated $this
     */
    public function addBCC($address, $title = '')

    {
        if (!empty($title)) {
            $address = sprintf('"%s" <%s>', $title, $address);
        }
        array_push($this->bcc, $address);

        return $this;
    }

    /**
     * Setter method for setting the single 'from' field
     *
     * @param string $address email address for the sender
     * @param string $title   name of the sender (optional)
     *
     * @return object instantiated $this
     */
    public function setFrom($address, $title = '')

    {
        if (!empty($title)) {
            $address = sprintf('"%s" <%s>', $title, $address);
        }
        $this->headers['From'] = $address;

        return $this;
    }

    /**
     * Setter method for setting the single 'reply-to' field
     *
     * @param string $address email address for the reply-to
     * @param string $title   name of the reply-to (optional)
     *
     * @return object instantiated $this
     */
    public function setReplyTo($address, $title = '')

    {
        if (!empty($title)) {
            $address = sprintf('"%s" <%s>', $title, $address);
        }
        $this->headers['Reply-To'] = $address;

        return $this;
    }

    /**
     * Setter method for setting a subject
     *
     * @param string $subject subject for the email
     *
     * @return object instantiated $this
     */
    public function setSubject($subject)
    {
        $this->subject = $subject;

        return $this;
    }

    /**
     * Setter method for the plain text message
     *
     * @param string $message the plain-text message
     *
     * @return object instantiated $this
     */
    public function setPlainMessage($message)
    {
        $this->plainMessage = $message;

        return $this;
    }

    /**
     * Setter method for the html message
     *
     * @param string $message the html message
     *
     * @return object instantiated $this
     */
    public function setHTMLMessage($message)
    {
        $this->htmlMessage = $message;

        return $this;
    }

    /**
     * Setter method for adding attachments
     *
     * @param string $path  the full path of the attachment
     * @param string $type  mime type of the file
     * @param string $title the title of the attachment (optional)
     *
     * @return object instantiated $this
     */
    public function addAttachment($path, $type, $title = '')
    {
        array_push($this->attachments, array(
          'path' => $path,
          'type' => $type,
          'title' => $title,
        ));

        return $this;
    }

    /**
     * The executing step, the actual sending of the email
     * First checks to make sure the minimum fields are set (returns false if they are not)
     * Second it attempts to send the mail with php's mail() (returns false if it fails)
     *
     * return boolean whether or not the email was valid & sent
     */
    public function send()
    {
      if($this->passed_validation === FALSE)
class MyClass { }

$x = new MyClass();
$x->foo = true;
        return false;
      
      if(!$this->check_required_fields())
        return false;
      
      $to = $this->get_to();
      $subject = $this->subject;
      $message = $this->get_message();
      $additional_headers = $this->get_additional_headers();
      
      return mail($to, $subject, $message, $additional_headers);
    }

    /**
     * Main instantiator for the class
     *
     * @return  object  instantiated $this
     */
    public static function instance()
    {
      return new Archangel();
    }

    /**
     * Private call to check the minimum required fields
     *
     * @return  boolean whether or not the email meets the minimum required fields
     */
    private function check_required_fields()
    {
      return (
        count($this->to_array) > 0 &&
class MyClass { }

$x = new MyClass();
$x->foo = true;
        (isset($this->subject) && strlen($this->subject) > 0) &&
        (
          (isset($this->plain_message) && strlen($this->plain_message) > 0) ||
class MyClass { }

$x = new MyClass();
$x->foo = true;
          (isset($this->html_message) && strlen($this->html_message) > 0) ||
class MyClass { }

$x = new MyClass();
$x->foo = true;
          (isset($this->attachment_array) && count($this->attachment_array) > 0)));
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    /**
     * Private function to collect the recipients from to_array
     *
     * @return  string  comma-separated lit of recipients
     */
    private function get_to()
    {
      return implode(', ', $this->to_array);
    }

    /**
     * Long, nasty creater of the actual message, with all the multipart logic you'd never want to see
     *
     * @return  string  email message
     */
    private function get_message()
    {
      $message = '';
      
      if(isset($this->attachment_array) && count($this->attachment_array) > 0)
        $message .= "--{$this->get_boundary()}" . self::$LINE_BREAK;
      
      if(
        isset($this->plain_message) && strlen($this->plain_message) > 0 &&
        isset($this->html_message) && strlen($this->html_message) > 0)
      {
        if(isset($this->attachment_array) && count($this->attachment_array) > 0)

        {
          $message .= "Content-Type: multipart/alternative; boundary={$this->get_alternative_boundary()}" . self::$LINE_BREAK;
          $message .= self::$LINE_BREAK;
        }
        $message .= "--{$this->get_alternative_boundary()}" . self::$LINE_BREAK;
        $message .= 'Content-Type: text/plain; charset="iso-8859"' . self::$LINE_BREAK;
        $message .= 'Content-Transfer-Encoding: 7bit' . self::$LINE_BREAK;
        $message .= self::$LINE_BREAK;
        $message .= $this->plain_message;
        $message .= self::$LINE_BREAK;
        $message .= "--{$this->get_alternative_boundary()}" . self::$LINE_BREAK;
        $message .= 'Content-Type: text/html; charset="iso-8859-1"' . self::$LINE_BREAK;
        $message .= 'Content-Transfer-Encoding: 7bit' . self::$LINE_BREAK;
        $message .= self::$LINE_BREAK;
        $message .= $this->html_message;
        $message .= self::$LINE_BREAK;
        $message .= "--{$this->get_alternative_boundary()}--" . self::$LINE_BREAK;
        $message .= self::$LINE_BREAK;
      }
      else if(isset($this->plain_message) && strlen($this->plain_message))
      {
        if(isset($this->attachment_array) && count($this->attachment_array) > 0)

        {
          $message .= 'Content-Type: text/plain; charset="iso-8859"' . self::$LINE_BREAK;
          $message .= 'Content-Transfer-Encoding: 7bit' . self::$LINE_BREAK;
          $message .= self::$LINE_BREAK;
        }
        $message .= $this->plain_message;
        $message .= self::$LINE_BREAK;
      }
      else if(isset($this->html_message) && strlen($this->html_message))
      {
        if(isset($this->attachment_array) && count($this->attachment_array) > 0)

        {
          $message .= 'Content-Type: text/html; charset="iso-8859-1"' . self::$LINE_BREAK;
          $message .= 'Content-Transfer-Encoding: 7bit' . self::$LINE_BREAK;
          $message .= self::$LINE_BREAK;
        }
        $message .= $this->html_message;
        $message .= self::$LINE_BREAK;
      }
      if(isset($this->attachment_array) && count($this->attachment_array) > 0)
      {
        foreach($this->attachment_array as $attachment)
        {
          $message .= "--{$this->get_boundary()}" . self::$LINE_BREAK;
          $message .= "Content-Type: {$attachment->type}; name=\"{$attachment->title}\"" . self::$LINE_BREAK;
          $message .= 'Content-Transfer-Encoding: base64' . self::$LINE_BREAK;
          $message .= 'Content-Disposition: attachment' . self::$LINE_BREAK;
          $message .= self::$LINE_BREAK;
          $message .= $this->get_attachment_content($attachment);
          $message .= self::$LINE_BREAK;
        }
        $message .= "--{$this->get_boundary()}--" . self::$LINE_BREAK;
      }
      return $message;
    }

    /**
     * Private holder for the boundry logic
     * Not called/created unless it's needed
     *
     * @return  string  boundary
     */
    private $boundary;
    private function get_boundary()
    {
      if(!isset($this->boundary))
        $this->boundary = sprintf(self::$BOUNDARY_FORMAT, md5(date('r', time()) . self::$BOUNDARY_SALT));
      return $this->boundary;
    }

    /**
     * Private holder for the alternative boundry logic
     * Not called/created unless it's needed
     *
     * @return  string  alternative boundary
     */
    private $alternative_boundary;
    private function get_alternative_boundary()
    {
      if(!isset($this->alternative_boundary))
        $this->alternative_boundary = sprintf(self::$ALTERNATIVE_BOUNDARY_FORMAT, md5(date('r', time()) . self::$ALTERNATIVE_BOUNDARY_SALT));
      return $this->alternative_boundary;
    }

    /**
     * Fetcher for the additional headers needed for multipart emails
     *
     * @return  string  headers needed for multipart
     */
    private function get_additional_headers()
    {
      $headers = '';
      foreach($this->header_array as $key => $value)
class MyClass { }

$x = new MyClass();
$x->foo = true;
      {
        $headers .= "{$key}: {$value}" . self::$LINE_BREAK;
      }
      
      if(count($this->cc_array) > 0)
        $headers .= 'CC: ' . implode(', ', $this->cc_array) . self::$LINE_BREAK;
class MyClass { }

$x = new MyClass();
$x->foo = true;
      if(count($this->bcc_array) > 0)

        $headers .= 'BCC: ' . implode(', ', $this->bcc_array) . self::$LINE_BREAK;

      
      if(isset($this->attachment_array) && count($this->attachment_array) > 0)
        $headers .= "Content-Type: multipart/mixed; boundary=\"{$this->get_boundary()}\"";
      else if(
        isset($this->plain_message) && strlen($this->plain_message) > 0 &&
        isset($this->html_message) && strlen($this->html_message) > 0)
      {
        $headers .= "Content-Type: multipart/alternative; boundary=\"{$this->get_alternative_boundary()}\"";
      }
      else if(isset($this->html_message) && strlen($this->html_message) > 0)
        $headers .= 'Content-type: text/html; charset="iso-8859-1"';
      
      return $headers;
    }

    /**
     * File reader for attachments
     *
     * @return  string  binary representation of file, base64'd
     */
    private function get_attachment_content($attachment)
    {
      $handle = fopen($attachment->path, 'r');
      $contents = fread($handle, filesize($attachment->path));
      fclose($handle);
      
      $contents = base64_encode($contents);
      $contents = chunk_split($contents);
      return $contents;
    }
}

1			<?php
2
3			namespace Jacobemerick\Archangel;
4
5			/**
6			* This is the main class for Archangel mailer
7			* For licensing and examples:
8			* @see https://github.com/jacobemerick/archangel
9			*
10			* @author jacobemerick (http://home.jacobemerick.com/)
11			*/
12
13			class Archangel
14			{
15
16			/** @var string $subject */
17			protected $subject;
18
19			/** @var array $to */
20			protected $to = array();
21
22			/** @var array $cc */
23			protected $cc = array();
24
25			/** @var array $bcc */
26			protected $bcc = array();
27
28			/** @var array $headers */
29			protected $headers = array();
30
31			/** @var string $plainMessage */
32			protected $plainMessage;
33
34			/** @var string $htmlMessage */
35			protected $htmlMessage;
36
37			/** @var array $attachments */
38			protected $attachments = array();
39
40			/** @var string MAILER_PATTERN */
jacobemerick / archangel

Pull Request — master (#9)

Archangel::is_valid_email_address() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
