Versions Compared

Old Version 1

changes.mady.by.user Massimo Arrigoni

Saved on

compared with

New Version 2

changes.mady.by.user Stefano Mantegazza

Saved on

Key

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

...

...

...

Method parameters

Allows the creation of an email message within the desired list.

  • string CreateNewsletter(string accessKey, int listID, string subject, string type, string content, Option[] options)
  • accessKey:

...

  •  access key obtained using the Login method
  • listID: ID of the list within which the newsletter has to be created. Lists and corresponding IDs can be obtained calling the GetLists Method
  • subject: subject of the email message
  • type: type of message text (HTML, URL, FILE, TEXT)
  • content:

...

  • message text source, depending on the type:
    • type = HTML, content
    è il codice HTML del messaggio
    • is the HTML code of the message
    • type = TEXT, content
    è il
    • is the PLAIN-
    TEXT del messaggio
    • TEXT of the message
    • type = URL, content
    è l'url da quale ricavare in codice HTML del messaggio
    • is the url from which to draw the HTML code of the message
    • type = FILE, content
    è uno array di byte che rappresenta il file dal quale ricavare il codice HTML del messaggio
    • is a byte array from which to draw the HTML code of the message
  • options:

...

  • an array

...

  • of key/value

...

  • pairs for options setting
    • note:
    una stringa contenente delle note relative al messaggio
    • a string containing notes about the message
    • dyn_fld:
    una valore booleano per abilitare/disabilitare l'utilizzo dei campi dinamici all'interno del messaggio
    • boolean value to enable/disable the use of dynamic fields in the message (dyn_fld=true, dyn_fld=false)
    • emb_img:
    un valore booleano per abilitare/disabilitare l'utilizzo di immagini embedded all'interno del messaggio
    • boolean value to enable/disable the use of embedded images in the message (emb_img=true, emd_img=false)
    • link_track:
    una valore booleano per abilitare/disabilitare il tracciamento dei link
    •  boolean value to enable/disable the use of link tracking in the message (link_trcak=true, link_track=false).
    Se
    • If link_track=true
    e non viene specificato nessun'altra opzione si considera abilitato il tracciamento di tutti i protocolli
    • and no other option is specified all the protocols are activated.
    • track_http:
    una valore booleano per abilitare/disabilitare il tracciamento del protocollo http
    • boolean value to enable/disable the use of http protocol tracking in the message (track_http=true, track_http=false)
    • track_https:
    una valore booleano per abilitare/disabilitare il tracciamento del protocollo HTTPS
    • boolean value to enable/disable the use of HTTPS protocol tracking in the message (track_https=true, track_https=false)
    • track_mailto:
    una valore booleano per abilitare/disabilitare il tracciamento del protocollo MAILTO
    • boolean value to enable/disable the use of MAILTO protocol tracking in the message (track_mailto=true, track_mailto=false)
    • track_ftp:
    una valore booleano per abilitare/disabilitare il tracciamento del protocollo FTP
    • boolean value to enable/disable the use of FTP protocol tracking in the message (track_ftp=true, track_ftp=false)
    • track_news:
    una valore booleano per abilitare/disabilitare il tracciamento del protocollo NEWS
    • boolean value to enable/disable the use of NEWS protocol tracking in the message (track_news=true, track_news=false)
    • link_params:
    una stringa che permette di specificare dei parametri aggiuntivi per i link tracciati
    • a string allowing to specify additional parameters for tracked links
    • body_code:
    una stringa che contiene un codice personalizzato del TAG <body>
  • header: una stringa che contiene un codice personalizzato del TAG <header>
  • conf_msg: un valore booleano per marcare la newsletter come messaggio di conferma iscrizione.
    • a string containing a personalized code for the <body> tag
    • header: a string containing a personalized code for the <header> tag
    • conf_msg: boolean value to mark the message used as a subscription confirmation
    • attach<nn>_data = base64 file encoding
    del file
    • attach<nn>_name =
    nome del file
    • filename
    • template =
    identificativo del template da utilizzare per la creazione della newsletter. In caso venga specificata le opzioni "template"
    • ID of the template to be used for newsletter creation. In case the "template" parameter is specified, "body_code"
    e il parametro
    • and "content"
    e non vengono presi in considerazione.

...

    • parameters will be ignored.

If error code=0, the message will contain the ID of the newsletter which is created

Sample CreateNewsletter response

Code Block
languagehtml/xml
linenumberstrue
<CreateNewsletterResult>
<errorCode>0</errorCode>
<errorDescription></errorDescription>
<listID>1</listID>
<newsletterID>3</newsletterID>
</CreateNewsletterResult>