...
...
...
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
- is the HTML code of the message
- type = TEXT, content
- is the PLAIN-
- TEXT of the message
- type = URL, content
- is the url from which to draw the HTML code of the message
- type = FILE, content
- 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:
- a string containing notes about the message
- dyn_fld:
- boolean value to enable/disable the use of dynamic fields in the message (dyn_fld=true, dyn_fld=false)
- emb_img:
- boolean value to enable/disable the use of embedded images in the message (emb_img=true, emd_img=false)
- link_track:
- boolean value to enable/disable the use of link tracking in the message (link_trcak=true, link_track=false).
- If link_track=true
- and no other option is specified all the protocols are activated.
- track_http:
- boolean value to enable/disable the use of http protocol tracking in the message (track_http=true, track_http=false)
- track_https:
- boolean value to enable/disable the use of HTTPS protocol tracking in the message (track_https=true, track_https=false)
- track_mailto:
- boolean value to enable/disable the use of MAILTO protocol tracking in the message (track_mailto=true, track_mailto=false)
- track_ftp:
- boolean value to enable/disable the use of FTP protocol tracking in the message (track_ftp=true, track_ftp=false)
- track_news:
- boolean value to enable/disable the use of NEWS protocol tracking in the message (track_news=true, track_news=false)
- link_params:
- a string allowing to specify additional parameters for tracked links
- body_code:
- 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
- attach<nn>_name =
- filename
- template =
- ID of the template to be used for newsletter creation. In case the "template" parameter is specified, "body_code"
- and "content"
...
- 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 | ||||
---|---|---|---|---|
| ||||
<CreateNewsletterResult>
<errorCode>0</errorCode>
<errorDescription></errorDescription>
<listID>1</listID>
<newsletterID>3</newsletterID>
</CreateNewsletterResult> |