imap-rfc822-write-address.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.imap-rfc822-write-address" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>imap_rfc822_write_address</refname>
  <refpurpose>Returns a properly formatted email address given the mailbox, host, and personal info</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>imap_rfc822_write_address</methodname>
   <methodparam><type>string</type><parameter>mailbox</parameter></methodparam>
   <methodparam><type>string</type><parameter>hostname</parameter></methodparam>
   <methodparam><type>string</type><parameter>personal</parameter></methodparam>
  </methodsynopsis>
  <para>
   Returns a properly formatted email address as defined in <link
   xlink:href="&url.rfc;2822">RFC2822</link> given the needed information.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>mailbox</parameter></term>
     <listitem>
      <para>
       The mailbox name, see <function>imap_open</function> for more
       information
      </para>
      &imap.mailboxname.insecure;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>hostname</parameter></term>
     <listitem>
      <para>
       The email host part
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>personal</parameter></term>
     <listitem>
      <para>
       The name of the account owner
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns a string properly formatted email address as defined in <link
   xlink:href="&url.rfc;2822">RFC2822</link>, &return.falseforfailure;.
   </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>imap_rfc822_write_address</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
echo imap_rfc822_write_address("hartmut", "example.com", "Hartmut Holzgraefe");
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Hartmut Holzgraefe <hartmut@example.com>
]]>
    </screen>
   </example>
  </para>
 </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->