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

Note

This module is part of the community.general collection (version 8.6.7).

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

Aliases: cloud.webfaction.webfaction_mailbox

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"

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: none

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

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 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}}

Status

  • This module will be removed in version 9.0.0. [deprecated]

  • For more information see DEPRECATED.

Authors

  • Quentin Stafford-Fraser (@quentinsf)