Subscribe.aspx

 

This function is contained in predefined subscription forms: it allows users to sign up to a newsletter using a double opt-in method.

Form must be structured as follows, while “name” attributes can be drawn from the page Settings > Codes table in the MailUp console. Please note that any “type” can be set for all parameters, as it is arbitrary.

 

Subscription form action:

 

 

<form method="post" action="http://esempio.emailsp.net/frontend/subscribe.aspx">

 

 

Action address is linked to the console address. If the console address is xyzw.espsrv.com, correct action is http://xyzw.espsrv.it/frontend/subscribe.aspx. Parameters for calling subscribe.aspx function are described below

 

Email field (mandatory):

 

<input name="email" type="text" size="60" maxlength="100"> 


Fields related to distribution lists (mandatory):


<input type="hidden" name="list" value="1"> 

 

If you wish to let the user choose more than one list, it is possible to list them using the same name every time, for example:

 

<input name="list" type="checkbox" value="2">Seconda lista <br>


<input name="list" type="checkbox" value="3">Terza lista <br> 

 

If you wish to subscribe a user to more than a list, without him choosing one of them, you can use:

<input type="hidden" name="list" value="1,2,3"> 

 

In case a user subscribes to more than a list, the system will send just one confirmation email, which will enable the subscription to all the lists. Conventionally, the system will use the confirmation email and the message pages of the first of the enabled lists (list 1 in the example above)

The “value” field must contain the ID of the list the user subscribes to; list ID can be found at the page Settings > Edit lists or looking at the dropdown menu at the top left of the page. In the image below, the list called "Business" has value=3.



Dropdown menu for list selection

 

 

Mobile number (optional): To record the mobile number the following fields must be added to the form:

<input id="prefix" value="0039" type="text" name="prefix" />
<input id="sms" type="text" name="number" />

Please note that the field “prefix” (international prefix) need not be entered as a separate field, it can also be inserted in the field “number”. Anyway we suggest that it should be kept separated for clarity’s sake.


Groups (optional): 


<input name="group" type="checkbox" value="1"> First group <br>
<input name="group" type="checkbox" value="2"> Second group <br> 

 

If you want the user to be subscribed to different groups, without choice, type must be “hidden”, as in the example given below:


<input name="group" type="hidden" value="2,8,10"> 

 

This way, the user is automatically subscribed to groups 2,8 and 10. Group IDs are listed at the page Settings > Codes table in the MailUp console.


Personal data fields (optional):

 
<input name="campo1" type="text" size="60" maxlength="100"> Nome
<input name="campo2" type="text" size="60" maxlength="100"> Cognome 

 

In the form it is the customer’s responsibility to set the fields, dropdown menus, colors, styles, checkboxes, controls, freely based on one’s needs. The fields which are not necessary can be removed from the registration form. If there are extra fields with names which are not recognized, they will be ignored.


All parameters to be passed (name=list, group, field1, field2…) can be of any type (type=checkbox, text, radio, button…) and they can assume any value.



Figura 12: Esempio di TABELLA CODICI. Per visualizzarla, entrare in MailUp, menu Impostazioni, "TABELLE CODICI" 

Campi per modificare nome e/o indirizzo e-mail del mittente:
<input type="hidden" name="dynsndmail" value="email@example.com" > 
<input type="hidden" name="dynsndname" value="Nome Cognome"> 
È possibile specificare i campi sopra riportati nei casi si volesse sostituirli ai valori preimpostati per la lista.
Questi campi consentono l'invio di messaggi di conferma iscrizione con mittente personalizzato ed in particolare, nel solo caso in cui siano definiti entrambi, il risultato è il seguente: i valori specificati saranno impostati nell'intestazione della mail come campo "From" dell'intestazione, mentre il nome e l'indirizzo predefiniti come mittenti per la lista MailUp sono impostati come campo "Sender". Ne consegue quindi che su molti client di posta il messaggio ricevuto risulterà come inviato "da Sender per conto di From" Un e-mail di richiesta conferma così impostata conterrà un link che riconduce al sistema di gestione della newsletter per finalizzare l'iscrizione, mentre se il destinatario decidesse di rispondere all'e-mail ("Reply To") la mail di risposta sarà indirizzata sarà all'indirizzo specificato come "From". Questa modalità risulta utile nei casi di e-mail di richiesta conferma in cui si vuole proporre l'iscrizione ad una newsletter ad un conoscente: l'invito è molto più efficace se chi ha fatto l'invito compare (come "From") tra i mittenti dell'e-mail. 
La compilazione dei campi in questione è comunque facoltativa, nel caso in cui non siano specificati entrambi l'e-mail di richiesta conferma viene inviata compilando il solo campo "From" con i valori preimpostati per la lista. 

Updsubscriber.aspx (User update)


 

Questa funzione consente una modifica all'anagrafica di un utente. 
URL: http://newsletter.nomedominio.tld/frontend/xmlUpdSubscriber.aspx 
PARAMETRI IN INGRESSO:

NOME

OBBL.

DESCRIZIONE

ListGuid

SI

Codice alfanumerico proprio della lista di distribuzione

List

SI

Codice lista di distribuzione

Email

NO (1)

Indirizzo e-mail dell'utente

Sms

NO (1)

Numero di cellulare dell'utente, comprensivo di prefisso internazionale (2)

Replace

NO

Parametro per abilitare o meno la sostituzione dei gruppi per l'utente specificatoValori accettati: 0/1/false/true – Valore di default: false

