WebMail Specific Methods

APIs & Tools

The following methods are only used for WebMail related operations:

Name

isMobile

Syntax

isMobile()

Explanation

Returns true if the client was detected as a mobile browser.

Folder Specific Methods

Name

folder_create

Syntax

folder_create(STRING folderName, STRING parentPath[, STRING folderType])

Explanation

Creates a folder with name <folderName>. The parent's folder will be <parentPath>. The root parent is "/" or "". If

<folderType> is present the folder will have that type: "calendar", "tasks", "journal", "notes", "contacts".



Name

folder_delete

Syntax

folder_delete(STRING folderPath)

Explanation

Deletes the folder with absolute path <folderPath>. If the folder is a special folder (like INBOX), <folder_empty> method will be called.

- Special folders for an account are: "INBOX", "Sent", "Drafts" and "Trash".
- Special folders for a mail list are the following: "INBOX", "Sent", "Drafts", "Trash", "Requests", "PendingRequests", "ConfirmedRequests", "Pending", "Reject", "ToBeRejected" and "Deleted".



Name

folder_empty

Syntax

folder_empty(STRING folderPath)

Explanation

Empties the folder with absolute path <folderPath>.



Name

folder_move

Syntax

folder_move(STRING oldFolderPath, STRING newFolderParent)

Explanation

Moves a folder with absolute path <oldFolderPath> into the new location <newFolderParent>.


Name

folder_rename

Syntax

folder_rename(STRING oldFolderPath, STRING newFolderName)

Explanation

Renames a folder with absolute path <oldFolderPath>. The new name will be <newFolderName>.



Name

folder_setSortType

Syntax

folder_setSortType(NUMBER fid, STRING type, STRING order)

Explanation

Sets the sort <type> and <order> for <fid> folder. After this method will be called, mails from <fid> folder will be sorted in <order>("ascending" or "descending"), by <type> ("subject", "to", "date", "from" or "size").


Name

folder_setGroupType

Syntax

folder_setGroupType(NUMBER fid, STRING type, STRING order)

Explanation

The method sets the group <type> and <order> for <fid> folder. After this method will be called, mails from <fid> folder will be grouped in <order> ("ascending" or "descending"), by <type> ("subject", "from", "conversation", or "none").


Name

folder_setResolutionView

Syntax

folder_setResolutionView(NUMBER fid, STRING resolutionView)

Explanation

The method sets the <resolutionView> for <fid> folder. Depending on the folder type you can have the following resolution views:

− EVENTS folder: "day", "week", "workWeek", "month", "list"
− TASKS folder: "all", "uncompleted", "completed"
− JOURNAL folder: "day", "month", "list"


Name

folder_loadList

Syntax

ARRAY folder_loadList()

Explanation

Returns current account's folders. Every element has MAP type and the folowing properties:

− STRING name: folder's name
− STRING path: absolute path
− NUMBER fid: folder ID
− NUMBER count: number of all mails from folder
− NUMBER news: number of unseen mails from folder
− STRING type: type of the folder - can be: "local", "events", "journal", "tasks", "notes", "public" or "shared".
− VALUE isSelectable: this property exists if the folder is selectable.
− VALUE hasChildren: this property exists if the folder has one or more children.



Name

folder_loadById

Syntax

MAP folder_loadById(NUMBER folderId)

Explanation

Returns the following properties for the folder identified by <folderId>. 

− STRING name: folder name
− STRING path: absolute path
− NUMBER count: number of mails from folder
− NUMBER news: number of unseen mails from folder
− NUMBER fid: folder id
− STRING sortType: "subject", "from", "size", "date" or "incoming"
− STRING sortOrder: "ascending" or "descending"
− VALUE hasChildren: this property exists if the folder has one or more children.
− STRING resolutionView: depending on the folder type you can have the following resolution views:
  Y EVENTS folder: "day", "week", "workWeek", "month", "list"
  Y TASKS folder: "all", "uncompleted", "completed"
  Y JOURNAL folder: "day", "month", "list"


Name

folder_loadByPath

Syntax

MAP folder_loadByPath(STRING folderPath)

Explanation

Returns the same properties as the method <folder_loadById> for the folder identified by <folderPath>.


Shared Folder Providers Specific Methods

Name

fsharedFolderProvider_loadList

Syntax

ARRAY sharedFolderProvider_loadList()

Explanation

Returns the string list of shared folders providers.


Name

sharedFolderProvider_add

Syntax

sharedFolderProvider_add(STRING accountName)

Explanation

Add <accountName> to shared folders providers list.


Name

sharedFolderProvider_remove

Syntax

sharedFolderProvider_remove(STRING accountName)

Explanation

Remove <accountName> to shared folders providers list.


Folder Permission Specific Methods

Name

folderPermission_loadNames

Syntax

ARRAY folderPermission_loadNames()

Explanation

Returns the list of all possible permissions. The list contains MAPs with following properties:

− STRING name: permission name
− STRING description: permission description


Name

folderPermission_loadList

Syntax

ARRAY folderPermission_loadList(NUMBER resourceId)

Explanation

Returns the list of permissions for <resourceId>. The resource can be a folder or the current account. If the resource is a folder then the <resourceId> is a folder id. Otherwise, if the resource is the account then <resourceId> is the <folderContainerId> property obtained with account_loadInfo method. Every permission has the following properties:

− STRING name: principal's name
− ARRAY allow: the string list with allow permissions
− ARRAY deny: the string list with deny permissions


Name

folderPermission_loadPrincipalRights

Syntax

ARRAY folderPermission_loadPrincipalRights(NUMBER resourceId, STRING principalName)

Explanation

Returns the permissions list available for <principalName> on <resourceId>


Name

folderPermission_loadMyRights

Syntax

ARRAY folderPermission_loadMyRights(NUMBER resourceId)

Explanation

Returns the permissions list available for current account on <resourceId>


Name

folderPermission_set

Syntax

folderPermission_set(NUMBER resourceId, STRING principalName, ARRAY permissions)

Explanation

Try to set <permissions> for <principalName> on <resourceId>. Every permission has the properties:

− STRING name: permission's name
− STRING type: allow or deny


Name

folderPermission_remove

Syntax

folderPermission_remove(NUMBER resourceId, STRING principalName)

Explanation

Try to remove all permissions for <principalName> on <resourceId>.


Name

folderPermission_getRecursive

Syntax

STRING folderPermission_getRecursive(NUMBER fid)

Explanation

Returns "true" if permissions are applied recursively on folder <fid> and "false" otherwise.


