# final class \SmartMailerMimeParser
{ } ::

Class: SmartMailerMimeParser - provides an easy to use eMail MIME Parser.

- Language: PHP
- Located at: lib/core/plugins/lib_mail_utils.php
- Package: Application:Plugins:Mailer
- Namespace: \
- Class Name: SmartMailerMimeParser
- Version: v.20240118
- Depends: classes: Smart, SmartHashCrypto, SmartUtils, SmartFileSysUtils, SmartFileSystem, SmartMailerMimeDecode, SmartMailerNotes
- Usage: static object: Class::method() - This class provides only STATIC methods

## class Methods

public static function encode_mime_fileurl ( string $y_msg_file, string $y_ctrl_key ) {} :: STRING
@return: {STRING} the encoded and encrypted url segment
@param: {STRING} $y_msg_file: The relative path to the .eml message file
@param: {STRING} $y_ctrl_key: The encryption private key
Encode and Encrypts a Mime File URL using the crypto algo defined in SMART_FRAMEWORK_SECURITY_CRYPTO or 'hash/sha3-384' as a fallback
It takes in account if the User is Authenticated or not
This make safe using Mail Message Parts URL links sent by URL for specific and private user access
public static function decode_mime_fileurl ( string $y_enc_msg_file, string $y_ctrl_key ) {} :: ARRAY
@return: {ARRAY} with the decoded and decrypted url segment containing all required information to validate the email message path
@param: {STRING} $y_enc_msg_file: The encoded/encrypted path to the .eml message file
@param: {STRING} $y_ctrl_key: The decryption private key
Decode and Decrypts a Mime File URL encoded/encrypted with encode_mime_fileurl()
It takes in account if the User is Authenticated or not
public static function display_message ( string $y_msg_type, string $y_enc_msg_file, string $y_ctrl_key, string $y_link, string $y_target = "", string $y_title = "", string $y_process_mode = "", string $y_show_headers = "" ) {} :: STRING
@return: {STRING} the HTML view of the message linked with all sub-parts in a safe way by making use of encode_mime_fileurl() and decode_mime_fileurl()
Get an Email Message (.eml) as HTML
public static function get_message_data_structure ( string $y_msg_type, string $y_enc_msg_file, string $y_ctrl_key, string $y_process_mode, string $y_link = "", string $y_target = "" ) {} :: ARRAY
@return: {ARRAY} with the full message structure as parts and all sub-parts in a safe way by making use of encode_mime_fileurl() and decode_mime_fileurl()
Get an Email Message (.eml) as ARRAY
This can be used to re-compose a Mime Message for Reply or Forward

## class Properties

## class Constants

documentation generated on: 2024-12-16 16:53:45 +0000

Smart.Framework © 2009-2024 unix-world.org