<?xml version="1.0"?>
<doc>
<assembly>
<name>UserAPI</name>
</assembly>
<members>
<member name="T:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_ForwardToEmail">
<summary>
The UserMessageRuleAction_ForwardToEmail object represents user message rule "Forward To Email" action in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionBase">
<summary>
This is base class for user mesage rule actions.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionBase.m_ValuesChanged">
<summary>
Holds flag if some values are changed.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionBase.#ctor(LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_enum,LumiSoft.MailServer.API.UserAPI.UserMessageRule,LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection,System.String,System.String)">
<summary>
Default constructor.
</summary>
<param name="actionType">Specifies action type.</param>
<param name="rule">Onwer rule that owns this action.</param>
<param name="owner">Owner UserMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionBase.Commit">
<summary>
Tries to save all changed values to server. Throws Exception if fails.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionBase.Serialize">
<summary>
Serialices action object.
</summary>
<returns>Returns serialized action data.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionBase.Owner">
<summary>
Gets owner UserMessageRuleActionCollection that owns this action.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionBase.ID">
<summary>
Gets user message rule action action ID.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionBase.ActionType">
<summary>
Get user message rule action type.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionBase.Description">
<summary>
Gets or sets action description text.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_ForwardToEmail.#ctor(LumiSoft.MailServer.API.UserAPI.UserMessageRule,LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection,System.String,System.String,System.Byte[])">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner UserMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="actionData">Action data.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_ForwardToEmail.#ctor(LumiSoft.MailServer.API.UserAPI.UserMessageRule,LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection,System.String,System.String,System.String)">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner UserMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="email">Email address where to forward message.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_ForwardToEmail.Serialize">
<summary>
Serialices action object.
</summary>
<returns>Returns serialized action data.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_ForwardToEmail.HasChanges">
<summary>
Gets if this object has changes what isn't stored to mail server by calling Commit().
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_ForwardToEmail.EmailAddress">
<summary>
Gets or sets email address where to forward message.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_PostToHttp">
<summary>
The UserMessageRuleAction_PostToHttp object represents user message rule "Post To HTTP" action in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_PostToHttp.#ctor(LumiSoft.MailServer.API.UserAPI.UserMessageRule,LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection,System.String,System.String,System.Byte[])">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner UserMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="actionData">Action data.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_PostToHttp.#ctor(LumiSoft.MailServer.API.UserAPI.UserMessageRule,LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection,System.String,System.String,System.String)">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner UserMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="url">HTTP URL where to post message.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_PostToHttp.Serialize">
<summary>
Serialices action object.
</summary>
<returns>Returns serialized action data.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_PostToHttp.HasChanges">
<summary>
Gets if this object has changes what isn't stored to mail server by calling Commit().
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_PostToHttp.Url">
<summary>
Gets or sets HTTP URL where to post message.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.ServerReturnMessages">
<summary>
The ServerReturnMessages object represents server return messages in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.ServerReturnMessages.#ctor(LumiSoft.MailServer.API.UserAPI.System_Settings,LumiSoft.MailServer.API.UserAPI.ServerReturnMessage,LumiSoft.MailServer.API.UserAPI.ServerReturnMessage)">
<summary>
Default constructor.
</summary>
<param name="sysSettings">Reference to system settings.</param>
<param name="delayedDeliveryWarning">Delayed delivery warning message template.</param>
<param name="undelivered">Undelivered notice message template</param>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.ServerReturnMessages.DelayedDeliveryWarning">
<summary>
Gets or sets message template what is sent when message delayed delivery, immediate delivery failed.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.ServerReturnMessages.Undelivered">
<summary>
Gets or sets message template what is sent when message delivery has failed.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.IMAP_Settings">
<summary>
The IMAP_Settings object represents IMAP settings in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.IMAP_Settings.#ctor(LumiSoft.MailServer.API.UserAPI.System_Settings,System.Boolean,System.String,System.String,System.Int32,System.Int32,System.Int32,System.Int32,LumiSoft.MailServer.API.UserAPI.BindInfo[])">
<summary>
Default constructor.
</summary>
<param name="sysSettings">Reference to system settings.</param>
<param name="enabled">Specifies if IMAP service is enabled.</param>
<param name="hostName">Host name.</param>
<param name="greeting">Greeting text.</param>
<param name="idleTimeout">Session idle timeout seconds.</param>
<param name="maxConnections">Maximum conncurent connections.</param>
<param name="maxConnectionsPerIP">Maximum conncurent connections fro 1 IP address.</param>
<param name="maxBadCommands">Maximum bad commands per session.</param>
<param name="bindings">Specifies IMAP listening info.</param>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.IMAP_Settings.Enabled">
<summary>
Gets or sets if IMAP server is enabled.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.IMAP_Settings.HostName">
<summary>
Gets or sets IMAP host name reported to connected clients. If "", then machine NETBIOS name used.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.IMAP_Settings.GreetingText">
<summary>
Gets or sets greeting text reported to connected clients. If "", default server greeting text is used.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.IMAP_Settings.SessionIdleTimeOut">
<summary>
Gets or sets how many seconds session can idle before timed out.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.IMAP_Settings.MaximumConnections">
<summary>
Gets or sets maximum conncurent connections server accepts.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.IMAP_Settings.MaximumConnectionsPerIP">
<summary>
Gets or sets maximum conncurent connections from 1 IP address. Value 0, means unlimited connections.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.IMAP_Settings.MaximumBadCommands">
<summary>
Gets or sets maximum bad commands can happen before server terminates connection.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.IMAP_Settings.Binds">
<summary>
Gets IP bindings.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.VirtualServerCollection">
<summary>
The VirtualServerCollection object represents LumiSoft Mail Server virtual servers.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.VirtualServerCollection.#ctor(LumiSoft.MailServer.API.UserAPI.Server)">
<summary>
Default constructor.
</summary>
<param name="parent">Server object that is the parent of this object.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.VirtualServerCollection.GetVirtualServerAPIs">
<summary>
Gets available virtual server API infos.
</summary>
<returns></returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.VirtualServerCollection.Add(System.Boolean,System.String,System.String,System.String,System.String)">
<summary>
Adds new virtual server to virtual server collection.
</summary>
<param name="enabled">Specified if virtual server is enabled.</param>
<param name="name">Virtual server name.</param>
<param name="assembly">Assembly name what contains virtual server API.</param>
<param name="type">Full virtual server API type name.</param>
<param name="initString">Virtual server API init string. This value depends on API implementation.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.VirtualServerCollection.Remove(LumiSoft.MailServer.API.UserAPI.VirtualServer)">
<summary>
Removes specified virtual server from mail server.
</summary>
<param name="server">Virtual server to remove.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.VirtualServerCollection.Bind">
<summary>
Gets server virtual servers and binds them to this, if not binded already.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.VirtualServerCollection.GetEnumerator">
<summary>
Gets enumerator.
</summary>
<returns></returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.VirtualServerCollection.Server">
<summary>
Gets the Server object that is the owner of this collection.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.VirtualServerCollection.Count">
<summary>
Gets number of virtual servers in server.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.VirtualServerCollection.Item(System.Int32)">
<summary>
Gets a VirtualServer object in the collection by index number.
</summary>
<param name="index">An Int32 value that specifies the position of the VirtualServer object in the VirtualServerCollection collection.</param>
<returns>A VirtualServer object value that represents the virtual server.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.VirtualServerCollection.Item(System.String)">
<summary>
Gets a VirtualServer object in the collection by virtual server ID.
</summary>
<param name="virtualServerID">A String value that specifies the virtual server ID of the VirtualServer object in the VirtualServerCollection collection.</param>
<returns>A VirtualServer object value that represents the virtual server.</returns>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_StoreToFtp">
<summary>
The UserMessageRuleAction_StoreToFtp object represents user message rule "Store To FTP Folder" action in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_StoreToFtp.#ctor(LumiSoft.MailServer.API.UserAPI.UserMessageRule,LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection,System.String,System.String,System.Byte[])">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner USerMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="actionData">Action data.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_StoreToFtp.#ctor(LumiSoft.MailServer.API.UserAPI.UserMessageRule,LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection,System.String,System.String,System.String,System.Int32,System.String,System.String,System.String)">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner UserMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="host">FTP server where to store message.</param>
<param name="port">FTP server port.</param>
<param name="userName">FTP server user name.</param>
<param name="password">FTP server user password.</param>
<param name="folder">FTP folder where to store message.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_StoreToFtp.Serialize">
<summary>
Serialices action object.
</summary>
<returns>Returns serialized action data.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_StoreToFtp.HasChanges">
<summary>
Gets if this object has changes what isn't stored to mail server by calling Commit().
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_StoreToFtp.Server">
<summary>
Gets or sets FTP server where to store message.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_StoreToFtp.Port">
<summary>
Gets or sets FTP server port.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_StoreToFtp.UserName">
<summary>
Gets or sets FTP server user name.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_StoreToFtp.Password">
<summary>
Gets or sets FTP server user password.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_StoreToFtp.Folder">
<summary>
Gets or sets FTP folder where to store message.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_ExecuteProgram">
<summary>
The UserMessageRuleAction_ExecuteProgram object represents user message rule "Execute Program" action in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_ExecuteProgram.#ctor(LumiSoft.MailServer.API.UserAPI.UserMessageRule,LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection,System.String,System.String,System.Byte[])">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner UserMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="actionData">Action data.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_ExecuteProgram.#ctor(LumiSoft.MailServer.API.UserAPI.UserMessageRule,LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection,System.String,System.String,System.String,System.String)">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner UserMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="program">Program to execute.</param>
<param name="programArgs">Executable program arguments.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_ExecuteProgram.Serialize">
<summary>
Serialices action object.
</summary>
<returns>Returns serialized action data.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_ExecuteProgram.HasChanges">
<summary>
Gets if this object has changes what isn't stored to mail server by calling Commit().
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_ExecuteProgram.Program">
<summary>
Gets or sets program to execute.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_ExecuteProgram.ProgramArguments">
<summary>
Gets or sets executable program arguments.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.SipRegistrationContact">
<summary>
This class represents SIP registration contact.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.SipRegistrationContact.#ctor(System.String,System.Int32,System.Double)">
<summary>
Default constructor.
</summary>
<param name="contactUri">Contact URI.</param>
<param name="exprires">Seconds after how many seconds this contact will expire.</param>
<param name="priority">Contact priority.</param>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SipRegistrationContact.ContactUri">
<summary>
Gets contact URI.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SipRegistrationContact.Expires">
<summary>
Gets after how many seconds this contact will expire.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SipRegistrationContact.Priority">
<summary>
Gets contact priority. Higer value means higher priority.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.RouteCollection">
<summary>
The RouteCollection object represents route groups in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.RouteCollection.#ctor(LumiSoft.MailServer.API.UserAPI.VirtualServer)">
<summary>
Default constructor.
</summary>
<param name="virtualServer">Owner virtual server.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.RouteCollection.Add(System.String,System.String,System.Boolean,LumiSoft.MailServer.API.UserAPI.RouteActionBase)">
<summary>
Creates and adds new route to route collection.
</summary>
<param name="description">Route description text.</param>
<param name="pattern">Route pattern.</param>
<param name="enabled">Specifies if route is enabled.</param>
<param name="action">Route action.</param>
<returns></returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.RouteCollection.Remove(LumiSoft.MailServer.API.UserAPI.Route)">
<summary>
Deletes and removes specified route from route collection.
</summary>
<param name="route">Route to delete.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.RouteCollection.Contains(System.String)">
<summary>
Check if collection contains route with specified ID.
</summary>
<param name="routeID">Route ID.</param>
<returns></returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.RouteCollection.ContainsPattern(System.String)">
<summary>
Check if collection contains route with route pattern.
</summary>
<param name="pattern">Route pettern.</param>
<returns></returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.RouteCollection.GetRouteByPattern(System.String)">
<summary>
Gets a Route object in the collection by route pattern.
</summary>
<param name="pattern">Route pattern.</param>
<returns>A Route object value that represents the route in virtual server.</returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.RouteCollection.Refresh">
<summary>
Refreshes routes.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.RouteCollection.Bind">
<summary>
Gets server groups and binds them to this.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.RouteCollection.GetEnumerator">
<summary>
Gets enumerator.
</summary>
<returns></returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.RouteCollection.VirtualServer">
<summary>
Gets the VirtualServer object that is the owner of this collection.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.RouteCollection.Count">
<summary>
Gets number of routes in virtual server.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.RouteCollection.Item(System.Int32)">
<summary>
Gets a Route object in the collection by index number.
</summary>
<param name="index">An Int32 value that specifies the position of the Route object in the RouteCollection collection.</param>
<returns>A Route object value that represents the route in virtual server.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.RouteCollection.Item(System.String)">
<summary>
Gets a Route object in the collection by group ID.
</summary>
<param name="routeID">A String value that specifies the group ID of the Route object in the RouteCollection collection.</param>
<returns>A Route object value that represents the route in virtual server.</returns>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.Relay_Settings">
<summary>
The Relay_Settings object represents Relay settings in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.Relay_Settings.#ctor(LumiSoft.MailServer.API.UserAPI.System_Settings,System.Boolean,System.String,System.Int32,System.Boolean,System.String,System.String,System.String,System.String,System.String,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean,System.String)">
<summary>
Default constructor.
</summary>
<param name="sysSettings">Reference to system settings.</param>
<param name="useSmartHost">Specifies if smart host is used for relaying.</param>
<param name="smartHost">Smart host name or ip.</param>
<param name="smartHostPort">Smart host port.</param>
<param name="smrtHostSSL">Specifies if smart host is connected via SSL.</param>
<param name="smartHostUserName">Smart host user name.</param>
<param name="dns1">DNS server.</param>
<param name="dns2">DNS server.</param>
<param name="smartHostPassword">Smart host password.</param>
<param name="hostName">Host name reported to connected server.</param>
<param name="idleTimeout">Session idle timeout seconds.</param>
<param name="maxConnections">Maximum conncurent conncetions.</param>
<param name="maxConnectionsPerIP">Maximum conncurent conncetions to one IP address.</param>
<param name="relayInterval">Relay messages interval seconds.</param>
<param name="relayRetryInterval">Relay retry messages interval seconds.</param>
<param name="undeliveredWarning">Specifies after how many minutes delayed delivery message is sent.</param>
<param name="undelivered">Specifies after how many hours undelivered notification message is sent.</param>
<param name="storeUndelivered">Specifies if undelivered messages are stored to "Undelivered" folder in mail store.</param>
<param name="bindIP">IP addresss what is used to send out relay messages.</param>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Relay_Settings.UseSmartHost">
<summary>
Gets or sets if relay send emails thorugh smart host or directly using dns.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Relay_Settings.SmartHost">
<summary>
Gets or sets smart host to use for sending relay messages.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Relay_Settings.SmartHostPort">
<summary>
Gets or sets smart host server port.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Relay_Settings.SmartHostSsl">
<summary>
Gets or sets if smart host connected via SSL.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Relay_Settings.SmartHostUserName">
<summary>
Gets or sets smart host server user name.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Relay_Settings.SmartHostPassword">
<summary>
Gets or sets smart host server password.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Relay_Settings.Dns1">
<summary>
Gets or sets DNS server.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Relay_Settings.Dns2">
<summary>
Gets or sets DNS server.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Relay_Settings.HostName">
<summary>
Gets or sets EHLO/HELO host name reported to connected server. If "", then machine NETBIOS name used.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Relay_Settings.SessionIdleTimeOut">
<summary>
Gets or sets how many seconds session can idle before times out.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Relay_Settings.MaximumConnections">
<summary>
Gets or sets maximum concurent connections allowed to send out messages.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Relay_Settings.MaximumConnectionsPerIP">
<summary>
Gets or sets maximum concurent connections allowed to one destination IP.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Relay_Settings.RelayInterval">
<summary>
Gets or sets interval seconds.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Relay_Settings.RelayRetryInterval">
<summary>
Gets or sets relay retry messages interval seconds.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Relay_Settings.SendUndeliveredWarningAfter">
<summary>
Gets or sets after how many minutes delayed delivery message is sent.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Relay_Settings.SendUndeliveredAfter">
<summary>
Gets or sets after how many hours undelivered notification is sent.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Relay_Settings.StoreUndeliveredMessages">
<summary>
Gets or sets if undelivered messages are stored to "Undelivered" folder in mail store.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Relay_Settings.BindIP">
<summary>
Gets or sets IP addresss what is used to send out relay messages.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.MailingListAclCollection">
<summary>
The MailingListAclCollection object represents mailing list access list in mailing list.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.MailingListAclCollection.#ctor(LumiSoft.MailServer.API.UserAPI.MailingList)">
<summary>
Default constructor.
</summary>
<param name="mailingList">Owner mailing list.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.MailingListAclCollection.Add(System.String)">
<summary>
Adds specified ACL entry to mailing list.
</summary>
<param name="userOrGroup">User or group.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.MailingListAclCollection.Remove(System.String)">
<summary>
Deletes specified ACL entry from mailing list.
</summary>
<param name="userOrGroup">User or group.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.MailingListAclCollection.Bind">
<summary>
Gets server mailing list members and binds them to this, if not binded already.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.MailingListAclCollection.GetEnumerator">
<summary>
Gets enumerator.
</summary>
<returns></returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.MailingListAclCollection.Count">
<summary>
Gets number of ACL entries on that mailing list.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.MailingListAclCollection.Item(System.Int32)">
<summary>
Gets a ACL entry in the collection by index number.
</summary>
<param name="index">An Int32 value that specifies the position of the ACL entry in the MailingListAclCollection collection.</param>
<returns></returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.MailingListAclCollection.Item(System.String)">
<summary>
Gets a ACL entry in the collection by ACL entry name.
</summary>
<param name="aclEntry">A String value that specifies the ACL entry name in the MailingListAclCollection collection.</param>
<returns></returns>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.IPSecurityAction_enum">
<summary>
Specifiess IP security action.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.IPSecurityAction_enum.Allow">
<summary>
Allow access.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.IPSecurityAction_enum.Deny">
<summary>
Deny access.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.GroupMemberCollection">
<summary>
The GroupMemberCollection object represents group members in group.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GroupMemberCollection.#ctor(LumiSoft.MailServer.API.UserAPI.Group)">
<summary>
Default constructor.
</summary>
<param name="group">Owner group.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GroupMemberCollection.Add(System.String)">
<summary>
Adds specified user or group to members collection.
</summary>
<param name="userOrGroup">User or group to add.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GroupMemberCollection.Remove(System.String)">
<summary>
Deletes specified user or group from mebers collection.
</summary>
<param name="userOrGroup">User or group to delete.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GroupMemberCollection.Contains(System.String)">
<summary>
Check if collection contains group member with specified name.
</summary>
<param name="member">Member name.</param>
<returns></returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GroupMemberCollection.Bind">
<summary>
Gets server group members and binds them to this, if not binded already.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GroupMemberCollection.GetEnumerator">
<summary>
Gets enumerator.
</summary>
<returns></returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GroupMemberCollection.Count">
<summary>
Gets number of members on that group.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GroupMemberCollection.Item(System.Int32)">
<summary>
Gets a group member in the collection by index number.
</summary>
<param name="index">An Int32 value that specifies the position of the group member in the GroupMemberCollection collection.</param>
<returns></returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GroupMemberCollection.Item(System.String)">
<summary>
Gets a group member in the collection by group member name.
</summary>
<param name="member">A String value that specifies the group member name in the GroupMemberCollection collection.</param>
<returns></returns>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_ForwardToEmail">
<summary>
The GlobalMessageRuleAction_PostToHttp object represents global message rule "Forward To Email" action in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionBase">
<summary>
This is base class for global mesage rule actions.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionBase.m_ValuesChanged">
<summary>
Holds flag if some values are changed.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionBase.#ctor(LumiSoft.MailServer.API.UserAPI.GlobalMessageRule,LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection,System.String,System.String)">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that owns this action.</param>
<param name="owner">Owner GlobalMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionBase.Commit">
<summary>
Tries to save all changed values to server. Throws Exception if fails.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionBase.Serialize">
<summary>
Serialices action object.
</summary>
<returns>Returns serialized action data.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionBase.Owner">
<summary>
Gets owner GlobalMessageRuleActionCollection that owns this action.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionBase.ID">
<summary>
Gets global message rule action action ID.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionBase.ActionType">
<summary>
Get global message rule action type.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionBase.Description">
<summary>
Gets or sets action description text.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_ForwardToEmail.#ctor(LumiSoft.MailServer.API.UserAPI.GlobalMessageRule,LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection,System.String,System.String,System.Byte[])">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner GlobalMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="actionData">Action data.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_ForwardToEmail.#ctor(LumiSoft.MailServer.API.UserAPI.GlobalMessageRule,LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection,System.String,System.String,System.String)">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner GlobalMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="email">Email address where to forward message.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_ForwardToEmail.Serialize">
<summary>
Serialices action object.
</summary>
<returns>Returns serialized action data.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_ForwardToEmail.ActionType">
<summary>
Get global message rule action type.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_ForwardToEmail.HasChanges">
<summary>
Gets if this object has changes what isn't stored to mail server by calling Commit().
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_ForwardToEmail.EmailAddress">
<summary>
Gets or sets email address where to forward message.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.GlobalMessageRule">
<summary>
The GlobalMessageRule object represents global message rule in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRule.#ctor(LumiSoft.MailServer.API.UserAPI.VirtualServer,LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleCollection,System.String,System.Int64,System.Boolean,System.String,System.String,LumiSoft.MailServer.API.UserAPI.GlobalMessageRule_CheckNextRule_enum)">
<summary>
Default constructor.
</summary>
<param name="virtualServer">Owner virtual server.</param>
<param name="owner">Owner GlobalMessageRuleCollection collection that owns this rule.</param>
<param name="id">Global message rule ID.</param>
<param name="cost">Specifies global message rule process oreder number.</param>
<param name="enabled">Specifies if global message rule is enabled.</param>
<param name="description">Global message rule description.</param>
<param name="matchexpression">Global message rule match expression.</param>
<param name="checkNext">Specifies when next rule is checked.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRule.Commit">
<summary>
Tries to save all changed values to server. Throws Exception if fails.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRule.VirtualServer">
<summary>
Gets the VirtualServer object that is the owner of this group.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRule.Owner">
<summary>
Gets owner GlobalMessageRuleCollection that owns this rule.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRule.HasChanges">
<summary>
Gets if this object has changes what isn't stored to mail server by calling Commit().
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRule.ID">
<summary>
Gets global message rule ID.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRule.Cost">
<summary>
Gets or sets if user message rule cost. Cost specifies in what order rules are processes,
rules with lower value are proecessed firts.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRule.Enabled">
<summary>
Gets or sets if global message rule is enabled.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRule.Description">
<summary>
Gets or sets global message rule description.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRule.MatchExpression">
<summary>
Gets or sets match expression.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRule.CheckNextRule">
<summary>
Gets or sets when next rule is checked.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRule.Actions">
<summary>
Gets global message rule actions.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.FilterCollection">
<summary>
The FilterCollection object represents filters in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.FilterCollection.#ctor(LumiSoft.MailServer.API.UserAPI.VirtualServer)">
<summary>
Default constructor.
</summary>
<param name="virtualServer">Owner virtual server.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.FilterCollection.GetFilterTypes">
<summary>
Gets available filters info.
</summary>
<returns></returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.FilterCollection.Add(System.Boolean,System.String,System.String,System.String)">
<summary>
Adds new filter to virtual server.
</summary>
<param name="enabled">Specifies if filter is enabled.</param>
<param name="description">Filter description.</param>
<param name="assembly">Filter assembly.</param>
<param name="filterClass">Filter class.</param>
<returns></returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.FilterCollection.Remove(LumiSoft.MailServer.API.UserAPI.Filter)">
<summary>
Removes specified filter from virtual server.
</summary>
<param name="filter">Filter to remove.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.FilterCollection.ToArray">
<summary>
Copies collection to array.
</summary>
<returns></returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.FilterCollection.Refresh">
<summary>
Refreshes filters.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.FilterCollection.Bind">
<summary>
Gets server filters and binds them to this, if not binded already.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.FilterCollection.GetEnumerator">
<summary>
Gets enumerator.
</summary>
<returns></returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.FilterCollection.VirtualServer">
<summary>
Gets the VirtualServer object that is the owner of this collection.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.FilterCollection.Count">
<summary>
Gets number of filters in virtual server.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.FilterCollection.Item(System.Int32)">
<summary>
Gets a Filter object in the collection by index number.
</summary>
<param name="index">An Int32 value that specifies the position of the Filter object in the FilterCollection collection.</param>
<returns>A Filter object value that represents the filter in virtual server.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.FilterCollection.Item(System.String)">
<summary>
Gets a Filter object in the collection by filter ID.
</summary>
<param name="filterID">A String value that specifies the filter ID of the Filter object in the FilterCollection collection.</param>
<returns>A Filter object value that represents the filter in virtual server.</returns>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.Utils">
<summary>
Provides internal helper methods.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.Utils.DecompressDataSet(System.IO.Stream)">
<summary>
Decompresses specified DataSet data what is compressed with GZIP.
</summary>
<param name="source">Stream to decompress.</param>
<returns>Returns decompressed DataSet.</returns>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.UserRemoteServerCollection">
<summary>
The UserRemoteServerCollection object represents remote servers in user.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserRemoteServerCollection.#ctor(LumiSoft.MailServer.API.UserAPI.User)">
<summary>
Default constructor.
</summary>
<param name="user">Owner user.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserRemoteServerCollection.Add(System.String,System.String,System.Int32,System.Boolean,System.String,System.String,System.Boolean)">
<summary>
Adds new remote server for owner user.
</summary>
<param name="description">Remote server description.</param>
<param name="host">Remote server host name or IP.</param>
<param name="port">Remote server port.</param>
<param name="ssl">Specifies if connected to remote server via SSL.</param>
<param name="userName">Remote server user name.</param>
<param name="password">Remote server password.</param>
<param name="enabled">Specifies if remote server is enabled.</param>
<returns></returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserRemoteServerCollection.Remove(LumiSoft.MailServer.API.UserAPI.UserRemoteServer)">
<summary>
Removes specified remote server.
</summary>
<param name="remoteServer">Remote server to remove.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserRemoteServerCollection.ToArray">
<summary>
Copies collection to array.
</summary>
<returns></returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserRemoteServerCollection.GetEnumerator">
<summary>
Gets enumerator.
</summary>
<returns></returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserRemoteServerCollection.Bind">
<summary>
Gets user remote servers and binds them to this.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserRemoteServerCollection.Count">
<summary>
Gets number of remote servers on that user.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserRemoteServerCollection.Item(System.Int32)">
<summary>
Gets a UserRemoteServer object in the collection by index number.
</summary>
<param name="index">An Int32 value that specifies the position of the UserRemoteServer object in the UserRemoteServerCollection collection.</param>
<returns>A UserRemoteServer object value that represents the user remote server in virtual server.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserRemoteServerCollection.Item(System.String)">
<summary>
Gets remote server with specified ID.
</summary>
<param name="remoteServerID">A String value that specifies the remote server ID of the UserRemoteServer object in the UserRemoteServerCollection collection.</param>
<returns>A UserRemoteServer object value that represents the user remote server in virtual server.</returns>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.UserMessageRule">
<summary>
The UserMessageRule object represents user message rule in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRule.#ctor(LumiSoft.MailServer.API.UserAPI.UserMessageRuleCollection,System.String,System.Int64,System.Boolean,System.String,System.String,LumiSoft.MailServer.API.UserAPI.GlobalMessageRule_CheckNextRule_enum)">
<summary>
Default constructor.
</summary>
<param name="owner">Owner UserMessageRuleCollection collection that owns this rule.</param>
<param name="id">Rule ID.</param>
<param name="cost">Rule cost.</param>
<param name="enabled">Specifies if rule is enabled.</param>
<param name="description">Rule description text.</param>
<param name="matchexpression">Rule match expression.</param>
<param name="checkNext">Specifies when next rule is checked.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRule.Commit">
<summary>
Tries to save all changed values to server. Throws Exception if fails.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRule.Owner">
<summary>
Gets owner GlobalMessageRuleCollection that owns this rule.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRule.HasChanges">
<summary>
Gets if this object has changes what isn't stored to mail server by calling Commit().
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRule.ID">
<summary>
Gets user message rule ID.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRule.Cost">
<summary>
Gets or sets if user message rule cost. Cost specifies in what order rules are processes,
rules with lower value are proecessed firts.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRule.Enabled">
<summary>
Gets or sets if user message rule is enabled.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRule.Description">
<summary>
Gets or sets user message rule description.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRule.MatchExpression">
<summary>
Gets or sets match expression.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRule.CheckNextRule">
<summary>
Gets or sets when next rule is checked.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRule.Actions">
<summary>
Gets user message rule actions.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection">
<summary>
The UserMessageRuleActionCollection object represents user message rule actions in global message rule.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection.#ctor(LumiSoft.MailServer.API.UserAPI.UserMessageRule)">
<summary>
Default constructor.
</summary>
<param name="rule">Owner user message rule.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection.Add_AddHeaderField(System.String,System.String,System.String)">
<summary>
Creates and adds new 'Add Header Field' action to UserMessageRuleActionCollection collection.
</summary>
<param name="description">Action description text.</param>
<param name="headerFieldName">Header field name.</param>
<param name="headerFieldValue">Header field value.</param>
<returns></returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection.Add_AutoResponse(System.String,System.String,System.Byte[])">
<summary>
Creates and adds new 'Auto Response' action to UserMessageRuleActionCollection collection.
</summary>
<param name="description">Action description text.</param>
<param name="from">MAIL FROM: what is reported to destination SMTP server when auto response is sent.</param>
<param name="message">Full auto response message. This must be rfc 2822 defined message.
You can use LumiSoft.Net.Mime class to parse and to construct valid message.</param>
<returns></returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection.Add_DeleteMessage(System.String)">
<summary>
Creates and adds new 'Delete Message' action to UserMessageRuleActionCollection collection.
</summary>
<param name="description">Action description text.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection.Add_ExecuteProgram(System.String,System.String,System.String)">
<summary>
Creates and adds new 'Execute Program' action to UserMessageRuleActionCollection collection.
</summary>
<param name="description">Action description text.</param>
<param name="program">Program to execute.</param>
<param name="programArguments">Executable program arguments</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection.Add_ForwardToEmail(System.String,System.String)">
<summary>
Creates and adds new 'Forward To Email' action to UserMessageRuleActionCollection collection.
</summary>
<param name="description">Action description text.</param>
<param name="email">Email address where to forward message.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection.Add_ForwardToHost(System.String,System.String,System.Int32)">
<summary>
Creates and adds new 'Forward To Host' action to UserMessageRuleActionCollection collection.
</summary>
<param name="description">Action description text.</param>
<param name="host">Host name or IP where to forward message.</param>
<param name="port">Destination host port.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection.Add_MoveToImapFolder(System.String,System.String)">
<summary>
Creates and adds new 'Move To IMAP Folder' action to UserMessageRuleActionCollection collection.
</summary>
<param name="description">Action description text.</param>
<param name="folder">IMAP folder where to move message. If specified folder doesn't exist, message is store users Inbox.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection.Add_PostToHttp(System.String,System.String)">
<summary>
Creates and adds new 'Post To HTTP' action to UserMessageRuleActionCollection collection.
</summary>
<param name="description">Action description text.</param>
<param name="url">HTTP URL where to post message.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection.Add_PostToNntp(System.String,System.String,System.Int32,System.String)">
<summary>
Creates and adds new 'Post To NNTP Newsgroup' action to UserMessageRuleActionCollection collection.
</summary>
<param name="description">Action description text.</param>
<param name="host">NTTP server where to post message.</param>
<param name="port">NNTP server port.</param>
<param name="newsgroup">NTTP newsgroup where to post message.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection.Add_RemoveHeaderField(System.String,System.String)">
<summary>
Creates and adds new 'Remove Header Field' action to UserMessageRuleActionCollection collection.
</summary>
<param name="description">Action description text.</param>
<param name="headerField">Header field name what to remove.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection.Add_StoreToDisk(System.String,System.String)">
<summary>
Creates and adds new 'Store To Disk Folder' action to UserMessageRuleActionCollection collection.
</summary>
<param name="description">Action description text.</param>
<param name="folder">Disk folder where to store message.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection.Add_StoreToFtp(System.String,System.String,System.Int32,System.String,System.String,System.String)">
<summary>
Creates and adds new 'Store To FTP Folder' action to UserMessageRuleActionCollection collection.
</summary>
<param name="description">Action description text.</param>
<param name="host">FTP server where to store message.</param>
<param name="port">FTP server port.</param>
<param name="userName">FTP server user name.</param>
<param name="password">FTP server user password.</param>
<param name="folder">FTP folder where to store message.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection.Add(LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionBase)">
<summary>
Adds specified action to user message rule.
</summary>
<param name="action">Action to add.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection.Add(System.String,System.String,LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_enum,System.Byte[],System.Boolean)">
<summary>
Adds specified action to connected server.
</summary>
<param name="actionID">Action ID.</param>
<param name="description">Action description.</param>
<param name="type">Action type.</param>
<param name="actionData">Action data.</param>
<param name="addToCollection">Specifies if added action must be created locally and added to local collection.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection.Remove(LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionBase)">
<summary>
Deletes specified action from user message rule.
</summary>
<param name="action">Action to remove.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection.Bind">
<summary>
Gets user message rule actions and binds them to this, if not binded already.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection.GetAction(System.String,System.String,LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_enum,System.Byte[])">
<summary>
Gets user message rule action.
</summary>
<param name="actionID">Action ID.</param>
<param name="description">Action description.</param>
<param name="actionType">Action type.</param>
<param name="actionData">Action data.</param>
<returns></returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection.GetEnumerator">
<summary>
Gets enumerator.
</summary>
<returns></returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection.Rule">
<summary>
Gets owner message rule where this actions apply.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection.Count">
<summary>
Gets number of user message rule actions.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection.Item(System.Int32)">
<summary>
Gets a UserMessageRuleActionBase object in the collection by index number.
</summary>
<param name="index">An Int32 value that specifies the position of the UserMessageRuleActionBase object in the UserMessageRuleActionCollection collection.</param>
<returns>A UserMessageRuleActionBase object value that represents the user message rule action in virtual server.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection.Item(System.String)">
<summary>
Gets a UserMessageRuleActionBase object in the collection by user message rule ID.
</summary>
<param name="userMessageRuleActionID">A String value that specifies the user message rule action ID of the GlobalMessageRuleActionBase object in the GlobalMessageRuleActionCollection collection.</param>
<returns>A UserMessageRuleActionBase object value that represents the user message rule action in virtual server.</returns>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_DeleteMessage">
<summary>
The UserlMessageRuleAction_DeleteMessage object represents user message rule "Delete Message" action in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_DeleteMessage.#ctor(LumiSoft.MailServer.API.UserAPI.UserMessageRule,LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection,System.String,System.String)">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner UserMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_DeleteMessage.Serialize">
<summary>
Serialices action object.
</summary>
<returns>Returns serialized action data.</returns>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.UserFolderAcl">
<summary>
The UserFolderAcl object represents user folder ACL in UserFolder.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserFolderAcl.#ctor(LumiSoft.MailServer.API.UserAPI.UserFolderAclCollection,LumiSoft.MailServer.API.UserAPI.UserFolder,System.String,LumiSoft.Net.IMAP.IMAP_ACL_Flags)">
<summary>
Default constructor.
</summary>
<param name="owner">Owner UserFolderAclCollection collection that owns this object.</param>
<param name="folder">Folder to what that ACl entry applies.</param>
<param name="userOrGroup">User or group to who this acl apply.</param>
<param name="permissions">Permissions to owner folder.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserFolderAcl.Commit">
<summary>
Tries to save all changed values to server. Throws Exception if fails.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserFolderAcl.Owner">
<summary>
Gets owner UserFolderAclCollection that owns this object.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserFolderAcl.Folder">
<summary>
Gets folder where this ACL entry applies.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserFolderAcl.UserOrGroup">
<summary>
Gets user or Group name to who that ACL will apply.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserFolderAcl.Permissions">
<summary>
Gets or sets user/group permissions on that folder.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_ExecuteProgram">
<summary>
The GlobalMessageRuleAction_ExecuteProgram object represents global message rule "Execute Program" action in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_ExecuteProgram.#ctor(LumiSoft.MailServer.API.UserAPI.GlobalMessageRule,LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection,System.String,System.String,System.Byte[])">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner GlobalMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="actionData">Action data.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_ExecuteProgram.#ctor(LumiSoft.MailServer.API.UserAPI.GlobalMessageRule,LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection,System.String,System.String,System.String,System.String)">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner GlobalMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="program">Program to execute.</param>
<param name="programArgs">Executable program arguments.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_ExecuteProgram.Serialize">
<summary>
Serialices action object.
</summary>
<returns>Returns serialized action data.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_ExecuteProgram.ActionType">
<summary>
Get global message rule action type.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_ExecuteProgram.HasChanges">
<summary>
Gets if this object has changes what isn't stored to mail server by calling Commit().
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_ExecuteProgram.Program">
<summary>
Gets or sets program to execute.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_ExecuteProgram.ProgramArguments">
<summary>
Gets or sets executable program arguments.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.UsersDefaultFolderCollection">
<summary>
The UsersDefaultFolderCollection object represents users default folders in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UsersDefaultFolderCollection.#ctor(LumiSoft.MailServer.API.UserAPI.VirtualServer)">
<summary>
Default constructor.
</summary>
<param name="virtualServer">Owner virtual server.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UsersDefaultFolderCollection.Add(System.String,System.Boolean)">
<summary>
Creates and adds new users default folder into collection.
</summary>
<param name="folderName">Folder name.</param>
<param name="permanent">Specifies if folder is permanent (User can't delete it).</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UsersDefaultFolderCollection.Remove(LumiSoft.MailServer.API.UserAPI.UsersDefaultFolder)">
<summary>
Deletes and removes specified users default folder from collection.
</summary>
<param name="folder">UsersDefaultFolder to delete.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UsersDefaultFolderCollection.Contains(System.String)">
<summary>
Check if collection contains users default folder with specified name.
</summary>
<param name="folderName">Folder name.</param>
<returns></returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UsersDefaultFolderCollection.GetFolderByName(System.String)">
<summary>
Gets a UsersDefaultFolder object in the collection by folder name.
</summary>
<param name="folderName">Folder name.</param>
<returns>A UsersDefaultFolder object value that represents the users default folder in virtual server.</returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UsersDefaultFolderCollection.Bind">
<summary>
Gets server users default folders and binds them to this, if not binded already.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UsersDefaultFolderCollection.GetEnumerator">
<summary>
Gets enumerator.
</summary>
<returns></returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UsersDefaultFolderCollection.VirtualServer">
<summary>
Gets the VirtualServer object that is the owner of this collection.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UsersDefaultFolderCollection.Count">
<summary>
Gets number of users default folders in virtual server.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UsersDefaultFolderCollection.Item(System.Int32)">
<summary>
Gets a UsersDefaultFolder object in the collection by index number.
</summary>
<param name="index">An Int32 value that specifies the position of the UsersDefaultFolder object in the UsersDefaultFolderCollection collection.</param>
<returns>A UsersDefaultFolder object value that represents the virtual server users default folder.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UsersDefaultFolderCollection.Item(System.String)">
<summary>
Gets a UsersDefaultFolder object in the collection by domain ID.
</summary>
<param name="folderName">A String value that specifies the users default folder name of the UsersDefaultFolder object in the UsersDefaultFolderCollection collection.</param>
<returns> UsersDefaultFolder object value that represents the virtual server users default folder.</returns>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.SMTP_Settings">
<summary>
The SMTP_Settings object represents SMTP settings in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.SMTP_Settings.#ctor(LumiSoft.MailServer.API.UserAPI.System_Settings,System.Boolean,System.String,System.String,System.String,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean,LumiSoft.MailServer.API.UserAPI.BindInfo[])">
<summary>
Default constructor.
</summary>
<param name="sysSettings">Reference to system settings.</param>
<param name="enabled">Specifies if SMTP service is enabled.</param>
<param name="hostName">SMTP host name.</param>
<param name="greeting">Greeting text.</param>
<param name="defaultDomain">Default domain.</param>
<param name="idleTimeOut">Session idle timeout seconds.</param>
<param name="maxConnections">Maximum conncurent connections.</param>
<param name="maxConnectionsPerIP">Maximum conncurent connections fro 1 IP address.</param>
<param name="maxBadCommands">Maximum bad commands per session.</param>
<param name="maxRecipients">Maximum recipients per message.</param>
<param name="maxMessageSize">Maximum allowed message size.</param>
<param name="requireAuth">Specifies if SMTP server is private server and requires authentication.</param>
<param name="bindings">Specifies SMTP listening info.</param>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SMTP_Settings.Enabled">
<summary>
Gets or sets if SMTP service is enabled.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SMTP_Settings.HostName">
<summary>
Gets or sets SMTP host name reported to connected clients. If "", then machine NETBIOS name used.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SMTP_Settings.GreetingText">
<summary>
Gets or sets greeting text reported to connected clients. If "", default server greeting text is used.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SMTP_Settings.DefaultDomain">
<summary>
Gets or sets default email domain. For example if mail sent to "postmaster", then email becomes postmaster + '@' + default domain.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SMTP_Settings.SessionIdleTimeOut">
<summary>
Gets or sets how many seconds session can idle before timed out.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SMTP_Settings.MaximumConnections">
<summary>
Gets or sets maximum conncurent connections server accepts.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SMTP_Settings.MaximumConnectionsPerIP">
<summary>
Gets or sets maximum conncurent connections from 1 IP address. Value 0, means unlimited connections.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SMTP_Settings.MaximumBadCommands">
<summary>
Gets or sets maximum bad commands can happen before server terminates connection.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SMTP_Settings.MaximumRecipientsPerMessage">
<summary>
Gets or sets how many recipients are allowed per message.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SMTP_Settings.MaximumMessageSize">
<summary>
Gets or sets maximum message size in MB.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SMTP_Settings.RequireAuthentication">
<summary>
Gets or sets if server requires authentication for all incoming connections. If this value is true,
that means smtp server isn't accessible to public.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SMTP_Settings.Binds">
<summary>
Gets IP bindings.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_ForwardToHost">
<summary>
The GlobalMessageRuleAction_ForwardToHost object represents global message rule "Forward To Host" action in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_ForwardToHost.#ctor(LumiSoft.MailServer.API.UserAPI.GlobalMessageRule,LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection,System.String,System.String,System.Byte[])">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner GlobalMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="actionData">Action data.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_ForwardToHost.#ctor(LumiSoft.MailServer.API.UserAPI.GlobalMessageRule,LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection,System.String,System.String,System.String,System.Int32)">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner GlobalMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="host">Host name or IP where to forward message.</param>
<param name="port">Destination host port.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_ForwardToHost.Serialize">
<summary>
Serialices action object.
</summary>
<returns>Returns serialized action data.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_ForwardToHost.ActionType">
<summary>
Get global message rule action type.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_ForwardToHost.HasChanges">
<summary>
Gets if this object has changes what isn't stored to mail server by calling Commit().
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_ForwardToHost.Host">
<summary>
Gets or sets host name or IP where to forward message.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_ForwardToHost.Port">
<summary>
Gets or sets destination host port.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_RemoveHeaderField">
<summary>
The UserMessageRuleAction_RemoveHeaderField object represents user message rule "Remove Header Field" action in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_RemoveHeaderField.#ctor(LumiSoft.MailServer.API.UserAPI.UserMessageRule,LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection,System.String,System.String,System.Byte[])">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner UserMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="actionData">Action data.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_RemoveHeaderField.#ctor(LumiSoft.MailServer.API.UserAPI.UserMessageRule,LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection,System.String,System.String,System.String)">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner UserMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="headerField">Header field name what to remove.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_RemoveHeaderField.Serialize">
<summary>
Serialices action object.
</summary>
<returns>Returns serialized action data.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_RemoveHeaderField.HasChanges">
<summary>
Gets if this object has changes what isn't stored to mail server by calling Commit().
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_RemoveHeaderField.HeaderFieldName">
<summary>
Gets or sets header field name what to remove.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.BindInfo">
<summary>
The BindInfo object represents services TCP listening info in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.BindInfo.#ctor(System.String,System.Net.IPAddress,System.Int32,System.Boolean,System.Byte[])">
<summary>
Default constructor.
</summary>
<param name="protocol">Network protocol.</param>
<param name="ip">IP address.</param>
<param name="port">Port.</param>
<param name="ssl">Specifies if dedicated SSL conncetion.</param>
<param name="certificate">SSL certificate.</param>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.BindInfo.Protocol">
<summary>
Gets protocol.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.BindInfo.IP">
<summary>
Gets listening IP address.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.BindInfo.Port">
<summary>
Gets listening port.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.BindInfo.SSL">
<summary>
Gets if dedicated SSL connection.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.BindInfo.Certificate">
<summary>
Gets SSL certificate.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.RouteAction_RouteToMailbox">
<summary>
The RouteAction_RouteToMailbox object represents route "Route To Mailbox" action in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.RouteActionBase">
<summary>
This is base class for user mesage rule actions.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.RouteActionBase.#ctor(LumiSoft.MailServer.API.UserAPI.RouteAction_enum)">
<summary>
Default constructor.
</summary>
<param name="actionType">Route action type.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.RouteActionBase.Serialize">
<summary>
Serialices action object.
</summary>
<returns>Returns serialized action data.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.RouteActionBase.ActionType">
<summary>
Gets route action type.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.RouteAction_RouteToMailbox.#ctor(System.String)">
<summary>
Default constructor.
</summary>
<param name="mailbox">Mailvox where to route message.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.RouteAction_RouteToMailbox.#ctor(System.Byte[])">
<summary>
Default constructor.
</summary>
<param name="actionData">Action data.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.RouteAction_RouteToMailbox.Serialize">
<summary>
Serialices action object.
</summary>
<returns>Returns serialized action data.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.RouteAction_RouteToMailbox.Mailbox">
<summary>
Gets or sets mailbox where to route message.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.GlobalMessageRule_CheckNextRule_enum">
<summary>
Specified when next rule is checked.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.GlobalMessageRule_CheckNextRule_enum.Always">
<summary>
Next rules is always checked.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.GlobalMessageRule_CheckNextRule_enum.IfMatches">
<summary>
Next rule is checked if last rule matches.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.GlobalMessageRule_CheckNextRule_enum.IfNotMatches">
<summary>
Next rule is checked is last rule don't match.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_RemoveHeaderField">
<summary>
The GlobalMessageRuleAction_RemoveHeaderField object represents global message rule "Remove Header Field" action in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_RemoveHeaderField.#ctor(LumiSoft.MailServer.API.UserAPI.GlobalMessageRule,LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection,System.String,System.String,System.Byte[])">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner GlobalMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="actionData">Action data.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_RemoveHeaderField.#ctor(LumiSoft.MailServer.API.UserAPI.GlobalMessageRule,LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection,System.String,System.String,System.String)">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner GlobalMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="headerField">Header field name what to remove.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_RemoveHeaderField.Serialize">
<summary>
Serialices action object.
</summary>
<returns>Returns serialized action data.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_RemoveHeaderField.ActionType">
<summary>
Get global message rule action type.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_RemoveHeaderField.HasChanges">
<summary>
Gets if this object has changes what isn't stored to mail server by calling Commit().
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_RemoveHeaderField.HeaderFieldName">
<summary>
Gets or sets header field name what to remove.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.Filter">
<summary>
The Filter object represents user filter in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.Filter.#ctor(LumiSoft.MailServer.API.UserAPI.VirtualServer,LumiSoft.MailServer.API.UserAPI.FilterCollection,System.String,System.Int64,System.Boolean,System.String,System.String,System.String)">
<summary>
Default constructor.
</summary>
<param name="virtualServer">Owner virtual server.</param>
<param name="owner">Owner FilterCollection collection that owns this filter.</param>
<param name="id">Filter ID.</param>
<param name="cost">Filter process order, lower values are processed first.</param>
<param name="enabled">Specifies if filter is enabled.</param>
<param name="description">Filter description.</param>
<param name="assembly">Filter assebly file.</param>
<param name="filterClass">Filter class name.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.Filter.Commit">
<summary>
Tries to save all changed values to server. Throws Exception if fails.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Filter.Owner">
<summary>
Gets owner FilterCollection that owns this filter.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Filter.HasChanges">
<summary>
Gets if this group object has changes what isn't stored to mail server by calling Commit().
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Filter.ID">
<summary>
Gets filter ID.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Filter.Enabled">
<summary>
Gets or sets if filter is enabled.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Filter.Description">
<summary>
Gets or sets filter description.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Filter.AssemblyName">
<summary>
Gets or sets filer assembly name.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Filter.Class">
<summary>
Gets or sets filter class.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.Auth_Settings">
<summary>
The Auth_Settings object represents Authentication settings in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.Auth_Settings.#ctor(LumiSoft.MailServer.API.UserAPI.System_Settings,LumiSoft.MailServer.API.UserAPI.ServerAuthenticationType_enum,System.String)">
<summary>
Default constructor.
</summary>
<param name="sysSettings">Reference to system settings.</param>
<param name="authType">Specifies authentication type.</param>
<param name="winDomain">Windows domain.</param>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Auth_Settings.AuthenticationType">
<summary>
Gets or sets authentication type.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Auth_Settings.WinDomain">
<summary>
Gets or set windows domain to against what to do authentication.
This property is used only if ServerAuthenticationType_enum.Windows.
Value "" means that local computer is used.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.UserFolderCollection">
<summary>
The UserFolderCollection object represents user folders in user.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserFolderCollection.#ctor(System.Boolean,LumiSoft.MailServer.API.UserAPI.UserFolder,LumiSoft.MailServer.API.UserAPI.User)">
<summary>
Default constructor.
</summary>
<param name="bind"></param>
<param name="folder">Owner folder or null if root.</param>
<param name="user">Owner user.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserFolderCollection.Add(System.String)">
<summary>
Adds new folder to user.
</summary>
<param name="newFolder">Folder to add. NOTE: Folder may not conatian path parts like folder/subfolder !</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserFolderCollection.Remove(LumiSoft.MailServer.API.UserAPI.UserFolder)">
<summary>
Removes specified folder.
</summary>
<param name="folder">Folder to remove.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserFolderCollection.Contains(System.String)">
<summary>
Checks if specified folder name exists in this collection.
</summary>
<param name="folderName">Folder name.</param>
<returns></returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserFolderCollection.Bind">
<summary>
Gets server user folders and binds them to this, if not binded already.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserFolderCollection.GetEnumerator">
<summary>
Gets enumerator.
</summary>
<returns></returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserFolderCollection.Parent">
<summary>
Gets parent folder. Returns null if this is root folders collection.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserFolderCollection.Count">
<summary>
Gets number of folders in that collection.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserFolderCollection.Item(System.Int32)">
<summary>
Gets a folder in the collection by index number.
</summary>
<param name="index">An Int32 value that specifies the position of the folder object in the UserFolderCollection collection.</param>
<returns></returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserFolderCollection.Item(System.String)">
<summary>
Gets a folder in the collection by folder name.
</summary>
<param name="folderName">A String value that specifies the folder name in the UserFolderCollection collection.</param>
<returns></returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserFolderCollection.List">
<summary>
Gets direct access to internal collection.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.Server">
<summary>
The Server object represents an LumiSoft Mail Server computer.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.Server.#ctor">
<summary>
Default constructor.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.Server.Dispose">
<summary>
Clean up any resources being used.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.Server.Connect(System.String,System.String,System.String)">
<summary>
Connects to the specified LumiSoft mail server.
</summary>
<param name="host">Host name or IP of server to connect.</param>
<param name="userName">User name.</param>
<param name="password">Password.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.Server.Disconnect">
<summary>
Disconnects from connected server.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Server.Connected">
<summary>
Gets if API is connected to server.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Server.Host">
<summary>
Gets connected host name or IP. NOTE: You must be connected before accessing this property.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Server.UserName">
<summary>
Gets user name which was used to connect to mail server. NOTE: You must be connected before accessing this property.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Server.IPAddresses">
<summary>
Gets mail server IP addresses. NOTE: You must be connected before accessing this property.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Server.ServerInfo">
<summary>
Gets mail server sessions. NOTE: You must be connected before accessing this property.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Server.Sessions">
<summary>
Gets mail server sessions. NOTE: You must be connected before accessing this property.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Server.Events">
<summary>
Gets mail server events. NOTE: You must be connected before accessing this property.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Server.VirtualServers">
<summary>
Gets mail server virtual servers. NOTE: You must be connected before accessing this property.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Server.Socket">
<summary>
Gets connected socket.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Server.LockSynchronizer">
<summary>
Gets lobal lock() object what can be used to lock whole User API.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.RouteAction_RouteToEmail">
<summary>
The RouteAction_RouteToEmail object represents route "Route To Email" action in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.RouteAction_RouteToEmail.#ctor(System.String)">
<summary>
Default constructor.
</summary>
<param name="emailAddress">Wmail address where to route message.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.RouteAction_RouteToEmail.#ctor(System.Byte[])">
<summary>
Default constructor.
</summary>
<param name="actionData">Action data.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.RouteAction_RouteToEmail.Serialize">
<summary>
Serialices action object.
</summary>
<returns>Returns serialized action data.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.RouteAction_RouteToEmail.EmailAddress">
<summary>
Gets email address where to route message.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.MailingList">
<summary>
The MailingList object represents mailing list in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.MailingList.#ctor(LumiSoft.MailServer.API.UserAPI.VirtualServer,LumiSoft.MailServer.API.UserAPI.MailingListCollection,System.String,System.String,System.String,System.Boolean)">
<summary>
Default constructor.
</summary>
<param name="virtualServer">Owner virtual server.</param>
<param name="owner">Owner MailingListCollection collection that owns this mailing list.</param>
<param name="id">Mailing list ID.</param>
<param name="name">Mailing list name.</param>
<param name="description">Mailing list description.</param>
<param name="enabled">Specifies if mailing list is enabled.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.MailingList.Commit">
<summary>
Tries to save all changed values to server. Throws Exception if fails.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.MailingList.VirtualServer">
<summary>
Gets the VirtualServer object that is the owner of this mailing list.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.MailingList.Owner">
<summary>
Gets onwer MailingListCollection that owns this mailing list.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.MailingList.ID">
<summary>
Gets mailing list ID.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.MailingList.Name">
<summary>
Gets or sets mailing list name.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.MailingList.Description">
<summary>
Gets or sets mailing list description.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.MailingList.Enabled">
<summary>
Gets or sets if mailing list enabled.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.MailingList.Members">
<summary>
Gets mailing list members.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.MailingList.ACL">
<summary>
Gets mailing list ACL.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.Logging_Settings">
<summary>
The Logging_Settings object represents logging settings in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.Logging_Settings.#ctor(LumiSoft.MailServer.API.UserAPI.System_Settings,System.Boolean,System.String,System.Boolean,System.String,System.Boolean,System.String,System.Boolean,System.String,System.Boolean,System.String)">
<summary>
Default constructor.
</summary>
<param name="sysSettings">Reference to system settings.</param>
<param name="logSMTP">Specifies if SMTP is logged.</param>
<param name="smtpLogsPath">SMTP logs path.</param>
<param name="logPOP3">Specifies if POP3 is logged.</param>
<param name="pop3LogsPath">POP3 logs path.</param>
<param name="logIMAP">Specifies if IMAP is logged.</param>
<param name="imapLogsPath">IMAP logs path.</param>
<param name="logRelay">Specifies if Relay is logged.</param>
<param name="relayLogsPath">Relay logs path.</param>
<param name="logFetchMessages">Specifies if fetch messages is logged.</param>
<param name="fetchMessagesLogsPath">Fetch messages logs path.</param>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Logging_Settings.LogSMTP">
<summary>
Gets or sets if SMTP is logged.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Logging_Settings.SmtpLogsPath">
<summary>
Gets or sets SMTP logs path.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Logging_Settings.LogPOP3">
<summary>
Gets or sets if POP3 is logged.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Logging_Settings.Pop3LogsPath">
<summary>
Gets or sets POP3 logs path.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Logging_Settings.LogIMAP">
<summary>
Gets or sets if IMAP is logged.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Logging_Settings.ImapLogsPath">
<summary>
Gets or sets IMAP logs path.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Logging_Settings.LogRelay">
<summary>
Gets or sets if Relay is logged.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Logging_Settings.RelayLogsPath">
<summary>
Gets or sets Relay logs path.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Logging_Settings.LogFetchMessages">
<summary>
Gets or sets if remote messages fetching is logged.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Logging_Settings.FetchMessagesLogsPath">
<summary>
Gets or sets fetch messages logs path.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_SendError">
<summary>
The GlobalMessageRuleAction_SendError object represents global message rule "Send Error To Client" action in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_SendError.#ctor(LumiSoft.MailServer.API.UserAPI.GlobalMessageRule,LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection,System.String,System.String,System.Byte[])">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner GlobalMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="actionData">Action data.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_SendError.#ctor(LumiSoft.MailServer.API.UserAPI.GlobalMessageRule,LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection,System.String,System.String,System.String)">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner GlobalMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="errorText">Error text.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_SendError.Serialize">
<summary>
Serialices action object.
</summary>
<returns>Returns serialized action data.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_SendError.ActionType">
<summary>
Get global message rule action type.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_SendError.HasChanges">
<summary>
Gets if this object has changes what isn't stored to mail server by calling Commit().
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_SendError.SmtpErrorText">
<summary>
Gets or sets SMTP error text to return connected client.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.FetchMessages_Settings">
<summary>
The FetchMessages_Settings object represents Fetch remote server messages settings in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.FetchMessages_Settings.#ctor(LumiSoft.MailServer.API.UserAPI.System_Settings,System.Boolean,System.Int32)">
<summary>
Default constructor.
</summary>
<param name="sysSettings">Reference to system settings.</param>
<param name="enabled">Specifies if remote messages fetching service is enabled.</param>
<param name="fetchInterval">Messages fetching inteval seconds.</param>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.FetchMessages_Settings.Enabled">
<summary>
Gets or sets if remote messages fetching service is enabled.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.FetchMessages_Settings.FetchInterval">
<summary>
Gets or sets how fetch seconds, how often to fetch messages from remote server.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.DomainCollection">
<summary>
The DomainCollection object represents domains in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.DomainCollection.#ctor(LumiSoft.MailServer.API.UserAPI.VirtualServer)">
<summary>
Default constructor.
</summary>
<param name="virtualServer">Owner virtual server.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.DomainCollection.Add(System.String,System.String)">
<summary>
Creates and adds new domain to domain collection.
</summary>
<param name="name">Domain name.</param>
<param name="description">Domain description text.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.DomainCollection.Remove(LumiSoft.MailServer.API.UserAPI.Domain)">
<summary>
Deletes and removes specified domain from domain collection.
</summary>
<param name="domain">Domain to delete.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.DomainCollection.Contains(System.String)">
<summary>
Check if collection contains domain with specified name.
</summary>
<param name="domainName">Domain name.</param>
<returns></returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.DomainCollection.Refresh">
<summary>
Refreshes domains.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.DomainCollection.Bind">
<summary>
Gets server domains and binds them to this, if not binded already.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.DomainCollection.GetEnumerator">
<summary>
Gets enumerator.
</summary>
<returns></returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.DomainCollection.VirtualServer">
<summary>
Gets the VirtualServer object that is the owner of this collection.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.DomainCollection.Count">
<summary>
Gets number of domains in virtual server.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.DomainCollection.Item(System.Int32)">
<summary>
Gets a Domain object in the collection by index number.
</summary>
<param name="index">An Int32 value that specifies the position of the Domain object in the DomainCollection collection.</param>
<returns>A Domain object value that represents the virtual server domain.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.DomainCollection.Item(System.String)">
<summary>
Gets a Domain object in the collection by domain ID.
</summary>
<param name="domainID">A String value that specifies the domain ID of the Domain object in the DomainCollection collection.</param>
<returns>A Domain object value that represents the virtual server domain.</returns>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.Group">
<summary>
The Group object represents user group in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.Group.#ctor(LumiSoft.MailServer.API.UserAPI.VirtualServer,LumiSoft.MailServer.API.UserAPI.GroupCollection,System.String,System.String,System.String,System.Boolean)">
<summary>
Default constructor.
</summary>
<param name="virtualServer">Owner virtual server.</param>
<param name="owner">Owner GroupCollection collection that owns this group.</param>
<param name="id">Group ID.</param>
<param name="name">Group name.</param>
<param name="descritpion">Group description.</param>
<param name="enabled">Specifies if group is enabled.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.Group.Commit">
<summary>
Tries to save all changed values to server. Throws Exception if fails.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Group.VirtualServer">
<summary>
Gets the VirtualServer object that is the owner of this group.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Group.Owner">
<summary>
Gets onwer GroupCollection that owns this group.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Group.HasChanges">
<summary>
Gets if this group object has changes what isn't stored to mail server by calling Commit().
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Group.GroupID">
<summary>
Gets group ID.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Group.GroupName">
<summary>
Gets or sets group name.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Group.Description">
<summary>
Gets or sets group description.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Group.Enabled">
<summary>
Gets or sets if group is enabled.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Group.Members">
<summary>
Gets group members.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.UserFolderAclCollection">
<summary>
The UserFolderAclCollection object represents user folder ACL entries in UserFolder.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserFolderAclCollection.#ctor(LumiSoft.MailServer.API.UserAPI.UserFolder)">
<summary>
Default consturctor.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserFolderAclCollection.Add(System.String,LumiSoft.Net.IMAP.IMAP_ACL_Flags)">
<summary>
Adds specified user or group permissions to active folder.
</summary>
<param name="userOrGroup">User or group.</param>
<param name="permissions">Permissions to allow.</param>
<returns>Returns added UserFolderAcl.</returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserFolderAclCollection.Remove(LumiSoft.MailServer.API.UserAPI.UserFolderAcl)">
<summary>
Removes specified user or group permissions from active folder.
</summary>
<param name="aclEntry">User or group.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserFolderAclCollection.Bind">
<summary>
Gets server user folders and binds them to this, if not binded already.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserFolderAclCollection.GetEnumerator">
<summary>
Gets enumerator.
</summary>
<returns></returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserFolderAclCollection.Folder">
<summary>
Gets folder for what this ACL apply.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserFolderAclCollection.Count">
<summary>
Gets number of ACL entries for that folder.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserFolderAclCollection.Item(System.Int32)">
<summary>
Gets a UserFolderAcl object in the collection by index number.
</summary>
<param name="index">An Int32 value that specifies the position of the UserFolderAcl object in the UserFolderAclCollection collection.</param>
<returns>A UserFolderAcl object value that represents the user folder ACL in virtual server.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserFolderAclCollection.Item(System.String)">
<summary>
Gets a UserFolderAcl object in the collection by user or group name.
</summary>
<param name="userOrGroup">A String value that specifies the user or group name of the UserFolderAcl object in the UserFolderAclCollection collection.</param>
<returns>A UserFolderAcl object value that represents the user folder ACL in virtual server.</returns>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.UserEmailAddressCollection">
<summary>
The UserEmailAddressCollection object represents user email addresses in User.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserEmailAddressCollection.#ctor(LumiSoft.MailServer.API.UserAPI.User)">
<summary>
Default constructor.
</summary>
<param name="user">Owner user.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserEmailAddressCollection.Add(System.String)">
<summary>
Adds specified email address to user.
</summary>
<param name="emailAddress">Email address to add.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserEmailAddressCollection.Remove(System.String)">
<summary>
Removes specified email address from user.
</summary>
<param name="emailAddress">Email address to remove.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserEmailAddressCollection.ToArray">
<summary>
Copies collection to array.
</summary>
<returns></returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserEmailAddressCollection.Bind">
<summary>
Gets server email addresses and binds them to this, if not binded already.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserEmailAddressCollection.GetEnumerator">
<summary>
Gets enumerator.
</summary>
<returns></returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserEmailAddressCollection.User">
<summary>
Gets the User object that is the owner of this collection.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserEmailAddressCollection.Count">
<summary>
Gets number of email addresses on that user.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserEmailAddressCollection.Item(System.Int32)">
<summary>
Gets a user email address in the collection by index number.
</summary>
<param name="index">An Int32 value that specifies the position of the user email address in the UserEmailAddressCollection collection.</param>
<returns></returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserEmailAddressCollection.Item(System.String)">
<summary>
Gets a user email address in the collection by user email address.
</summary>
<param name="emailAddress">A String value that specifies the user email address in the UserEmailAddressCollection collection.</param>
<returns></returns>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.Route">
<summary>
The Route object represents route in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.Route.#ctor(LumiSoft.MailServer.API.UserAPI.RouteCollection,System.String,System.Int64,System.String,System.String,System.Boolean,LumiSoft.MailServer.API.UserAPI.RouteActionBase)">
<summary>
Default constructor.
</summary>
<param name="owner">Owner RouteCollection collection that owns this route.</param>
<param name="id">Route ID.</param>
<param name="cost">Rule cost.</param>
<param name="descritpion">Route description text.</param>
<param name="pattern">Routing pattern.</param>
<param name="enabled">Specifies if route is enabled.</param>
<param name="action">Route action.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.Route.Commit">
<summary>
Tries to save all changed values to server. Throws Exception if fails.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Route.Owner">
<summary>
Gets owner RouteCollection that owns this route.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Route.HasChanges">
<summary>
Gets if this route object has changes what isn't stored to mail server by calling Commit().
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Route.ID">
<summary>
Gets route ID.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Route.Description">
<summary>
Gets or sets route description text.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Route.Pattern">
<summary>
Gets or sets pattern text.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Route.Enabled">
<summary>
Gets or sets if route is enabled.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Route.Action">
<summary>
Gets or sets route action.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.RecycleBin">
<summary>
The RecycleBin object represents recycle bin in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.RecycleBin.#ctor(LumiSoft.MailServer.API.UserAPI.VirtualServer)">
<summary>
Default constructor.
</summary>
<param name="virtualServer">Owner virtual server.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.RecycleBin.GetMessagesInfo(System.String,System.DateTime,System.DateTime)">
<summary>
Gets recycle bin messages info.
</summary>
<param name="user">User who's recyclebin messages to get or null if all users messages.</param>
<param name="startDate">Messages from specified date. Pass DateTime.MinValue if not used.</param>
<param name="endDate">Messages to specified date. Pass DateTime.MinValue if not used.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.RecycleBin.GetMessage(System.String,System.IO.Stream)">
<summary>
Gets specified message and stores it to specified stream.
</summary>
<param name="messageID">Message ID.</param>
<param name="message">Stream where to store message.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.RecycleBin.RestoreRecycleBinMessage(System.String)">
<summary>
Restores specified recycle bin message.
</summary>
<param name="messageID">Messge ID which to restore.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.RecycleBin.Bind">
<summary>
Gets recycle bin settings and binds them to this.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.RecycleBin.Commit">
<summary>
Tries to save all changed values to server. Throws Exception if fails.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.RecycleBin.HasChanges">
<summary>
Gets if this domain object has changes what isn't stored to mail server by calling Commit().
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.RecycleBin.DeleteToRecycleBin">
<summary>
Gets or sets if deleted messages are store to recycle bin.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.RecycleBin.DeleteMessagesAfter">
<summary>
Gest or sets how old messages will be deleted.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.MailingListMemberCollection">
<summary>
The MailingListMemberCollection object represents mailing list members in mailing list.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.MailingListMemberCollection.#ctor(LumiSoft.MailServer.API.UserAPI.MailingList)">
<summary>
Default constructor.
</summary>
<param name="mailingList">Owner mailing list.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.MailingListMemberCollection.Add(System.String)">
<summary>
Adds specified member to mailing list.
</summary>
<param name="member">Member to add.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.MailingListMemberCollection.Remove(System.String)">
<summary>
Deletes specified member from mebers collection.
</summary>
<param name="member">Member to delete.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.MailingListMemberCollection.Bind">
<summary>
Gets server mailing list members and binds them to this, if not binded already.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.MailingListMemberCollection.GetEnumerator">
<summary>
Gets enumerator.
</summary>
<returns></returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.MailingListMemberCollection.Count">
<summary>
Gets number of members on that mailing list.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.MailingListMemberCollection.Item(System.Int32)">
<summary>
Gets a mailing list member in the collection by index number.
</summary>
<param name="index">An Int32 value that specifies the position of the mailing list member in the MailingListMemberCollection collection.</param>
<returns></returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.MailingListMemberCollection.Item(System.String)">
<summary>
Gets a mailing list member in the collection by mailing list member name.
</summary>
<param name="member">A String value that specifies the mailing list member name in the MailingListMemberCollection collection.</param>
<returns></returns>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleCollection">
<summary>
The GlobalMessageRuleCollection object represents global message rules in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleCollection.#ctor(LumiSoft.MailServer.API.UserAPI.VirtualServer)">
<summary>
Default constructor.
</summary>
<param name="virtualServer">Owner virtual server.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleCollection.Add(System.Boolean,System.String,System.String,LumiSoft.MailServer.API.UserAPI.GlobalMessageRule_CheckNextRule_enum)">
<summary>
Adds new global message rule to virtual server.
</summary>
<param name="enabled">Specifies if global message rules is enabled.</param>
<param name="description">Global message rule description.</param>
<param name="matchExpression">Match expression.</param>
<param name="checkNext">Specifies when next rule is checked.</param>
<returns></returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleCollection.Remove(LumiSoft.MailServer.API.UserAPI.GlobalMessageRule)">
<summary>
Deletes specified global message rule from virtual server.
</summary>
<param name="rule">Global message rule to delete.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleCollection.Refresh">
<summary>
Refreshes rules.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleCollection.Bind">
<summary>
Gets server global message rules and binds them to this, if not binded already.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleCollection.GetEnumerator">
<summary>
Gets enumerator.
</summary>
<returns></returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleCollection.VirtualServer">
<summary>
Gets the VirtualServer object that is the owner of this collection.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleCollection.Count">
<summary>
Gets number of global message rules in virtual server.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleCollection.Item(System.Int32)">
<summary>
Gets a GlobalMessageRule object in the collection by index number.
</summary>
<param name="index">An Int32 value that specifies the position of the GlobalMessageRule object in the GlobalMessageRuleCollection collection.</param>
<returns>A GlobalMessageRule object value that represents the global message rule in virtual server.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleCollection.Item(System.String)">
<summary>
Gets a GlobalMessageRule object in the collection by global message rule ID.
</summary>
<param name="globalMessageRuleID">A String value that specifies the global message rule ID of the GlobalMessageRule object in the GlobalMessageRuleCollection collection.</param>
<returns>A GlobalMessageRule object value that represents the global message rule in virtual server.</returns>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.Domain">
<summary>
The Domain object represents domain in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.Domain.#ctor(LumiSoft.MailServer.API.UserAPI.DomainCollection,System.String,System.String,System.String)">
<summary>
Default constructor.
</summary>
<param name="owner">Owner DomainCollection that owns this domain.</param>
<param name="id">Domain ID.</param>
<param name="name">Domain name.</param>
<param name="description">Domain decription.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.Domain.Commit">
<summary>
Tries to save all changed values to server. Throws Exception if fails.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Domain.HasChanges">
<summary>
Gets if this domain object has changes what isn't stored to mail server by calling Commit().
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Domain.Owner">
<summary>
Gets onwer DomainCollection that owns this domain.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Domain.DomainID">
<summary>
Gets domain ID.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Domain.DomainName">
<summary>
Gets or sets domain name.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Domain.Description">
<summary>
Gets or sets domain description.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_PostToNntpNewsgroup">
<summary>
The UserMessageRuleAction_PostToNntpNewsgroup object represents user message rule "Post To NNTP Newsgroup" action in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_PostToNntpNewsgroup.#ctor(LumiSoft.MailServer.API.UserAPI.UserMessageRule,LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection,System.String,System.String,System.Byte[])">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner UserMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="actionData">Action data.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_PostToNntpNewsgroup.#ctor(LumiSoft.MailServer.API.UserAPI.UserMessageRule,LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection,System.String,System.String,System.String,System.Int32,System.String)">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner UserMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="host">NTTP server where to post message.</param>
<param name="port">NNTP server port.</param>
<param name="newsgroup">NTTP newsgroup where to post message.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_PostToNntpNewsgroup.Serialize">
<summary>
Serialices action object.
</summary>
<returns>Returns serialized action data.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_PostToNntpNewsgroup.HasChanges">
<summary>
Gets if this object has changes what isn't stored to mail server by calling Commit().
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_PostToNntpNewsgroup.Server">
<summary>
Gets or sets NTTP server where to post message.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_PostToNntpNewsgroup.Port">
<summary>
Gets or sets NNTP server port.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_PostToNntpNewsgroup.Newsgroup">
<summary>
Gets or sets NNTP newsgroup where to post message.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_MoveToImapFolder">
<summary>
The UserMessageRuleAction_MoveToImapFolder object represents user message rule "Move To IMAP Folder" action in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_MoveToImapFolder.#ctor(LumiSoft.MailServer.API.UserAPI.UserMessageRule,LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection,System.String,System.String,System.Byte[])">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner UserMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="actionData">Action data.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_MoveToImapFolder.#ctor(LumiSoft.MailServer.API.UserAPI.UserMessageRule,LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection,System.String,System.String,System.String)">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner UserMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="folder">IMAP folder where to move message. If specified folder doesn't exist, message is store users Inbox.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_MoveToImapFolder.Serialize">
<summary>
Serialices action object.
</summary>
<returns>Returns serialized action data.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_MoveToImapFolder.HasChanges">
<summary>
Gets if this object has changes what isn't stored to mail server by calling Commit().
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_MoveToImapFolder.Folder">
<summary>
Gets or sets IMAP folder where to move message. If specified folder doesn't exist, message is store users Inbox.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.SipRegistration">
<summary>
The SipRegistration object represents SIP registration in LumiSoft Mail Server server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.SipRegistration.#ctor(LumiSoft.MailServer.API.UserAPI.SipRegistrationCollection,System.String,System.String,LumiSoft.MailServer.API.UserAPI.SipRegistrationContact[])">
<summary>
Default constructor.
</summary>
<param name="owner">Owner SipRegistrationCollection collection that owns this object.</param>
<param name="userName">User name of user which added this registration.</param>
<param name="addressOfRecord">SIP registration address of record.</param>
<param name="contacts">SIP registration contacts.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.SipRegistration.Refresh">
<summary>
Refreshes specified registration info.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SipRegistration.Owner">
<summary>
Gets owner registration collection.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SipRegistration.UserName">
<summary>
Gets user name of user which added this registration.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SipRegistration.AddressOfRecord">
<summary>
Gets SIP registration address of record. This is user ad registration name/id.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SipRegistration.Contacts">
<summary>
Gets this registration contacts.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.SharedRootFolder">
<summary>
The SharedRootFolder object represents shared root folder in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.SharedRootFolder.#ctor(LumiSoft.MailServer.API.UserAPI.VirtualServer,LumiSoft.MailServer.API.UserAPI.SharedRootFolderCollection,System.String,System.Boolean,System.String,System.String,LumiSoft.MailServer.API.UserAPI.SharedFolderRootType_enum,System.String,System.String)">
<summary>
Default constructor.
</summary>
<param name="virtualServer">Owner virtual server.</param>
<param name="owner">Owner SharedRootFolderCollection collection that owns this root folder.</param>
<param name="id">Root folder ID.</param>
<param name="enabled">Specifies if root folder is enabled.</param>
<param name="name">Root folder name.</param>
<param name="description">Root folder description.</param>
<param name="type">Root folder type.</param>
<param name="boundedUser">Root folder bounded user.</param>
<param name="boundedFolder">Root folder bounded folder.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.SharedRootFolder.Commit">
<summary>
Tries to save all changed values to server. Throws Exception if fails.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SharedRootFolder.Owner">
<summary>
Gets owner SharedRootFolderCollection that owns this root folder.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SharedRootFolder.HasChanges">
<summary>
Gets if this group object has changes what isn't stored to mail server by calling Commit().
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SharedRootFolder.ID">
<summary>
Gets root folder ID.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SharedRootFolder.Enabled">
<summary>
Gets or sets if root folder is enabled.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SharedRootFolder.Name">
<summary>
Gets or sets root folder name.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SharedRootFolder.Description">
<summary>
Gets or sets root folder description.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SharedRootFolder.Type">
<summary>
Gets or sets root folder type.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SharedRootFolder.BoundedUser">
<summary>
Gets or sets bounded user.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SharedRootFolder.BoundedFolder">
<summary>
Gets or sets bounded folder.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.RouteAction_enum">
<summary>
Route actions.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.RouteAction_enum.RouteToMailbox">
<summary>
Routes message to local server user mailbox.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.RouteAction_enum.RouteToEmail">
<summary>
Routes message to email address.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.RouteAction_enum.RouteToHost">
<summary>
Routes message to destination host.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.QueueItemCollection">
<summary>
The Queues object represents SMTP/Relay queue in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.QueueItemCollection.#ctor(LumiSoft.MailServer.API.UserAPI.VirtualServer,System.Boolean)">
<summary>
Default constructor.
</summary>
<param name="virtualServer">Owner virtual server.</param>
<param name="smtp_relay">Specifies if smtp or relay queue collection.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.QueueItemCollection.Refresh">
<summary>
Refreshes sessions.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.QueueItemCollection.Bind">
<summary>
Gets server groups and binds them to this.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.QueueItemCollection.GetEnumerator">
<summary>
Gets enumerator.
</summary>
<returns></returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.QueueItemCollection.VirtualServer">
<summary>
Gets the VirtualServer object that is the owner of this collection.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.QueueItemCollection.Count">
<summary>
Gets number of queue itmes in collection.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.QueueItemCollection.Item(System.Int32)">
<summary>
Gets a QueueItem object in the collection by index number.
</summary>
<param name="index">An Int32 value that specifies the position of the QueueItem object in the QueueCollection collection.</param>
<returns>A QueueItem object value that represents the queue item in virtual server.</returns>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_PostToHttp">
<summary>
The GlobalMessageRuleAction_PostToHttp object represents global message rule "Post To HTTP" action in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_PostToHttp.#ctor(LumiSoft.MailServer.API.UserAPI.GlobalMessageRule,LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection,System.String,System.String,System.Byte[])">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner GlobalMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="actionData">Action data.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_PostToHttp.#ctor(LumiSoft.MailServer.API.UserAPI.GlobalMessageRule,LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection,System.String,System.String,System.String)">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner GlobalMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="url">HTTP URL where to post message.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_PostToHttp.Serialize">
<summary>
Serialices action object.
</summary>
<returns>Returns serialized action data.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_PostToHttp.ActionType">
<summary>
Get global message rule action type.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_PostToHttp.HasChanges">
<summary>
Gets if this object has changes what isn't stored to mail server by calling Commit().
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_PostToHttp.Url">
<summary>
Gets or sets HTTP URL where to post message.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.EventCollection">
<summary>
The EventCollection object represents events in LumiSoft Mail Server server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.EventCollection.#ctor(LumiSoft.MailServer.API.UserAPI.Server)">
<summary>
Default constructor.
</summary>
<param name="owner">Owner Server object that owns this collection.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.EventCollection.Bind">
<summary>
Gets server events and binds them to this.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.EventCollection.Refresh">
<summary>
Refreshes sessions.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.EventCollection.Clear">
<summary>
Deletes all events.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.EventCollection.GetEnumerator">
<summary>
Gets enumerator.
</summary>
<returns></returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.EventCollection.Count">
<summary>
Gets number of events in server.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.EventCollection.Item(System.Int32)">
<summary>
Gets a Event object in the collection by index number.
</summary>
<param name="index">An Int32 value that specifies the position of the Event object in the EventCollection collection.</param>
<returns>A Event object value that represents the event in server.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.EventCollection.Item(System.String)">
<summary>
Gets a Event object in the collection by filter ID.
</summary>
<param name="eventID">A String value that specifies the event ID of the Event object in the EventCollection collection.</param>
<returns>A Event object value that represents the event in server.</returns>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.UserMessageRuleCollection">
<summary>
The UserMessageRuleCollection object represents user message rules in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleCollection.#ctor(LumiSoft.MailServer.API.UserAPI.User)">
<summary>
Default constructor.
</summary>
<param name="user">Owner user that own this collection.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleCollection.Add(System.Boolean,System.String,System.String,LumiSoft.MailServer.API.UserAPI.GlobalMessageRule_CheckNextRule_enum)">
<summary>
Adds new user message rule to virtual server.
</summary>
<param name="enabled">Specifies if user message rules is enabled.</param>
<param name="description">User message rule description.</param>
<param name="matchExpression">Match expression.</param>
<param name="checkNext">Specifies when next rule is checked.</param>
<returns></returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleCollection.Remove(LumiSoft.MailServer.API.UserAPI.UserMessageRule)">
<summary>
Deletes specified user message rule from virtual server.
</summary>
<param name="rule">User message rule to delete.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleCollection.Refresh">
<summary>
Refreshes rules.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleCollection.ToArray">
<summary>
Copies collection to array.
</summary>
<returns></returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleCollection.Bind">
<summary>
Gets server global message rules and binds them to this, if not binded already.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleCollection.GetEnumerator">
<summary>
Gets enumerator.
</summary>
<returns></returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleCollection.VirtualServer">
<summary>
Gets the VirtualServer object that is the owner of this collection.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleCollection.Owner">
<summary>
Gets onwer user that ownt this UserMessageRuleCollection.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleCollection.Count">
<summary>
Gets number of user message rules in virtual server.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleCollection.Item(System.Int32)">
<summary>
Gets a UserMessageRule object in the collection by index number.
</summary>
<param name="index">An Int32 value that specifies the position of the UserMessageRule object in the UserMessageRuleCollection collection.</param>
<returns>A UserMessageRule object value that represents the user message rule in virtual server.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleCollection.Item(System.String)">
<summary>
Gets a UserMessageRule object in the collection by user message rule ID.
</summary>
<param name="ruleID">A String value that specifies the user message rule ID of the UserMessageRule object in the UserMessageRuleCollection collection.</param>
<returns>A UserMessageRule object value that represents the user message rule in virtual server.</returns>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.System_Settings">
<summary>
The System_Settings object represents System settings in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.System_Settings.#ctor(LumiSoft.MailServer.API.UserAPI.VirtualServer)">
<summary>
Default constructor.
</summary>
<param name="virtualServer">Owner virtual server.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.System_Settings.Commit">
<summary>
Tries to save all changed values to server. Throws Exception if fails.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.System_Settings.LoadSettings(System.Data.DataSet)">
<summary>
Loads settings from DataSet.
</summary>
<param name="dsSettings">DataSet what contains settings.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.System_Settings.SetValuesChanged">
<summary>
Sets property HasChanges to true.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.System_Settings.CreateSettingsSchema(System.Data.DataSet)">
<summary>
Creates settings schema.
</summary>
<param name="ds"></param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.System_Settings.ToDataSet">
<summary>
Copies all system settings to DataSet.
</summary>
<returns></returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.System_Settings.Bind">
<summary>
Gets server settings and binds them to this.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.System_Settings.HasChanges">
<summary>
Gets if this object has changes what isn't stored to mail server by calling Commit().
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.System_Settings.Authentication">
<summary>
Gets authentication settings.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.System_Settings.SMTP">
<summary>
Gets SMTP settings.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.System_Settings.POP3">
<summary>
Gets POP3 settings.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.System_Settings.IMAP">
<summary>
Gets IMAP settings.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.System_Settings.Relay">
<summary>
Gets relay settings.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.System_Settings.FetchMessages">
<summary>
Gets fetch messages service settings.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.System_Settings.SIP">
<summary>
Gets SIP settings.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.System_Settings.Logging">
<summary>
Gets logging settings.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.System_Settings.ReturnMessages">
<summary>
Gets server return messages object.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_StoreToFtp">
<summary>
The GlobalMessageRuleAction_StoreToFtp object represents global message rule "Store To FTP Folder" action in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_StoreToFtp.#ctor(LumiSoft.MailServer.API.UserAPI.GlobalMessageRule,LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection,System.String,System.String,System.Byte[])">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner GlobalMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="actionData">Action data.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_StoreToFtp.#ctor(LumiSoft.MailServer.API.UserAPI.GlobalMessageRule,LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection,System.String,System.String,System.String,System.Int32,System.String,System.String,System.String)">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner GlobalMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="host">FTP server where to store message.</param>
<param name="port">FTP server port.</param>
<param name="userName">FTP server user name.</param>
<param name="password">FTP server user password.</param>
<param name="folder">FTP folder where to store message.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_StoreToFtp.Serialize">
<summary>
Serialices action object.
</summary>
<returns>Returns serialized action data.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_StoreToFtp.ActionType">
<summary>
Get global message rule action type.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_StoreToFtp.HasChanges">
<summary>
Gets if this object has changes what isn't stored to mail server by calling Commit().
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_StoreToFtp.Server">
<summary>
Gets or sets FTP server where to store message.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_StoreToFtp.Port">
<summary>
Gets or sets FTP server port.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_StoreToFtp.UserName">
<summary>
Gets or sets FTP server user name.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_StoreToFtp.Password">
<summary>
Gets or sets FTP server user password.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_StoreToFtp.Folder">
<summary>
Gets or sets FTP folder where to store message.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.EventType_enum">
<summary>
Specifies event type.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.EventType_enum.Error">
<summary>
Event is error.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_AutoResponse">
<summary>
The UserMessageRuleAction_AutoResponse object represents user message rule "Auto Response" action in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_AutoResponse.#ctor(LumiSoft.MailServer.API.UserAPI.UserMessageRule,LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection,System.String,System.String,System.Byte[])">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner UserMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="actionData">Action data.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_AutoResponse.#ctor(LumiSoft.MailServer.API.UserAPI.UserMessageRule,LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection,System.String,System.String,System.String,System.Byte[])">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner UserMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="from">MAIL FROM: what is reported to destination SMTP server when auto response is sent.</param>
<param name="message">Full auto response message. This must be rfc 2822 defined message.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_AutoResponse.Serialize">
<summary>
Serialices action object.
</summary>
<returns>Returns serialized action data.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_AutoResponse.HasChanges">
<summary>
Gets if this object has changes what isn't stored to mail server by calling Commit().
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_AutoResponse.From">
<summary>
Gets or sets MAIL FROM: what is reported to destination SMTP server when auto response is sent.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_AutoResponse.Message">
<summary>
Gets or sets full auto response message. This must be rfc 2822 defined message.
You can use LumiSoft.Net.Mime class to parse and to construct valid message.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.SessionCollection">
<summary>
The SessionCollection object represents sessions in LumiSoft Mail Server server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.SessionCollection.#ctor(LumiSoft.MailServer.API.UserAPI.Server)">
<summary>
Default constructor.
</summary>
<param name="owner">Owner Server object that owns this collection.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.SessionCollection.Refresh">
<summary>
Refreshes sessions.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.SessionCollection.ConatainsID(System.String)">
<summary>
Gets if collection contains session with specified ID.
</summary>
<param name="sessionID">Session ID.</param>
<returns></returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.SessionCollection.GetSessionByID(System.String)">
<summary>
Gets a Session object in the collection by session ID.
</summary>
<returns></returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.SessionCollection.Bind">
<summary>
Gets server events and binds them to this.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.SessionCollection.GetEnumerator">
<summary>
Gets enumerator.
</summary>
<returns></returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SessionCollection.Server">
<summary>
Gets the Server object that is the owner of this collection.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SessionCollection.Count">
<summary>
Gets number of sessions in server.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SessionCollection.Item(System.Int32)">
<summary>
Gets a Session object in the collection by index number.
</summary>
<param name="index">An Int32 value that specifies the position of the Session object in the SessionCollection collection.</param>
<returns>A Session object value that represents the session in server.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SessionCollection.Item(System.String)">
<summary>
Gets a Session object in the collection by filter ID.
</summary>
<param name="sessionID">A String value that specifies the session ID of the Session object in the SessionCollection collection.</param>
<returns>A Session object value that represents the session in server.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SessionCollection.List">
<summary>
Gets direct access to sessions collection.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.ServerAuthenticationType_enum">
<summary>
Specifies users authentication method.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.ServerAuthenticationType_enum.Integrated">
<summary>
Server uses local user names and passwords todo authentication.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.ServerAuthenticationType_enum.Windows">
<summary>
Server authenticates against windows.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.QueueItem">
<summary>
The Queues object represents SMTP/Relay queue item in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.QueueItem.#ctor(System.DateTime,System.String)">
<summary>
Default constructor.
</summary>
<param name="createTime">Queue item create time.</param>
<param name="header">Message header.</param>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.QueueItem.CreateTime">
<summary>
Gets queue item create time.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.QueueItem.Header">
<summary>
Gets message header.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.RestoreFlags_enum">
<summary>
Specifies virtual server backup restore options.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.RestoreFlags_enum.Add">
<summary>
All missing items added.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.RestoreFlags_enum.Replace">
<summary>
All existing items will be overwritten.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.Logs">
<summary>
Provides virtual server logging related methods.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.Logs.#ctor(LumiSoft.MailServer.API.UserAPI.VirtualServer)">
<summary>
Default constructor.
</summary>
<param name="virtualServer">Owner virtual server.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.Logs.GetSmtpLogSessions(System.Int32,System.DateTime,System.DateTime,System.DateTime,System.String)">
<summary>
Gets SMTP sessions logs.
</summary>
<param name="limit">Specifies maximum number of log entries to return.</param>
<param name="date">Date what logs to get.</param>
<param name="startTime">Start time filter.</param>
<param name="endTime">End time filter.</param>
<param name="containsText">Log record text filter. Pass null or "" if no text filter.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.Logs.GetPop3LogSessions(System.Int32,System.DateTime,System.DateTime,System.DateTime,System.String)">
<summary>
Gets POP3 sessions logs.
</summary>
<param name="limit">Specifies maximum number of log entries to return.</param>
<param name="date">Date what logs to get.</param>
<param name="startTime">Start time filter.</param>
<param name="endTime">End time filter.</param>
<param name="containsText">Log record text filter. Pass null or "" if no text filter.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.Logs.GetImapLogSessions(System.Int32,System.DateTime,System.DateTime,System.DateTime,System.String)">
<summary>
Gets IMAP sessions logs.
</summary>
<param name="limit">Specifies maximum number of log entries to return.</param>
<param name="date">Date what logs to get.</param>
<param name="startTime">Start time filter.</param>
<param name="endTime">End time filter.</param>
<param name="containsText">Log record text filter. Pass null or "" if no text filter.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.Logs.GetRelayLogSessions(System.Int32,System.DateTime,System.DateTime,System.DateTime,System.String)">
<summary>
Gets RELAY sessions logs.
</summary>
<param name="limit">Specifies maximum number of log entries to return.</param>
<param name="date">Date what logs to get.</param>
<param name="startTime">Start time filter.</param>
<param name="endTime">End time filter.</param>
<param name="containsText">Log record text filter. Pass null or "" if no text filter.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.Logs.GetFetchLogSessions(System.Int32,System.DateTime,System.DateTime,System.DateTime,System.String)">
<summary>
Gets FETCH sessions logs.
</summary>
<param name="limit">Specifies maximum number of log entries to return.</param>
<param name="date">Date what logs to get.</param>
<param name="startTime">Start time filter.</param>
<param name="endTime">End time filter.</param>
<param name="containsText">Log record text filter. Pass null or "" if no text filter.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.Logs.GetLogSessions(System.String,System.Int32,System.DateTime,System.DateTime,System.DateTime,System.String)">
<summary>
Gets specified service session logs.
</summary>
<param name="service">Service name. SMTP,POP3,IMAP,RELAY,FETCH.</param>
<param name="limit">Specifies maximum number of log entries to return.</param>
<param name="date">Date what logs to get.</param>
<param name="startTime">Start time filter.</param>
<param name="endTime">End time filter.</param>
<param name="containsText">Log record text filter. Pass null or "" if no text filter.</param>
<returns></returns>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.IPSecurityCollection">
<summary>
The IPSecurityCollection object represents IP security entries in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.IPSecurityCollection.#ctor(LumiSoft.MailServer.API.UserAPI.VirtualServer)">
<summary>
Default constructor.
</summary>
<param name="virtualServer">Owner virtual server.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.IPSecurityCollection.Add(System.Boolean,System.String,LumiSoft.MailServer.API.UserAPI.Service_enum,LumiSoft.MailServer.API.UserAPI.IPSecurityAction_enum,System.Net.IPAddress,System.Net.IPAddress)">
<summary>
Adds new security enrty to collection.
</summary>
<param name="enabled">Specifies if security entry is enabled.</param>
<param name="description">Security entry description text.</param>
<param name="service">Specifies service for what security entry applies.</param>
<param name="action">Specifies what action done if IP matches to security entry range.</param>
<param name="startIP">Range start IP.</param>
<param name="endIP">Range end IP.</param>
<returns></returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.IPSecurityCollection.Remove(LumiSoft.MailServer.API.UserAPI.IPSecurity)">
<summary>
Deletes and removes specified security entry from collection.
</summary>
<param name="entry"></param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.IPSecurityCollection.ToArray">
<summary>
Copies collection to array.
</summary>
<returns></returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.IPSecurityCollection.Refresh">
<summary>
Refreshes IP security entries.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.IPSecurityCollection.Bind">
<summary>
Gets server mailing list members and binds them to this, if not binded already.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.IPSecurityCollection.GetEnumerator">
<summary>
Gets enumerator.
</summary>
<returns></returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.IPSecurityCollection.VirtualServer">
<summary>
Gets the VirtualServer object that is the owner of this collection.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.IPSecurityCollection.Count">
<summary>
Gets number of IP security entries in virtual server.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.IPSecurityCollection.Item(System.Int32)">
<summary>
Gets a IPSecurity object in the collection by index number.
</summary>
<param name="index">An Int32 value that specifies the position of the IPSecurity object in the IPSecurityCollection collection.</param>
<returns>A IPSecurity object value that represents the filter in virtual server.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.IPSecurityCollection.Item(System.String)">
<summary>
Gets a IPSecurity object in the collection by filter ID.
</summary>
<param name="securityEntryID">A String value that specifies the IP security entry ID of the IPSecurity object in the IPSecurityCollection collection.</param>
<returns>A IPSecurity object value that represents the filter in virtual server.</returns>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection">
<summary>
The GlobalMessageRuleActionCollection object represents global message rule actions in global message rule.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection.#ctor(LumiSoft.MailServer.API.UserAPI.GlobalMessageRule)">
<summary>
Default constructor.
</summary>
<param name="rule">Owner global message rule.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection.Add_AddHeaderField(System.String,System.String,System.String)">
<summary>
Creates and adds new 'Add Header Field' action to GlobalMessageRuleActionCollection collection.
</summary>
<param name="description">Action description text.</param>
<param name="headerFieldName">Header field name.</param>
<param name="headerFieldValue">Header field value.</param>
<returns></returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection.Add_AutoResponse(System.String,System.String,System.Byte[])">
<summary>
Creates and adds new 'Auto Response' action to GlobalMessageRuleActionCollection collection.
</summary>
<param name="description">Action description text.</param>
<param name="from">MAIL FROM: what is reported to destination SMTP server when auto response is sent.</param>
<param name="message">Full auto response message. This must be rfc 2822 defined message.
You can use LumiSoft.Net.Mime class to parse and to construct valid message.</param>
<returns></returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection.Add_DeleteMessage(System.String)">
<summary>
Creates and adds new 'Delete Message' action to GlobalMessageRuleActionCollection collection.
</summary>
<param name="description">Action description text.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection.Add_ExecuteProgram(System.String,System.String,System.String)">
<summary>
Creates and adds new 'Execute Program' action to GlobalMessageRuleActionCollection collection.
</summary>
<param name="description">Action description text.</param>
<param name="program">Program to execute.</param>
<param name="programArguments">Executable program arguments</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection.Add_ForwardToEmail(System.String,System.String)">
<summary>
Creates and adds new 'Forward To Email' action to GlobalMessageRuleActionCollection collection.
</summary>
<param name="description">Action description text.</param>
<param name="email">Email address where to forward message.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection.Add_ForwardToHost(System.String,System.String,System.Int32)">
<summary>
Creates and adds new 'Forward To Host' action to GlobalMessageRuleActionCollection collection.
</summary>
<param name="description">Action description text.</param>
<param name="host">Host name or IP where to forward message.</param>
<param name="port">Destination host port.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection.Add_MoveToImapFolder(System.String,System.String)">
<summary>
Creates and adds new 'Move To IMAP Folder' action to GlobalMessageRuleActionCollection collection.
</summary>
<param name="description">Action description text.</param>
<param name="folder">IMAP folder where to move message. If specified folder doesn't exist, message is store users Inbox.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection.Add_PostToHttp(System.String,System.String)">
<summary>
Creates and adds new 'Post To HTTP' action to GlobalMessageRuleActionCollection collection.
</summary>
<param name="description">Action description text.</param>
<param name="url">HTTP URL where to post message.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection.Add_PostToNntp(System.String,System.String,System.Int32,System.String)">
<summary>
Creates and adds new 'Post To NNTP Newsgroup' action to GlobalMessageRuleActionCollection collection.
</summary>
<param name="description">Action description text.</param>
<param name="host">NTTP server where to post message.</param>
<param name="port">NNTP server port.</param>
<param name="newsgroup">NTTP newsgroup where to post message.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection.Add_RemoveHeaderField(System.String,System.String)">
<summary>
Creates and adds new 'Remove Header Field' action to GlobalMessageRuleActionCollection collection.
</summary>
<param name="description">Action description text.</param>
<param name="headerField">Header field name what to remove.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection.Add_SendError(System.String,System.String)">
<summary>
Creates and adds new 'Send Error To Client' action to GlobalMessageRuleActionCollection collection.
</summary>
<param name="description">Action description text.</param>
<param name="errorText">Error text..</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection.Add_StoreToDisk(System.String,System.String)">
<summary>
Creates and adds new 'Store To Disk Folder' action to GlobalMessageRuleActionCollection collection.
</summary>
<param name="description">Action description text.</param>
<param name="folder">Disk folder where to store message.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection.Add_StoreToFtp(System.String,System.String,System.Int32,System.String,System.String,System.String)">
<summary>
Creates and adds new 'Store To FTP Folder' action to GlobalMessageRuleActionCollection collection.
</summary>
<param name="description">Action description text.</param>
<param name="host">FTP server where to store message.</param>
<param name="port">FTP server port.</param>
<param name="userName">FTP server user name.</param>
<param name="password">FTP server user password.</param>
<param name="folder">FTP folder where to store message.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection.Add(LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionBase)">
<summary>
Adds specified action to global message rule.
</summary>
<param name="action">Action to add.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection.Add(System.String,System.String,LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_enum,System.Byte[],System.Boolean)">
<summary>
Adds specified action to connected server.
</summary>
<param name="actionID">Action ID.</param>
<param name="description">Action description.</param>
<param name="type">Action type.</param>
<param name="actionData">Action data.</param>
<param name="addToCollection">Specifies if added action must be created locally and added to local collection.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection.Remove(LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionBase)">
<summary>
Deletes specified action from global message rule.
</summary>
<param name="action">Action to remove.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection.Bind">
<summary>
Gets server global message rule actions and binds them to this, if not binded already.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection.GetAction(System.String,System.String,LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_enum,System.Byte[])">
<summary>
Gets global message rule action.
</summary>
<param name="actionID">Action ID.</param>
<param name="description">Action description.</param>
<param name="actionType">Action type.</param>
<param name="actionData">Action data.</param>
<returns></returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection.GetEnumerator">
<summary>
Gets enumerator.
</summary>
<returns></returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection.Rule">
<summary>
Gets owner message rule where this actions apply.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection.Count">
<summary>
Gets number of global message rule actions.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection.Item(System.Int32)">
<summary>
Gets a GlobalMessageRuleActionBase object in the collection by index number.
</summary>
<param name="index">An Int32 value that specifies the position of the GlobalMessageRuleActionBase object in the GlobalMessageRuleActionCollection collection.</param>
<returns>A GlobalMessageRuleActionBase object value that represents the global message rule action in virtual server.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection.Item(System.String)">
<summary>
Gets a GlobalMessageRuleActionBase object in the collection by global message rule ID.
</summary>
<param name="globalMessageRuleActionID">A String value that specifies the global message rule action ID of the GlobalMessageRuleActionBase object in the GlobalMessageRuleActionCollection collection.</param>
<returns>A GlobalMessageRuleActionBase object value that represents the global message rule action in virtual server.</returns>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_ForwardToHost">
<summary>
The UserMessageRuleAction_ForwardToHost object represents user message rule "Forward To Host" action in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_ForwardToHost.#ctor(LumiSoft.MailServer.API.UserAPI.UserMessageRule,LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection,System.String,System.String,System.Byte[])">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner UserMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="actionData">Action data.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_ForwardToHost.#ctor(LumiSoft.MailServer.API.UserAPI.UserMessageRule,LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection,System.String,System.String,System.String,System.Int32)">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner UserMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="host">Host name or IP where to forward message.</param>
<param name="port">Destination host port.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_ForwardToHost.Serialize">
<summary>
Serialices action object.
</summary>
<returns>Returns serialized action data.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_ForwardToHost.HasChanges">
<summary>
Gets if this object has changes what isn't stored to mail server by calling Commit().
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_ForwardToHost.Host">
<summary>
Gets or sets host name or IP where to forward message.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_ForwardToHost.Port">
<summary>
Gets or sets destination host port.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_AddHeaderField">
<summary>
The UserMessageRuleAction_AddHeaderField object represents user message rule "Add Header Field" action in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_AddHeaderField.#ctor(LumiSoft.MailServer.API.UserAPI.UserMessageRule,LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection,System.String,System.String,System.Byte[])">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner GlobalMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="actionData">Action data.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_AddHeaderField.#ctor(LumiSoft.MailServer.API.UserAPI.UserMessageRule,LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection,System.String,System.String,System.String,System.String)">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that owns this action.</param>
<param name="owner">Owner UserMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="headerFieldName">Header field name.</param>
<param name="headerFieldValue">Header field name.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_AddHeaderField.Serialize">
<summary>
Serialices action object.
</summary>
<returns>Returns serialized action data.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_AddHeaderField.HasChanges">
<summary>
Gets if this object has changes what isn't stored to mail server by calling Commit().
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_AddHeaderField.HeaderFieldName">
<summary>
Gets or sets header field name what is added.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_AddHeaderField.HeaderFieldValue">
<summary>
Gets or sets header field value.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.UserCollection">
<summary>
The UserCollection object represents users in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserCollection.#ctor(LumiSoft.MailServer.API.UserAPI.VirtualServer)">
<summary>
Default constructor.
</summary>
<param name="virtualServer">Owner virtual server.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserCollection.Add(System.String,System.String,System.String,System.String,System.Int32,System.Boolean,LumiSoft.MailServer.API.UserAPI.UserPermissions_enum)">
<summary>
Adds new user to virtual server.
</summary>
<param name="userName">User login name.</param>
<param name="fullName">User full name.</param>
<param name="password">User login password.</param>
<param name="description">User description.</param>
<param name="mailboxSize">Maximum mailbox size in MB.</param>
<param name="enabled">Sepcifies if user is enabled.</param>
<param name="permissions">Specifies user permissions.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserCollection.Remove(LumiSoft.MailServer.API.UserAPI.User)">
<summary>
Removes specified user from virtual server.
</summary>
<param name="user">User to remove.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserCollection.Contains(System.String)">
<summary>
Check if collection contains user with specified name.
</summary>
<param name="userName">User name.</param>
<returns></returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserCollection.GetUserByName(System.String)">
<summary>
Gets a User object in the collection by user name.
</summary>
<param name="userName">User name.</param>
<returns>A User object value that represents the user in virtual server.</returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserCollection.Refresh">
<summary>
Refreshes users.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserCollection.Bind">
<summary>
Gets server users and binds them to this, if not binded already.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserCollection.GetEnumerator">
<summary>
Gets enumerator.
</summary>
<returns></returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserCollection.VirtualServer">
<summary>
Gets the VirtualServer object that is the owner of this collection.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserCollection.Count">
<summary>
Gets number of users in virtual server.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserCollection.Item(System.Int32)">
<summary>
Gets a User object in the collection by index number.
</summary>
<param name="index">An Int32 value that specifies the position of the User object in the UserCollection collection.</param>
<returns>A User object value that represents the user in virtual server.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserCollection.Item(System.String)">
<summary>
Gets a User object in the collection by user ID.
</summary>
<param name="userID">A String value that specifies the user ID of the User object in the UserCollection collection.</param>
<returns>A User object value that represents the user in virtual server.</returns>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.User">
<summary>
The User object represents user in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.User.#ctor(LumiSoft.MailServer.API.UserAPI.VirtualServer,LumiSoft.MailServer.API.UserAPI.UserCollection,System.String,System.Boolean,System.String,System.String,System.String,System.String,System.Int32,LumiSoft.MailServer.API.UserAPI.UserPermissions_enum,System.DateTime)">
<summary>
Default constructor.
</summary>
<param name="virtualServer">Owner virtual server.</param>
<param name="owner">Owner UserCollection collection that owns this user.</param>
<param name="id">User ID.</param>
<param name="enabled">Specifies if user is enabled.</param>
<param name="userName">User login name.</param>
<param name="password">User password.</param>
<param name="fullName">User full name.</param>
<param name="description">User description.</param>
<param name="mailboxSize">Mailbox size in MB.</param>
<param name="permissions">Specifies user permissions.</param>
<param name="creationTime">Time when user was created.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.User.Commit">
<summary>
Tries to save all changed values to server. Throws Exception if fails.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.User.VirtualServer">
<summary>
Gets virtual server to where this collection belongs to.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.User.Owner">
<summary>
Gets owner UserCollection that owns this user.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.User.HasChanges">
<summary>
Gets if this user object has changes what isn't stored to mail server by calling Commit().
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.User.UserID">
<summary>
Gets user ID.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.User.Enabled">
<summary>
Gets or sets if user is enabled.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.User.UserName">
<summary>
Gets or sets user login name.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.User.Password">
<summary>
Gets or sets user password.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.User.FullName">
<summary>
Gets or sets user full name.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.User.Description">
<summary>
Gets or sets user description.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.User.MaximumMailboxSize">
<summary>
Gets or sets user maximum mailbox size in MB.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.User.MailboxSize">
<summary>
Gets user mailbox size in bytes.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.User.Permissions">
<summary>
Gets or sets user permissions.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.User.EmailAddresses">
<summary>
Gets user email addresses.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.User.Folders">
<summary>
Gets user folders.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.User.MessageRules">
<summary>
Gets user remote servers.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.User.RemoteServers">
<summary>
Gets user remote servers.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.User.CreationTime">
<summary>
Gets date/time when user was created.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.User.LastLogin">
<summary>
Gets user last login time.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_PostToNntpNewsgroup">
<summary>
The GlobalMessageRuleAction_PostToNntpNewsgroup object represents global message rule "Post To NNTP Newsgroup" action in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_PostToNntpNewsgroup.#ctor(LumiSoft.MailServer.API.UserAPI.GlobalMessageRule,LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection,System.String,System.String,System.Byte[])">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner GlobalMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="actionData">Action data.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_PostToNntpNewsgroup.#ctor(LumiSoft.MailServer.API.UserAPI.GlobalMessageRule,LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection,System.String,System.String,System.String,System.Int32,System.String)">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner GlobalMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="host">NTTP server where to post message.</param>
<param name="port">NNTP server port.</param>
<param name="newsgroup">NTTP newsgroup where to post message.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_PostToNntpNewsgroup.Serialize">
<summary>
Serialices action object.
</summary>
<returns>Returns serialized action data.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_PostToNntpNewsgroup.ActionType">
<summary>
Get global message rule action type.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_PostToNntpNewsgroup.HasChanges">
<summary>
Gets if this object has changes what isn't stored to mail server by calling Commit().
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_PostToNntpNewsgroup.Server">
<summary>
Gets or sets NNTP server where to post message.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_PostToNntpNewsgroup.Port">
<summary>
Gets or sets NNTP server port.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_PostToNntpNewsgroup.Newsgroup">
<summary>
Gets or sets NTTP newsgroup where to post message.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_MoveToImapFolder">
<summary>
The GlobalMessageRuleAction_MoveToImapFolder object represents global message rule "Move To IMAP Folder" action in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_MoveToImapFolder.#ctor(LumiSoft.MailServer.API.UserAPI.GlobalMessageRule,LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection,System.String,System.String,System.Byte[])">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner GlobalMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="actionData">Action data.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_MoveToImapFolder.#ctor(LumiSoft.MailServer.API.UserAPI.GlobalMessageRule,LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection,System.String,System.String,System.String)">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner GlobalMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="folder">IMAP folder where to move message. If specified folder doesn't exist, message is store users Inbox.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_MoveToImapFolder.Serialize">
<summary>
Serialices action object.
</summary>
<returns>Returns serialized action data.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_MoveToImapFolder.ActionType">
<summary>
Get global message rule action type.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_MoveToImapFolder.HasChanges">
<summary>
Gets if this object has changes what isn't stored to mail server by calling Commit().
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_MoveToImapFolder.Folder">
<summary>
Gets or sets IMAP folder where to move message. If specified folder doesn't exist, message is store users Inbox.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_DeleteMessage">
<summary>
The GlobalMessageRuleAction_DeleteMessage object represents global message rule "Delete Message" action in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_DeleteMessage.#ctor(LumiSoft.MailServer.API.UserAPI.GlobalMessageRule,LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection,System.String,System.String)">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner GlobalMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_DeleteMessage.Serialize">
<summary>
Serialices action object.
</summary>
<returns>Returns serialized action data.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_DeleteMessage.ActionType">
<summary>
Get global message rule action type.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.XmlTable">
<summary>
Represents simple xml serializable/deserializable name/value table.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.XmlTable.#ctor(System.String)">
<summary>
Default constructor.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.XmlTable.Add(System.String,System.String)">
<summary>
Adds name/value to table.
</summary>
<param name="name">Name of the value pair.</param>
<param name="value">Value.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.XmlTable.GetValue(System.String)">
<summary>
Gets value from name/value table.
</summary>
<param name="name">Name of value to get.</param>
<returns></returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.XmlTable.Parse(System.Byte[])">
<summary>
Parses table from byte[] xml data.
</summary>
<param name="data">Table data.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.XmlTable.ToStringData">
<summary>
Returns string representation of xml table.
</summary>
<returns>Returns string representation of xml table.</returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.XmlTable.ToByteData">
<summary>
Returns byte[] representation of xml table.
</summary>
<returns>Returns byte[] representation of xml table.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.XmlTable.TableName">
<summary>
Gets or sets table name.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.UsersDefaultFolder">
<summary>
The UsersDefaultFolder object represents users default folder in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UsersDefaultFolder.#ctor(LumiSoft.MailServer.API.UserAPI.UsersDefaultFolderCollection,System.String,System.Boolean)">
<summary>
Default constructor.
</summary>
<param name="owner">Owner UsersDefaultFolderCollection collection that owns this.</param>
<param name="folderName">Folder name.</param>
<param name="permanent">Specifies if folder is permanent (User can't delete it).</param>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UsersDefaultFolder.Owner">
<summary>
Gets owner UsersDefaultFolderCollection that owns this.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UsersDefaultFolder.FolderName">
<summary>
Gets folder name.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UsersDefaultFolder.Permanent">
<summary>
Gets if folder is permanent (User can't delete it).
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.UserPermissions_enum">
<summary>
User permission flags.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.UserPermissions_enum.None">
<summary>
None of the permissions.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.UserPermissions_enum.All">
<summary>
All permissions.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.UserPermissions_enum.POP3">
<summary>
POP3 access.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.UserPermissions_enum.IMAP">
<summary>
IMAP access.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.UserPermissions_enum.Relay">
<summary>
Can relay. This permission is used only if connected user IP doesn't have relay permission.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.SharedRootFolderCollection">
<summary>
The SharedRootFolderCollection object represents shared root folders in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.SharedRootFolderCollection.#ctor(LumiSoft.MailServer.API.UserAPI.VirtualServer)">
<summary>
Default constructor.
</summary>
<param name="virtualServer">Owner virtual server.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.SharedRootFolderCollection.Add(System.Boolean,System.String,System.String,LumiSoft.MailServer.API.UserAPI.SharedFolderRootType_enum,System.String,System.String)">
<summary>
Adds new shared root folder to virtual server.
</summary>
<param name="enabled">Specifies if shared root folder is enabled.</param>
<param name="name">Shared root folder name.</param>
<param name="description">Shared root folder description.</param>
<param name="type">Shared root folder type.</param>
<param name="boundedUser">Bounded user.</param>
<param name="boundedFolder">Bounded folder.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.SharedRootFolderCollection.Remove(LumiSoft.MailServer.API.UserAPI.SharedRootFolder)">
<summary>
Removes specified shared root folder from virtual server.
</summary>
<param name="sharedFolder">Shared folder to delete.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.SharedRootFolderCollection.Contains(System.String)">
<summary>
Check if collection contains root folder with specified name.
</summary>
<param name="rootFolderName">Root folder name.</param>
<returns></returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.SharedRootFolderCollection.GetRootFolderByName(System.String)">
<summary>
Gets a SharedRootFolder object in the collection by root folder name.
</summary>
<param name="rootFolderName">Root folder name.</param>
<returns>A SharedRootFolder object value that represents the shared root folder in virtual server.</returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.SharedRootFolderCollection.Bind">
<summary>
Gets server shared root folders and binds them to this.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.SharedRootFolderCollection.GetEnumerator">
<summary>
Gets enumerator.
</summary>
<returns></returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SharedRootFolderCollection.VirtualServer">
<summary>
Gets the VirtualServer object that is the owner of this collection.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SharedRootFolderCollection.Count">
<summary>
Gets number of shared root folders in virtual server.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SharedRootFolderCollection.Item(System.Int32)">
<summary>
Gets a SharedRootFolder object in the collection by index number.
</summary>
<param name="index">An Int32 value that specifies the position of the SharedRootFolder object in the SharedRootFolderCollection collection.</param>
<returns>A SharedRootFolder object value that represents the shared root folder in virtual server.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SharedRootFolderCollection.Item(System.String)">
<summary>
Gets a SharedRootFolder object in the collection by group ID.
</summary>
<param name="rootFolderID">A String value that specifies the shared root folder ID of the SharedRootFolder object in the SharedRootFolderCollection collection.</param>
<returns>A SharedRootFolder object value that represents the shared root folder in virtual server.</returns>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.Session">
<summary>
The Session object represents sessions(SMTP,POP3,...) event in LumiSoft Mail Server server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.Session.#ctor(LumiSoft.MailServer.API.UserAPI.SessionCollection,System.String,System.String,System.DateTime,System.Int32,System.String,System.String,System.String,System.Int32,System.Int32,System.String)">
<summary>
Default constructor.
</summary>
<param name="owner">Owner SessionCollection collection that owns this object.</param>
<param name="id">Session ID.</param>
<param name="type">Session type.</param>
<param name="startTime">Session start time.</param>
<param name="timeoutSec">Session timeout seconds after no activity.</param>
<param name="userName">Session authenticated user.</param>
<param name="localEndPoint">Session local end point.</param>
<param name="remoteEndPoint">Session remote end point.</param>sessionLog
<param name="readKbSec">Session read KB in second.</param>
<param name="writeKbSec">Session write KB in second.</param>
<param name="sessionLog">Session log part.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.Session.Kill">
<summary>
Kills specified session.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Session.ID">
<summary>
Gets session ID.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Session.Type">
<summary>
Gets session type (SMTP,POP3,...).
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Session.SartTime">
<summary>
Gets session start time.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Session.IdleTimeOutSeconds">
<summary>
Gets after how many seconds session will time out if no activity.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Session.UserName">
<summary>
Gets session authenticated user name.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Session.LocalEndPoint">
<summary>
Gets session local endpoint.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Session.RemoteEndPoint">
<summary>
Gets session remote endpoint.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Session.ReadKbInSecond">
<summary>
Gets session read KB in second.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Session.WriteKbInSecond">
<summary>
Gets session write KB in second.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Session.SessionLog">
<summary>
Gets session active log part.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.GroupCollection">
<summary>
The GroupCollection object represents user groups in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GroupCollection.#ctor(LumiSoft.MailServer.API.UserAPI.VirtualServer)">
<summary>
Default constructor.
</summary>
<param name="virtualServer">Owner virtual server.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GroupCollection.Add(System.String,System.String,System.Boolean)">
<summary>
Creates and adds new group to group collection.
</summary>
<param name="name">Group name.</param>
<param name="description">Group description.</param>
<param name="enabled">Specifies if group is enabled.</param>
<returns></returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GroupCollection.Remove(LumiSoft.MailServer.API.UserAPI.Group)">
<summary>
Deletes and removes specified group from group collection.
</summary>
<param name="group">Group to delete.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GroupCollection.Contains(System.String)">
<summary>
Check if collection contains group with specified name.
</summary>
<param name="groupName">Group name.</param>
<returns></returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GroupCollection.GetGroupByName(System.String)">
<summary>
Gets a Group object in the collection by group name.
</summary>
<param name="groupName">Group name.</param>
<returns>A Group object value that represents the group in virtual server.</returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GroupCollection.Refresh">
<summary>
Refreshes groups.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GroupCollection.Bind">
<summary>
Gets server groups and binds them to this.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GroupCollection.GetEnumerator">
<summary>
Gets enumerator.
</summary>
<returns></returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GroupCollection.VirtualServer">
<summary>
Gets the VirtualServer object that is the owner of this collection.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GroupCollection.Count">
<summary>
Gets number of groups in virtual server.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GroupCollection.Item(System.Int32)">
<summary>
Gets a Group object in the collection by index number.
</summary>
<param name="index">An Int32 value that specifies the position of the Group object in the GroupCollection collection.</param>
<returns>A Group object value that represents the group in virtual server.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GroupCollection.Item(System.String)">
<summary>
Gets a Group object in the collection by group ID.
</summary>
<param name="groupID">A String value that specifies the group ID of the Group object in the GroupCollection collection.</param>
<returns>A Group object value that represents the group in virtual server.</returns>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_enum">
<summary>
Specifies match action done when global message rule is matched.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_enum.AutoResponse">
<summary>
AutoResponse is sent to specified recipient.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_enum.DeleteMessage">
<summary>
Deletes message.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_enum.ForwardToEmail">
<summary>
Message is forwarded to specified email.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_enum.ForwardToHost">
<summary>
Message is forwarded to specified host.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_enum.StoreToDiskFolder">
<summary>
Message is stored to specified disk folder.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_enum.ExecuteProgram">
<summary>
Specified program is executed.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_enum.MoveToIMAPFolder">
<summary>
Moves message to specified message folder(for example: Junk). This will take effect only for local recipients only !
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_enum.AddHeaderField">
<summary>
Appends specified header field to message.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_enum.RemoveHeaderField">
<summary>
Removes specified header field or fields if there are multiple of them.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_enum.SendErrorToClient">
<summary>
Sends error to currently connected client. NOTE: Error text may contain ASCII printable chars only and maximum length is 500.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_enum.StoreToFTPFolder">
<summary>
Stores message to specified FTP server folder.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_enum.PostToNNTPNewsGroup">
<summary>
Posts message to specified NNTP newsgroup.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_enum.PostToHTTP">
<summary>
Posts message to specified page via HTTP.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_AddHeaderField">
<summary>
The GlobalMessageRuleAction_AddHeaderField object represents global message rule "Add Header Field" action in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_AddHeaderField.#ctor(LumiSoft.MailServer.API.UserAPI.GlobalMessageRule,LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection,System.String,System.String,System.Byte[])">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner GlobalMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="actionData">Action data.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_AddHeaderField.#ctor(LumiSoft.MailServer.API.UserAPI.GlobalMessageRule,LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection,System.String,System.String,System.String,System.String)">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that owns this action.</param>
<param name="owner">Owner GlobalMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="headerFieldName">Header field name.</param>
<param name="headerFieldValue">Header field name.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_AddHeaderField.Serialize">
<summary>
Serialices action object.
</summary>
<returns>Returns serialized action data.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_AddHeaderField.ActionType">
<summary>
Get global message rule action type.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_AddHeaderField.HasChanges">
<summary>
Gets if this object has changes what isn't stored to mail server by calling Commit().
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_AddHeaderField.HeaderFieldName">
<summary>
Gets or sets header field name what is added.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_AddHeaderField.HeaderFieldValue">
<summary>
Gets or sets header field value.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.ConvertEx">
<summary>
Convert methods.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.ConvertEx.ToString(System.Object)">
<summary>
Converts object to string. If value == null, returns "".
</summary>
<param name="value">Value to be converted.</param>
<returns></returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.ConvertEx.ToBoolean(System.Object)">
<summary>
Convert object to bool. If value == null or object can't be converted to bool, returns false.
</summary>
<param name="value">Value to be converted.</param>
<returns></returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.ConvertEx.ToBoolean(System.Object,System.Boolean)">
<summary>
Convert object to bool. If value == null or object can't be converted to bool, returns false.
</summary>
<param name="value">Value to be converted.</param>
<param name="defaultValue">If parsing fails, this default value is used then.</param>
<returns></returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.ConvertEx.ToInt32(System.Object)">
<summary>
Convert object to int. If value == null or object can't be converted to int, returns 0.
</summary>
<param name="value"></param>
<returns></returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.ConvertEx.ToIPEndPoint(System.String,System.Net.IPEndPoint)">
<summary>
Converts specified value to IP end point. Returns default value specified if parsing fails.
</summary>
<param name="value">Value to convert.</param>
<param name="defultValue">Default value if parsing fails.</param>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.UserRemoteServer">
<summary>
The UserRemoteServer object represents remote server in user.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserRemoteServer.#ctor(LumiSoft.MailServer.API.UserAPI.User,LumiSoft.MailServer.API.UserAPI.UserRemoteServerCollection,System.String,System.String,System.String,System.Int32,System.Boolean,System.String,System.String,System.Boolean)">
<summary>
Default constructor.
</summary>
<param name="ownerUser">User that owns specified remote server.</param>
<param name="owner">Owner UserRemoteServerCollection collection that owns this remote server.</param>
<param name="id">Remote server ID.</param>
<param name="description">Remote server description.</param>
<param name="host">Remote server name or IP.</param>
<param name="port">Remote server port.</param>
<param name="ssl">Specifies if connected to remote server via SSL.</param>
<param name="userName">Remote server user name.</param>
<param name="password">Remote server password.</param>
<param name="enabled">Specifies if remote server is enabled.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserRemoteServer.Commit">
<summary>
Tries to save all changed values to server. Throws Exception if fails.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserRemoteServer.Owner">
<summary>
Gets onwer UserRemoteServerCollection that owns this remote server.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserRemoteServer.ID">
<summary>
Gets remote server id.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserRemoteServer.Description">
<summary>
Gets or sets remote server description.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserRemoteServer.Host">
<summary>
Gets or sets remote server name or IP.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserRemoteServer.Port">
<summary>
Gets or sets remote server port.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserRemoteServer.SSL">
<summary>
Gets or sets if connection is madet to remote server via SSL.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserRemoteServer.UserName">
<summary>
Gets or sets remote server user name.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserRemoteServer.Password">
<summary>
Gets or sets remote server password.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserRemoteServer.Enabled">
<summary>
Gets or sets if remote server is enabled.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.SIP_Settings">
<summary>
The SIP_Settings object represents SIP settings in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.SIP_Settings.#ctor(LumiSoft.MailServer.API.UserAPI.System_Settings,System.Boolean,System.String,System.Int32,LumiSoft.MailServer.API.UserAPI.BindInfo[])">
<summary>
Default constructor.
</summary>
<param name="sysSettings">Reference to system settings.</param>
<param name="enabled">Specifies if IMAP service is enabled.</param>
<param name="hostName">SIP host name.</param>
<param name="minExpires">SIP minimum content expire time in seconds.</param>
<param name="bindings">Specifies SIP listening info.</param>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SIP_Settings.Enabled">
<summary>
Gets or sets if IMAP server is enabled.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SIP_Settings.HostName">
<summary>
Gets or sets SIP hostname. For example sip.lumisoft.ee.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SIP_Settings.MinimumExpires">
<summary>
Gets or set SIP minimum allowed content expire time in seconds.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SIP_Settings.Binds">
<summary>
Gets IP bindings.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.MailingListCollection">
<summary>
The MailingListCollection object represents mailing lists in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.MailingListCollection.#ctor(LumiSoft.MailServer.API.UserAPI.VirtualServer)">
<summary>
Default constructor.
</summary>
<param name="virtualServer">Owner virtual server.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.MailingListCollection.Add(System.String,System.String,System.Boolean)">
<summary>
Adds new mailing list to virtual server.
</summary>
<param name="name">Mailing list name.</param>
<param name="description">Mailing list description.</param>
<param name="enabled">Specifies if mailing list is enabled.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.MailingListCollection.Remove(LumiSoft.MailServer.API.UserAPI.MailingList)">
<summary>
Deletes specified mailing list from virtual server.
</summary>
<param name="mailingList"></param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.MailingListCollection.Contains(System.String)">
<summary>
Check if collection contains mailing list with specified name.
</summary>
<param name="mailingListName">Mailing list name.</param>
<returns></returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.MailingListCollection.GetMailingListByName(System.String)">
<summary>
Gets a MailingList object in the collection by mailing list name.
</summary>
<param name="mailingListName">Mailing list name.</param>
<returns>A MailingList object value that represents the mailing list in virtual server.</returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.MailingListCollection.Refresh">
<summary>
Refreshes mailing lists.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.MailingListCollection.Bind">
<summary>
Gets server mailing lists and binds them to this, if not binded already.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.MailingListCollection.GetEnumerator">
<summary>
Gets enumerator.
</summary>
<returns></returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.MailingListCollection.VirtualServer">
<summary>
Gets the VirtualServer object that is the owner of this collection.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.MailingListCollection.Count">
<summary>
Gets number of mailing lists in virtual server.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.MailingListCollection.Item(System.Int32)">
<summary>
Gets a MailingList object in the collection by index number.
</summary>
<param name="index">An Int32 value that specifies the position of the MailingList object in the MailingListCollection collection.</param>
<returns>A MailingList object value that represents the mailing list in virtual server.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.MailingListCollection.Item(System.String)">
<summary>
Gets a MailingList object in the collection by mailing list ID.
</summary>
<param name="mailingListID">A String value that specifies the mailing list ID of the Group object in the MailingListCollection collection.</param>
<returns>A MailingList object value that represents the mailing list in virtual server.</returns>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.LogSession">
<summary>
The LogSession object represents user session log in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.LogSession.#ctor(LumiSoft.MailServer.API.UserAPI.VirtualServer,System.String,System.String,System.DateTime,System.Net.IPEndPoint,System.String)">
<summary>
Default constructor.
</summary>
<param name="virtualServer">Reference to owner virtual server.</param>
<param name="service">Service. SMTP,POP3,IMAP,RELAY,FETCH.</param>
<param name="sessionID">Session ID.</param>
<param name="startTime">Session start time.</param>
<param name="remoteEndPoint">Remote end point.</param>
<param name="userName">Authenticated user name.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.LogSession.GetLogText">
<summary>
Gets log text (TAB delimited log fields).
</summary>
<returns></returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.LogSession.SessionID">
<summary>
Gets session ID.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.LogSession.StartTime">
<summary>
Gets session start time.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.LogSession.RemoteEndPoint">
<summary>
Gets remote end point.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.LogSession.UserName">
<summary>
Gets session authenticated user name.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.LogSession.LogText">
<summary>
Gets log text (TAB delimited log fields).
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.IPSecurity">
<summary>
The IPSecurity object represents IP security entry in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.IPSecurity.#ctor(LumiSoft.MailServer.API.UserAPI.IPSecurityCollection,System.String,System.Boolean,System.String,LumiSoft.MailServer.API.UserAPI.Service_enum,LumiSoft.MailServer.API.UserAPI.IPSecurityAction_enum,System.Net.IPAddress,System.Net.IPAddress)">
<summary>
Default constructor.
</summary>
<param name="owner">Owner IPSecurityCollection collection that owns this object.</param>
<param name="id">Security entry ID.</param>
<param name="enabled">Specifies if security entry is enabled.</param>
<param name="description">Security entry description text.</param>
<param name="service">Specifies service for what security entry applies.</param>
<param name="action">Specifies what action done if IP matches to security entry range.</param>
<param name="startIP">Range start IP.</param>
<param name="endIP">Range end IP.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.IPSecurity.Commit">
<summary>
Tries to save all changed values to server. Throws Exception if fails.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.IPSecurity.Owner">
<summary>
Gets owner IPSecurityCollection that owns this object.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.IPSecurity.HasChanges">
<summary>
Gets if this object has changes what isn't stored to mail server by calling Commit().
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.IPSecurity.ID">
<summary>
Gets IP security entry ID.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.IPSecurity.Enabled">
<summary>
Gets or sets if IP security entry is enabled.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.IPSecurity.Description">
<summary>
Gets or sets description text.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.IPSecurity.Service">
<summary>
Gets or sets service.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.IPSecurity.Action">
<summary>
Gets or sets action.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.IPSecurity.StartIP">
<summary>
Gets or sets range start IP address.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.IPSecurity.EndIP">
<summary>
Gets or sets range end IP address.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.Event">
<summary>
The Event object represents user event in LumiSoft Mail Server server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.Event.#ctor(System.String,LumiSoft.MailServer.API.UserAPI.EventType_enum,System.String,System.DateTime,System.String,System.String)">
<summary>
Default constructor.
</summary>
<param name="id">Event ID.</param>
<param name="type">Event type.</param>
<param name="virtualServer">Virtual server name or "" if global error.</param>
<param name="createDate">Event create date.</param>
<param name="message">Event message.</param>
<param name="text">Event extended info.</param>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Event.ID">
<summary>
Gets event ID.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Event.Type">
<summary>
Gets event type.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Event.VirtualServer">
<summary>
Gets virtual server name or "" if global error.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Event.CreateDate">
<summary>
Gets when events is created.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Event.Text">
<summary>
Gets event extended info.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_StoreToDiskFolder">
<summary>
The UserMessageRuleAction_StoreToDiskFolder object represents user message rule "Store To Disk Folder" action in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_StoreToDiskFolder.#ctor(LumiSoft.MailServer.API.UserAPI.UserMessageRule,LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection,System.String,System.String,System.Byte[])">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner UserMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="actionData">Action data.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_StoreToDiskFolder.#ctor(LumiSoft.MailServer.API.UserAPI.UserMessageRule,LumiSoft.MailServer.API.UserAPI.UserMessageRuleActionCollection,System.String,System.String,System.String)">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner UserMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="folder">Disk folder where to store message.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_StoreToDiskFolder.Serialize">
<summary>
Serialices action object.
</summary>
<returns>Returns serialized action data.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_StoreToDiskFolder.HasChanges">
<summary>
Gets if this object has changes what isn't stored to mail server by calling Commit().
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_StoreToDiskFolder.Folder">
<summary>
Gets or sets disk folder where to store message.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_enum">
<summary>
Specifies match action done when user message rule is matched.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_enum.AutoResponse">
<summary>
AutoResponse is sent to specified recipient.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_enum.DeleteMessage">
<summary>
Deletes message.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_enum.ForwardToEmail">
<summary>
Message is forwarded to specified email.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_enum.ForwardToHost">
<summary>
Message is forwarded to specified host.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_enum.StoreToDiskFolder">
<summary>
Message is stored to specified disk folder.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_enum.ExecuteProgram">
<summary>
Specified program is executed.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_enum.MoveToIMAPFolder">
<summary>
Moves message to specified message folder(for example: Junk). This will take effect only for local recipients only !
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_enum.AddHeaderField">
<summary>
Appends specified header field to message.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_enum.RemoveHeaderField">
<summary>
Removes specified header field or fields if there are multiple of them.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_enum.StoreToFTPFolder">
<summary>
Stores message to specified FTP server folder.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_enum.PostToNNTPNewsGroup">
<summary>
Posts message to specified NNTP newsgroup.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.UserMessageRuleAction_enum.PostToHTTP">
<summary>
Posts message to specified page via HTTP.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.UserFolder">
<summary>
The UserFolder object represents user folder in user.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserFolder.#ctor(LumiSoft.MailServer.API.UserAPI.UserFolderCollection,LumiSoft.MailServer.API.UserAPI.User,LumiSoft.MailServer.API.UserAPI.UserFolder,System.String,System.String)">
<summary>
Default constructor.
</summary>
<param name="owner">Owner UserFolderCollection collection that owns this object.</param>
<param name="user">Owner user.</param>
<param name="parent">Gets parent folder.</param>
<param name="folderPath">Folder path where folder belongs to.</param>
<param name="folderName">Folder name.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserFolder.Rename(System.String)">
<summary>
Renames/moves folder name.
</summary>
<param name="newFolderName">Full folder path, path + folder name.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserFolder.GetMessagesInfo">
<summary>
Gets folder messages info.
</summary>
<returns></returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserFolder.DeleteMessage(System.String,System.Int64)">
<summary>
Deletes specified message.
</summary>
<param name="messageID">Message ID.</param>
<param name="uid">Message IMAP UID value.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserFolder.GetMessage(System.String,System.IO.Stream)">
<summary>
Gets specified message and stores it to specified stream.
</summary>
<param name="messageID">Message ID.</param>
<param name="message">Stream where to store message.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserFolder.StoreMessage(System.IO.Stream)">
<summary>
Stores specified message to this folder. Message storing begins from stream current position.
</summary>
<param name="message">Message to store.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.UserFolder.GetFolderInfo">
<summary>
Gets folder info. Return structure: {creationDate,numberOfMessages,sizeUsed}.
</summary>
<returns></returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserFolder.Owner">
<summary>
Gets owner UserFolderCollection that owns this object.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserFolder.User">
<summary>
Gets user who owns that folder.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserFolder.Parent">
<summary>
Gets parent folder collection. Returns null if this is root folders collection.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserFolder.FolderName">
<summary>
Gets folder name. NOTE: Path isn't included !
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserFolder.FolderPath">
<summary>
Gets folder path. NOTE: Folder name isn't included !
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserFolder.FolderFullPath">
<summary>
Gets folder path. NOTE: Folder name is included !
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserFolder.ACL">
<summary>
Gets specified folder specified ACL entires.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserFolder.ChildFolders">
<summary>
Gets specified folder child folders.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserFolder.MessagesCount">
<summary>
Gets number of messages in this folder.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserFolder.SizeUsed">
<summary>
Gets number bytes this folder messages allocate.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.UserFolder.CreationTime">
<summary>
Gets date/time when folder was created.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.SharedFolderRootType_enum">
<summary>
Specifies shared folder root folder type.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.SharedFolderRootType_enum.BoundedRootFolder">
<summary>
Root folder is bounded to some user account.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.SharedFolderRootType_enum.UsersSharedFolder">
<summary>
Users shared folders will be added into this root folder.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_StoreToDiskFolder">
<summary>
The GlobalMessageRuleAction_StoreToDiskFolder object represents global message rule "Store To Disk Folder" action in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_StoreToDiskFolder.#ctor(LumiSoft.MailServer.API.UserAPI.GlobalMessageRule,LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection,System.String,System.String,System.Byte[])">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner GlobalMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="actionData">Action data.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_StoreToDiskFolder.#ctor(LumiSoft.MailServer.API.UserAPI.GlobalMessageRule,LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection,System.String,System.String,System.String)">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner GlobalMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="folder">Disk folder where to store message.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_StoreToDiskFolder.Serialize">
<summary>
Serialices action object.
</summary>
<returns>Returns serialized action data.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_StoreToDiskFolder.ActionType">
<summary>
Get global message rule action type.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_StoreToDiskFolder.HasChanges">
<summary>
Gets if this object has changes what isn't stored to mail server by calling Commit().
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_StoreToDiskFolder.Folder">
<summary>
Gets or sets disk folder where to store message.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.Queues">
<summary>
The Queues object represents queues in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.Queues.#ctor(LumiSoft.MailServer.API.UserAPI.VirtualServer)">
<summary>
Default constructor.
</summary>
<param name="virtualServer">Owner virtual server.</param>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Queues.SMTP">
<summary>
Gets incoming SMTP queue.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.Queues.Relay">
<summary>
Gets outgoing relay queue.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.POP3_Settings">
<summary>
The POP3_Settings object represents POP3 settings in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.POP3_Settings.#ctor(LumiSoft.MailServer.API.UserAPI.System_Settings,System.Boolean,System.String,System.String,System.Int32,System.Int32,System.Int32,System.Int32,LumiSoft.MailServer.API.UserAPI.BindInfo[])">
<summary>
Default constructor.
</summary>
<param name="sysSettings">Reference to system settings.</param>
<param name="enabled">Specifies if POP3 service is enabled.</param>
<param name="hostName">Host name.</param>
<param name="greeting">Greeting text.</param>
<param name="idleTimeout">Session idle timeout seconds.</param>
<param name="maxConnections">Maximum conncurent connections.</param>
<param name="maxConnectionsPerIP">Maximum conncurent connections fro 1 IP address.</param>
<param name="maxBadCommands">Maximum bad commands per session.</param>
<param name="bindings">Specifies POP3 listening info.</param>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.POP3_Settings.Enabled">
<summary>
Gets or sets if POP3 server is enabled.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.POP3_Settings.HostName">
<summary>
Gets or sets POP3 host name reported to connected clients. If "", then machine NETBIOS name used.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.POP3_Settings.GreetingText">
<summary>
Gets or sets greeting text reported to connected clients. If "", default server greeting text is used.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.POP3_Settings.SessionIdleTimeOut">
<summary>
Gets or sets how many seconds session can idle before timed out.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.POP3_Settings.MaximumConnections">
<summary>
Gets or sets maximum conncurent connections server accepts.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.POP3_Settings.MaximumConnectionsPerIP">
<summary>
Gets or sets maximum conncurent connections from 1 IP address. Value 0, means unlimited connections.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.POP3_Settings.MaximumBadCommands">
<summary>
Gets or sets maximum bad commands can happen before server terminates connection.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.POP3_Settings.Binds">
<summary>
Gets IP bindings.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_AutoResponse">
<summary>
The GlobalMessageRuleAction_AutoResponse object represents global message rule "Auto Response" action in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_AutoResponse.#ctor(LumiSoft.MailServer.API.UserAPI.GlobalMessageRule,LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection,System.String,System.String,System.Byte[])">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner GlobalMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="actionData">Action data.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_AutoResponse.#ctor(LumiSoft.MailServer.API.UserAPI.GlobalMessageRule,LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleActionCollection,System.String,System.String,System.String,System.Byte[])">
<summary>
Default constructor.
</summary>
<param name="rule">Onwer rule that ows this action.</param>
<param name="owner">Owner GlobalMessageRuleActionCollection that owns this action.</param>
<param name="id">Action ID.</param>
<param name="description">Action description.</param>
<param name="from">MAIL FROM: what is reported to destination SMTP server when auto response is sent.</param>
<param name="message">Full auto response message. This must be rfc 2822 defined message.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_AutoResponse.Serialize">
<summary>
Serialices action object.
</summary>
<returns>Returns serialized action data.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_AutoResponse.ActionType">
<summary>
Get global message rule action type.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_AutoResponse.HasChanges">
<summary>
Gets if this object has changes what isn't stored to mail server by calling Commit().
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_AutoResponse.From">
<summary>
Gets or sets MAIL FROM: what is reported to destination SMTP server when auto response is sent.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.GlobalMessageRuleAction_AutoResponse.Message">
<summary>
Gets or sets full auto response message. This must be rfc 2822 defined message.
You can use LumiSoft.Net.Mime class to parse and to construct valid message.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.VirtualServer">
<summary>
The VirtualServer object represents virtual server in LumiSoft Mail Server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.VirtualServer.#ctor(LumiSoft.MailServer.API.UserAPI.Server,LumiSoft.MailServer.API.UserAPI.VirtualServerCollection,System.String,System.Boolean,System.String,System.String,System.String,System.String)">
<summary>
Default constructor.
</summary>
<param name="server">Owner server.</param>
<param name="owner">Owner VirtualServerCollection collection that owns this object.</param>
<param name="id">Virtual server ID.</param>
<param name="enabled">Specifies if virtual server is enabled.</param>
<param name="name">Virtual server name.</param>
<param name="assembly">API assembly name.</param>
<param name="type">API Type name.</param>
<param name="initString">API init string.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.VirtualServer.Backup(System.String)">
<summary>
Backsup all virtual server settings to the specified file.
</summary>
<param name="fileName">File name where to store backup.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.VirtualServer.Backup(System.IO.Stream)">
<summary>
Backsup all virtual server settings to the specified stream.
</summary>
<param name="stream">Stream where to store backup.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.VirtualServer.Restore(System.String,LumiSoft.MailServer.API.UserAPI.RestoreFlags_enum)">
<summary>
Restores all virtual server settings from the specified file.
</summary>
<param name="fileName">File what conatins backup.</param>
<param name="restoreFlags">Specifies restore options.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.VirtualServer.Restore(System.IO.Stream,LumiSoft.MailServer.API.UserAPI.RestoreFlags_enum)">
<summary>
Restores all virtual server settings from the specified stream.
</summary>
<param name="stream">Stream what conatins backup.</param>
<param name="restoreFlags">Specifies restore options.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.VirtualServer.Commit">
<summary>
Tries to save all changed values to server. Throws Exception if fails.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.VirtualServer.DomainChanged">
<summary>
Is called when domain has changed.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.VirtualServer.Server">
<summary>
Gets the Server object that is the owner of this collection.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.VirtualServer.Owner">
<summary>
Gets onwer VirtualServerCollection that owns this object.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.VirtualServer.HasChanges">
<summary>
Gets if this user object has changes what isn't stored to mail server by calling Commit().
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.VirtualServer.VirtualServerID">
<summary>
Gets virtual server ID.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.VirtualServer.Enabled">
<summary>
Gets or sets if virtual server is enabled.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.VirtualServer.Name">
<summary>
Gets or sets virtual server name.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.VirtualServer.AssemblyName">
<summary>
Gets virtual server assembly name what implements virtual server API.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.VirtualServer.TypeName">
<summary>
Gets virtual server Type name what implements virtual server API.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.VirtualServer.InitString">
<summary>
Gets or sets init string used to configure virtual server API.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.VirtualServer.SystemSettings">
<summary>
Gets virtual server sytem settings.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.VirtualServer.Domains">
<summary>
Gets virtual server domains.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.VirtualServer.Users">
<summary>
Gets virtual server users.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.VirtualServer.Groups">
<summary>
Gets virtual server user groups.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.VirtualServer.MailingLists">
<summary>
Gets virtual server mailing lists.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.VirtualServer.GlobalMessageRules">
<summary>
Gets virtual server global message rules.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.VirtualServer.Routes">
<summary>
Gets virtual server routes.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.VirtualServer.RootFolders">
<summary>
Gets virtual server shared root folders.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.VirtualServer.UsersDefaultFolders">
<summary>
Gets virtual server shared root folders.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.VirtualServer.Filters">
<summary>
Gets virtual server filters.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.VirtualServer.IpSecurity">
<summary>
Gets virtual server IP security entries collection.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.VirtualServer.Queues">
<summary>
Gets virtual server queues.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.VirtualServer.RecycleBin">
<summary>
Gets virtual server recycle bin.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.VirtualServer.Logs">
<summary>
Gets virtual server logs.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.VirtualServer.SipRegistrations">
<summary>
Gets virtual server SIP registrations.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.SipRegistrationCollection">
<summary>
The SipRegistrationCollection object represents SIP registrations in LumiSoft Mail Server server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.SipRegistrationCollection.#ctor(LumiSoft.MailServer.API.UserAPI.VirtualServer)">
<summary>
Default constructor.
</summary>
<param name="owner">Owner VirtualServer object that owns this collection.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.SipRegistrationCollection.Refresh">
<summary>
Refreshes sessions.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.SipRegistrationCollection.Set(System.String,System.String[])">
<summary>
Adds or updates specified SIP registration info.
</summary>
<param name="addressOfRecord">Registration address of record.</param>
<param name="contacts">Contacts to add to the specified address of record.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.SipRegistrationCollection.Remove(LumiSoft.MailServer.API.UserAPI.SipRegistration)">
<summary>
Removes specified SIP registration from server,
</summary>
<param name="registration">Registration to remove.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.SipRegistrationCollection.Bind">
<summary>
Gets server events and binds them to this.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.SipRegistrationCollection.GetEnumerator">
<summary>
Gets enumerator.
</summary>
<returns></returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SipRegistrationCollection.VirtualServer">
<summary>
Gets the VirtualServer object that is the owner of this collection.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SipRegistrationCollection.Count">
<summary>
Gets number of SIP registrations in server.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SipRegistrationCollection.Item(System.Int32)">
<summary>
Gets a SipRegistration object in the collection by index number.
</summary>
<param name="index">An Int32 value that specifies the position of the SipRegistration object in the SipRegistrationCollection collection.</param>
<returns>A SipRegistration object value that represents the SIP registration in server.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SipRegistrationCollection.Item(System.String)">
<summary>
Gets a SipRegistration object in the collection by SIP registration name.
</summary>
<param name="addressOfRecord">A String value that specifies the SIP registration 'address of record' of the SipRegistration object in the SipRegistrationCollection collection.</param>
<returns>A SipRegistration object value that represents the SIP registration in server.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.SipRegistrationCollection.List">
<summary>
Gets direct access to sessions collection.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.RouteAction_RouteToHost">
<summary>
The RouteAction_RouteToHost object represents route "Route To Host" action in LumiSoft Mail Server virtual server.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.RouteAction_RouteToHost.#ctor(System.String,System.Int32)">
<summary>
Default constructor.
</summary>
<param name="host">Host name or IP where to route message.</param>
<param name="port">Host port.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.RouteAction_RouteToHost.#ctor(System.Byte[])">
<summary>
Default constructor.
</summary>
<param name="actionData">Action data.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.RouteAction_RouteToHost.Serialize">
<summary>
Serialices action object.
</summary>
<returns>Returns serialized action data.</returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.RouteAction_RouteToHost.Host">
<summary>
Gets or sets host name or IP where to route message.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.RouteAction_RouteToHost.Port">
<summary>
Gets or sets host port.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.Service_enum">
<summary>
Specifies service
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.Service_enum.SMTP">
<summary>
SMTP.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.Service_enum.POP3">
<summary>
POP3.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.Service_enum.IMAP">
<summary>
IMAP.
</summary>
</member>
<member name="F:LumiSoft.MailServer.API.UserAPI.Service_enum.Relay">
<summary>
SMTP Relay.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.ServerReturnMessage">
<summary>
This class represents server return message template.
For example for undelivered messagege notice, delayed delivery warning, ... .
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.ServerReturnMessage.#ctor(System.String,System.String)">
<summary>
Default constructor.
</summary>
<param name="subject">Message subject template.</param>
<param name="bodyTextRft">Messge body text template in RTF format.</param>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.ServerReturnMessage.Equals(System.Object)">
<summary>
Checks if specfied object value is equal to this.
</summary>
<param name="obj">Object to compre.</param>
<returns>Returns true if specified object value equals this value.</returns>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.ServerReturnMessage.GetHashCode">
<summary>
Server hash function to particular type.
</summary>
<returns></returns>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.ServerReturnMessage.Subject">
<summary>
Gets message subject template.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.ServerReturnMessage.BodyTextRtf">
<summary>
Gets body text template in RTF format.
</summary>
</member>
<member name="T:LumiSoft.MailServer.API.UserAPI.ServerInfo">
<summary>
Provides server info.
</summary>
</member>
<member name="M:LumiSoft.MailServer.API.UserAPI.ServerInfo.#ctor(System.String,System.String,System.Int32,System.Int32,System.DateTime,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
<summary>
Default constructor.
</summary>
<param name="os">Operatin system on what mail server is running.</param>
<param name="mailserverVersion">Mail server version.</param>
<param name="memUsage">Memory used by mail server.</param>
<param name="cpuUsage">Cpu used by mail server.</param>
<param name="serverDateTime">Time when server started.</param>
<param name="readsSec">Specifies how many KB / Second server reads.</param>
<param name="writesSec">Specifies how many KB / Second server writes.</param>
<param name="smtpSessions">Virtual servers total SMTP sessions.</param>
<param name="pop3Sessions">Virtual servers total POP3 sessions.</param>
<param name="imapSessions">Virtual servers total IMAP sessions.</param>
<param name="relaySessions">Virtual servers total Relay sessions.</param>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.ServerInfo.OS">
<summary>
Gets operatin system on what mail server is running.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.ServerInfo.MailServerVersion">
<summary>
Gets mail server version.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.ServerInfo.MemoryUsage">
<summary>
Gets how many MB memory mail server consumes.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.ServerInfo.CpuUsage">
<summary>
Gets much CPU % mail server consumes.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.ServerInfo.ServerStartTime">
<summary>
Gets server start time.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.ServerInfo.ReadsInSecond">
<summary>
Gets how many KB / Second server reads.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.ServerInfo.WritesInSecond">
<summary>
Gets how many KB / Second server writes.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.ServerInfo.TotalSmtpSessions">
<summary>
Gets all virtual servers total SMTP sessions.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.ServerInfo.TotalPop3Sessions">
<summary>
Gets all virtual servers total POP3 sessions.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.ServerInfo.TotalImapSessions">
<summary>
Gets all virtual servers total IMAP sessions.
</summary>
</member>
<member name="P:LumiSoft.MailServer.API.UserAPI.ServerInfo.TotalRelaySessions">
<summary>
Gets all virtual servers total Relay sessions.
</summary>
</member>
</members>
</doc>