| 1 |
-------------------------------------------------------- |
| 2 |
------ Installing MailRelay plugin for Wordpress ------- |
| 3 |
-------------------------------------------------------- |
| 4 |
|
| 5 |
The installation of the MailRelay plugin product for Wordpress is very simple. It only takes a few steps to do it. |
| 6 |
|
| 7 |
After installing the extension a new menu will appear on the left panel, this menu will let you sync all your Wordpress users with your Mailrelay account. |
| 8 |
This will save you time when syncing and organizing your users in groups. |
| 9 |
|
| 10 |
Let's start with the installation process: |
| 11 |
|
| 12 |
------------------- |
| 13 |
First required step |
| 14 |
------------------- |
| 15 |
|
| 16 |
The first step, in order for us to be able to use the extension, is to enable the API key of our Mailrelay account. For that we need to log in our Mailrelay account |
| 17 |
admin panel. Once we are there we will go to the "Settings" menu, then "API access". On that screen click on the "Generate new API key" button. |
| 18 |
|
| 19 |
--------------------------------------------------------------------------------------- |
| 20 |
Upload the necessary files to the server or install it direct from WordPress repository |
| 21 |
--------------------------------------------------------------------------------------- |
| 22 |
|
| 23 |
The Mailrelay plugins comes into a .zip file. To upload it we will go to the left menu Plugins > Add new. Then you click on the Upload tab that will allow you to |
| 24 |
install a plugin from the archive. A file box will appear where you can upload the mailrelay zip file. The plugin will be uploaded to your blog and installed. |
| 25 |
Please note that you have to give write access to your wp-content/plugins folder. |
| 26 |
|
| 27 |
You can also install the Mailrelay plugin straight from the WordPress repository. In the left menu Plugins > Add new. Then you will search for Mailrelay in the Search Plugins area. Then you just need to click the Install Now button and wait for it to be installed, after that click on the Activate button. |
| 28 |
|
| 29 |
------------------------- |
| 30 |
Configuring the extension |
| 31 |
------------------------- |
| 32 |
|
| 33 |
Once the extension is installed we will have a new settings option. We will go to Mailrelay on the left Menu. |
| 34 |
You will be taken into a form that you need to fill the following data: |
| 35 |
|
| 36 |
- Account (this can be found in your Mailrelay welcome email). |
| 37 |
- API key (the API key generated for our Mailrelay account). |
| 38 |
|
| 39 |
Once this data is successfully saved we can start the user sync. |
| 40 |
|
| 41 |
-------- |
| 42 |
Settings |
| 43 |
-------- |
| 44 |
|
| 45 |
After the configuration, we will click on the Save button. If settings are correct, this will take us to a screen where you can select if you want to |
| 46 |
Automatically synchronize all your users to your Mailrelay account and with which group (from 1 to all). |
| 47 |
|
| 48 |
----------- |
| 49 |
Manual Sync |
| 50 |
----------- |
| 51 |
|
| 52 |
In the Manual Sync tab you can select the groups of your Mailrelay account that you want your WordPress users synced to. |
| 53 |
We will click them and will press the Sync button. |
| 54 |
|
| 55 |
We will see the following screen, which simply shows us the sync process. It shows the total users synced, total users updated and fails. |
| 56 |
|
| 57 |
[ NOTE: Depending on the number of users to sync, the process can take from some seconds to several minutes. ] |
| 58 |
|
| 59 |
--------- |
| 60 |
Uninstall |
| 61 |
--------- |
| 62 |
|
| 63 |
Uninstalling the extension is as easy as installing it. You only have to go to Plugins > Installed plugins. |
| 64 |
You must search for the Mailrelay module and click on Deactivate. Selecting this option, the extension will be disabled. |
| 65 |
Next you can click on the Delete link to completely remove the extension. |
| 66 |
|
| 67 |
---------------- |
| 68 |
Additional notes |
| 69 |
---------------- |
| 70 |
- This extension has been tested using Wordpress 5.9 |
| 71 |
|
| 72 |
- This software is provided by the copyright holders and contributors "AS IS" and any express or implied warranties, including, but not limited to, |
| 73 |
the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall the copyright owner or contributors be liable for any direct, |
| 74 |
indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data or profits, |
| 75 |
or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any |
| 76 |
way out of the use of this software, even if advised of the possibility of such damage. |
| 77 |
|
