Skip to content

Commit

Permalink
Remove rest from rest api (#21)
Browse files Browse the repository at this point in the history
* Remove REST from REST API

* Remove broken link
  • Loading branch information
mjmayer committed Jun 17, 2020
1 parent 47f2b81 commit 8bdfc8b
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 13 deletions.
11 changes: 5 additions & 6 deletions about/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,15 @@
Introduction
============

With Mailsac, it is easy to interact with email via REST API, webhooks and websockets. You can
With Mailsac, it's super easy to interact with email via API, Webhooks and WebSockets. You can
reserve and release email addresses, check messages, download attachments, and route mail.

.. tip:: All REST API endpoints can be found in the `API Specification <https://mailsac.com/docs/api/>`_
.. tip:: All API endpoints can be found in the `API Specification <https://mailsac.com/docs/api/>`_

--------------------------------------------

------------
cURL REST API Example
------------
cURL API Example
----------------

You can use cURL to fetch emails from a fake inbox at user1@mailsac.com

Expand All @@ -27,5 +26,5 @@ Information about the most recent email is returned as JSON
:emphasize-lines: 1
:lines: 2-
.. tip:: This may look for more information than you need. But it provides
a great example of all the hard work mailsac has done to make parsing
a great example of all the hard work Mailsac has done to make parsing
of email easier.
2 changes: 1 addition & 1 deletion getting_started/checkmail.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Check Mail
Now that curl and jq are installed, we can start interacting with Mailsac API. The
`Mailsac API Specification <https://mailsac.com/docs/api/>`_ includes all supported
endpoints. The API Specification reference is great starting place, if you a familiar with
REST APIs, or for reference after completing this step-by-step introduction.
APIs, or for reference after completing this step-by-step introduction.

In this example, we are going to check an arbitrary email address
for mail, read that email and respond to the email.
Expand Down
2 changes: 1 addition & 1 deletion services/forwarding/forwarding.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ main@mailsac.com, you could setup the following scheme:
Catch-All Domain Forwarding Addresses
-------------------------------------

A :ref:`Catch-All email address <doc_catchall>` can receive all the mail for
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`.
Expand Down
10 changes: 5 additions & 5 deletions services/sending_mail/sendingmail.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Mail can be sent via the following methods:

- `Web Form`_
- `Unified Inbox`_
- `REST API <https://mailsac.com/docs/api/#send-email-messages>`_
- `API <https://mailsac.com/docs/api/#send-email-messages>`_
- :ref:`SMTP <doc_sendingmail_smtp>`

Sending mail, both replies and new messages, is available only from private
Expand Down Expand Up @@ -64,10 +64,10 @@ like you would with gmail or yahoo mail.

4. Click *Send* to send the message.

Sending from the REST API
-------------------------
Sending from the API
--------------------

The REST API is the preferred method for sending messages programmattically.
The API is the preferred method for sending messages programmattically.
The :code:`/api-outgoing-messages` endpoint is documented in the
`API documentation <https://mailsac.com/api/#send-email-messages>`_.

Expand Down Expand Up @@ -187,4 +187,4 @@ sending credits.
| **Auth Settings** | Password / allow plain / insecure |
+-----------------------+-------------------------------------------------------------------------------------------+
| **Encryption** | TLS |
+-----------------------+-------------------------------------------------------------------------------------------+
+-----------------------+-------------------------------------------------------------------------------------------+

0 comments on commit 8bdfc8b

Please sign in to comment.