Skip to content

Enhancement - Absolute Image Paths #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Enhancement - Absolute Image Paths #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
efcd481
aws
joshuafranks Jun 10, 2020
384bdc9
sendgrid
Jun 11, 2020
f1ec753
postmark
Jun 11, 2020
226055e
mailgun
Jun 11, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions email-service-mailgun.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,36 +4,36 @@

When you first begin, Mailgun will automatically create a sandbox domain that you can use for sending, but to send using your own domain you'll need to create a custom domain. Select _Sending_ then _Domains_ from the menu on the left hand side, then click _Add New Domain_ (you'll need to add credit card details before this button appears).

![/img/docs/providers/mailgun/mailgun-1.png](/img/docs/providers/mailgun/mailgun-1.png)
![https://sendportal.io/img/docs/providers/mailgun/mailgun-1.png](https://sendportal.io/img/docs/providers/mailgun/mailgun-1.png)

Enter the domain name, choose whichever region makes the most sense for you and click _Add Domain_.

![/img/docs/providers/mailgun/mailgun-2.png](/img/docs/providers/mailgun/mailgun-2.png)
![https://sendportal.io/img/docs/providers/mailgun/mailgun-2.png](https://sendportal.io/img/docs/providers/mailgun/mailgun-2.png)

You'll now need to visit the site that you use to manage DNS for the domain provided (usually the domain registrar). The steps to do this are beyond the scope of this documentation as they vary from provider to provider, but you will need to create a `TXT` entry for the relevant domain and paste in the strings from the `Hostname` and `Enter This Value` columns. Once you've added these, click _Verify DNS Settings_.

![/img/docs/providers/mailgun/mailgun-3.png](/img/docs/providers/mailgun/mailgun-3.png)
![https://sendportal.io/img/docs/providers/mailgun/mailgun-3.png](https://sendportal.io/img/docs/providers/mailgun/mailgun-3.png)

You'll now need to copy the `Private API Key` from _Settings_ > _API Keys_

![/img/docs/providers/mailgun/mailgun-4.png](/img/docs/providers/mailgun/mailgun-4.png)
![https://sendportal.io/img/docs/providers/mailgun/mailgun-4.png](https://sendportal.io/img/docs/providers/mailgun/mailgun-4.png)

Then paste this into your SendPortal provider configuration.

![/img/docs/providers/mailgun/mailgun-5.png](/img/docs/providers/mailgun/mailgun-5.png)
![https://sendportal.io/img/docs/providers/mailgun/mailgun-5.png](https://sendportal.io/img/docs/providers/mailgun/mailgun-5.png)

## Tracking

To enable tracking, select _Sending_ then _Webhooks_ from the menu and click the _Add Webhook_ button.

![/img/docs/providers/mailgun/mailgun-6.png](/img/docs/providers/mailgun/mailgun-6.png)
![https://sendportal.io/img/docs/providers/mailgun/mailgun-6.png](https://sendportal.io/img/docs/providers/mailgun/mailgun-6.png)

The URL depends on your domain, but must end with `/api/v1/webhooks/mailgun`. For example, if SendPortal is installed at `https://campaigns.marketing.com`, then each webhook should point to `https://campaigns.marketing.com/api/v1/webhooks/mailgun`.

![/img/docs/providers/mailgun/mailgun-7.png](/img/docs/providers/mailgun/mailgun-7.png)
![https://sendportal.io/img/docs/providers/mailgun/mailgun-7.png](https://sendportal.io/img/docs/providers/mailgun/mailgun-7.png)

You'll need to add an entry for each type of event you want to track, but the URL is the same for each of them.

![/img/docs/providers/mailgun/mailgun-8.png](/img/docs/providers/mailgun/mailgun-8.png)
![https://sendportal.io/img/docs/providers/mailgun/mailgun-8.png](https://sendportal.io/img/docs/providers/mailgun/mailgun-8.png)

That's it! You're now setup to send and track e-mails using Mailgun.
20 changes: 10 additions & 10 deletions email-service-postmark.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,42 +6,42 @@ To send e-mails using the Postmark provider, you will need a Postmark account. I

Postmark will automatically create a server for you, called `My First Server`. Click on the server and select the _API Tokens_ tab.

![/img/docs/providers/postmark/postmark-1.png](/img/docs/providers/postmark/postmark-1.png)
![https://sendportal.io/img/docs/providers/postmark/postmark-1.png](https://sendportal.io/img/docs/providers/postmark/postmark-1.png)

Copy the string from `Server API tokens` and create a provider within SendPortal.

![/img/docs/providers/postmark/postmark-2.png](/img/docs/providers/postmark/postmark-2.png)
![https://sendportal.io/img/docs/providers/postmark/postmark-2.png](https://sendportal.io/img/docs/providers/postmark/postmark-2.png)

Next, navigate to _Sender Signatures_ and select the option to _Add Domain_.

![/img/docs/providers/postmark/postmark-3.png](/img/docs/providers/postmark/postmark-3.png)
![https://sendportal.io/img/docs/providers/postmark/postmark-3.png](https://sendportal.io/img/docs/providers/postmark/postmark-3.png)

Enter your domain name and click _Verify domain_.

![/img/docs/providers/postmark/postmark-4.png](/img/docs/providers/postmark/postmark-4.png)
![https://sendportal.io/img/docs/providers/postmark/postmark-4.png](https://sendportal.io/img/docs/providers/postmark/postmark-4.png)

You'll now need to visit the site that you use to manage DNS for the domain provided (usually the domain registrar). The steps to do this are beyond the scope of this documentation as they vary from provider to provider, but you will need to create a `TXT` entry for the relevant domain and paste in the strings from the `Hostname` and `Add this value` columns.

![/img/docs/providers/postmark/postmark-5.png](/img/docs/providers/postmark/postmark-5.png)
![https://sendportal.io/img/docs/providers/postmark/postmark-5.png](https://sendportal.io/img/docs/providers/postmark/postmark-5.png)

Once you've added the entry with your DNS provider, click the _Verify_ button and the DKIM status should transition to `Verified`. It can take some time to make this transition, but if it doesn't work ensure you didn't accidentally copy and paste any whitespace at the beginning or end of either string.

![/img/docs/providers/postmark/postmark-6.png](/img/docs/providers/postmark/postmark-6.png)
![https://sendportal.io/img/docs/providers/postmark/postmark-6.png](https://sendportal.io/img/docs/providers/postmark/postmark-6.png)

To configure e-mail tracking, select the server from the `Servers` page, select the `Transactional` (`Default Transactional Stream`) stream from the list of `Message Streams`.

![/img/docs/providers/postmark/postmark-7.png](/img/docs/providers/postmark/postmark-7.png)
![https://sendportal.io/img/docs/providers/postmark/postmark-7.png](https://sendportal.io/img/docs/providers/postmark/postmark-7.png)

Select the _Webhooks_ tab and click _Add webhook_.

![/img/docs/providers/postmark/postmark-8.png](/img/docs/providers/postmark/postmark-8.png)
![https://sendportal.io/img/docs/providers/postmark/postmark-8.png](https://sendportal.io/img/docs/providers/postmark/postmark-8.png)

The `Webhook URL` depends on your domain, but must end with `/api/v1/webhooks/postmark`. For example, if SendPortal is installed at `https://campaigns.marketing.com`, then each webhook should point to `https://campaigns.marketing.com/api/v1/webhooks/postmark`.

![/img/docs/providers/postmark/postmark-9.png](/img/docs/providers/postmark/postmark-9.png)
![https://sendportal.io/img/docs/providers/postmark/postmark-9.png](https://sendportal.io/img/docs/providers/postmark/postmark-9.png)

You'll also need to enable open tracking and link tracking from the stream settings.

![/img/docs/providers/postmark/postmark-10.png](/img/docs/providers/postmark/postmark-10.png)
![https://sendportal.io/img/docs/providers/postmark/postmark-10.png](https://sendportal.io/img/docs/providers/postmark/postmark-10.png)

That's it! You're now setup to send and track e-mails using Postmark.
10 changes: 5 additions & 5 deletions email-service-sendgrid.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,27 +6,27 @@ To send e-mails using the Twilio Sendgrid provider, you will need a Sendgrid acc

Once registered, open the `Setup Guide`, choose the `Web API` integration and select the PHP language option.

![/img/docs/providers/sendgrid/sendgrid-1.png](/img/docs/providers/sendgrid/sendgrid-1.png)
![https://sendportal.io/img/docs/providers/sendgrid/sendgrid-1.png](https://sendportal.io/img/docs/providers/sendgrid/sendgrid-1.png)

Generate an API key and copy it to your SendPortal configuration.

![/img/docs/providers/sendgrid/sendgrid-2.png](/img/docs/providers/sendgrid/sendgrid-2.png)
![https://sendportal.io/img/docs/providers/sendgrid/sendgrid-2.png](https://sendportal.io/img/docs/providers/sendgrid/sendgrid-2.png)

Check the `I've integrated the code above` box and click Next.

Send a test e-mail from SendPortal and if it works successfully click _Verify integration_.

## Tracking

![/img/docs/providers/sendgrid/sendgrid-3.png](/img/docs/providers/sendgrid/sendgrid-3.png)
![https://sendportal.io/img/docs/providers/sendgrid/sendgrid-3.png](https://sendportal.io/img/docs/providers/sendgrid/sendgrid-3.png)

Open and click tracking is enabled by default in SendGrid, but if you'd like to check the settings you'll find them under _Settings_ > _Tracking_.

![/img/docs/providers/sendgrid/sendgrid-4.png](/img/docs/providers/sendgrid/sendgrid-4.png)
![https://sendportal.io/img/docs/providers/sendgrid/sendgrid-4.png](https://sendportal.io/img/docs/providers/sendgrid/sendgrid-4.png)

You can also enable subscription tracking from this page. If enabled, SendGrid will automatically add unsubscribe links to the bottom of every e-mail you send.

![/img/docs/providers/sendgrid/sendgrid-5.png](/img/docs/providers/sendgrid/sendgrid-5.png)
![https://sendportal.io/img/docs/providers/sendgrid/sendgrid-5.png](https://sendportal.io/img/docs/providers/sendgrid/sendgrid-5.png)

To enable tracking within SendPortal you'll need to enable event notifications from _Settings_ > _Mail Settings_.

Expand Down
46 changes: 23 additions & 23 deletions email-service-ses.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,73 +4,73 @@

To send e-mails using the Amazon SES provider, you will need an AWS account. If you don't already have an account, [visit the AWS website](https://aws.amazon.com/) and click the _Create an AWS Account_ button in the top right corner of the screen.

![/img/docs/providers/aws/aws-1.png](/img/docs/providers/aws/aws-1.png)
![https://sendportal.io/img/docs/providers/aws/aws-1.png](https://sendportal.io/img/docs/providers/aws/aws-1.png)

Be aware that you'll need to provide credit card details, even if you only intend to make use of the free tier.

Once you've created an account, navigate to the SES (Simple Email Service) control panel by typing "simple email service" into the `Find Services` input on the AWS Management Console and clicking on the relevant option in the dropdown.

![/img/docs/providers/aws/aws-2.png](/img/docs/providers/aws/aws-2.png)
![https://sendportal.io/img/docs/providers/aws/aws-2.png](https://sendportal.io/img/docs/providers/aws/aws-2.png)

Click _Go to identity management_;

![/img/docs/providers/aws/aws-3.png](/img/docs/providers/aws/aws-3.png)
![https://sendportal.io/img/docs/providers/aws/aws-3.png](https://sendportal.io/img/docs/providers/aws/aws-3.png)

You'll need to verify the domain from which you want to send all your e-mails, so click _Verify a New Domain_.

![/img/docs/providers/aws/aws-4.png](/img/docs/providers/aws/aws-4.png)
![https://sendportal.io/img/docs/providers/aws/aws-4.png](https://sendportal.io/img/docs/providers/aws/aws-4.png)

At this stage we're not going to generate the DKIM settings, but this is worth doing once you move to a production environment, as it will reduce the risk of any messages you send being marked as spam.

![/img/docs/providers/aws/aws-5.png](/img/docs/providers/aws/aws-5.png)
![https://sendportal.io/img/docs/providers/aws/aws-5.png](https://sendportal.io/img/docs/providers/aws/aws-5.png)

Once you click _Verify This Domain_ you'll be provided with a domain verification record;

![/img/docs/providers/aws/aws-6.png](/img/docs/providers/aws/aws-6.png)
![https://sendportal.io/img/docs/providers/aws/aws-6.png](https://sendportal.io/img/docs/providers/aws/aws-6.png)

You'll now need to visit the site that you use to manage DNS for the domain provided (usually the domain registrar). The steps to do this are beyond the scope of this documentation as they vary from provider to provider, but you will need to create a `TXT` entry for the relevant domain and paste in the strings from the `Name` and `Value` columns.

Once you've completed this step, click `Close`. At first the `Verification status` will be `pending verification` and `Enabled for sending` will be `No`.

![/img/docs/providers/aws/aws-7.png](/img/docs/providers/aws/aws-7.png)
![https://sendportal.io/img/docs/providers/aws/aws-7.png](https://sendportal.io/img/docs/providers/aws/aws-7.png)

As long as you have set the DNS entry correctly, the `Verification status` will transition to `verified` and `Enabled for Sending` will show `Yes`. You should also receive a notification via e-mail to say that the domain has been successfully verified.

![/img/docs/providers/aws/aws-8.png](/img/docs/providers/aws/aws-8.png)
![https://sendportal.io/img/docs/providers/aws/aws-8.png](https://sendportal.io/img/docs/providers/aws/aws-8.png)

It can take some time to make this transition, but if it doesn't work ensure you didn't accidentally copy and paste any whitespace at the beginning or end of either string.

We also need to create a "configuration set". In order to do that, select the _Configuration Sets_ option from the side menu of the SES panel.

![/img/docs/providers/aws/aws-9.png](/img/docs/providers/aws/aws-9.png)
![https://sendportal.io/img/docs/providers/aws/aws-9.png](https://sendportal.io/img/docs/providers/aws/aws-9.png)

If you don't require e-mail tracking (delivery, opens etc) you only need to create the configuration set.

![/img/docs/providers/aws/aws-10.png](/img/docs/providers/aws/aws-10.png)
![https://sendportal.io/img/docs/providers/aws/aws-10.png](https://sendportal.io/img/docs/providers/aws/aws-10.png)

Next we need to generate an access key pair. To do this you'll need to visit the [IAM (Identity and Access Management) module of AWS](https://console.aws.amazon.com/iam/home?#/home).

It's best to create a new IAM user, so click _Users_ and _Add user_. You can create the key pair using your root user account, but as this allows unrestricted access to the AWS console, it's a security risk if the credentials are ever compromised.

As the user doesn't need access to the management console, you can just select the `Programmatic access` option.

![/img/docs/providers/aws/aws-12.png](/img/docs/providers/aws/aws-12.png)
![https://sendportal.io/img/docs/providers/aws/aws-12.png](https://sendportal.io/img/docs/providers/aws/aws-12.png)

If you don't already have any groups configured, you'll need to create one at the next step. If you only want the account to be able to send e-mails then select the `AmazonSESFullAccess` policy.

![/img/docs/providers/aws/aws-13.png](/img/docs/providers/aws/aws-13.png)
![https://sendportal.io/img/docs/providers/aws/aws-13.png](https://sendportal.io/img/docs/providers/aws/aws-13.png)

If you also want to enable e-mail tracking, you'll need to add the `AmazonSNSFullAccess` policy.

![/img/docs/providers/aws/aws-14.png](/img/docs/providers/aws/aws-14.png)
![https://sendportal.io/img/docs/providers/aws/aws-14.png](https://sendportal.io/img/docs/providers/aws/aws-14.png)

Selecting tags for the user is optional, so we're not going to enter any at this stage. Once the user has been created you should now be able to copy and paste the access key and secret access key to the SendPortal provider configuration.

![/img/docs/providers/aws/aws-15.png](/img/docs/providers/aws/aws-15.png)
![https://sendportal.io/img/docs/providers/aws/aws-15.png](https://sendportal.io/img/docs/providers/aws/aws-15.png)

We're now ready to configure the provider with SendPortal.

![/img/docs/providers/aws/aws-11.png](/img/docs/providers/aws/aws-11.png)
![https://sendportal.io/img/docs/providers/aws/aws-11.png](https://sendportal.io/img/docs/providers/aws/aws-11.png)

Congratulations! You can now send e-mails using Amazon SES.

Expand All @@ -84,37 +84,37 @@ You'll need to configure Amazon's SNS (Simple Notification Service) in order for

Begin by creating a topic. Select _Topics_ from the menu and click _Create topic_. Everything other than a name is optional at this time.

![/img/docs/providers/aws/aws-16.png](/img/docs/providers/aws/aws-16.png)
![https://sendportal.io/img/docs/providers/aws/aws-16.png](https://sendportal.io/img/docs/providers/aws/aws-16.png)

We also need to create a subscription to go along with our topic. For the Topic ARN, select the topic that you just created and select `HTTPS` as the protocol. The `Endpoint` will depend on your domain, but must end with `/api/v1/webhooks/aws`. For example, if SendPortal is installed at `https://campaigns.marketing.com`, then each webhook should point to `https://campaigns.marketing.com/api/v1/webhooks/aws`.

![/img/docs/providers/aws/aws-17.png](/img/docs/providers/aws/aws-17.png)
![https://sendportal.io/img/docs/providers/aws/aws-17.png](https://sendportal.io/img/docs/providers/aws/aws-17.png)

The subscription needs to be confirmed before we can use it, but if you've supplied the correct URL for your SendPortal instance, and it's already available to the outside world, we'll do that automatically for you. You should see `Status` transition to `Confirmed`.

![/img/docs/providers/aws/aws-18.png](/img/docs/providers/aws/aws-18.png)
![https://sendportal.io/img/docs/providers/aws/aws-18.png](https://sendportal.io/img/docs/providers/aws/aws-18.png)

We now need to tell SES to send any e-mail tracking webhooks to this endpoint so navigate back to the SES panel (we're almost there now...).

Select the domain that you already configured from `Domains` and open the section titled `Notifications`.

![/img/docs/providers/aws/aws-19.png](/img/docs/providers/aws/aws-19.png)
![https://sendportal.io/img/docs/providers/aws/aws-19.png](https://sendportal.io/img/docs/providers/aws/aws-19.png)

Click _Edit Configuration_ and select the SNS topic that you created from the dropdown for each of the notification types.

![/img/docs/providers/aws/aws-20.png](/img/docs/providers/aws/aws-20.png)
![https://sendportal.io/img/docs/providers/aws/aws-20.png](https://sendportal.io/img/docs/providers/aws/aws-20.png)

Finally, we need to enable the notification types for the configuration step that we created. Select the configuration set from the list and select SNS from the dropdown next to `Add Destination`.

![/img/docs/providers/aws/aws-21.png](/img/docs/providers/aws/aws-21.png)
![https://sendportal.io/img/docs/providers/aws/aws-21.png](https://sendportal.io/img/docs/providers/aws/aws-21.png)

Select all the notification types you wish to receive (excluding `Send` and `Rendering Failure`), and select the Topic from the list.

![/img/docs/providers/aws/aws-22.png](/img/docs/providers/aws/aws-22.png)
![https://sendportal.io/img/docs/providers/aws/aws-22.png](https://sendportal.io/img/docs/providers/aws/aws-22.png)

Phew! That's it folks! You should now be setup to send and track e-mails using Amazon AWS.

![/img/docs/providers/aws/aws-23.png](/img/docs/providers/aws/aws-23.png)
![https://sendportal.io/img/docs/providers/aws/aws-23.png](https://sendportal.io/img/docs/providers/aws/aws-23.png)

For more information on Amazon SNS, visit the [official documentation](https://docs.aws.amazon.com/sns/latest/dg/sns-getting-started.html).

Expand Down