Skip to content

Commit 855e8d8

Browse files
authored
Merge pull request #7373 from kenjis/docs-improve-email.rst
docs: improve email.rst
2 parents b2d34d9 + 8c250e1 commit 855e8d8

1 file changed

Lines changed: 12 additions & 9 deletions

File tree

user_guide_src/source/libraries/email.rst

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ CodeIgniter's robust Email Class supports the following features:
1818

1919
.. contents::
2020
:local:
21-
:depth: 2
21+
:depth: 3
2222

2323
***********************
2424
Using the Email Library
@@ -44,6 +44,9 @@ messages are sent. You can either set them manually as described here,
4444
or automatically via preferences stored in your config file, described
4545
below:
4646

47+
Setting Email Preferences by Passing an Array
48+
---------------------------------------------
49+
4750
Preferences are set by passing an array of preference values to the
4851
email initialize method. Here is an example of how you might set some
4952
preferences:
@@ -63,15 +66,8 @@ Email properties. Then save the file and it will be used automatically.
6366
You will NOT need to use the ``$email->initialize()`` method if
6467
you set your preferences in the config file.
6568

66-
Reviewing Preferences
67-
---------------------
68-
69-
The settings used for the last successful send are available from the
70-
instance property ``$archive``. This is helpful for testing and debugging
71-
to determine that actual values at the time of the ``send()`` call.
72-
7369
SSL versus TLS for SMTP Protocol
74-
================================
70+
--------------------------------
7571

7672
To protect the username, password and email content while communicating with the SMTP server,
7773
encryption on the channel should be used. Two different standards are widely deployed and
@@ -97,6 +93,13 @@ If your configuration requires you to connect to port 587, you should most likel
9793
with the SMTP server to switch from clear-text to an encrypted channel. The initial communication
9894
will be made in clear-text and the channel will be upgraded to TLS with the ``STARTTLS`` command.
9995

96+
Reviewing Preferences
97+
---------------------
98+
99+
The settings used for the last successful send are available from the
100+
instance property ``$archive``. This is helpful for testing and debugging
101+
to determine that actual values at the time of the ``send()`` call.
102+
100103
Email Preferences
101104
=================
102105

0 commit comments

Comments
 (0)