Merge pull request #13 from mailsac/update_readme_local_build

Update readme local build
mailsac · Apr 13, 2020 · 4929183 · 4929183
2 parents 810bcf1 + d9026b7
commit 4929183
Show file tree

Hide file tree

Showing 6 changed files with 102 additions and 84 deletions.
diff --git a/README.md b/README.md
@@ -25,5 +25,7 @@ for testing purposes.
     `npm install http-server -g`
     `http-server _build/html`
 
+7. Alternatively the reStructuredText Visual Studio Code extension can be used for live previews
+
 Copyright © 2019 by Forking Software LLC
 
diff --git a/services/catchall.rst b/services/catchall.rst
@@ -24,4 +24,4 @@ subdomain (mail.yourdomain.com).
 4. Make sure Catch-All is Enabled.
 5. You will now be able to setup a forwarding address (click Forwarding button next to the email address), or just check mail at
    the \* inbox, like \*@yourdomain.com
-5. You could also use `POP3 to pull the emails into GMail, Apple Mail, Thunderbird, or any other email client that supports POP3 <https://mailsac.com/docs/fetch-messages-with-pop3>`_.
+6. You could also use `POP3 to pull the emails into GMail, Apple Mail, Thunderbird, or any other email client that supports POP3 <https://mailsac.com/docs/fetch-messages-with-pop3>`_.
diff --git a/services/introduction.rst b/services/introduction.rst
@@ -7,7 +7,7 @@ To get the most out of Mailsac, an account and API key are required. Getting a p
 entitle you to support. Once you are signed up with Mailsac you can start exploring
 the services provided:
 
-* :ref:`Message  Storage <mailstorage>`
+* :ref:`Message  Storage <doc_mailstorage>`
 * :ref:`Email Attachments <doc_attachments>`
 * :ref:`Email Hosting <doc_emailhosting>`
 * :ref:`Catch-All <doc_catchall>`

diff --git a/services/mailstorage.rst b/services/mailstorage.rst
@@ -1,46 +1,54 @@
-.. _mailstorage:
+.. _doc_mailstorage:
 .. role:: red
 
+===============
 Message Storage
 ===============
 
-When you have an account and make an email address private, message storage kicks in.
-
-Message storage comes into play in two ways. It governs:
+All `plans <https://mailsac.com/pricing>`_ include message storage. The amount
+of message storage is how many messages can be stored before mail before
+messages are recycled.
 
-* The number of messages allowed across your owned email addresses
-* The number of starred messages
+Messages that are sent to a :ref:`private domain <doc_privatedomains>`, private 
+address, or `starred messages`_ count towards message storage.
 
 When are Messages Recycled?
 ---------------------------
 
-The **oldest, unstarred** messages are removed.
+Messages sent to non-private addresses and domains will be recycled at times
+to ensure capacity for new messages.
 
-Example
-~~~~~~~
+Messages sent to :ref:`private domains <doc_privatedomains>`, private addresses,
+and `starred messages`_ associated with Mailsac are recycled once the storage 
+limit is reached.
 
-If your storage limit is 100 messages, and you star 25 messages, and you own 3 email addresses,
-you’ll be allowed 75 messages across those 3 email addresses.
+Examples
+--------
+
+1. If your storage limit is 100 messages and you have starred 125 messages, the
+   oldest 25 messages will be recycled.
+2. If your storage limit is 100 messages and you have 75 messages in your
+   private domain. No messages will be recycled.
+3. If your storage limit is 100 messages and you have 150 messages in your
+   private domain, the oldest 50 messages will be recycled.
+4. If your storage limit is 100 messages and you have 50 messages in 3
+   private inboxes (total 150 messages), the oldest 50 messages will be
+   recycled.
 
-Once you have 100 messages across all your starred and private email addresses, the oldest unstarred
-ones will be removed.
 
 Getting More Storage
