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 page.
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 page.</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 page.
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 page.</p>
Returns
arrayThe list of Horde_Url objects with links to the message
composition screen.
|
public
array
|
#
mailboxList( )
Returns the list of mailboxes.
Returns the list of mailboxes.
Returns
arrayThe list of IMAP mailboxes. A list of arrays with the
following keys:
- d: (string) The namespace delimiter.
- label: (string) Human readable label (UTF-8).
- level: (integer) The child level of this element.
- ob: (Horde_Imap_Client_Mailbox) A mailbox object.
- subscribed: (boolean) True if mailbox is subscribed (@since 6.2.0).
|
public
Horde_Imap_Client_Mailbox
|
#
createMailbox( string $mbox, array $options = array() )
Creates a new mailbox.
Parameters
- $mbox
- The name of the mailbox to create (UTF-8).
- $options
- <p>Additional options:
- full: (boolean) If true, $mbox is a full mailbox name. If false,
$mbox will be created in the default namespace.
DEFAULT: false</p>
Returns
Horde_Imap_Client_MailboxThe mailbox 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 (UTF-8).
- $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 (UTF-8).
- $indices
- The list of UIDs to copy.
- $target
- The name of the target mailbox (UTF-8).
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 (UTF-8).
- $indices
- The list of UIDs to move.
- $target
- The name of the target mailbox (UTF-8).
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 (UTF-8).
- $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
|
#
addFlags( array $flags )
Ensures a list of user-defined IMAP flag(s) for the current user exist.
Silently ignores any flags that are already defined.
Ensures a list of user-defined IMAP flag(s) for the current user exist.
Silently ignores any flags that are already defined.
Parameters
- $flags
- An array of user-defined flag names.
Since
6.3.0
|
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 (UTF-8).</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
|
#
logRecipient( string $reason, string|array $recipients, string $message_id, boolean $success = true )
Log an entry to the IMP_Sentmail system.
Log an entry to the IMP_Sentmail system.
Parameters
- $reason
- <p>$action The performed action. One of:
- forward
- mdn
- new
- redirect
- reply</p>
- $recipients
- The message recipients.
- $message_id
- The Message-ID.
- $success
- Was the message successfully sent?
|
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 (UTF-8).</p>
Returns
array
A list of IMP_Flag_Base objects.
Since
6.3.0
|
public
@see
|
#
getSpecialMailboxes( )
Return the list of special mailboxes.
Return the list of special mailboxes.
Returns
@see
IMP_Mailbox::getSpecialMailboxes()
|
public
Horde_History_Log
|
#
getMaillog( string $mid )
Obtain the Maillog for a given message.
Obtain the Maillog for a given message.
Parameters
- $mid
- The Message-ID to obtain the log for.
Returns
Horde_History_Log
The log object.
Since
6.1.0
|
public
|
#
logMaillog( string $action, string $mid, string $data = null )
Log an entry in the Maillog.
Log an entry in the Maillog.
Parameters
- $action
- The action to log.
- $mid
- The Message-ID.
- $data
- Additional data.
Since
6.1.0
|
public
array
|
#
getMaillogChanges( integer $ts )
Returns a list of Message-IDs that have been added to the Maillog since
the specified timestamp.
Returns a list of Message-IDs that have been added to the Maillog since
the specified timestamp.
Parameters
- $ts
- <p>The timestamp to start searching from. Only entries
after this timestamp will be returned.</p>
Returns
array
An array of Message-IDs that have been changed since $ts.
Since
6.1.0
|
IMP_Api