Includes..

OBSOLETE FUNCTION should be removed after mailbox_display,

printMessage function is adapted $addr_ar = array(), $group = '' and $host='' arguments are used in 1.4.0

• deprecated: See Rfc822Address.php
• since: 1.4.0

• string $address
• integer $max

Displays error messages, if there are errors in responses to commands issues by sqimap_append() and sqimap_append_done() functions.

• since: 1.5.1 and 1.4.5

• string $response
• string $sMailbox
• $sid
• $query

Retrieve the CAPABILITY string from the IMAP server.

If capability is set, returns only that specific capability, else returns array of all capabilities.

• return: (string if $capability is set and found, false, if $capability is set and not found, array if $capability not set)

• stream $imap_stream
• string $capability: (since 1.3.0)
• boolean $bUseCache: (since 1.5.1) Controls use of capability data stored in session

This encodes a mailbox name for use in IMAP commands.

• return: the encoded mailbox string
• since: 1.5.0

• string $what: the mailbox to encode

Custom fgets function: gets a line from the IMAP server, no matter how big it may be.

• return: a line
• since: 1.2.8

• stream $imap_stream: the stream to read from

Returns the delimiter between mailboxes: INBOX/Test, or INBOX.Test

• stream $imap_stream

Gets the number of messages in the current mailbox.

OBSOLETE use sqimap_status_messages instead.

• deprecated:

• stream $imap_stream: imap stream
• string $mailbox

Logs the user into the IMAP server. If $hide is set, no error messages will be displayed (if set to 1, just exits, if set to 2, returns FALSE).

This function returns the IMAP connection handle.

• return: The IMAP connection stream, or if the connection fails, FALSE if $hide is set to 2 or an error string if $hide is set to 3.

• string $username: user name
• string $password: password encrypted with onetimepad. Since 1.5.2 function can use internal password functions, if parameter is set to boolean false.
• string $imap_server_address: address of imap server
• integer $imap_port: port of imap server
• int $hide: controls display connection errors:
  1. = do not hide
  2. = show no errors (just exit)
  3. = show no errors (return FALSE)
  4. = show no errors (return error string)
• array $stream_options: Stream context options, see config_local.php for more details (OPTIONAL)

Parses a NAMESPACE response and returns an array with the available personal, users and shared namespaces.

• return: The returned array has the following format:

   array(
     'personal' => array(
         0 => array('prefix'=>'INBOX.','delimiter' =>'.'),
         1 => ...
      ),
      'users' => array(..
      ),
      'shared' => array( ..
      )
   )

  Note that if a namespace is not defined in the server, then the corresponding array will be empty.

• string $input
• &$input

• stream $imap_stream: imap string
• string $tag_uid
• boolean $handle_errors
• array $response
• array $message
• string $query: (since 1.2.5)
• boolean $filter: (since 1.4.1) see sqimap_fread()
• mixed $outputstream: (since 1.4.1) see sqimap_fread()
• boolean $no_return: (since 1.4.1) see sqimap_fread()
• &$response
• &$message

Reads the output from the IMAP stream. If handle_errors is set to true, this will also handle all errors that are received. If it is not set, the errors will be sent back through $response and $message.

• since: 1.5.0

• stream $imap_stream: imap stream
• string $tag
• boolean $handle_errors: handle errors internally or send them in $response and $message.
• array $response
• array $message
• string $query: command that can be printed if something fails
• boolean $filter: see sqimap_fread()
• mixed $outputstream: see sqimap_fread()
• boolean $no_return: see sqimap_fread()
• &$response
• &$message

Both send a command and accept the result from the command.

This is to allow proper session number handling.

• return: returns false on imap error. displays error message if imap stream is not available.
• since: 1.2.3

• stream $imap_stream: imap connection resource
• string $query: imap command
• boolean $handle_errors: see sqimap_retrieve_imap_response()
• array $response
• array $message
• boolean $unique_id: (since 1.3.0) see sqimap_session_id().
• &$response
• &$message

Generates a new session ID by incrementing the last one used; this ensures that each command has a unique ID.

• return: IMAP session id of the form 'A000'.
• since: 1.2.0

• bool $unique_id: (since 1.3.0) controls use of unique identifiers/message sequence numbers in IMAP commands. See IMAP rfc 'UID command' chapter.

Returns the number of unseen messages in this folder.

obsoleted by sqimap_status_messages ! Arguments differ in 1.0.x

• deprecated:

• stream $imap_stream
• string $mailbox