actual_send_newsletter (line 92)
Send out the newsletter.
void
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 = ''])
-
LONG_TEXT
$message: The newsletter message
-
SHORT_TEXT
$subject: The newsletter subject
-
LANGUAGE_NAME
$lang: The language
-
array
$send_details: A map describing what newsletters and newsletter levels the newsletter is being sent to
-
BINARY
$html_only: Whether to only send in HTML format
-
string
$from_email: Override the email address the mail is sent from (blank: staff address)
-
string
$from_name: Override the name the mail is sent from (blank: site name)
-
integer
$priority: The message priority (1=urgent, 3=normal, 5=low)
-
string
$csv_data: CSV data of extra subscribers (blank: none). This is in the same ocPortal newsletter CSV format that we export elsewhere.
add_newsletter (line 383)
Make a newsletter.
AUTO_LINK
add_newsletter
(SHORT_TEXT $title, LONG_TEXT $description)
-
SHORT_TEXT
$title: The title
-
LONG_TEXT
$description: The description
basic_newsletter_join (line 34)
Add to the newsletter, in the simplest way.
string
basic_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 = ''])
-
EMAIL
$email: The email address of the subscriber
-
integer
$interest_level: The interest level
-
?LANGUAGE_NAME
$lang: The language (NULL: users)
-
boolean
$get_confirm_mail: Whether to require a confirmation mail
-
?AUTO_LINK
$newsletter_id: The newsletter to join (NULL: the first)
-
string
$forename: Subscribers forename
-
string
$surname: Subscribers surname
delete_newsletter (line 410)
Delete a newsletter.
void
delete_newsletter
(AUTO_LINK $id)
edit_newsletter (line 397)
Edit a newsletter.
void
edit_newsletter
(AUTO_LINK $id, SHORT_TEXT $title, LONG_TEXT $description)
-
AUTO_LINK
$id: The ID
-
SHORT_TEXT
$title: The title
-
LONG_TEXT
$description: The description
newsletter_shutdown_function (line 321)
Actually send out the newsletter in the background.
void
newsletter_shutdown_function
()
newsletter_variable_substitution (line 286)
Sub in newsletter variables.
string
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
$message: The original newsletter message
-
SHORT_TEXT
$subject: The newsletter subject
-
SHORT_TEXT
$forename: Subscribers forename (blank: unknown)
-
SHORT_TEXT
$surname: Subscribers surname (blank: unknown)
-
SHORT_TEXT
$name: Subscribers name (or username)
-
EMAIL
$email_address: Subscribers email address
-
ID_TEXT
$sendid: Specially encoded ID of subscriber (begins either 'n' for newsletter subscriber, or 'm' for member - then has normal subscriber/member ID following)
-
SHORT_TEXT
$hash: Double encoded password hash of subscriber (blank: can not unsubscribe by URL)
newsletter_who_send_to (line 129)
Find a group of members the newsletter will go to.
array
newsletter_who_send_to
(array $send_details, LANGUAGE_NAME $lang, integer $start, integer $max)
-
array
$send_details: A map describing what newsletters and newsletter levels the newsletter is being sent to
-
LANGUAGE_NAME
$lang: The language
-
integer
$start: Start position in result set (results are returned in parallel for each category of result)
-
integer
$max: Maximum records to return from each category