mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 19:08:54 +00:00
2d23ddfe59
- Move alised documented to their real function name and document what an alias is. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@99005 c90b9560-bf6c-de11-be94-00142212c4b1
132 lines
3.6 KiB
XML
132 lines
3.6 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.3 $ -->
|
|
<!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 -->
|
|
<refentry id="function.imap-headerinfo">
|
|
<refnamediv>
|
|
<refname>imap_headerinfo</refname>
|
|
<refpurpose>Read the header of the message</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>object</type><methodname>imap_headerinfo</methodname>
|
|
<methodparam><type>resource</type><parameter>imap_stream</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>msg_number</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>fromlength</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>subjectlength</parameter></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>defaulthost</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
This function returns an object of various header elements.
|
|
</para>
|
|
<para>
|
|
<informalexample>
|
|
<literallayout>
|
|
remail, date, Date, subject, Subject, in_reply_to, message_id,
|
|
newsgroups, followup_to, references
|
|
|
|
message flags:
|
|
Recent - 'R' if recent and seen,
|
|
'N' if recent and not seen,
|
|
' ' if not recent
|
|
Unseen - 'U' if not seen AND not recent,
|
|
' ' if seen OR not seen and recent
|
|
Answered -'A' if answered,
|
|
' ' if unanswered
|
|
Deleted - 'D' if deleted,
|
|
' ' if not deleted
|
|
Draft - 'X' if draft,
|
|
' ' if not draft
|
|
Flagged - 'F' if flagged,
|
|
' ' if not flagged
|
|
|
|
NOTE that the Recent/Unseen behavior is a little odd. If you want to
|
|
know if a message is Unseen, you must check for
|
|
|
|
Unseen == 'U' || Recent == 'N'
|
|
|
|
toaddress (full to: line, up to 1024 characters)
|
|
|
|
to[] (returns an array of objects from the To line, containing):
|
|
personal
|
|
adl
|
|
mailbox
|
|
host
|
|
|
|
fromaddress (full from: line, up to 1024 characters)
|
|
|
|
from[] (returns an array of objects from the From line, containing):
|
|
personal
|
|
adl
|
|
mailbox
|
|
host
|
|
|
|
ccaddress (full cc: line, up to 1024 characters)
|
|
cc[] (returns an array of objects from the Cc line, containing):
|
|
personal
|
|
adl
|
|
mailbox
|
|
host
|
|
|
|
bccaddress (full bcc line, up to 1024 characters)
|
|
bcc[] (returns an array of objects from the Bcc line, containing):
|
|
personal
|
|
adl
|
|
mailbox
|
|
host
|
|
|
|
reply_toaddress (full reply_to: line, up to 1024 characters)
|
|
reply_to[] (returns an array of objects from the Reply_to line,
|
|
containing):
|
|
personal
|
|
adl
|
|
mailbox
|
|
host
|
|
|
|
senderaddress (full sender: line, up to 1024 characters)
|
|
sender[] (returns an array of objects from the sender line, containing):
|
|
personal
|
|
adl
|
|
mailbox
|
|
host
|
|
|
|
return_path (full return-path: line, up to 1024 characters)
|
|
return_path[] (returns an array of objects from the return_path line,
|
|
containing):
|
|
personal
|
|
adl
|
|
mailbox
|
|
host
|
|
|
|
udate (mail message date in unix time)
|
|
|
|
fetchfrom (from line formatted to fit <parameter>fromlength</parameter>
|
|
characters)
|
|
|
|
fetchsubject (subject line formatted to fit <parameter>subjectlength</parameter> characters)
|
|
</literallayout>
|
|
</informalexample>
|
|
</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:"../../../../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
|
|
-->
|