WIP A SubClass of phpMailer adapted for LimeSurvey
package | Default |
---|
__construct( $exceptions = false)
inheritdoc | Default exception to false (we use getError or getDebug) WIP Set all needed fixed in params |
---|---|
addAddress( $addressTo, $name = '')
inheritdoc | Fix first parameters if he had email + name ( Name |
---|---|
addAttachementsByType()
addDebug( $str, $level): void
addUrlsPlaceholders(string|array<mixed,string> $aUrlsPlaceholders): void
string|array<mixed,string>
an array of url placeholder to set automatically
attachementExists( $aAttachment)
clearAttachments()
inheritdoc | Reset the attachementType done to false |
---|---|
doReplacements(string $string): string
string
wher need to replace
string
getDebug(string $format = ''): null|string|array
string
(currently only html or null (return array))
null|string|array
getError(): null|string
see | \parent::ErrorInfo |
---|---|
null|string
getEventMessage(): string
string
getFrom(): string
string
from (name
getInstance(integer $reset = self::ResetBase)
integer
totally or partially the instance return \LimeMailer
getIsHtml(): boolean
boolean
getTokenReplacements(): array<mixed,string>
array<mixed,string>
init()
manageEvent( $eventParams = array())
var | specific event parameters to add return boolean|null : sended of not, if null : no action are done by event, can use default action. |
---|---|
Send()
inheritdoc | Disable all sending in demoMode |
---|---|
sendMessage(): boolean
boolean
setFrom( $from, $fromname = null, $auto = true): boolean
inheritdoc | Fix first parameters if he had email + name ( Name |
---|---|
boolean
setSurvey(integer $surveyId): void
integer
setTo( $addressTo, $name = ''): void
see | self::addAddress |
---|
setToken(string $token): void
Throws |
|
---|
string
setTypeWithRaw(string|null $emailType,string|null $language = null)
string|null
: set the rawSubject and rawBody at same time
string|null
forced language
validateAddress( $address, $patternselect = null)
inheritdoc | Adding php with idna support Must review , seems phpMailer have something with idn ? @see parent::idnSupported |
---|---|
validateAddresses(string $aEmailAddressList,string|callable $patternselect = null): string
returns | array |
---|
string
Email address to check
string|callable
Which pattern to use (default to static::$validator)
string
List with valid email addresses - invalid email addresses are filtered - false if none of the email addresses are valid
ResetNone
ResetBase
ResetComplete
surveyId :
mailLanguage :
html :
oToken :
aUrlsPlaceholders :
aReplacements :
emailType :string
var | Current email type, used for updating email raw subject and body for token (in survey) : invite, remind, confirm, register … for survey (admin or not) : admin_notification, admin_responses, savesurveydetails, errorsavingresults other : addadminuser, passwordreminderadminuser, mailsendusergroup … |
---|
string
_aAttachementByType :array<mixed,string>
var |
---|
array<mixed,string>
replaceTokenAttributes :boolean
var | replace token attributes (FIRSTNAME etc …) and replace to TOKEN:XXX by XXXX |
---|
boolean
aAttachements :array
var | Current attachements (as string or array) |
---|---|
see |
array
_bAttachementTypeDone :boolean
var | Current attachements (as string or array) |
---|
boolean
rawSubject :string
var | $rawBody |
---|
string
rawBody :string
var |
---|
string
BodySubjectCharset :string
var | Charset of Body and Subject |
---|---|
see | @CharSet |
string
CharSet :
inheritdoc | , defaultto utf-8 |
---|---|
eventName :
eventMessage :
debug :
validator :string|callable
inheritdoc | Set default to idna (unsure is needed : need an idna email to check since seems PHPMailer do the job here ?) |
---|---|
var |
string|callable