Inheritance diagram for ilFormatMail:

Collaboration diagram for ilFormatMail:

Public Member Functions
	formatReplyRecipientsForCC ()

	formatReplyRecipient ()

	appendSearchResult (array $a_names, string $a_type)

	appendSignature (string $message)

	prependSignature (string $message)

	formatReplyMessage (string $message)

	formatReplySubject (string $subject)

	formatForwardSubject (string $subject)

Public Member Functions inherited from ilMail
	__construct (private int $a_user_id, private ?ilMailAddressTypeFactory $mail_address_type_factory=null, private ilMailRfc822AddressParserFactory $mail_address_parser_factory=new ilMailRfc822AddressParserFactory(), private ?ilAppEventHandler $event_handler=null, private ?ilLogger $logger=null, private ?ilDBInterface $db=null, private ?ilLanguage $lng=null, private ?ilFileDataMail $mail_file_data=null, protected ?ilMailOptions $mail_options=null, private ?ilMailbox $mailbox=null, private ?ilMailMimeSenderFactory $sender_factory=null, private ?Closure $usr_id_by_login_callable=null, private ?AutoresponderService $auto_responder_service=null, private ?int $mail_admin_node_ref_id=null, private ?int $mail_obj_ref_id=null, private ?ilObjUser $actor=null, private ?ilMailTemplatePlaceholderResolver $placeholder_resolver=null, private ?ilMailTemplatePlaceholderToEmptyResolver $placeholder_to_empty_resolver=null, ?Conductor $legal_documents=null, ?MailSignatureService $signature_service=null,)

	autoresponder ()

	withContextId (string $context_id)

	withContextParameters (array $parameters)

	existsRecipient (string $new_recipient, string $existing_recipients)

	setSaveInSentbox (bool $save_in_sentbox)

	getSaveInSentbox ()

	getMailObjectReferenceId ()

	formatNamesForOutput (string $recipients)

	getPreviousMail (int $mail_id)

	getNextMail (int $mail_id)

	getMailsOfFolder (int $a_folder_id, array $filter=[])

	countMailsOfFolder (int $folder_id)

	deleteMailsOfFolder (int $folder_id)

	getMail (int $mail_id)

	markRead (array $mail_ids)

	markUnread (array $mail_ids)

	moveMailsToFolder (array $mail_ids, int $folder_id)

	deleteMails (array $mail_ids)

	getNewDraftId (int $folder_id)

	updateDraft (int $a_folder_id, array $a_attachments, string $a_rcp_to, string $a_rcp_cc, string $a_rcp_bcc, string $a_m_subject, string $a_m_message, int $a_draft_id=0, bool $a_use_placeholders=false, ?string $a_tpl_context_id=null, array $a_tpl_context_params=[])

	persistToStage (int $a_user_id, array $a_attachments, string $a_rcp_to, string $a_rcp_cc, string $a_rcp_bcc, string $a_m_subject, string $a_m_message, bool $a_use_placeholders=false, ?string $a_tpl_context_id=null, ?array $a_tpl_ctx_params=[])

	retrieveFromStage ()

	enqueue (string $a_rcp_to, string $a_rcp_cc, string $a_rcp_bcc, string $a_m_subject, string $a_m_message, array $a_attachment, bool $a_use_placeholders=false)
	Should be used to enqueue a 'mail'. More...

	sendMail (MailDeliveryData $mail_data)
	This method is used to finally send internal messages and external emails To use the mail system as a consumer, please use ilMail::enqueue. More...

	validateRecipients (string $to, string $cc, string $bcc)

	saveAttachments (array $attachments)

	appendInstallationSignature (?bool $a_flag=null)

	setUserInstanceById (array $user_instances_by_id_map)

	setMailOptionsByUserIdMap (array $mail_options_by_usr_id_map)

	formatLinebreakMessage (string $message)

Additional Inherited Members
Static Public Member Functions inherited from ilMail
static	_getAutoGeneratedMessageString (?ilLanguage $lang=null)

static	_getIliasMailerName ()

static	_getInstallationSignature ()

static	getSalutation (int $a_usr_id, ?ilLanguage $a_language=null)

Data Fields inherited from ilMail
const string	ILIAS_HOST = 'ilias'

