A collection of settings that apply to the web client at the user level.
Inheritance Hierarchy
Ipswitch.Messaging.FrameworkSettings
Ipswitch.Messaging.FrameworkWebClientUserSettings
Namespace: Ipswitch.Messaging.Framework
Assembly: Ipswitch.Messaging.Framework (in Ipswitch.Messaging.Framework.dll) Version: 1.0.0.0
Syntax
The WebClientUserSettings type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
| WebClientUserSettings |
Initializes a new instance of the WebClientUserSettings class, which acts as a collection of user-level settings that apply to the web client.
|
Methods
| Name | Description | |
|---|---|---|
| Add(ISetting) | (Inherited from Settings.) | |
| AddT(String, T) | (Inherited from Settings.) | |
| Clear | (Inherited from Settings.) | |
| Contains(String) | (Inherited from Settings.) | |
| Contains(ISetting) | (Inherited from Settings.) | |
| CopyTo | (Inherited from Settings.) | |
| Equals | (Inherited from Object.) | |
| GetT | (Inherited from Settings.) | |
| GetEnumerator | (Inherited from Settings.) | |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
| GetType | Gets the Type of the current instance. (Inherited from Object.) | |
| Remove(String) | (Inherited from Settings.) | |
| Remove(ISetting) | (Inherited from Settings.) | |
| SetT | (Inherited from Settings.) | |
| ToString | (Inherited from Object.) |
Properties
| Name | Description | |
|---|---|---|
| AlternateEmailAddress | ||
| AlternateFromAddresses |
Gets or sets a value that allows the user to sent messages that appear to come from an address other than their actual one.
| |
| AlwaysRequestReadReceipt |
Gets or sets a value indicating whether or not a read receipt should always be requested when sending a message. If PIM is disabled, it will disable Calendars, Notes, and Tasks in the Web Client.
| |
| AutoSaveDraftFrequency |
Gets or sets a value that indicates how often the compose page will save messages being composed as a draft.
| |
| AutoSuggestRecipients |
Gets or sets a value indicating whether or not the web client should automatically suggest recipients to the user while composing.
| |
| CalendarDayEndTime |
Gets or sets a time offset from midnight indicating the time each day that the calendar should use as a cut-off when hiding late appointments. Any appointments after this time will normally be hidden. The user can still view appointments after this time by requesting to see the entire day.
| |
| CalendarDayStartTime |
Gets or sets a time offset from midnight indicating the time each day that the calendar should use as a cut-off when hiding early appointments. Any appointments before this time will normally be hidden. The user can still view appointments before this time by requesting to see the entire day.
| |
| CalendarDisplayDeleteConfirmation |
Gets or sets a value that indicates whether a confirmation dialog will appear asking users if they are sure they wish to delete the calendar item.
| |
| CalendarEnableReminders |
Gets or sets a value that indicates whether reminders will pop up for calendar items.
| |
| CalendarFirstDayOfWeek |
Gets or sets a value that indicates which day of the week should appear at the beginning of each week.
| |
| CalendarInitialView |
Gets or set a value that controls what field will be used to sort a contact list.
| |
| CalendarMinutesPerRow |
Gets or sets a value that specifies the number of minutes each row in the calendar should represent.
| |
| CalendarMultiDayNumber |
Gets or sets a value that specifies the number of days to display in the calendar multiview.
| |
| CalendarShowAllDayRow |
Gets or sets a value that indicates whether or not the All Day row should be displayed on the user's calendars.
| |
| CalendarWorkDayEndTime |
Gets or sets a time offset from midnight indicating the time each day that the calendar should treat as the end of a typical work day.
| |
| CalendarWorkDayStartTime |
Gets or sets a time offset from midnight indicating the time each day that the calendar should treat as the start of a typical work day.
| |
| CheckMailLocation |
Gets or sets a value that indicates whether the webclient will check for new mail in all of the user's folders or only in the user's inbox.
| |
| ConfirmMessageDeletes |
Gets or sets a value that indicates whether or not to present a confirmation message to the user when messages are deleted.
| |
| ContactsSortField |
Gets or set a value that controls what field will be used to sort a contact list.
| |
| Count | (Inherited from Settings.) | |
| DefaultAddressBookFolder |
Gets or sets a value that indicates which folder should be used as the default contact folder by the web client.
| |
| DefaultCalendar |
Gets or sets a string that contains the id of the folder that will be shown by default in dropdowns when multiple calendars exist.
| |
| DefaultMessageEncodingName |
Gets or sets the name of a code page for an Encoding that will be used as the
default whenever an Encoding is needed for the User in the web client.
| |
| DisplayBccInCompose |
Gets or sets a value that indicates whether or not the web client will show the BCC field by default when composing a new message.
| |
| DisplayCcInCompose |
Gets or sets a value that indicates whether or not the web client will show the CC field by default when composing a new message.
| |
| DisplayCheckboxesInGrids |
Gets or sets a value indicating whether or not checkboxes should be displayed by grids in the web client user interface.
| |
| DisplayName |
Gets or sets a string that is the Name to be used for this user in the web client. This is the name that will be used in outgoing messages or anywhere else that a friendly name string for the user is needed in the web client.
| |
| DisplayQuickCompose |
Gets or sets a value that indicates whether or not the compose link is display by itself on the menu or under the actions menu option.
| |
| EnableColumnFiltering |
Gets or sets a value indicating whether or not column filters are allowed to display in the web client's user interface.
| |
| Enabled |
Gets or sets a value that indicates whether or not a user is allowed to access the web client.
| |
| EnableDSTAdjustment |
Gets or sets a value that indicates whether or not a daylight savings time will be applied to any dates/times.
| |
| EnableEmptySubjectWarning |
Gets or sets a value that indicates whether or not the web client will warn the user if a message being sent contains an empty subject.
| |
| EnableMissingAttachmentsWarning |
Gets or sets a value that indicates whether or not the web client will warn the user if a message contains no attachments, but contains text implying that one should be there.
| |
| FailedLoginAttempts |
Gets or sets a value that indicates how many times the User has attempted and failed to log in to the web client since the last successful login.
| |
| IncludeAttachmentsWithForwards |
Gets or sets a value that indicates whether or not forwards will contain any attachments found in the original message.
| |
| IncludeAttachmentsWithReplies |
Gets or sets a value that indicates whether or not replies will contain any attachments found in the original message.
| |
| IncludeGroupsInAutoSuggestion |
Gets or sets a value that indicates whether or not group contacts should be included when message recipients are auto-suggested by the web client.
| |
| IncludeInlineImagesAsDownloadableAttachments |
Gets or sets a value indicating whether or not checkboxes should be displayed by grids in the web client user interface.
| |
| IncludeOriginalMessageInForwards |
Gets or sets a value that indicates whether or not forwards will contain the original message.
| |
| IncludeOriginalMessageInReplies |
Gets or sets a value that indicates whether or not replies will contain the original message.
| |
| InitialFolderToDisplay |
Gets or sets a value indicating the user folder that will be initially displayed when the user logs in.
| |
| InsertSignatureIntoForwards |
Gets or sets a value that indicates whether or not forwarded messages will have the user's signature inserted into them.
| |
| InsertSignatureIntoReplies |
Gets or sets a value that indicates whether or not replies will have the user's signature inserted into them.
| |
| IsReadOnly | (Inherited from Settings.) | |
| Item | (Inherited from Settings.) | |
| LastFailedLogin |
Gets or sets a DateTimeOffset that marks the last date and time that the user attempted to log in to the web client and failed.
| |
| LastLogin |
Gets or sets a DateTimeOffset that marks the last date and time that the user successfully logged in to the web client.
| |
| Lockouts |
Gets or sets a value that indicates how many times the User has been locked out of the web client due to too many failed attempts to log in since the last successful login.
| |
| MailCheckFrequency |
Gets or sets a value that indicates how often the webclient will check for new messages.
| |
| NewMessageAlertBlinkCount |
Gets or sets a value that indicates how many times the webclient should blink when alerting the user that new messages have arrived.
| |
| NewMessageFormat |
Gets or sets a value that indicates whether new messages should default to HTML or Plain Text.
| |
| NewMessageSoundExternalUrl |
Gets or sets a URI that can be used to locate a sound file to play when new messages arrive. If null, then the default sound file will be used by the web client.
| |
| NewMessagesPlaySound |
Gets or sets a value that indicates whether or not the webclient should play a sound when new messages arrive.
| |
| NewMessagesShowAlert |
Gets or sets a value that indicates whether or not the webclient should do something to notify the user when new messages arrive.
| |
| NewMessagesShowNotification |
Gets or set a value that indicates whether or not the webclient will display a new messages notification.
| |
| OnlyShowUnread |
Gets or sets a value that indicates whether or not the message list will display unread messages only.
| |
| PagingAlwaysVisible |
Gets or sets a value indicating whether or not paging will be shown when there is only one page of results.
| |
| PagingLocation |
Gets or sets a value indicating where to display the paging buttons.
| |
| PagingNumberPerPage |
Gets or sets a value that specifies the number of message list items to display per page.
| |
| PagingShowTextAlongsideButtons |
Gets or sets a value indicating whether or not text will be show beside the paging buttons.
| |
| PagingStyle |
Gets or sets a value indicating what type of paging buttons to display for the message list.
| |
| PasswordChangeRequired |
Gets or sets a value indicating whether or not the web client should require that the user change their password.
| |
| PimEnabled |
Gets or sets a value indicating whether or not Personal Information Management is enabled or
disabled. If PIM is disabled, it will disable Calendars, Notes, and Tasks in the Web Client.
| |
| PurgeMessageOnDelete |
Gets or sets a value that indicates whether or not deleted messages should be purged from the user's folders instead of being moved to a special folder for deleted items. If true, deleted items will be removed instead of moved.
| |
| ReadingPaneLocation |
Gets or sets a value indicating where to display the reading pane.
| |
| ReadReceiptResponseAction |
Gets or sets a value that indicates which of the options in the ReadReceiptResponseAction enum should be taken when a read receipt has been requested for a message.
| |
| SaveMessagesInSentFolder |
Gets or sets a value that indicates whether or not the web client should save a copy of messages that are sent.
| |
| SaveRecipientsAsContacts |
Gets or sets a value that indicates whether or not the web client should automatically save message recipients in the user's contact list.
| |
| Signature |
Gets or sets a string that can be automatically appended to the bottom of new messages composed in the web client.
| |
| SpamConfirmBeforeReport |
Gets or sets a value that indicates whether or not a confirmation dialog will appear before a message is reported as spam.
| |
| SpamFolder |
Gets or sets a value indicating the id of user folder that will be used as a spam folder.
| |
| SpamReportAction |
Gets or sets a value that indicates what will happen to messages after they are reported as spam.
| |
| SuppressExternalImages |
Gets or sets a value indicating whether or not images should be suppressed when displaying messages in the web client.
| |
| SuppressJavascript |
Gets or sets a value indicating whether or not scripts should be suppressed when displaying messages in the web client.
| |
| Suspended |
Gets or sets a value that indicates whether or not a user's access to the web client has been suspended. Web client access is usually suspended due to exceeding the maximum allowed login attempts.
| |
| ThemeName |
Gets or sets a value that controls which theme the webclient uses.
| |
| TimezoneOffset |
Gets or sets the time offset for the user's time zone used by the web client.
|
See Also