Further changes related to PR #2807
diff --git a/system/libraries/Email.php b/system/libraries/Email.php
index a41884f..739b76c 100644
--- a/system/libraries/Email.php
+++ b/system/libraries/Email.php
@@ -725,13 +725,13 @@
$this->_set_error_message('lang:email_attachment_missing', $filename);
return FALSE;
}
-
+
if ( ! $fp = fopen($filename, FOPEN_READ))
{
$this->_set_error_message('lang:email_attachment_unreadable', $filename);
return FALSE;
}
-
+
$file_content = stream_get_contents($fp);
$mime = $this->_mime_types(pathinfo($filename, PATHINFO_EXTENSION));
fclose($fp);
@@ -740,7 +740,7 @@
{
$file_content =& $filename; // buffered file
}
-
+
$this->_attachments[] = array(
'name' => array($filename, $newname),
'disposition' => empty($disposition) ? 'attachment' : $disposition, // Can also be 'inline' Not sure if it matters
@@ -750,24 +750,24 @@
return $this;
}
-
+
// --------------------------------------------------------------------
-
+
/**
- * Set and return id of attachment
- *
- * useful for attached inline pictures
+ * Set and return attachment Content-ID
+ *
+ * Useful for attached inline pictures
*
* @param string $filename
* @return string
*/
- public function attach_cid($filename)
+ public function attachment_cid($filename)
{
if ($this->multipart !== 'related')
{
$this->multipart = 'related'; // Thunderbird need this for inline images
}
-
+
for ($i = 0, $c = count($this->_attachments); $i < $c; $i++)
{
if ($this->_attachments[$i]['name'][0] === $filename)
@@ -776,7 +776,7 @@
return $this->_attachments[$i]['cid'];
}
}
-
+
return FALSE;
}
@@ -1429,6 +1429,7 @@
$this->_finalbody = ($this->_get_protocol() === 'mail')
? $body
: $hdr.$this->newline.$this->newline.$body;
+
return TRUE;
}
diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst
index 34eff5d..b112da5 100644
--- a/user_guide_src/source/changelog.rst
+++ b/user_guide_src/source/changelog.rst
@@ -332,11 +332,11 @@
- :doc:`Email Library <libraries/email>` changes include:
- - Added custom filename to ``Email::attach()`` as ``$this->email->attach($filename, $disposition, $newname)``.
- - Added possibility to send attachment as buffer string in ``Email::attach()`` as ``$this->email->attach($buffer, $disposition, $newname, $mime)``.
- - Added method ``Email::attach_cid()`` returning CID which enables to embed an attachment to html.
+ - Added a custom filename parameter to ``attach()`` as ``$this->email->attach($filename, $disposition, $newname)``.
+ - Added possibility to send attachment as buffer string in ``attach()`` as ``$this->email->attach($buffer, $disposition, $newname, $mime)``.
+ - Added method ``attachment_cid()`` to enable embedding inline attachments into HTML.
- Added dsn (delivery status notification) option.
- - Renamed method _set_header() to set_header() and made it public to enable adding custom headers in the :doc:`Email Library <libraries/email>`.
+ - Renamed method ``_set_header()`` to ``set_header()`` and made it public to enable adding custom headers.
- Successfully sent emails will automatically clear the parameters.
- Added a *return_path* parameter to the ``from()`` method.
- Removed the second parameter (character limit) from internal method ``_prep_quoted_printable()`` as it is never used.
@@ -345,7 +345,7 @@
- Removed unused protected method ``_get_ip()`` (:doc:`Input Library <libraries/input>`'s ``ip_address()`` should be used anyway).
- Internal method ``_prep_q_encoding()`` now utilizes PHP's *mbstring* and *iconv* extensions (when available) and no longer has a second (``$from``) argument.
- Added an optional parameter to ``print_debugger()`` to allow specifying which parts of the message should be printed ('headers', 'subject', 'body').
- - Added SMTP keepalive option to avoid opening the connection for each ``Email::send()``. Accessible as ``$smtp_keepalive``.
+ - Added SMTP keepalive option to avoid opening the connection for each ``send()`` call. Accessible as ``$smtp_keepalive``.
- Public method ``set_header()`` now filters the input by removing all "\\r" and "\\n" characters.
- :doc:`Pagination Library <libraries/pagination>` changes include:
diff --git a/user_guide_src/source/libraries/email.rst b/user_guide_src/source/libraries/email.rst
index 274d88d..8e38003 100644
--- a/user_guide_src/source/libraries/email.rst
+++ b/user_guide_src/source/libraries/email.rst
@@ -269,13 +269,13 @@
$this->email->attach($buffer, 'attachment', 'report.pdf', 'application/pdf');
-$this->email->attach_cid()
- --------------------------
+$this->email->attachment_cid()
+------------------------------
- Returns CID which enables to embed an attachment to html. First parameter
- must be attached file.
+Sets and returns an attachment's Content-ID, which enables your to embed an inline
+(picture) attachment into HTML. First parameter must be attached file.
- ::
+::
$filename = '/img/photo1.jpg';
$this->email->attach($filename);
@@ -286,8 +286,8 @@
$this->email->message('<img src='cid:". $cid ."' alt="photo1" />');
$this->email->send();
}
-
- CID for each Email have to be create again to be unique.
+
+CID for each Email have to be create again to be unique.
$this->email->print_debugger()
------------------------------