Name

folderPermission_setRecursive

Syntax

folderPermission_setRecursive(NUMBER fid, STRING recursiveValue)

Explanation

Try to apply recursively permissions on folder <fid> if <recursiveValue> is "true" or to disable that otherwise.


Contacts Specific Methods

Name

contact_loadList

Syntax

ARRAY contact_loadList(NUMBER fid[, NUMBER startIdx])

Explanation

Loads a list of contacts from folder <fid>. If <startIdx> is present the list will begin from this index and will contain maximum pageSize webmail option. Otherwise, the list will contain all contacts from folder. Every contact has the properties:

− STRING firstName
− STRING lastName
− STRING nickName
− NUMBER id


Name

contact_getListSize

Syntax

NUMBER contact_getListSize(NUMBER fid)

Explanation

Returns the number of contacts from folder <fid>.


Name

contact_load

Syntax

MAP contact_load(NUMBER fid, NUMBER id)

Explanation

Loads the contact <id> from folder <fid> and returns:

− NUMBER id
− STRING email
− STRING firstName
− STRING lastName
− STRING nickName
− STRING personalEmail
− STRING businessEmail
− STRING phone
− STRING mobilePhone
− STRING homePhone
− STRING businessPhone
− STRING homeAddress
− STRING businessAddress
− STRING notes


Name

contact_add

Syntax

contact_add(NUMBER fid, MAP contactInfo)

Explanation

Try to add the contact with the properties contained in the MAP element <contactInfo> in folder <fid>.


Name

contact_update

Syntax

contact_update(NUMBER fid, NUMBER id, MAP contactInfo)

Explanation

Try to update the properties contained in <contactInfo> for the contact <id> from folder <fid>.


Name

contact_remove

Syntax

contact_remove(NUMBER fid, NUMBER id)

Explanation

Removes the contact <id> from folder <fid>.


Name

contact_loadImportList

Syntax

ARRAY contact_loadImportList()

Explanation

Returns a list of contacts imported from a CSV file. The file must be submited before, with action=upload.


Name

addressBook_loadList

Syntax

ARRAY addressBook_loadList([NUMBER startIdx])

Explanation

Loads the ordered list of personal contacts, domain contacts (if useDomainContacts webmail option is enabled) and public contacts (if useRcptContacts webmai loption is enabled). If <startIdx> is present the list will begin from this index and will contain maximum pageSize webmail option. Otherwise, the list will contain all contacts. Every contact has the properties:

− STRING firstName
− STRING lastName
− STRING nickname
− STRING type: personal, domain or public
− NUMBER id


Name

addressBook_getSize

Syntax

NUMBER addressBook_getSize()

Explanation

Returns the number of contacts from address book.


Alias Specific Methods

Name

alias_loadTemporaryList

Syntax

ARRAY alias_loadTemporaryList()

Explanation

Returns the list of all temporary aliases. Every alias has the properties:

− STRING name: alias name
− STRING expire: expiry date


Name

alias_createTemporary

Syntax

MAP alias_createTemporary()

Explanation

Try to create a temporary alias. In success case, returns:

− STRING name: alias name
− STRING expire: expiry date


Name

alias_removeTemporary

Syntax

alias_removeTemporary(STRING aliasName)

Explanation

Try to remove <aliasName> temporary alias.


Filters Specific Methods

Name

sieveFilter_isEmailBlackListed

Syntax

sieveFilter_isEmailBlackListed(STRING email)

Explanation

Returns true if the email is blacklisted.


Name

sieveFilter_orderMoveUp

Syntax

sieveFilter_orderMoveUp(INTEGER id)

Explanation

Moved the filter with the given id up one position.


Name

sieveFilter_orderMoveDown

Syntax

sieveFilter_orderMoveDown(INTEGER id)

Explanation

Moved the filter with the given id down one position.


Name

ARRAY sieveFilter_loadBlackList

Syntax

ARRAY sieveFilter_loadBlackList()

Explanation

Loads the list of email addresses that have been blacklisted. The ARRAY contains STRINGS.


Name

sieveFilter_addToBlackList

Syntax

sieveFilter_addToBlackList(STRING email)

Explanation

Adds an email address to the black list.


Name

sieveFilter_removeFromBlackList

Syntax

sieveFilter_removeFromBlackList(NUMBER email_index)

Explanation

Removes the entry with the email_index position from the black list.


Name

sieveFilter_loadList

Syntax

ARRAY sieveFilter_loadList()

Explanation

Loads the list of WebMail filters for the current account. Every element has MAP type and contain the following properties:

− STRING name: the name of the filter
− NUMBER id: the ID of the filter
− STRING enabled: can be "yes" or "no".


Name

sieveFilter_add

Syntax

sieveFilter_add(MAP filter)

Explanation

Adds the filter with the properties specified by <filter>. The MAP can contain the following properties:

− STRING name: name of the filter
− STRING match: can be "all" or "any"
− ARRAY expressions: expressions to be matched; each element has MAP type and can contain the following properties:
  Y STRING header: header to be matched; can be "no header", "subject", "to", "cc", "to or cc", "from", "size", "custom"
  Y STRING customHeader: custom header to be matched; exists only if <header> is "custom"
  Y STRING value: value to be matched on header
  Y STRING condition: can be "is greater than", "is lower than" if <header> is "size" or the <customHeader> is defined and considered to have a numerical value, or it can be "contains", "is", "begins with", "ends with", "does not contain", "is not", "does not begin with", "does not end with" for any other <header> value
− ARRAY actions: a list of actions to be taken when matching occurs; each element has MAP type and can contain the following properties:
  Y STRING type: can be "no action", "move", "copy", "delete", "forward" or "vacation"

If <type> is "vacation" then the following properties must exist for an action element:
  Y STRING subject: subject of the message
  Y STRING text: body of the message
  Y STRING days: number of days after another message will be sent to the same address

If <type> is not "vacation", then the following property must be defined:
  Y STRING destination: if <type> is "forward", then <destination> property should contain the e-mail address where the mail will be forwarded; in case <type> is "move" or "copy", then it must contain the name of the folder where the message will be moved or copied.

For more clarity, examples will follow for each type of filter that can be created. The example below adds a simple filter, which forwards any message that contains the string "[Jokes]" to "jokes@localdomain" email address.

The following example illustrates filtering on a custom header. It checks the custom header "X-Spam" and if it is "**" then it moves the message into "Spam" folder.

The last example illustrates the creation of a responder (<type> is "vacation").


Name

sieveFilter_load

