mittwald API icon

mittwald API

Interact with the mittwald API

Actions125

Mail → Create Mail Address

AI-generated

Summary

Create a new mail address (mailbox) within a selected project, configuring its address, password, quota, forwarding targets, spam protection, catch-all status, and auto-responder settings.

Inputs

  • Project (required) — Select the target project either from a searchable list or by entering its UUID or short ID.
  • Address (required) — Specify the full email address to create (e.g., info@example.com).
  • Password — Set the mailbox password for authentication. Leave empty to skip setting a password.
  • Quota in Bytes — Define the mailbox storage quota in bytes; set to 0 to apply the project's default quota.
  • Forward Addresses — Provide an optional comma- or newline-separated list of email addresses to which incoming mail should be forwarded.
  • Catch-All — Enable to make this address receive mail sent to all unknown local parts on its domain.
  • Enable Spam Protection — Toggle whether spam protection is active for this mail address, enabled by default.
  • Auto Responder Active — Enable to activate auto-responder functionality for this mail address.
  • Auto Responder Message — Set the message body that will be sent as an automatic reply when the auto-responder is active.

Output shape

a single record

Returns a single object with the details of the newly created mail address, including configured properties. No pagination or additional envelopes.

Examples

Example 1: Create a new mailbox in a specific project with forwarding to multiple addresses and auto-responder enabled.

Set Project by ID, specify Address and Password, enter Forward Addresses as a comma-separated list, enable Auto Responder Active, and provide Auto Responder Message.

Links

Discussion