White cat - Справочник по PHP
Затем скопируйте c-client/c-client.a в /usr/local/lib или какую либо другую директорию, прописанную в пути, затем скопируйте c-client/rfc822.h, mail.h и linkage.h в /usr/local/include или другую директорию с include-файлами.
Не смотря на имя модуля, имеющиеся в нем функции позволяют выполнять также много других полезных операций, выходящих за рамки простого использования протокола IMAP. Лежащая в основе библиотека C-клиента также поддерживает NNTP, POP3 и методы доступа к локальным почтовым ящикам.
imap_append
Добавляет текстовое сообщение в указанный почтовый ящик.
Синтаксис:
int imap_append(int imap_stream, string mbox, string message, stringflags);
Возвращает true в случае успеха или false иначе.
imap_append() добавляет текстовое сообщение в указанный почтовый ящик mbox. Если указаны необязательные флаги, также записывает в почтовый ящик и флаги. При общении с сервером Cyrus IMAP нужно использовать в качестве ограничителей строки "rn" вместо "n",иначе действие не выполнится.
imap_base64
Декодирует текст, закодированный с помощью BASE64.
Синтаксис:
string imap_base64(string text);
Функция imap_base64() декодирует текст в формате BASE-64. Декодированное сообщение возвращается как строка.
imap_body
Читает тело сообщения.
Синтаксис:
string imap_body(int imap_stream, int msg_number, int flags);
Функция imap_body() возвращает тело сообщения, имеющего номер п/п msg_number в текущем почтовом ящике.
Необязательные флаги это битовые маски из
imap_check
Проверяет текущий почтовый ящик.
Синтаксис:
array imap_check(int imap_stream);
Возвращает информацию о текущем почтовом ящике. В случае неуспеха возвращает FALSE.
Функция imap_check() проверяет статус текущего почтового ящика на сервере и возвращает информацию в объекте со следующими свойствами :
imap_close
Закрывает поток IMAP.
Синтаксис:
int imap_close(int imap_stream, int flags);
Закрывает поток imap. Необязательный флаг CL_EXPUNGE заставляет стереть помеченные на удаление сообщения при закрытии.
imap_createmailbox
Создает новый почтовый ящик.
Синтаксис:
int imap_createmailbox(int imap_stream, string mbox);
imap_createmailbox() создает новый почтовый ящик указанный в mbox.Возвращает true в случае успеха и false при ошибке.
imap_delete
Помечает сообщение из текущего почтового ящика на удаление.
Синтаксис:
int imap_delete(int imap_stream, int msg_number);
Возвращает true. Функция imap_delete() помечает сообщение, указанное через msg_number на удаление. Настоящее удаление сообщений осуществляется функцией imap_expunge().
imap_deletemailbox
Удаляет почтовый ящик.
Синтаксис:
int imap_deletemailbox(int imap_stream, string mbox);
Возвращает true в случае успеха и false иначе.
imap_expunge
Удаляет все сообщения, помеченные на удаление.
Синтаксис:
int imap_expunge(int imap_stream);
imap_expunge() удаляет все сообщения помеченные на удаление с помощью imap_delete().
Возвращает true.
imap_fetchbody
Извлекает простую секцию тела сообщения.
Синтаксис:
string imap_fetchbody(int imap_stream, int msg_number, int part_number, flags flags);
Эта функция заставляет извлечь подробную секцию указанного сообщения как текстовую строку. Секция это строка целых чисел, разделенных точками, которые указывают на части тела сообщения в списке частей согласно спецификации IMAP4. Части тела не декодируются этой функцией.
Необязательным параметром к imap_fetchbody() является битовая маска из
imap_fetchstructure
Читает структуру простого сообщения.
Синтаксис:
array imap_fetchstructure(int imap_stream, int msg_number);
Эта функция заставляет извлечь всю информацию о структуре сообщения с номером msg_number. Возвращаемая величина является объектом со следующими элементами :
Также функция возвращает массив объектов под названием parameters[]. Этот объект имеет следующие свойства :
value - величина
В случае сообщения из нескольких частей, функция также возвращает массив объектов всех свойств под название parts[].
imap_header
Читает заголовок сообщения.
Синтаксис:
object imap_header(int imap_stream, int msg_number, int fromlength, int subjectlength, int defaulthost);
Эта функция возвращает объект различных элементов заголовка
imap_headers
Возвращает заголовки всех сообщений в почтовом ящике.
Синтаксис:
array imap_headers(int imap_stream);
Возвращает строковый массив из информации по заголокам. Один элемент массива на сообщение.
imap_listmailbox
Читает список почтовых ящиков.
Синтаксис:
array imap_listmailbox(int imap_stream, string ref, string pat);
Возвращает массив, содержащий названия почтовых ящиков.
imap_listsubscribed
Перечисляет все подписанные ящики.
Синтаксис:
array imap_listsubscribed(int imap_stream, string ref, string pattern);
Возвращает массив всех почтовых ящиков на которые Вы подписаны. Аргументы ref и pattern указывают начальноеместорасположение откуда начинать поиск и шаблон, которому должны удовлетворять названия почтовых ящиков.
imap_mail_copy
Копирует указанные сообщения в почтовый ящик.
Синтаксис:
int imap_mail_copy(int imap_stream, string msglist, string mbox, int flags);
Возвращает true в случае успеха и false иначе.
Копирует почтовые сообщения указанные с помощью msglist в почтовый ящик mbox.
msglist - это диапазон, а не простономера сообщений.
Флаги - это битовые маски из
imap_mail_move
Переносит указанные сообщения в почтовый ящик.
Синтаксис:
int imap_mail_move(int imap_stream, string msglist, string mbox);
Переносит почтовые сообщения указанные с помощью msglist в почтовый ящик mbox.
msglist - это диапазон, а не простономера сообщений.
Возвращает true в случае успеха и false иначе.
imap_num_msg
Выдает количество сообщений в текущем почтовом ящике.
Синтаксис:
int imap_num_msg(void);
Возвращает количество сообщений в текущем почтовом ящике.
imap_num_recent
Возвращает количество недавно пришедших сообщений в текущем почтовом ящике.
Синтаксис:
int imap_num_recent(int imap_stream);
imap_open
Подключение к серверу (открытие почтового ящика).
Синтаксис:
int imap_open(string mailbox, string username, string password [, int flags]);
Функция imap_open() возвращает дескриптор почтового ящика IMAP (дескриптор подключения к серверу IMAP) или false при ошибке.
Эта функция может быть использована для открытия потоков к POP3 и NNTP серверам, но в этом случае некоторые функции будут недоступны.
Аргумент mailbox - задает имя сервера и путь к почтовому ящику. Имя сервера следует заключать в фигурные скобки "{" и "}", внутри которых должно содержаться: имя сервера (или его IP-адрес), возможно указание протокола (который начинается со слеша "/") и номера порта.
Для того, чтобы присоединиться к серверу IMAP на 143-й порт на локальной машине сделайте следующее:
$mbox = imap_open("{localhost:143}INBOX","user_id","password");
Для того, чтобы подсоединиться к POP3-серверу на 110-й порт на локальном сервере используйте:
$mbox = imap_open("{localhost/pop3:110}INBOX","user_id","password");
Для того, чтобы подсоединиться к NNTP-серверу на 119-й порт на локальном сервере используйте:
$nntp = imap_open("{localhost/nntp:119}comp.test","","");
Для того, чтобы подсоединиться к удаленному серверу замените "localhost" на имя или IP-адрес сервера к которому Вы хотите подсоединиться.
Опции - битовая маска из
imap_ping
Проверяет поток IMAP на работоспособность.
Синтаксис:
int imap_ping(int imap_stream);
Возвращает true если поток еще работоспособен и false иначе.
Функция imap_ping() проверяет поток на работоспособность. Он может также проверять новую почту; это предпочтительный метод для периодической проверки новой почты и "живучести" удаленных серверов.
imap_renamemailbox
Переименовывает старый почтовый ящик в новый.
Синтаксис:
int imap_renamemailbox(int imap_stream, string old_mbox, string new_mbox);
Эта функция переименовывает старый почтовый ящик в новый.Возвращает true в случае успеха и false иначе.
imap_reopen
Заново открывает поток IMAP на новый почтовый ящик.
Синтаксис:
int imap_reopen(string imap_stream, string mailbox, string [flags]);
Возвращает true в случае успеха и false иначе.
Эта функция заново открывает указанный поток на новый ящик.
Опции - битовая маска из
imap_subscribe
Подписывает на почтовый ящик.
Синтаксис:
int imap_subscribe(int imap_stream, string mbox);
Возвращает true в случае успеха и false иначе.
