Permette di eseguire un invio singolo di un messaggio email. Il messaggio da inviare può essere già esistente oppure essere creato durante l'esecuzione della richiesta. Performs a single sending of an email message, already existing or created as the request is executed.
Method parameters
- string SendSingleNewsletter(string accessKey, int listID, string subject, string type, string content, string recipientEmail, Option[] options)
- accessKey:
...
- access key obtained using the LoginFromId method
- listID: list identifier. Lists and corresponding IDs can be obtained calling the GetLists Method
- subject: subject of the email message
- type: type of message text source (HTML, URL, FILE, TEXT, ID)
- 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 (this value is deprecated and it is handled exactly as "HTML")
- 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
- type = ID, content
- message text source, depending on the type:
options: un array di coppie key/value per impostare le varie opzioni di invio. E' possibile specificare un sottoinsieme delle opzioni previste per i metodo CreateNewsletter e SendNewsletter:
- note: una stringa contenente delle note relative al messaggio
- dyn_fld: una valore booleano per abilitare/disabilitare l'utilizzo dei campi dinamici all'interno del messaggio
- is the identifier of the newsletter to be sent
- recipientEmail: email address of the recipient. If not already subscribed, recipient will be automatically added to the subscribers of specified list (message is sent also in this case)
- options: an array of key/value pairs for options setting. A subset of the options listed for the CreateNewsletter Method and SendNewsletter Method is available for this method as well.
- 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 among track_http, track_https, track_mailto, track_ftp, track_news,
- tracking of all protocols is activated. In order to disable a protocol, specify the corresponding parameter
- 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
- from_email:
- a string containing the sender email address. If not specified, the default value for the list will be used
- from_name:
- campo1 … campo<nn> = è possibile indicare uno o più campi anagrafici da aggiornare per il destinatario specificato. Vengono gestiti esattamente come le opzioni corrispondenti del metodo SendNewsletter per un destinatario singolo (quindi non devono essere specificati i ; come separatore)
...
- a string containing the sender name. If not specified, the default value for the list will be used
- campo1… campo<nn> = you can indicate one or more personal data fields to be updated for the recipient of this message. They work exactly like as in the WS_MailUpSend.SendNewsletter, but referred to a single recipient: as a consequence, the character ";" is not required as a separator
If error code=0, the message will contain the ID of the sending
Sample SendSingleNewsletter Method
Code Block | ||||
---|---|---|---|---|
| ||||
<SendSingleNewsletterResult>
<errorCode>0</errorCode>
<errorDescription>Message sent to support@mailup.it</errorDescription>
</SendSingleNewsletterResult> |