{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Used to send a bulk email campaign. It supports scheduling of the campaign (if a schedule is not specified, the message is queued up immediately).","type":"text"}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{},"macroMetadata":{"schemaVersion":{"value":"1"},"title":"Table of Contents"}}}},{"type":"rule"},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Method parameters","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#0000ff"}}]},{"text":" SendNewsletter(","type":"text"},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#0000ff"}}]},{"text":" accessKey, ","type":"text"},{"text":"int","type":"text","marks":[{"type":"textColor","attrs":{"color":"#0000ff"}}]},{"text":" listID, ","type":"text"},{"text":"int","type":"text","marks":[{"type":"textColor","attrs":{"color":"#0000ff"}}]},{"text":" newsletterID, ","type":"text"},{"text":"Option","type":"text","marks":[{"type":"textColor","attrs":{"color":"#2b91af"}}]},{"text":"[] options)","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"accessKey","type":"text","marks":[{"type":"em"}]},{"text":": access key obtained using the ","type":"text"},{"text":"LoginFromId","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/mailupapi/pages/36342058"}}]},{"text":" method","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"newsletterID","type":"text","marks":[{"type":"em"}]},{"text":": Id of the message returned by the ","type":"text"},{"text":"WS_MailUpSend.CreateNewsletter","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/mailupapi/pages/36340297"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"options","type":"text","marks":[{"type":"em"}]},{"text":": an array of key/value pairs for options setting","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"from_email: a string containing the sender email address. If not specified, the default value for the list will be used","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"from_name: a string containing the sender name. If not specified, the default value for the list will be used","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"clear_stats: a boolean value to enable/disable the deletion of statistics referred to previous mailings of the same message","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"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","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"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 ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"exclude: a string containing the IDs of the groups to be excluded from the sending, separated by the \";\" character","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"filters: a string containing the IDs of the filters separated by the \";\" character, to be used to retrieve the recipients of the message","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"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","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"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","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"timezone: an integer indicating the time zone","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"campo1… campo = in case the \"recipients\" parameter contains a list of email addresses, you can indicate one or more personal data fields to be updated. Each option \"campo\" is a string containing the values for the personal data field referred to the email addresses indicated in the \"recipients\" parameter. Values must be separated by the \";\" character","type":"text"}]}]}]}]}]}]}]},{"type":"paragraph","content":[{"text":"If error code=0, the message will contain the ID of the sending","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"SOAP Examples","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Sample requests","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"SOAP request (RECIPIENTS, immediate)","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"html/xml"},"content":[{"text":"\n\t\n\t\n\t\t \n\t\t\tHzAgwRRJaAKBtkgNWpkAuURfV4SxMm6T3HJegRuSkUivKJElNNcmSQe8nqGyoM9\n\t\t\t2\n\t\t\t84\n\t\t\t\n\t\t\t\t send_to RECIPIENTS \n\t\t\t\t from_name Your favorite dealer \n\t\t\t\t recipients mike@example.com \n\t\t\t\n\t\t\n\t\n","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"SOAP request (ALL, immediate)","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"html/xml"},"content":[{"text":"\n \n \n \n\tHzAgwRRJaAKBtkgNWpkAuURfV4SxMm6T3HJegRuSkUivKJElNNcmSQe8nqGyoM9\n\t2\n\t84\n\t\n\t\t send_to ALL \n\t\t from_name Your favorite dealer \n \n \n \n","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"SOAP request (RECIPIENTS, scheduled)","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"html/xml"},"content":[{"text":"\n\n\n\t\n\tHzAgwRRJaAKBtkgNWpkAuURfV4SxMm6T3HJegRuSkUivKJElNNcmSQe8nqGyoM9\n\t2\n\t84\n\t\n\t\t send_to RECIPIENTS \n\t\t from_name Your favorite dealer \n\t\t from_email test@nweb.it \n\t\t recipients mike@example.com \n\t \n\t\t\n\t\t deliverydt 20120904143000 \n\t\t timezone 0 \n\t\n\t\n\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Sample responses","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"SOAP response (immediate)","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"html/xml"},"content":[{"text":"\n\t0\n\t\n\t2\n\t84\n\t179\n\tSending in progress\n","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"SOAP response (scheduled)","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"html/xml"},"content":[{"text":"\n\t0\n\t\n\t2\n\t84\n\t190\n\tDelivery scheduled at 04/09/2012 14:30:00 GMT 1\n","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Recipient fields (merge tags)","type":"text"}]},{"type":"paragraph","content":[{"text":"You can pass to the system values that will be saved in the recipient database as ","type":"text"},{"text":"Recipient fields","type":"text","marks":[{"type":"link","attrs":{"href":"https://helpmailup.atlassian.net/wiki/pages/createpage.action?spaceKey=MUG&title=Recipient%20fields"}}]},{"text":", and can be used in the message as merge tags (dynamic fields).","type":"text"}]},{"type":"paragraph","content":[{"text":"The number of elements indicated for each \"campo\" parameter must match the number of addresses in the \"recipients\" parameter.","type":"text"}]},{"type":"paragraph","content":[{"text":"For example, let's say the message is sent to three recipients. The ","type":"text"},{"text":"recipients ","type":"text","marks":[{"type":"em"}]},{"text":"parameter will look as follows:","type":"text"}]},{"type":"codeBlock","content":[{"text":"recipients=johnsmith@example.com;pauljohnson@example.com;anntaylor@example.com","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"Now let's assume that you want to pass to the system the recipients' first and last name as part of the API call. Let's also assume that those fields are saved in the first two ","type":"text"},{"text":"Recipient fields ","type":"text","marks":[{"type":"em"}]},{"text":"(","type":"text"},{"text":"campo1","type":"text","marks":[{"type":"em"}]},{"text":" and ","type":"text"},{"text":"campo2","type":"text","marks":[{"type":"em"}]},{"text":"). The API call will have to include 3 items for each semi-colon separated array of values:","type":"text"}]},{"type":"codeBlock","content":[{"text":"campo1=John;Paul;Ann\ncampo2=Smith;Johnson;Taylor","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"},{"text":" In case of empty personal data fields, the number of elements must always be the same. In the example below, empty values are passed for the second recipient:","type":"text"}]},{"type":"codeBlock","content":[{"text":"campo1=John;;Ann\ncampo2=Smith;;Taylor","type":"text"}]},{"type":"heading","attrs":{"level":2},"marks":[{"type":"indentation","attrs":{"level":1}}],"content":[{"text":"Code samples","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Ruby","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"ruby"},"content":[{"text":"# Refer to https://mailup.atlassian.net/wiki/display/mailupapi/MailUp+RubyGem for gem information.\nrequire 'mailup'\nm = MailUp::Send.new('username', 'password')\nm.send_newsletter(:newsletterID => 3, \"Options\" => {:from_email => '...\"})\n# => 0...\"","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"PHP","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"php"},"content":[{"text":"loginFromId();\n//...\n// Prepare sending of message 294 to recipients of group 481 (that belong to list 66)\n$sendNewsletterData = array(\"listID\" => \"66\",\n\t\t\t\t\t\t \"newsletterID\" => \"294\",\n\t\t\t\t\t\t \"options\" => array(\t\t\t\t\t\t \n\t\t\t\t\t\t\t\t\t\tarray(\"Key\" =>\"from_email\", \"Value\" => \"sender@example.com\"),\n\t\t\t\t\t\t\t\t\t\tarray(\"Key\" =>\"from_name\", \"Value\" => \"Your Dealer\"),\n\t\t\t\t\t\t\t\t\t\tarray(\"Key\" =>\"send_to\", \"Value\" => \"GROUPS\"),\n\t\t\t\t\t\t\t\t\t\tarray(\"Key\" =>\"recipients\", \"Value\" => \"481\"))\n\t\t\t\t\t);\n\t\t\t\t\t\n$WsSend->sendNewsletter($sendNewsletterData);\n$WsSend->logout();\n?>\n\n","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"},{"type":"hardBreak"}]}],"version":1}

Browser not supported