forked from mailrelay/opencart
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Mailrelay_Installation.txt
77 lines (54 loc) · 3.95 KB
/
Mailrelay_Installation.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
--------------------------------------------------------
------ Installing MailRelay plugin for OpenCart -------
--------------------------------------------------------
The installation of the MailRelay plugin product for OpenCart is very simple. It only takes a few steps to do it.
After installing the extension we will go to option "Extensions -> Modules -> Mailrelay Sync -> Edit" this option will let you sync all your OpenCart users with your Mailrelay account.
This will save you time when syncing and organizing your users in groups.
Let's start with the installation process:
-------------------
First required step
-------------------
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
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.
It's not necessary for us to write down this key, once it's generated, the extension will be able to get it using your user and password data.
----------------------------------------
Upload the necessary files to the server
----------------------------------------
The Mailrelay plugins comes into a .zip file. The content of it must be extracted inside the folder where OpenCart is installed.
---------------------------------------
Installation from OpenCart admin panel
---------------------------------------
Once we have uploaded all the required files, we need to do some configs from the admin panel:
- We will go to the "Extensions -> Modules -> Mailrelay Sync -> Edit" option
- If it shows it's deactivated, we click on Activate to enable it
This finishes the installation process.
-------------------------
Configuring the extension
-------------------------
Once the extension is installed we will have a new settings option. We will go to Settings > Mailrelay option.
Clicking on this option will take us to a form where we need to fill the following data:
- Host (this can be found in your Mailrelay welcome email). Please note that the host must be entered without initial http://
- API key (the API key generated for our Mailrelay account)
Once this data is successfully saved we can start the user sync.
----------
Sync users
----------
After the configuration, we will click on "Save" button. If settings are correct we can select the groups of our
Mailrelay account that must be sync with the OpenCart users. We will select one of them and will press the "Start Sync" button.
We will see the following screen, that simply shows us the sync process. It shows the total users synced.
[ NOTE: Depending on the number of users to sync, the process can take from some seconds to several minutes. ]
---------
Uninstall
---------
Uninstalling the extension is as easy as installing it. You only have to go to "Extensions -> Modules -> Mailrelay Sync -> Uninstall".
Selecting this option, the extension will be disabled.
The files won't be removed from ftp, to do that you must remove the right folders and files.
----------------
Additional notes
----------------
- This extension has been tested using OpenCart 1.5.1.1
- This software is provided by the copyright holders and contributors "AS IS" and any express or implied warranties, including, but not limited to,
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,
indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data or profits,
or bussiness interruption) however caused and on any theory of liability, wether in contract, strict liability, or tort (including negligence or otherwise) arising in any
way out of the use of this software, even if advised of the possibility of such damage.