/core/functions_email.php

Description
Description | Functions

Email functions for ILance

  • author: ILance
  • version: $Revision: 1.0.0 $
Functions
Description | Functions
is_notification_unsubscribed (line 295)

Function to determine if a specific user email address is unsubscribed to a particular notification

  • return: Returns true if an email is unsubscribed from a specific notification otherwise returns false
bool is_notification_unsubscribed ([string $email = ''], [string $varname = ''])
  • string $email: email address
  • string $varname: email varname (non-encrypted version)
send_email (line 37)

Function to dispatch new email using php's mail() or SMTP

  • return: Returns true on successful email dispatch
bool send_email ([string $toemail = ''], [string $subject = ''], [string $message = ''], [string $from = ''], [string $fromname = ''], [bool $html = false], [string $logtype = 'alert'])
  • string $toemail: to email address
  • string $subject: email subject
  • string $message: email message
  • string $from: email from address
  • string $fromname: email from name
  • bool $html: send html formatted email? (default is false)
  • string $logtype: log type (default alert)
unsubscribe_notification (line 251)

Function to unsubscribe a user from receiving a particular email template on the site

  • return: Returns true on successful email unsubscribe
bool unsubscribe_notification ([string $email = ''], [string $emailid = ''])
  • string $email: email address
  • string $emailid: email varname (encrypted version)

Documentation generated on Mon, 08 Aug 2011 17:40:58 +0200 by phpDocumentor 1.4.1