Table of Contents |
---|
Subscribe.aspx
You can use subscribe.aspx as the form handler from a form hosted on your Web site. It allows you to offer your Web site visitors a way to sign up for your newsletter(s), while giving you full control on the look & feel of the signup form. By default the signup process uses the double opt-in method (confirmed opt-in).
The signup form must be structured as described below:
- the field “name” attribute for each field must match the corresponding code that can be located under Settings > Codes Table in your MailUp admin console
- the field "type" is entirely up to you
Codes Table
Info | ||
---|---|---|
| ||
The field code uses the word "CAMPO" because MailUp's original source code was developed in Italy. "Campo" means "Field" in Italian |
Subscription form action
...
language | html/xml |
---|
...
...
...
The parameters for calling subscribe.aspx are described below.
Email field (required)
...
...
...
...
Info | ||
---|---|---|
| ||
In case a user subscribes to more than one list, the system will still only send one confirmation request message, which will allow the user to confirm their subscription to all the lists included in the signup request. Note that the system will use the message templates (e.g. subscription confirmation request message and subscription confirmation message), as well as the Web page templates defined for the first List that the user was subscribed to. |
The “value” field must contain the ID of the list the user will be subscribed to. You can see that numeric value shown in the MailUp admin console under Settings > Edit lists or looking at the dropdown menu at the top left of the page. In the image, the list called "New products" has value=3.
Mobile phone number (optional)
You can use the mobile number field to record the customer's mobile number in the database and be able to send text messages to them.
Code Block | ||
---|---|---|
| ||
<input id="prefix" value="001" type="text" name="prefix" />
<input id="sms" type="text" name="number" /> |
Please note that the field “prefix” (international prefix) needs not be entered as a separate field, it can also be inserted in the field “number”. We recommend passing it as a separate field for clarity’s sake.
Groups (optional)
...
...
...
...
...
...
...
...
...
...
...
...
...
...
If you want the user to be subscribed to one or more groups, without presenting a choice, simply set the type as “hidden”, as in the example below:
...
...
...
In the example above, the user is automatically subscribed to groups 2, 8 and 10. The Group IDs are listed in your MailUp admin console under Settings > Codes table.
Other personal data fields (optional)
You can ask your users or customers to provide any other piece of information that will be saved in the Personal Data Fields that have been setup under Manage > Personal Data Fields.
...
...
...
...
The field type is entirely up to you. See the section above for details about the Codes Table.
Modifying the sender email and name
...
...
...
...
...
...
...
...
...
...
...
...
...
This allows to send a subscription confirmation message with a personalized sender. When both have been specified, they will be set as the values in the “From” field, while the default name and email address for the MailUp list will be used for the “Sender” field. So, on many clients this message will be viewed as “sent by Sender on behalf of From”. A confirmation email like this contains a link to the newsletter management system to complete the subscription, while, if the recipient replies to the email message (“Reply to”), the reply will be sent to the address indicated in the “From” field. This practice is very useful when a confirmation email is sent to an acquaintance: the invitation is much more effective if the person who invites is among the senders of the email (in the “From” field).
Xmlsubscribe.aspx (User subscription)
This function is similar to the previous one: the main differences is in the format with which the parameters are defined, and in the fact that "xmlSubscribe" returns an output code with information about the outcome of the operation. If you wish to create a form that subscribes the user to more than one list at the same time, and sends only one confirmation email, use the "subscribe.aspx" API described above.
URL
The URL to use depends on your MailUp account's unique URL. If your MailUp admin console address is xyzw.espsrv.com, the correct action URL for the form (the URL of the form handler) will be http://xyzw.espsrv.com/frontend/xmlSubscribe.aspx
REQUEST PARAMETERS
Name | Mandatory? | Description |
N (1) | User email address | |
Sms | N (1) | User mobile number, with international prefix (2) |
List | Y | List ID |
Group | N | Groups to which to subscribe the user |
Confirm | N | Parameter to enable or disable confirmation request email. Accepted values: 0/1. Default value: 1 |
csvFldNames | N | Personal data codes (separated by the ";" character) |
csvFldValues | N | Values related to personal data codes (separated by the ";" character) |
retCode | N | Parameter to enable or disable the return of an output code for the call. Accepted values: 0/1 – Default value: 0 |
Dynsndmail(3) | N | "dynamic sender e-mail address" Sender address in the confirmation request email (If blank, default value for the list will be used) |
dynsndname(3) | N | "dynamic sender name" Sender name in the confirmation request email (If blank, default value for the list will be used) |
...
RESPONSE VALUES
CODE | DESCRIPTION |
---|---|
0 | Operation completed successfully / Either email address or mobile number has been changed |
1 | Generic error |
2 | Invalid email address or mobile number |
3 | User already subscribed |
-1011 | IP not registered |
This function performs a check on a user subscription status Xmlchksubscriber.aspx (User subscription check)
URL
The URL to use depends on your MailUp account's unique URL. If your MailUp admin console address is xyzw.espsrv.com, the correct action URL for the form (the URL of the form handler) will be http://xyzw.espsrv.com/frontend/Xmlchksubscriber.aspx
REQUEST PARAMETERS
Name | Mandatory? | Description |
ListGuid | Y | Alphanumeric code associated to a distribution list |
List | Y | List ID |
N (1) | User email address | |
Sms | N (1) | User mobile number, with international prefix (2) |
...
RESPONSE VALUES
CODE | DESCRIPTION |
1 | Generic error / user not subscribed |
2 | User subscribed (OPT-IN) |
3 | User unsubscribed (OPT-OUT) |
4 | User subscription to be confirmed (PENDING) |
Info |
---|
NOTE: Code 1 is given as output value both in case of error (e.g. when ListGuid code does not match ListID) and when the user is not a subscribed user. |
Xmlunsubscribe.aspx (User unsubscription)
This function forces the unsubscription of a subscriber from a list.
URL
The URL to use depends on your MailUp account's unique URL. If your MailUp admin console address is xyzw.espsrv.com, the correct action URL for the form (the URL of the form handler) will be http://xyzw.espsrv.com/frontend/Xmlunsubscribe.aspx
REQUEST PARAMETERS
Name | Mandatory? | Description |
ListGuid | Y | Alphanumeric code associated to a distribution list |
List | Y | List ID |
N (1) | User email address | |
Sms | N (1) | User mobile number, with international prefix (2) |
...
...
...
...
...
...
3
...
User unknown / already unsubscribed
Info |
---|
NOTE: If successfully unsubscribed, the user will be moved to unsubscribers and will receive an unsubscription confirmation email, if this option has been selected |
Updsubscriber.aspx (User update)
This function allows to update a user's personal data.
URL
The URL to use depends on your MailUp account's unique URL. If your MailUp admin console address is xyzw.espsrv.com, the correct action URL for the form (the URL of the form handler) will be http://xyzw.espsrv.com/frontend/Updsubscriber.aspx
REQUEST PARAMETERS
Name | Mandatory? | Description |
ListGuid | Y | Alphanumeric code associated to a distribution list |
List | Y | List ID |
N (1) | User email address | |
Sms | N (1) | User mobile number, with international prefix (2) |
Replace | N | Parameter to enable or disable group replacement for the specified user. Accepted values: 0/1/false/true – Default value: false |
Group | N | Groups to which to subscribe the user |
csvFldNames | N | Personal data codes (separated by the ";" character) |
csvFldValues | N | Values related to personal data codes (separated by the ";" character) |
...
RESPONSE VALUES
...
CODE
...
DESCRIPTION
...
0
...
Data updated successfully
...
1
...