const string	PROP_CONTEXT_SUBJECT_PREFIX = 'subject_prefix'

int	$user_id

Protected Attributes inherited from ilMail
array	$mail_data = []

Detailed Description

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om TODO All these utility functions could be moved to some kind of decorator once a mail is an elaborated object and not an array anymore

Definition at line 25 of file class.ilFormatMail.php.

Member Function Documentation

◆ appendSearchResult()

ilFormatMail::appendSearchResult	(	array	$a_names,
		string	$a_type
	)

Parameters

list<string> $a_names

Definition at line 69 of file class.ilFormatMail.php.

References ilMail\$mail_data.

                                                                       : array
     {
         $name_str = implode(',', $a_names);
 
         $key = 'rcp_to';
         if ($a_type === 'cc') {
             $key = 'rcp_cc';
         } elseif ($a_type === 'bc') {
             $key = 'rcp_bcc';
         }
 
         if (!isset($this->mail_data[$key]) || !is_string($this->mail_data[$key])) {
             $this->mail_data[$key] = '';
         } else {
             $this->mail_data[$key] = trim($this->mail_data[$key]);
         }
 
         if ($this->mail_data[$key] !== '') {
             $this->mail_data[$key] .= ',';
         }
         $this->mail_data[$key] .= $name_str;
 
         return $this->mail_data;
     }

◆ appendSignature()

ilFormatMail::appendSignature ( string $message )

Definition at line 94 of file class.ilFormatMail.php.

                                                     : string
     {
         return $message . (chr(13) . chr(10) . $this->mail_options->getSignature());
     }

◆ formatForwardSubject()

ilFormatMail::formatForwardSubject ( string $subject )

Definition at line 124 of file class.ilFormatMail.php.

                                                          : string
     {
         return '[FWD: ' . $subject . ']';
     }

◆ formatReplyMessage()

ilFormatMail::formatReplyMessage ( string $message )

Definition at line 109 of file class.ilFormatMail.php.

                                                        : string
     {
         $bodylines = preg_split("/\r\n|\n|\r/", $message);
         foreach ($bodylines as $i => $value) {
             $bodylines[$i] = '> ' . $value;
         }
 
         return implode(chr(10), $bodylines);
     }

◆ formatReplyRecipient()

ilFormatMail::formatReplyRecipient ( )

Definition at line 56 of file class.ilFormatMail.php.

                                           : string
     {
         if (empty($this->mail_data)) {
             return '';
         }
 
         $user = new ilObjUser((int) $this->mail_data['sender_id']);
         return $this->mail_data['rcp_to'] = $user->getLogin();
     }

◆ formatReplyRecipientsForCC()

ilFormatMail::formatReplyRecipientsForCC ( )

Definition at line 27 of file class.ilFormatMail.php.

References $DIC.

                                                 : string
     {
         global $DIC;
 
         if (empty($this->mail_data)) {
             return '';
         }
 
         $new_cc = [];
 
         $current_usr_login = $DIC->user()->getLogin();
 
         foreach (explode(',', (string) $this->mail_data['rcp_to']) as $to) {
             $to = trim($to);
             if ($to !== '' && $current_usr_login !== $to) {
                 $new_cc[] = $to;
             }
         }
 
         foreach (explode(',', (string) $this->mail_data['rcp_cc']) as $cc) {
             $cc = trim($cc);
             if ($cc !== '' && $current_usr_login !== $cc) {
                 $new_cc[] = $cc;
             }
         }
 
         return $this->mail_data['rcp_cc'] = implode(', ', $new_cc);
     }

◆ formatReplySubject()

ilFormatMail::formatReplySubject ( string $subject )

Definition at line 119 of file class.ilFormatMail.php.

                                                        : string
     {
         return 'RE: ' . $subject;
     }

◆ prependSignature()

ilFormatMail::prependSignature ( string $message )

Definition at line 99 of file class.ilFormatMail.php.

References $message.

                                                      : string
     {
         return $this->mail_options->getSignature() .
             chr(13) .
             chr(10) .
             chr(13) .
             chr(10) .
             $message;
     }

The documentation for this class was generated from the following file:

components/ILIAS/Mail/classes/class.ilFormatMail.php

Public Member Functions

Additional Inherited Members