-~~~~~~~~~~~~~~~~~~~~
-Message storage can be purchased on a per-message basis in blocks listed on the `pricing page
-<https://mailsac.com/pricing>`_.
+--------------------
+Message storage can be purchased on a per-message basis in blocks listed on the 
+`pricing page <https://mailsac.com/pricing>`_.
 
-Starred (saved) Messages
-------------------------
-Mailsac will delete messages on regular intervals. One way around this is to create an account and
-star messages so they will be saved.
+Starred Messages
+----------------
+When you star a message, it counts towards your overall storage. 
 
 :red:`Use the star symbol ★`
 
-When you star a message, it counts towards your overall storage. But once it’s
-starred, you can be sure it will not get recycled, so you can refer back to it
-later.
-
-Your user `dashboard <https://mailsac.com/dashboard>`_ has links to all inboxes where you starred messages.
+Your user `dashboard <https://mailsac.com/dashboard>`_ has links to all 
+inboxes where you starred messages.
 
-You can star messages on any address, including those you own or other public addresses.
+You can star messages on any address, including those you own or other 
+public addresses.
diff --git a/services/private_domains/private_domains.rst b/services/private_domains/private_domains.rst
@@ -1,24 +1,77 @@
 .. _doc_privatedomains:
 
-===============
 Private Domains
 ===============
 
 Private domains allow for receiving of email at any address within a
 domain. Private domains can be `purchased <https://mailsac.com/pricing>`_ as
 an addon or as part of a plan.
 
-.. _section_byod_configuration:
+Zero-Setup Subdomain
+--------------------
+
+The Zero-Setup Subdomain automatically creates a subdomain under msdc.co (eg
+test123.msdc.co) that is ready to receive email with no additional setup. This
+is the ideal option if you do not own a domain or do not have access to change
+the DNS records for a domain.
+
+`Zero-Setup Subdomain Configuration`_
 
 BYODomain
 ---------
 
 BYODomain (Bring Your Own Domain) allows you to easily receive email with a
 domain or subdomain you already own. If you do not already own a domain you can
 use our Zero-Setup Subdomain. Alternatively, you can purchase a domain from a
