Create an email provider

Try it in the demo.

SendMock ships SendGrid, Mailgun, Postmark, Resend, Amazon SES and Brevo. Any other email API can be added without code, because a provider is a definition: the requests it answers, where each part of the email is read from, and what it answers.

This walkthrough adds Mailjet, whose send API is POST /v3.1/send with a JSON body. Swap in your provider's names and fields as you go.

The field names below (Messages, TextPart, MessageID, ...) come from Mailjet's API docs. Use the ones in your provider's docs.

Before you start: read the provider's docs forCopy Anchor Link

1. The send request: method, path and body format (JSON, form or multipart).
2. Where each part is: sender, recipients, subject, text and HTML.
3. The answers: the success body (with the message id your app reads) and the error body.
4. The credentials your app sends (API key and secret).

1. Add the providerCopy Anchor Link

1. Open Mail > Providers and press Add provider.
2. Set Name to Mailjet; the Key becomes mailjet. Leave Start from on Blank and press Add provider. The provider sheet opens.

2. GeneralCopy Anchor Link

1. Set Host to api.mailjet.com.
2. Press Add credential twice: api_key, and secret_key marked Secret.

3. RequestsCopy Anchor Link

1. Change Request 1 path to /v3.1/send. Keep POST and JSON.

2. Under Field mapping, press Map a part for each part and set its source:

   Part	Source
   from	Messages[0].From.Email
   to	Messages[0].To[*].Email
   subject	Messages[0].Subject
   text	Messages[0].TextPart
   html	Messages[0].HTMLPart

3. Under Checks on a send, press Add check: to, Required, Missing field.

4. ResponsesCopy Anchor Link

1. Set Message id to {{ random_hex(16) }}.

2. Set the Success response body to:

   Copy Text

   {"Messages": [{"Status": "success", "To": [{"Email": "{{ message.to }}", "MessageID": "{{ message.provider_id }}"}]}]}

3. Press Add an error response and set its body to:

   Copy Text

   {"ErrorMessage": "{{ error.reason }}", "StatusCode": 400}

5. Check the previewCopy Anchor Link

Open Preview. The sample send is built from your field mapping: the Stored message shows [email protected] as recipient, and the Response is 200 with your body. Clear the sample body to {} and the answer becomes your error response.

6. Save and connect your appCopy Anchor Link

1. Press Save provider. Mailjet is listed as Custom.
2. Open Try it and point Mailjet's SDK at the base URL it shows.

To share it with your team, export the seed file in Settings > Seed: custom providers are saved with their secrets as ${ENV} references.

RelatedCopy Anchor Link

• Mail > Providers
• Create an SMS provider
• Create a payment gateway