Giter Site home page Giter Site logo

swpm-mailjet-integration's Introduction

Mailjet Integration addon for SWPM (Simple WordPress Membership)

This is repository contains a WordPress plugin/addon that you can install to be able to use Mailjet with Simple WordPress Membership plugin.

General Information

This document will help you understand what this addon can do, and will help you configure it.

What is it for / Why did I wrote this WordPress plugin

  • I was looking for a way to easily send Email Marketing campaigns to the users of my WordPress website.
  • The existing Newsletter / Email Markerting Addons available for Simple WordPress Membership did not seemed to provide the functionalities I was looking for
  • I wanted to be able to automatically maintain a fully up-to-date list of contacts (email addresses) of my the users of my WordPress website.
  • I wanted to avoid having to do some manual/hard-to-maintain customization to the PHP code of the original Simple WordPress Membership plugin or the original Mailjet plugin.
  • I like the pricing model of Mailjet, which is not charging by list of contacts but by number of emails you send. I value quality over quantity, so the other pricing models does not makes sense to me.
  • I was curious to learn how to write a WordPress plugin

Requirements

Installation

  1. First, make sure that you have installed and configured Simple WordPress Membership plugin

  2. Then install Mailjet Plugin for WordPress, create your Mailjet account, and configure the Mailjet Plugin for WordPress following the official documentation

    • Create a Mailjet account and generate your API Keys
    • Declare your API Keys in the Official Mailjet Plugin

    01-mailjet-plugin.png

  3. Download this addon, either by cloning this Github repository, or by downloading the latest ZIP file from the Release Page

  4. Uncompress the ZIP file, and rename the folder to make sure it is named swpm-mailjet-integration

  5. Move the folder swpm-mailjet-integration into the WordPress plugin folder, in wp-content/plugins

    # Expected folder structure :
    \wp-content
          \plugins
                \example-of-plugin-1
                \example-of-plugin-2
                \swpm-mailjet-integration
                      \swpm-mailjet-integration.php
                \example-of-plugin-3
    
  6. Configure Mailjet Plugin for WordPress

    • Select/Create the Contact List where you will want to export the WordPress contacts to :

    02-mailjet-plugin.png

  7. Go to the Plugins page of your WordPress website, and enable this plugin SWPM Mailjet Integration

    03-swpm-mailjet-integration.png

  8. Then go to the WP Membership settings, and go to the page Addons Settings

    04-swpm-mailjet-integration.png

    05-swpm-mailjet-integration.png

  9. Enable the Mailjet Integration option and configure the options

    06-swpm-mailjet-integration.png

    Note: For verification purposes, we suggest you to first Show the Newsletter checkbox on the SWPM forms. Once everything is working fine, you can then decide to change the settings to hide the Newsletter checkbox.

  10. Verify that the Newsletter checkbox is visible on the SWPM Registration and SWPM Profil Edit page

    07-swpm-mailjet-integration.png

    08-swpm-mailjet-integration.png

    09-swpm-mailjet-integration.png

  11. Verify that the Contacts / Email addresses are added to the Mailjet Contact List, on the Mailjet website

    10-mailjet-contact-list.png

  12. If you are using custom extra fields (WP/WP Meta/ SWPM), then you will have to declare the fields on the Contact List Properties page, on the Mailjet website

    11-mailjet-contact-list-properties.png

Troubleshooting / Problems

You will find below some basic help about the most commons problems.

Problem 1 : I don't see the Mailjet Integration addon in the WordPress Plugin page

  • Verify that you have uncompressed the ZIP file and named the folder correctly : swpm-mailjet-integration
  • Verify that it is in the path /wp-content/plugins/swpm-mailjet-integration
  • Verify that there isn't another sub-folder called swpm-mailjet-integration inside /wp-content/plugins/swpm-mailjet-integration (exemple: /wp-content/plugins/swpm-mailjet-integration/swpm-mailjet-integration)

Problem 2 : The Newsletter checkbox is not visible on the Simple WordPress Membership form pages

  • Verify that you are indeed using Simple WordPress Membership plugin and not another Membership plugin
  • Verify that the SWPM plugin is up to date
  • Verify that the Mailjet Integration Addon is globally enabled on the WordPress Plugins page
  • Verify that the Mailjet Integration Addon is also set to enabled in the page Simple WordPress Membership > Settings > Addons Settings
  • Verify that the Subscription Mode is not set to Invisible

Problem 3 : The users does not seems to be added to the Contact List on my Mailjet Account

  • Verify that the official Mailjet plugin is installed, enabled and configured correctly
  • Log into your Mailjet account and make sure that you don't see any error messages
  • Make sure that the Contact List that you have configured in WordPress is indeed visible on the Mailjet website
  • On the Mailjet website > Contact List > Properties page, make sure that all the extra properties are defined correctly

Note regarding email delivery issues :

Your WordPress website is not in charge of the email delivery. Your website is only in charge of syncing the contacts into the Mailjet Contact List.

For any email delivery problems, please verify your Mailjet Account and use Mailjet's support to assist you in the troubleshooting.

Thanks

  • The people at Simple WordPress Membership, for having created such a nice Membership plugin
  • The people at Mailjet, for providing a great tool to manage Newsletters and Email Marketing

Contribution / Bugs / Improvements

Please report any bug, and feel free to fork the project to add some improvements. Pull Requests are welcome :)

Authors

  • Thomas L. - Original version - Th0masL

swpm-mailjet-integration's People

Contributors

th0masl avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.