-registrar (`Namecheap <https://namecheap.com>`_ or
+registrar (`Namecheap <https://namecheap.com>`__ or
 `GoDaddy <https://godaddy.com>`_) and configure it for use with Mailsac.
 
+`BYODomain Configuration`_
+
+.. _section_zero_setup_subdomain:
+
+Zero-Setup Subdomain Configuration
+==================================
+
+Setting up a Zero-Setup domain only takes a few seconds.
+
+#. From the `dashboard <https://mailsac.com/dashboard>`_, select `Verified
+   Domains <https://mailsac.com/domains>`_.
+
+   .. image:: verified_domains.png
+      :scale: 50%
+      :align: center
+
+#. Select "Setup a Custom Domain"
+
+   .. image:: setup_custom_domain.png
+      :width: 600px
+      :align: center
+
+#. Enter a subdomain name and select continue
+
+   .. image:: enter_domain_name.png
+      :width: 600px
+      :align: center
+
+#. Send a test email to any address at in the private domain. There is no
+   need to configure individual addresses. Sending an email to the address
+   creates the address.
+
+#. Enter the email address you sent the email to.
+
+   .. image:: check_mail.png
+      :scale: 50%
+      :align: center
+
+#. Verify the email was received.
+
+   .. image:: verified_mail.png
+      :width: 600px
+      :align: center
+
+.. _section_byod_configuration:
+
 BYODomain Configuration
 =======================
 
@@ -66,7 +119,7 @@ your domain.
    .. note:: The adding of DNS records will depend on your DNS name server.
       Your IT department may be able to assist with this. If you use your domain
       registrar's name server they should have documentation on how to configure
-      DNS (`Namecheap <https://www.namecheap.com/support/knowledgebase/article.aspx/317/2237/how-do-i-add-txtspfdkimdmarc-records-for-my-domain>`_
+      DNS (`Namecheap <https://www.namecheap.com/support/knowledgebase/article.aspx/317/2237/how-do-i-add-txtspfdkimdmarc-records-for-my-domain>`__
       , `Godaddy Documentation <https://www.godaddy.com/help/add-a-txt-record-19232>`_).
 
   =============== ==================
@@ -147,50 +200,3 @@ your domain.
 
 Email can now be received and sent from your BYODomain!
 
-Zero-Setup Subdomain
---------------------
-
-The Zero-Setup Subdomain automatically creates a subdomain under msdc.co (eg
-test123.msdc.co) that is ready to receive email with no additional setup. This
-is the ideal option if you do not own a domain or do not have access to change
-the DNS records for a domain.
-
-Zero-Setup Subdomain Configuration
-==================================
-
-Setting up a Zero-Setup domain only takes a few seconds.
-
-#. From the `dashboard <https://mailsac.com/dashboard>`_, select `Verified
-   Domains <https://mailsac.com/domains>`_.
-
-   .. image:: verified_domains.png
-      :scale: 50%
-      :align: center
-
-#. Select "Setup a Custom Domain"
-
-   .. image:: setup_custom_domain.png
-      :width: 600px
-      :align: center
-
-#. Enter a subdomain name and select continue
-
-   .. image:: enter_domain_name.png
-      :width: 600px
-      :align: center
-
-#. Send a test email to any address at in the private domain. There is no
-   need to configure individual addresses. Sending an email to the address
-   creates the address.
-
-#. Enter the email address you sent the email to.
-
-   .. image:: check_mail.png
-      :scale: 50%
-      :align: center
-
-#. Verify the email was received.
-
-   .. image:: verified_mail.png
-      :width: 600px
-      :align: center
diff --git a/services/sending_mail/sendingmail.rst b/services/sending_mail/sendingmail.rst
@@ -1,7 +1,9 @@
-.. _doc_sendingmail:
 .. _Unified Inbox: https://mailsac.com/app
 .. _Dashboard: https://mailsac.com/dashboard
 .. _Web Form: https://mailsac.com/compose
+.. _API Key: https://mailsac.com/api-keys
+
+.. _doc_sendingmail:
 
 Sending Mail
 ============
@@ -11,7 +13,7 @@ Mail can be sent via the following methods:
 - `Web Form`_
 - `Unified Inbox`_
 - `REST API <https://mailsac.com/docs/api/#send-email-messages>`_
-- `SMTP <doc_sendingmail_smtp_>`__
+- `SMTP <doc_sendingmail_smtp>`_
 
 Sending mail, both replies and new messages, is available only from private
 addresses and private domains. Sending or replying requires `mail credits
@@ -125,7 +127,7 @@ etc) using these SMTP settings:
 +-----------------------+-------------------------------------------------------+
 | **Username**          + Private email address                                 |
 +-----------------------+-------------------------------------------------------+
-| **Password**          | `API Key <https://mailsac.com/api-keys>`_ or SMTP Key |
+| **Password**          | `API Key`_ or SMTP Key                                |
 +-----------------------+-------------------------------------------------------+
 | **Port**              | 587                                                   |
 +-----------------------+-------------------------------------------------------+
@@ -159,7 +161,7 @@ accessible.
 +-----------------------+-------------------------------------------------------+
 | **Password**          | Not required                                          |
 +-----------------------+-------------------------------------------------------+
-| **Port**              | 25
+| **Port**              | 25                                                    |
 +-----------------------+-------------------------------------------------------+
 | **Auth Settings**     | Not required                                          |
 +-----------------------+-------------------------------------------------------+
@@ -178,7 +180,7 @@ sending credits.
 +-----------------------+-------------------------------------------------------------------------------------------+
 | **Username**          + Private email address or email address in a private domain                                |
 +-----------------------+-------------------------------------------------------------------------------------------+
-| **Password**          | `API Key <https://mailsac.com/api-keys>`_                                                 |
+| **Password**          | `API Key`_                                                                                |
 +-----------------------+-------------------------------------------------------------------------------------------+
 | **Port**              | 587                                                                                       |
 +-----------------------+-------------------------------------------------------------------------------------------+