Acceso A Buzones IMAP

eBD:IMAP

Sintaxis:

HTML

<eBD:IMAP SERVER="server_address" [PORT="143"]
USERNAME="username" PASSWORD="password" VAR="varname"/>

Acción:
Conecta con un servidor IMAP y almacena la conexión en la variable varname

Ejemplo:

HTML

<eBD:IMAP SERVER="$my_server_ip" USERNAME="$user" PASSWORD="$pwd" VAR="imap"/>

eBD:IMAP_COPY

Sintaxis:

HTML

<eBD:IMAP_COPY IMAP="varname" ID="message_id"
FROM="INBOX.folder.name" TO="INBOX.folder.other.name"/>

Acción:
Copia un mensaje de un mailbox (o carpeta) a otro

Ejemplo:

HTML

<eBD:IMAP_COPY IMAP="$imap" ID="$id" FROM="INBOX" TO="INBOX.folder"/>

eBD:IMAP_CREATE

Sintaxis:

HTML

<eBD:IMAP_CREATE IMAP="varname" MAILBOX="INBOX.folder.name" />

Acción:
Crea una nueva carpeta o mailbox

Ejemplo:

HTML

<eBD:IMAP_CREATE IMAP="$imap" MAILBOX="INBOX.other" />

eBD:IMAP_DELETE

Sintaxis:

HTML

<eBD:IMAP_DELETE IMAP="varname" MAILBOX="INBOX.folder.name" [ ID="message_id" ] />

Acción:
Borra todo un mailbox (o carpeta) o sólo un mensaje de esa carpeta (si se indica el parámetro ID).

Ejemplo:

HTML

<eBD:IMAP_DELETE IMAP="$imap" MAILBOX="INBOX.folder" ID="$message_id"/>

eBD:IMAP_GET

Sintaxis:

HTML

<eBD:IMAP_GET IMAP="varname" MAILBOX="INBOX.folder.name"
[ SEARCH="search_hash" ] [ ID="message_id" ] [ STRINGIFY="1|0" ] VAR="[string|list|hash]"/>

Acción:
Obtiene la lista de mensages de un mailbox, o descarga el mensaje de ese mailbox identificado con el
parámetro ID. El parámetro STRINGIFY indica si el mensaje debe descargarse como una estructura de datos (HASH) o como un string (código fuente del mensaje).

El parámetro SEARCH permite realizar búsquedas en el FROM, TO o SUBJECT de los mensajes, si no se especifica por defecto su valor será 'All'.

Ejemplo:

HTML

<eBD:IMAP_GET IMAP="$imap" MAILBOX="INBOX" VAR="headers"/>
<eBD:IMAP_GET IMAP="$imap" MAILBOX="INBOX" ID="$message_id" VAR="msg_content"/>
<eBD:SET VAR="search" INDEX="from" VALUE="ebdsoft.com"/>
<eBD:SET VAR="search" INDEX="to" VALUE="cjuan"/>
<eBD:SET VAR="search" INDEX="subject" VALUE="this is a message"/>
<eBD:IMAP_GET IMAP="$imap" MAILBOX="INBOX" SEARCH="$search" VAR="messages"/>

eBD:IMAP_MAILBOXES

Sintaxis:

HTML

<eBD:IMAP_MAILBOXES IMAP="varname" [ MAILBOX="INBOX.folder" ] VAR="arrayname"/>

Acción:
Devuelve el arbol de mailboxes o carpetas de la raiz, o solo las subcarpetas de una carpeta concreta (si se identifica con el parámetro MAILBOX).

Ejemplo:

HTML

<eBD:IMAP_MAILBOXES IMAP="$imap" VAR="foldertree"/>
<eBD:IMAP_MAILBOXES IMAP="$imap" MAILBOX="INBOX.folder" VAR="subfolders"/>

eBD:IMAP_RENAME

Sintaxis:

HTML

<eBD:IMAP_RENAME IMAP="varname" MAILBOX="INBOX.folder.name" TO="INBOX.folder.other"/>

Acción:
Renombra un mailbox o carpeta

Ejemplo:

HTML

<eBD:IMAP_RENAME IMAP="$imap" MAILBOX="INBOX.folder.name" TO="INBOX.folder.other"/>

eBD:IMAP_LOGOUT

Sintaxis:

HTML

<eBD:IMAP_LOGOUT IMAP="varname"/>

Acción:
Cierra la conexión con el servidor IMAP.

Ejemplo:

HTML

<eBD:IMAP_LOGOUT IMAP="$imap"/>

eBD:IMAP_FLAGS

Sintaxis:

HTML

<eBD:IMAP_FLAGS IMAP="varname" MAILBOX="INBOX.folder.name" ID="message_id"
ADD="\Seen|\Draft|\Answered|\Flagged|\Deleted|\Recent|my_label_1"
REMOVE="\Seen|\Draft|\Answered|\Flagged|\Deleted|\Recent|my_label_1"/>

Acción:
Modifica el estatus de los flags de los mensajes. Pueden ser flags definidos por el usuario o del sistema (que empiezan por una barra invertida), estos puedes ser:
\Seen \Answered \Flagged \Deleted \Draft \Recent

Ejemplo:

HTML

<eBD:IMAP_FLAGS IMAP="$imap" MAILBOX="INBOX" ID="$message_id" ADD="\Seen,my_label_1"
REMOVE="\Answered,my_label_2"/>

eBD:IMAP_STATUS

Sintaxis:

HTML

<eBD:IMAP_STATUS IMAP="varname" MAILBOX="INBOX.folder.name" VAR="hashname"/>

Acción:
Devuelve el número total de emails en la carpeta y el número de emails no leidos.

Ejemplo:

HTML

<eBD:IMAP_STATUS IMAP="$imap" MAILBOX="INBOX" VAR="num_of_messages"/>