/functions/imap_general.php

Description

imap_general.php

This implements all functions that do general IMAP functions.

Includes
require_once (SM_PATH.'functions/auth.php') (line 17)
require_once (SM_PATH.'functions/page_header.php') (line 16)

Includes..

Functions
map_yp_alias (line 955)

This is an example that gets IMAP servers from yellowpages (NIS).

you can simple put map:map_yp_alias in your $imap_server_address in config.php use your own function instead map_yp_alias to map your LDAP whatever way to find the users IMAP server.

void map_yp_alias ( $username)
  • $username
parseAddress (line 696)
void parseAddress ( $address, [ $max = 0])
  • $address
  • $max
sqimap_append (line 896)

Saves a message to a given folder -- used for saving sent messages

void sqimap_append ( $imap_stream,  $sent_folder,  $length)
  • $imap_stream
  • $sent_folder
  • $length
sqimap_append_checkresponse (line 908)
void sqimap_append_checkresponse ( $response,  $folder)
  • $response
  • $folder
sqimap_append_done (line 902)
void sqimap_append_done ( $imap_stream, [ $folder = ''])
  • $imap_stream
  • $folder
sqimap_capability (line 608)

Retreive the CAPABILITY string from the IMAP server.

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

void sqimap_capability ( $imap_stream, [ $capability = ''])
  • $imap_stream
  • $capability
sqimap_fgets (line 86)

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

  • return: a line
string sqimap_fgets (mixed $imap_stream)
sqimap_fread (line 106)
void sqimap_fread ( $imap_stream,  $iSize, [ $filter = false], [ $outputstream = false], [ $no_return = false])
  • $imap_stream
  • $iSize
  • $filter
  • $outputstream
  • $no_return
sqimap_get_delimiter (line 638)

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

void sqimap_get_delimiter ([ $imap_stream = false])
  • $imap_stream
sqimap_get_num_messages (line 686)

Gets the number of messages in the current mailbox.

void sqimap_get_num_messages ( $imap_stream,  $mailbox)
  • $imap_stream
  • $mailbox
sqimap_get_user_server (line 941)
void sqimap_get_user_server ( $imap_server,  $username)
  • $imap_server
  • $username
sqimap_login (line 436)

Logs the user into the IMAP server. If $hide is set, no error messages will be displayed. This function returns the IMAP connection handle.

void sqimap_login ( $username,  $password,  $imap_server_address,  $imap_port,  $hide)
  • $username
  • $password
  • $imap_server_address
  • $imap_port
  • $hide
sqimap_logout (line 596)

Simply logs out the IMAP session

void sqimap_logout (mixed $imap_stream)
sqimap_read_data (line 409)
void sqimap_read_data ( $imap_stream,  $tag_uid,  $handle_errors,  &$response,  &$message, [ $query = ''], [ $filter = false], [ $outputstream = false], [ $no_return = false])
  • $imap_stream
  • $tag_uid
  • $handle_errors
  • &$response
  • &$message
  • $query
  • $filter
  • $outputstream
  • $no_return
sqimap_read_data_list (line 164)

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.

void sqimap_read_data_list ( $imap_stream,  $tag_uid,  $handle_errors,  &$response,  &$message, [ $query = ''], [ $filter = false], [ $outputstream = false], [ $no_return = false])
  • $imap_stream
  • $tag_uid
  • $handle_errors
  • &$response
  • &$message
  • $query
  • $filter
  • $outputstream
  • $no_return
sqimap_run_command (line 58)
void sqimap_run_command ( $imap_stream,  $query,  $handle_errors,  &$response,  &$message, [ $unique_id = false], [ $filter = false], [ $outputstream = false], [ $no_return = false])
  • $imap_stream
  • $query
  • $handle_errors
  • &$response
  • &$message
  • $unique_id
  • $filter
  • $outputstream
  • $no_return
sqimap_run_command_list (line 40)

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

This is to allow proper session number handling.

void sqimap_run_command_list ( $imap_stream,  $query,  $handle_errors,  &$response,  &$message, [ $unique_id = false])
  • $imap_stream
  • $query
  • $handle_errors
  • &$response
  • &$message
  • $unique_id
sqimap_session_id (line 26)

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'.
string sqimap_session_id ([mixed $unique_id = FALSE])
sqimap_status_messages (line 872)

Returns the number of unseen/total messages in this folder

void sqimap_status_messages ( $imap_stream,  $mailbox)
  • $imap_stream
  • $mailbox
sqimap_unseen_messages (line 856)

Returns the number of unseen messages in this folder.

void sqimap_unseen_messages ( $imap_stream,  $mailbox)
  • $imap_stream
  • $mailbox

Documentation generated on Sat, 07 Oct 2006 16:31:36 +0300 by phpDocumentor 1.3.0RC6