Versions Compared

Key

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

Method parameters

...

  • string SendNewsletter(string accessKey, int listID, int newsletterID, Option[] options)
  • accessKey: access key obtained using the Login method
  • newsletterID: Id of the message returned by the CreateNewsletter Method
  • options: an array of key/value pairs for options setting
    • from_email: a string containing the sender email address. If not specified, the default value for the list will be used
    • from_name: a string containing the sender name. If not specified, the default value for the list will be used
    • clear_stats: a boolean value to enable/disable the deletion of statistics referred to previous mailings of the same message
    • send_to: a mandatory string indicating to whom the message will be sent. If send_to=ALL the message is sent to all subscribers, if send_to=RECIPIENTS the message is sent to specific email addresses, if send_to=GROUPS 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, "recipients" parameter is ignored and the message is sent to all the recipients in the list; if send_to=RECIPIENTS, "recipients" parameter contains a list of email addresses separated by the ";" character; if send_to=GROUPS, the "recipients" parameter contains the IDs of the recipient groups, separated by the ";" character 
    • exclude: a string containing the IDs of the groups to be excluded from the sending, separated by the ";" character
    • filters: a string containing the IDs of the filters separated by the ";" character, to be used to retrieve the recipients of the message
    • filters_as: a string indicating how to apply the filters: if filters_as=AND, all the conditions in the filters have to be met; if filters_as=OR, at least one of them
    • deliverydt: a string containing date and time of scheduled delivery, in the format yyyyMMddHHmmss. If not specified, the sending starts immediately, and in case another sending is in progress the message is queued
    • timezone: an integer indicating the time zone
    • campo1… campo<nn> = in case the "recipients" parameter contains a list of email addresses, it is possible to indicate one or more personal data fields to be updated. Each option "campo<nn>" is a string containing the values for the personal data field <nn> referred to the email  addresses addresses indicated in the "recipients" parameter. Values must be separated by the ";" character

...