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_TEXT
The newsletter message
\SHORT_TEXT
The newsletter subject
\LANGUAGE_NAME
The language
array
A map describing what newsletters and newsletter levels the newsletter is being sent to
\BINARY
Whether to only send in HTML format
string
Override the email address the mail is sent from (blank: staff address)
string
Override the name the mail is sent from (blank: site name)
integer
The message priority (1=urgent, 3=normal, 5=low)
string
CSV data of extra subscribers (blank: none). This is in the same Composr newsletter CSV format that we export elsewhere.
\ID_TEXT
The template used to show the email
\Tempcode
UIadd_newsletter(\SHORT_TEXT $title, \LONG_TEXT $description) : \AUTO_LINK
package | newsletter |
---|
\SHORT_TEXT
The title
\LONG_TEXT
The description
\AUTO_LINK
The 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 |
\EMAIL
The email address of the subscriber
integer
The interest level
\?LANGUAGE_NAME
The language (null: users)
boolean
Whether to require a confirmation mail
\?AUTO_LINK
The newsletter to join (null: the first)
string
Subscribers forename
string
Subscribers surname
string
Newsletter passworddelete_newsletter(\AUTO_LINK $id)
edit_newsletter(\AUTO_LINK $id, \SHORT_TEXT $title, \LONG_TEXT $description)
package | newsletter |
---|
\AUTO_LINK
The ID
\SHORT_TEXT
The title
\LONG_TEXT
The 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 |
---|
string
The original newsletter message
\SHORT_TEXT
The newsletter subject
\SHORT_TEXT
Subscribers forename (blank: unknown)
\SHORT_TEXT
Subscribers surname (blank: unknown)
\SHORT_TEXT
Subscribers name (or username)
\EMAIL
Subscribers email address
\ID_TEXT
Specially encoded ID of subscriber (begins either 'n' for newsletter subscriber, or 'm' for member - then has normal subscriber/member ID following)
\SHORT_TEXT
Double encoded password hash of subscriber (blank: can not unsubscribe by URL)
string
The 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 |
---|
array
A map describing what newsletters and newsletter levels the newsletter is being sent to
\LANGUAGE_NAME
The language
integer
Start position in result set (results are returned in parallel for each category of result)
integer
Maximum records to return from each category
boolean
Whether to get raw rows rather than mailer-ready correspondance lists
string
Serialized CSV data to also consider
array
Returns a tuple of corresponding detail lists, emails,hashes,usernames,forenames,surnames,ids, and a record count for levels (depending on requests: csv, 1,