Mail_mimeDecode::decode()

Mail_mimeDecode::decode() – デコードを実行する

Synopsis

require_once 'Mail/mimeDecode.php';

object decode ( array $args = = null )

Description

この関数は、 メッセージデータの構造内容のデコードを実行、結果を返します。

Parameter

  • array $args - 関数の引数配列です。

    • boolean $args['include_bodies'] - 返される構造にメール本体も含むかどうかを指定します。

    • boolean $args['decode_bodies'] - 返される構造のメール本体をデコードするかどうかを指定します。

    • boolean $args['decode_headers'] - ヘッダのデコードをするかどうかを指定します。 (RFC2047).

    • string $args['input'] - もし静的に呼ばれた場合、 デコードすべきデータの入力を指定します。

    • string $args['crlf'] - もし静的に呼ばれた場合、 行末に使用する文字タイプを指定します。

Return value

object -

  • array $return->headers - an associative array of the headers. The keys of the array are the header names (lowercased) whilst the values are the header values (original case). If there are multiple headers with the same name (eg. Received: ) then the value is a numerically indexed array of each of the header values. If the parameter decode_headers is specified as TRUE, the headers will be decoded according to RFC 2047.

  • string $return->ctype_primary - the first part of the content type (ie. before the forward slash). Eg. if the content type is multipart/mixed, ctype_primary would be "multipart".

  • string $return->ctype_secondary - the second part of the content type. Eg. If the content type is multipart/mixed, ctype_secondary would be "mixed".

  • array $return->ctype_parameters - if the content type header has any parameters (eg. boundary="=_hudfhdsalfhds8fy8329hfj") then they will be in this associative array. Keys are the parameter name (eg. boundary) whilst the values are the parameter values (eg. =_hudfhdsalfhds8fy8329hfj).

  • string $return->disposition - if the Content-Disposition header is present, its value will be given here. This is usually either "inline" or "attachment".

  • array $return->d_parameters - if any parameters are given with the Content-Disposition header, they will be given here in an associative array, keys being the parameter names and values being the parameter values. "name" and "filename" are two common examples here.

  • array $return->body - if the include_bodies parameter is given when instanciating the class, (either statically or via a concrete instance), then this will be present if the part in question has a body. MIME parts with content type multipart/* generally do not not have bodies, instead consisting of subparts. If the parameter decode_bodies is specified as TRUE then the body will be decoded.

  • array $return->parts - if a MIME part consists of subparts, then this array will be present consisting of objects with the same properties as described here.

Throws

Possible PEAR_Error values
エラーコード エラーメッセージ 意味 解決策
NULL " 静的に呼ばれたか、引数が与えられていない " You called the function statically and forgot to fill $args['input'] 総ての$args['input']を埋めるか、 静的にこの関数を呼ばないでください。
NULL その他 エラーメッセージを見てください。 入力されたメッセージ、 またはメッセージパートがMIME標準に準じていません。

Note

This function can be called statically.

コンストラクタ (Previous) UUコードデータのデコード (Next)
Last updated: Fri, 01 Aug 2014 — Download Documentation
Do you think that something on this page is wrong? Please file a bug report or add a note.
View this page in:

User Notes:

There are no user contributed notes for this page.