| Свойство | Тип | Описание | |
|---|---|---|---|
| $EOL | |||
| $blob | |||
| $blobOctetsLeft | |||
| $lines | |||
| $searchFlags | array | IMAP flags to search criteria | |
| $state |
| Метод | Описание | |
|---|---|---|
| auth ( $cb, $login, $password ) | ||
| countMessages ( $cb, null $flags = null ) | Count messages all messages in current box | |
| createFolder ( $cb, string $folder, $parentFolder = null ) : boolean | create a new folder (and parent folders if needed) | |
| getRawContent ( $cb, $uid, $byUid = true ) | * Get raw content of message or part | |
| getRawHeader ( $cb, $uid, $byUid = true ) | * Get raw header of message or part | |
| getRawMessage ( $cb, integer $uid, $byUid = true ) | Fetch a message | |
| getSize ( $cb, integer $uid = null ) | get a list of messages with number and size | |
| getUniqueId ( $cb, integer | null $id = null ) | get unique id for one or all messages | |
| listFolders ( $cb, string $reference = '', string $mailbox = '*' ) | ||
| logout ( $cb = null ) | logout of imap server | |
| onFinish ( ) | ||
| onRead ( ) | ||
| onReady ( ) | ||
| removeFolder ( $cb, $folder ) | remove a folder | |
| removeMessage ( $cb, integer $uid ) | Remove a message from server. | |
| renameFolder ( $cb, string $oldName, string $newName ) | rename and/or move folder | |
| selectBox ( $cb, string $box = 'INBOX' ) |
| Метод | Описание | |
|---|---|---|
| decodeCount ( array $lines ) | ||
| decodeGetUniqueId ( array $lines ) | ||
| decodeLine ( string $line ) : array | split a given line in tokens. a token is literal of any form or a list | |
| decodeList ( array $lines ) | ||
| decodeSize ( $lines ) | * | |
| escapeList ( array $list ) : string | escape a list with literals or lists | |
| escapeString ( $string ) : string | escape a single literal | |
| expunge ( string $tag = self::TAG_EXPUNGE ) | ||
| fetch ( array $items, string $from, string $to = null, boolean $uid = false, string $tag = self::TAG_FETCH ) | ||
| onCommand ( string $tag, string $type, string $line, array $lines, string $blob ) | ||
| searchMessages ( array $params, string $tag = self::TAG_SEARCH ) | ||
| startsWith ( string $haystack, string $needle ) | ||
| store ( array $flags, string $from, string $to = null, string $mode = null, boolean $silent = true, string $tag = self::TAG_STORE ) |
| public countMessages ( $cb, null $flags = null ) | ||
| $flags | null | |
| public createFolder ( $cb, string $folder, $parentFolder = null ) : boolean | ||
| $folder | string | folder name |
| Результат | boolean | success |
| protected decodeLine ( string $line ) : array | ||
| $line | string | line to decode |
| Результат | array | tokens, literals are returned as string, lists as array |
| protected escapeList ( array $list ) : string | ||
| $list | array | list with literals or lists as PHP array |
| Результат | string | escaped list for imap |
| protected escapeString ( $string ) : string | ||
| $string | ||
| Результат | string | escaped list for imap |
| public getRawContent ( $cb, $uid, $byUid = true ) | ||
| $uid | number of message | |
| public getRawHeader ( $cb, $uid, $byUid = true ) | ||
| $uid | unique number of message | |
| public getRawMessage ( $cb, integer $uid, $byUid = true ) | ||
| $uid | integer | unique number of message |
| public getUniqueId ( $cb, integer | null $id = null ) | ||
| $id | integer | null | message number |
| public listFolders ( $cb, string $reference = '', string $mailbox = '*' ) | ||
| $reference | string | |
| $mailbox | string | |
| public removeMessage ( $cb, integer $uid ) | ||
| $uid | integer | unique number of message |
| public renameFolder ( $cb, string $oldName, string $newName ) | ||
| $oldName | string | name or instance of folder |
| $newName | string | new global name of folder |
| protected searchMessages ( array $params, string $tag = self::TAG_SEARCH ) | ||
| $params | array | |
| $tag | string | |
| protected startsWith ( string $haystack, string $needle ) | ||
| $haystack | string | |
| $needle | string | |
| protected array $searchFlags | ||
| Результат | array | |
