XML calls
To subscribe a user, a call - POST or GET - has to be performed to the address http://<MailUP Admin Console URL>/frontend/xmlSubscribe.aspx, where the first part of the URL is the URL of your MailUp admin console, passing the following parameters in any order:
- List : list ID* (Mandatory)
- Group : Id of the group in which to insert the user* (Optional)
- Email : recipient's email address (Mandatory)
- Confirm : boolean value which specifies whether to subscribe the user at once (0) or send a confirmation request (1) (optional – default : 1)
- csvFldNames : code list of the personal data fields to be updated, separated by the ";" character* (optional)
- csvFldValues : values linked to the personal data fields to be updated, separated by the ";" character and provided in the same order as the fields specified in the parameter "csvFldNames" (Optional)
A list of codes is available under Settings > Codes table in the MailUp admin console.
Generic Code Sample
You may want to subscribe the user John Smith to a "General list" in group 1 without asking for a confirmation, and to list 2 sending a confirmation request:
name : John Smith
e-mail : smith@myprovider.com
company : MyCompany Inc.
gender: M
To subscribe the user to these two lists, two different calls have to be performed (in this case the GET method is more convenient, as it calls the page directly, using the proper querystrings).
The necessary codes are displayed in the codes table: 1 for "General list", 8 for "List 2", 6 for group 1 in the general list. The codes for personal data fields are: Campo1, Campo2, Campo3, Campo5(Name, Surname, Company, Gender). So the calls will have to be structured like this:
http://newsletter.domainname.tld/frontend/xmlSubscribe.aspx?list=1&group=6&email=smith@myprovider.com&confirm=false&csvFldNames=campo1;campo2;campo3;campo5&csvFldValues=John;Smith;MyCompany Inc;M
http://newsletter.domainname.tld/frontend/xmlSubscribe.aspx?list=8&email=smith@myprovider.com&confirm=true&csvFldNames=campo1;campo2;campo3;campo5&csvFldValues=John;Smith;MyCompany Inc.;M
In the second case a confirmation email will be created, freely customizable at the page Settings > Confirmation request. Choose the appropriate list at the page Settings > Codes table in the administration console.
If the user clicks in the subscription link provided in the confirmation email he will be subscribed, otherwise he will remain among "Pending" users.
xmlSubscribe.aspx returns the following values:
0 : Subscription completed
1 : Generic error
2 : Invalid address
3 : User already subscribed
-1011: IP not registered
These values can be used in subscription procedures to differentiate the possible outcomes of the operation
Language Specific Code Samples
ASP.NET
The following code has been developed using C# language.
<script runat="server" language="C#"> void Subscribe() { string retCode = "1"; // if retCode = 1 returned value is an error code, if retCode = 0 returned value is the error text string ret_val = SubscribeUser(retCode); // Once the value has been returned it is possible to decide what to do/view // ******************************************************** // If retCode = 1 returned values are the following: // 0 : Operation completed // 1 : Generic error // 2 : Invalid email address // 3 : User already subscribed // ******************************************************** switch(ret_val) { case "0": // Display a message saying the user was subscribed successfully break; case "1": // Display a message saying the service is not accessible at the moment break; case "2": // Display a message saying the email address in an invalid address break; case "3": // Display a message saying that the user is already subscribed break; default: // Display a message saying the service is temporarily unavailable break; } //************************************************************************** // If retCode = 0 error text is returned //************************************************************************** // For example, the value ret_val can be associated to a Label object } // This function calls the user's registration page and returns an output value string SubscribeUser(string retCode) { string strEmail = Request.Params["email"]; // user's email address string intList = Request.Params["list"]; // list ID string intGroup = Request.Params["group"]; // group to which to subscribe the user (optional) string blnConfirm = "1"; //Confirmation request string csvFldNames = "Field1;Field2;Field3;Field4"; //Field names are taken from the Codes Table string csvFldValues = "Name;Surname;Company;M"; //Values are assigned to the corresponding fields in the same order as csvFldNames string result = ""; // returned value string url = "http://newsletter.nomedominio.tld/frontend/xmlSubscribe.aspx"; url += "?list=" + intList + "&group=" + intGroup + "&email=" + strEmail + "&confirm=" + blnConfirm.ToString() + "&csvFldNames=" + csvFldNames + "&csvFldValues=" + csvFldValues + "&retCode=" + retCode; System.Net.HttpWebRequest wreq = (System.Net.HttpWebRequest)System.Net.WebRequest.Create(url); wreq.Method = "GET"; wreq.Timeout = 10000; System.Net.HttpWebResponse wr = (System.Net.HttpWebResponse)wreq.GetResponse(); // If the page answers correctly the return value is obtained if (wr.StatusCode == System.Net.HttpStatusCode.OK) { System.IO.Stream s = wr.GetResponseStream(); System.Text.Encoding enc = System.Text.Encoding.GetEncoding("utf-8"); System.IO.StreamReader readStream = new System.IO.StreamReader( s, enc ); // vreturn value result = readStream.ReadToEnd(); } return result; } </script>
Classic ASP 3.0
In case the customer's portal has its own subscription forms, linked to other databases (e.g. to register to a database, to access a restricted area, to authenticate a user…) it is possible to add to the page code the following code, which allows to simultaneously record the data also within the MailUp console, with or without confirmation request.