Package webf :: Module webflib :: Class WebFactionXmlRpc
[hide private]
[frames] | no frames]

Class WebFactionXmlRpc

source code

object --+
         |
        WebFactionXmlRpc

WebFaction XML-RPC server proxy class

Instance Methods [hide private]
 
__init__(self, login=True)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
 
get_config(self)
Get configuration file from user's directory
source code
 
login(self)
Login to WebFaction and get a session_id
source code
 
create_app(self, app_name, app_type, autostart, extra_info)
Create new application
source code
 
delete_app(self, app_name)
Create new application
source code
 
delete_db(self, name, db_type)
Delete database
source code
None on success or 1 on failure
create_db(self, name, db_type, password)
Create database
source code
None on success or 1 on failure
create_cronjob(self, line)
Create a cronjob
source code
None on success or 1 on failure
delete_cronjob(self, line)
Delete a cronjob
source code
None on success or 1 on failure
create_website(self, website_name, ip, https, subdomains, site_apps)
Create a website
source code
None on success or 1 on failure
create_email(self, email_address, targets, autoresponder_on=False, autoresponder_subject='', autoresponder_message='', autoresponder_from='')
Create an email address for a mailbox
source code
None on success or 1 on failure
delete_email(self, email_address)
Delete an email address
source code
None on success or 1 on failure
create_mailbox(self, mailbox, enable_spam_protection=True, share=False, spam_to_learn_folder='spam_to_learn', ham_to_learn_folder='ham_to_learn')
Delete a mailbox
source code
None on success or 1 on failure
delete_mailbox(self, mailbox)
Delete a mailbox
source code
None on success or 1 on failure
set_apache_acl(self, paths, permission='rwx', recursive=False)
Set Apache ACL
source code
None on success or 1 on failure
system(self, cmd)
Runs a Linux command in your homedir and prints the result
source code

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, login=True)
(Constructor)

source code 

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__
(inherited documentation)

delete_db(self, name, db_type)

source code 

Delete database

Parameters:
  • name (string) - name of database
  • db_type (string) - mysql or postgres

create_db(self, name, db_type, password)

source code 

Create database

Parameters:
  • name (string) - name of database
  • db_type (string) - mysql or postgres
  • password (string) - password
Returns: None on success or 1 on failure
Nothing

create_cronjob(self, line)

source code 

Create a cronjob

Parameters:
  • line (string) - A line you want in your cronjob
Returns: None on success or 1 on failure
Nothing

delete_cronjob(self, line)

source code 

Delete a cronjob

Parameters:
  • line (string) - A line you want removed from your cronjob
Returns: None on success or 1 on failure
Nothing

create_website(self, website_name, ip, https, subdomains, site_apps)

source code 

Create a website

Parameters:
  • website_name (string) - Name of website
  • ip (string) - IP Address
  • https (boolean) - Use https protocol
  • subdomains (list) - List of subdomains for this website
  • site_apps (list)
Returns: None on success or 1 on failure
Nothing

create_email(self, email_address, targets, autoresponder_on=False, autoresponder_subject='', autoresponder_message='', autoresponder_from='')

source code 

Create an email address for a mailbox

Parameters:
  • email_address (string)
  • targets (string) - mailbox names
Returns: None on success or 1 on failure
Success code

delete_email(self, email_address)

source code 

Delete an email address

Parameters:
  • email_address (string) - An email address you want removed from a mailbox
Returns: None on success or 1 on failure
Success code

create_mailbox(self, mailbox, enable_spam_protection=True, share=False, spam_to_learn_folder='spam_to_learn', ham_to_learn_folder='ham_to_learn')

source code 

Delete a mailbox

Parameters:
  • mailbox (string) - Mailbox name you want to create
  • enable_spam_protection (boolean) - Use WebFaction's spam filtering
  • share (boolean) - Unknown
Returns: None on success or 1 on failure
Success code

delete_mailbox(self, mailbox)

source code 

Delete a mailbox

Parameters:
  • mailbox (string) - A mailbox name you wanted deleted
Returns: None on success or 1 on failure
Success code

set_apache_acl(self, paths, permission='rwx', recursive=False)

source code 

Set Apache ACL

Parameters:
  • paths (string)
  • permission (string) - Unix file permissions
  • recursive (boolean) - Recurse sub-directories
Returns: None on success or 1 on failure
Success code

system(self, cmd)

source code 

Runs a Linux command in your homedir and prints the result

Parameters:
  • cmd (string) - Command you want to run
Returns: None on success or 1 on failure
Success code