The Mailjet TYPO3 extension ensures increased deliverability of your emails by replacing the default TYPO3 transactional SMTP service with ours. In addition, you can use the Mailjet Subscription Form to update selected Mailjet contact lists with new subscribers.
These options will help you optimize your sending capabilities and keep your contact lists up-to-date.
In this section we will quickly go over what you need to do to configure the Mailjet extension and the Mailjet Subscription Form. Detailed explanations will be provided in the next sections of the guide.
Configure the Mailjet Extension
After successfully installing the extension, you need to enter your Mailjet API credentials (API Key and Secret Key) to link it to your Mailjet account.
- Find ‘Mailjet Email Marketing’ in your list of installed extensions and click on ‘Configure’.
- In the ‘API Settings’ tab enter your Mailjet API credentials (API Key and Secret Key) to link your Mailjet account. Then select a sender email address that has been validated in your Mailjet account and Save your settings.
- Under ‘General Settings’ tick the checkbox next to ‘Send emails through Mailjet’ to enable your TYPO3 Emails to be sent through Mailjet.
For more details, please see ‘Install and Configure‘ section.
Enable the Mailjet Subscription Form
The main requirement for the subscription form is that for each one you need to select a sender email address (again validated by Mailjet).
- Add a Mailjet plugin to a page of your choice.
- Select which contact list you want to link to the form from the ‘Plugin’ tab, under ‘Subscription form configuration’
- In the Plugin Options select the ‘Messages and errors’ tab and enter the email address in the ‘Email FROM address’ field, then Save your settings.
For more details, please see the ‘Mailjet Subscription Form‘ section.
Install and Configure
Install the Mailjet Extension
Log into your TYPO3 site as an administrator and go to ‘Admin Tools’ →‘Extensions’.
There are two ways to install the Mailjet extension - from the TYPO3 extension list, or by manually uploading a .ZIP file.
From the TYPO3 Extension List
From the drop-down menu at the top select ‘Get Extensions’.
Enter ‘Mailjet’ in the Search field. You will see ‘Mailjet Email Marketing’ extension in the search results - click on the ‘Import and Install’ link next to it.
Well done - the extension has been installed!
By Uploading a ZIP File
You can download the extension from Mailjet’s TYPO3 repository in GitHub - simply choose the latest release available there.
- Click on the ‘Upload’ button in the TYPO3 admin.
- Select the
mailjet.zipfile from your computer with the ‘Choose File’ option, then click on ‘Upload’.
- Congrats - you have successfully installed the Mailjet extension!
Configure the Mailjet Extension
To access the configuration options, use the drop-down menu to get back to your Installed Extensions.
Then locate the Mailjet extension with the Search menu, and click on the ‘Configure’ button.
The ‘API Settings’ tab allows you to link the Mailjet extension to your Mailjet account. To do that, you need to enter your API Key and Secret Key details in the respective fields.
You can find the API Key and Secret Key information in your Mailjet API Key Management page.
In addition, you must enter your desired sender email address in the designated field.
Once this is done, click on the ‘Save’ button to submit your settings.
If accepted, you will see a confirmation message under ‘API Status’. If not, you will see an error describing which details were incorrect.
Configure your sending settings by using the options available in the ‘General Settings’ tab.
- Send Emails through Mailjet - Tick this checkbox in order to start sending your TYPO3 emails through the Mailjet SMTP servers.
- Allow HTML - Tick this checkbox if you want your emails to allow HTML code. If you disable the option, the email body will automatically be converted to plain text.
- Mailjet SMTP host - If the field is left blank, the default value for the Mailjet SMTP host will be used.
- Mailjet SMTP port - Choose a port for the Mailjet SMTP.
- Enable SSL communication with mailjet.com
- Test email recipient - Choose an email address to send a test email to. The email will be sent once you Save your settings.
Click on ‘Save’ to submit your changes.
The ‘Account Information’ tab displays your Mailjet account details - First and Last Name, Company Name and Address. The information cannot be edited directly from the extension within TYPO3 - you can change it in your Mailjet Profile.
Mailjet Subscription Form
Once you have successfully installed and configured the Mailjet extension, the next step is to add subscription forms to your website. This way you can easily capture new contacts directly from your site and synchronize them with your Mailjet contact lists.
Mailjet allows you to set up multiple subscription forms in one (or more) of your web pages. Use these options to be able to update multiple contact lists. The TYPO3 settings will help you configure the visibility options for the forms.
Set up a Mailjet Subscription Form
Click on the web page you want to add the subscription form to. Then use the drop-down menu under ‘General’ → ‘Content Element’ → ‘Type’ to select ‘Insert Plugin’. A pop-in window will appear, asking you to refresh the display - click on ‘OK’.
Once the display has refreshed, you will see the ‘Plugin’ tab appear next to ‘General’. Open it.
Under ‘Selected Plugin’ choose Mailjet, then refresh the page with the help of the pop-in window.
The configuration settings for the Mailjet form will then be displayed. Under ‘Plugin Options’ you will see 3 tabs - ‘Subsciption form configuration’,’ Confirmation email customization‘ and ‘Messages and Errors’.
Subscription Form Configuration
This section contains all the settings you need to properly configure your subscription form.
Mailjet contact list - Choose a contact list, to which the new subscribers will be added. If you need to create a new contact list, visit the Contacts section in your Mailjet account.
Contact properties - You can collect additional information about your subscribers by adding up to 3 fields linked to specific contact properties you have configured in Mailjet. For more details on contact properties please visit our dedicated guide.
Email field label - This is the text that appears above the email address field in the form.
Property labels - Similarly, you can add label texts above each of the fields for the properties you have added to the form.
Property descriptions - These are the descriptions, which are displayed below their respective property fields. For example, descriptions are useful when you need to specify what type of data should be entered - specific date format, number, text etc.
Form description - You can add a description for the form itself - its purpose, what kind of emails the subscribers will receive etc. It will be displayed above the Email field and its label.
Submit Button label - This will be the text on the “Subscribe” button.
Confirmation Email Customization
Once a person submits their subscription request via the Mailjet form, they will receive an email asking them to confirm their subscription. This email will always include several pieces of information that cannot be removed:
- The URL of the website that contains the subscription form.
- A button for completing the subscription process, linking to a confirmation URL.
- The confirmation URL itself, so users can copy-paste it in the address bar of their web browser.
The rest of the email content can be edited with the fields located in the ‘Confirmation email customization’ tab:
If you do not enter any information, the default text for the respective field will be displayed.
Email Heading Text - Will be displayed above the website URL and subscription confirmation button.
Email Body Text - Will be displayed between the button and the subscription link in the email.
Email Confirmation Button Text - Will be displayed on the subscription confirmation button.
Email Footer Text - the information you want displayed after the subscription confirmation link.
Thanks,… - Used for the end of the email, before the signature.
Owner - the email signature. Usually you would put your company / website name here.
Here is an example of a customized subscription confirmation email.
Messages and Errors
This tab allows you to modify the messages your users might receive when attempting to use the subscription form. Importantly, it also includes a field to select the sender email address for this form.
Select Sender Address
For each subscription form it is required to select a sender address. This will be the email address used to send the subscription confirmation email. Enter the sender email address in the ‘Email FROM address’ field.
Edit Messages and Errors
The rest of the options in this tab allow you to customize the responses a user can receive after submitting their details in the subscription form.
Confirmation Message - will be shown after a user clicks on the Subscribe button and the subscription confirmation email is sent successfully. You can use the
Data type mismatch error - will be displayed whenever a user enters data in an incorrect format in one of the form fields. For example, you ask users to submit their age in one of the fields, so they need to enter a number, but instead they enter text.
%idcan be used to show the field label with the incorrect data format, and
%typeto display the type of data required.
Subscribe error. Please try again later! - If there was any kind of issue with the form submission, the user will see this error message.
Thanks for subscribing - Once the user clicks on the button in the confirmation email and completes the subscription process, this message will be displayed on the landing page.
The TYPO3 Support page can assist you with answers to questions about module functionalities and common issues.
Of course, feel free to contact our Customer Support team, in case you come across any technical difficulties with the Mailjet product - our team of specialists will be more than happy to assist you! Please visit the Mailjet ‘Contact Us’ page for more information.
We hope you find this guide helpful. Let us know what you think of the TYPO3 integration process, or especially what functionality we should introduce next by emailing firstname.lastname@example.org.
Mailjet Integrations Team