CLI API Documentation

Axigen's PHP Command Line Interface API reference guide

List of all members.

Public Member Functions

  __construct ($webmailDataObj, $parentObj)
  __get ($varName)
  __set ($varName, $varValue)
  getSessionObj ()
  getWebmailData ()
  save ()

Member Function Documentation

WebmailData::__get ( varName  ) 

Get member.

member

description

skin

the skin for Webmail

language

the language for Webmail

signature

the account signature

pageSize

page size

timeZone

the timezone of the account

saveToSent

a mail copy to be saved in the Sent folder

deleteToTrash

deleted mail to be sent in the Trash folder

autoRefreshInterval

the Webmail automatic refresh interval, stated in minutes

confirmMailDelete

confirmation of mail deletion

confirmFolderEmpty

confirmation of emptying folder

htmlFilterLevel

the security level for a HTML mail body

usePublicContacts

if the account should use the domain public contacts in addressbook context

useRcptContacts

if the account should use the domain recipient contacts in addressbook context

requestReadReceipts

enable/disable requesting of read receipts

sendReadReceipts

enable/disable sending of read receipts (values: always|never|ask)

weekStartDay

the account week start day

purgeTrashMessageSelector

the message selector used to purge trash folder

purgeSpamMessageSelector

the message selector used to purge spam folder

WebmailData::__set ( varName,
varValue  
)

Set member.

member

description

skin

the skin for Webmail

language

the language for Webmail

signature

the account signature

pageSize

page size

timeZone

the timezone of the account

saveToSent

a mail copy to be saved in the Sent folder

deleteToTrash

deleted mail to be sent in the Trash folder

autoRefreshInterval

the Webmail automatic refresh interval, stated in minutes

confirmMailDelete

confirmation of mail deletion

confirmFolderEmpty

confirmation of emptying folder

htmlFilterLevel

the security level for a HTML mail body

usePublicContacts

if the account should use the domain public contacts in addressbook context

useRcptContacts

if the account should use the domain recipient contacts in addressbook context

requestReadReceipts

enable/disable requesting of read receipts

sendReadReceipts

enable/disable sending of read receipts (values: always|never|ask)

weekStartDay

the account week start day

purgeTrashMessageSelector

the message selector used to purge trash folder

purgeSpamMessageSelector

the message selector used to purge spam folder

WebmailData::save (  ) 

this method must be called if one of the members has been changed

Returns:
bool