Class BeMailComponent

General BEdita mail component

Object

Extended by

BeMailComponent

Version: $Revision$
Modifiedby: $LastChangedBy$
Lastmodified:

$LastChangedDate$

$Id$

Located at controllers/components/be_mail.php

Methods summary

`public`	# `startup( unknown_type & $controller = null )` startup component set smtp options if it's in configuration (bedita.cfg.php) startup component set smtp options if it's in configuration (bedita.cfg.php) Parameters `$controller`
`public`	# `sendMailById( integer $msg_id, string $to, boolean $html = true )` send single mail from mail_messages table send single mail from mail_messages table Parameters `$msg_id` `$to` $to, recipient email `$html`
`private string`	# `prepareMailBody( array $message, boolean $html = true, integer $mail_group_id = null, $card_id = null )` Prepare mail body using template Prepare mail body using template Parameters `$message` $message, mail_message array from a find on MailMessage `$html` $html, mail type `$mail_group_id` used to get publication public url and build unsubscribe link `$card_id` to built unsubscribe link Returns string body (html or txt) of the message
`public`	# `sendMail( array $data = array(), $createLog = true )` send single mail from $data array send single mail from $data array Parameters `$data` `$createLog`
`private`	# `mailLog( string $msg, string $level = "info", array $recipient = null, string $subj = null, array & $data = array() )` save mail log data save mail log data Parameters `$msg` `$level` `$recipient` `$subj` `$data`
`public array`	# `lockMessages( )` set to "injob" messages with status=pending and start_sending <= now set to "injob" messages with status=pending and start_sending <= now Returns array $msgIds
`public`	# `createJobs( array $msgIds )` create jobs from message with status "injob" create jobs from message with status "injob" Parameters `$msgIds`
`public`	# `sendQueuedJobs( array $msgIds )` execute active jobs execute active jobs
`public`	# `notify( $timeout = 20 )` Send notification mail and save mail job data Try to send all "unsent" notifications and all "pending" notifications stayed in queue too much time (see $timeout param) Send notification mail and save mail job data Try to send all "unsent" notifications and all "pending" notifications stayed in queue too much time (see $timeout param) Parameters `$timeout` in minute for check when a message is considered blocked (it has to resend)
`public array`	# `getMessagesBlocked( integer $timeout = 20 )` return array of messages that result blocked and update pid of mail jobs blocked return array of messages that result blocked and update pid of mail jobs blocked Parameters `$timeout` $timeout, time in minute for check when a message is considered blocked Returns array of message ids
`protected`	# `setSmtpOptions( )` if available set smtp options to EmailComponent if available set smtp options to EmailComponent
`private`	# `prepareData( array & $data )` prepare data for email sending prepare data for email sending Parameters `$data` Throws `BeditaException`
`private`	# `send( array $data )` send email send email Parameters `$data`

Properties summary

`public array`	`$components`	# `array("Email")`
`private string`	`$layoutNewsletter`	# `"newsletter"`
`private string`	`$templateNewsletter`	# `"newsletter"`
`private string`	`$boundaryPlaceholder`	# `"[[[--BOUNDARY--]]]"`