Class IMP_Ui_Compose

The IMP_Ui_Compose:: class is designed to provide a place to store common code shared among IMP's various UI views for the compose page.

See the enclosed file COPYING for license information (GPL). If you did not receive this file, see http://www.horde.org/licenses/gpl.

Package: IMP
Category: Horde
License: GPL
Author: Michael Slusarz slusarz@horde.org
Located at Ui/Compose.php

Methods summary
`public mixed`	# `expandAddresses( string $input, IMP_Compose $imp_compose )` Expand addresses in a string. Only the last address in the string will be expanded. Expand addresses in a string. Only the last address in the string will be expanded. Parameters `$input` The input string. `$imp_compose` An IMP_Compose object. Returns `mixed` If a string, this value should be used as the new input string. If an array, the first value is the input string without the search string; the second value is the search string; and the third value is the list of matching addresses.
`public`	# `attachAutoCompleter( array $fields )` Attach the auto-completer to the current compose form. Attach the auto-completer to the current compose form. Parameters `$fields` <p>The list of DOM IDs to attach the autocompleter to.</p>
`public`	# `attachSpellChecker( )` Attach the spellchecker to the current compose form. Attach the spellchecker to the current compose form.
`public mixed`	# `getAddressList( string $addr, array $opts = array() )` Given an address input, parses the input to obtain the list of addresses to use on the compose page. Given an address input, parses the input to obtain the list of addresses to use on the compose page. Parameters `$addr` The value of the header string. `$opts` <p>Additional options: - addr_list: (boolean) Return the list of address components? DEFAULT: false</p> Returns `mixed` List of addresses, or a string of addresses if 'addr_list' is true.
`public IMP_Contents`	# `getContents( Horde_Variables $vars = null )` Create the IMP_Contents objects needed to create a message. Create the IMP_Contents objects needed to create a message. Parameters `$vars` The variables object. Returns `IMP_Contents` The IMP_Contents object. Throws `IMP_Exception`
`public IMP_Contents`	# `getIndices( Horde_Variables $vars = null )` Return the Indices object for the messages affected by this compose action. Return the Indices object for the messages affected by this compose action. Parameters `$vars` The variables object. Returns `IMP_Contents` The IMP_Contents object.
`public string`	# `mailboxReturnUrl( string $url = null )` Generate mailbox return URL. Generate mailbox return URL. Parameters `$url` The URL to use instead of the default. Returns `string` The mailbox return URL.
`public`	# `popupSuccess( )` Generate a compose message popup success window (compose.php). Generate a compose message popup success window (compose.php).
`public`	# `passphraseDialog( string $type, string $cacheid = null )` Outputs the script necessary to generate the passphrase dialog box. Outputs the script necessary to generate the passphrase dialog box. Parameters `$type` Either 'pgp', 'pgp_symm', or 'smime'. `$cacheid` Compose cache ID (only needed for 'pgp_symm').
`public array`	# `identityJs( )` Returns `array` See Horde::addInlineJsVars().
`public string`	# `convertComposeText( string $data, string $to, integer $identity )` Convert compose data to/from text/HTML. Convert compose data to/from text/HTML. Parameters `$data` The message text. `$to` Either 'text' or 'html'. `$identity` The current identity. Returns `string` The converted text
`public mixed`	# `htmlSigCallback( DOMDocument $doc, DOMNode $node )` Process DOM node (callback). Process DOM node (callback). Parameters `$doc` Document node. `$node` Node. Returns `mixed` The text to replace the node with. Returns null if regular node processing should continue.

Packages

Classes

Class IMP_Ui_Compose

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns