Delivering messages and communications

Available options:

• Boolean usenewsletteroptions: use default values from communication instead of what specified here.
• Boolean cssinline: automatically change the html in order to increase compatibility (default false).
• Boolean webbug: enable the web bug to allow the detection of HTML openings even if the user does not click (default true).
• String emailbodyencoding: binary encoding of the body of the email (default windows-1252).
• String emailsubjectencoding: binary encoding of the subject of the email (default windows-1252).
• Boolean emailhtmlmultipart: send also a textual copy of the HTML emails with encoding "multipart/alternative" (default false).
• String emailformat: force the emails delivery for a certain format: "HTML" = all html, "TEXT" = all text, "AUTO" = according to the contact's preferences. Default value is "HTML".
• Boolean embed: incorporate all the resources (images, CSS) to allow the emails display even with disconnected email clients (default false)
• String emailreplyto: "reply-to" address of emails (default email of the user who makes the call).
• Boolean useallchannels: use all available communication channels (in the case of multi-channel communication, e.g. SMS+email; default true).
• Boolean usecontactsdata: use the contacts' data (valid only for deliveries with trial=true; default true).  
• Integer iddatabase: if usecontactsdata=true this is the database to use for contacts lookup.
• Boolean ignoreuserpreferencesonchannels: use the channels of communication without considering the contacts' preferences (default true).
• Boolean confirm: automatically confirm the launch without sending the launch confirmation email (default true).
• Boolean sendconfirmationrequest: when option confirm is set to "false", this flag determines whether the confirmation mail should be sent or not (default false).
• Boolean enablesendreport: send a report as configured in journey settings (default false).
• Boolean failonemptytarget: for non-trial launches only, launch fails if at least one of the audiences specified in target is empty (default false).
• Boolean partitioned: used to create a partitioned launch (launch in multiple stages) using parameters: "partitions" and "partitionDelays" (default false).
• Boolean recall: used to send the communication only to contacts who received the mail in a previous delivery without opening or clicking it before and without recording an hard bounce. If it's a trial delivery this option won't be considered (default false).
• String partitions: list of integer separated by ';' char representing the percentage of each partition. For example: "10;20;70" means that first partition will be the 10% of target. Sum of partitions must be 100.
• String partitiondelays: list of integer separated by ';' char representing the deltas in milliseconds between partitions. For example: "0;86400000;172800000", means that first partition will be sent on the requestedStartDate, second partition the day after and third partition the day after that.
• Boolean usecontactstimezone: if true a launch based on timezone will be created. The "requestedStartDate" of launch will be evaluated using the value of timezone field of each contact (default false).
• Integer idpolicy: use this option to override the policy to use for this delivery. The sendNewsletter fails if this option is evaluated but the policy mapping feature is not active or if the "Choose a different policy for each delivery" journey option is false. See the getAllDeliveryPolicies for retrieve policies ids. 
• Boolean ignoremissingunsubscribelink: used to disable the unsubscribe link presence checking. Whether "false" this function will fail if no unsubscribe link has been set in the communication (default true).
• Boolean ignoreencodingerrors: used to disable the charset compatibility checking. E.g. whether "false", this function will fail if you use "utf-8" characters not supported in "window-1252" encoding and the communication has the encoding set to "windows-1252" (default true).
• String additionaltargetfilterquery: query to optionally filter delivery target. For example: "SELECT * FROM CONTACTS WHERE status = 'subscribed'". This query will be applied to filter every audience of target
• Integer emailpriority: set messages delivery priority. Available values: "1" - Highest, "2" - High, "3" - Normal (default, used when not declared), "4" - Low, "5" - Lowest
• String channels: comma separated list of custom channel identifiers for which to enable the delivery. This channels are added to the enabled channels specified in the options parameter. The custom channels in this list must be defined in the account.
• Boolean forceusedeliverabilitycluster: if true, the sending policy will be the one in the contact delivery cluster, for contacts that have it valued (default false).
• Boolean usedatabasepolicysettings: corresponds to the parameter that indicates, when configuring communication sending, whether to use the database delivery policy. If not specified, the journey delivery policy is used.

Available options:  
 

• Int idcontact: looks up for contact's profile data using the internal id of the contact
• Int iddatabase: if the contact is not recognized this values is used to render the email as it was sent to a contact of a database  
• String contactprimarykey: looks up for contact's profile data searching for a contact with the given primary key, in the given database (see iddatabase option)
• Boolean contactprimarykeyoptional: If the contact isn't found, use the to field in the message values as recipient address instead of failing the delivery.
  Note: when no contact is found, no statistics are recorded, since the message is sent but there's no contact on any database to associate the message against.  
• Boolean usecontactemail: uses the email of the given contact as the recipient address of the message (overriding message.to). Default = false
• Boolean cssinline: apply css inline to the html content of the message. Default = false
• Boolean embbeddedimages: download and embed all the images founded in the html content of the message (attaching them at the message). Default = false
• Int idwebsite: specifies the website to use when rendering absolute URLs (for example image urls or [link:ununsubscribe] urls..). Default = id of the default website
• Boolean usenewsletterastemplate: indicates to use a communication template (or notification message template, which is a special type of communication) as the message body. Default = false
• Boolean renderatsend: indicates to render the message during the delivery and not while serving the API call. This option must be used in conjunction with usenewsletterastemplate. This option will result in faster API calls and in less resources usage. This is the preferred way of sending messages using usenewsletterastemplate option. Default = false. With 'renderAtSend' option, message body will never be persisted on db, even if 'messageRetention' level is set to 'full'  
• Boolean usehtmlcodeastemplate: indicates to use html code as the message body. In this case for example you can use mn:if conditions and EmailMessage.tempvars. Default = false
• Int idnewsletter: the communication whose template is used to draw the message (usenewsletterastemplate must be set to true).
• String newsletterkey: the key for sending by API of the communication whose template is used to draw the message (usenewsletterastemplate must be set to true). If idnewsletter and newsletterkey are both valued, idnewsletter will be used.
• String format: the format of the email (default is 'html', admitted values are 'html', 'text' and 'multipart').  
• Timestamp expectedDeliveryTs: requests to send the message at a given time. If empty it means 'as soon as possible'.   This field must be formatted according to the formatting options of the user who runs the request. The timestap is always the user timestamp.
• String messageRetention: Specify a retention policy for the given message between "minimal" (discard the message body), "full" (keep the whole message and headers) and "reserved" (discard the recipient).
• String idlanguage: language of the notification message if the contact is not subscribed in any database
• Boolean nospool: indicates to attempt to avoid message spooling and send messages directly. This option can be helpful to send a message in a timely manner. Default = false  

Available options:
 

• Int idcontact: looks up for contact's profile data using the internal id of the contact
• Int iddatabase: if the contact is not recognized this values is used to render the email as it was sent to a contact of a database  
• String contactprimarykey: looks up for contact's profile data searching for a contact with the given primary key, in the given database (see iddatabase option)
• Boolean contactprimarykeyoptional: If the contact isn't found, use the to field in the message values as recipient address instead of failing the delivery.
  Note: when no contact is found, no statistics are recorded, since the message is sent but there's no contact on any database to associate the message against.  
• Boolean usecontactcell: uses the phone number (field 'cell') of the given contact as the recipient address of the message (overriding message.to). Default = false
• Boolean usenewsletterastemplate: indicates to use a communication template (or notification message template, which is a special type of communication) as the message body. Default = false
• Int idnewsletter: the communication whose template is used to draw the message (usenewsletterastemplate must be set to true)
• String newsletterkey: the key for sending by API of the communication whose template is used to draw the message (usenewsletterastemplate must be set to true). If idnewsletter and newsletterkey are both valued, idnewsletter will be used.
• Int idwebsite: specifies the website to use when rendering absolute URLs (for example [link:ununsubscribe] urls..). Default = id of the default website
• Boolean validatesmslength: If true the number of sms parts will be validated according to the maxsmsparts option together with the account settings. Default = true
• Timestamp expectedDeliveryTs: requests to send the message at a given time. If empty it means 'as soon as possible'
• Int maxsmsparts: specifies the maximum number of parts of sms message. Messages splitted in a number of parts exceeding this limit will not be sent. Default = system maximum number of sms parts
• String messageRetention: Specify a retention policy for the given message between "minimal" (discard the message body), "full" (keep the whole message and headers) and "reserved" (discard the recipient)
• Boolean nospool: indicates to attempt to avoid message spooling and send messages directly. This option can be helpful to send a message in a timely manner. Default = false
• String smsencoding: encoding of the SMS body (gsm, unicode)