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

13. ftp_backup

Fields
Methods
Member Objects


1. Fields

max_auth_errors

Function name Function signature
ftp_backup_max_auth_errors_get int ftp_backup_max_auth_errors_get (object:ftp_backup obj)
This function returns the maximum authentication errors number after which the connection is terminated
ftp_backup_max_auth_errors_set int ftp_backup_max_auth_errors_set (object:ftp_backup obj, int value)
This function sets the maximum authentication errors number after which the connection is terminated. Returns 0 on succes, -1 on failure

max_connection_threads

Function name Function signature
ftp_backup_max_connection_threads_get int ftp_backup_max_connection_threads_get (object:ftp_backup obj)
This function returns the maximum number of threads involved in I/O for this service
ftp_backup_max_connection_threads_set int ftp_backup_max_connection_threads_set (object:ftp_backup obj, int value)
This function sets the maximum number of threads involved in I/O for this service. Returns 0 on succes, -1 on failure

max_errors

Function name Function signature
ftp_backup_max_errors_get int ftp_backup_max_errors_get (object:ftp_backup obj)
This function returns the maximum protocol errors number after which the connection is terminated
ftp_backup_max_errors_set int ftp_backup_max_errors_set (object:ftp_backup obj, int value)
This function sets the maximum protocol errors number after which the connection is terminated. Returns 0 on succes, -1 on failure

log_host

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

log_level

Function name Function signature
ftp_backup_log_level_get int ftp_backup_log_level_get (object:ftp_backup obj)
This function returns the log level for this service. For more information of service log level, read the Axigen documentation
ftp_backup_log_level_set int ftp_backup_log_level_set (object:ftp_backup 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

min_connection_threads

Function name Function signature
ftp_backup_min_connection_threads_get int ftp_backup_min_connection_threads_get (object:ftp_backup obj)
This function returns the minimum number of threads involved in I/O for this service
ftp_backup_min_connection_threads_set int ftp_backup_min_connection_threads_set (object:ftp_backup obj, int value)
This function sets the minimum number of threads involved in I/O for this service. Returns 0 on succes, -1 on failure

log_type

Function name Function signature
ftp_backup_log_type_get string ftp_backup_log_type_get (object:ftp_backup obj)
This function returns the log the for this service. Expected values are: "internal", "system" or "remote"
ftp_backup_log_type_set int ftp_backup_log_type_set (object:ftp_backup 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
ftp_backup_save int ftp_backup_save (object:ftp_backup serv, object:session session)
This function saves the ftp backup configuration back to Axigen
ftp_backup_destroy int ftp_backup_destroy (object:ftp_backup ftp_backup)
This function destroys a ftp backup object
ftp_backup_reset int ftp_backup_reset (object:ftp_backup ftp_backup, object:session session)
This function resets the changes made but not yet saved
ftp_backup_load object:ftp_backup ftp_backup_load (object:session session, object:context_list context)

3. Member Objects

listeners

Functions that apply to member object:
Function name Function signature
ftp_backup_listeners_get object:listeners ftp_backup_listeners_get (object:ftp_backup ftp_backup, object:session s)
This function returns a list of ftp backup listeners