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

Note

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

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

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

Synopsis
Parameters
Notes
Examples

Synopsis

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

Parameters

Parameter	Choices/Defaults	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	present ← absent	Whether the mailbox should exist

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)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/webfaction_mailbox_module.html