iconv_mime_encode

(PHP 5, PHP 7, PHP 8)

iconv_mime_encode — Construit un en-tête MIME avec les champs field_name et field_value

Description

iconv_mime_encode(string $field_name, string $field_value, array $options = []): string|false

iconv_mime_encode() compose et retourne une chaîne de caractères qui représente un champ en-tête MIME qui ressemble à : 

Subject: =?ISO-8859-1?Q?Pr=FCfung_f=FCr?= Entwerfen von einer MIME kopfzeile
Dans l'exemple ci-dessus, "Subject" est le nom du champ et la portion qui commence par "=?ISO-8859-1?..." est la valeur du champ.

Liste de paramètres

field_name

Le nom du champ.

field_value

La valeur du champ.

options

Il est possible de contrôler le comportement de la fonction iconv_mime_encode() en spécifiant un tableau associatif contenant la configuration des éléments dans le paramètre options. La liste des éléments supportés par iconv_mime_encode() figure ci-dessous. Il est à noter que les noms des éléments sont sensibles à la casse.

Liste des éléments supportés par iconv_mime_encode()
Élément Type Description Valeur par défaut Exemple
scheme string Spécifie la méthode d'encodage d'un champ. Les valeurs possibles sont "B" ou "Q", où "B" signifie que le schéma d'encodage sera base64 et "Q", quoted-printable. B B
input-charset string Spécifie le jeu de caractères pour représenter le premier paramètre field_name et le second paramètre field_value. S'il est omis, iconv_mime_encode() utilisera la directive de configuration iconv.internal_encoding du php.ini pour les représenter. iconv.internal_encoding ISO-8859-1
output-charset string Spécifie le jeu de caractères à utiliser pour composer l'en-tête MIME. iconv.internal_encoding UTF-8
line-length int Spécifie la longueur maximale de chaque en-tête. Si l'en-tête est plus grand que la longueur définie par ce paramètre, l'en-tête résultant sera un en-tête composé de plusieurs lignes conformément au standard » RFC2822 - Internet Message Format. S'il est omis, la longueur maximale sera fixée à 76 caractères. 76 996
line-break-chars string Spécifie les caractères de fin de ligne. S'il est omis, la valeur par défaut sera "\r\n" (CR LF). Il est à noter que ce paramètre est toujours représenté comme une chaîne ASCII au regard de la valeur du paramètre input-charset. \r\n \n

Valeurs de retour

Retourne un champ MIME en cas de succès, ou false si une erreur survient durant l'encodage.

Exemples

Exemple #1 Exemple avec iconv_mime_encode()

<?php
$preferences = array(
"input-charset" => "ISO-8859-1",
"output-charset" => "UTF-8",
"line-length" => 76,
"line-break-chars" => "\n"
);
$preferences["scheme"] = "Q";
// Ceci donne : "Subject: =?UTF-8?Q?Pr=C3=BCfung=20Pr=C3=BCfung?="
echo iconv_mime_encode("Subject", "Prüfung Prüfung", $preferences);

$preferences["scheme"] = "B";
// Ceci donne : "Subject: =?UTF-8?B?UHLDvGZ1bmcgUHLDvGZ1bmc=?="
echo iconv_mime_encode("Subject", "Prüfung Prüfung", $preferences);
?>

Voir aussi