Table of Objects

1. account

2. cli

3. connection_data

4. contact_info

5. context

6. dnr

7. domain

8. domain_registration

9. field

10. filter

11. folder_rcpt

12. forwarder

13. ftp_backup

14. imap

15. ldap_connector

16. limits

17. list

18. listener

19. loader

20. log

21. maillist

22. mapping_data

23. migration

24. migration_data

25. nameserver

26. pop3

27. processing

28. proxy

29. public_folder

30. queue

31. queue_item

32. quotas

33. registry_information

34. report

35. rpop

36. saver

37. server

38. services

39. session

40. smtp_out

41. spe

42. string_list

43. upload_wmfilter

44. url_redirect

45. userdb

46. webadmin

47. webmail

48. webmaildata

48. webmaildata

Fields
Methods
Member Objects


1. Fields

delete_to_trash

Function name Function signature
webmaildata_delete_to_trash_set int webmaildata_delete_to_trash_set (object:webmaildata obj, int value)
This function tells Webmail to move the deleted emails to Trash folder (if the value parameter is 1). If the value parameter is 0 the deleted messages will no be moved.
webmaildata_delete_to_trash_get int webmaildata_delete_to_trash_get (object:webmaildata obj)
This function returs 1 if the deleted mails should be moved to trash and 0 if not

week_start_day

Function name Function signature
webmaildata_week_start_day_get string webmaildata_week_start_day_get (object:webmaildata obj)
This function returns the start day of the week used in Axigen Webmail for the the account to whom the webmaildata object belongs

signature

Function name Function signature
webmaildata_signature_get string webmaildata_signature_get (object:webmaildata obj)
This function returns the email signature used in Axigen Webmail for the the account to whom the webmaildata object belongs
webmaildata_signature_set int webmaildata_signature_set (object:webmaildata obj, string value)
This function sets the signature appended by Webmail at the end of each email sent by the account who has the webmaildata object, returns 0 on succes, -1 on failure

language

Function name Function signature
webmaildata_language_get string webmaildata_language_get (object:webmaildata obj)
This function returns the language used in Axigen Webmail for the the account to whom the webmaildata object belongs
webmaildata_language_set int webmaildata_language_set (object:webmaildata obj, string value)
This function sets the language to be used by Webmail

timezone

Function name Function signature
webmaildata_timezone_get string webmaildata_timezone_get (object:webmaildata obj)
This function returns the timezone used in Axigen Webmail for the the account to whom the webmaildata object belongs
webmaildata_timezone_set int webmaildata_timezone_set (object:webmaildata obj, string value)
This function sets the timezone to be used by Webmail. Returns 0 on succes, -1 on failure

save_to_sent

Function name Function signature
webmaildata_save_to_sent_get int webmaildata_save_to_sent_get (object:webmaildata obj)
This function returns 1 if the sent mail should be saved to Sent folder and 0 if not
webmaildata_save_to_sent_set int webmaildata_save_to_sent_set (object:webmaildata obj, int value)
This function tells Webmail to save the sent mails to Sent folder (if the value parameter is 1). If the value parameter is 0 the sent messages will no be saved.

use_domain_contacts

Function name Function signature
webmaildata_use_domain_contacts_get int webmaildata_use_domain_contacts_get (object:webmaildata obj)
This function returns 1 if Webmail uses domain contacts and 0 otherwise

hide_deleted_messages

Function name Function signature
webmaildata_hide_deleted_messages_set int webmaildata_hide_deleted_messages_set (object:webmaildata obj, int value)
This function tells Webmail to hide the emails with the deleted flag (if the value parameter is 1). If the value parameter is 0 the deleted emails will be shown.
webmaildata_hide_deleted_messages_get int webmaildata_hide_deleted_messages_get (object:webmaildata obj)
This function returns 1 if Axigen Webmail hides the mails with the deleted flag set and 0 otherwise

confirm_folder_empty

Function name Function signature
webmaildata_confirm_folder_empty_set int webmaildata_confirm_folder_empty_set (object:webmaildata obj, int value)
This function sets the Webmail option of confirmation when emptying folders (if the value parameter is 1). If the value is 0 the function desets this option.
webmaildata_confirm_folder_empty_get int webmaildata_confirm_folder_empty_get (object:webmaildata obj)
This function returns 1 if Webmail asks for confirmation when the user wants to empty a folder

page_size

Function name Function signature
webmaildata_page_size_get int webmaildata_page_size_get (object:webmaildata obj)
This function returns the page size (the number of emails displayed in a page) used in Axigen Webmail for the the account to whom the webmaildata object belongs
webmaildata_page_size_set int webmaildata_page_size_set (object:webmaildata obj, int value)
This function sets the week start day to be used by Webmail. Values should be valid days in the selected language. For example, if the setted language is "en" than the first day could be setted to "Sunday". Returns 0 on succes, -1 on failure */ int webmaildata_week_start_day_set(struct webmaildata* obj, const char* value); /** This function sets the number of emails that Webmail should display on a page. Returns 0 on succes, -1 on failure

skin

Function name Function signature
webmaildata_skin_get string webmaildata_skin_get (object:webmaildata data)
This function destroys a webmail data object This function returns the name of the skin used in Axigen Webmail for the the account to whom the webmaildata object belongs
webmaildata_skin_set int webmaildata_skin_set (object:webmaildata obj, string value)
This function sets the skin to be used by Webmail. At this time valid values are: classic, coolwater, webreflection. Returns 0 on succes, -1 on failure

auto_refresh_interval

Function name Function signature
webmaildata_auto_refresh_interval_set int webmaildata_auto_refresh_interval_set (object:webmaildata obj, int value)
This function sets the Webmail auto refresh interval (in seconds)
webmaildata_auto_refresh_interval_get int webmaildata_auto_refresh_interval_get (object:webmaildata obj)
This function returns the Webmail auto refresh interval in seconds

confirm_mail_delete

Function name Function signature
webmaildata_confirm_mail_delete_get int webmaildata_confirm_mail_delete_get (object:webmaildata obj)
This function returns 1 if Webmail asks for confirmation when the user deletes emails and 0 otherwise
webmaildata_confirm_mail_delete_set int webmaildata_confirm_mail_delete_set (object:webmaildata obj, int value)
This function sets the Webmail option of confirmation when deleting emails (if the value parameter is 1). If the value is 0 the function desets this option.

use_public_contacts

Function name Function signature
webmaildata_use_public_contacts_get int webmaildata_use_public_contacts_get (object:webmaildata obj)
This function returns 1 if Webmail uses public contacts and 0 otherwise

2. Methods

Function name Function signature
webmaildata_load object:webmaildata webmaildata_load (object:session session, object:context_list context)
webmaildata_save int webmaildata_save (object:webmaildata data, object:session session)
This function saves the webmaildata object

3. Member Objects

listeners

Functions that apply to member object:
Function name Function signature
webmail_listeners_get object:listeners webmail_listeners_get (object:webmail webmail, object:session s)
This function returns a list of webmail listeners