Class cMailer

Mailer class which should be used for all mail sending purposes.

Swift_Mailer

cMailer

Package: Core\Backend
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Rusmir Jusufovic, Simon Sprankel
Located at classes/class.mailer.php

Methods summary
`public`	# `__construct( Swift_Transport $transport = NULL )` Constructor Constructor Parameters `$transport` [optional] the transport type Overrides `Swift_Mailer::__construct()`
`public static Swift_SmtpTransport`	# `constructTransport( string $mailHost, string $mailPort, string $mailEncryption = NULL, string $mailUser = NULL, string $mailPass = NULL )` Tries to establish an SMTP connection with the given settings. If this is possible, a Swift_SmtpTransport object is returned. Otherwise a simple Swift_MailTransport object is returned. Tries to establish an SMTP connection with the given settings. If this is possible, a Swift_SmtpTransport object is returned. Otherwise a simple Swift_MailTransport object is returned. Parameters `$mailHost` the mail host `$mailPort` the mail port `$mailEncryption` [optional] the mail encryption `$mailUser` [optional] the mail user `$mailPass` [optional] the mail password Returns `Swift_SmtpTransport` Swift_MailTransport the transport object
`public`	# `setCharset( string $charset )` Sets the charset of the messages which are sent with this mailer object. If you want to use UTF-8, you do not need to call this method. Sets the charset of the messages which are sent with this mailer object. If you want to use UTF-8, you do not need to call this method. Parameters `$charset` the character encoding
`public integer`	# `sendMail( string\|array $from, string\|array $to, string $subject, string $body = '', string\|array $cc = NULL, string\|array $bcc = NULL, string\|array $replyTo = NULL, boolean $resend = false, string $contentType = 'text/plain' )` Wrapper function for sending a mail. All parameters which accept mail addresses also accept an array where the key is the email address and the value is the name. Wrapper function for sending a mail. All parameters which accept mail addresses also accept an array where the key is the email address and the value is the name. Parameters `$from` the sender of the mail, if something "empty" is given, default address from CONTENIDO system settings is used `$to` one or more recipient addresses `$subject` the subject of the mail `$body` [optional] the body of the mail `$cc` [optional] one or more recipient addresses which should get a normal copy `$bcc` [optional] one or more recipient addresses which should get a blind copy `$replyTo` [optional] address to which replies should be sent `$resend` [optional] whether the mail is resent `$contentType` Returns integer number of recipients to which the mail has been sent
`public integer`	# `send( Swift_Mime_Message $message, array & $failedRecipients = NULL, boolean $resend = false )` Sends the given Swift_Mime_Message and logs it if $resend is false. Sends the given Swift_Mime_Message and logs it if $resend is false. Parameters `$message` `$failedRecipients` $failedRecipients, optional `$resend` $resend, optional Returns integer See `Swift_Mailer::send()` Overrides `Swift_Mailer::send()`
`public`	# `resendMail( integer $idmailsuccess )` Resends the mail with the given idmailsuccess. Resends the mail with the given idmailsuccess. Parameters `$idmailsuccess` the ID of the mail which should be resend Throws `cInvalidArgumentException` if the mail has already been sent successfully or does not exist
`private string`	# `encodeField( string\|array $value, string $charset )` Encodes the given value / the given array values with htmlentities. Encodes the given value / the given array values with htmlentities. Parameters `$value` the value to encode `$charset` the charset to use in htmlentities Returns string array encoded value
`private string`	# `decodeField( string\|array $value, string $charset )` Decodes the given value / the given array values with html_entity_decode. Decodes the given value / the given array values with html_entity_decode. Parameters `$value` the value to decode `$charset` the charset to use in htmlentities Returns string array decoded value
`private string`	# `_logMail( Swift_Mime_Message $message, array $failedRecipients = array() )` Log the information about sending the email. Log the information about sending the email. Parameters `$message` the message which has been send `$failedRecipients` [optional] the recipient addresses that did not get the mail Returns string the idmail of the inserted table row in con_mail_log

Methods inherited from Swift_Mailer
`createMessage(), getTransport(), newInstance(), registerPlugin()`

Properties summary
`private string`	`$_mailHost` The mail host name The mail host name	# `'localhost'`
`private string`	`$_mailUser` The username for authentication at the host The username for authentication at the host	# `''`
`private string`	`$_mailPass` The password for authentication at the host The password for authentication at the host	# `''`
`private string`	`$_mailEncryption` The encryption method (ssl/tls). The encryption method (ssl/tls).	# `NULL`
`private integer`	`$_mailPort` The port to use at the host The port to use at the host	# `25`
`private string`	`$_mailSender` The mail address of the sender The mail address of the sender	# `'noreply@contenido.org'`
`private string`	`$_mailSenderName` The name of the sender The name of the sender	# `'CONTENIDO Backend'`

Packages

Classes

Functions

Class cMailer

Parameters

Overrides

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

See

Overrides

Parameters

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns