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` `Swift_Transport` $transport [optional] the transport type
`public static Swift_SmtpTransport\|Swift_MailTransport`	# `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` `string` $mailHost the mail host `$mailPort` `string` $mailPort the mail port `$mailEncryption` `string` $mailEncryption [optional] the mail encryption `$mailUser` `string` $mailUser [optional] the mail user `$mailPass` `string` $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` `string` $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` `string\|array` $from the sender of the mail, if something "empty" is given, default address from CONTENIDO system settings is used `$to` `string\|array` $to one or more recipient addresses `$subject` `string` $subject the subject of the mail `$body` `string` $body [optional] the body of the mail `$cc` `string\|array` $cc [optional] one or more recipient addresses which should get a normal copy `$bcc` `string\|array` $bcc [optional] one or more recipient addresses which should get a blind copy `$replyTo` `string\|array` $replyTo [optional] address to which replies should be sent `$resend` `boolean` $resend [optional] whether the mail is resent `$contentType` `string` $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` `Swift_Mime_Message` $message `$failedRecipients` `array` &$failedRecipients [optional] `$resend` `boolean` $resend [optional] Returns `integer` See Swift_Mailer::send()
`public`	# `resendMail( integer $idmailsuccess )` Resends the mail with the given idmailsuccess. Resends the mail with the given idmailsuccess. Parameters `$idmailsuccess` `integer` $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\|array`	# `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` `string\|array` $value the value to encode `$charset` `string` $charset the charset to use in htmlentities Returns `string\|array` encoded value
`private string\|array`	# `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` `string\|array` $value the value to decode `$charset` `string` $charset the charset to use in htmlentities Returns `string\|array` decoded value
`private string\|boolean`	# `_logMail( Swift_Mime_Message $message, array $failedRecipients = array() )` Log the information about sending the email. Log the information about sending the email. Parameters `$message` `Swift_Message` $message the message which has been send `$failedRecipients` `array` $failedRecipients [optional] the recipient addresses that did not get the mail Returns `string\|boolean` the idmail of the inserted table row in con_mail_log\|bool false if mail_log option is inactive

Properties summary
`private string`	`$_mailHost`	`'localhost'`	# The mail host name The mail host name
`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`	`NULL`	# The encryption method (ssl/tls). The encryption method (ssl/tls).
`private integer`	`$_mailPort`	`25`	# The port to use at the host The port to use at the host
`private string`	`$_mailSender`	`'noreply@contenido.org'`	# The mail address of the sender The mail address of the sender
`private string`	`$_mailSenderName`	`'CONTENIDO Backend'`	# The name of the sender The name of the sender

Packages

Classes

Functions

Class cMailer

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

See

Parameters

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns