Skip to content

Commit

Permalink
Forwarding corrections (#20)
Browse files Browse the repository at this point in the history
* Fix WebSocket capitalization

* Add information about private address can exist in private domains

* Add link to WebSocket test page
  • Loading branch information
mjmayer committed Jun 17, 2020
1 parent 747507c commit 06c05b0
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions services/forwarding/forwarding.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,16 @@ Email Forwarding
================

Forwarding allows email to be sent to a different email address or
service (Webhook, Websocket, Slack Webhook). Private addresses and custom
service (Webhook, WebSocket, Slack Webhook). Private addresses and custom
domains can be configured for email forwarding. Forwarding is not available on
disposable email addresss.

Forward to Another Mailsac Address
----------------------------------

Any private address can be forwarded to another private address.
This allows you to consolidate many email addresses into a single inbox.
Any private address, in the *@mailsac.com* domain or private domain can be
forwarded to another private address. This allows you to consolidate many email
addresses into a single inbox.

Forwarding to another private address can be configured by selecting
`Manage Email Addresses`_ from the Dashboard_. Select the *Settings* button
Expand All @@ -36,7 +37,7 @@ Catch-All Domain Forwarding Addresses

A :ref:`Catch-All email address <doc_catchall>` 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
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
Expand Down Expand Up @@ -70,21 +71,22 @@ 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*.

Websocket Forwarding
WebSocket Forwarding
--------------------

Private addresses and Catch-All addresses can have their mail forwarded to a
websocket. A websocket uses a single persistent connection to notify a websocket
client as soon as a message arrives.
WebSocket. A WebSocket uses a single persistent connection to notify a WebSocket
client as soon as a message arrives. The `WebSocket Test Page
<https://sock.mailsac.com>`_ demonstrates a WebSocket.

Forwarding to a Websocket can be configured by selecting
Forwarding to a WebSocket can be configured by selecting
`Manage Email Addresses`_ from the Dashboard_. Select the *Settings* button next
to the email address to manage, then check the box labeled *Enable forwarding
all incoming email via web socket*, and select *Save Settings*.

A code example for a websocket is available :ref:`available
A code example for a WebSocket is available :ref:`available
<doc_websocket_example_overview>`.

Additional information about the websocket endpoint, authentication and example
Additional information about the WebSocket endpoint, authentication and example
frame format is show in the `API Documentation
<https://mailsac.com/docs/api/#web-socket-api>`_.

0 comments on commit 06c05b0

Please sign in to comment.