Konquadrat API Reference

Index

\com\setasign\Konquadrat
1. Object
  1. Custom
    1. Traits
      1. Mail
        
        DefaultSender
        
        Email
        
        EmailAttachmentRelation
        
        EmailTemplateAttachmentRelation
        
        HasEmailTpl
        
        SenderTpl
        
        SmartyTemplate
        
        TemplateTpl

com\setasign\Konquadrat\Object\Custom\Traits\Mail

Email Trait Email

File: /Konquadrat/src/Object/Custom/traits/Mail/Email.php

Used in

\com\setasign\Konquadrat\Object\Custom\Mail\EmailObject

Summary

Static Methods

parseMailList()

Methods

addAttachment()
addAttachmentByFile()
addAttachmentRelation()
addAttachmentToMail()
addAttachmentsToMail()
getAttachmentRelations()
getAttachments()
getTabHeader()
initAndWakeupMail__Email()
saveAttachmentsAndRelations()
sendAction()

Properties

$applicationConfig
$attachmentRelations
$attachments
$dataDirectory
$domainName

Properties

$applicationConfig

protected ?\com\setasign\SetaFramework\Application\ApplicationConfig Email::$applicationConfig

$attachmentRelations

protected ?\com\setasign\Konquadrat\Object\Custom\Mail\EmailAttachmentRelationObject[] Email::$attachmentRelations

$attachments

protected ?\com\setasign\Konquadrat\Object\Custom\Mail\EmailAttachmentObject[] Email::$attachments

$dataDirectory

protected ?string Email::$dataDirectory

$domainName

protected Email::$domainName

Static Methods

parseMailList()

public static Email::parseMailList (

string $mailList

): array

Parameters

$mailList : string

Methods

addAttachment()

public Email::addAttachment (

\com\setasign\Konquadrat\Object\Custom\Mail\EmailAttachmentObject $emailAttachment

): void

Parameters

$emailAttachment : \com\setasign\Konquadrat\Object\Custom\Mail\EmailAttachmentObject

addAttachmentByFile()

public Email::addAttachmentByFile (

\com\setasign\SetaFramework\FileSystem\File $file,
bool $inline = false

): void

Parameters

$file : \com\setasign\SetaFramework\FileSystem\File
$inline : bool

Exceptions

Throws \com\setasign\Konquadrat\Exception

addAttachmentRelation()

public Email::addAttachmentRelation (

\com\setasign\Konquadrat\Object\Custom\Mail\EmailAttachmentRelationObject $attachmentRelation

): void

Parameters

$attachmentRelation : \com\setasign\Konquadrat\Object\Custom\Mail\EmailAttachmentRelationObject

addAttachmentToMail()

protected Email::addAttachmentToMail (

\Symfony\Component\Mime\Email $mail,
\com\setasign\Konquadrat\Object\Custom\Mail\EmailAttachmentObject|\com\setasign\Konquadrat\Object\Custom\Mail\StaticEmailAttachmentTplObject $attachment

): void

Parameters

$mail : \Symfony\Component\Mime\Email
$attachment : \com\setasign\Konquadrat\Object\Custom\Mail\EmailAttachmentObject|\com\setasign\Konquadrat\Object\Custom\Mail\StaticEmailAttachmentTplObject

addAttachmentsToMail()

protected Email::addAttachmentsToMail (

\Symfony\Component\Mime\Email $mail

): void

Parameters

$mail : \Symfony\Component\Mime\Email

Exceptions

Throws \com\setasign\Konquadrat\MultiLangException

getAttachmentRelations()

public Email::getAttachmentRelations (

void

): array

getAttachments()

public Email::getAttachments (

void

): array

getTabHeader()

public Email::getTabHeader (

void

): string

initAndWakeupMail__Email()

public Email::initAndWakeupMail__Email (

\com\setasign\SetaFramework\Bootstrap\DomainName $domainName,
\com\setasign\SetaFramework\Application\ApplicationConfig $applicationConfig,
\com\setasign\Konquadrat\DirectorySettings $directorySettings

): void

Parameters

$domainName : \com\setasign\SetaFramework\Bootstrap\DomainName
$applicationConfig : \com\setasign\SetaFramework\Application\ApplicationConfig
$directorySettings : \com\setasign\Konquadrat\DirectorySettings

saveAttachmentsAndRelations()

protected Email::saveAttachmentsAndRelations (

void

): void

Exceptions

Throws \com\setasign\Konquadrat\Object\ObjectSaveException

sendAction()

public Email::sendAction (

bool $saveMail = true

): ?\com\setasign\Konquadrat\Object\Action\ActionResponse

Parameters

$saveMail : bool

Exceptions

Throws \com\setasign\Konquadrat\Exception

Throws \com\setasign\Konquadrat\Object\ObjectSaveException

Throws \Symfony\Component\Mailer\Exception\TransportExceptionInterface