Skip to content

Commit

Permalink
Merge pull request #38 from mailsac/update_catch_all
Browse files Browse the repository at this point in the history
Add examples and detailed instructions to catch-all
  • Loading branch information
mjmayer committed Aug 19, 2020
2 parents 222bdb0 + eff5b22 commit c86d303
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 11 deletions.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added services/forwarding/enable_catch_all.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
64 changes: 53 additions & 11 deletions services/forwarding/forwarding.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,56 @@ service (Webhook, WebSocket, Slack Webhook). Private addresses and custom
domains can be configured for email forwarding. Forwarding is not available on
disposable email addresss.

Catch-All Domain Forwarding Addresses
-------------------------------------

A Catch-All email address can receive all the mail for
a custom domain, and optionally forward it to another address or service (
Webhook, WebSocket, or Slack Webhook). A Catch-All address is a private address
in the format `*@example.com`.

A Catch-All email address can be configured by selecting `Manage Domains`_ from
the Dashboard_, then choosing *Manage* next to the domain, and then selecting
the *Forwarding* tab.

.. figure:: enable_catch_all.png
:align: center
:width: 400px

Enable Catch-All address on custom domain.

Configure Forwarding on a Catch-All Address
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Catch-All addresses can be forwarded to:

- :ref:`Another Private Mailsac Address <sec_forward_to_another_mailsac_address>`
- :ref:`Slack <sec_forward_to_slack>`
- :ref:`Webhook <sec_webhook_forwarding>`
- :ref:`WebSocket <sec_websocket_forwarding>`

From the Dashboard_, select `Manage Email Addresses`, then select settings
icon next to the Catch-All address.

.. figure:: catch-all_forwarding_settings.png
:align: center
:width: 400px

Configure Forwarding on a Catch-All Address

Catch-All Example Use Case
^^^^^^^^^^^^^^^^^^^^^^^^^^

Traditionally individual mailboxes or distribution lists needed to be configured
for each address in a domain. If a small business wanted to add a new address,
sales@widgets.com, they would need to configure that mailbox. With a Catch-All
address they can instruct customers to start sending to sales@widgets.com and
all the messages sent to sales@widgets.com will be forwarded to the Catch-All
(\*@widgets.com).

Catch-All forwarding makes adding a new email address as simple as sending to
it.

.. _sec_forward_to_another_mailsac_address:

Forward to Another Mailsac Address
Expand All @@ -35,17 +85,7 @@ main@mailsac.com, you could setup the following scheme:
* 3@mailsac.com forwards to main@mailsac.com
* main@mailsac.com is checked by POP3 in GMail

Catch-All Domain Forwarding Addresses
-------------------------------------

A Catch-All email address can receive all the mail for
a custom domain, and optionally forward it to another address or service (
Webhook, WebSocket, or Slack Webhook). A Catch-All address is a private address
in the format `*@example.com`.

A Catch-All email address can be configured by selecting `Manage Domains`_ from
the Dashboard_, then choosing *Manage* next to the domain, and then selecting
the *Forwarding* tab.
.. _sec_forward_to_slack:

Forward to Slack
----------------
Expand Down Expand Up @@ -76,6 +116,8 @@ from the Dashboard_. Select the *Settings* button next to the email address to
manage, then input the URL under *Forward To Custom Webhook* and select *Save
Settings*.

.. _sec_websocket_forwarding:

WebSocket Forwarding
--------------------

Expand Down

0 comments on commit c86d303

Please sign in to comment.