Skip to content

Question: How to set forwarding address via API for a specific mailbox? #6902

@hanwei2015

Description

@hanwei2015

Summary

Hello, and thank you for your great work on mailcow.

I am currently integrating mailbox creation and management using the mailcow API. Creating mailboxes works well, but I could not find clear documentation on how to set or update a forwarding address for a specific mailbox via API.

The online API documentation mentions mailbox endpoints, but the parameters related to forwarding (e.g., forwarding target, keep local copy, etc.) are either missing or not described in detail. I would like to confirm:

Which API endpoint should be used to enable/disable forwarding for a mailbox?

Which fields are required to set the forwarding destination address?

Is there an example JSON payload you could provide for this case?

If forwarding configuration is currently not available through the documented API, is there an alternative recommended approach?

Thank you in advance for your help!

Motivation

Adding clear API support and documentation for forwarding settings would benefit all users who use mailcow in automated deployments, centralized user management systems, or custom control panels.

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions