actual_send_newsletter
add_newsletter
basic_newsletter_join
delete_newsletter
edit_newsletter
incoming_bounced_email_script
newsletter_block_list
newsletter_variable_substitution
newsletter_who_send_to
actual_send_newsletter(\LONG_TEXT $message, \SHORT_TEXT $subject, \LANGUAGE_NAME $lang, array $send_details, \BINARY $html_only= 0, string $from_email= '', string $from_name= '', integer $priority= 3, string $csv_data= '', \ID_TEXT $mail_template= 'MAIL') : \Tempcode
| package | newsletter |
|---|---|
| range | 1 5 |
\LONG_TEXTThe newsletter message
\SHORT_TEXTThe newsletter subject
\LANGUAGE_NAMEThe language
arrayA map describing what newsletters and newsletter levels the newsletter is being sent to
\BINARYWhether to only send in HTML format
stringOverride the email address the mail is sent from (blank: staff address)
stringOverride the name the mail is sent from (blank: site name)
integerThe message priority (1=urgent, 3=normal, 5=low)
stringCSV data of extra subscribers (blank: none). This is in the same Composr newsletter CSV format that we export elsewhere.
\ID_TEXTThe template used to show the email
\TempcodeUIadd_newsletter(\SHORT_TEXT $title, \LONG_TEXT $description) : \AUTO_LINK
| package | newsletter |
|---|
\SHORT_TEXTThe title
\LONG_TEXTThe description
\AUTO_LINKThe IDbasic_newsletter_join(\EMAIL $email, integer $interest_level= 4, \?LANGUAGE_NAME $lang= null, boolean $get_confirm_mail= false, \?AUTO_LINK $newsletter_id= null, string $forename= '', string $surname= '') : string
No authorisation support here, checks it works only for non-subscribed or non-confirmed members.
| package | newsletter |
|---|---|
| range | 1 4 |
\EMAILThe email address of the subscriber
integerThe interest level
\?LANGUAGE_NAMEThe language (null: users)
booleanWhether to require a confirmation mail
\?AUTO_LINKThe newsletter to join (null: the first)
stringSubscribers forename
stringSubscribers surname
stringNewsletter passworddelete_newsletter(\AUTO_LINK $id)
edit_newsletter(\AUTO_LINK $id, \SHORT_TEXT $title, \LONG_TEXT $description)
| package | newsletter |
|---|
\AUTO_LINKThe ID
\SHORT_TEXTThe title
\LONG_TEXTThe description
newsletter_block_list() : array
newsletter_variable_substitution(string $message, \SHORT_TEXT $subject, \SHORT_TEXT $forename, \SHORT_TEXT $surname, \SHORT_TEXT $name, \EMAIL $email_address, \ID_TEXT $sendid, \SHORT_TEXT $hash) : string
| package | newsletter |
|---|
stringThe original newsletter message
\SHORT_TEXTThe newsletter subject
\SHORT_TEXTSubscribers forename (blank: unknown)
\SHORT_TEXTSubscribers surname (blank: unknown)
\SHORT_TEXTSubscribers name (or username)
\EMAILSubscribers email address
\ID_TEXTSpecially encoded ID of subscriber (begins either 'n' for newsletter subscriber, or 'm' for member - then has normal subscriber/member ID following)
\SHORT_TEXTDouble encoded password hash of subscriber (blank: can not unsubscribe by URL)
stringThe new newsletter messagenewsletter_who_send_to(array $send_details, \LANGUAGE_NAME $lang, integer $start, integer $max, boolean $get_raw_rows= false, string $csv_data= '') : array
| package | newsletter |
|---|
arrayA map describing what newsletters and newsletter levels the newsletter is being sent to
\LANGUAGE_NAMEThe language
integerStart position in result set (results are returned in parallel for each category of result)
integerMaximum records to return from each category
booleanWhether to get raw rows rather than mailer-ready correspondance lists
stringSerialized CSV data to also consider
arrayReturns a tuple of corresponding detail lists, emails,hashes,usernames,forenames,surnames,ids, and a record count for levels (depending on requests: csv, 1,