Difference between revisions of "GetDisplayPreferences()"

Latest revision as of 12:55, 22 August 2008

This function will return the display settings for a particular mailbox. The available settings are:

 compose_new_win => 0 for compose in same window, 1 for compose in new window
 autocomplete_enabled => 0 if disabled, 1 if email address auto-completion is enabled
 compose_window_type => html to use html compostion, plain for plain text
 use_emoticons => 0 if conversion of emoticons into pictures is disabled, 1 if enabled-- like :) for smiley
 show_html_default => 0 will show plain text version of message by default, 1 will show html
 attachment_show_images => 0 if putting attached message inline with message is disabled, 1 if enabled; html only
 use_previewPane => 0 if the preview pane is disabled when looking at message list, 1 if enabled
 show_num_msgs => 50 -- the number of messages to show in a page when looking at the message list
 wrap_at => -- usually blank to default at 86 characters; how many characters to show on a single line
 hour_format => -- blank or 2 means use 12 hour default, 1 means use 24 hour format
 timezone => -- blank means use U.S. Eastern as the default
 reply_citation_style => "No citation","Original message","Author said","On date, author said", and "User-defined"
 reply_citation_start => if style "User-defined" from above, what text should start the citation
 reply_citation_end => if style "User-defined" from above, what text should end the citation

Input Parameters

Four strings and one result array:

   Administrative username,
   Administrative password,
   Domain name,
   User ID (the portion of the email address before the @ symbol),

   Display preferences array (see above for details)000

Return Values

If successful, the return value of the function will be 1.

Consult the Result Code Table for a list of result codes and their meaning.