community.general.webfaction_mailbox module – Add or remove mailboxes on Webfaction
Note
This module is part of the community.general collection (version 8.6.8).
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
.
DEPRECATED
- Removed in:
version 9.0.0
- Why:
the endpoints this module relies on do not exist any more and do not resolve to IPs in DNS.
- Alternative:
no known alternative at this point
Synopsis
Add or remove mailboxes on a Webfaction account. Further documentation at https://github.com/quentinsf/ansible-webfaction.
Aliases: cloud.webfaction.webfaction_mailbox
Parameters
Parameter |
Comments |
---|---|
The webfaction account to use |
|
The webfaction password to use |
|
The name of the mailbox |
|
The password for the mailbox |
|
Whether the mailbox should exist Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
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 do not specify
localhost
as your host, you may want to addserial=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}}
Status
This module will be removed in version 9.0.0. [deprecated]
For more information see DEPRECATED.