Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

Method parameters

Sends a newsletter

  • string SendNewsletter(string accessKey, int listID, int newsletterID, Option[] options)
  • accessKey:

...

  •  access key obtained using the Login method
  • newsletterID: identificativo del messaggio ritornato dal metodo CreateNewsletter options: un array di coppie key/value per impostare le varie opzioni di invio
    • from_email:
    una stringa che contiene l'email mittente, se non indicato verrà utilizzato il valore impostato per la lista;
    • a string containing the sender email address. If not specified, the default value for the list will be used
    • from_name:
    una stringa che contiene il nome del mittente, se non indicato verrà utilizzato il valore impostato per la lista;
    •  a string containing the sender name. If not specified, the default value for the list will be used
    • clear_stats:
    un valore booleano, abilita/disabilita la cancellazione delle statistiche relative ad eventuali invii precedenti della stessa newsletter.
    • a boolean value to enable/disable the deletion of statistics referred to previous mailings of the same message
    • send_to:
    (obbligatorio) una stringa che indica a chi deve essere fatto l'invio.
    • a mandatory string indicating to whom the message will be sent. If send_to=ALL
    invia a tutti gli iscritti,
    • the message is sent to all subscribers, if send_to=RECIPIENTS
    invia ad un elenco di indirizzi email,
    • the message is sent to specific email addresses, if send_to=GROUPS
    invia agli iscritti appartenenti a determinati gruppirecipients: una stringa che identifica i destinatari dell'invio. Assume un significato diverso a seconda del valore send_to.
    • the message is sent to subscribers to specific groups
    • recipients: a string indicating the recipients of the message. Its content depends on the value assumed by "send_to". If send_to = ALL,
    l'eventuale parametro recipients viene ignorato e il messaggio verrà inviato a tutti gli iscritti della listasend
    • "recipients" parameter is ignored and the message is sent to all the recipients in the list; if send_to=RECIPIENTS,
    il parametro recipients contiene un elenco di indirizzi email separati dal carattere ;
    • "recipients" parameter contains a list of email addresses separated by ";" character; if send_to=GROUPS, il
    parametro recipients contiene l'elenco dei gruppi (identificativi) separati dal carattere ; ai quali dovrà essere inviato il messaggio
    • "recipients" parameter contains the IDs of the recipient groups, separated by the ";" character 
    • exclude: una stringa contenente l'elenco dei gruppi (identificativi) separati dal carattere ; da escludere dall'invio
    • filters: una stringa contenente l'elenco dei filtri (identificativi) separati dal caratteri ; da utilizzare per individuare gli utenti ai quali dovrà essere inviato il messaggio.
    • filters_as: una stringa che indica la modalità di applicazione degli eventuali filtri indicatifilters_as=AND, tutti i filtri devono essere soddisfattifilters_as=OR, almeno uno dei filtri deve essere soddisfatto
    • deliverydt: una stringa contenente la data e l'ora per la quale deve essere schedulato la partenza dell'invio. Il formato deve essere il seguente: yyyyMMddHHmmss. Se non specificato l'invio inizia immediatamente ed in caso di invio già in corso il messaggio viene accodato a quelli in uscita.
    • timezone: un intero che identifica il fuso orario.
    • campo1 … campo<nn> = nel caso l'opzione recipients contenga l'elenco degli indirizzi email è possibile indicare uno o più campi anagrafici da aggiornare. Ogni option "campo<nn>" è una stringa contenente i valori per il campo anagrafico <nn> per gli indirizzi email indicati nell'opzione "recipients". Anche in questo caso, i valori devo essere separati dal carattere ;.

Se il codice di errore è 0, il messaggio conterrà l'identificativo del'invio.
Esempio di messaggio SendNewsletterResult:
<SendNewsletterResult>
<errorCode>0</errorCode>
<errorDescription>0</errorDescription>
<listID>1</listID>
<newsletterID>1</newsletterID>
<deliveryStatus>Sending in progress</deliveryStatus>
</SendNewsletterResult>

Come specificare i campi anagrafici


E' importante che il numero di elementi indicati per ogni option "campo<nn>" sia uguale al numero di indirizzi specificati nella option "recipients".
Si supponga di voler effettuare un invio a tre indirizzi email: recipients=m.rossi@example.com;m.bianchi@example.com;p.verdi@example.com
Se, ad esempio, si vogliono specificare i dati anagrafici Nome e Cognome, supponendo che nella nostra anagrafica siano rispettivamente campo1 e campo2, questi vanno indicati nel seguente modo:
campo1=Mario;Mauro;Paolo
campo2=Rossi;Bianchi;Verdi
Nel caso un campo anagrafico sia vuoto, questo va comunque indicato, questo per aver sempre un ugual numero di elementi:
campo1=Mario;;Paolo
campo2=Rossi;;Verdi
(per il secondo indirizzo email non sono stati indicati i campi anagrafici)