Версия: 6.x
burger close
Открытые статические члены | Поля данных
Класс Imap

Подробное описание

-type PARTSTRUCTURE_PARAM = object{attribute:string, value?:string} -type PARTSTRUCTURE = object{ id?:string, encoding:int|mixed, partStructure:object[], parameters:PARTSTRUCTURE_PARAM[], dparameters:object{attribute:string, value:string}[], parts:array<int, object{disposition?:string}>, type:int, subtype:string }

Открытые статические члены

static append ($imap_stream, string $mailbox, string $message, string $options=null, string $internal_date=null)
 
static body ($imap_stream, int $msg_number, int $options=0)
 
static clearflag_full ($imap_stream, $sequence, string $flag, int $options=0)
 
static createmailbox ($imap_stream, string $mailbox)
 
static deletemailbox ($imap_stream, string $mailbox)
 
static expunge ($imap_stream)
 
static fetch_overview ($imap_stream, $sequence, int $options=0)
 
static fetchbody ($imap_stream, int $msg_number, $section, int $options=0)
 
static fetchheader ($imap_stream, int $msg_number, int $options=0)
 
static fetchstructure ($imap_stream, int $msg_number, int $options=0)
 
static get_quotaroot ($imap_stream, string $quota_root)
 
static getmailboxes ($imap_stream, string $ref, string $pattern)
 
static getsubscribed ($imap_stream, string $ref, string $pattern)
 
static headers ($imap_stream)
 
static listOfMailboxes ($imap_stream, string $ref, string $pattern)
 
static mail_compose (array $envelope, array $body)
 
static mail_copy ($imap_stream, $msglist, string $mailbox, int $options=0)
 
static mail_move ($imap_stream, $msglist, string $mailbox, int $options=0)
 
static mailboxmsginfo ($imap_stream)
 
static num_msg ($imap_stream)
 
static open (string $mailbox, string $username, string $password, int $options=0, int $n_retries=0, array $params=[])
 
static ping ($imap_stream)
 
static renamemailbox ($imap_stream, string $old_mbox, string $new_mbox)
 
static reopen ($imap_stream, string $mailbox, int $options=0, int $n_retries=0)
 
static savebody ($imap_stream, $file, int $msg_number, string $part_number= '', int $options=0)
 
static search ($imap_stream, string $criteria, int $options=SE_FREE, string $charset=null, bool $encodeCriteriaAsUtf7Imap=false)
 
static setflag_full ($imap_stream, $sequence, string $flag, int $options=NIL)
 
static status ($imap_stream, string $mailbox, int $options)
 
static subscribe ($imap_stream, string $mailbox)
 
static unsubscribe ($imap_stream, string $mailbox)
 
static encodeStringToUtf7Imap (string $str)
 
static decodeStringFromUtf7ImapToUtf8 (string $str)
 

Поля данных

const SORT_CRITERIA
 
const TIMEOUT_TYPES
 
const CLOSE_FLAGS
 

Методы

static append (   $imap_stream,
string  $mailbox,
string  $message,
string  $options = null,
string  $internal_date = null 
)
static
Аргументы
resource | false$imap_stream
Возвращает
true
См. также
imap_append()
static body (   $imap_stream,
int  $msg_number,
int  $options = 0 
)
static
Аргументы
false | resource$imap_stream
static clearflag_full (   $imap_stream,
  $sequence,
string  $flag,
int  $options = 0 
)
static
Аргументы
false | resource$imap_stream
int | string$sequence
Возвращает
true
static createmailbox (   $imap_stream,
string  $mailbox 
)
static
Аргументы
false | resource$imap_stream
Возвращает
true
static decodeStringFromUtf7ImapToUtf8 ( string  $str)
static

Returns the provided string in UTF-8 encoded format.

Возвращает
string $str, but UTF-8 encoded

-pure

static deletemailbox (   $imap_stream,
string  $mailbox 
)
static
Аргументы
false | resource$imap_stream
Возвращает
true
static encodeStringToUtf7Imap ( string  $str)
static

Returns the provided string in UTF7-IMAP encoded format.

Возвращает
string $str UTF-7 encoded string

-pure

static expunge (   $imap_stream)
static
Аргументы
false | resource$imap_stream
Возвращает
true
static fetch_overview (   $imap_stream,
  $sequence,
int  $options = 0 
)
static
Аргументы
false | resource$imap_stream
int | string$sequence
Возвращает
object[]

-return list<object>

-var list<object>

