File: Zend_Mail-SmtpAuthentication.xml

package info (click to toggle)
zendframework 1.12.9%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: jessie-kfreebsd
  • size: 133,584 kB
  • sloc: xml: 1,311,829; php: 570,173; sh: 170; makefile: 125; sql: 121
file content (45 lines) | stat: -rw-r--r-- 1,612 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
<?xml version="1.0" encoding="UTF-8"?>
<!-- Reviewed: no -->
<sect1 id="zend.mail.smtp-authentication">
    <title>SMTP Authentication</title>

    <para>
        <classname>Zend_Mail</classname> supports the use of SMTP authentication, which
        can be enabled be passing the 'auth' parameter to the configuration array in
        the <classname>Zend_Mail_Transport_Smtp</classname> constructor. The available
        built-in authentication methods are PLAIN, LOGIN and CRAM-MD5 which all
        expect a 'username' and 'password' value in the configuration array.
    </para>

    <example id="zend.mail.smtp-authentication.example-1">
        <title>Enabling authentication within Zend_Mail_Transport_Smtp</title>

        <programlisting language="php"><![CDATA[
$config = array('auth' => 'login',
                'username' => 'myusername',
                'password' => 'password');

$transport = new Zend_Mail_Transport_Smtp('mail.server.com', $config);

$mail = new Zend_Mail();
$mail->setBodyText('This is the text of the mail.');
$mail->setFrom('sender@test.com', 'Some Sender');
$mail->addTo('recipient@test.com', 'Some Recipient');
$mail->setSubject('TestSubject');
$mail->send($transport);
]]></programlisting>
    </example>

    <note>
        <title>Authentication types</title>

        <para>
            The authentication type is case-insensitive but has no punctuation.
            E.g. to use CRAM-MD5 you would pass 'auth' => 'crammd5' in the
            <classname>Zend_Mail_Transport_Smtp</classname> constructor.
        </para>
    </note>
</sect1>
<!--
vim:se ts=4 sw=4 et:
-->