21. maillist
FieldsMethodsMember Objects1. Fields
name
| Function name |
Function signature |
| maillist_name_set |
int maillist_name_set (object:maillist obj, string value) |
|
This function sets the name of the maillist, returns 0 on succes, -1 on failure
|
| maillist_name_get |
string maillist_name_get (object:maillist obj) |
|
This function returns the name fo the maillist
|
request_needs_confirmation
| Function name |
Function signature |
| maillist_request_needs_confirmation_get |
string maillist_request_needs_confirmation_get (object:maillist obj) |
|
This function returns the rfc2822 like template that will tell the user to wait for admins confirmation
|
| maillist_request_needs_confirmation_set |
int maillist_request_needs_confirmation_set (object:maillist obj, string value) |
|
This function sets the rfc2822 like template that will tell the user to wait for admins confirmation. Returns 0 on succes, -1 on failure
|
add_header
| Function name |
Function signature |
| maillist_add_header_get |
string maillist_add_header_get (object:maillist obj) |
|
This function returns the rfc2822 like headers that will be added to the mail's headers that will be published
|
| maillist_add_header_set |
int maillist_add_header_set (object:maillist obj, string value) |
|
This function sets the sets like headers that will be added to the mail's headers that will be published. Returns 0 on succes, -1 on failure
|
body_end
| Function name |
Function signature |
| maillist_body_end_set |
int maillist_body_end_set (object:maillist obj, string value) |
|
This function returns the text that will be added to the body to the mail that will be published. Returns 0 on succes, -1 on failure
|
| maillist_body_end_get |
string maillist_body_end_get (object:maillist obj) |
|
This function returns the text that will be added to the body to the mail that will be published
|
body_begin
| Function name |
Function signature |
| maillist_body_begin_set |
int maillist_body_begin_set (object:maillist obj, string value) |
|
This function returns the text that will be inserted before the body to the mail that will be published. Returns 0 on succes, -1 on failure
|
| maillist_body_begin_get |
string maillist_body_begin_get (object:maillist obj) |
|
This function returns the text that will be inserted before the body to the mail that will be published
|
request_needs_admin_confirmation
| Function name |
Function signature |
| maillist_request_needs_admin_confirmation_get |
string maillist_request_needs_admin_confirmation_get (object:maillist obj) |
|
This function returns the rfc2822 like template that will tell the user to wait for admins confirmation
|
| maillist_request_needs_admin_confirmation_set |
int maillist_request_needs_admin_confirmation_set (object:maillist obj, string value) |
|
This function sets the rfc2822 like template that will tell the user to wait for admins confirmation. Returns 0 on succes, -1 on failure
|
invalid_user_name
| Function name |
Function signature |
| maillist_invalid_user_name_get |
string maillist_invalid_user_name_get (object:maillist obj) |
|
This function returns the description of the error that the filter will return in case the user name is invalid, null for example
|
| maillist_invalid_user_name_set |
int maillist_invalid_user_name_set (object:maillist obj, string value) |
|
This function sets the description of the error that the filter will return in case the user name is invalid, null for example. Returns 0 on succes, -1 on failure
|
invalid_format
| Function name |
Function signature |
| maillist_invalid_format_set |
int maillist_invalid_format_set (object:maillist obj, string value) |
|
This function sets the description of the error that the filter will return in case the user has sent a mail message with wrong format. Returns 0 on succes, -1 on failure
|
| maillist_invalid_format_get |
string maillist_invalid_format_get (object:maillist obj) |
|
This function returns the description of the error that the filter will return in case the user has sent a mail message with wrong format
|
welcome
| Function name |
Function signature |
| maillist_welcome_set |
int maillist_welcome_set (object:maillist obj, string value) |
|
This function sets the rfc2822 like template that will tell the user that he has been created. Returns 0 on succes, -1 on failure
|
| maillist_welcome_get |
string maillist_welcome_get (object:maillist obj) |
|
This function returns the rfc2822 like template that will tell the user that he has been created
|
sender_allow
| Function name |
Function signature |
| maillist_sender_allow_set |
int maillist_sender_allow_set (object:maillist obj, string value) |
|
This function sets who has access to sending mails on this list. Parameter 'value' should be: anyone, users, admin. returns 0 on succes, -1 on failure
|
| maillist_sender_allow_get |
string maillist_sender_allow_get (object:maillist obj) |
|
This function returns who has access to sending mails on this list. Returns are: anyone, users, admin
|
enabled_rcpts
| Function name |
Function signature |
| maillist_enabled_rcpts_set |
int maillist_enabled_rcpts_set (object:maillist obj, string value) |
|
This function sets which maillist recipient are enabled, between subscribe, unsubscribe and request recipients. A valid value should be enclosed between brackets, like this: (request subscribe unsubscribe)
|
| maillist_enabled_rcpts_get |
string maillist_enabled_rcpts_get (object:maillist obj) |
|
This function returns which maillist recipient are enabled, between subscribe, unsubscribe and request recipients
|
bad_confirmation
| Function name |
Function signature |
| maillist_bad_confirmation_get |
string maillist_bad_confirmation_get (object:maillist obj) |
|
This function returns the description of the error that the filter will return in case the confirmation is not good
|
| maillist_bad_confirmation_set |
int maillist_bad_confirmation_set (object:maillist obj, string value) |
|
This function sets the description of the error that the filter will return in case the confirmation is not good. Returns 0 on succes, -1 on failure
|
unknown_command
| Function name |
Function signature |
| maillist_unknown_command_get |
string maillist_unknown_command_get (object:maillist obj) |
|
This function returns the description of the error that the filter will return in case the request will not have a known command
|
| maillist_unknown_command_set |
int maillist_unknown_command_set (object:maillist obj, string value) |
|
This function returns the description of the error that the filter will return in case the request will not have a known command. Returns 0 on succes, -1 on failure
|
subscribe_denied
| Function name |
Function signature |
| maillist_subscribe_denied_set |
int maillist_subscribe_denied_set (object:maillist obj, string value) |
|
This function sets the rfc2822 like template that will tell the user that he has not been created. Returns 0 on succes, -1 on failure
|
| maillist_subscribe_denied_get |
string maillist_subscribe_denied_get (object:maillist obj) |
|
This function returns the rfc2822 like template that will tell the user that he has not been created
|
admin_email
| Function name |
Function signature |
| maillist_admin_email_get |
string maillist_admin_email_get (object:maillist obj) |
|
This function returns the maillist's admin email
|
| maillist_admin_email_set |
int maillist_admin_email_set (object:maillist obj, string value) |
|
This function sets the maillist's admin email. Returns 0 on succes, -1 on failure
|
description
| Function name |
Function signature |
| maillist_description_set |
int maillist_description_set (object:maillist obj, string value) |
|
This function sets the maillist description, returns 0 on succes, -1 on failure
|
| maillist_description_get |
string maillist_description_get (object:maillist obj) |
|
This function returns the maillist description
|
auto_reject_response
| Function name |
Function signature |
| maillist_auto_reject_response_set |
int maillist_auto_reject_response_set (object:maillist obj, string value) |
|
This function sets the rfc2822 like template that will tell the user that his mail is rejected. Returns 0 on succes, -1 on failure. Returns 0 on succes, -1 on failure
|
| maillist_auto_reject_response_get |
string maillist_auto_reject_response_get (object:maillist obj) |
|
This function returns the rfc2822 like template that will tell the user that his mail is rejected
|
moderate
| Function name |
Function signature |
| maillist_moderate_set |
int maillist_moderate_set (object:maillist obj, string value) |
|
This function sets which type of users require moderation. Parameter 'value' should be: "all", "guests" or "none". Returns 0 on succes, -1 on failure
|
| maillist_moderate_get |
string maillist_moderate_get (object:maillist obj) |
|
This function returns which type of users require moderation. Returns are: all, guests, none
|
unsubscribe_rcpt
| Function name |
Function signature |
| maillist_unsubscribe_rcpt_set |
int maillist_unsubscribe_rcpt_set (object:maillist obj, string value) |
|
This function sets the unsubscribe recipient for this mail list, returns 0 on succes, -1 on failure
|
| maillist_unsubscribe_rcpt_get |
string maillist_unsubscribe_rcpt_get (object:maillist obj) |
|
This function gets the unsubscribe recipient for this mail list
|
ctype_allow
| Function name |
Function signature |
| maillist_ctype_allow_get |
string maillist_ctype_allow_get (object:maillist obj) |
|
This function returns the type of content type allowed on maillist emails. Returns are: plain, text, garbage
|
| maillist_ctype_allow_set |
int maillist_ctype_allow_set (object:maillist obj, string value) |
|
This function sets the type of content type allowed on maillist emails. Parameter 'value' should be: "plain", "text" or "garbage". Returns 0 on succes, -1 on failure
|
admin_confirm
| Function name |
Function signature |
| maillist_admin_confirm_set |
int maillist_admin_confirm_set (object:maillist obj, int value) |
|
If the value parameter is 1, this function tells the the confirmation of requests should go to the list's admin, and 0 otherwise
|
| maillist_admin_confirm_get |
int maillist_admin_confirm_get (object:maillist obj) |
|
This function returns 1 if the confirmation of requests should go to the list's admin, and 0 otherwise
|
request_rcpt
| Function name |
Function signature |
| maillist_request_rcpt_set |
int maillist_request_rcpt_set (object:maillist obj, string value) |
|
This function sets the request recipient for this mail list, returns 0 on succes, -1 on failure
|
| maillist_request_rcpt_get |
string maillist_request_rcpt_get (object:maillist obj) |
|
This funtion gets the request recipient for this mail list
|
password
| Function name |
Function signature |
| maillist_password_get |
string maillist_password_get (object:maillist obj) |
|
This function is useless, it returns a string like this "******". The actual password cannot be retrieved.
|
| maillist_password_set |
int maillist_password_set (object:maillist obj, string value) |
|
This function sets the password of the admin's maillist, returns 0 on succes, -1 on failure , returns 0 on succes, -1 on failure
|
user_already_subscribed
| Function name |
Function signature |
| maillist_user_already_subscribed_set |
int maillist_user_already_subscribed_set (object:maillist obj, string value) |
|
This function sets the description of the error that the filter will return in case the user already exists on this list. Returns 0 on succes, -1 on failure
|
| maillist_user_already_subscribed_get |
string maillist_user_already_subscribed_get (object:maillist obj) |
|
This function returns the description of the error that the filter will return in case the user already exists on this list.
|
not_a_user
| Function name |
Function signature |
| maillist_not_a_user_get |
string maillist_not_a_user_get (object:maillist obj) |
|
This function returns the description of the error that the filter will return in case the sender is not a user of the list and it should be.
|
| maillist_not_a_user_set |
int maillist_not_a_user_set (object:maillist obj, string value) |
|
This function returns the description of the error that the filter will return in case the sender is not a user of the list and it should be.. Returns 0 on succes, -1 on failure
|
goodbye
| Function name |
Function signature |
| maillist_goodbye_get |
string maillist_goodbye_get (object:maillist obj) |
|
This function returns the rfc2822 like template that will tell the user that he has been deleted
|
| maillist_goodbye_set |
int maillist_goodbye_set (object:maillist obj, string value) |
|
This function sets the rfc2822 like template that will tell the user that he has been deleted. Returns 0 on succes, -1 on failure
|
subscribe_rcpt
| Function name |
Function signature |
| maillist_subscribe_rcpt_get |
string maillist_subscribe_rcpt_get (object:maillist obj) |
|
This function gets the subscribe recipient for this mail list
|
| maillist_subscribe_rcpt_set |
int maillist_subscribe_rcpt_set (object:maillist obj, string value) |
|
This function sets the subscribe recipient for this mail list, returns 0 on succes, -1 on failure
|
2. Methods
| Function name |
Function signature |
| maillist_load |
object:maillist maillist_load (object:session session, object:context_list context) |
| maillist_save |
int maillist_save (object:maillist data, object:session session) |
|
This function saves the maillist configuration back to Axigen.
|
3. Member Objects
limits
Functions that apply to member object:
| Function name |
Function signature |
| maillist_limits_get |
object:limits maillist_limits_get (object:maillist maillist, object:session s) |
|
This function returns a limits object. This object can be used for setting various limit parameters for the maillist
|
quotas
Functions that apply to member object:
| Function name |
Function signature |
| maillist_quotas_get |
object:quotas maillist_quotas_get (object:maillist maillist, object:session s) |
|
This function returns a quotas object. This object can be used for setting storage restrictions on the maillist
|
filters
Functions that apply to member object:
| Function name |
Function signature |
| maillist_filters_get |
object:filters maillist_filters_get (object:maillist maillist, object:session s) |
|
This function returns a filter object. This object is used for applying various filters on the maillist's incoming emails
|
services
Functions that apply to member object:
| Function name |
Function signature |
| maillist_services_get |
object:services maillist_services_get (object:maillist obj) |
|
This function returns a services object. This object can be used to check/enable services
|
registry_information
Functions that apply to member object:
| Function name |
Function signature |
| maillist_registry_information_get |
object:registry_information maillist_registry_information_get (object:maillist maillist, object:session s) |
|
This function returns a registry_information object. This object can be used at retrieving various information about the maillist's login (imap, pop3, webmail)
|
webmaildata
Functions that apply to member object:
| Function name |
Function signature |
| maillist_webmaildata_get |
object:webmaildata maillist_webmaildata_get (object:maillist maillist, object:session s) |
|
This function returns a webmaildata object. This can be used at configuring various webmail options for the maillist's admin
|
|
