« imap\_num\_recentimap\_ping »PHP ManualФункції IMAP

imap_open

(PHP 4, PHP 5, PHP 7, PHP 8)

imap_open — Відкриває потік IMAP до поштової скриньки

Опис

imap_open(    string $mailbox,    string $user,    string $password,    int $flags = 0,    int $retries = 0,    array $options = []): IMAP\Connection|false

Відкриває потік IMAP до mailbox

Ця функція також може використовуватися для відкриття потоку до серверів POP3 та NNTP, але частина функцій та особливостей працюватиме лише з серверами IMAP.

Список параметрів

mailbox

Ім'я поштової скриньки складається з сервера та шляху до поштової скриньки на ньому. Спеціальне ім'я INBOX використовується для поштової скриньки поточного користувача. Імена поштових скриньок, що містять міжнародні символи, крім вхідних у друкований простір ASCII, повинні бути закодовані за допомогою imap_utf7_encode()

Увага

Якщо imap.enable_insecure_rsh не вимкнено, то передача в цей параметр не перевірених даних не безпечна

Серверна частина, укладена у фігурні дужки '{' і '}', складається з імені або IP-адреси сервера, опціонального порту (попереднього двокрапкою) та опціональних специфікацій протоколу (попередніх слешем '/').

Серверна частина є обов'язковою у всіх параметрах поштової скриньки.

Всі імена, що починаються з { є віддаленими іменами і мають такий синтаксис "{" remote_system_name [":" port] [flags] "}" [mailbox_name]где:

  • remote_system_name- Повне доменне ім'я сервера, або IP-адресу у квадратних дужках.
  • port- Необов'язковий параметр. Визначає порт сервера
  • flags- опціональні прапори, дивись таблицю нижче
  • mailbox_name- Ім'я поштової скриньки. За замовчуванням INBOX

Опціональні прапори

ФлагОпис
/service=serviceсервіс доступу до поштової скриньки. За замовчуванням "imap"
/user=userім'я користувача для входу на сервер
/authuser=userвіддалений користувач для автентифікації; якщо вказано, то це буде той користувач, пароль якого використовується (наприклад administrator)
/anonymousвіддалений доступ під анонімним користувачем
/debugзаписувати телеметрію протоколу до спеціального лог-файлу програми
/secureне передавати пароль через мережу у вигляді зашифрованого тексту
/imap/imap2/imap2bis/imap4/imap4rev1еквівалентно /service=imap
/pop3еквівалентно /service=pop3
/nntpеквівалентно /service=nntp
/norshне використовувати rsh або ssh для встановлення переавторизованої сесії IMAP
/sslвикористовувати SSL для шифрування сесії
/validate-certперевіряти сертифікати серверів TLS/SSL (поведінка за замовчуванням)
/novalidate-certне перевіряти сертифікати від серверів TLS/SSL. корисно для серверів із самопідписаним сертифікатом
/tlsпримусово використовувати start-TLS для шифрування сесії та відкидати з'єднання з серверами, що його не підтримують
/notlsне застосовувати start-TLS для шифрування сесії, навіть якщо сервер його підтримує
/readonlyзапит відкриття в режимі "тільки читання" (тільки IMAP; ігнорується для NNTP та видає помилку для SMTP та POP3)

user

Ім'я користувача

password

Пароль користувача user

flags

flags - бітова маска з однієї або кількох констант:

  • **OP_READONLY**- відкрити поштову скриньку лише для читання
  • **OP_ANONYMOUS**- не використовувати та не оновлювати .newsrc для новин (тільки NNTP)
  • **OP_HALFOPEN**- відкрити з'єднання, але не підключатися до поштової скриньки ім'я IMAP і NNTP.
  • **CL_EXPUNGE**- автоматично видаляти всі позначені для видалення повідомлення під час закриття поштової скриньки (див.imap_delete() і imap_expunge()) .
  • **OP_DEBUG**- домовленості щодо протоколу налагодження
  • **OP_SHORTCACHE**- коротке кешування (тількиelt) .
  • **OP_SILENT**- не передавати події (внутрішнє використання)
  • **OP_PROTOTYPE**- Повернути прототип драйвера
  • **OP_SECURE**- не здійснювати безпечну автентифікацію

retries

Максимальна кількість спроб з'єднання

options

Параметри для з'єднання. Для встановлення одного або декількох параметрів з'єднання можна використовувати такі (рядки) ключі:

  • DISABLE_AUTHENTICATOR- забороняє властивості автентифікації

Значення, що повертаються

У разі успішного виконання повертає екземпляр IMAP\Connectionили**false**в случае возникновения ошибки.

список змін

ВерсияОпис
8.1.0Повертає екземпляр IMAP\Connection; раніше повертався ресурс (resource

Приклади

Приклад #1 Різні способи використання imap_open()

Loading...

Приклад #2 Приклад використання imap_open()****

Loading...

Дивіться також