You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.general.webfaction_mailbox – Add or remove mailboxes on Webfaction

Note

This plugin is part of the community.general collection (version 3.8.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.webfaction_mailbox.

Synopsis

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

Parameters

Parameter	Comments
login_name string / required	The webfaction account to use
login_password string / required	The webfaction password to use
mailbox_name string / required	The name of the mailbox
mailbox_password string / required	The password for the mailbox
state string	Whether the mailbox should exist Choices: present ← (default) absent

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.

• See the webfaction API for more info.

Examples

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

Authors

• Quentin Stafford-Fraser (@quentinsf)