imap-headerinfo.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: hirokawa Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.imap-headerinfo" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>imap_headerinfo</refname>
  <refpurpose>メッセージヘッダを読み込む</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>stdClass</type><type>false</type></type><methodname>imap_headerinfo</methodname>
   <methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
   <methodparam><type>int</type><parameter>message_num</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>from_length</parameter><initializer>0</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>subject_length</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   指定したメッセージ番号についての情報を、そのヘッダを読み込んで取得します。
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &imap.imap-parameter.imap;
    <varlistentry>
     <term><parameter>message_num</parameter></term>
     <listitem>
      <para>
       メッセージ番号。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>from_length</parameter></term>
     <listitem>
      <para>
       <literal>fetchfrom</literal> プロパティの文字数。
       ゼロ以上でなければなりません。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>subject_length</parameter></term>
     <listitem>
      <para>
       <literal>fetchsubject</literal> プロパティの文字数。
       ゼロ以上でなければなりません。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>defaulthost</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   エラー時には &false;、成功時には
   以下のプロパティをもつオブジェクトを返します。
   <itemizedlist>
    <listitem>
     <simpara>
      toaddress - 完全な to: 行。最大 1024 文字。
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      to - To: 行から、次のプロパティを含むオブジェクトの配列を返します。
      <literal>personal</literal>、<literal>adl</literal>、
      <literal>mailbox</literal> および <literal>host</literal>
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      fromaddress - 完全な from: 行。最大 1024 文字。
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      from - From: 行から、次のプロパティを含むオブジェクトの配列を返します。
      <literal>personal</literal>、<literal>adl</literal>、
      <literal>mailbox</literal> および <literal>host</literal>
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      ccaddress - 完全な cc: 行。最大 1024 文字。
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      cc - Cc: 行から、次のプロパティを含むオブジェクトの配列を返します。
      <literal>personal</literal>、<literal>adl</literal>、
      <literal>mailbox</literal> および <literal>host</literal>
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      bccaddress - 完全な bcc: 行。最大 1024 文字。
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      bcc - Bcc: 行から、次のプロパティを含むオブジェクトの配列を返します。
      <literal>personal</literal>、<literal>adl</literal>、
      <literal>mailbox</literal> および <literal>host</literal>
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      reply_toaddress - 完全な Reply-To: 行。最大 1024 文字。
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      reply_to - Reply-To: 行から、次のプロパティを含むオブジェクトの配列を返します。
      <literal>personal</literal>、<literal>adl</literal>、
      <literal>mailbox</literal> および <literal>host</literal>
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      senderaddress - 完全な sender: 行。最大 1024 文字。
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      sender - Sender: 行から、次のプロパティを含むオブジェクトの配列を返します。
      <literal>personal</literal>、<literal>adl</literal>、
      <literal>mailbox</literal> および <literal>host</literal>
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      return_pathaddress - 完全な Return-Path: 行。最大 1024 文字。
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      return_path - Return-Path: 行から、次のプロパティを含むオブジェクトの配列を返します。
      <literal>personal</literal>、
      <literal>adl</literal>、<literal>mailbox</literal> および
      <literal>host</literal>
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      remail - 
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      date - ヘッダにあるメッセージの日付。
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      Date - date と同じ。
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      subject - メッセージの件名。
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      Subject - subject と同じ。
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      in_reply_to - 
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      message_id - 
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      newsgroups - 
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      followup_to - 
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      references - 
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      Recent - 最近の既読メッセージは <literal>R</literal>、
      最新の未読メッセージは <literal>N</literal>、
      最新でないメッセージは ' '。
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      Unseen - 最新でない未読メッセージは <literal>U</literal>、
      既読、あるいは最新の未読メッセージは ' '。
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      Flagged - フラグがたっている場合は <literal>F</literal>、
      そうでない場合は ' '。
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      Answered - 返信した場合は <literal>A</literal>、
      していない場合は ' '。
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      Deleted - 削除された場合は <literal>D</literal>、
      されていない場合は ' '。
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      Draft - 草稿である場合は <literal>X</literal>、
      そうでない場合は ' '。
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      Msgno - メッセージ番号。
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      MailDate - 
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      Size - メッセージのサイズ。
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      udate - メールメッセージの日付を Unix time で表したもの。
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      fetchfrom - from 行を <parameter>from_length</parameter> 文字に適合させたもの。
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      fetchsubject - subject 行を
      <parameter>subject_length</parameter> 文字に適合させたもの。
     </simpara>
    </listitem>
   </itemizedlist>
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &imap.changelog.imap-param;
     <row>
      <entry>8.0.0</entry>
      <entry>
       未使用だった <parameter>defaulthost</parameter> が削除されました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>imap_fetch_overview</function></member>
   </simplelist>
  </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
-->