static fetchbody (   $imap_stream,
int  $msg_number,
  $section,
int  $options = 0 
)
static
Аргументы
false | resource$imap_stream
string | int$section
static fetchheader (   $imap_stream,
int  $msg_number,
int  $options = 0 
)
static
Аргументы
false | resource$imap_stream
static fetchstructure (   $imap_stream,
int  $msg_number,
int  $options = 0 
)
static
Аргументы
false | resource$imap_stream-return PARTSTRUCTURE

-var PARTSTRUCTURE

static get_quotaroot (   $imap_stream,
string  $quota_root 
)
static
Аргументы
false | resource$imap_stream
static getmailboxes (   $imap_stream,
string  $ref,
string  $pattern 
)
static
Аргументы
resource | false$imap_stream
Возвращает
object[]

-return list<object>

-var list<object>

static getsubscribed (   $imap_stream,
string  $ref,
string  $pattern 
)
static
Аргументы
resource | false$imap_stream
Возвращает
object[]

-return list<object>

-var list<object>

static headers (   $imap_stream)
static
Аргументы
false | resource$imap_stream
static listOfMailboxes (   $imap_stream,
string  $ref,
string  $pattern 
)
static
Аргументы
false | resource$imap_stream
Возвращает
string[]

-return list<string>

static mail_compose ( array  $envelope,
array  $body 
)
static
Аргументы
mixed[]An associative array of headers fields
mixed[]An indexed array of bodies

-param array{ subject?:string } $envelope An associative array of headers fields (docblock is not complete) -param list<array{ type?:int, encoding?:int, charset?:string, subtype?:string, description?:string, disposition?:array{filename:string} }> $body An indexed array of bodies (docblock is not complete)

-pure

static mail_copy (   $imap_stream,
  $msglist,
string  $mailbox,
int  $options = 0 
)
static
Аргументы
false | resource$imap_stream
int | string$msglist
Возвращает
true
static mail_move (   $imap_stream,
  $msglist,
string  $mailbox,
int  $options = 0 
)
static
Аргументы
false | resource$imap_stream
int | string$msglist
Возвращает
true
static mailboxmsginfo (   $imap_stream)
static
Аргументы
false | resource$imap_stream
static num_msg (   $imap_stream)
static
Аргументы
false | resource$imap_stream
static open ( string  $mailbox,
string  $username,
string  $password,
int  $options = 0,
int  $n_retries = 0,
array  $params = [] 
)
static

-param array{DISABLE_AUTHENTICATOR:string}|array<empty, empty> $params

Возвращает
resource
static ping (   $imap_stream)
static
Аргументы
resource | false$imap_stream-pure
static renamemailbox (   $imap_stream,
string  $old_mbox,
string  $new_mbox 
)
static
Аргументы
false | resource$imap_stream
Возвращает
true
static reopen (   $imap_stream,
string  $mailbox,
int  $options = 0,
int  $n_retries = 0 
)
static
Аргументы
false | resource$imap_stream
Возвращает
true
static savebody (   $imap_stream,
  $file,
int  $msg_number,
string  $part_number = '',
int  $options = 0 
)
static
Аргументы
false | resource$imap_stream
string | false | resource$file
Возвращает
true
static search (   $imap_stream,
string  $criteria,
int  $options = SE_FREE,
string  $charset = null,
bool  $encodeCriteriaAsUtf7Imap = false 
)
static
Аргументы
false | resource$imap_stream
Возвращает
int[]

-return list<int>

-var list<int>

static setflag_full (   $imap_stream,
  $sequence,
string  $flag,
int  $options = NIL 
)
static
Аргументы
false | resource$imap_stream
int | string$sequence
Возвращает
true
static status (   $imap_stream,
string  $mailbox,
int  $options 
)
static
Аргументы
false | resource$imap_stream-param SA_MESSAGES|SA_RECENT|SA_UNSEEN|SA_UIDNEXT|SA_UIDVALIDITY|SA_ALL $flags
static subscribe (   $imap_stream,
string  $mailbox 
)
static
Аргументы
false | resource$imap_stream
static unsubscribe (   $imap_stream,
string  $mailbox 
)
static
Аргументы
false | resource$imap_stream

Поля

const CLOSE_FLAGS
Инициализатор
= [
0,
CL_EXPUNGE,
]

-var list<int>

const SORT_CRITERIA
Инициализатор
= [
SORTARRIVAL,
SORTCC,
SORTDATE,
SORTFROM,
SORTSIZE,
SORTSUBJECT,
SORTTO,
]

-var list<int>

const TIMEOUT_TYPES
Инициализатор
= [
IMAP_CLOSETIMEOUT,
IMAP_OPENTIMEOUT,
IMAP_READTIMEOUT,
IMAP_WRITETIMEOUT,
]

-var list<int>