* The server part, which is enclosed in '{' and '}', consists of the servers * name or ip address, an optional port (prefixed by ':'), and an optional * protocol specification (prefixed by '/'). *

* The server part is mandatory in all mailbox * parameters. *

* All names which start with { are remote names, and are * in the form "{" remote_system_name [":" port] [flags] "}" * [mailbox_name] where: * remote_system_name - Internet domain name or * bracketed IP address of server.

* The user name *

* The password associated with the username *

* The options are a bit mask with one or more of * the following: * OP_READONLY - Open mailbox read-only

* Number of maximum connect attempts *

* Connection parameters, the following (string) keys maybe used * to set one or more connection parameters: * DISABLE_AUTHENTICATOR - Disable authentication properties

* The mailbox name, see imap_open for more * information *

* The options are a bit mask with one or more of * the following: * OP_READONLY - Open mailbox read-only

* Number of maximum connect attempts *

* If set to CL_EXPUNGE, the function will silently * expunge the mailbox before closing, removing all messages marked for * deletion. You can achieve the same thing by using * imap_expunge *

*

toaddress

full to: line, up to 1024 characters

*

to

an array of objects from the To: line, with the following properties: personal, adl, mailbox, and host

*

fromaddress

full from: line, up to 1024 characters

*

from

an array of objects from the From: line, with the following properties: personal, adl, mailbox, and host

*

ccaddress

full cc: line, up to 1024 characters

*

cc

an array of objects from the Cc: line, with the following properties: personal, adl, mailbox, and host

*

bccaddress

full bcc: line, up to 1024 characters

*

bcc

an array of objects from the Bcc: line, with the following properties: personal, adl, mailbox, and host

*

reply_toaddress

full Reply-To: line, up to 1024 characters

*

reply_to

an array of objects from the Reply-To: line, with the following properties: personal, adl, mailbox, and host

*

senderaddress

full sender: line, up to 1024 characters

*

sender

an array of objects from the Sender: line, with the following properties: personal, adl, mailbox, and host

*

return_pathaddress

full Return-Path: line, up to 1024 characters

*

return_path

an array of objects from the Return-Path: line, with the following properties: personal, adl, mailbox, and host

*

remail -

*

date

The message date as found in its headers

*

Date

Same as date

*

subject

The message subject

*

Subject

Same a subject

*

in_reply_to -

*

message_id -

*

newsgroups -

*

followup_to -

*

references -

*

Recent

R if recent and seen, N if recent and not seen, ' ' if not recent.

*

Unseen

U if not seen AND not recent, ' ' if seen OR not seen and recent

*

Flagged

F if flagged, ' ' if not flagged

*

Answered

A if answered, ' ' if unanswered

*

Deleted

D if deleted, ' ' if not deleted

*

Draft

X if draft, ' ' if not draft

*

Msgno

The message number

*

MailDate -

*

Size

The message size

*

udate

mail message date in Unix time

*

fetchfrom

from line formatted to fit fromlength characters

*

fetchsubject

subject line formatted to fit subjectlength characters

*

* The parsed headers data *

* The default host name *

* The mailbox name, see imap_open for more * information *

* The email host part *

* The name of the account owner *

* A string containing addresses *

* The default host name *

* mailbox - the mailbox name (username) * host - the host name * personal - the personal name * adl - at domain source route *

* The message number *

* The optional options are a bit mask * with one or more of the following: * FT_UID - The msg_number is a UID

* The message number *

* The body section to read *

* The message number *

* The part number. It is a string of integers delimited by period which * index into a body part list as per the IMAP4 specification *

* A bitmask with one or more of the following: * FT_UID - The msg_number is a UID

* The message number *

* The part number. It is a string of integers delimited by period which * index into a body part list as per the IMAP4 specification *

* A bitmask with one or more of the following: * FT_UID - The msg_number is a UID

* The path to the saved file as a string, or a valid file descriptor * returned by fopen. *

* The message number *

* The part number. It is a string of integers delimited by period which * index into a body part list as per the IMAP4 specification *

* A bitmask with one or more of the following: * FT_UID - The msg_number is a UID

* The message number *

* The possible options are: * FT_UID - The msgno * argument is a UID

* The message number *

* This optional parameter only has a single option, * FT_UID, which tells the function to treat the * msg_number argument as a * UID. *

* * Returned Objects for imap_fetchstructure * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *

type	Primary body type
encoding	Body transfer encoding
ifsubtype	TRUE if there is a subtype string
subtype	MIME subtype
ifdescription	TRUE if there is a description string
description	Content description string
ifid	TRUE if there is an identification string
id	Identification string
lines	Number of lines
bytes	Number of bytes
ifdisposition	TRUE if there is a disposition string
disposition	Disposition string
ifdparameters	TRUE if the dparameters array exists
dparameters	An array of objects where each object has an * "attribute" and a "value" * property corresponding to the parameters on the * Content-disposition MIME * header.
ifparameters	TRUE if the parameters array exists
parameters	An array of objects where each object has an * "attribute" and a "value" * property.
parts	An array of objects identical in structure to the top-level * object, each of which corresponds to a MIME body * part.

*

* * Primary body type (may vary with used library) * * * * * * * * *

0	text
1	multipart
2	message
3	application
4	audio
5	image
6	video
7	other

*

* * Transfer encodings (may vary with used library) * * * * * * *

0	7BIT
1	8BIT
2	BINARY
3	BASE64
4	QUOTED-PRINTABLE
5	OTHER

*/ function imap_fetchstructure(#[LanguageLevelTypeAware(['8.1' => 'IMAP\Connection'], default: 'resource')] $imap, int $message_num, int $flags = 0): stdClass|false {} /** * Clears IMAP cache * @link https://php.net/manual/en/function.imap-gc.php * @param resource $imap * @param int $flags

* Specifies the cache to purge. It may one or a combination * of the following constants: * IMAP_GC_ELT (message cache elements), * IMAP_GC_ENV (enveloppe and bodies), * IMAP_GC_TEXTS (texts). *

* The message number *

* You can set the FT_UID which tells the function * to treat the msg_number argument as an * UID. *

* The message number *

* Returns FALSE on failure. */ function imap_check(#[LanguageLevelTypeAware(['8.1' => 'IMAP\Connection'], default: 'resource')] $imap): stdClass|false {} /** * Returns the list of mailboxes that matches the given text * @link https://php.net/manual/en/function.imap-listscan.php * @param resource $imap * @param string $reference

* ref should normally be just the server * specification as described in imap_open *

* The searched string *

* msglist is a range not just message * numbers (as described in RFC2060). *

* The mailbox name, see imap_open for more * information *

* options is a bitmask of one or more of * CP_UID - the sequence numbers contain UIDS

* msglist is a range not just message numbers * (as described in RFC2060). *

* The mailbox name, see imap_open for more * information *

* options is a bitmask and may contain the single option: * CP_UID - the sequence numbers contain UIDS

* An associative array of headers fields. Valid keys are: "remail", * "return_path", "date", "from", "reply_to", "in_reply_to", "subject", * "to", "cc", "bcc", "message_id" and "custom_headers" (which contains * associative array of other headers). *

* An indexed array of bodies *

* A body is an associative array which can consist of the following keys: * "type", "encoding", "charset", "type.parameters", "subtype", "id", * "description", "disposition.type", "disposition", "contents.data", * "lines", "bytes" and "md5". *

* The mailbox name, see imap_open for more * information. Names containing international characters should be * encoded by imap_utf7_encode *

* The old mailbox name, see imap_open for more * information *

* The new mailbox name, see imap_open for more * information *

* The mailbox name, see imap_open for more * information *

* The mailbox name, see imap_open for more * information *

* The mailbox name, see imap_open for more * information *

* The mailbox name, see imap_open for more * information *

* The message to be append, as a string *

* When talking to the Cyrus IMAP server, you must use "\r\n" as * your end-of-line terminator instead of "\n" or the operation will * fail *

* If provided, the options will also be written * to the mailbox *

* If this parameter is set, it will set the INTERNALDATE on the appended message. The parameter should be a date string that conforms to the rfc2060 specifications for a date_time value. *

* The encoded text *

* A quoted-printable string *

* The 8bit string to convert *

* The 8bit string *

* A MIME encoded string. MIME encoding method and the UTF-8 * specification are described in RFC2047 and RFC2044 respectively. *

* The mailbox name, see imap_open for more * information *

* Valid flags are: * SA_MESSAGES - set $status->messages to the * number of messages in the mailbox * @return object This function returns an object containing status information. * The object has the following properties: messages, * recent, unseen, * uidnext, and uidvalidity. *

* flags is also set, which contains a bitmask which can * be checked against any of the above constants.

* Returns FALSE on failure. */ function imap_mailboxmsginfo(#[LanguageLevelTypeAware(['8.1' => 'IMAP\Connection'], default: 'resource')] $imap): stdClass {} /** * Sets flags on messages * @link https://php.net/manual/en/function.imap-setflag-full.php * @param resource $imap * @param string $sequence

* A sequence of message numbers. You can enumerate desired messages * with the X,Y syntax, or retrieve all messages * within an interval with the X:Y syntax *

* The flags which you can set are \Seen, * \Answered, \Flagged, * \Deleted, and \Draft as * defined by RFC2060. *

* A bit mask that may contain the single option: * ST_UID - The sequence argument contains UIDs * instead of sequence numbers

* A sequence of message numbers. You can enumerate desired messages * with the X,Y syntax, or retrieve all messages * within an interval with the X:Y syntax *

* The flags which you can unset are "\\Seen", "\\Answered", "\\Flagged", * "\\Deleted", and "\\Draft" (as defined by RFC2060) *

* options are a bit mask and may contain * the single option: * ST_UID - The sequence argument contains UIDs * instead of sequence numbers

* Criteria can be one (and only one) of the following: * SORTDATE - message Date

* Set this to 1 for reverse sorting *

* The options are a bitmask of one or more of the * following: * SE_UID - Return UIDs instead of sequence numbers

* The message number. *

* The message UID *

* ref should normally be just the server * specification as described in imap_open. *

* ref should normally be just the server * specification as described in imap_open *

* A message sequence description. You can enumerate desired messages * with the X,Y syntax, or retrieve all messages * within an interval with the X:Y syntax *

* sequence will contain a sequence of message * indices or UIDs, if this parameter is set to * FT_UID. *

* A string, delimited by spaces, in which the following keywords are * allowed. Any multi-word arguments (e.g. * FROM "joey smith") must be quoted. Results will match * all criteria entries. * ALL - return all messages matching the rest of the criteria

* Valid values for options are * SE_UID, which causes the returned array to * contain UIDs instead of messages sequence numbers. *

* Return FALSE if it does not understand the search * criteria or no messages have been found. *

* A modified UTF-7 encoding string, as defined in RFC 2060, section 5.1.3 (original UTF-7 * was defined in RFC1642). *

* An ISO-8859-1 string. *

* The MIME text *

* If the element hasn't been encoded, and in other words is in * plain US-ASCII, the charset property of that element is * set to default. */ function imap_mime_header_decode(string $string): array|false {} /** * Returns a tree of threaded message * @link https://php.net/manual/en/function.imap-thread.php * @param resource $imap * @param int $flags [optional] * @return array|false imap_thread returns an associative array containing * a tree of messages threaded by REFERENCES, or FALSE * on error. *

* Every message in the current mailbox will be represented by three entries * in the resulting array: *

* $thread["XX.num"] - current message number *

* $thread["XX.next"] *

* $thread["XX.branch"] *

* One of the following: * IMAP_OPENTIMEOUT, * IMAP_READTIMEOUT, * IMAP_WRITETIMEOUT, or * IMAP_CLOSETIMEOUT. *

* The timeout, in seconds. *

* If timeout is not provided or evaluates to -1, * the current timeout value of timeout_type is * returned as an integer. */ function imap_timeout(int $timeout_type, int $timeout = -1): int|bool {} /** * Retrieve the quota level settings, and usage statics per mailbox * @link https://php.net/manual/en/function.imap-get-quota.php * @param resource $imap * @param string $quota_root

* quota_root should normally be in the form of * user.name where name is the mailbox you wish to * retrieve information about. *

* As of PHP 4.3, the function more properly reflects the * functionality as dictated by the RFC2087. * The array return value has changed to support an unlimited number of returned * resources (i.e. messages, or sub-folders) with each named resource receiving * an individual array key. Each key value then contains an another array with * the usage and limit values within it. *

* For backwards compatibility reasons, the original access methods are * still available for use, although it is suggested to update. */ #[ArrayShape(["usage" => "int", "limit" => "int"])] function imap_get_quota(#[LanguageLevelTypeAware(['8.1' => 'IMAP\Connection'], default: 'resource')] $imap, string $quota_root): array|false {} /** * Retrieve the quota settings per user * @link https://php.net/manual/en/function.imap-get-quotaroot.php * @param resource $imap * @param string $mailbox

* quota_root should normally be in the form of * which mailbox (i.e. INBOX). *

* This function will return FALSE in the case of call failure, and an * array of information about the connection upon an un-parsable response * from the server. */ function imap_get_quotaroot(#[LanguageLevelTypeAware(['8.1' => 'IMAP\Connection'], default: 'resource')] $imap, string $mailbox): array|false {} /** * Sets a quota for a given mailbox * @link https://php.net/manual/en/function.imap-set-quota.php * @param resource $imap * @param string $quota_root

* The mailbox to have a quota set. This should follow the IMAP standard * format for a mailbox: user.name. *

* The maximum size (in KB) for the quota_root *

* The mailbox name, see imap_open for more * information *

* The user to give the rights to. *

* The rights to give to the user. Passing an empty string will delete * acl. *

* The mailbox name, see imap_open for more * information *

* The receiver *

* The mail subject *

* The mail body, see imap_mail_compose *

* As string with additional headers to be set on the mail *

* The receivers specified in bcc will get the * mail, but are excluded from the headers. *

* Use this parameter to specify return path upon mail delivery failure. * This is useful when using PHP as a mail client for multiple users. *

*

toaddress

full to: line, up to 1024 characters

*

to

an array of objects from the To: line, with the following properties: personal, adl, mailbox, and host

*

fromaddress

full from: line, up to 1024 characters

*

from

an array of objects from the From: line, with the following properties: personal, adl, mailbox, and host

*

ccaddress

full cc: line, up to 1024 characters

*

cc

an array of objects from the Cc: line, with the following properties: personal, adl, mailbox, and host

*

bccaddress

full bcc: line, up to 1024 characters

*

bcc

an array of objects from the Bcc: line, with the following properties: personal, adl, mailbox, and host

*

reply_toaddress

full Reply-To: line, up to 1024 characters

*

reply_to

an array of objects from the Reply-To: line, with the following properties: personal, adl, mailbox, and host

*

senderaddress

full sender: line, up to 1024 characters

*

sender

an array of objects from the Sender: line, with the following properties: personal, adl, mailbox, and host

*

return_pathaddress

full Return-Path: line, up to 1024 characters

*

return_path

an array of objects from the Return-Path: line, with the following properties: personal, adl, mailbox, and host

*

remail -

*

date

The message date as found in its headers

*

Date

Same as date

*

subject

The message subject

*

Subject

Same a subject

*

in_reply_to -

*

message_id -

*

newsgroups -

*

followup_to -

*

references -

*

Recent

R if recent and seen, N if recent and not seen, ' ' if not recent.

*

Unseen

U if not seen AND not recent, ' ' if seen OR not seen and recent

*

Flagged

F if flagged, ' ' if not flagged

*

Answered

A if answered, ' ' if unanswered

*

Deleted

D if deleted, ' ' if not deleted

*

Draft

X if draft, ' ' if not draft

*

Msgno

The message number

*

MailDate -

*

Size

The message size

*

udate

mail message date in Unix time

*

fetchfrom

from line formatted to fit fromlength characters

*

fetchsubject

subject line formatted to fit subjectlength characters

*

* ref should normally be just the server * specification as described in imap_open *

* LATT_NOINFERIORS - This mailbox contains, and may not contain any * "children" (there are no mailboxes below this one). Calling * imap_createmailbox will not work on this mailbox. *

* LATT_NOSELECT - This is only a container, * not a mailbox - you cannot open it. *

* LATT_MARKED - This mailbox is marked. This means that it may * contain new messages since the last time it was checked. Not provided by all IMAP * servers. *

* LATT_UNMARKED - This mailbox is not marked, does not contain new * messages. If either MARKED or UNMARKED is * provided, you can assume the IMAP server supports this feature for this mailbox. *

* ref should normally be just the server * specification as described in imap_open *

*
• FT_UID - The msg_number is a UID *
• FT_PEEK - Do not set the \Seen flag if not already set *
• FT_INTERNAL - The return string is in internal format, will not canonicalize to CRLF.

* @return string|false body of the specified message */ function imap_fetchtext(#[LanguageLevelTypeAware(['8.1' => 'IMAP\Connection'], default: 'resource')] $imap, int $message_num, int $flags = 0): string|false {} /** * Alias of imap_listscan * @link https://php.net/manual/en/function.imap-scan.php * @param $imap * @param $reference * @param $pattern * @param $content */ function imap_scan(#[LanguageLevelTypeAware(['8.1' => 'IMAP\Connection'], default: 'resource')] $imap, string $reference, string $pattern, string $content): array|false {} /** * Alias of imap_createmailbox * @link https://php.net/manual/en/function.imap-create.php * @param $imap * @param $mailbox */ function imap_create(#[LanguageLevelTypeAware(['8.1' => 'IMAP\Connection'], default: 'resource')] $imap, string $mailbox): bool {} /** * Alias of imap_renamemailbox * @link https://php.net/manual/en/function.imap-rename.php * @param $imap * @param $from * @param $to */ function imap_rename(#[LanguageLevelTypeAware(['8.1' => 'IMAP\Connection'], default: 'resource')] $imap, string $from, string $to): bool {} /** * Decode a modified UTF-7 string to UTF-8 * * @link https://www.php.net/manual/en/function.imap-mutf7-to-utf8.php * * @param string $string * @return string|false */ function imap_mutf7_to_utf8(string $string): string|false {} /** * Encode a UTF-8 string to modified UTF-7 * * @link https://www.php.net/manual/en/function.imap-utf8-to-mutf7.php * * @param string $string * @return string|false */ function imap_utf8_to_mutf7(string $string): string|false {} /** * @since 8.2 */ function imap_is_open(IMAP\Connection $imap): bool {} /** * @deprecated 8.1 */ define('NIL', 0); define('IMAP_OPENTIMEOUT', 1); define('IMAP_READTIMEOUT', 2); define('IMAP_WRITETIMEOUT', 3); define('IMAP_CLOSETIMEOUT', 4); define('OP_DEBUG', 1); /** * Open mailbox read-only * @link https://php.net/manual/en/imap.constants.php */ define('OP_READONLY', 2); /** * Don't use or update a .newsrc for news * (NNTP only) * @link https://php.net/manual/en/imap.constants.php */ define('OP_ANONYMOUS', 4); define('OP_SHORTCACHE', 8); define('OP_SILENT', 16); define('OP_PROTOTYPE', 32); /** * For IMAP and NNTP * names, open a connection but don't open a mailbox. * @link https://php.net/manual/en/imap.constants.php */ define('OP_HALFOPEN', 64); define('OP_EXPUNGE', 128); define('OP_SECURE', 256); /** * silently expunge the mailbox before closing when * calling imap_close * @link https://php.net/manual/en/imap.constants.php */ define('CL_EXPUNGE', 32768); /** * The parameter is a UID * @link https://php.net/manual/en/imap.constants.php */ define('FT_UID', 1); /** * Do not set the \Seen flag if not already set * @link https://php.net/manual/en/imap.constants.php */ define('FT_PEEK', 2); define('FT_NOT', 4); /** * The return string is in internal format, will not canonicalize to CRLF. * @link https://php.net/manual/en/imap.constants.php */ define('FT_INTERNAL', 8); define('FT_PREFETCHTEXT', 32); /** * The sequence argument contains UIDs instead of sequence numbers * @link https://php.net/manual/en/imap.constants.php */ define('ST_UID', 1); define('ST_SILENT', 2); define('ST_SET', 4); /** * the sequence numbers contain UIDS * @link https://php.net/manual/en/imap.constants.php */ define('CP_UID', 1); /** * Delete the messages from the current mailbox after copying * with imap_mail_copy * @link https://php.net/manual/en/imap.constants.php */ define('CP_MOVE', 2); /** * Return UIDs instead of sequence numbers * @link https://php.net/manual/en/imap.constants.php */ define('SE_UID', 1); define('SE_FREE', 2); /** * Don't prefetch searched messages * @link https://php.net/manual/en/imap.constants.php */ define('SE_NOPREFETCH', 4); define('SO_FREE', 8); define('SO_NOSERVER', 8); define('SA_MESSAGES', 1); define('SA_RECENT', 2); define('SA_UNSEEN', 4); define('SA_UIDNEXT', 8); define('SA_UIDVALIDITY', 16); define('SA_ALL', 31); /** * This mailbox has no "children" (there are no * mailboxes below this one). * @link https://php.net/manual/en/imap.constants.php */ define('LATT_NOINFERIORS', 1); /** * This is only a container, not a mailbox - you * cannot open it. * @link https://php.net/manual/en/imap.constants.php */ define('LATT_NOSELECT', 2); /** * This mailbox is marked. Only used by UW-IMAPD. * @link https://php.net/manual/en/imap.constants.php */ define('LATT_MARKED', 4); /** * This mailbox is not marked. Only used by * UW-IMAPD. * @link https://php.net/manual/en/imap.constants.php */ define('LATT_UNMARKED', 8); define('LATT_REFERRAL', 16); define('LATT_HASCHILDREN', 32); define('LATT_HASNOCHILDREN', 64); /** * Sort criteria for imap_sort: * message Date * @link https://php.net/manual/en/imap.constants.php */ define('SORTDATE', 0); /** * Sort criteria for imap_sort: * arrival date * @link https://php.net/manual/en/imap.constants.php */ define('SORTARRIVAL', 1); /** * Sort criteria for imap_sort: * mailbox in first From address * @link https://php.net/manual/en/imap.constants.php */ define('SORTFROM', 2); /** * Sort criteria for imap_sort: * message subject * @link https://php.net/manual/en/imap.constants.php */ define('SORTSUBJECT', 3); /** * Sort criteria for imap_sort: * mailbox in first To address * @link https://php.net/manual/en/imap.constants.php */ define('SORTTO', 4); /** * Sort criteria for imap_sort: * mailbox in first cc address * @link https://php.net/manual/en/imap.constants.php */ define('SORTCC', 5); /** * Sort criteria for imap_sort: * size of message in octets * @link https://php.net/manual/en/imap.constants.php */ define('SORTSIZE', 6); define('TYPETEXT', 0); define('TYPEMULTIPART', 1); define('TYPEMESSAGE', 2); define('TYPEAPPLICATION', 3); define('TYPEAUDIO', 4); define('TYPEIMAGE', 5); define('TYPEVIDEO', 6); define('TYPEMODEL', 7); define('TYPEOTHER', 8); define('ENC7BIT', 0); define('ENC8BIT', 1); define('ENCBINARY', 2); define('ENCBASE64', 3); define('ENCQUOTEDPRINTABLE', 4); define('ENCOTHER', 5); /** * Garbage collector, clear message cache elements. * @link https://php.net/manual/en/imap.constants.php */ define('IMAP_GC_ELT', 1); /** * Garbage collector, clear envelopes and bodies. * @link https://php.net/manual/en/imap.constants.php */ define('IMAP_GC_ENV', 2); /** * Garbage collector, clear texts. * @link https://php.net/manual/en/imap.constants.php */ define('IMAP_GC_TEXTS', 4);