When a new WebUser Session is created, the Skin specified in the account WebUser Preferences
is opened and is used as the "Session Skin". The string StartPage is retreived from
that Skin Text Dataset, and a jump page is composed and sent to the user browser. The jump page
redirects the user browser into the "Session Realm", to the page specified with the StartPage
string.
HTTP requests to the "Session realm" (requests with URLs started with /Session/)
are processed as Session Requests. The second component of the Session Request URL is a unique Session ID, the HTTP module
uses it to find the WebUser session.
If the specified session is not found, or the Session has the Fixed Network Address option set,
and the HTTP request did not come from the same IP address as the Login request that started the session,
the disconnected.wssp page is displayed (see above).
After the Session is found, the Web Application module processes the rest of the request URL
as the "request inside this session realm". If the request URL specifies a regular file, that
file is retrieved from the Session Skin, and it is sent back to the user browser.
For each .wssp request a code component is called. It processes the HTTP
request parameters and generates a result dataset. Then the .wssp file is retreived from the Skin,
and it is used to compose the HTTP response.
If the result dataset does not contain the blockAlerts element, the Web Application
module checks if there is a pending Alert for the session user. If one or
several pending alerts are found, the Alerts code component is called, and the
Alerts.wssp file is used to compose the HTTP response.
The Web Application module checks for certain HTTP request parameters and processes them for
all .wssp page requests. The following list specifies these "generic" actions:
- EmptyTrashNow
- If the HTTP request contains this parameter, and the mailbox or mailbox
alias with the name Trash can be opened with the "Can Delete" Mailbox Access Right, then the code
component removes all messages from that mailbox. If this operation
fails, the error code is placed into the resulting dataset as the errorCode string element.
- SMIMEUnlock
- If the HTTP request contains this parameter and the session does not have an Active Private Key, and the encrypted
Private Key exists in the Account Settings, and the HTTP request contains the SMIMEPassword parameter, the module
tries to activate ("unlock") the Private Key using the supplied password. If the operation fails, the error code is placed
into the resulting dataset as the SMIMEError string element.
The Web Application module places certain data into datasets produced with all Session Requests code components.
The following list specifies these "generic" dataset elements that can be used with all Session WSSP pages:
- messageText
- This string element is added if the HTTP request contains the messageText parameter. The element value is
the same as the HTTP parameter value.
- messageCode
- This string element is added if the HTTP request contains the messageCode parameter. The element value is
the same as the HTTP parameter value.
- secureChannel
- This element exists and has the YES string value if the request has been received via a secure (HTTPS) connection.
- isWML
- This element exists and has the YES string value if the request has been received from a WML browser.
- charset
- This string element contains the Preferred Charset selected in the User Preferences, if the Use UTF8 mode is set
to Never. Otherwise, this element contains the utf-8 string.
Note: it's just a default value, individual code components can specify different values
for this dataset element.
- SMIMEActive
- This element exists and has the YES string value if the session has an unlocked (Active) SMIME Private Key.
- SMIMEInactive
- This element exists and has the YES string value if the session does not have an unlocked (Active) SMIME Private Key,
but the user has the Private Key in the Account Settings, and the Key can be unlocked.
- mailboxes
- The list of all selectable mailboxes visible to the user.
If a .wssp request specifies an unknown code component,
but the .wssp file with the specified name can be retrieved from the Session Skin, that .wssp file
is processed using the dataset with the "generic" elements only, and the result is sent back to the
user browser.
- Example: The Stock Skin uses Hello.wssp requests. There is no code component with
this name, so a dataset with the generic values is composed, and the Hello.wssp file is
used to process this dataset.
The following sections specify the names of existing code components (names for .wssp requests),
the actions taken by these component, and the dataset produced with these components.
The code component results are processed using the .wssp files with the same names as the
code component names.
Name: Mailboxes, wMailboxes
Actions
If the HTTP request contains the Create parameter and the NewName parameter is a non-empty
string, the component tries to create a mailbox with the specified name. If this operation fails,
the errorCode element with the error code text is added to the result dataset. If the mailbox
is created, the messageCode element with MailboxCreated string value is added to
the result dataset, and the created mailbox name is added to the list of subscribed mailboxes, if the
Show Subscribed Mailboxes option is selected in the Account WebUser Preferences.
If the request contains the newClass parameter, then the created mailbox is set to the specified class.
If the HTTP request contains the Filter parameter, only the mailboxes
with names containing this parameter value are included into the list.
Result Dataset
The code component creates a list of all account mailboxes and aliases (if the
Show All Account Mailboxes option is selected in the Account WebUser Preferences), or
the list of all subscribed mailboxes (if the
Show Subscribed Mailboxes option is selected). If both options are selected, these two lists
are merged into one.
- filter
- this string element contains the current value of the HTTP Filter parameter.
- newName
- this string element contains the current value of the HTTP NewName parameter.
- mailboxClasses
- this array elements contains strings - names of all supported mailbox classes.
- mailboxList
- this element is an array with one dictionary-type element for each mailbox in
the composed mailbox list. Each dictionary contains the following elements:
- mailboxName
- this string element contains the mailbox name.
- parent
- this string element exists if the mailbox is a submailbox of some other mailbox. The string contains
the name of that parent mailbox.
- nonSelectable
- this string element with the value Yes is added if the mailbox is not selectable. If it
is added, none of the following elements is added to the dictionary.
- isList
- this element is added to the element if the mailbox is the main mailbox (archive) for
a mailing list (this also means that there is a mailing list with the same name).
- nMessages
- this string element contains the number of messages in the mailbox. If the number cannot be retrieved, the
element value is the ??? string.
- nRecent
- this string element contains the number of "Recent" messages in the mailbox.
- numUnread
- this string element contains the number of "Unseen" messages in the mailbox.
- size
- this string element contains the "rounded" size of the mailbox.
- mailboxClass
- this optional string element contains the mailbox class (for non-mail mailboxes).
- mailboxPage
- this string element contains the name of the wssp page to be used to process this mailbox class.
- nSelected
- this string element contains the number of elements in the mailboxList array.
- trashSize
- this string element is added only if the account has the Trash mailbox. It contains the Trash mailbox size.
- currentStorage
- this string element contains the "rounded-up" total size of account mailboxes.
- storageLimit
- this string element contains the "rounded-up" account total mailbox size limit.
If account does not have the total mailbox size limit, this element contains the unlimited string.
Name: Mailbox, wMailbox
The HTTP request must contain the Mailbox parameter - the name of the mailbox
to be displayed.
Actions
For each mailbox, the module creates a session object that contains the mailbox view
parameters. When the object is created, these parameters are initiated with the Web User Preferences
values.
The HTTP request Msg parameters are interpreted as "message set elements". A request can contain
several parameters, and each parameter should have a numeric value - the Unique ID of a mailbox message.
If the HTTP request contains the Forward or Redirect parameter and the RedirectAddresses
parameter is not empty, a "message set" is composed using the Msg parameters, and the message set messages are
forwarded or redirected to the specified addresses.
If the HTTP request contains the ListApprove parameter and the mailbox is an "approval" mailbox for some mailing list,
the request is processed as the Redirect request with the effective address being the mailing list address.
If the operation has been successful,
the messageCode element with the MessagesForwardedInfo or MessagesRedirectedInfo string value
is added to the result dataset. Otherwise, the errorCode element with the operation
error code string value is added to the result dataset.
If the HTTP request contains the Copy or Move parameter and the MailboxName
parameter contains a name of some selectable mailbox, a "message set" is composed using the Msg parameters,
and the message set messages are copied to the specified mailbox. If the Move parameter was
specified, the message set messages are marked as Deleted, deleted, or moved to Trash - depending on the
WebUser Preferences.
If the operation has been successful,
the messageCode element with the MessagesCopiedInfo string value
is added to the result dataset. Otherwise, the errorCode element with the operation
error code string value is added to the result dataset.
If the WebUser Preferences DeleteMethod option is set to Move To Trash, and
the HTTP request contains the Delete parameter, a "message set" is composed using the Msg parameters,
the message set messages are copied to the Trash mailbox and deleted. If the Trash mailbox
did not exist, it is created.
If the HTTP request contains the DeleteAll parameter, all mailbox messages are deleted, using the
method specified with the WebUser Preferences DeleteMethod option.
If the HTTP request contains the read, unread, flag, unflag, delete, or undelete
parameters, a "message set" is composed using the Msg parameters, and
the flags for the message set messages are modified. The delete and undelete parameters
are processed in this way only if the WebUser Preferences DeleteMethod option is not set to Move To Trash.
If the operation has not been successful, the errorCode element with the operation
error code string value is added to the result dataset.
If the WebUser Preferences DeleteMethod option is not set to Move To Trash, and
the HTTP request contains the Purge parameter, all mailbox messages with the Deleted
flag are deleted.
If the operation has not been successful, the errorCode element with the operation
error code string value is added to the result dataset.
If the HTTP request contains the NextMessage parameter with a numeric value, the value
is interpreted as the unique ID (UID) of a mailbox message, and the component tries to find the next mailbox message.
If such a message is found, its UID is added to the Result Dataset as the messageJump element.
If the HTTP request contains the PrevMessage parameter with a numeric value, the value
is interpreted as the UID of a mailbox message, and the component tries to find the previous mailbox message.
If such a message is found, its UID is added to the Result Dataset as the messageJump element.
If the HTTP request contains the NextUnread parameter and the mailbox contains an unread
message, the UID of that unread message is added to the Result Dataset as the messageJump element.
If the messageJump element was not added to the Result Dataset, the code component uses the
generic Mailbox component to process the HTTP request parameters and to compose the resulting dataset.
Result Dataset
- mailbox
- a string with the mailbox name.
- mailboxClass
- if this string element exists, it contains the mailbox class.
- mailboxPage
- this string element contains the name of the wssp page that should be used to display mailboxes of this class.
- isSentBox
- this element exists and contains the YES string if the current mailbox is the mailbox selected to keep copies of sent messages.
- isDraftsBox
- this element exists and contains the YES string if the current mailbox is the mailbox selected to keep message drafts.
- If a next unread, next, or previous message is found:
- messageJump
- a string with the found message UID.
- If a next unread, next, or previous message was not requested in the HTTP request parameters or it was not found:
- refreshTime
- the mailbox view refresh time (in seconds), retreived from the WebUser Preferences.
- listApproval
- this string element exists if the mailbox is the approval mailbox for a mailing list. The element contains the E-mail address of that mailing list.
The generic Mailbox code component is used to generate the rest of the resulting dataset.
Name: Contacts, wContacts
Processed in the same way as the Mailbox page.
Name: Notes, wNotes
Processed in the same way as the Mailbox page.
Name: Calendar, wCalendar
The HTTP request must contain the Mailbox parameter - the name of a Calendar-type mailbox
to be displayed.
Actions
For each mailbox, the module creates a session object that contains the mailbox view
parameters. When the object is created, these parameters are initiated with the Web User Preferences
values. The object also contains the month number for the "monthly calendar" view. It is initially set to the current month.
The object contains the day number that specifies the first day to be displayed in the Calendar view.
The object also contains the "byDay" flag that controls how the calendar data is stored in the dataset (by days or by time intervals).
The HTTP request prevMonthlyCalendar parameter can specify the number of months to be substructed
from the "monthly calendar" month number.
The HTTP request nextMonthlyCalendar parameter can specify the number of months to be added
to the "monthly calendar" month number.
The HTTP request JumpDay parameter can specify the "day number in the epoch" that will become the first day
to be displayed in the Calendar view.
The HTTP request byDay parameter can specify the new byDay flag value.
The HTTP request Msg parameters are interpreted as "message set elements". A request can contain
several parameters, and each parameter should have a numeric value - the Unique ID of a mailbox message.
If the WebUser Preferences DeleteMethod option is set to Move To Trash, and
the HTTP request contains the Delete parameter, a "message set" is composed using the Msg parameters,
the message set messages are copied to the Trash mailbox and deleted. If the Trash mailbox
did not exist, it is created.
If the HTTP request contains the read, unread, flag, unflag, delete, or undelete
parameters, a "message set" is composed using the Msg parameters, and
the flags for the message set messages are modified. The delete and undelete parameters
are processed in this way only if the WebUser Preferences DeleteMethod option is not set to Move To Trash.
If the operation has not been successful, the errorCode element with the operation
error code string value is added to the result dataset.
If the WebUser Preferences DeleteMethod option is not set to Move To Trash, and
the HTTP request contains the Purge parameter, all mailbox messages with the Deleted
flag are deleted.
If the operation has not been successful, the errorCode element with the operation
error code string value is added to the result dataset.
Result Dataset
- mailbox
- a string with the mailbox name.
- refreshTime
- the mailbox view refresh time (in seconds), retreived from the WebUser Preferences.
- weekDayNames
- the array containing weekday name strings, starting with the day specified as the first weekday in the WebUser Preferences.
- todayDay
- the day of month for the current date.
- todayMonth
- the current month.
- todayYear
- the current year.
- todayDayNum
- the "day number in the epoch" for the current day.
- monthlyCalendar
- an array containing one element for each week of the months to be displayed in the "monthly calendar".
Each week element is an array with 7 elements. If the element does not correspond to a month day (i.e. the element
corresponds to a day before the first day of month or after the last day of month), the element is an empty string.
Otherwise the element is a dictionary containing the following subelements:
- day
- a string with the day of the month corresponding to this element.
- workDay
- an optional YES string added if the day is a working day.
- dayNum
- the "day number in the epoch" for this day.
- year
- the string with the number of the year the first displayed day belongs to.
- byDay
- the optional element containing the YES string. It is added if the byDay flag is set.
- timeSlices
- an array containing time slice starting times if the byDay flag is set. Each element
is a dictionary containing the following values:
- hour
- the hour number in the 24-hour system.
- PMhour
- the hour number in the 14-hour system if the hour value is 12 or more.
- minute
- the minute number. Always 2 digits.
- calendarDays
- an array containing calendar view elements if the byDay flag is set. Each element is a
dictionary presenting calendar data for one day. It contains the following elements:
- weekDay
- the weekday name of this day.
- year
- the number of the year this day belongs to
- month
- the name of month this day belongs to
- day
- the day number in the month.
- dayNum
- the "day number in the epoch".
- allDayEvents
- an optional array containing descriptors for all-day events for this day. Each array element is a dictionary
containing "Event elements" (see below).
- events
- an array containing descriptors this day events. Each descriptor corresponds to one time interval, it is a dictionary
containing "Event elements" (if there is an Event in this time interval) and the following elements:
- nTimeSlices
- the length of the descriptor time interval, in time slices.
- conflicts
- an optional array containing UIDs of other Events conflicting with the Event displayed in this time interval.
- status
- if the time interval does not contain an Event and it does not belong to a "working time" period,
this element contains the UNAVAILABLE string.
- calendarDays
- an array containing calendar days if the byDay flag is not set. Each element
is a dictionary containing the following values:
- weekDay
- the weekday name of this day.
- year
- the number of the year this day belongs to
- month
- the name of month this day belongs to
- day
- the day number in the month.
- dayNum
- the "day number in the epoch".
- allDayEvents
- an array containing information about All-Day Events if the byDay flag is not set.
The array has one element for each displayed day. This element is an empty string if there
is no All-Day Events in that day, or it is an array containing dictionary subelements for each
All-Day Event taking place that day. Each dictionary subelement contains the "Event elements" for
one All-Day Event.
- calendarSlices
- an array containing information for a time interval if the byDay flag is not set.
Each array element is a dictionary containing the following elements:
- hour
- the hour number in the 24-hour system.
- PMhour
- the hour number in the 14-hour system if the hour value is 12 or more.
- minute
- the minute number. Always 2 digits.
- days
- an array with the calendar data for this time interval in each day. Each element
is a dictionary with the day data containing the "Event elements" if this time interval contains
an Event in that day, and also the following elements:
- nTimeSlices
- the length of the descriptor time interval, in time slices.
- conflicts
- an optional array containing UIDs of other Events conflicting with the Event displayed in this time interval.
- status
- if the time interval does not contain an Event and it does not belong to a "working time" period,
this element contains the UNAVAILABLE string.
The "Event elements" are:
- summary
- the string with Event Summary text.
- ID
- a numeric string with the UID of the Event message in the mailbox.
- status
- a string with the Event busy status.
- priority
- a numeric with the Event priority value. This element exists only if the Event priority is not zero.
Name: Tasks, wTasks
The HTTP request must contain the Mailbox parameter - the name of a Tasks-type mailbox
to be displayed.
Actions
For each mailbox, the module creates a session object that contains the mailbox view
parameters. When the object is created, these parameters are initiated with the Web User Preferences
values. The object contains the day number that specifies the first day to be displayed in the Tasks view.
The HTTP request JumpDay parameter can specify the "day number in the epoch" that will become the first day
to be displayed in the Tasks view.
The HTTP request Msg parameters are interpreted as "message set elements". A request can contain
several parameters, and each parameter should have a numeric value - the Unique ID of a mailbox message.
If the WebUser Preferences DeleteMethod option is set to Move To Trash, and
the HTTP request contains the Delete parameter, a "message set" is composed using the Msg parameters,
the message set messages are copied to the Trash mailbox and deleted. If the Trash mailbox
did not exist, it is created.
If the HTTP request contains the read, unread, flag, unflag, delete, or undelete
parameters, a "message set" is composed using the Msg parameters, and
the flags for the message set messages are modified. The delete and undelete parameters
are processed in this way only if the WebUser Preferences DeleteMethod option is not set to Move To Trash.
If the operation has not been successful, the errorCode element with the operation
error code string value is added to the result dataset.
If the WebUser Preferences DeleteMethod option is not set to Move To Trash, and
the HTTP request contains the Purge parameter, all mailbox messages with the Deleted
flag are deleted.
If the operation has not been successful, the errorCode element with the operation
error code string value is added to the result dataset.
The HTTP request showCompleted parameter can specify the new showCompleted flag value.
Result Dataset
- mailbox
- a string with the mailbox name.
- refreshTime
- the mailbox view refresh time (in seconds), retreived from the WebUser Preferences.
- showCompleted
- the optional element containing the YES string. It is added if the showCompleted flag is set.
- numTotal
- the total number of calendaring items in the mailbox.
- numSelected
- the total number of selected Task items.
- tasks
- an array with selected tasks. Each element is a dictionary describing a task. It contains the following elements:
- nBefore
- this number string exists if the Task starts after the initial time displayed in the Tasks view. It shows how many
Task view time periods should be skipped before the Task starts.
- nDuration
- this number string specifies the time interval (in time periods) between either the Task start time or the Task view
first display time (whatever is later) and the Task Due time or the Task view last display time (whatever is earlier).
- nAfter
- this numeric string exists if the Task ends before the Task view end time. It shows how many
Task view time periods should be skipped after the Task ends.
- ID
- a string with the UID of the Task message in the mailbox.
- percentComplete
- a numberic string with the Percent-Complete value of the Task object.
- summary
- a string with the Task summary
- priority
- a numeric string with the Task priority if it was set (is not zero).
Name: Message
The HTTP request must contain the Mailbox parameter (the name of the mailbox containing
the messages to be displayed), and the MSG parameter - the Unique ID of that message in the mailbox.
- Actions
- If the HTTP request contains the Copy or Move parameter and the MailboxName
parameter contains a name of some selectable mailbox, the message is copied to the specified mailbox.
If the Move parameter was specified, the message is marked as Deleted, or it is deleted - depending on the
WebUser Preferences.
If the operation has been successful,
the messageCode element with the MessageCopied string value
is added to the result dataset. Otherwise, the errorCode element with the operation
error code string value is added to the result dataset.
If the Move operation has removed the message, the backToMailbox element with the Yes value
is added to the result dataset, and the code component stops request processing.
If the HTTP request contains the Redirect parameter and the RedirectAddresses
parameter is not empty,the message is redirected to the specified addresses.
If the HTTP request contains the ListApprove parameter and the message mailbox is an "approval" mailbox for some mailing list,
the request is processed as the Redirect request with the effective address being the mailing list address.
If the operation has been successful,
the messageCode element with the MessageRedirected string value
is added to the result dataset. Otherwise, the errorCode element with the operation
error code string value is added to the result dataset.
If the HTTP request contains the TakeAddress parameter
the message From: address is added to the Account address book.
If the HTTP request contains the TakeCertificate parameter
the certificate from the message digital signature is added to the Account address book.
If the HTTP request contains the StoreFiles parameter and the selectedWebFolder
parameter contains a name of a Personal File Site folder, the file parts of the message (attachments, images) are stored
in the specified File Site folder.
If the operation has been successful,
the messageCode element with the FilesCopied string value
is added to the result dataset. Otherwise, the errorCode element with the operation
error code string value is added to the result dataset.
If the HTTP request contains the read, unread, flag, unflag, delete, or undelete
parameters, the message flags are modified.
If the operation has not been successful, the errorCode element with the operation
error code string value is added to the result dataset.
Then the code component use the generic Message component to process the HTTP request parameters
and the compose the resulting dataset.
- Result Dataset
- mailbox
- A string with the mailbox name.
- If the message has not been removed:
- MSG
- A string with the message UID.
- flagged, recent, deleted, flagged, media, isDraft
- These elements with the Yes value are added based if the message has the corresponding flags.
- status
- This string element has the follwing values:
- Deleted - if the message has the Deleted flag set, otherwise
- Draft - if the message has the Draft flag set, otherwise
- Redirected - if the message has the Redirected flag set, otherwise
- Unread - if the message does not have the Seen flag set, otherwise
- Answered - if the message has the Answered flag set, otherwise
- Read
- messageBody
- A string with HTML presentation of the message, generated using the generic Message
code component.
- charset
- The charset to use for message display. This element can be set with the generic Message
code component.
- nextMsg
- this element is added if there is a next message in the mailbox view. The element value
is a string with the next message UID.
- prevMsg
- this element is added if there is a previous message in the mailbox view. The element value
is a string with the previous message UID.
- hasFiles
- this YES string element is added if there is the message contains a file part.
- editableContact
- this YES string element is added if the message is a VCard object that can be updated.
- editableGroup
- this YES string element is added if the message is a Group object that can be updated.
- editableNote
- this YES string element is added if the message is a Note object that can be updated.
- editableEvent
- this YES string element is added if the message is an Event "published" by this user and it that can be updated.
- editableTask
- this YES string element is added if the message is a Task "published" by this user and it that can be updated.
- canCancelEvent
- this YES string element is added if the message is an Event this user can cancel.
- canCancelTask
- this YES string element is added if the message is a Task this user can cancel.
- canAcceptDecline
- this YES string element is added if the message is a Task or Event request.
- percentComplete
- this element containing a number is added if the message is an Task delegated to this user by someone else.
- statusCode
- this optional string element contains the status of the message if the message is a Task or an Event.
- conflictingID
- this optional string element contains the UID of the Default Calendar mailbox message that conflicts with the
displayed Event Request.
- canUpdatePartStatus
- this YES string element is added if the message is a reply to the user's Task or Event request.
- canCancelEvent
- this YES string element is added if the message is a cancel request from an Event origanizer.
- canCancelTask
- this YES string element is added if the message is a cancel request from a Task origanizer.
- listApproval
- this string element exists if the message mailbox is the approval mailbox for a mailing list. The element contains the E-mail address of that mailing list.
Name: Compose
- Actions
- If the HTTP request contains the charset parameter, the parameter value is
used as the desired charset - the charset to be used in the composed message.
The optional Operation HTTP request parameter specifies the type of the
Compose operation and it can have the Reply, ReplyAll, Forward, or EditDraft value.
If this parameter is specified, the OrigMessage parameter (with the UID of the
original message) and the OrigMailbox parameter (with the name of the mailbox containing
the original message) must be specified.
If the HTTP request contains the Operation parameter and it does not contain the filled parameter,
the original message header fields are used to compose the Subject, To, Cc, and the message body data for the new message.
Otherwise, the Subject, To, Cc, Bcc, and Body HTTP request parameters are
used as the new message data.
If the HTTP request contains the AddressBook parameter and it does not contain the
CloseBook parameter, or if HTTP request contains the OpenBook parameter
the generic AddressBook code component is used to process the request parameters and to form some result dataset elements.
If the HTTP request contains the isEvent parameter, the Calendar Event item is being
composed. If the HTTP request contains the isTask parameter, the Calendar Task (ToDo) item is being
composed. If the HTTP request contains the isNote parameter, the Note item is being
composed.
If the HTTP request contains the Send parameter, the composed message is submitted
to the Server Queue. If the HTTP request contains the Save parameter, the composed
message is stored as a Draft in the selected Drafts mailbox.
In both cases all HTTP request Attachment parameters are added to the message
as attachments.
- Result Dataset
- operation
- This string element is added to the result dataset if the HTTP request contains the Operation
parameter. The element value equals the request parameter value.
- origMessage
- This element containing the UID of the original message is added to the result dataset
if the HTTP request contains the OrigMessage parameter.
- origMailbox
- This element with the name of the mailbox containing the original message is added to the result dataset
if the HTTP request contains the OrigMailbox parameter.
- sentOrSaved
- This element with Yes value is added to the result dataset if the Send or SaveDraft operation
has completed successfully. If this element is added:
- The sent element with the Yes value is added if the operation was the Send operation.
- The messageCode element with the MessageSent or MessageSaved value is added to dataset.
- No other element listed below is added to the result dataset.
- Subject, To, Cc, Bcc
- These elements contain strings with the current header fields data.
- From
- This element contains a string with the From address specified
in the WebUser Preferences.
- addressBook
- This element with the Yes value is added to the result dataset if the
HTTP request contains the AddressBook parameter and does not contain the CloseBook
parameter or if the HTTP request contains the OpenBook parameter.
- body
- This string element contains the current message body text.
- mailerWidth
- This string element contains the MailerWidth WebUser Preferences option value.
- forwardedMessage
- This optional string element contains the HTML represenation of the original message.
This element is added to the result dataset if the HTTP request Operation parameter
is Forward.
- DSN
- This element with the Yes value is added to the result dataset if the
HTTP request contains the DSN parameter.
- SaveSent
- This element with the Yes value is added to the result dataset if
the WebUser Preferences contain a non-empty SentBox option and the HTTP
does not contain the Filled parameter or the HTTP request contains the
SaveSent parameter.
- desiredCharset
- This string element contains the name of charset to be used in the
composed message.
- charset
- This element is the UTF-8 string if the Use UTF8 WebUser Preferences option is set
to "for Reading and Composing". Otherwise, this element contains the same value as the desiredCharset
result dataset element.
- isEvent
- This element with the Yes value is added to the result dataset if the item being
composed is a Calendar Event item.
- isEvent
- This element with the Yes value is added to the result dataset if the item being
composed is a Calendar Task (ToDo) item.
- isEvent
- This element with the Yes value is added to the result dataset if the item being
composed is a Note item.
The following elements are added if the item being composed is a Calendar item:
- allDayEvent
- This element with the Yes value is added to the result dataset if the item is an All-Day
Event. The element value is controlled with the HTTP parameter of the same name.
Name: MailboxSettings
The HTTP request must contain the Mailbox parameter - the name of the mailbox
to manage.
- Actions
- If the HTTP request contains the Remove parameter, the mailbox is removed.
If the HTTP request also contains the RemoveSub parameter, all mailbox submailboxes
are removed, too.
If the operation has been successful and the Show Subscribed Mailboxes option is selected
in the WebUser Preferences, the deleted mailbox(es) are removed from the account subscription list.
If the operation has been successful, the removed element with the Yes string
value is added to the result data set and the code component stops request processing. Otherwise,
the errorCode element with the operation error code string value is added to the result dataset.
If the HTTP request contains the Rename parameter and the NewName parameters
is not empty, the mailbox is renamed. The NewName parameter value is converted into the "UTF-7 Mailbox Name encoding"
format and is used as the new mailbox name.
If the HTTP request also contains the RenameSub parameter, all mailbox submailboxes
are renamed, too.
If the operation has been successful and the Show Subscribed Mailboxes option is selected
in the WebUser Preferences, the renamed mailbox(es) are renamed in the account subscription list.
If the operation has been successful, the removed element with the Yes string
value is added to the result data set and the code component stops request processing. Otherwise,
the errorCode element with the operation
error code string value is added to the result dataset.
If the HTTP request contains the Update parameter, the code component retreieves all
Acc parameters from the request. Each Acc parameter should have a numeric value.
For each retreieved Acc parameter value nnn, the Znnn parameter is
retrieved. If it contains a non-empty string, all Knnn request parameters are retrieved,
where K is a mailbox access right letter.
The list of Znnn name strings with their Knnn parameter sets are used to
form and set the new ACL list for the selected mailbox.
If the ACL update operation has been successful,
the messageCode element with the Updated string value
is added to the result dataset. Otherwise, the errorCode element with the operation
error code string value is added to the result dataset.
If the HTTP request contains the DeleteAll parameter, all mailbox messages are deleted, using the
method specified with the WebUser Preferences DeleteMethod option. If the operation has been successful,
the messageCode element with the MessagesDeleted string value is added to the result dataset.
- Result Dataset
- renamed
- This element with the Yes string value is added to the dataset if the
mailbox has been renamed. In this case no other element is added to the result dataset.
- removed
- This element with the Yes string value is added to the dataset if the
mailbox has been removed. In this case no other element is added to the result dataset.
- rights
- This array element contains the mailbox ACL (Access Control List) elements.
Each array element is a dictionary with the following elements:
- ident
- this string element contains the ACL element name.
- index
- this string element contains the element number in the ACL set.
- lookup, select, seen, flags, insert, post, create, delete, admin
- these elements with Yes string values are added when the ACL element includes these mailbox access rights.
Name: Alerts
This code component can be called implicitly, if the Web Application module has detected a
pending Alert message.
- Actions
- If the HTTP request contains the AlertTime parameter, that parameter should contain
a time stamp in the ACAP format. The code component confirms all Alerts older than the specified
time.
If the HTTP request contains the returnURL parameter, the parameter value is added
to the result dataset (as the returnURL element).
- Result Dataset
- alerts
- This element is added to the result dataset if there are pending Alerts for the session user. The
element value is an array of dictionary elements, each element describing one alert message. Each dictionary contains
the following elements:
- time
- A string element containing the time when the alert was posted.
- text
- A string element containing the alert message text.
- currentTime
- This element is added to the result dataset if there are pending Alerts for the session user.
Its string value contains the current time in the ACAP format.
- returnURL
- If the Alerts page was retrieved automatically, when some other page had to be displayed,
the encoded URL for that other page is placed into this string element.
Name: Subscription
- Actions
- If the HTTP request contains the Open parameter, the MailboxName parameter value
is converted into the "UTF-7 Mailbox Name encoding" format, the converted string is
added to the result dataset as the jump element, and the request processing ends.
If the HTTP request contains the Update parameter:
- All Elem request parameters are retrieved, converted into the "UTF-7 Mailbox Name encoding" format,
and form the new Account Subscription list.
- All AliasName request are retreived, they should contain numeric values. For each
retrieved numeric value nnn, the parameters pairs annn and mnnn
are retrieved. If both parameters exist and contain non-empty strings, the strings are converted into
the "UTF-7 Mailbox Name encoding" format, and are used to form the new set of Account Mailbox Aliases.
- If the Subscription or Mailbox Aliases update operation fails, the errorCode element is
added to the result dataset. Otherwise the messageCode element with the Updated string value
is added to the result dataset.
- Result Dataset
- jump
- The name of the mailbox to open ("to jump to"). If this element exists, none of the following
elements is added to the result dataset.
- subscription
- This array element contains the Account subscription list. Each array element is a string
with some mailbox name.
- aliases
- This array element contains the Account Mailboix Aliases list. Each array element is a dictionary
with the following elements:
- index
- A string with this Mailbox Alias element index.
- name
- A string with the Mailbox Alias name.
- ref
- A string with the name of the Mailbox this Alias points to.
Name: Password
- Actions
- If the HTTP request contains the ModifyPassword parameter, the request should also
contain the OldPassword parameter, and that parameter should match the current Account
password. If the OldPassword parameter value is correct:
- The RecoverPassword request parameter value is set as the new RecoverPassword
account setting. The messageCode element with the Updated string value is added to the result dataset.
- If the Account user is allowed to modify the Account password, the NewPassword1 and
NewPassword2 parameters are checked. If they are non-empty and match each other, then
the Account password is updated using these parameters value.
If the password has been updated successfully, the messageCode element with the PasswordChanged string value is added to the result dataset.
If the password update operation failed, the errorCode element is added to the result dataset.
- Result Dataset
- RecoverPassword
- This string element contains the Account RecoverPassword setting value.
Name: PublicInfo
- Actions
- If the HTTP request contains the Update parameter, the request should also
contain zero, one, or several ID parameters, each with a numeric value. For each ID parameter,
its numeric value nnn is used to retrieve the pair of Nnnn and Vnnn string parameters.
The value of the Nnnn parameter specifies the name of the Account Public Info setting, the
value of the Vnnn parameter specifies the setting value. These pairs are used to set the new
Account Public Info settings. If an empty string is specified as a setting value, the setting is removed from
the Account Settings.
If the Public Info settings have been updated successfully, the messageCode element with the Updated string value is added to the result dataset.
If the password update operation failed, the errorCode element is added to the result dataset.
- Result Dataset
- publicInfo
- This array element contains a set Public Info elements. It contains one element for each
Public Info Setting specified with the Directory Integration settings.
Each array element is a dictionary with the following elements:
- id
- this string element contains the element number in the set.
- name
- this string element contains the Public Info setting name.
- value
- this string element contains the current Public Info setting value. This element exists only
if the Account contains this Public Info setting.
Name: WebSite
The code component uses the generic WebSite component to process the HTTP parameters
and to form the result dataset. Before the generic component is called, the following
elements are added to the result dataset:
- Result Dataset
- fileRef
- The WebFile/ string.
- pageRef
- The website.wssp string.
Name: Bye
- Actions
- The code component can delete old messages from the Trash (as specified in the WebUser preferences)
and closes the session. The session will be destroyed as soon as this HTTP request is processed, so
the bye.wssp code can use session data, but the prpduced HTML code should not
contain references to session objects.
- Result Dataset
- blockAlerts
- This element has the Yes string value. It is added to the result dataset to prevent
Alert processing.
