W3cubDocs

/Ansible

webfaction_mailbox - Add or remove mailboxes on Webfaction

New in version 2.0.

Synopsis

Add or remove mailboxes on a Webfaction account. Further documentation at http://github.com/quentinsf/ansible-webfaction.

Options

parameter required default choices comments
login_name
yes
The webfaction account to use
login_password
yes
The webfaction password to use
mailbox_name
yes
The name of the mailbox
mailbox_password
yes
The password for the mailbox
state
no present
  • present
  • absent
Whether the mailbox should exist

Examples

- name: Create a mailbox
  webfaction_mailbox:
    mailbox_name="mybox"
    mailbox_password="myboxpw"
    state=present
    login_name={{webfaction_user}}
    login_password={{webfaction_passwd}}

Notes

Note

You can run playbooks that use this on a local machine, or on a Webfaction host, or elsewhere, since the scripts use the remote webfaction API - the location is not important. However, running them on multiple hosts simultaneously is best avoided. If you don’t specify localhost as your host, you may want to add serial: 1 to the plays.

Note

See the webfaction API for more info.

This is an Extras Module

For more information on what this means please read Extras Modules

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, developing_test_pr and Developing Modules.

© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/webfaction_mailbox_module.html