imap_append

(PHP 4, PHP 5, PHP 7, PHP 8)

imap_appendAcrescenta uma mensagem de string a uma caixa de correio especificada

Descrição

imap_append(
    IMAP\Connection $imap,
    string $folder,
    string $message,
    ?string $options = null,
    ?string $internal_date = null
): bool

Acrescenta uma mensagem string informada no parâmetro message à caixa informada em folder.

Parâmetros

imap

Uma instância de IMAP\Connection.

folder

O nome da caixa de correio, veja imap_open() para mais informações

Aviso

Passar dados não confiáveis para este parâmetro é inseguro, a menos que imap.enable_insecure_rsh esteja desabilitado.

message

A mensagem a ser anexada, como uma string

Ao comunicar com o servidor Cyrus IMAP, deve-se usar "\r\n" como o terminador de fim de linha em vez de "\n" ou a operação irá falhar

options

Se fornecido, o options também será gravado em folder.

internal_date

Se esse parâmetro for definido, ele definirá a data interna (INTERNALDATE) na mensagem anexada. O parâmetro deve ser uma string de data que esteja em conformidade com as especificações RFC2060 para um valor de data/horário.

Valor Retornado

Retorna true em caso de sucesso ou false em caso de falha.

Registro de Alterações

Versão Descrição
8.1.0 O parâmetro imap agora espera uma instância de IMAP\Connection; anteriormente, um resource imap válido era esperado.
8.0.0 options e internal_date agora podem ser nulos.

Exemplos

Exemplo #1 Exemplo de imap_append()

<?php
$imap
= imap_open("{imap.example.org}INBOX.Drafts", "username", "password");

$check = imap_check($imap);
echo
"Contagem de mensagens antes de anexar: ". $check->Nmsgs . "\n";

imap_append($imap, "{imap.example.org}INBOX.Drafts"
, "From: eu@example.com\r\n"
. "To: voce@example.com\r\n"
. "Subject: teste\r\n"
. "\r\n"
. "esta é uma mensagem de teste, favor ignorar\r\n"
);

$check = imap_check($imap);
echo
"Contagem de mensagens após anexar: ". $check->Nmsgs . "\n";

imap_close($imap);
?>