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

27. processing

Fields
Methods
Member Objects


1. Fields

max_retry_count

Function name Function signature
processing_max_retry_count_get int processing_max_retry_count_get (object:processing obj)
This function returns the maximum number of retries to deliver an email
processing_max_retry_count_set int processing_max_retry_count_set (object:processing obj, int value)
This function sets the maximum number of retries to deliver an email. Returns 0 on succes, -1 on failure

max_mail_schedule_interval

Function name Function signature
processing_max_mail_schedule_interval_get int processing_max_mail_schedule_interval_get (object:processing obj)
This function obtains the maximum interval for email resheduling in case of a delivery error (in seconds)
processing_max_mail_schedule_interval_set int processing_max_mail_schedule_interval_set (object:processing obj, int value)
This function sets the maximum interval for email resheduling in case of a delivery error (in seconds). Returns 0 on succes, -1 on failure

max_directory_count

Function name Function signature
processing_max_directory_count_get int processing_max_directory_count_get (object:processing obj)
This function returns the maximum number of directories in the queue directory
processing_max_directory_count_set int processing_max_directory_count_set (object:processing obj, int value)
This function sets the maximum number of directories in the queue directory. Returns 0 on succes, -1 on failure

internal_queue_size

Function name Function signature
processing_internal_queue_size_set int processing_internal_queue_size_set (object:processing obj, int value)
This function sets the internal processing queue size (in number of messages). Returns 0 on succes, -1 on failure
processing_internal_queue_size_get int processing_internal_queue_size_get (object:processing obj)
This function returns the internal processing queue size (in number of messages)

log_host

Function name Function signature
processing_log_host_get string processing_log_host_get (object:processing obj)
This function returns the host which handles the logging (if the log type is not local)
processing_log_host_set int processing_log_host_set (object:processing obj, string value)
This function sets the address of the host that offers log services for Axigen. Returns 0 on succes, -1 on failure

mailbox_disable_interval

Function name Function signature
processing_mailbox_disable_interval_set int processing_mailbox_disable_interval_set (object:processing obj, int value)
This function sets the number of seconds a mailbox(folder) is disabled if the "messages per second" limit is disabled. Returns 0 on succes, -1 on failure
processing_mailbox_disable_interval_get int processing_mailbox_disable_interval_get (object:processing obj)
This function returns the number of seconds a mailbox(folder) is disabled if the "messages per second" limit is disabled

queue_path

Function name Function signature
processing_queue_path_get string processing_queue_path_get (object:processing obj)
This function returns the path of the queue directory
processing_queue_path_set int processing_queue_path_set (object:processing obj, string value)
This function sets the path of the queue directory. Returns 0 on succes, -1 on failure. Returns 0 on succes, -1 on failure

delivery_threads

Function name Function signature
processing_delivery_threads_set int processing_delivery_threads_set (object:processing obj, int value)
This function sets the number of email delivery threads. Returns 0 on succes, -1 on failure
processing_delivery_threads_get int processing_delivery_threads_get (object:processing obj)
This function returns the number of email delivery threads

queue_schedule_interval

Function name Function signature
processing_queue_schedule_interval_get int processing_queue_schedule_interval_get (object:processing obj)
This function obtains the interval for queue checking
processing_queue_schedule_interval_set int processing_queue_schedule_interval_set (object:processing obj, int value)
This function sets the interval for queue checking. Returns 0 on succes, -1 on failure

log_level

Function name Function signature
processing_log_level_set int processing_log_level_set (object:processing obj, int val)
This function sets the log level for this service. For more information on service log level, read the Axigen documentation. Returns 0 on succes, -1 on failure
processing_log_level_get int processing_log_level_get (object:processing obj)
This function returns the log level for this service. For more information of service log level, read the Axigen documentation

messages_per_second

Function name Function signature
processing_messages_per_second_set int processing_messages_per_second_set (object:processing obj, int value)
This function sets the maximum number of email which a mailbox(folder) is allowed to receive in one second. Returns 0 on succes, -1 on failure
processing_messages_per_second_get int processing_messages_per_second_get (object:processing obj)
This function returns the maximum number of email which a mailbox(folder) is allowed to receive in one second

log_type

Function name Function signature
processing_log_type_get string processing_log_type_get (object:processing obj)
This function returns the log the for this service. Expected values are: "internal", "system" or "remote"
processing_log_type_set int processing_log_type_set (object:processing obj, string value)
This function sets the log type for this service. Valid values for the 'value' parameter are: "internal"(used at logging in a local file), "system"(used at logging in system log) or "remote"(used at logging on a dedicated logging machine)

2. Methods

Function name Function signature
processing_load object:processing processing_load (object:session session, object:context_list context)
processing_destroy int processing_destroy (object:processing processing)
This function destroys a processing object
processing_reset int processing_reset (object:processing processing, object:session session)
This function resets the changes made but not yet saved
processing_save int processing_save (object:processing serv, object:session session)
This function saves the processing configuration back to Axigen

3. Member Objects

listeners

Functions that apply to member object:
Function name Function signature
pop3_listeners_get object:listeners pop3_listeners_get (object:pop3 pop3, object:session s)
This function returns the listener list of this service