Expose stream context options

Author: Synchro

changelog.md

@@ -28,6 +28,7 @@
 * Provide detailed errors when individual recipients fail
 * Report more errors when connecting
 * Add extras classes to composer classmap
+* Expose stream_context_create options via new SMTPOptions property
 
 ## Version 5.2.9 (Sept 25th 2014)
 * **Important: The autoloader is no longer autoloaded by the PHPMailer class**

class.phpmailer.php

@@ -255,6 +255,12 @@ class PHPMailer
      */
     public $SMTPAuth = false;
 
+    /**
+     * Options array passed to stream_context_create when connecting via SMTP.
+     * @type array
+     */
+    public $SMTPOptions = array();
+
     /**
      * SMTP username.
      * @type string
@@ -1220,7 +1226,7 @@ public function getSMTPInstance()
     protected function smtpSend($header, $body)
     {
         $bad_rcpt = array();
-        if (!$this->smtpConnect()) {
+        if (!$this->smtpConnect($this->SMTPOptions)) {
             throw new phpmailerException($this->lang('smtp_connect_failed'), self::STOP_CRITICAL);
         }
         if ('' == $this->Sender) {

class.smtp.php

@@ -265,7 +265,7 @@ public function connect($host, $port = null, $timeout = 30, $options = array())
         }
         // Connect to the SMTP server
         $this->edebug(
-            "Connection: opening to $host:$port, t=$timeout, opt=".var_export($options, true),
+            "Connection: opening to $host:$port, timeout=$timeout, options=".var_export($options, true),
             self::DEBUG_CONNECTION
         );
         $errno = 0;

examples/ssl_options.phps

@@ -0,0 +1,74 @@
+<?php
+/**
+ * This example shows settings to use when sending over SMTP with TLS and custom connection options.
+ */
+
+//SMTP needs accurate times, and the PHP time zone MUST be set
+//This should be done in your php.ini, but this is how to do it if you don't have access to that
+date_default_timezone_set('Etc/UTC');
+
+require '../PHPMailerAutoload.php';
+
+//Create a new PHPMailer instance
+$mail = new PHPMailer;
+
+//Tell PHPMailer to use SMTP
+$mail->isSMTP();
+
+//Enable SMTP debugging
+// 0 = off (for production use)
+// 1 = client messages
+// 2 = client and server messages
+$mail->SMTPDebug = 2;
+
+//Ask for HTML-friendly debug output
+$mail->Debugoutput = 'html';
+
+//Set the hostname of the mail server
+$mail->Host = 'smtp.example.com';
+
+//Set the SMTP port number - 587 for authenticated TLS, a.k.a. RFC4409 SMTP submission
+$mail->Port = 587;
+
+//Set the encryption system to use - ssl (deprecated) or tls
+$mail->SMTPSecure = 'tls';
+
+//Custom connection options
+$mail->SMTPOptions = array (
+    'ssl' => array(
+        'verify_peer'  => true,
+        'verify_depth' => 3,
+        'allow_self_signed' => true,
+        'peer_name' => 'smtp.example.com',
+        'cafile' => '/etc/ssl/ca_cert.pem',
+    )
+);
+
+//Whether to use SMTP authentication
+$mail->SMTPAuth = true;
+
+//Username to use for SMTP authentication - use full email address for gmail
+$mail->Username = "[email protected]";
+
+//Password to use for SMTP authentication
+$mail->Password = "yourpassword";
+
+//Set who the message is to be sent from
+$mail->setFrom('[email protected]', 'First Last');
+
+//Set who the message is to be sent to
+$mail->addAddress('[email protected]', 'John Doe');
+
+//Set the subject line
+$mail->Subject = 'PHPMailer SMTP options test';
+
+//Read an HTML message body from an external file, convert referenced images to embedded,
+//convert HTML into a basic plain-text alternative body
+$mail->msgHTML(file_get_contents('contents.html'), dirname(__FILE__));
+
+//send the message, check for errors
+if (!$mail->send()) {
+    echo "Mailer Error: " . $mail->ErrorInfo;
+} else {
+    echo "Message sent!";
+}