IMP external API interface.
This file defines IMP's external API interface. Other applications
can interact with IMP through this API.
Copyright 2009-2012 Horde LLC (http://www.horde.org/)
See the enclosed file COPYING for license information (GPL). If you
did not receive this file, see http://www.horde.org/licenses/gpl.
Methods summary
public
Horde_Url
|
#
compose( string|array $args = array(), array $extra = array() )
Returns a compose window link.
Returns a compose window link.
Parameters
- $args
- <p>List of arguments to pass to compose.php.
If this is passed in as a string, it will be
parsed as a
toaddress?subject=foo&cc=ccaddress
(mailto-style) string.</p>
- $extra
- <p>Hash of extra, non-standard arguments to
pass to compose.php.</p>
Returns
Horde_Url
The link to the message composition screen.
|
public
array
|
#
batchCompose( string|array $args = array(), array $extra = array() )
Return a list of compose window links.
Return a list of compose window links.
Parameters
- $args
- <p>List of arguments to pass to compose.php.
If this is passed in as a string, it will be
parsed as a
toaddress?subject=foo&cc=ccaddress
(mailto-style) string.</p>
- $extra
- <p>List of hashes of extra, non-standard
arguments to pass to compose.php.</p>
Returns
arrayThe list of Horde_Url objects with links to the message
composition screen.
|
public
array
|
#
folderlist( )
Returns the list of folders.
Returns the list of folders.
Returns
arrayThe list of IMAP folders. Keys are the IMAP mailbox
name (UTF7-IMAP). Values have the following keys:
- label: (string) Human readable label.
- level: (integer) The child level of this element.
|
public
string
|
#
createFolder( string $folder, array $options = array() )
Creates a new folder.
Parameters
- $folder
- The name of the folder to create (UTF7-IMAP).
- $options
- <p>Additional options:
- full: (boolean) If true, $folder is a full mailbox name. If false,
$folder will be created in the default namespace.
Available since IMP 5.0.11
DEFAULT: false</p>
Returns
string
The full folder name created or false on failure.
Throws
|
public
integer|boolean
|
#
deleteMessages( string $mailbox, array $indices )
Deletes messages from a mailbox.
Deletes messages from a mailbox.
Parameters
- $mailbox
- The name of the mailbox (UTF7-IMAP).
- $indices
- The list of UIDs to delete.
Returns
integer|booleanThe number of messages deleted if successful,
false if not.
|
public
boolean
|
#
copyMessages( string $mailbox, array $indices, string $target )
Copies messages to a mailbox.
Copies messages to a mailbox.
Parameters
- $mailbox
- The name of the source mailbox (UTF7-IMAP).
- $indices
- The list of UIDs to copy.
- $target
- The name of the target mailbox (UTF7-IMAP).
Returns
boolean
True if successful, false if not.
|
public
boolean
|
#
moveMessages( string $mailbox, array $indices, string $target )
Moves messages to a mailbox.
Moves messages to a mailbox.
Parameters
- $mailbox
- The name of the source mailbox (UTF7-IMAP).
- $indices
- The list of UIDs to move.
- $target
- The name of the target mailbox (UTF7-IMAP).
Returns
boolean
True if successful, false if not.
|
public
boolean
|
#
flagMessages( string $mailbox, array $indices, array $flags, boolean $set )
Flag messages.
Parameters
- $mailbox
- The name of the source mailbox (UTF7-IMAP).
- $indices
- The list of UIDs to flag.
- $flags
- The flags to set.
- $set
- True to set flags, false to clear flags.
Returns
boolean
True if successful, false if not.
|
public
array
|
#
searchMailbox( string $mailbox, Horde_Imap_Client_Search_Query $query )
Perform a search query on the remote IMAP server.
Perform a search query on the remote IMAP server.
Parameters
- $mailbox
- <p>The name of the source
mailbox (UTF7-IMAP).</p>
- $query
- The query object.
Returns
array
The search results (UID list).
|
public
mixed
|
#
server( )
Returns information on the currently logged on IMAP server.
Returns information on the currently logged on IMAP server.
Returns
mixedAn array with the following entries:
'hostspec' - (string) The server hostname.
'port' - (integer) The server port.
'protocol' - (string) Either 'imap' or 'pop'.
'secure' - (string) Either 'none', 'ssl', or 'tls'.
|
public
array
|
#
favouriteRecipients( integer $limit, array $filter = array('new', 'forward', 'reply', 'redirect') )
Returns the list of favorite recipients.
Returns the list of favorite recipients.
Parameters
- $limit
- Return this number of recipients.
- $filter
- <p>A list of messages types that should be
returned. Valid types: 'forward', 'mdn', 'new',
'reply', and 'redirect'. A value of null returns
all message types.</p>
Returns
array
A list with the $limit most favourite recipients.
Throws
|
public
Horde_Imap_Client_Base
|
#
imapOb( )
Returns the Horde_Imap_Client object created using the IMP credentials.
Returns the Horde_Imap_Client object created using the IMP credentials.
Returns
Horde_Imap_Client_Base
The imap object.
|
public
array
|
#
flagList( string $mailbox = null )
Return the list of user-settable IMAP flags.
Return the list of user-settable IMAP flags.
Parameters
- $mailbox
- <p>If set, returns the list of flags filtered by
what the mailbox allows.</p>
Returns
array
A list of IMP_Flag_Base objects.
|
IMP_Api