Zend_Validate-EmailAddress.xml 9.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- Reviewed: no -->
  3. <!-- EN-Revision: 17468 -->
  4. <sect2 id="zend.validate.set.email_address">
  5. <title>メールアドレス</title>
  6. <para>
  7. <classname>Zend_Validate_EmailAddress</classname> は、メールアドレスの検証を行います。
  8. このバリデータは、まずメールアドレスを
  9. local-part @ hostname
  10. に分割し、メールアドレスやホスト名の仕様にあわせて検証します。
  11. </para>
  12. <sect3 id="zend.validate.set.email_address.basic">
  13. <title>基本的な使用法</title>
  14. <para>
  15. 基本的な使用法は、以下のようになります。
  16. </para>
  17. <programlisting language="php"><![CDATA[
  18. $validator = new Zend_Validate_EmailAddress();
  19. if ($validator->isValid($email)) {
  20. // メールアドレスは正しい形式のようです
  21. } else {
  22. // 不正な形式なので、理由を表示します
  23. foreach ($validator->getMessages() as $message) {
  24. echo "$message\n";
  25. }
  26. }
  27. ]]></programlisting>
  28. <para>
  29. これは、メールアドレス <varname>$email</varname> を検証し、失敗した場合は
  30. その原因を表す便利なエラーメッセージを
  31. <code>$validator->getMessages()</code> で取得します。
  32. </para>
  33. </sect3>
  34. <sect3 id="zend.validate.set.email_address.complexlocal">
  35. <title>複雑なローカルパート</title>
  36. <para>
  37. <classname>Zend_Validate_EmailAddress</classname> は、メールアドレスの検証を
  38. RFC2822 にもとづいて行います。たとえば、妥当な形式のメールアドレスとしては
  39. <code>bob@domain.com</code>、<code>bob+jones@domain.us</code>、
  40. <code>"bob@jones"@domain.com</code> および <code>"bob jones"@domain.com</code>
  41. などがあります。
  42. </para>
  43. <para>
  44. かつて使われていたものの、現在は有効とはみなされないフォーマットもあります
  45. (たとえば、メールアドレスに改行文字や "\" を使用するなど)。
  46. </para>
  47. </sect3>
  48. <sect3 id="zend.validate.set.email_address.hostnametype">
  49. <title>さまざまな形式のホスト名の検証</title>
  50. <para>
  51. メールアドレスのホスト名部分の検証は、
  52. <link linkend="zend.validate.set.hostname"><classname>Zend_Validate_Hostname</classname></link>
  53. で行います。デフォルトでは、<code>domain.com</code>
  54. 形式の DNS ホスト名のみが有効となります。しかし、
  55. IP アドレスやローカルホスト名も有効にしたいこともあるでしょう。
  56. </para>
  57. <para>
  58. その場合は、<classname>Zend_Validate_EmailAddress</classname>
  59. のインスタンスを作成する際にパラメータを渡さなければなりません。
  60. このパラメータで、認めたいホスト名の形式を指定します。
  61. 詳細は <classname>Zend_Validate_Hostname</classname> を参照ください。
  62. たとえば DNS ホスト名およびローカルホスト名のどちらも許可するには、次のようにします。
  63. </para>
  64. <programlisting language="php"><![CDATA[
  65. $validator = new Zend_Validate_EmailAddress(
  66. Zend_Validate_Hostname::ALLOW_DNS |
  67. Zend_Validate_Hostname::ALLOW_LOCAL);
  68. if ($validator->isValid($email)) {
  69. // メールアドレスは正しい形式のようです
  70. } else {
  71. // 不正な形式なので、理由を表示します
  72. foreach ($validator->getMessages() as $message) {
  73. echo "$message\n";
  74. }
  75. }
  76. ]]></programlisting>
  77. </sect3>
  78. <sect3 id="zend.validate.set.email_address.checkacceptance">
  79. <title>そのホスト名が実際にメールを受け付けるかどうかのチェック</title>
  80. <para>
  81. ただ単にメールアドレスが正しい書式であるというだけでは、
  82. そのアドレスが実際に存在するかどうかはわかりません。
  83. この問題を解決するには、MX の検証を行います。
  84. メールアドレスのホスト名に対応する DNS レコードに、MX (メール)
  85. のエントリが存在するかどうかを調べるのです。
  86. これは、そのホストがメールを受け付けているかどうかを教えてはくれますが、
  87. そのメールアドレス自体が正しいものであるかどうかを知ることはできません。
  88. </para>
  89. <para>
  90. MX のチェックはデフォルトでは無効になっており、
  91. 現時点では UNIX プラットフォームでのみサポートしています。
  92. MX のチェックを有効にするには、<classname>Zend_Validate_EmailAddress</classname>
  93. コンストラクタの 2 番目のパラメータを渡します。
  94. </para>
  95. <programlisting language="php"><![CDATA[
  96. $validator = new Zend_Validate_EmailAddress(Zend_Validate_Hostname::ALLOW_DNS,
  97. true);
  98. ]]></programlisting>
  99. <para>
  100. あるいは、<constant>TRUE</constant> または <constant>FALSE</constant> を
  101. <code>$validator->setValidateMx()</code> に渡すことで、
  102. MX の検証を有効あるいは無効にすることもできます。
  103. </para>
  104. <para>
  105. この設定を有効にすると、ネットワーク関数を用いて
  106. メールアドレスのホスト名部に対する MX レコードの存在チェックをします。
  107. これにより、スクリプトの処理速度が低下することに気をつけてください。
  108. </para>
  109. </sect3>
  110. <sect3 id="zend.validate.set.email_address.validateidn">
  111. <title>国際化ドメイン名の検証</title>
  112. <para>
  113. <classname>Zend_Validate_EmailAddress</classname> は、ドメインの中に国際文字が使われている場合も処理できます。
  114. このようなドメインは、国際化ドメイン名 (International Domain Name: IDN)
  115. と呼ばれています。これはデフォルトで有効になっていますが、無効にすることも可能です。
  116. 無効にするには、<classname>Zend_Validate_EmailAddress</classname> が内部で保持している
  117. <classname>Zend_Validate_Hostname</classname> オブジェクトの設定を変更します。
  118. </para>
  119. <programlisting language="php"><![CDATA[
  120. $validator->hostnameValidator->setValidateIdn(false);
  121. ]]></programlisting>
  122. <para>
  123. <methodname>setValidateIdn()</methodname> の詳細な使用法は、
  124. <classname>Zend_Validate_Hostname</classname> のドキュメントを参照ください。
  125. </para>
  126. <para>
  127. IDN の検証は、DNS ホスト名の検証を有効にしている場合にのみ行われることに注意しましょう。
  128. </para>
  129. </sect3>
  130. <sect3 id="zend.validate.set.email_address.validatetld">
  131. <title>トップレベルドメインの検証</title>
  132. <para>
  133. デフォルトでは、ホスト名の検証は既知の TLD の一覧に基づいて行われます。
  134. これはデフォルトで有効になっていますが、無効にすることもできます。無効にするには、
  135. 無効にするには、<classname>Zend_Validate_EmailAddress</classname> が内部で保持している
  136. <classname>Zend_Validate_Hostname</classname> オブジェクトの設定を変更します。
  137. </para>
  138. <programlisting language="php"><![CDATA[
  139. $validator->hostnameValidator->setValidateTld(false);
  140. ]]></programlisting>
  141. <para>
  142. <methodname>setValidateTld()</methodname> の詳細な使用法は、
  143. <classname>Zend_Validate_Hostname</classname> のドキュメントを参照ください。
  144. </para>
  145. <para>
  146. TLD の検証は、DNS ホスト名の検証を有効にしている場合にのみ行われることに注意しましょう。
  147. </para>
  148. </sect3>
  149. <sect3 id="zend.validate.set.email_address.setmessage">
  150. <title>メッセージの設定</title>
  151. <para>
  152. <classname>Zend_Validate_EmailAddress</classname> は、
  153. <classname>Zend_Validate_Hostname</classname> を使用してメールアドレスのホスト名部分をチェックします。
  154. Zend Framework 1.10 以降、
  155. <classname>Zend_Validate_Hostname</classname> 用のメッセージを
  156. <classname>Zend_Validate_EmailAddress</classname>
  157. から設定できるようになります。
  158. </para>
  159. <programlisting language="php"><![CDATA[
  160. $validator = new Zend_Validate_EmailAddress();
  161. $validator->setMessages(array(Zend_Validate_Hostname::UNKNOWN_TLD => 'I don't know the TLD you gave'));
  162. ]]></programlisting>
  163. <para>
  164. Zend Framework 1.10 より前のバージョンでは、まず
  165. <classname>Zend_Validate_Hostname</classname> にメッセージをアタッチしてからそれを
  166. <classname>Zend_Validate_EmailAddress</classname> に設定しないと独自のメッセージを返せませんでした。
  167. </para>
  168. </sect3>
  169. </sect2>
  170. <!--
  171. vim:se ts=4 sw=4 et:
  172. -->