Syntax

MAP sieveFilter_load(NUMBER filterId)

Explanation

Loads the filter with the ID <filterId>. This is the current active filter. The returned MAP element contains the same properties as for filter_add, with the same meanings, and two more properties:

− STRING enabled: it can be "true" or "false"
− NUMBER id: the ID of the filter.


Name

sieveFilter_enable

Syntax

sieveFilter_enable(NUMBER filterId)

Explanation

Enables the filter with the ID <filterId>.


Name

sieveFilter_disable

Syntax

sieveFilter_disable(NUMBER filterId)

Explanation

Disables the filter with the ID <filterId>.


Name

sieveFilter_update

Syntax

sieveFilter_update(NUMBER filterId, MAP filter)

Explanation

Updates the properties contained in <filter> for the filter specified by <filterId> (MAP element has the same properties as for #filter_load method).


Name

sieveFilter_remove

Syntax

sieveFilter_remove(NUMBER filterId)

Explanation

Removes the filter identified by <filterId> from the list of filters.


Name

sieveFilter_reset

Syntax

sieveFilter_reset()

Explanation

Resets the changes made on the current active filter.


Name

sieveFilter_setOrder

Syntax

sieveFilter_setOrder(STRING order)

Explanation

Sets the filters order. The <order> parameter must contain the id's of the filters in the desired order, comma separated.


Mail Specific Methods

Name

mail_compose

Syntax

MAP mail_compose(STRING action[, NUMBER fid, NUMBER mid])

Explanation

Tries to send a composed mail. First it verifies its correctness. If mail_compose returns true the syntax is OK. If the retuned MAP is empty, the mail was sent, otherwise you can identify bad fields:

− toErr (exists only if to is wrong)
− ccErr (exists only if cc is wrong)
− bccErr (exists only if bcc is wrong)
<action> can have one of the following values:
− "save": the mail is saved to "Drafts" folder
− "reply": the mail is send as a reply to the mail identified by by <fid> (folder id of the folder that contains the mail that is replyed) and <mid> (mail id of the mail that is replyed)
− "replyall": the same action as "reply", but the mail will be replyed to all RCPT's from the mail identified by <fid> and <mid>.
− "forward": the mail identified by <fid> and <mid> will be forwarded
− "compose": default action, for simple compose
Any other value of <action> is considered "compose".

Possible errors:
− INTERNAL_SERVER_ERROR
− MAIL_COMPOSE_NO_DATA
− MAIL_COMPOSE_BAD_FORMAT
− MAIL_COMPOSE_SIZE_LIMIT
− MAIL_COMPOSE_INVALID_RCPTS
− MAIL_COMPOSE_SEND_LIMIT
− MAIL_FROM_ERROR

Before calling this method you should upload the mail to the server, otherwise <mail_compose> will take no action. The WebMail Server recognizes a mail upload try by a query "action=compose". The form's enctype has to be "multipart/form-data" for the upload to be recognized.



If you want to attach a file to this mail you should follow the example (where query action=attach is used):


Name

mail_composeLight

Syntax

MAP mail_composeLight(MAP composeInfo)

Explanation

Tries to send a mail. <composeInfo> contains:

− From
− Reply-To
− To
− Cc
− Bcc
− Subject
− Body
− action: save | compose | reply | replyall | forward
− replyFid and replyMid: the mail replied

If the retuned MAP is empty, the mail was sent, otherwise you can identify bad fields:
− toErr (exists only if to is wrong)
− ccErr (exists only if cc is wrong)
− bccErr (exists only if bcc is wrong)

Possible errors:
− INTERNAL_SERVER_ERROR
− MAIL_COMPOSE_SIZE_LIMIT
− MAIL_COMPOSE_INVALID_RCPTS
− MAIL_COMPOSE_SEND_LIMIT
− MAIL_FROM_ERROR


Name

mail_copy

Syntax

mail_copy(NUMBER folderId, NUMBER mailId, NUMBER newFolderId)

Explanation

Copies the mail with id <mailId>, from the folder with id <folderId>, to the folder with id <newFolderId>.


Name

mail_delete

Syntax

mail_delete(NUMBER folderId, NUMBER mailId)

Explanation

Deletes the mail identified by <mailId> and <folderId>.


Name

mail_move

Syntax

mail_move(NUMBER folderId, NUMBER mailId, NUMBER newFolderId)

Explanation

Moves the mail identified by <mailId> and <folderId>, to the folder with id <newFolderId>.


Name

mail_setFlag

Syntax

mail_setFlag(NUMBER folderId, NUMBER mailId, STRING flag)

Explanation

Sets the <flag> for the mail (<folderId>, <mailId>); <flag> can be: "seen", "flagged" or "deleted". Any other values are ignored.


Name

mail_unsetFlag

Syntax

mail_unsetFlag(NUMBER folderId, NUMBER mailId, PARAM flag)

Explanation

Unsets the <flag> for the mail (<folderId>, <mailId>); <flag> can be: "seen", "flagged" or "deleted". Any other values are ignored.


Name

mail_loadComposeInfo

Syntax

MAP mail_loadComposeInfo(NUMBER fid, NUMBER mid)

Explanation

Loads some info, needed for composing mail (<fid>,<mid>). It returns a MAP object that contains:

− STRING from
− STRING to
− STRING cc
− STRING bcc
− STING replyto: used to fill "To" field in case of a "Reply" action
− STRING replytoall: used to fill "Cc" field in case of a "Reply To All" action
− STRING subject


Name

mail_load

Syntax

MAP mail_load(NUMBER folderId, NUMBER mailId)

Explanation

Returns a MAP object that contains the headers of the mail (<folderId>, <mailId>). MAP object properties:

− STRING from
− STRING subject
− STRING to
− STRING cc
− STRING bcc
− STRING date
− STRING dateFriendly: the date transformed in the user timezone; also the date has a short format ([hh:mm] if date is today, [WeekDay, dd Month] if date is this year and [dd Month yyyy] if date is not this year.
− VALUE seen: exists if the mail has the flag "seen"
− VALUE flagged: exists if the mail has the flag "flagged"
− VALUE deleted: exists if the mail has the flag "deleted"
− VALUE hasNext: exists if the mail has a succesor
− VALUE hasPrev: exists if the mail has a predecesor
− NUMBER mid: mail id
− VALUE att: exists only if mail has attachments


Name

mail_loadList

Syntax

ARRAY mail_loadList(NUMBER folderId[, NUMBER startIndex])

Explanation

Returns the list of mails from the folder with id <folderId>. The first mail from the list has <startIndex>. Every element has MAP type and properties:

− STRING subject
− STRING from
− STRING to
− STRING date
− STRING dateFriendly: the date transformed in the user timezone; also the date has a short format ([hh:mm] if date is today, [WeekDay, dd Month] if date is this year and [dd Month yyyy] if date is not this year.
− NUMBER size: mail size
− NUMBER id: mail index
− NUMBER mid: mail ID
− VALUE seen: exists if the mail has the flag "seen"
− VALUE flagged: exists if the mail has the flag "flagged"
− VALUE deleted: exists if the mail has the flag "deleted"
− STRING hasNext: exists if the mail has a succesor
− VALUE hasPrev: exists if the mail has a predecesor
− VALUE att: exists only if mail has attachments


Name

mail_getSearchFolderId

Syntax

NUMBER mail_getSearchFolderId()

Explanation

Returns the id of the temporary search folder created after a search operation. Before calling this method you should submit a search request through the Webmai Server (action=search).



After this request, the server will search all the mails from folder <fid>, that matches the inputted <subject>. A search action can be done using the following searching keys: − match ("any"|"all"): applies any/all of following criterias:
− before ("dd-mm-yyyy"): searches messages whose internal date (disregarding time and timezone) is earlier than the specified date.
− sentbefore ("dd-mm-yyyy"): searches messages whose "Date" header (disregarding time and timezone) is earlier than the specified date.
− on ("dd-mm-yyyy"): searches messages whose internal date (disregarding time and timezone) is whithin the specified date.
− senton ("dd-mm-yyyy"): searches messages whose "Date" header (disregarding time and timezone) is whithin the specified date.
− since ("dd-mm-yyyy"): searches messages whose internal date (disregarding time and timezone) is within or later than the specified date.
− sentsince ("dd-mm-yyyy"): searches messages whose "Date" header (disregarding time and timezone) is within or later than the specified date.
− subject[] (string): searches messages that contain the specified string in the "Subject" header; [] means that there can be more than one subject search criteria.
− notsubject[] (string): searches messages that don't contain the specified string in the "Subject" header.
− from[] (string): searches messages that contain the specified string in the "From" header.
− notfrom[] (string): searches messages that don't contain the specified string in the "From" header.
− to[] (string): searches messages that contain the specified string in the "To" header.
− notto[] (string): searches messages that don't contain the specified string in the "To" header.
− cc[] (string): searches messages that contain the specified string in the "CC" header.
− notcc[] (string): searches messages that don't contain the specified string in the "CC" header.
− body[] (string): searches messages that contain the specified string in the body of the message.
− notbody[] (string): searches messages that don't contain the specified string in the body of the message.
− text[]: searches messages that contain the specified string in the header or body of the message.
− nottext[] (string): searches messages that don't contain the specified string in the header or body of the message.
− header ("Header:hello"): searches messages that contain the specified string in the specified <Header> header.
− notheader ("Header:hello"): searches messages that don't contain the specified string in the specified <Header> header.v − larger (size): searches messages larger than specified size.
− smaller (size): searches messages smaller than specified size.
− deleted ("yes"|"no"): searches deleted/undeleted messages.
− seen ("yes"|"no"): searches seen/unseen messages.
− flagged ("yes"|"no"): searches flagged/unflagged messages.
− att[] (string): searches messages that contain the specified string in the attachment filenames; [] means that there can be more than one att search criteria.
− notatt[] (string): searches messages that don't contain the specified string in the attachment filenames.
− anywhere[]: searches messages that contain the specified string in the header, body or the attachments name of the message.
− notanywhere[] (string): searches messages that don't contain the specified string in the header, body or attachments name of the message.
− quicksearch[]: searches messages that contain the specified string in the subject, from, to, cc, body or the attachments name of the message.

Name

mail_sendBinary

Syntax

mail_sendBinary(NUMBER folderId, NUMBER mailId)

Explanation

Sends original mail (headers + body) in text/plain (RAW) format.


Don't write any other HTML or HSP code before this method.


Name

mail_sendHeaders

Syntax

mail_sendHeaders(NUMBER folderId, NUMBER mailId)

Explanation

Sends only the headers of mail (<folderId>, <mailId>).


Don't write any other HTML or HSP code before this method.


Name

body_loadParts

Syntax

ARRAY body_loadParts(NUMBER folderId, NUMBER mailId[, STRING action])

Explanation

Returns all body parts of the mail (<folderId>, <mailId>). Every element has MAP type and properties:

− NUMBER bid: body id
− STRING type: mime type
− STRING subtype: mime subtype

The following properties are available only for message bodies:
− STRING from
− STRING subject
− STRING to
− STRING date


Name

body_show

Syntax

body_show(NUMBER folderId, NUMBER mailId, NUMBER bodyId, MAP showInfo)

Explanation

This method will display the content of the body identified by <bodyId>, <mailId> and <folderId>. <bodyId> can be obtained with body_loadParts() method. Only text, html or multipart/related bodies are displayed. <typeShow> is a MAP object and can have the following properties:

 − STRING type: specifies what kind of bodies to display:
  Y "text": the body will be displayed only if it is TEXT/nonHTML
  Y "html": displays a body if it's of TEXT/HTML type.

It's parsed and securely regenerated.
 − STRING indent
  Y "yes": it is used to display de body indented, on a reply
  Y "no": normal display

 − STRING graphics
  Y "yes": it is used to enable all external resources
  Y "no": it is used to disable all external resources

 − STRING filter: if missing, filter level is taken from webmail options
  Y "xhtml"
  Y "tidy"
  Y "strict"
  Y "text"

After parsing a html body, if there are any external graphics then "hasGraphics" property is added to <showInfo>.


Name

att_loadList

Syntax

ARRAY att_loadList(NUMBER folderId, NUMBER mailId)

Explanation

Returns attachment list of the mail identified by <mailId> and <folderId>. Every element has MAP type and the following properties:

− NUMBER attid
− STRING name: attachment's name
− STRING type: mime type
− STRING subtype: mime subtype


Name

att_sendatt_send

Syntax

att_send(NUMBER folderId, NUMBER mailId, NUMBER attId, STRING download)

Explanation

Sends the content of the attachment identified by <attid>, <mailId> and <folderId>.


This method MUST be called alone, without any other HTML or HSP code, because it sends binary data (ex: images files) to the client and resets HTTP headers.


Name

att_sendCid

Syntax

att_sendCid(NUMBER folderId, NUMBER mailId, NUMBER bodyId, NUMBER cid)

Explanation

Sends the content of an inline attachment identified by content id <cid>, <attid>, <mailId> and <folderId>. It is used only for bodies with multipart/related types.


This method MUST be called alone, without any other HTML or HSP code, because it sends binary data (ex: images files) to the client and resets HTTP headers.


Name

upatt_add

Syntax

upatt_add()

Explanation

Tries to add an attachment to a composed message. Possible errors:

− INTERNAL_SERVER_ERROR
− UPATT_NO_DATA
− UPATT_COUNT_LIMIT
− UPATT_SIZE_LIMIT
− MESSAGE_SIZE_LIMIT

Before calling this method you should upload the attachment to the server.



Name

upatt_delete

Syntax

upatt_delete(NUMBER id)

Explanation

Deletes uploaded file with id <id>.


Name

upatt_emptyList

Syntax

upatt_emptyList()

Explanation

Empty the list of uploaded attachments.


Name

upatt_loadList

Syntax

ARRAY upatt_loadList()

Explanation

Loads uploaded file list. Returned list contains MAP objects with following properties:

− STRING filename
− STRING size
− STRING id


Name

upatt_storeFwAttt

Syntax

upatt_storeFwAtt(NUMBER folderId, NUMBER mailId, STRING disposition)

Explanation

Appends the attachment list (from mail identified by <mailId> and <folderId>), to the mail that is forwarded. If <disposition> is equal to "attachment", than the whole mail will be attached as a single attachment.

Account Specific Methods

Name

account_loadInfo

Syntax

MAP account_loadInfo()

Explanation

Returns a MAP object with following properties (account's informations):

− STRING accountName
− STRING domainName
− NUMBER totalQuota
− NUMBER remainingQuota
− NUMBER usedQuota
− NUMBER overQuotaThreshold
− NUMBER maxRpopConnections
− NUMBER minRpopRetrievalInterval
− NUMBER minHtmlFilterLevel
− NUMBER folderContainerId
− STRING accountType: user, maillist or postmaster
− STRING publicAddressBook: yes or no (license)
− STRING personalOrganizer: yes or no (license)


Name

account_getType

Syntax

STRING account_getType()

Explanation

Returns the type of the account ("user" or "mlist").


Name

account_updatePassword

Syntax

account_updatePassword(STRING oldPasswd, STRING newPasswd)

Explanation

Changes the account's password.


Name

account_loadWebmailData

Syntax

MAP account_loadWebmailData()

Explanation

Returns a MAP object with following properties (account's Webmail data):

− NUMBER pageSize: number of mails displayed on a page
− STRING skin: user's webmail skin
− VALUE confirmMailDelete: option for confirmation before mail deletion
− VALUE confirmFolderEmpty: option for confirmation before empty a folder
− VALUE saveToSent: option for saving a mail to "Sent" folder after send action
− VALUE deleteToTrash: option for moving mail to "Trash" folder after delete action
− NUMBER autoRefreshInterval
− VALUE hideDeletedMessages
− NUMBER htmlFilterLevel: can have values from 0 up to 3
− STRING language
− STRING signature
− STRING timeZone
− VALUE usePublicContacts
− VALUE useRcptContacts
− STRING weekStartDay


Name

account_updateWebmailData

Syntax

MAP account_updateWebmailData(MAP webmailData)

Explanation

Updates the account's webmail data.

User Specific Methods

Name

user_getSenderNotInAB

Syntax

INTEGER user_getSenderNotInAB()

Explanation

Returns an integer that describes the action taken when the user receives an email message from somebody that is not in his address book. Supported values:

 − PASS = 0
 − SEND_NDR = 1
 − MOVE_TO_TRASH = 2
 − DISCARD = 3


Name

user_setSenderNotInAB

Syntax

user_setSenderNotInAB(INTEGER value)

Explanation

Sets the action taken when the user receives an email message from somebody that is not in his address book. See user_getSenderNotInAB for supported values.


Name

user_loadContactInfo

Syntax

MAP user_loadContactInfo()

Explanation

Returns a MAP object with following properties (account's contact information):

− STRING firstName
− STRING lastName
− STRING nickName
− STRING personalEmail
− STRING businessEmail
− STRING phone
− STRING mobilePhone
− STRING homePhone
− STRING businessPhone
− STRING homeAddress
− STRING businessAddress


Name

user_updateContactInfo

Syntax

MAP user_updateContactInfo(MAP personalData)

Explanation

Updates account's contact information with the properties in <contactInfo>. The MAP returned by this method contains all wrong properties from <contactInfo> in case updating fails.

Maillist Specific Methods

Name

mlist_getDescription

Syntax

STRING mlist_getDescription()

Explanation

Returns the description of the mail list.


Name

mlist_setDescription

Syntax

mlist_setDescription(STRING description)

Explanation

Sets the description for the current mail list.


Domain Specific Methods

Name

domain_loadList

Syntax

ARRAY domain_loadList()

Explanation

Loads the list of domains that have showWebmailLogin = "yes" if showDomainList = "yes" in Webmail general settings.


Name

domain_loadSPEPolicy

Syntax

MAP domain_loadSPEPolicy()

Explanation

Returns the current domain password enforcement policy:

− STRING enabled(yes|no)
− NUMBER minimumLength: minimum password length
− NUMBER maximumLength: maximim password length
− STRING requiredCharacters (letters | lettersAndNumbers | lettersAndNumbersAndSpecial)

Public Folder Specific Methods

Name

publicFolder_getName

Syntax

STRING publicFolder_getName()

Explanation

Returns the name of the public folder.

Connection Specific Methods

Name

connection_isSecure

Syntax

connection_isSecure()

Explanation

Returns true if the current connection is secure (SSL) or false otherwise.


Name

connection_getHostNameResolver

Syntax

STRING connection_getHostNameResolver()

Explanation

Returns the domain name of the host. "Host" HTTP header MUST be sent by the client in order to resolve host name to domain name.


Name

connection_getUrlRedirect

Syntax

STRING connection_getUrlRedirect()

Explanation

Returns an url redirection string for the current connection which is used to redirect from a plain to a secure connection.


RPOP Specific Methods

Name

rpopConnection_loadList

Syntax

ARRAY rpopConnection_loadList()

Explanation

Returns the list of rpop connections defined by the user. Every element is a MAP and contains the following properties:

− STRING hostname
− STRING username
− NUMBER port


<rpopConnectionKey> is a MAP with hostname, username and port properties.


Name

rpopConnection_load

Syntax

MAP rpopConnection_load(MAP connKey)

Explanation

Loads the details (<rpopConnection>) of the rpop connection identified by <rpopConnectionKey> and contains:

− STRING hostname
− STRING username
− NUMBER port
− STRING password
− NUMBER retrievalInterval
− STRING folderName
− STRING encryption (none|ssl|tls)
− STRING enableAPOP (yes|no)
− STRING deleteOnRetrieval (yes|no)


Name

rpopConnection_add

Syntax

MAP rpopConnection_add(MAP connInfo)

Explanation

Adds <rpopConnection>. The MAP returned by this method contains all wrong properties from <rpopConnection> if adding failed.


Name

rpopConnection_update

Syntax

MAP rpopConnection_update(MAP connKey, MAP connInfo)

Explanation

Updates the rpop connection identified by <rpopConnectionKey> with <rpopConnection> values. The MAP returned by this method contains all wrong properties from <rpopConnection> if updating failed.


Name

rpopConnection_remove

Syntax

rpopConnection_remove(MAP connKey)

Explanation

Removes the rpop connection identified by <rpopConnectionKey>.

Grouping Specific Methods

Name

thread_loadList

Syntax

ARRAY thread_loadList(NUMBER folderId[, NUMBER startId[, NUMBER count]])

Explanation

Loads the list of threads from de folder <fid>, starting with index <startIdx>. The number of threads is passed through <count>. Every element of list is a MAP and contains:

− STRING subject (the key of the thread)

This method should be called after a call to folder_setGroupType() for the folder on which theread_loadList() acts.


Name

thread_load

Syntax

ARRAY thread_load(NUMBER folderId, STRING subject)

Explanation

Loads information about all mails from the thread identified by <subject>, folder <fid>. The list contains MAPs with properties:

− NUMBER id: mail id
− NUMBER level: level in tree


Name

group_loadList

Syntax

ARRAY group_loadList(NUMBER folderId[, NUMBER startId[, NUMBER count]])

Explanation

Returns the list of groups from folder <fid>; the first in list is <startIndex>. The number of groups is passed through <count>. Every group (MAP) contains: 

− STRING key

This method should be used after folder_setGroupType() was called.


Name

group_load

Syntax

ARRAY group_load(NUMBER folderId, STRING groupKey)

Explanation

Returns informations about all mails from the group identified by <groupKey>, from folder <fid>. <groupType> specifies the group type: "subject" or "from". Every element from list contains:

− NUMBER id: mail id

Calendar Specific Methods

Data structures (MAPS): 
WEBDATE
− NUMBER year - allowed values: 1970-2037
− NUMBER month - allowed values: 1-12
− NUMBER day - allowed values: 1-31
− NUMBER hour - allowed values: 0-23
− NUMBER min - allowed values: 0-59

OBJECTINFO: full description of calendar object
− NUMBER id - id of the object used for delete/update operations
− NUMBER recurid - recurring id. if 0 means there is no recurrence or recurring master object
− FLAG isVirtual - readonly - means this is a new recurring instance. Id is set to the master object. This object is not yet saved and an update operation is needed on this to make it persistent. After update this object will have a new id
− STRING summary - summary of the event
− WEBDATE startDate - starting date of the event. Might be missing for tasks
− WEBDATE endDate - end/due date of the event/task. Journal doesnt have this property.
− STRING type - can be one of (event, task, journal)
− STRING description - full description of the event
− STRING location - location of the event
− STRING status - readonly - status of the event can be one of:
     1. "need-action"
     2. "completed" - valid only in task
     3. "in-process" - valid only in task
     4. "cancelled"
     5. "draft" - valid only in journal
     6. "final" - valid only in journal
     7. "confirmed"
     8. "tentative"
− FLAG isAllDayEvent - Only appears for events. If set means that only year,month,day in the startDate/endDate map
− STRING email - Email address of the organizer
− STRING name - Common name for the email address of the organizer
− MAP emailReminder. Only valid for events and tasks
  Y STRING description - Text to appear in the description of the reminder (not used right now)
  Y STRING type - this is the trigger type which can be absolute or relative. "Relative" can only be set for events and absolute can only be set for tasks.
  Y WEBDATE/NUMBER trigger - This is a WEBDATE if type is absolute. If type is relative then the trigger represents the number of minutes before the start(for the event) when the popup will be shown
  Y VECTOR(STRING) attendees - A list of email addresses (xxx@xxx) where the notification emails will be sent.
− MAP displayReminder
  Y STRING description - Text associated with this reminder (not used)
  Y STRING type - Same as for email reminders
  Y WEBDATE/NUMBER trigger - same as for email reminders
− VECTOR(MAP) attendees - The attendee list. The item MAP is described below
  Y STRING name - its the name of the attendee (Ex:John Doe)
  Y STRING email - its the email address of the attendee (ex: john.doe@lost.com)
  Y STRING status - Readonly - Its the acceptance status of the attendee. Can be one of the following values
    1. "need-action" - user didnt take any action yet
    2. "accepted" - user accepted the invite
    3. "declined" - user declined the invite
    4. "tentative" - user tentatively accepted the invite
    5. "delegated" - user was delegated
    6. "completed" - Only valid for task. User completed its task
    7. "in-process" - Only valid for task.
    8. "unknown" - This should not happen anyway
− WEBDATE completedDate - optional - Only valid for task. Date when task was completed.
− NUMBER priority - Only valid for task. Priority of the task. Default is 0 and growing
− NUMBER percentComplete - Only valid for task.
− NUMBER duration - Only valid for journal. Minutes representing duration of the journal
− NUMBER category - Only valid for journal. Category string
− MAP recurrency - Only appears if object is recurrent and can only be set for the master object.
Instances of recurring objects cannot be recurrent.
  Y NUMBER count - optional - Maximum number of recurring occurances
  Y WEBDATE until - optional - Last date of a recurring occurance. Count and Until cannot be simultaniously present. In this acase then until has priority over count.
  Y NUMBER period - default 1, optional - The skip interval (ex. every 2 days)
  Y STRING type - Type of recurrence and can be one of:
    • "daily"
    • "weekly"
    • "monthly"
    • "yearly"
  Y VECTOR(STRING) weekMask - optional - Used for daily specification. Contains a list of days when occurance can take place. Possible values are ("sun", "mon", "tue","wed","thu","fri","sat"). If missing then no restrictions are assumed (all days)
  Y VECTOR(STRING) weekly - Required when type is weekly. Contains list of days of week when is possible to have occurances. Possible values are ("sun", "mon", "tue","wed","thu","fri","sat"). If missing then no restrictions are assumed (all days)
  Y MAP monthly - It is used for monthly recurrences. If monthDay excludes (weekDay, occurence)
    • STRING type - Type of monthly recurrence. Can be one of "byMonthDay" or "byWeekDay". If "byMonthDay" is specified then "monthDay" must be present. If "byWeekDay" is specified then "weekDay" and "occurence" must be specified.
    • NUMBER monthDay - Day of month (1-31)
    • VECTOR(STRING) weekMask - Mask of days. The item value can be one of ("sun", "mon", "tue","wed","thu","fri","sat")
    • STRING occurence - Possible values: ("first", "second", "third","forth", "last")
  Y MAP yearly
    • STRING type - Type of monthly recurrence and can be one of "byMonthDay" or "byWeekDay". If "byMonthDay" is specified then "month" and "monthDay" must be present. If "byWeekDay" is specified then "month", "weekDay" and "occurence" must be present.
    • STRING month - Month when occurance apears. Can be on of "january","october","november", "december"
    • NUMBER monthDay - Day of month (1-31)
    • VECTOR(STRING) weekMask - Mask of days. The item value can be one of ("sun", "mon", "tue","wed","thu","fri","sat")
− STRING transparency - Can be one of("opaque", "transparent")

Events

Name

event_loadList

Syntax

ARRAY(MAP) event_loadList(NUMBER folderId [, MAP resolutionTime])

Explanation

Returns an array of events from folder <folderId> for interval <resolutionTime>. resolutionTime (MAP):

− NUMBER year - allowed values are: 1970-2037
− NUMBER month - allowed values are: 1-12
− NUMBER weekOrDay - If this is a week then allowed values are 0-5 and represent the number of the week within the month. Week 0 means the week that contains the 1st day of the month. If this is a day then allowed value is 1-31

Each element in returned array consists of following map:
− MAP startDate - start date of event or recurring instance.
− MAP endDate - end date of event or recurring instance. If isAllDayEvent=true this is the inclusive end of the event.
− STRING summary - summary field for the event
− NUMBER id - storage object id used for reference for further ops
− NUMBER recurid - recurring instance, 0 - means no recurrence
− FLAG isAllDayEvent - true if object is all day.


Name

event_load

Syntax

MAP event_load(NUMBER folderId, NUMBER objectId [, NUMBER recurrenceId])

Explanation

Loads event <objectId> from folder <folderId>. If need to load an instance of recurring event specifiy instance time in <recurrenceId>


Name

event_add

Syntax

event_add(NUMBER folderId, MAP object)

Explanation

Adds <object> to folder <folderId>.


Name

event_update

Syntax

event_update(NUMBER folderId, OBJECTINFO objectInfo, NUMBER objectId [, NUMBER recurrenceId])

Explanation

Modifies object with <objectId> and <recurrenceId> with info from <objectInfo>. If flag isVirtual is set in the MAP then this represents an object instance, objectId represents the id of the master object.


Name

event_remove

Syntax

event_remove(NUMBER folderId, NUMBER objectId [, NUMBER recurrenceId])

Explanation

Removes object with <objectId> event from folder <folderId>. If the object is a recurring object and <recurrenceId> = 0 then removes the object and all saved instances. If object is recurring object and <recurrenceId> is not null then deletes a certain instance.


Name

event_copy

Syntax

event_copy(NUMBER folderId, NUMBER objectId, NUMBER newFolderId)

Explanation

Copies object with <objectId> event from folder <folderId> to <newFolderId>.


Name

event_move

Syntax

event_move(NUMBER folderId, NUMBER objectId, NUMBER newFolderId)

Explanation

Moves object with <objectId> event from folder <folderId> to <newFolderId>.


Tasks Specific Methods

Name

task_loadList

Syntax

ARRAY(MAP) task_loadList(NUMBER folderId)

Explanation

Returns an array of events from folder <folderId> filtered with the folder saved filtering type and sorted by due date. If no due date is present eventa are returned first. Each element in returned array consists of following map:

− MAP startDate - optional - start date of event or recurring instance
− MAP endDate - optional - end date of event or recurring instance
− STRING summary - summary field for the event
− NUMBER id - storage object id used for reference for further ops
− NUMBER recurid - recurring instance, 0 - means no recurrence
− NUMBER percentComplete - this is the percent complete for the task


Name

task_load

Syntax

MAP task_load(NUMBER folderId, NUMBER objectId [, NUMBER recurrenceId])

Explanation

Loads task <objectId> from folder <folderId>. If need to load an instance of recurring task specifiy instance time in <recurrenceId>.


Name

task_add

Syntax

task_add(NUMBER folderId, OBJECTINFO objectInfo)

Explanation

Adds an task to folder.


Name

task_update

Syntax

task_update(NUMBER folderId, OBJECTINFO objectInfo, NUMBER objectId [, NUMBER recurrenceId])

Explanation

Modifies object with <objectId> and <recurrenceId> with info from <objectInfo>. If flag isVirtual is set in the MAP then this represents an object instance, objectId represents the id of the master object.


Name

task_remove

Syntax

task_remove(NUMBER folderId, NUMBER objectId [, NUMBER recurrenceId])

Explanation

Removes object with <objectId> event from folder <folderId>. If the object is a recurring object and <recurrenceId> = 0 then removes the object and all saved instances. If object is recurring object and <recurrenceId> is not null then deletes a certain instance.


Name

task_copy

Syntax

task_copy(NUMBER folderId, NUMBER objectId, NUMBER newFolderId)

Explanation

Copies object with <objectId> event from folder <folderId> to <newFolderId>.


Name

task_move

Syntax

task_move(NUMBER folderId, NUMBER objectId, NUMBER newFolderId)

Explanation

Moves object with <objectId> event from folder <folderId> to <newFolderId>.

Inbox Processing Methods

Name

calAction_get

Syntax

MAP calAction_get(NUMBER folderId, NUMBER mailId)

Explanation

Analyses the message from itip point of view and returns a map containing info used to display information to use. Return value map:

− STRING title - its a string describing the result of the analyze. Possible values for this are:
  1. "UNDEFINED" - This should not happen
  2. "UNSUPPORTED" - The receivedObject cannot be processed because is not calendar compliant is calendar compliant and has some unsupported features for the server
  3. "PUBLISH_UPDATE" - organizer->others - receivedObject is an update for the <existingObject>. The following actions are associated with this code:
    • ACTION_ACCEPT
  4. "PUBLISH_NEW" - organizer->others - receivedObject is a new object for this attendee/assigneet. A published event means attendees are readonly. They can accept the event but no reply is sent to the organizer. The following actions are associated with this code:
    • ACTION_ACCEPT
    • ACTION_REJECT
  5. "REQUEST_RESCHEDULE" - organizer->attendee - receivedObject is an update for the <existingObject>. The existingObject was changed in a critical way which affects the planning. The following actions are associated with this code:
    • ACTION_ACCEPT
    • ACTION_TENTATIVE
    • ACTION_REJECT
    • ACTION_PROPOSE
  6. "REQUEST_UPDATE" - organizer->attendee - receivedObject is an update of the <existingObject>. The existingObject was changed in a non critical way which doesnt affect its planning. The following actions are associated with this code:
    • ACTION_ACCEPT
  7. "REQUEST_NEW" - organizer->attendee - receivedObject is a new calendar object received. The following actions are associated with this code:
    • ACTION_ACCEPT
    • ACTION_TENTATIVE
    • ACTION_REJECT
    • ACTION_PROPOSE
  8. "REPLY" - attendee->organizer - receivedObject is a reply announcing attendee participation status ( for task also anounces its percent complete) This message is processed automatically and no actions are defined.
  9. "REPLY_INVALID_REQUEST", - attendee->organizer: - the operation requested by the organizer could not be processed by the attendee and this is a notification.
  10. "CANCEL" - organizer->attendee - The organizer has canceled an object, master recurring object or instance of a recurring object. The following actions are associated with this code:
    • ACTION_ACCEPT
  11. "REFRESH" - attendee->organizer - Attendee requested an update for an object. The following actions are associated with this code:
    • ACTION_ACCEPT
  12. "COUNTER" - attendee->organizer - The receivedObject contains proposal information from the attendee. The following actions are associated with this code:
    • ACTION_ACCEPT
    • ACTION_REJECT
    • ACTION_PROPOSE - if organizer whats to change the receivedObject and send an update to attendee
  13. "DECLINECOUNTER", - organizer->attendee - Organizer rejected the proposal from the attendee. The following actions are associated with this code:
    • ACTION_ACCEPT
  14. "OBSOLETE" - system - It is an error code announcing that the receivedObject has a sequence number smaller than the existingObject and cannot be processed.
  15. "TOONEW" - system - It is an error code announcing that the receivedObject has a sequence number greater than the existingObject and cannot be processed.
  16. "SECURITY_ROLEERROR" - system - it is an error code announcing that the received object has a security error which can be: the from mail is not attendee or organizer, the receiver is not organizer or attendee depending on context.
  17. "CANNOTVIEW" - system - error nouncing that this email object cannot be processed as an itip email. Occures when trying to click an email from search folder.
  18. "CANNOTVIEWPF" - system - error nouncing that this email object cannot be processed as an itip email in a public folder.
  19. "NORIGHTS" - system - error happens when user doesnt have permissions to access the default calendar of this itip message.
− VECTOR(string) actions - contains the possible actions that can be taken by the user:
  1. "ACCEPT"
  2. "ACCEPT_TENTATIVE"
  3. "REJECT"
  4. "PROPOSE"
  5. "READONLY" - this is not a possible action but rather a status. Instead of buttons a message should be displayed to announce the user he doesnt have write permissions to the personal calendar/task folder
  6. "READONLY_ITIP" - this is not a possible action but rather a status. Instead of buttons a message should be displayed to announce the user he doesnt have permissions to remove the itip email after processing
− OBJECTINFO receivedObject - contains the object received from email
− OBJECTINFO existingObject - optional - contains the object existing in storage with the same UID as the one received
− STRING calendarFid - container the fid of the calendar mbox that will be used when action will take place


Name

calAction_take

Syntax

calAction_take(NUMBER folderId, NUMBER mailId, STRING action [, OBJECTINFO proposedInfo])

Explanation

Call this when user presses one on the action buttons to actually process <folderId, mailId> with <action>. If action is ACTION_PROPOSE then a <proposedInfo> map must be specified.

Popup Reminders

Name

reminder_loadList

Syntax

ARRAY(MAP) reminder_loadList()

Explanation

Returns a list of calendar object (task/events) which have a reminder that has expired. The returned map has the following structure

− NUMBER id - id of the object
− NUMBER recurid - the recurring id of the object
− WEBDATE startDate - optional - start date of the event
− WEBDATE endDate - end/due date of the event
− STRING summary - summary of the object
− STRING type - type of the entry. Can be one of ("event", "task")


Name

reminder_takeAction

Syntax

reminder_takeAction(STRING type, NUMBER snoozeTime, NUMBER objectId[, NUMBER recurrenceId])

Explanation

Use this function to snooze/dismiss with <snoozeTime> the object identified by <type, objectid, recurrenceId>


Notes Specific Methods

Name

note_loadList

Syntax

ARRAY(MAP) note_loadList(NUMBER fid[, NUMBER startIdx])

Explanation

Returns the stored notes list form <fid> folder, starting with <startIdx> index. The number of notes is maximum <pageSize> from webmail options.The returned ap is:

− NUMBER mid - mail id
− STRING note - summary of note
− WEBDATE date - date of note


Name

note_show

Syntax

note_show(NUMBER fid, NUMBER mailId)

Explanation

Shows <mailId> note from <fid> folder.


Name

note_add

Syntax

note_add(NUMBER fid)

Explanation

Adds a note to <fid> folder. Before calling this method you should upload the note to the server.



Name

note_update

Syntax

note_update(NUMBER fid, NUMBER mailId)

Explanation

Modifies <mailId> note from <fid> folder. Before calling this method you should upload the new note to the server.


Name

note_remove

Syntax

note_remove(NUMBER fid, NUMBER mailId)

Explanation

Removes <mailId> note from <fid> folder.

Free / Busy Specific Methods

FBENTRY - represents a busy interval [startDate, endDate)

− WEBDATE startDate − WEBDATE endDate


Name

freebusy_query

Syntax

ARRAY(FBENTRY) freebusy_query(STRING userEmail, WEBDATE startDate, WEBDATE endDate)

Explanation

Retrieve busy intervals in the specified interval [startData, endDate) for user specified by <userEmail>


Date Functions

Name

date_load

Syntax

WEBDATE date_load()

Explanation

Returns the user's current date in WEBDATE format.


Name

timezone_loadList

Syntax

ARRAY timezone_loadList()

Explanation

Returns a list of strings. Each string represents a timezone.