File: function.imap-headerinfo.html

package info (click to toggle)
php3 3%3A3.0.18-0potato1.1
links: PTS
area: main
in suites: potato
size: 17,736 kB
ctags: 11,198
sloc: ansic: 108,120; sh: 2,512; php: 2,024; yacc: 1,887; makefile: 1,038; perl: 537; pascal: 238; awk: 90; cpp: 28; sql: 11
file content (281 lines) | stat: -rw-r--r-- 7,256 bytes
parent folder | download | duplicates (3)
<HTML
><HEAD
><TITLE
>imap_headerinfo</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.57"><LINK
REL="HOME"
TITLE="PHP Manual"
HREF="manual.html"><LINK
REL="UP"
TITLE="IMAP, POP3 and NNTP functions"
HREF="ref.imap.html"><LINK
REL="PREVIOUS"
TITLE="imap_fetchstructure"
HREF="function.imap-fetchstructure.html"><LINK
REL="NEXT"
TITLE="imap_header"
HREF="function.imap-header.html"><META
NAME="HTTP_EQUIV"
CONTENT="text/html; charset=ISO-8859-1"></HEAD
><BODY
CLASS="refentry"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>PHP Manual</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="function.imap-fetchstructure.html"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="function.imap-header.html"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="function.imap-headerinfo"
>imap_headerinfo</A
></H1
><DIV
CLASS="refnamediv"
><A
NAME="AEN16621"
></A
><P
>    (PHP3 , PHP4 )</P
>imap_headerinfo&nbsp;--&nbsp;Read the header of the message</DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN16624"
></A
><H2
>Description</H2
><DIV
CLASS="funcsynopsis"
><A
NAME="AEN16626"
></A
><P
></P
><CODE
CLASS="FUNCDEF"
>object <B
CLASS="function"
>imap_headerinfo</B
></CODE
> (int imap_stream, int msg_number [, int 
      fromlength [, int 
      subjectlength [, string 
      defaulthost]]])<P
></P
></DIV
><P
>&#13;     This function returns an object of various header elements.
    </P
><P
>  
     <DIV
