{"type":"doc","content":[{"type":"paragraph","content":[{"text":"The SendMessageNL method:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Allows to send a message to the recipients listed in a CSV file","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Synchronously executes the following steps:","type":"text"},{"type":"hardBreak"},{"type":"hardBreak"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Scheduling of a sending at the date and time contained in the parameters","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Return of a delivery ID to the caller","type":"text"},{"type":"hardBreak"},{"type":"hardBreak"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Asynchronously executes the following steps:","type":"text"},{"type":"hardBreak"},{"type":"hardBreak"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Creation of a group in MailUp in which to gather the recipients that have to be imported","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Import to MailUp of the recipients included in the file. Recipients will be imported to the list indicated by the filename (see ","type":"text"},{"text":"details","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/mailupapi/pages/36340287"}}]},{"text":")","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Method parameters","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"int","type":"text","marks":[{"type":"textColor","attrs":{"color":"#0000ff"}}]},{"text":" SendMessageNL(","type":"text"},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#0000ff"}}]},{"text":" accessKey, ","type":"text"},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#0000ff"}}]},{"text":" fileName, ","type":"text"},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#0000ff"}}]},{"text":" separator, ","type":"text"},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#0000ff"}}]},{"text":" listId, ","type":"text"},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#0000ff"}}]},{"text":" listGuid, ","type":"text"},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#0000ff"}}]},{"text":" messageId, ","type":"text"},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#0000ff"}}]},{"text":" senderName, ","type":"text"},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#0000ff"}}]},{"text":" sender, ","type":"text"},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#0000ff"}}]},{"text":" subject, ","type":"text"},{"text":"DateTime","type":"text","marks":[{"type":"textColor","attrs":{"color":"#0000ff"}}]},{"text":" timeDateSending, ","type":"text"},{"text":"int ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#0000ff"}}]},{"text":"sendDelayTest)","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"accessKey: 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":"fileName: name of the CSV files containing the recipients of the message","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"separator: separating character used in the CSV file. If null or empty, the character ';' will be used by default.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"listId: list identifier","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"listGuid: GUID of the list in MailUp","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"messageId: ID of the message to be sent","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"senderName: name of the sender of the message. If null or empty, the system will use the default name for the list.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"sender: email address of message sender. If null or empty, the system will use the default address for the list. If no default sender has been defined for the list, the sending does not start.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"subject: required but not used, you can either set it to NULL or empty string value","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"timeDateSending: date and time of scheduled sending","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"sendDelayTest: no more used, always set to zero.","type":"text"},{"type":"hardBreak"},{"type":"hardBreak"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"Parameters","type":"text"},{"text":" listGuid ","type":"text","marks":[{"type":"em"}]},{"text":"e ","type":"text"},{"text":"listId","type":"text","marks":[{"type":"em"}]},{"text":" can be used together or alternatively, passing one of them as null or empty: in the first case the list is verified using both parameters, otherwise using only the provided parameter.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"SendMessageNL method","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Requires the CSV file to be moved to MailUp servers before method is called","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Manages import and sending for a specific list. Differently from batch FTP imports from a CSV file, this method does not allow to import contacts to different lists. All recipients must be imported in the same list","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The file containing the recipients must be in CSV format (can also be provided in a compressed format using ZIP compression).The file and its fields must be structured following the guidelines contained in the ","type":"text"},{"text":"CSV file description","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/mailupapi/pages/36340287"}}]}]}]}]}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"SendMessageNL is likely the best option for a fast bulk import and sending but users should be aware of some known ","type":"text"},{"text":"limitations","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/mailupapi/pages/36339933"}}]}]}]},{"type":"paragraph","content":[{"text":"The method returns","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"the ID of the sending","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"-1 in case the operation did not complete successfully (e.g. due to incorrect parameters or system failure). In this case no recipient has been imported and no message has been sent. ","type":"text"},{"type":"hardBreak"},{"text":"You should then check:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"if parameters fileName, messageId and accessKey have been provided.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"if parameter accessKey is correct (it should contain the key obtained from login method).","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"that at least one of the parameters listId and ListGuid has been provided. And if their values are correct.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"that the sender argument contains a valid email address or an empty string when provided.","type":"text"},{"type":"hardBreak"},{"type":"hardBreak"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"-3 in case the request command to start import to MailUp of the recipients included in the file fail. (e.g. due to an import operation already running that the system doesn't recognize).","type":"text"},{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"If this is the case, you should login into your mailup account and check if the import process was successfully queued. If so, the dispatch will take place correctly, else, it would be required to run once again the SendMessageNL method.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Since SendMessageNL starts as an asynchronous task, in some cases a failure may occur after the method call is completed. In this case the failure is notified by means of an ","type":"text"},{"text":"alert","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/mailupapi/pages/36340156"}}]}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"SOAP Examples","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Sample request","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"SOAP request (Scheduled sending with time zone)","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\t10_201105031527211234.csv\n\t\t\t;\n\t\t\t10\n\t\t\t0e591119-cd77-4157-9379-6ac75335664\n\t\t\t151\n\t\t\tYour Dealer\n\t\t\tsender@example.com\n\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t2013-05-22T13:00:00.000+02:00\n\t\t\n\t\n","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Sample response","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"SOAP response (successful, returns sending ID)","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"html/xml"},"content":[{"text":"\n \n \n 226\n \n \n","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"SOAP response (request failed)","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"html/xml"},"content":[{"text":"\n \n \n -1\n \n \n","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Code Examples","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"PHP","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"php"},"content":[{"text":" $this->accessKey));\n\t\t\t$this->soapClient->sendMessageNL($params);\t\t\t\n\t\t} catch (SoapFault $soapFault) {\t\n\t\t\t\tvar_dump($soapFault);\n\t\t}\n\t}\n}\n\n$WsSend = new MailUpWsSend();\n$WsSend->loginFromId();\n$filename = \"10_201105031527211234.csv\"\n \nuploadFile($filename) or die(\"Unable to upload list of recipients through FTP\");\n \n$sendingDate = date (\"c\", mktime(13,20,0,7,1,2013)); //set date with 2013-07-01T13:20:00+00:00\n$sendMessageNLData = array(\"fileName\" => $filename,\n\t\t\t\t\t\t \"separator\" => \";\",\n\t\t\t\t\t\t \"listId\" => \"10\",\n\t\t\t\t\t\t \"listGuid\" => \"0e591119-cd77-4157-9379-6ac75335664\",\n\t\t\t\t\t\t \"messageId\" => \"151\",\n\t\t\t\t\t\t \"senderName\" => \"Your Dealer\",\n\t\t\t\t\t\t \"sender\" => \"sender@example.com\",\n\t\t\t\t\t\t \"subject\" => \"\",\n\t\t\t\t\t\t \"timeDateSending\" => $sendingDate\n);\n\n\n$WsSend->sendMessageNL($sendMessageNLData);\n$WsSend->logout();\n\n?>","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Related pages","type":"text"}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"children","parameters":{"macroParams":{},"macroMetadata":{"schemaVersion":{"value":"2"},"title":"Children Display"}}}},{"type":"paragraph","content":[{"text":" ","type":"text"}]}],"version":1}

Browser not supported