Skip to content

Commit

Permalink
rest api language
Browse files Browse the repository at this point in the history
  • Loading branch information
@ruffrey
ruffrey committed Jun 17, 2020
1 parent 06c05b0 commit f635e06
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions about/introduction.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,18 @@
Introduction
============

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

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

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

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

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

This comment has been minimized.

Sign in to view

Copy link
@mjmayer

mjmayer Jun 29, 2020

Contributor

@ruffrey "from a fake inbox at" The inbox that is being checked is real. I'm not a fan of the word "fake".

Could I change the wording to "In this example we are checking mail send to the email address user1@mailsac.com"?

This comment has been minimized.

Sign in to view

Copy link
@ruffrey

ruffrey Jun 29, 2020

Author Member

In general I am not a fan of the word either. However, I have been doing research, and "fake smtp server" is something that is often used to describe precisely what we do. I would push that we include this keyword in a few places, if not here.

This comment has been minimized.

Sign in to view

Copy link
@ruffrey

ruffrey Jun 29, 2020

Author Member

If we don't use the keyword somewhere, we miss out on google fu. It's just playing the game. Perhaps we can remove it from here, and add it on other pages, or have specific pages where we use that language.

image

This comment has been minimized.

Sign in to view

Copy link
@mjmayer

mjmayer Jun 29, 2020

Contributor

I'm inclined to include it elsewhere in describing our service. It just felt out of place in an example. As I work through other pages I'll try to work in some the "fake smtp" server language in.

.. literalinclude:: intro_curl.bash
:language: bash
Expand Down

0 comments on commit f635e06

Please sign in to comment.