| 프로퍼티 | 타입 | 설명 | |
|---|---|---|---|
| $_data | array | Internal data array. |
| 메소드 | 설명 | |
|---|---|---|
| bodyPart ( string $id, array $opts = [] ) | Return the body part data for a MIME ID. | |
| bodyPartSize ( string $id ) | Returns the decoded body part size for a MIME ID. | |
| bodyText ( array $opts = [] ) | Return body text. | |
| contains ( integer $criteria ) : boolean | Does the query contain the given criteria? | |
| count ( ) | ||
| current ( ) | ||
| envelope ( ) | Return envelope header data. | |
| flags ( ) | Return flags set for the message. | |
| fullText ( array $opts = [] ) | Get the full text of the message. | |
| hash ( ) : string | Returns a hash of the current query object. | |
| headerText ( array $opts = [] ) | Return header text. | |
| headers ( string $label, array $search, array $opts = [] ) | Returns RFC 2822 header text that matches a search string. | |
| imapDate ( ) | Return the internal (IMAP) date of the message. | |
| key ( ) | ||
| mimeHeader ( string $id, array $opts = [] ) | Return MIME header text. | |
| modseq ( ) | Return the mod-sequence value for the message. | |
| next ( ) | ||
| offsetExists ( $offset ) | ||
| offsetGet ( $offset ) | ||
| offsetSet ( $offset, $value ) | ||
| offsetUnset ( $offset ) | ||
| remove ( integer $criteria, string $key ) | Remove an entry under a given criteria. | |
| rewind ( ) | ||
| seq ( ) | Return the sequence number of the message. | |
| size ( ) | Return the size (in bytes) of the message. | |
| structure ( ) | Return MIME structure information. | |
| uid ( ) | Return the unique ID of the message. | |
| valid ( ) |
| public bodyPart ( string $id, array $opts = [] ) | ||
| $id | string | The MIME ID to obtain the body part text for. |
| $opts | array | The following options are available: - decode: (boolean) Attempt to server-side decode the bodypart data if it is MIME transfer encoded. DEFAULT: false - length: (integer) The length of the substring to return. DEFAULT: The entire text is returned. - peek: (boolean) If set, does not set the '\Seen' flag on the message. DEFAULT: The seen flag is set. - start: (integer) If a portion of the full text is desired to be returned, the starting position is identified here. DEFAULT: The entire text is returned. |
| public bodyPartSize ( string $id ) | ||
| $id | string | The MIME ID to obtain the decoded body part size for. |
| public bodyText ( array $opts = [] ) | ||
| $opts | array | The following options are available: - id: (string) The MIME ID to obtain the body text for. DEFAULT: The body text for the entire message will be returned. - length: (integer) The length of the substring to return. DEFAULT: The entire text is returned. - peek: (boolean) If set, does not set the '\Seen' flag on the message. DEFAULT: The seen flag is set. - start: (integer) If a portion of the full text is desired to be returned, the starting position is identified here. DEFAULT: The entire text is returned. |
| public fullText ( array $opts = [] ) | ||
| $opts | array | The following options are available: - length: (integer) The length of the substring to return. DEFAULT: The entire text is returned. - peek: (boolean) If set, does not set the '\Seen' flag on the message. DEFAULT: The seen flag is set. - start: (integer) If a portion of the full text is desired to be returned, the starting position is identified here. DEFAULT: The entire text is returned. |
| public headerText ( array $opts = [] ) | ||
| $opts | array | The following options are available: - id: (string) The MIME ID to obtain the header text for. DEFAULT: The header text for the base message will be returned. - length: (integer) The length of the substring to return. DEFAULT: The entire text is returned. - peek: (boolean) If set, does not set the '\Seen' flag on the message. DEFAULT: The seen flag is set. - start: (integer) If a portion of the full text is desired to be returned, the starting position is identified here. DEFAULT: The entire text is returned. |
| public headers ( string $label, array $search, array $opts = [] ) | ||
| $label | string | A unique label associated with this particular search. This is how the results are stored. |
| $search | array | The search string(s) (case-insensitive). |
| $opts | array | The following options are available: - cache: (boolean) If true, and 'peek' is also true, will cache the result of this call. DEFAULT: false - id: (string) The MIME ID to search. DEFAULT: The base message part - length: (integer) The length of the substring to return. DEFAULT: The entire text is returned. - notsearch: (boolean) Do a 'NOT' search on the headers. DEFAULT: false - peek: (boolean) If set, does not set the '\Seen' flag on the message. DEFAULT: The seen flag is set. - start: (integer) If a portion of the full text is desired to be returned, the starting position is identified here. DEFAULT: The entire text is returned. |
| public mimeHeader ( string $id, array $opts = [] ) | ||
| $id | string | The MIME ID to obtain the MIME header text for. |
| $opts | array | The following options are available: - length: (integer) The length of the substring to return. DEFAULT: The entire text is returned. - peek: (boolean) If set, does not set the '\Seen' flag on the message. DEFAULT: The seen flag is set. - start: (integer) If a portion of the full text is desired to be returned, the starting position is identified here. DEFAULT: The entire text is returned. |
| public modseq ( ) |