Group

NO

I gruppi nei quali iscrivere l'utente

csvFldNames

NO

codici dei campi anagrafici (separati da (wink)

csvFldValues

NO

valori corrispondenti ai codici dei campi anagrafici (separati da (wink)


(1) deve essere specificato almeno uno dei parametri email e sms
(2) se non specificato verrà utilizzato il prefisso internazionale italiano (0039) 
VALORI RESTITUITI

CODICE

DESCRIZIONE

0

Modifica completata con successo

1

Errore generico

Xmlchksubscriber.aspx (User subscription check)


Questa funzione consente la verifica sullo stato di iscrizione di un utente. 
URL: http://newsletter.nomedominio.tld/frontend/xmlChkSubscriber.aspx 
PARAMETRI IN INGRESSO:

NOME

OBBL.

DESCRIZIONE

ListGuid

SI

Codice alfanumerico proprio della lista di distribuzione

List

SI

Codice lista di distribuzione

Email

NO (1)

Indirizzo e-mail dell'utente

Sms

NO (1)

Numero di cellulare dell'utente, comprensivo di prefisso internazionale (2)


(1) deve essere specificato almeno uno dei parametri email e sms
(2) se non specificato verrà utilizzato il prefisso internazionale italiano (0039) 
VALORI RESTITUITI

CODICE

DESCRIZIONE

1

Errore generico / utente non iscritto

2

Utente iscritto (OPT-IN)

3

Utente disiscritto (OPT-OUT)

4

Utente in attesa di conferma iscrizione (PENDING)



NOTA:
Il codice 1 viene restituito sia in caso di errore (ad esempio il ListGuid non corrisponde alla lista specificata) che in caso di utente non iscritto 

 

Xmlsubscribe.aspx (User subscription)

 

Questa funzione è analoga alla precedente, le principali differenze consistono nel formato con cui si specificano i parametri e nal fatto che la xmlSubscribe restituisce un codice di ritorno con informazioni sull'esito dell'operazione. 
Per creare un form che iscrive a più liste contemporaneamente, inviando una sola email di richiesta conferma, utilizzare l'API subscribe.aspx descritta nel precedente paragrafo. 
URL: http://newsletter.nomedominio.tld/frontend/xmlSubscribe.aspx (sostituire la parte in rosso con il dominio di terzo livello corretto)
(OBBL. = Obbligatorio) 
PARAMETRI IN INGRESSO:

 

NOME

OBBLIGATORIO.

DESCRIZIONE

Email

NO (1)

Indirizzo e-mail dell'utente

Sms

NO (1)

Numero di cellulare dell'utente, comprensivo di prefisso internazionale (2)

List

SI

Lista di distribuzione

Group

NO

I gruppi nei quali iscrivere l'utente

Confirm

NO

parametro per abilitare o meno l'email di richiesta confermaValori accettati: 0/1 e di default: 1

csvFldNames

NO

codici dei campi anagrafici (separati da (wink)

csvFldValues

NO

valori corrispondenti ai codici dei campi anagrafici (separati da (wink)

retCode

NO

Parametro per abilitare o meno la restituizione del codice di ritorno della chiamataValori accettati: 0/1 – Valore di default: 0

Dynsndmail(3)

NO

"dynamic sender e-mail address" Indirizzo e-mail del mittente nell'e-mail di richiesta conferma (se non specificato viene usato il valore di default specificato per la lista)

dynsndname(3)

NO

"dynamic sender name" Nome del mittente nell'e-mail di richiesta conferma (se non specificato viene usato il valore di default specificato per la lista)



(1) deve essere specificato almeno uno dei parametri email e sms
(2) se non specificato verrà utilizzato il prefisso internazionale italiano (0039)
(3) per ulteriori dettagli sull'utilizzo di questi campi consultare la descrizione dei campi omonimi per la pagina subscribe.aspx 

VALORI RESTITUITI

 

CODICE

DESCRIZIONE

0

Operazione completata con successo

1

Errore generico

2

Indirizzo email/numero cellulare non valido

3

Utente già iscritto


Nota: per conoscere il dominio di terzo livello utilizzato è sufficiente entrare in MailUp e guardare l'indirizzo della propria console. Ad esempio in figura sotto tale dominio è "v73.s02.it" 
 
Figura 13: indicazione del dominio di terzo livello per una certa console 

 

 

Xmlunsubscribe.aspx (User unsubscription)

 

Questa funzione forza la disiscrizione di un utente da una lista. 
URL: http://newsletter.nomedominio.tld/frontend/xmlUnSubscribe.aspx 
PARAMETRI IN INGRESSO:

 

NOME

OBBL.

DESCRIZIONE

ListGuid

SI

Codice alfanumerico proprio della lista di distribuzione

List

SI

Codice lista di distribuzione

Email

NO (1)

Indirizzo e-mail dell'utente

Sms

NO (1)

Numero di cellulare dell'utente, comprensivo di prefisso internazionale (2)

 


(1) deve essere specificato almeno uno dei parametri email e sms
(2) se non specificato verrà utilizzato il prefisso internazionale italiano (0039) 
VALORI RESTITUITI

 

CODICE

DESCRIZIONE

0

Utente disiscritto con successo

1

Errore generico

3

Utente non esistente / già disiscritto

 


NOTA:
In caso di esito positivo l'utente verrà spostato tra gli opt-out e gli verrà inviata una email di conferma dove previsto