API technical details

Subscribe.aspx

This function is contained in predefined subscription forms : it allows users to subscribe to a newsletter using a double opt-in signup 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

Numero di cellulare (opzionale): Per consentire la registrazione del numero di cellulare è sufficiente aggiungere al form i seguenti campi: 
<input id="prefix" value="0039" type="text" name="prefix" />
<input id="sms" type="text" name="number" />
Nota: il campo prefisso (corrisponde al prefisso internazionale) non deve essere necessariamente implementato come campo separato, può essere inserito direttamente nel campo "number", tuttavia si suggerisce di tenerlo separato per maggiore chiarezza.
Gruppi (opzionali): 
<input name="group" type="checkbox" value="1"> Primo gruppo <br>
<input name="group" type="checkbox" value="2"> Secondo gruppo <br> 
Se invece si volesse fare in modo che l'indirizzo sia inserito in 3 gruppi, senza dare all'utente la possibilità di scelta, è sufficiente cambaire il type con "hidden", come nell'esempio sotto: 
<input name="group" type="hidden" value="2,8,10"> 
In questo modo viene inserito automaticamente nei gruppi 2,8,10. L'ID del gruppo è consultabile sulla console MailUp in _ImpostazioniTabelle Codici_ 
Campi anagrafici (opzionali):
<input name="campo1" type="text" size="60" maxlength="100"> Nome
<input name="campo2" type="text" size="60" maxlength="100"> Cognome 
Nel form sarà a cura del Cliente l'impostazione di campi, tendine, grafica, colori, stili, checkbox, controlli, liberamente in base alle proprie esigenze. I campi non necessari possono essere rimossi dai form di iscrizione presi come esempio.
È necessario usare la nomenclatura "campo1", "campo2"… "campoN" di MailUp, sono ignorati i casi in cui il valore specificato come "name" non è riconosciuto. 
Tutte le variabili da passare (name=list, group, campo1, campo2…) possono essere di qualunque tipologia (type=checkbox, text, radio, button…) e possono assumere qualunque valore (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)

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:

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

VALORI RESTITUITI

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:

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

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