Objects
Server
Toolkit
MailMessage
Strings
Config
User
ConfigPop3
FolderFiltering
Mailslot
HttpRequest
HttpResponse
HttpSession
HttpObject
HttpObjectCollection
DIS
Mailgroup
SpellCheckContext
CalendarEventRecurring
CalendarEventParticipants
CalendarEvent
Calendar
Timezones
Calendaring
CalendarView
Subscriber
ServiceList
ServiceConfig
SmtpServiceConfig
iCalObject
iCalField
This object provides references to various other objects available to scripts. As this object is the default object most of the properties and methods do not need to be qualified.
______ | Mailtraq : object Provides access to the Remote Scripting layer's root object Request : HttpRequest or MailMessage This property holds a reference that depends on the context of the script being executed. If the script is running within the Web Server, then the return value will be the HTTP object. If the script is running in response to a trigger or input message, then the return value will be the MailMessage object that triggered it. Response : HttpResponse or MailMessage This property holds a reference that depends on the context of the script being executed. If the script is running within the Web Server, then the return value will be the HTTP object which contains the output web page. If the script is being run in order to generate an output message (such as a message template) then the return value will be the MailMessage object being created. Session : HttpSession This property holds a reference to the current session. In the context of Web Scripts: A cookie named SESSIONKEY is used maintain sessions between requests. Sessions can contain an arbitrary number of simple variables and HttpObject objects. Application : HttpSession This property holds a reference to the current application object. An application is similar to a HttpSession object in that it maintains values between web requests. However, the application values are shared amongst all the sessions for the current web site. System : Config This property is the same as the Config property (named for compatibility with earlier scripts) Server : Server This property holds a reference to itself. Because the server is the default object for scripts, it is necessary in order to obtain an object reference for passing to other functions. Directory : DIS This property holds a reference to the directory manager. The directory holds information about users and contacts Toolkit : Toolkit This property refers to a toolkit of useful functions. Config : Config This property holds a reference to the configuration object. Use this object to access or modify properties relating to the system configuration (such as user management and mailbox configuration). Calendaring : Calendaring This property holds a reference to the calendaring system. All the user calendars can be accessed and modified through this object. UserLanguage : string This property holds the currently selected language code. The language code is in the format base-region, for example en-uk for British English, or fr-ca for Canadian French. The default setting is taken from the environment or web browser, but it can be manually overriden. Some other functions, such as text macros, will select text based on the current language. SessionManager : SessionManager This property provides access to the global Session Manager. The Manager is responsible for issuing and maintaining objects. Version : string Returns the server version in the form major.minor.release.build Build : integer Returns the server build version Software : string Returns the server software name SitePath : string Returns the root filing system path to the current web site DatabasePath : string Returns the root filing system path to the database |
______ | Write ( Text ): none
This method outputs text to the current response environment (whatever is returned by the Response property). If the script is being called in a web page then this method will output text to the web page being created. If the script is being called in a template, then the text will be output to the message being created.
WriteLine ( Text ): none
This method outputs a line of text to the current response environment (whatever is returned by the Response property). If the script is being called in a web page then this method will output a line of text to the web page being created. If the script is being called in a template, then the line of text will be output to the message being created. This method is the same as the Write method except that a carriage-return/linefeed is appended.
CreateObject ( Class ): ActiveXObject
This method creates a new ActiveX object. The object must first be appropriately registered on the server. Example var fso = Server.CreateObject("Scripting.FileSystemObject");
GetLanguages (): string
This method returns a comma separated list of language names and language codes as defined in the underlying string macro table. The returned list is sequence of language code and language name pairs. For example, "en,English,fr,French,de,German,pt,Portugese,nl,Dutch". SameAddress ( Addr1 , Addr2 ): boolean
This method compares two e-mail addresses and returns true if they are the same after certain canonisation. If an address is either the local domain or one of it's aliases then it will match any other alias. If no domain is included, the local domain is assumed. If an address resolves to a local mailbox, then aliases for that mailbox are also considered. Example var match = SameAddress("user", "user@local.domain.com");
NameOf ( str ): boolean
This method takes an RFC2822 header e-mail entry and extracts the name part. Header e-mail entries generally appear in formats such as John Smith <jsmith@domain.com> or jsmith@domain.com (John Smith). In both of these cases the return string would be John Smith. This method is useful for rendering To: or From: message headers, particularly in conjunction with AddressOf.
UniqueString (): string
This method returns a unique string, often useful in creating unique identifies such as message ids. The string can be any length but at present it is eight characters. AddressOf ( str ): string
This method takes an RFC2822 header e-mail entry and extracts the e-mail address part. Header e-mail entries generally appear in formats such as John Smith <jsmith@domain.com> or jsmith@domain.com (John Smith). In both of these cases the return string would be John Smith. This method is useful for rendering To: or From: message headers, particularly in conjunction with NameOf.
HostOf ( address ): string
This method returns the domain part of an e-mail address (the part after the @ symbol). If the domain part does not exist, it returns the default local domain. Given jsmith@domain.com the string domain.com is returned.
UserOf ( address ): string
This method returns the user part of an e-mail address (the part before the @ symbol). Given jsmith@domain.com the string jsmith is returned.
CreateUser ( username , fullname , password , template (optional) , mailboxtemplate (optional) ): User
This method creates a new user account with the given parameters (subject to sufficient remaining user licenses). The newly created user account is returned by this method, or null if user creation was unsuccessul.
DeleteUser ( username , mailslots (optional) ): none This method deletes the named user account. If specified, all owned mailslots will be deleted as well.
Transfer ( path ): string
Transfers execution to another named script. The given parameter is a path (relative to the path of the currently executing script). When the current scriptlet completes, execution will start on the new script. It is important to note that transfer does not take place immediately, see the example. Example 1<%
In the above example, the execution continues to line 4, after the Server.Transfer() on line 3, but the next scriptlet is not executed because the transfer takes place when the first scriptlet ends on line 5.
MessageSend ( sender , recipients , header , body , attachments , messageid ): none This method will create and send a new e-mail, optionally with attachments from the current session.
MessageSaveDraft ( mailslot , sender , recipients , header , body , attachments , messageid ): none This method will create a new e-mail and save it as a draft in the specified mailslot, optionally with attachments from the current session.
MessageSaveSent ( mailslot , sender , recipients , header , body , attachments , messageid ): none This method will create a new e-mail and save it in the sent-items folder of the specified mailslot, optionally with attachments from the current session.
GenerateMessageId (): string
This method will create a new message-id in the format of <uniquestring@local.domain.com> using the primary domain name. GenerateMessageFilename (): string
This method will generate a unique string suitable for using as a filename in a mailslot. URLEncode ( text ): string
This method will encode the given string in a manner suitable for passing as a URL parameter. Effectively, characters not valid in a URL parameter are converted to %hex and spaces are converted to + symbols. Example var str = Server.URLEncode("The & character isn't valid");
See also URLDecode
URLDecode ( text ): string
This method will decode the given string that might have been passed as a URL parameter. Such strings are typically encoded by a routine similar to URLEncode. Effectively, characters not valid in a URL parameter are converted to %hex and spaces are converted to + symbols. Example var str = Server.URLDecode("The+%26character+isn%27t+valid");
See also URLEncode
SyncML ( url , xml ): string
This method will process a SyncML request and return the XML output as the result of the function
SyncMLBinary ( url , contentType , data ): SafeArray
This method will process a SyncML request and return the XML output as the result of the function
WBXMLEncode ( xml ): SafeArray
This method takes an XML representation of a common format (such as SyncML) and converts it to a compressed binary WBXML in the form of a SafeArray (a Variant array) which can be sent using HTTPResponse.BinaryWrite() in ASP
WBXMLDecode ( wbxml ): string
This method takes an WBXML biinary representation of a common format (such as SyncML) in the form of a SafeArray and converts it into plain text XML
MessageTrackingQuery ( FromDate , ToDate , EntryClass , MessageIdList , ReferenceIdList , SourceList , DestList ): string
This method queries the message tracking database based on the given parameters and returns a structured list of matches. A NULL is returned if there are no matches (rather than an empty string). If there are matches, a list of CR LF separated strings are returned (one line per entry). Each line is a TAB separated list: Timestamp (VDATE), EntryClass, MessageIdHash, ReferenceIdHash, Source, Destination, Info.
LogEvent ( text , eclass , echannel ): none Enters a string into the Mailtraq event log
|
This object is a container for a set of routines useful in scripts, particularly for handling and modifying strings in a consistent manner.
______ |
______ | ExtractEmailAddresses ( text ): string
This method extracts e-mail addreses from a string that is formatted in a manner suitable for use in an RFC2822 header (such as To: or CC:). This method is capable of extracting multiple e-mail addresses. The method returns a comma-separated list of addreses. See also ExtractNamesEmails
ExtractNamesEmails ( text , separator ): string
This method is similar to ExtractEmailAddresses except that it extracts both the e-mail addresses and corresponding display names. The input string is formatted in a manner suitable for use in an RFC2822 header (such as To: or CC:). The returned string is a list of e-mail address, display name pairs. The separator string can be specified as a parameter and is used to separate the items in the pairs and the pairs themselves. Example var to_header = "To: John Smith To: John Smith <jsmith@domain.org>, Jane Doe <jdoe@host.com>";
SetStringPrefix ( text , prefix ): string
This method ensures that the given string starts with the given prefix. This is not the same as concatenating two strings as the method checks first to see if the given prefix is already attached (in a case-insensitive manner). This function is very useful for prepending the Re: to a subject line when replying.
SetStringSuffix ( text , suffix ): string
This method ensures that the given string ends with the given prefix. This is not the same as concatenating two strings as the method checks first to see if the given suffix is already attached (in a case-insensitive manner).
HtmlEncode ( text ): string
This method encodes the given string in a manner suitable for including in HTML without being interpreted by the HTML engine. Specifically, angle brackets and ampersands are converted into their HTML equivilent. It is important to note that as both of these changes result in ampersands, repeating the function on a string will further encode it. Thus, the number of encodings must later match the number of decodings.
FirstNonBlank ( text ): string
This method takes a variable number of paramters and returns the first parameter that is neither null or an empty string. Example var first = Toolkit.FirstNonBlank(null, "", "First", 2, 3.0);
FormatNumber ( number , type ): string
This method takes an integer and formats it in a suitable manner for presentation. In the current version, the type parameter bytes is used to reduce the number and append a suitable suffix (gb, mb or k if necessary).
HeaderEncode ( text ): string
This method encodes a string in a manner suitable for use in an RFC2822 header. Some characters are not valid in this context (such as 8bit characters or escape sequences) and must therefore be encoded using a standard mechanism. The mechanism for encoding this text is inline content encoding which is a compact system that can identify character set and then encode the data using the basic 7bit character set. This method only encodes the text if it is necessary, making it safe to execute on any text that will be used in a message header. The output format is quoted-printable and the default character-set is assumed. See HeaderDecode for more information. For encoding To: style headers, see
HeaderEncodeTo ( text ): string
This method is very similar to HeaderEncode but is necessary when encoding header entries with multiple parts that must be encoded separately. Normally, when a string requires encoding, the entire string is converted into quoted-printable. This is unsuitable for header entries such as To: where multiple addresses may be specified. Typically only the Names need to be encoded, while the e-mail addresses and separators should not. Therefore, this method effectively divides the input text into a set of strings and each is tested for encoding separately, and then the string is re-combined. Use this method for To: and CC: headers.
HeaderDecode ( text ): string
This method decodes a header string that may have been encoded using compact inline MIME encoding. RFC2822 requires that all message headers be basic 7bit, which excludes various accent or language specific characters. In order to carry this data, header text can be encoded using a method called inline content encoding. This is a special construct that converts 8bit characters into 7bit using a content transfer encoding of either quoted-printable or base64. This inline encoding also specifies the output character set. Note: the entire subject line is encoded. This will cause problems for To: and CC: lines where other applications may need to extract e-mail addresses without first decoding. Use to handle encoding of this type of header. Example As an example: the subject line shown below... Subject: The price is £99 ...contains an 8bit character (the pound sign). The encoding of this text would be... Subject: =?iso-8859-1?Q?The_price_is=A399?= The encoded string identifies the character set (iso-8859-1), the content-encoding selected (Q indicates quoted-printable) and then the text appropriately encoded. See also HeaderDecode
HeaderDecodeHtml ( text ): string
This method is similar to the HeaderDecode method except that the output is appropriately encoded for HTML if the input charset is UTF-8.
HeaderDecodeUtf8 ( text ): string
This method is similar to the HeaderDecode method except that the output is converted to UTF-8.
DisDecode ( text ): string
This method encodes a string in a suitable format for sending to the Directory Information Service. Directory Information is managed using LDAP techniques which require rigid text encoding. The function is similar to URLEncode in that a single string is encoded by replacing invalid characters.
DisDecode ( text ): string
This method decodes a string returned by the Directory Information Service. The output is very similar to the URLDecode method but line breaks are handled in a better manner. The DIS provides address book information and text being received from the DIS should first be decoded with this method. If you wish to display the decoded data in HTML, consider using the DisToHtml method instead. See also DisDecode.
DisToHtml ( text ): string
This method is similar to DisDecode except that where appropriate output characters are re-encoded in a manner suitable for display in HTML. In particular, line breaks are encoded into <br> strings. See also DisDecode
SuffixNonBlank ( text , suffix ): string
This method will return the concatenation of two strings only if the first string is non-blank (not equal to an empty string). See also PrefixNonBlank, SurroundNonBlank
PrefixNonBlank ( prefix , text ): string
This method will return the concatenation of two strings only if the second string is non-blank (not equal to an empty string). See also SuffixNonBlank, SurroundNonBlank
SurroundNonBlank ( prefix , text , suffix ): string
This method will return the concatenation of three strings only if the second is non-blank (not equal to an empty string). See also SuffixNonBlank, PrefixNonBlank
JoinNonBlank ( sep , text ): string
This method selects the non-blank strings from the given parameters and returns them as a single string joined by the given separator. Example var table = Toolkit.JoinNonBlank(", ", "One", "", "Three");
WrapToColumn ( document , column , exceptchars ): string
This method takes a block of text and word-wraps it to the given column. If the input block includes CR/LF separators, then each line is wrapped separately. Optionally, a set of exception characters can be given and if any line starts with one of these characters then the line will not be wrapped. This method is used to wrap text when composing an e-mail. Typically replies include lines prefixed with > characters and those lines should not be wrapped (so the > character should be included in the exception characters. Similarly, lines beginning with a | character represent quoted text and should also not be wrapped.
TabList ( item ): string
This method takes a variable number of parameters and returns them as a single string separated by tabs. This can be useful when combined with TabMap.
TabMap ( list , map , field ): string
This method takes two tab lists (such as those created by TabList) and uses one as a map into the other to return a specific item. The first list is a list of text items. The second is a list of field names in the same order as the first list. The third parameter is a field name that must match one in the second list. The index of that field name in the second list is used to return an item from the first list. See also TabList Example var map = Toolkit.TabList("name", "email", "tel");
ListItemOf ( list , sep , index ): string
This method returns an indexed item from a string list. Each item in the list must be separated by one ore more characters from the given separator string. The index is zero based, so the second item is numbered 1. Example var list = "one, two, three,four, five";
See also ListContains, ListRemove, ListCount
ListContains ( list , sep , value ): boolean
This method tests the given list to determine if it contains a given string value. The list must be a sequence of strings separated by one or more character from the sep parameter. See also ListItemOf, ListRemove, ListCount
ListRemove ( list , sep , value ): string
This method will remove a specified item from the given list and return the new list as a single string. The list must be a sequence of strings separated by one or more character from the sep parameter. See also ListItemOf, ListContains, ListCount
ListCount ( list , sep ): integer
This method will return the number of items in the given list. The list must be a sequence of strings separated by one or more character from the sep parameter. See also ListItemOf, ListContains, ListRemove
VDateCreate ( year , month , day , hour , minute , second ): string
This method creates a date in the VDate format, used in the Calendaring system. The VDate format is also useful as it can be sorted alphanumerically and is not locale-dependent.
VDateFormat ( vdate , format ): string
This method formats a date in the specified manner using the system locale. The format string is made up of tokens and literals. Literals are surrounded by quotes (as in "text"). The available tokens are :-
Example var dt = Toolkit.VDateFormat('20040201153059', 'dddd, mmm d "at" hh:nnam/pm');
DateTimeToVDate ( datetime ): string
Converts a DateTime (Float) to VDate (String)
VDateToDateTime ( vdate ): float
Converts a VDate (String) to DateTime (Float)
DateTimeToUnix ( datetime ): int64
Converts a DateTime (Float) UNIX Time (Integer)
UnixToDateTime ( udate ): float
Converts a UNIX Date (Integer) to DateTime (Float)
FirstNameOf ( fullname ): string
This method extracts a first name from a string that should represent a person's full name. It will not always be successful but in most cases it will provide a reasonable assumption.
SurnameOf ( fullname ): string
This method extracts a surname from a string that should represent a person's full name. It will not always be successful but in most cases it will provide a reasonable assumption.
UserOfEmail ( email ): string
This method extracts the user part of an e-mail address. The user part is the string before the @ symbol and is sometimes called the mailbox.
DomainOfEmail ( email ): string
This method extracts the domain part of an e-mail address. The domain part is the string after the @ symbol.
FullnameOf ( email ): string
This method extracts the user's name from an RFC2822 header style name/address pair. The format is not standardised but is typically either Full Name <email@address.com> or <email@address.com> (Full Name). This method is capable of extracting the full name from either format and from most variations.
InsertParams ( template , param ): string
This method inserts one or more strings into another string in positions designated by markers. The markers are $1 through $9 representing the first through ninth parameters. Example var txt = Toolkit.InsertParams("The $2 parameter is not $1", "one", "second");
QualifyAddresses ( list , domain ): string
This method takes a line of text containing e-mail addresses that will eventually be used to form a To: or CC: header, and ensures that each address is fully qualified. If an apparent addresses does not include a domain name, the given domain is appended.
HtmlToPlainText ( html ): string
This method takes an HTML string and converts it into plain text format. BR tags are replaced with line breaks, P tags are replaced with double line breaks, brackets and ampersands are decoded, all whitespace is truncated to single characters and line breaks and tags stripped. The resulting plain-text should be considered UTF-8.
DnsLookupA ( host ): string
This method takes a host name and resolves it to a dotted quad IP address. If an error occurs or the name cannot be resolved, an integer error code is returned.
DnsLookupMx ( host ): string
This method takes a host name and queries the available DNS servers for the registered MX hosts (mail servers) that will accept mail for it. The returned string is a comma separated list of hosts and priority values. For example, querying "host.domain.tld" may return "50,mx1.host.domain.tld,150,mx2.host.domain.tld". If an error occurs or the name cannot be resolved, an integer error code is returned.
DnsLookupTxt ( host ): string
This method takes a host name and queries the available DNS servers for the TXT record. The returned string is the entire TXT record. If an error occurs or the name cannot be resolved, an integer error code is returned.
DnsLookupPtr ( host ): string
This method takes a dotted-quad IP address and queries the available DNS servers for a referse lookup. The returned string is the fully qualified host name that will resolve to the given IP address. If an error occurs or the name cannot be resolved, an integer error code is returned.
DblVerify ( ip , dbl ): string
This method takes a dotted-quad IP address and queries the given DBL (Database Black List). If the DBL has a record for the given IP address, a combination of the return IP address and the associated TXT description will be returned, separated by a tab character. If the IP address is not in the database, null will be returned. Example response: 127.0.0.1\tThis host is blacklisted
SpfVerify ( ip , helo , domain ): string
This method takes an IP address of a connecting peer and its HELO host name, along with the domain name of the message return path, and performs an SPF query to validate whether the peer is an authorised sender for the given domain. The possible responses are "+" for pass, "-" for fail, "?" for neutral, "~" for soft-fail, "e" for an error and "" for no records found.
LongQuoteString ( text ): string
This method takes a long string and prepares it for embedding in a client-side script by splitting it into a javascript concatenation scriptlet.
MessageTimestamp ( timestamp , tz ): string
This method takes a timestamp (optional) and formats it according to the RFC822 Date: message header
HashMD5 ( text ): string
This method takes a string and returns the MD5 hash in hexadecimal
CharsetConvert ( str , src_cs , dst_cs ): string
This method takes text in one character set and converts it to another character set
|
This object represents an e-mail message.
Properties |
Methods Add |
______ | LineCount : integer
This is the number of lines (including header, message body and attachments) in this message. Headers : Strings
The message header fields in the form of a list of strings. Use the methods to access and/or modify the fields themselves. Sender : string
This is the envelope Return-Path of the message. It is not necessarily the same as the sender specified in the message header. Recipients : Strings
The recipients of this message in the form of a list of strings. Each string is a single e-mail address in standard format. Use the methods to access and/or modify the recipients. Size : integer
The size (in bytes) of the message (including header, body and attachments) MessageId : string
This is the Message ID from the header. MessageIdHash : string
This is the MD5 hash of the Message ID from the header, used for some directory operations and message tracking. |
______ | Add ( line ): none
This message adds a single line to the end of the mail message. The line can include CR/LF pairs which will result in multiple lines being added in a single call.
GetLine ( index ): string
This method returns a specified line from the mail message. The line is indexed by the given parameter, staring from zero for the first line.
GetHeader ( field ): string
This method returns a named header value from the message header. If the header matches multiple entries then they are concatenated and returned as a single string. If no matching header is found an empty string is returned.
SetHeader ( field , value ): none
This method adds or modifies a message header with the given field name and value. If the header already exists, it is removed and the new value put in its place. If the header does not exist, then it is appended to the message header at the end (before the body begins). If multiple matching headers exist, they are all removed and the first instance replaced with the new value. If the new header value may contain 8bit characters, it should be processed with HeaderEncode first.
Cancel (): none
This method cancels a template message, preventing it from being sent. InsertFooter ( plaintext , htmltext ): none
Inserts text into a footer/disclaimer position in a message
ConsentAnalyze ( mailbox ): boolean Analyzes the message using the recipient mailboxes consent database and returns true if the message is OK or false if it should be rejected.
|
This object is an ordered collection of strings. Each string can be extracted or modified based on index (starting with zero for the first string).
Properties |
Methods |
This object represents the current system configuration, including user accounts and system setup.
Properties UserCount |
Methods GetUser |
______ | UserCount : integer
Returns the number of user accounts configured on the system. LocalHost : string
Returns or sets the primary domain name for this system. LocalHostAliases : string
Returns or sets the aliases of the primary domain name. The aliases are treated as a comma-separated list. LocalHostAliaseList : Strings
Returns a string list of domain aliases (the same aliases that LocalHostAliases returns, but in a Strings object. ServiceList : ServiceList
Returns the list of configured services. DefaultTimezoneId : integer This is the time zone id assigned to users who have not yet selected one |
______ | GetUser ( name ): User
This method returns a specified user object. If the user does not exist, then a null is returned instead. The user is specified by it's user name. See also GetUserByIndex
GetUserByIndex ( index ): User
This method returns a specified user object. If the user does not exist, then a null is returned instead. The user is specified by it's index (zero for the first user and the last user is one less than the value returned by UserCount. See also GetUser
GetUserById ( id ): User
This method returns a specified user object. If the user does not exist, then a null is returned instead. The user is specified by it's id (zero is the administrator). See also GetUser
GetMailslot ( name ): Mailslot
This method returns a specified mailslot object. If the mailslot does not exist, then a null is returned instead. The mailslot is specified by it's name.
CreateUser ( username , fullname , password , template (optional) , mailboxtemplate (optional) ): User
This method creates a new user account with the given parameters (subject to sufficient remaining user licenses). The newly created user account is returned by this method, or null if user creation was unsuccessul.
CreateMailbox ( name , owner ): Mailslot
This method creates a new mailbox object and returns it. The given mailbox name must be unique. By default, the new mailbox will be owned by the administrator. If a user account name is given, the new mailbox will be assigned to that user.
CreateMailingList ( name , owner ): Mailslot
This method creates a new mailing list object and returns it. The given mailing list name must be unique. By default, the new mailing list will be owned by the administrator. If a user account name is given, the new mailing list will be assigned to that user.
CreateArchive ( name , owner ): Mailslot
This method creates a new archive object and returns it. The given archive name must be unique. By default, the new archive will be owned by the administrator. If a user account name is given, the new archive will be assigned to that user.
DeleteUser ( username , mailslots (optional) ): none This method deletes the named user account. If specified, all owned mailslots will be deleted as well.
DeleteMailslot ( name ): none
This method deletes the named mailslot (mailbox, mailing list or archive).
AuthenticateUser ( username , password , context , ipaddress ): User
This method takes a username and password and if the password matches then the user object is returned, otherwise null is returned. This method provides a concise method of authentication.
GetAllUsers ( ): string
This method returns a comma-separated list of all the users in the system. Use functions such as ListItemOf to access the items in the list.
GetAllMailslots ( ): string
This method returns a comma-separated list of all the mailslots in the system (including all mailboxes, mailing lists and archives). Use functions such as ListItemOf to access the items in the list.
GetAllMailboxes ( ): string
This method returns a comma-separated list of all the mailboxes in the system. Use functions such as ListItemOf to access the items in the list.
GetAllMailingLists ( ): string
This method returns a comma-separated list of all the mailing lists in the system. Use functions such as ListItemOf to access the items in the list.
GetAllArchives ( ): string
This method returns a comma-separated list of all the archives in the system. Use functions such as ListItemOf to access the items in the list.
VerifyHamtoken ( address ): boolean
This method checks the given e-mail address to see if it contains a valid hamtoken (in the format mailbox+timedhash@example.com) for a local mailslot. Returns false if the address is non-local or doesn't match a local mailbox.
IssueHamtoken ( address ): boolean
This method takes an e-mail address representing a local mailslot and returns a hamtoken (in the format mailbox+timedhash@example.com) which will be valid for the next seven days.
|
This object represents a single user account in the system. Objects of this type can be obtained by using and .
Properties Name |
Methods AddPrivilege |
______ | Name : string
This is the unique name of the user account. It should contain only alphanumeric characters and underscores. Although other characters are permitted (for compatibility with other systems), they are not recommended. Id : integer
A unique number identifying the user FullName : string
This is the descriptive text for the user account and should be the full user name. Password : string
This is the password text for this account. The password is used when users authenticate. Password comparisons in the system are normally case-sensitive. CreationDate : date
This is the date and time at which the account was created. LastLogin : date
This is the date at which authentication last took place, which usually represent a login of some sort (such as for POP3, IMAP, WebMail, etc). PrimaryMailbox : string
This is the primary mailbox assigned to the user. The property is a string representing the name of the mailbox, not the mailbox object itself. The primary mailbox can be changed to any mailbox owned by the user. The primary mailbox is typically used as the sending address for e-mail sent via WebMail, and is used as the e-mail address for the user in directory enquiries (such as LDAP access to the local directory). The primary mailbox is also the default mailbox presented in the WebMail system for this user. EnableWebmail : boolean
This property is used to determine whether or not the user can log in to the WebMail system. In addition, the user must have a primary mailbox. SenderAddress : string (Read Only)
This is the fully qualified e-mail address to be used for this user. It is obtained from the PrimaryMailbox object. TimeZone : string
This is the time zone associated with the user. It is used as a reference to a defined time zone in the Timezones object. The calendaring system uses this property to present the calendar information to the user. Language : string
This is the language code associated with the user. The format is either a two-character language code (e.g. en or fr) or a two-character language code and two-character region code separated by a hyphen (e.g. en-uk or fr-ca). If this property is not defined then the Web Server system will attempt to extract the language from the browser. |
______ | AddPrivilege ( privilege ): none
This method adds a named privilege to the user's privilege list. See HasPrivilege for a list of the defined privileges.
RemovePrivilege ( privilege ): none
This method removes a named privilege from the user's privilege list. See HasPrivilege for a list of the defined privileges.
HasPrivilege ( privilege ): boolean
This method returns true if the named privilege exists within the user's privilege list. The available privleges are :-
GetUserData ( prop ): string
This method returns a single user-defined property that is stored in the user configuration. Any property name can be used and if the property does not exist an empty string is returned.
SetUserData ( prop , value ): none
This method sets a single user-defined property that is stored in the user configuration. Any property name can be used and if the property does not exist then a new property is added.
GetAccessToMailbox ( mailbox ): integer
This method returns the access control for a single mailbox with respect to the user. The value returned is the bitwise-or of the following values :-
SetAccessToMailbox ( mailbox , flags ): none
This method sets the given access control flags for the specified mailbox. Flags that are not specified are left unchanged. See GetAccessToMailbox for the individual access control flag values.
UnsetAccessToMailbox ( mailbox , flags ): none
This method clears the given access control flags for the specified mailbox. Only the specified flags are cleared, the rest are left unchanged. See GetAccessToMailbox for the individual access control flag values.
GetAccessMailboxes ( ): string
This method returns a comma separated list of mailboxes that the user has access to (Subscribe, Read or Write). See GetAccessToMailbox for the individual access control flag values.
GetOwnedMailboxes ( ): string
This method returns a comma separated list of mailboxes that are owned by the user.
GetAccessToCalendar ( calendar ): integer
This method returns the sum of the access control flags for the specified calendar (with respect to the user). The flag values are given below
SetAccessToCalendar ( calendar ): none
This method sets the specified access control flags on the given calendar with respect to the user. The access control flags that are not specified are left unchanged. See GetAccessToCalendar for the individual flag values.
UnsetAccessToCalendar ( calendar ):
This method clears the specified access control flags on the given calendar with respect to the user. The access control flags that are not specified are left unchanged. See GetAccessToCalendar for the individual flag values.
GetAccessCalendars ( ): string
This method returns a list of calendars that the user has access to (including Subscribe, Read and Write flags). The returned list is a tab separated list of calendar names and access control flags. Example var list = new String(user.GetAccessCalendars()).split("\t");
GetAccessToAddressbook ( calendar ): integer
This method returns the sum of the access control flags for the specified calendar (with respect to the user). The flag values are given below
SetAccessToAddressbook ( addressbook ): none
This method sets the specified access control flags on the given calendar with respect to the user. The access control flags that are not specified are left unchanged. See GetAccessToAddressbook for the individual flag values.
UnsetAccessToAddressbook ( addressbook ):
This method clears the specified access control flags on the given calendar with respect to the user. The access control flags that are not specified are left unchanged. See GetAccessToAddressbook for the individual flag values.
GetAccessAddressbooks ( ): string
This method returns a list of calendars that the user has access to (including Subscribe, Read and Write flags). The returned list is a tab separated list of calendar names and access control flags. Example var list = new String(user.GetAccessAddressbooks()).split("\t");
CheckRecipients ( rcpts , dis ): string
This method takes a comma-separated list of e-mail recipients and verifies that the user can send mail to these recipients. The return value is either en empty string, indicating all the recipients are acceptable, or a comma-separated list of the unacceptable recipients. This method will not ensure that a message can be delivered to the accepted recipients, only that the addresses themselves appear syntactically valid, and are local (if the sender does not have relay permission).
UpdateFolderHierarchy ( cache ): string
This method will return a folder hierarchy for this user. The hierarchy includes all folders and objects accessible to the user in a single string that includes parent-child relationships. Optionally a string can be given that was returned from a previous call, which can short-cut some of the processing. The returned string is in the following format :- (objtype|mailslot|folder|description|, count, new_count, size, branchstate, timestamp : [(hierarchy)[(hierarchy)[...]])
GetLdapField ( field ): string
This methid will return a specific LDAP field value for the user.
SetLdapField ( field , value ): string
This method will set a specific LDAP field value for the user.
AcceptVCalendarResponse ( vcalendar ): boolean
This method searches all calendars that this user has access to for the specified events and updates the participation data. The method returns True if an event that could be updated was found.
|
Properties Enabled |
Methods |
______ | Enabled :
Server :
Account :
Password :
Status :
Local :
LastCollection :
LastAttempt :
LeaveOnServer :
|
______ |
This object is a property of the mailbox and is used to control automatic filtering of incoming mail into the appropriate sub-folders (or marked appropriately).
Properties |
Methods |
______ | Count : integer
This property represents the number of filtering rules defined for the mailbox. Rules are numbered zero through this value - 1. |
______ | Get ( index ): string
This method returns a single filtering rule as a single string. This string is made up of a list of tab separated values. The values in this string are explained below :-
In the list above, items 3 through 5 are repeated for every additional sub-rule in a compound rule. The Group Logic Codes are :-
the Sub-Rule Logic Codes are :-
Replace ( index , string ): none
This method replaces an existing rule with the given rule in the same format as would be returned by Get.
Swap ( index1 , index2 ): none
This method swaps two existing filter rules based on their index values. As rules are evaluted in order this method can be used to change that order.
Add ( rule ): none
This method adds a new rule to the folder filtering rule set. The rule must be presented in a string using the same tab-separated format as is returned by the Get method.
Delete ( index ): none
This method removes an existing filter rule based on the rule index.
Clear ( ): none
This method removes all defined filter rules from this rule set.
|
The mailslot represents a delivery point for e-mails. There are a number of mailslot types, including Mailboxes, Mailing Lists and Archives. Most functionality is shared amongst the different types, but some functions will only be useful with a spceific type. Mailslots are referred to by a unique name and are containers for e-mail messages.
Properties Name |
Methods IsMailbox |
______ | Name : string
The mailslot name which must be unique and represents the user part of the e-mail address. Description : string
A general text description of the mailslot. If the mailslot is the user's primary mailbox then the description should be the same as the user's description. Owner : string
The name of the user who owns this mailslot. Each mailslot is owned by a single user. Use GetUser to retrieve the user object given the name. MailGroup : Mailgroup
The mailgroup to which this mailslot is assigned. MailGroupName : string
The name of the mailgroup to which this mailslot is assigned. Visibility : integer
The level of directory visibility for this mailslot. The values are 0 (Private -- visible only to owner), 1 (Protected -- visible to local users) and (2) Public Filters : FolderFiltering
The filtering object controls the set of rules that assign incoming mail to specific folders. AntiSpamEnabled : boolean
If set, the anti-spam system options become available and the system begins analyzing mail destined for this mailslot. AntiSpamActive : boolean
If set, the anti-spam system is activated at the mailbox level. This means that as mail is delivered to the mailbox it is analysed and if identified as spam it can either be modified and/or assigned to a specific folder. AntiSpamFolder : integer
If AntiSpamActive is set, and an incoming message is identified as spam, it will be assigned to this folder. AntiSpamReject : string
If AntiSpamReceipt is set, and an incoming message is identified as spam, it will be rejected with this message. AntiSpamReceipt : boolean
If set, mail arriving by SMTP will be analyzed if it is clearly destined for this mailslot (and no other). If the message is identified as spam, further actions can be taken (such as rejection using AntiSpamReject. AntiSpamDatabase : string
The name of the anti-spam database to use for this mailslot. The default is . which is a private database named after the mailslot. If another name is chosen, other mailslots may share the database and any learning or analysis will be performed with the same information. AntiSpamProfile : integer
The identify of the system profile to use for this mailslot. 0 indicates that no profile is in use, and thus the other AntiSpam properties are specific to this mailslot. AntiSpamCountHam : integer
The number of messages in the given database and profile that have been learned as non-spam. AntiSpamCountSpam : integer
The number of messages in the given database and profile that have been learned as spam. AutoresponderText : string
This is the text to include in an auto-response message. This text may include a script so it is important to escape both ASP and brace defined scriptlets when users are permitted to set the content. AutoresponderIgnore : string
Do not auto-respond to any address in this CR/LF separated address/wildcard list. AutoresponderActive : boolean
Set this property to true to activate the auto responder for this mailslot. AutoresponderCache : string
The list of addresses currently in the already responded cache. ForwardActive : boolean
Set this property to true to activate the mail forwarding feature. ForwardTo : string
Set this property to an address or list of addresses (comma separated) to forward all incoming mail to. DeleteOnForward : boolean
Set this property to true to delete mail when it is forward rather than keep a copy in the mailslot. AbuseWhitelist : string
This is a comma separated wildcard list of sender addresses that do not not need to pass the anti-spam analysis for this mailbox Pop3Restriction : integer
Change this property to restrict the messages visible via POP3. The options are (0) No restriction (1) Only messages after Pop3RestrictionTimestamp (2) Only messages older than Pop3RestrictionHours (3) Only the last Pop3RestrictionCount messages Pop3RestrictionHours : integer
The maximum age in hours for a message to appear in the POP3 list Pop3RestrictionTimestamp : string
The maximum age for a message to appear in the POP3 list (in VDate format) Pop3RestrictionCount : integer
The maximum number of messages to appear in the POP3 list |
______ | IsMailbox ( ): boolean
Returns true if this mailslot is a mailbox.
IsMailinglist ( ): boolean
Returns true if this mailslot is a mailing list.
IsArchive ( ):
Returns true if this mailslot is an archive.
AddProperty ( prop ): none
This method assigns the specified property to this mailslot. The properties are represented by a integers.
RemoveProperty ( prop ): none
This method removes the specified property from this mailslot. The properties are represented by integers.
HasProperty ( prop ): boolean
This method returns true if the specified property is assigned to this mailslot.
QueryMessages ( folder , start_at , return_max , query , filter , sortorder , separator ): string
This method executes a query on the e-mail messages in the mailslot. The result of the query is formatted into a string consisting of multiple parts using the given separators. The query string can contain any text and is returned once for each matching message, concatenated with the given separator string. One or more tokens can be present in the query string and in the return string these are replaced with the appropriate values. The tokens available are given below :-
QueryMessage ( id , query ): string
This method queries a single identified message with a query similar to that used in QueryMessages.
QueryTracking ( id ): string
This method takes a sent message id and produces a tracking report
GetMailFolders ( ): string
This method returns a comma-separated list of folder names and id numbers (also comma-separated) in the mailslot. The return string is a series of [id],[name] pairs, e.g. "0,Inbox,1,Drafts,10,Personal".
GetMailFolderName ( id ): string
This method returns the name of a specified folder (given the folder id number).
QueryFolders ( formatted , filter ): string
This method returns a single string consisting of information about all the folders in the mailslot and the number of matching messages in each folder. If a filter is given, only messages matching that filter will be included in the message counts, otherwise all messages are used in the message counts. The output string is a comma-separated list of fields, themselves comma-separated. For each folder, the string is "[indent],[folder-id],[count],[new-count],[size],[name]". If the formatted option is set, [indent] reprents the depth of the heirarchical tree and [name] contains only the last branch of the folder name. Otherwise, [indent] is always zero and [name] is the full text name (including branch separator slashes).
SetMessageFlag ( filenames , flags ): none
This method sets the given message flags for the specified messages. The filename parameter can consist of multiple filenames separated by commas to improve performance (rather than calling the function multiple times). The flags must be represented by their binary integer values.
ClearMessageFlag ( filenames , flags ): none
This method clears the given message flags for the specified messages. The filename parameter can consist of multiple filenames separated by commas to improve performance (rather than calling the function multiple times). The flags must be represented by their binary integer values.
MoveMessageToFolder ( filenames , folder , destination ): none
This method moves the specified messages to the designated folder. The filename parameter can consist of multiple filenames separated by commas.
CopyMessageToFolder ( filenames , folder , destination ): none
This method copies the specified messages to the designated folder. The filename parameter can consist of multiple filenames separated by commas.
DeleteMessage ( filenames ): none
This method erases the named messages. Normally the delete operation that the user initiates is actually the moving of messages to the Deleted Items folder. This method should be used to actually remove the messages completely from the mailslot.
GetNextMessage ( filename , folder , filter ): string
This method returns the file name of the adjacent message after the given message in the given folder with given filter.
GetPreviousMessage ( filename , folder , filter ): string
This method returns the file name of the adjacent message before the given message in the given folder with given filter.
EmptyFolder ( folder ): none
This method deletes all messages in the given folder
DeleteFolder ( folder ): none
This method removes the specified folder from the mailslot folder list. All messages that are in this folder are re-assigned to the Inbox.
AddFolder ( name ): none
This method adds a new folder to the mailslot folder list. The folder name must not include any commas, equal signs, apostrophes or quotation marks. To create a sub-folder, the name should include the parent name and the new name separated by a forward slash (/).
RenameFolder ( folderid , newname ): none
This method changes the name of an existing folder
FindMessageId ( messageid ): string
This method seaches the mailslot and returns a filename for a given message-id if it exists, or null otherwise.
FindMessageFolder ( filename ): integer
This method seaches the mailslot and returns the folder id for a given filename if it exists, or null otherwise.
CountMessages ( folderid , filter ): integer
This method returns the number of messages in a given folder that match the given filter (if the filter is specified).
RunFilters ( folderid ): none
This method executes all the filters in the folder filter list on the messages in the given folder.
SearchContent ( text , casesensitive , logicand , folderid , maxtime , maxcount ): string
This method returns a comma-separated list of filenames that match the given content search filter. The return string can be used as a filter for other functions as filenames are tested against the filter.
AntiSpamScore ( filename ): float
This message returns the spam assessment score for the given message. The anti-spam system must be enabled, but not necessarily automatically assessing messages.
AntiSpamLearn ( filename , learnspam ): none
This method will assess the given message and add the results to the anti-spam database for this mailslot.
AntiSpamUnlearn ( filename ): none
This method will reverse the learning process for the given message.
GetSubscriberCount (): integer
This method returns the number of subscribers in a mailing list. GetSubscriberByIndex ( index ): Subscriber
This method returns a subscriber object given its index (zero based). If no matching subscriber is found, Null is returned.
GetSubscriberByEmail ( email ): Subscriber
This method returns a subscriber object given its e-mail address property. If no matching subscriber is found, Null is returned.
AddSubscriber ( name , email , replyto ): Subscriber
This method adds a new subscriber and sets the e-mail, reply-to and name properties. If the e-mail address (which is the subscriber key) matches an existing subscriber, the Null will be returned. If the subscriber is successfully added, then the subscriber object will be returned.
DeleteSubscriberByIndex ( index ): boolean
This method removes an existing subscriber based on its index in the subscriber list. If the subscriber was successfully removed, the method returns true.
DeleteSubscriberByEmail ( email ): boolean
This method removes an existing subscriber based on its e-mail address. The e-mail address is the subscriber key and must be unique amongst all subscribers. If the deletion is successful, this method will return true.
GetArchiveInterface (): Mailslot
This method returns a Mailslot object that can access the mail archive for this mailslot. The returned Mailslot has the same methods as its parent but the mail access routines return data for the archive rather than the mailslot itself. If you call this method on a Mailslot that is already an archive it will simply return itself. ArchiveMessages ( filenames ):
This method moves messages into the mailslot archive. If the mailslot is an archive then this method will reverse the operation, moving the messages back into the original mailslot.
MatchAddress ( address ):
Returns true if the given address matches this mailslot. The domain must match a local alias and the mailbox can match the name of this mailslot or one of its aliases.
|
This object represents a request made by a user's browser for a page from a local web server. The request is similar in structure to a mail message, with a header and optional body (in the case of POST requests). Scripts running on a web site have access to this object through the property. Each request should be matched with a object representing the page being composed and ultimately returned to the browser.
Properties Header |
Methods GetServerVariable |
______ | Header : string
This method returns a single string containing the entire request header. The header consists of multiple lines separated by a CR/LF pair. To access individual header items use the method GetHeaderItem. RequestString : string
This is the initial request string received from the browser. The string is in the HTTP format and looks like this :- GET /directory/page.asp?param=value HTTP/1.1 The request consists of three parts :-
Verb : string
This is the verb part of the HTTP request. It can be GET which is a request for a page that does not carry a body, or POST which carries parameters in the request body. Other verbs are used in the HTTP protocol but are not catered for by the request/response model. Host : string
This property returns the Host that the request expects to connect to. For regular web page requests this value is taken from the Host: request header. The proprty is import for multi-homed web servers where the same IP Address is used to host multiple web sites. In such cases the only means to determine which host the request is targeted at is to check this property. Uri : string
This property returns the URI part of the HTTP Request string. The URI contains the path (relative to the server) of the requested resource, optionally with parameters attached. Url : string
This property returns the URL for the request. This property is not known for web servers as the host part is removed by the browser prior to connection. This this property is only available to the proxy. UrlUser : string
This property returns the username if it appears in the request URL. Requests can include usernames and passwords in the form below :- http://username:password@server.domain.com/path/page.asp This method is more commonly used in FTP requests but it is an acceptable manner of authentication and the request/response system supports it. If the username does not exist, the return string is empty. See also UrlPassword UrlPassword : string
This property is used in conjunction with to retrieve the password when credentials are included in the URL. Path : string
This property represents the path to the requested resource as it appears in the URI. Specifically, this is the part of the URI before any parameters (i.e. before the ? symbol). QueryParams : string
This property returns the query parameters as they appear in the URI. Specifically, this is the optional part of the URL after the ? symbol. If no parameters are present, an empty string is returned. ProtocolVersion : string
This is the version part of the request protocol. Typically this value is either HTTP/1.0 or HTTP/1.1. Protocol : string
This property represents the protocol that the client browser has requested. Typically this is HTTP for normal requests and HTTPS for secured (SSL) requests. User : User
This property returns the authenticated user object, if both the browser has offered credentials and the server has successfully validated them. If no valid credentials have been offered, the return object is the Guest user account. This is not a real account (in that it cannot own objects) but it is possible to assign properties and privileges. Credentials must be offered through the Authorization:. HostPort : string
This property returns the requested TCP/IP port, typically 80 for HTTP or 443 for HTTPS, unless the request URL specifies otherwise. This property is only available in the proxy system. HostName : string
This property returns the requested host name, as it appears in the URL. This property is only available in the proxy system. ClientIp : string
This property returns the dotted quad representing the client browser IP address. An example response is given below :- 192.168.0.1 ClientHost : string
This property attempts to resolve the client IP address into a fully qualified domain name (or network name if the client is on the local network). If the IP cannot be resolved, the IP address will be returned instead. BytesReceived : integer
This property returns the number of bytes received in the request (including body if it is sent). CountryCode : string
This property is the country code as it appears in the last part of the ClientHost. If the host name is not regional, or if the host domain cannot be resolved, then an empty string is returned. An example domain is given below :- dial122-isp.domain.co.uk In the above example, the country code is uk. This string is not a guarantee of where the client is located, but can be a useful means of providing regional defaults for a user. CookieUser : User
This property returns a user account if it can be authenticated by means of a specific Cookie string. This cookie is initially set with the SetCookieUser method in the related HttpResponse object. The cookie AUTHKEY and contains the name of the user and a secure hash that can be used to later authenticate them without requiring them to login again (should the session be lost). Body : string The posted data as a single string |
______ | GetServerVariable ( variable ): string
This method returns a named variable. It is similar to the function provided by IIS so it can be used to assist the porting of scripts.
GetHeaderItem ( field ): string
This method returns a named header field. Use this method to extract a specific header field from the Header property. Example var hostname = Request.GetHeaderItem("Host");
RemoveHeaderItem ( field ): none
This method removes a named header field from the request. This is useful to prevent other scripts from accessing the data.
Query ( param ): string
This method returns a named parameter provided in the URL string. This is only useful if the Verb is GET. If it is POST the parameters are sent in the message body which is accessed with Form instead. If you wish to retrieve a named parameter regardless of whether the request was a GET or POST then use instead.
Form ( param ): string
This method returns a named parameter provided in the body part of the request. This is only useful if the Verb is POST. If it is GET the parameters are sent in the URL instead which can be accessed with Query instead. If you wish to retrieve a named parameter regardless of whether the request was a GET or POST then use instead.
Fields ( param ): string
This method returns a named parameter from either the URL (in the case of GET requests) or the request body (in the case of POST requests). This method should only be used to return short strings. Complex large objects should be handled using the Object mechanism instead.
SafeFields ( param ): string
This method returns the same data that Fields does but encodes the brackets and ampersands to prevent cross-site scripting bugs.
Object ( param ): HttpObject
This method returns a named object from the request. Objects are similar to parameters but can also contain large binary data blocks. If the request is sent with the POST verb and encoded with multipart/form-data then large objects (such as file uploads) can be sent. Objects receive such objects and store them efficiently. Such objects can be moved to the session. See HttpObject for more information.
HasQuery ( param ): boolean
This method returns true if the given parameter exists within the URL. In this case, Query will return the contents (even if it is an empty string).
HasForm ( param ): boolean
This method returns true if the given parameter exists within the message body (in the case of a POST request). In this case, Form will return the contents (even if it is an empty string).
HasField ( param ): boolean
This method returns true if the given parameter exists either in the URL or in the message body. In this case, will return the contents (even if it is an empty string).
HasObject ( param ): boolean
This method determines whether or not a named object has been successfully decoded and stored in the object list. see HttpObject for more information.
MoveObjectToSession ( name ): none
This method will move an object to the HttpSession object store. Once the object his moved, it will no longer be available in the request object store. However, it will remain in the session until it expires and can be used in later requests. see HttpObject for more information.
MoveObjectToSessionChild ( param , destobj ): none
This method moves an object to the HttpSession object store in a similar manner to MoveObjectToSession. However, it will attach the object as a child of the named session object. The object then becomes dependent on the object parent. see HttpObject for more information.
ReadSyncML (): string
This method reads a SyncML request and returns the request in a text string. If the request is WBXML encoded, it is first translated into plain XML. WillAccept ( type ): boolean Tests the requests Accept: header against the given MIME type and returns true if the requesting client will accept that type.
|
This object represents the server's response to a client's page request (accessed through the property). Data is written to this object and is ultimately returned to the client.
Properties |
Methods AddHeader |
______ | StatusCode : integer
This property is the HTTP response code issued to the client. The default code is 200 representing a normal page, but other codes (such as 304 for redirection) can also be issued. Status : string
This property is the HTTP response string that follows the response code (see StatusCode) and is normally presented to the user or logged in a transaction log. ElapsedTime : integer
This property is the number of milliseconds since the request was received. BytesSent : integer
This property is the number of bytes that have so far been sent to the client. |
______ | AddHeader ( field , value ): none
This method adds a new header line to the response header text. The header will be presented in the format Field: value. This method replaces any existing headers with the same field name. Multiple duplicate header fields are not permitted.
Redirect ( url ): none
This method configures the response to send instructions to the client to re-direct the original request to a new URL. The response object is then ended preventing further modifications.
SendSessionObject ( objectid ): none
This method will prepare and send the contents of the named HttpObject as the server's response. Such objects typically include media types and if that is the case then the object's media types will be sent. It is important to note that the object is sent in response to the request's URL, and therefore it will be assigned part of that URL as the filename. If the intention is to provide a file for the user to download, then the request should be for the correct filename (possibly redirected).
SetCookieUser ( username ): string
This method issues a cookie to the client containing an authentication key that can then later be used to automate a login. The user name to associate with the cookie must be sent and it must match an appropriately configured user account.
WriteWbxmlSyncML (, syncml): none Writes a SyncML response using WBXML compression to the client
|
Sessions are a well recognised method for maintaining state between separate page requests. When a client begins browsing a site a cookie is issued with a unique session id. Every successive request includes this id and is used to identify and associate the session. All data stored in sesions are kept until the session expires. The expiry timer is reset every time a request is received that refers to the session.
Properties |
Methods Clear |
______ |
This collection contains all the root objects stored in the session. Use this property to iterate through available objects. SpellCheck : SpellCheckContext
Every session contains a spell-checking context which is used to check the spelling in session objects. The status of the spell-check operation is maintained along with the session so that on successive requests the spell-check can continue where it previously left off. Expiry : integer
This property represents the number of milliseconds since the last action before the session expires. |
______ | Clear ( ): none
This method erases all variables and objects, clearing the session state. This includes disassociating the session from the user account.
Get ( variable ): variant
This method returns a variant from the session variable list. These variables are persistent between requests and can be used to store information such as the username of the authenticated user. The return variable type is the same as the type given to the parameter in the Set call with the same variable name.
Set ( variable , value ): none
This method sets a variable in the session variable list. These variables are persistent between requests and can be used to store information such as the username of the authenticated user. The variable is a variant type which means it can be any type and when retrieved it will maintain it's type. Use Get to retrieve the variable.
GetHtml ( variable ): string
This method returns a string from the session variable list and encodes it as necessary for display in HTML. Other than the encoding, this method is the same as Get.
GetHtmlUtf8 ( variable ): string
This method returns a string from the session variable list and encodes it as necessary for display in an HTML edit element. UTF8 characters, stored as inline MIME, will be output in binary but any HTML codes will be escaped. It is similar to GetHtml.
LoadMessage ( id , path , filename , markread , attachment ): HttpObject
This method loads a message from the specified directory and stores it in the session object list. Until the session expires (or the session object id is re-used) the message data will be available for scripts to access. The directory name refers to the location in the database where the message is stored. For mailslots, the directory would be :- mail\inbox\mailslot\ If the message includes a MIME structure then each MIME part will be loaded into a separate sub-object. If the MIME parts have sub-parts they will be loaded into sub-objects.
LoadMailslotMessage ( id , mailslot , filename , markread , attachment ): HttpObject
This method is similar to LoadMessage except that instead of specifying a mailslot path, you can use just the name instead If the message includes a MIME structure then each MIME part will be loaded into a separate sub-object. If the MIME parts have sub-parts they will be loaded into sub-objects.
RenderMessageObjectToHtml ( id , emailtemplate , attachmentemplate ): string
This method takes the id of an object that contains an e-mail message (such as one loaded with LoadMailslotMessage) and produces an HTML rendering for presentation. Optionally URL templates for attachments and e-mail addresses can be given. When the renderer encounters attachments and e-mail addreses it can construct hyperlinks in a controlled manner. Example In this example the page compose.asp creates a new e-mail and getatt.asp displays an attachment. var text = Session.RenderMessageObjectToHtml(uid, The compose.asp page takes a parameter named rcpt which is set to the e-mail address extracted by the renderer by replacing the token $email. The getatt.asp page takes a parameter named uid which is set to the object id of the attachment object extracted by the renderer by replacing the token $uid.
RenderMessageObjectToText ( id , emailtemplate , attachmentemplate ): string
This method takes the id of an object that contains an e-mail message (such as one loaded with LoadMailslotMessage) and produces a plain text rendering for presentation.
RenderMessageObjectToTextReply ( id ): string
This method takes the id of an object that contains an e-mail message (such as one loaded with LoadMailslotMessage) and prepares it for replying to. Text is wrapped and prefixed with a ">" character, unless it already starts with either the ">" or "|" characters.
RenderMessageObjectToHtmlReply ( id ): string
This method takes the id of an object that contains an e-mail message (such as one loaded with LoadMailslotMessage) and prepares it for replying to in html mode. Text is wrapped and prefixed with a ">" character, unless it already starts with either the ">" or "|" characters.
MoveObjectToChild ( id , destid ): none
This method removes a session object from the object list and adds it as a child of an existing object. This can be useful for attaching an uploaded file to an existing message.
LoadObjectFromFile ( filename ): HttpObject
This method creates a new session object and loads the contents from the named local file.
|
These objects can store large binary objects and maintain their MIME media-type and filenames. The server provides a simple method for uploading files into objects and manipulating messages using objects. Each object can also contain multiple sub-objects. When a MIME structured e-mail is loaded into an object then a heirarchy of objects are created. Objects that receive uploaded files in the can be moved to the current using the method.
Properties ContentType |
Methods AsString |
______ | ContentType : string
This property contains the media-type of the object. If the object was received from an uploaded file then the media-type presented by the browser will be maintained. If the object was loaded from an e-mail message then the media-type will be determined by the message's MIME structure. See also ContentTransferEncoding Charset : string
This property contains the character set of the object. Only text objects typically have this set and a blank string may be returned. ContentTransferEncoding : string
This property indicates what format the object data is stored in. When objects are created from e-mail messages then this property is determined by the message's MIME structure. Possible encoding schemes are: 7bit, quoted-printable and base64. Filename : string
This property contains the filename of the object. For objects uploaded from browsers, the filename is sent along with the object by the browser. For objects loaded from messages, the filename will either be left blank or be assigned to the attachment filename if the message's MIME structure specifies one. ID : string
This property is a unique identifier for the session object. At any time the current session can be queried with this id and it will return a matching object even if it is a child object. Size : integer
This propety contains the size (in bytes) of the object data. Header : string
This property contains the MIME header (multiple lines separated by CR/LF pairs) if one is defined. Files uploaded to the server carry a simple header indicating the content-type and filename, while objects extracted from messages may have more complex headers (particularly if the object represents an attached e-mail message). Use GetHeader to retrieve individual header fields. |
______ | AsString ( ): string
This method returns a string representing the object data. The string length is limited so it is only useful for simple data types. For larger objects (such as messages) the AsText method should be used instead.
AsText ( ): string
This method returns a string representing the object data. The string length is not limited so it is suitable for returning large objects, but may consume larger amounts of memory than AsString.
GetMessageList ( ): string
This method returns a comma-separated list of sub-object ids that represent entire e-mail messages. This is useful when the object is loaded from an e-mail message and it has attached e-mail messages.
GetPresentation ( formatlist (Optional) ): HttpObject
This method selects an appropriate sub-object for presenting in the requested media-type. If the object itself is suitable a reference to it is returned instead. The standard media-types are text/html and text/plain. Most e-mail messages that are written in html include both the html and text alternatives. This method will select the appropriate sub-object.
GetAttachmentList ( ): string
This method returns a comma-separated list of object ids that represent message attachments. To obtain filename and size information each object should be retrieved from the session and queried separately.
GetEmbeddedList ( ): string
This method returns a comma-separated list of content-id strings that represent embedded graphics for html messages. This list can be used to scan the message body for references to the images.
GetHeader ( field ): string
This method returns a named header field, or an empty string if no matching header field exists. See also Header and GetHeaderItem.
GetHeaderItem ( field , item ): string
This method extracts a specific item from a header field. If the item name is empty, then the default item is returned. In the example below, text/html is the default item, and item named boundary is abc. Content-Type: text/html; boundary="abc"
ExpandHeaderMacros ( template ): string
This method expands named macros assuming that the service object contains an e-mail message.
GetObject ( id ): HttpObject
This method returns an object given it's object id. The entire object heirarchy is scanned so even if the object is a child of another object it will be found given this reference. Instead of the object id, the content-id can also be used (these id strings are used to identify embedded graphics in e-mail messages).
Release ( ): none
This method releases the allocated resources for this object and removes it from the parent object or session.
ReleaseChild ( id ): none
This method will release a named child object and remove it from the object list, freeing all allocated resources.
Replace ( text ): none
This method replaces the object content with the given string.
AviScan (): string
This method scans the object for viruses using the currently installed Anti-Virus engines. If one or more viruses are found, the method returns a non-null string description. Otherwise, null is returned.
SaveToFile ( filename ): none
This method saves the content of the object to a file.
SaveToStream ( stream ): none
This method saves the content of the object to stream object (that implements the IStream interface)
|
This object is a container for objects.
Properties |
Methods |
______ | Count : integer
This property returns the number of objects in this collection. |
______ | GetByIndex ( index ): HttpObject
This method returns an indexed object
Get ( id ): HttpObject
This method returns an object in the collection that matches the given id. Child objects are not considered in this request. Use Find to search child objects as well.
Find ( id ): HttpObject
This method returns an object in the collection that matches the given id. Child objects are also searched recursively when searching for a mtaching object. Use Get to search only the objects in this collection.
Release ( id ): none
This method releases an object based on it's object id. The released object is removed from the collection.
|
The Directory Information Service provides access to personal and global address books, and the local directory. The address books contain a list of contacts that can contain a wide variety of user controlled properties. The local directory contains a record for each user account with some fixed properties (determined by the user account) and other user controlled properties. Personal Address Books are named after their owning user, while the Global Address Book is named as an empty string. The Local Directory is named ".".
Properties |
Methods |
______ |
______ | Query ( book , query , sorting , template , separator (Optional) , firstchars (Optional) , search (Optional) ): string
This method returns a single string containing all the matching entries from the named book. A template string is used for each contact entry, and the results are concatenated with the given separator to construct a single structured string. To retrieve a single contact, use Fetch.
QueryCount ( book , query , sorting , firstchars (Optional) ): integer
This method returns a count of the entries that would be returned from a call to Query with similar parameters.
Add ( book , data ): string
This method adds a new contact to the named address book. The address book cannot be the Local Directory. A single LDAP string is used to contain the contact data, using a format similar to the example below :- cn=John+Smith,o=Smithers+Corp,c=UK The string is made up of a set of LDAP Properties separated by commas. Each property is an identifier and a value separated by an en equals sign. The value must be encoded in a similar manner to a URL, and the method DisDecode can be used. The return string is the Contact Identifier which can be used with the Fetch, Update and Delete methods.
Update ( book , id , data ): none
This method updates an existing contact entry in a Personal Address Book or the Global Address Book. The format for the contact data is the same as that described in Add. The contact data is used to update or add the properties specified in the data string. Properties that are not specified are left unchanged. To clear a property, the value for that property must be blank.
Delete ( book , id ): none
This method deletes a specified contact from the named address book.
CopyTo ( srcbook , id , dstbook ): none
This method copies an entry from one address book to another.
Fetch ( book , id ): string
This method returns the contact information string (see Add for format) for a specific contact in the named address book.
Export ( book ): string
This method returns a CSV export of the entire address book
|
The Mailgroup object represents a group to which objects can belong. The Mailgroup is used to control various accounting settings.
Properties Name |
Methods GetSendMaxMessages |
______ | Name : integer A unique identifier used to refer to this Mailgroup Name : string A unique short name used to refer to this Mailgroup Description : string A textual description or long name for this Mailgroup Parent : Mailgroup This is a point to the Mailgroup that owns (is the parent of) this Mailgroup. If this Mailgroup is the root then this property will be null. AccountingEnabled : boolean Determines whether or not accounting functions are enabled for this Mailgroup. If this property is not set then no limits will be applied to the mailboxes in the Mailgroup. SendLimitEnabled : boolean Determines whether or not a limit is placed on the volume of outgoing mail that users in this mail group may send each accounting period. LimitMessages : integer The maximum number of messages that users in this mail group may send in each accounting period. LimitVolume : integer The maximum total size (in bytes) of mail that may be sent by users in this mail group each accounting period LimitMessageSize : integer The maximum size (in bytes) of any single message that may be sent by users in this mail group MailboxLimitEnabled : boolean Determines whether or not limits are placed on the contents of mail in mailboxes within this mail group. MailboxLimit : integer The maximum total size (in bytes) of mail that can be kept in a mailbox within this mail group. |
______ | GetSendMaxMessages (): integer The maximum total number of messages that may be sent by users in this mail group each accounting period. The value returned is similar to LimitMessages but if AccountingEnabled is not set then the owner mail group method is called instead. Thus the value is taken from the first parent with AccountingEnabled set.
GetSendLimitVolume (): integer The maximum total size (in bytes) of mail that may be sent by users in this mail group each accounting period. The value returned is similar to LimitVolume but if AccountingEnabled is not set then the owner mail group method is called instead. Thus the value is taken from the first parent with AccountingEnabled set.
GetSendMessageSize (): integer The maximum message size that may be sent by users within this mail group. The value returned is similar to LimitMessageSize but if AccountingEnabled is not set then the owner mail group method is called instead. Thus the value is taken from the first parent with AccountingEnabled set.
GetSendMessageSize (): integer The maximum total size (in bytes) of mail that can be kept in a mailbox within this mail group. The value returned is similar to MailboxLimit but if AccountingEnabled is not set then the owner mail group method is called instead. Thus the value is taken from the first parent with AccountingEnabled set.
Create ( Name , Description ): Mailgroup This method creates a new child mail group with the given name and description.
Delete ( Group ): none This method erases a mail group.
|
This object is used to provide spell checking services for users. The system can spell check any text assigned to it. The object instance is also associated with the session so the current state (e.g. the last work checked) is maintained between web requests. The spell checker can operate in a number of languages, although by default the language is taken from the session. The choice of languages is determined by those installed on the server. Dictionaries are stored in the dict sub-directory (below the application file). In addition to shipped language dictionaries, each user can also have a private custom dictionary to which they can add words. The name of the dictionary should match the user's name.
Properties Text |
Methods Init |
______ | Text : string
This is the text to be spell checked. Assigning a new string to this property initializes the spell checking context. Language : string
This property is used to read or select the base dictionary to use when spell checking. Any language present in the dict directory can be used. The language name is the same as the file name (without the extension). IgnoreList : Strings
This property contains a list of words to ignore in the current context. Every time the user clicks Ignore All (or an equivilent) the current word should be added to this list to prevent it being queried later in the current context. CustomDictionary : Strings
This property provides access to the user's custom dictionary. Any word can be added and it will not be queried. Word : string
This property contains the current word (the word being queried because the system believes it is misspelled). ActionCount : integer
The number of changes that have taken place since the context was initialized. If the value is greater than zero, then actions can be undone. HtmlMode : boolean
Set this property to true if the text is formatted with HTML. If this property is set then HTML tags will be skipped when extracting words. |
______ | Init ( text , lang ): none
This method is used to initialize the context. The block of text and language are given when this method is called.
LoadCustomDictionary ( name ): none
This method loads a named custom dictionary. Typically just the current username should be given.
SaveCustomDictionary ( ): none
This method saves any changes to the current custom dictionary to disk.
Run ( ): boolean
This method starts spell checking or continues checking from the current word. If the spell check completes without any further queries, then true is returned. If false is returned, then a questionable word has been reached. At that point, the Word will contain the current word.
Undo ( ): none
This method will reverse the last change made to the text. After this method is called, the Word will be updated with the last questioned word.
Change ( word ): none
This method replaces the current word with the given word.
ChangeAll ( ): none
This method replaces the current word with the given word, and automatically replaces any future occurrences of the word.
Ignore ( ): none
This method will ignore the current word. When the spell checking continues the next word will be considered.
IgnoreAll ( ): none
This method will ignore the current word, and add the word to the context ignore list, ensuring that the same word is not queried again.
Add ( ): none
This method replaces the current word with the given word, and adds the word to the custom dictionary. If words are added to this dictionary, then SaveCustomDictionary must be called to save the changes before the context is re-initialized.
GetSuggestions ( ): string
This method returns a comma-separated list of suggestions for the current word.
GetLanguages ( ): string
This method returns a comma-separated list of language codes and language names that are currently installed. Use a language code from this list when initializing the context with Init.
FormatContext ( ): string
This method returns the text surrounding the current word with the current word appropriately highlighted. Formatting is done using HTML and can be presented directly to the user when a word is being queried.
HasLanguage ( ): boolean
This method returns true if the given language code is currently installed.
|
This object is used to define a recurrence pattern for an object or task in the calendaring system. Each calendar object contains a single instance of this object
Properties |
Methods |
______ | Enabled : boolean
This property is set to true if the owning object is set to recurr. |
______ | Get ( param ): string
This method returns a named parameter from the recurrence object.
Set ( param , value ): none
This method sets a named parameter in the recurrence object
Apply ( ): none
This method applies any changes made to the recurrence pattern and updates the owning object's next action time for scheduling. Only call this method when all the necessary changes have been made, and the recurrence pattern is valid.
Clear ( ): none
This method clears all the named parameters and sets the pattern to its default state.
|
This object is used to access and manage the participants of a calendar object. Participants are users (represented by their e-mail addresses) who are invited to the event.
Properties |
Methods Clear |
______ | Count : integer
The number of participants in the object |
______ | Clear ( ): none
This method removes all participants from the calendar object.
Add ( user ): none
This method adds a new participant to the calendar object. The participant is identified by either their e-mail address or, if they are a local user, their local username.
Remove ( user ): none
This method removes a named participant from the calendar object. The given name should be the same as the name used when adding the participant.
RemoveByIndex ( index ): none
This method removes a participant based on their position in the participant list.
GetAddress ( index ): string
This method returns the e-mail address of a participant based on their position in the participant list.
GetName ( index ): string
This method returns the participant's display name based on their position in the participant list.
GetStatus ( index ): string
This method returns the participant's status (with respect to the calendar object) based on their position in the participant list. The status can be one of the following :-
GetDate ( index ): string
This method returns a timestamp representing the date at which the specified participant's status changed. The participant is identified by their position in the participant list.
GetComment ( index ): string
This method returns a general comment associated with the specified participant. The participant is identified by their position in the participant list.
GetId ( index ): string
This method returns a unique participant identifier based on the participant's position in the list. The identifier is unique to both this participant and the event.
SetInfo ( user , name , status , comment , id ): none
This method updates the participant data.
IndexOfAddress ( address ): integer
Given an e-mail address, this method returns the index of the participant in the participant list
IndexOfId ( id ): integer
Given an identifier string, this method returns the index of the participant in the participant list.
|
Properties UID |
Methods |
______ | UID :
CID :
Text :
StartTime :
EndTime :
Description :
Location :
Category :
Category :
Busy :
Private :
Group :
Status :
StatusTime :
Priority :
Notify :
NotifyEmail :
RecurringStart :
RecurringEnd :
Calendar :
AllDay :
Recurring :
Participants :
PublishParticipants :
Notes :
ActionTime :
NotifyTime :
InviteTime :
NotifiedAt :
InvitedAt :
Invitations :
TimeZone :
Decorations :
Overdue :
EventType :
AutoresponderFor : string If set, this is the mail slot whose autoresponder will be set to the field when this event is active AutoresponderText : string If set, this is the autoresponder text that will be assigned when this event is active AutoresponderSetAt : string If set, this is when the autoresponder was automatically set AutoresponderClearedAt : string If set, this is when the autoresponder was automatically cleared ExternalUID : string The UID for this event as set in a non-local store, such as the original UID for an iCalendar invited meeting |
______ | OverlapsRange ( ):
CheckForCollision ( ):
GetText ( ):
GetField ( ):
|
Properties Name |
Methods |
______ | Name :
Description :
ActionTime :
Owne :
DisplayCalendars :
IcsCalendar : string
Returns the calendar events in iCalendar format IcsTasks : string
Returns the calendar tasks in iCalendar format DisableReminders : boolean
Set this to true to prevent reminder e-mails from being sent for this calendar |
______ | NewEvent ( newid ):
GetEvent ( ):
DeleteEvent ( ):
ImportVCalendar ( vCalendar ):
GetFreeBusy ( Start , End , Url ):
|
Properties |
Methods |
______ | Count :
|
______ | GetList ( ):
ToUTC ( ):
FromUTC ( ):
|
Properties |
Methods GetCalendar |
______ | Now :
ServerTimeZone : Timezones : |
______ | GetCalendar ( name ): Calendar
GetCalendarDescription ( name ): string
CalendarExists ( name ): boolean
Check to see if the named calendar exists
CreateView ( ):
WeekDayOf ( ):
YearOf ( ):
MonthOf ( ):
DayOf ( ):
HourOf ( ):
MinuteOf ( ):
SecondOf ( ):
Advance ( ):
MakeTimeStamp ( ):
CheckTimeStamp ( ):
CheckTimeRange ( ):
MergeTimeStamp ( ):
ToLocal ( ):
ToUTC ( ):
SetDate ( ):
SetTime ( ):
MinutesBetween ( ):
|
Properties Format |
Methods InitEvents |
______ | Format :
Year :
Month :
Week :
Day :
Date :
DateUTC :
LineCount :
Width :
Height :
Highlight :
UnitCount :
FirstDay :
StartWeekOn :
MonthDays :
MonthWeeks :
PreviousMonthDays :
NextMonthDays :
ViewStartTime :
ViewStartTimeLocal :
ViewEndTimeLocal :
GranularityUnit :
GranularitySize :
ColumnCount :
Next :
Previous :
Filter :
Count :
TFClock :
User :
Sorting :
|
______ | InitEvents ( ):
AddCalendar ( ):
CalendarIndexOf ( ):
GenerateMatrix ( ):
DayIdWithinRange ( ):
FindEvent ( ):
GetUnitIdByIndex ( ):
GetUnitIdByPosition ( ):
GetEventCountInUnit ( ):
GetEventInUnit ( ):
GetEventInUnitColumn ( ):
DoesEventStartIn ( ):
DoesEventEndIn ( ):
EventContinueCount ( ):
IdWithinPeriod ( ):
WeekDayOf ( ):
DayOf ( ):
MonthOf ( ):
YearOf ( ):
HourOf ( ):
MinuteOf ( ):
IsToday ( ):
Now ( ):
Compare ( ):
IsHighlighted ( ):
ToLocal ( ):
ToUTC ( ):
GetEventByIndex ( ):
|
The subscriber is a member of a mailing list object (which is a type of mailslot).
Properties Name |
Methods |
______ | Name : string The descriptive name of the subscriber Email : string The e-mail address of the subscriber. This message corresponds to the sending address of messages to be distributed by the list. It must match the Sender:, From: or Return-Path: header fields of incoming messages, and it must be unique amongst all the subscribers in the mailing list. ReplyTo : string The destination address for the subscriber. This is the address to which messages distributed to subscribers are sent. Volume : integer This is the number of messages sent to the mailing list since the subscriber joined the list. JoinDate : datetime This is the time at which the subscriber joined the mailing list. PostDate : datetime This is time stamp of the last message posted to the mailing list. Flags : integer These flags affect how the subscriber is managed within the mailing list. The flags are a binary combination of several specific options. The available flags are :-
Details : string This property contains general details for the subscriber. Typically, this information is taken from the Organization: header of the subscription message. However, it could be used to contain any text data for the subscriber. Password : string The password for this subscriber. The password is to allow the subscriber to access and change their subscription properties. Filter : string This is a standard message filter applied to every message that might be distributed to the subscriber. |
______ |
This is a list of the configured services.
Properties |
Methods |
______ | Count : integer The number of services in the list |
______ | GetService ( index ): ServiceConfig Obtain a handle for a specific service configuration
|
Use this to configure a service
Properties |
Methods |
______ | ServiceClass : integer This value identifies the type of service Location : string This string determines the port or address or other location that the service listens on |
______ | Invalidate (): none Tells the system that changes have been made to the service configuration, instructs the service manager to reload the configuration and schedules a disk-write of the changes. |
This object is used to configure an SMTP server and inherits from ServiceConfig
Properties BlacklistIp |
Methods |
______ | BlacklistIp : Strings The IP addresses to Blacklist BlacklistFrom : Strings The FROM addresses to Blacklist BlacklistRcpt : Strings The RCPT addresses to Blacklist BlacklistHelo : Strings The HELO names to Blacklist WhitelistIp : Strings The IP addresses to Whitelist WhitelistFrom : Strings The FROM addresses to Whitelist WhitelistRcpt : Strings The RCPT addresses to Whitelist WhitelistHelo : Strings The HELO names to Whitelist |
______ |
This is an iCalendar object. It can contain other iCalendar objects, but typically the root will be a VCALENDAR and contain VEVENTs or similar
Properties |
Methods |
______ |
______ |
Each iCalObject contains several iCalFields which represent a single line in the iCalendar transport format.
Properties |
Methods |
______ |
______ |