CLASS="informalexample"
><A
NAME="AEN16644"
></A
><P
></P
><P
CLASS="literallayout"
><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;remail,&nbsp;date,&nbsp;Date,&nbsp;subject,&nbsp;Subject,&nbsp;in_reply_to,&nbsp;message_id,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;newsgroups,&nbsp;followup_to,&nbsp;references<br>
<br>
message&nbsp;flags:<br>
&nbsp;&nbsp;&nbsp;Recent&nbsp;-&nbsp;&nbsp;'R'&nbsp;if&nbsp;recent&nbsp;and&nbsp;seen,&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'N'&nbsp;if&nbsp;recent&nbsp;and&nbsp;not&nbsp;seen,&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'&nbsp;'&nbsp;if&nbsp;not&nbsp;recent<br>
&nbsp;&nbsp;&nbsp;Unseen&nbsp;-&nbsp;&nbsp;'U'&nbsp;if&nbsp;not&nbsp;seen&nbsp;AND&nbsp;not&nbsp;recent,&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'&nbsp;'&nbsp;if&nbsp;seen&nbsp;OR&nbsp;not&nbsp;seen&nbsp;and&nbsp;recent<br>
&nbsp;&nbsp;&nbsp;Answered&nbsp;-'A'&nbsp;if&nbsp;answered,&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'&nbsp;'&nbsp;if&nbsp;unanswered<br>
&nbsp;&nbsp;&nbsp;Deleted&nbsp;-&nbsp;'D'&nbsp;if&nbsp;deleted,&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'&nbsp;'&nbsp;if&nbsp;not&nbsp;deleted<br>
&nbsp;&nbsp;&nbsp;Draft&nbsp;-&nbsp;&nbsp;&nbsp;'X'&nbsp;if&nbsp;draft,&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'&nbsp;'&nbsp;if&nbsp;not&nbsp;draft<br>
&nbsp;&nbsp;&nbsp;Flagged&nbsp;-&nbsp;'F'&nbsp;if&nbsp;flagged,&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'&nbsp;'&nbsp;if&nbsp;not&nbsp;flagged<br>
<br>
NOTE&nbsp;that&nbsp;the&nbsp;Recent/Unseen&nbsp;behavior&nbsp;is&nbsp;a&nbsp;little&nbsp;odd.&nbsp;If&nbsp;you&nbsp;want&nbsp;to<br>
know&nbsp;if&nbsp;a&nbsp;message&nbsp;is&nbsp;Unseen,&nbsp;you&nbsp;must&nbsp;check&nbsp;for<br>
<br>
Unseen&nbsp;==&nbsp;'U'&nbsp;||&nbsp;Recent&nbsp;==&nbsp;'N'<br>
<br>
toaddress&nbsp;(full&nbsp;to:&nbsp;line,&nbsp;up&nbsp;to&nbsp;1024&nbsp;characters)<br>
<br>
to[]&nbsp;(returns&nbsp;an&nbsp;array&nbsp;of&nbsp;objects&nbsp;from&nbsp;the&nbsp;To&nbsp;line,&nbsp;containing):<br>
&nbsp;&nbsp;&nbsp;personal<br>
&nbsp;&nbsp;&nbsp;adl<br>
&nbsp;&nbsp;&nbsp;mailbox<br>
&nbsp;&nbsp;&nbsp;host<br>
<br>
fromaddress&nbsp;(full&nbsp;from:&nbsp;line,&nbsp;up&nbsp;to&nbsp;1024&nbsp;characters)<br>
<br>
from[]&nbsp;(returns&nbsp;an&nbsp;array&nbsp;of&nbsp;objects&nbsp;from&nbsp;the&nbsp;From&nbsp;line,&nbsp;containing):<br>
&nbsp;&nbsp;&nbsp;personal<br>
&nbsp;&nbsp;&nbsp;adl<br>
&nbsp;&nbsp;&nbsp;mailbox<br>
&nbsp;&nbsp;&nbsp;host<br>
<br>
ccaddress&nbsp;(full&nbsp;cc:&nbsp;line,&nbsp;up&nbsp;to&nbsp;1024&nbsp;characters)<br>
cc[]&nbsp;(returns&nbsp;an&nbsp;array&nbsp;of&nbsp;objects&nbsp;from&nbsp;the&nbsp;Cc&nbsp;line,&nbsp;containing):<br>
&nbsp;&nbsp;&nbsp;personal<br>
&nbsp;&nbsp;&nbsp;adl<br>
&nbsp;&nbsp;&nbsp;mailbox<br>
&nbsp;&nbsp;&nbsp;host<br>
<br>
bccaddress&nbsp;(full&nbsp;bcc&nbsp;line,&nbsp;up&nbsp;to&nbsp;1024&nbsp;characters)<br>
bcc[]&nbsp;(returns&nbsp;an&nbsp;array&nbsp;of&nbsp;objects&nbsp;from&nbsp;the&nbsp;Bcc&nbsp;line,&nbsp;containing):<br>
&nbsp;&nbsp;&nbsp;personal<br>
&nbsp;&nbsp;&nbsp;adl<br>
&nbsp;&nbsp;&nbsp;mailbox<br>
&nbsp;&nbsp;&nbsp;host<br>
<br>
reply_toaddress&nbsp;(full&nbsp;reply_to:&nbsp;line,&nbsp;up&nbsp;to&nbsp;1024&nbsp;characters)<br>
reply_to[]&nbsp;(returns&nbsp;an&nbsp;array&nbsp;of&nbsp;objects&nbsp;from&nbsp;the&nbsp;Reply_to&nbsp;line,<br>
containing):<br>
&nbsp;&nbsp;&nbsp;personal<br>
&nbsp;&nbsp;&nbsp;adl<br>
&nbsp;&nbsp;&nbsp;mailbox<br>
&nbsp;&nbsp;&nbsp;host<br>
<br>
senderaddress&nbsp;(full&nbsp;sender:&nbsp;line,&nbsp;up&nbsp;to&nbsp;1024&nbsp;characters)<br>
sender[]&nbsp;(returns&nbsp;an&nbsp;array&nbsp;of&nbsp;objects&nbsp;from&nbsp;the&nbsp;sender&nbsp;line,&nbsp;containing):<br>
&nbsp;&nbsp;&nbsp;personal<br>
&nbsp;&nbsp;&nbsp;adl<br>
&nbsp;&nbsp;&nbsp;mailbox<br>
&nbsp;&nbsp;&nbsp;host<br>
<br>
return_path&nbsp;(full&nbsp;return-path:&nbsp;line,&nbsp;up&nbsp;to&nbsp;1024&nbsp;characters)<br>
return_path[]&nbsp;(returns&nbsp;an&nbsp;array&nbsp;of&nbsp;objects&nbsp;from&nbsp;the&nbsp;return_path&nbsp;line,<br>
containing):<br>
&nbsp;&nbsp;&nbsp;personal<br>
&nbsp;&nbsp;&nbsp;adl<br>
&nbsp;&nbsp;&nbsp;mailbox<br>
&nbsp;&nbsp;&nbsp;host<br>
<br>
udate&nbsp;(mail&nbsp;message&nbsp;date&nbsp;in&nbsp;unix&nbsp;time)<br>
<br>
fetchfrom&nbsp;(from&nbsp;line&nbsp;formatted&nbsp;to&nbsp;fit&nbsp;<TT
CLASS="parameter"
><I
>fromlength</I
></TT
>&nbsp;<br>
characters)<br>
<br>
fetchsubject&nbsp;(subject&nbsp;line&nbsp;formatted&nbsp;to&nbsp;fit&nbsp;<TT
CLASS="parameter"
><I
>subjectlength</I
></TT
>&nbsp;characters)<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</P
><P
></P
></DIV
>
    </P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="function.imap-fetchstructure.html"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="manual.html"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="function.imap-header.html"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>imap_fetchstructure</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="ref.imap.html"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>imap_header</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>