Skip to content

Commit

Permalink
Remove sending from documentation
Browse files Browse the repository at this point in the history
Sending has been deprecated for some time. This removes any mention of
it from the docs.
  • Loading branch information
mjmayer committed Jul 14, 2023
1 parent c39c361 commit f8306ad
Show file tree
Hide file tree
Showing 14 changed files with 6 additions and 262 deletions.
34 changes: 1 addition & 33 deletions api_examples/getting_started/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
.. _REST API Specification: https://mailsac.com/docs/api
.. _List Inbox Email Messages Endpoint: https://mailsac.com/docs/api#tag/Email-Messages-API/paths/~1addresses~1{email}~1messages/get
.. _Authentication Header: https://mailsac.com/docs/api#section/Auth-Option-1:-HTTP-Header
.. _Send Email Messages Endpoint: https://mailsac.com/docs/api#tag/Email-Messages-API/paths/~1outgoing-messages/post
.. _Get Message Text Endpoint: https://mailsac.com/docs/api#tag/Email-Messages-API/paths/~1text~1{email}~1{messageId}/get


Expand All @@ -14,7 +13,6 @@ This example will show how to do the following using the REST API.

- list emails sent to `user1@mailsac.com`
- read an email sent to `user1@mailsac.com`
- send an email from `user1@mailsac.com`

`user1@mailsac.com` can be replaced with any email address hosted by Mailsac.
If you are familiar with REST APIs the `REST API Specification`_ can be
Expand All @@ -25,8 +23,7 @@ REST API Overview

REST API interaction is at the core of Mailsac. The examples in this section
will provide you with easy to understand curl examples. For additional code
examples (Nodejs and Python) see: :ref:`Reading Email <doc_reading_mail>`
and :ref:`Sending Mail <doc_sending_mail>`.
examples (Nodejs and Python) see: :ref:`Reading Email <doc_reading_mail>`.

Prerequisites
-------------
Expand Down Expand Up @@ -123,32 +120,3 @@ retrieve different parsed representations of the SMTP body.
the header key, lowercased. When there are multiple headers with the same name
, such as :code:`Received` header, the value of the header will be an array of
strings. Otherwise the value will be a string.
Sending Mail
-------------
.. warning:: Sending outbound SMTP email has been deprecated.
To send an email from `user1@mailsac.com` we will use the
:code:`/api/outgoing-messages` `endpoint
<Send Email Messages Endpoint_>`_. This API endpoint uses a
POST method, unlike our previous two examples, and accepts the following
parameters in a JSON body.
* :code:`Mailsac-Key` header with `your API key <https://mailsac.com/api-keys>`_
* :code:`to` address
* :code:`from` address
* :code:`subject` subject
* :code:`text` message text body
The :code:`/api/outgoing-messages` endpoint expects a JSON encoded body,
a :code:`Content-Type: application/json` header, and a `Authentication Header`_.
.. code-block:: bash
:caption: **Send an email**
curl -H "Content-Type: application/json" \
-H "Mailsac-Key: YOUR_API_KEY_HERE" \
-X POST \
--data '{"to": "recipient@mailsac.com.com", "subject": "This is a test", "from": "my_sender@mailsac.com", "text": "This is a test"}' \
https://mailsac.com/api/outgoing-messages
6 changes: 2 additions & 4 deletions help/account_management/credential_management.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@ on the service being consumed.
- `Sub-Account User Login`_: Used to authenticate to Mailsac.com
(available to `Business and Enterprise Plans <Pricing_>`_)
- `API Key <API Keys and Users_>`_: Used to authenticate to the `REST API`_,
:ref:`Email Capture <doc_email_capture>`, :ref:`SMTP <sec_sendingmail_smtp>`,
:ref:`POP3 <sec_reading_mail_pop3>`.
:ref:`Email Capture <doc_email_capture>`, :ref:`POP3 <sec_reading_mail_pop3>`.
- POP3 Password: Used to authenticate to :ref:`POP3 Service <sec_reading_mail_pop3>`

.. _sec_password_change:
Expand All @@ -44,8 +43,7 @@ API Key Management
------------------

API keys are used to authenticate to the `REST API`_,
:ref:`Email Capture <doc_email_capture>`, :ref:`SMTP <sec_sendingmail_smtp>`,
:ref:`POP3 <sec_reading_mail_pop3>`.
:ref:`Email Capture <doc_email_capture>`, :ref:`POP3 <sec_reading_mail_pop3>`.

API Keys can be created , regenerated, and deleted in the `API Keys and Users`_
section of the Dashboard_.
Expand Down
4 changes: 2 additions & 2 deletions help/recent_activity/recent_activity.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
Recent Activity
===============

Recent Activity shows a detailed log of email received,
:ref:`forwarding <doc_forwarding>`, and :ref:`email sent <doc_sending_mail>`.
Recent Activity shows a detailed log of email received and
:ref:`forwarded <doc_forwarding>`.
This is useful in troubleshooting problems integrating with Mailsac.

Viewing Recent Activity
Expand Down
1 change: 0 additions & 1 deletion index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@ Table of Contents
services/webhook/webhook
services/websocket/websocket
services/forwarding/forwarding
services/sending_mail/sending_mail
services/reading_mail/reading_mail
services/mailredirect
services/slack_webhook/slack_webhook
Expand Down
9 changes: 0 additions & 9 deletions services/attachments.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,3 @@ There are several ways to download attachments when authenticated to the Mailsac

Additional information on reading mail, including code examples, can be found
in :ref:`Reading Email <doc_reading_mail>`.

Sending Attachments
--------------------

Attachments on outgoing messages are only supported
`through the API <https://mailsac.com/docs/api#tag/Email-Messages-API/paths/~1outgoing-messages/post>`_.

Additional information on sending mail, including code examples, can be found
in :ref:`Sending Email <doc_sending_mail>`.
5 changes: 1 addition & 4 deletions services/reading_mail/reading_mail.rst
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ password. The per private address SMTP password can be set through using the
Dashboard_ -> *Manage Email Addresses* -> Select the
*POP/SMTP* button next to the email address -> Select *Set New Password*

.. figure:: ../sending_mail/pop_smtp_set_password.png
.. figure:: pop_smtp_set_password.png
:align: center
:width: 400px

Expand All @@ -138,9 +138,6 @@ etc) using these POP3 settings:
| **Auth Settings** | Password / allow plain / insecure |
+-----------------------+-------------------------------------------------------+

To configure a mail client for sending see the :ref:`Sending Mail via SMTP
Section <sec_sendingmail_smtp>`.

.. _sec_reading_mail_attachments:

Viewing Email Attachments
Expand Down
Binary file removed services/sending_mail/pop_smtp_settings_button.png
Binary file not shown.
25 changes: 0 additions & 25 deletions services/sending_mail/sending_mail.js

This file was deleted.

18 changes: 0 additions & 18 deletions services/sending_mail/sending_mail.py

This file was deleted.

154 changes: 0 additions & 154 deletions services/sending_mail/sending_mail.rst

This file was deleted.

12 changes: 0 additions & 12 deletions services/sending_mail/sending_mail.sh

This file was deleted.

Binary file not shown.
Binary file removed services/sending_mail/webform.png
Binary file not shown.

0 comments on commit f8306ad

Please sign in to comment.