Email Config
Email Preferences
The following is a list of all the preferences that can be set when sending email.
| Preference | Default Value | Options | Description |
|---|---|---|---|
| useragent | CodeIgniter | None | The "user agent". |
| protocol | mail, sendmail, or smtp | The mail sending protocol. | |
| mailpath | /usr/sbin/sendmail | None | The server path to Sendmail. |
| smtp_host | No Default | None | SMTP Server Address. |
| smtp_user | No Default | None | SMTP Username. |
| smtp_pass | No Default | None | SMTP Password. |
| smtp_port | 25 | None | SMTP Port. |
| smtp_timeout | 5 | None | SMTP Timeout (in seconds). |
| wordwrap | TRUE | TRUE or FALSE (boolean) | Enable word-wrap. |
| wrapchars | 76 | Character count to wrap at. | |
| mailtype | text | text or html | Type of mail. If you send HTML email you must send it as a complete web page. Make sure you don't have any relative links or relative image paths otherwise they will not work. |
| charset | utf-8 | Character set (utf-8, iso-8859-1, etc.). | |
| validate | FALSE | TRUE or FALSE (boolean) | Whether to validate the email address. |
| priority | 3 | 1, 2, 3, 4, 5 | Email Priority. 1 = highest. 5 = lowest. 3 = normal. |
| crlf | \n | "\r\n" or "\n" or "\r" | Newline character. (Use "\r\n" to comply with RFC 822). |
| newline | \n | "\r\n" or "\n" or "\r" | Newline character. (Use "\r\n" to comply with RFC 822). |
| bcc_batch_mode | FALSE | TRUE or FALSE (boolean) | Enable BCC Batch Mode. |
| bcc_batch_size | 200 | None | Number of emails in each BCC batch. |
Overriding Word Wrapping
If you have word wrapping enabled (recommended to comply with RFC 822) and you have a very long link in your email it can get wrapped too, causing it to become un-clickable by the person receiving it. CodeIgniter lets you manually override word wrapping within part of your message like this:
The text of your email that
gets wrapped normally.
{unwrap}http://example.com/a_long_link_that_should_not_be_wrapped.html{/unwrap}
More text that will be
wrapped normally.
Place the item you do not want word-wrapped between: {unwrap} {/unwrap}