Node: <imap>

Node: imap

<imap enabled="yes" createdir="yes">filename</imap>

Attributes:

enabled

yes
no

createdir

yes
no

Notes

As of v2.0.23 <imap> is just a specialized <copy> node using the prepend="000000000000000000000000\r\n" attribute of <copy> to include the necessary IMAP header in the destination file. It is suggested that <copy> be used in favor of <imap> when creating new filter result operations. <imap> is now deprecated in favor of <copy>, though will still be supported for legacy configurations.

Creates an IMAP-formatted copy of the email in the filename specified. Use the filename as a template to describe the path and file name of the destination file. Extra information is written at the top of an IMAP email file that is used by the mail server software to store certain status codes and other indexing information.

If the destination directory does not exist and the createdir attribute is set to yes the directory is created.

IMAP requirements vary by mail server. In this release, the IMAP file is formatted for Merak Mail's requirements. The implementation is very basic and is not complete, but it will function, however you have limited means of controlling the specific IMAP folder messages will be copied to.

These macros are expanded dynamically to form the filename at run-time:

{yyyy}		4-digit year (0000-9999), System Time
{yy}		2-digit year (00-99), System Time
{mm}		2-digit month (01-12), System Time
{dd}		2-digit day of month (01-31), System Time
{utcyyyy}		4-digit year (0000-9999), Universal Coordinated Time
{utcyy}		2-digit year (00-99), Universal Coordinated Time
{utcmm}		2-digit month (01-12), Universal Coordinated Time
{utcdd}		2-digit day of month (01-31), Universal Coordinated Time
{source:drive}		Drive letter of source email file
{source:directory}		Path of source email file
{source:filename}		File name (without extension) of source email file
{source:extension}		File extension of source email file (include beginning period)
{smtp:client_ip}		SMTP Client IP address or "no_client_ip" if no IP address is provided by the mail server
{smtp:mail_from}		SMTP MAIL FROM data or "no_mail_from" if no MAIL FROM data is provided by the mail server
{smtp:rcpt_to}		SMTP RCPT TO data or "no_rcpt_to" if no RCPT TO data is provided by the mail server; some mail servers present an email with multiple recipients to the content filter only once with all recipients listed, in those cases only the first email address is used for macro expansion
{smtp:rcpt_to_mailbox}		SMTP RCPT TO mailbox data (text to the left of the "@") or "no_rcpt_to_mailbox" if no RCPT TO data is provided by the mail server; some mail servers present an email with multiple recipients to the content filter only once with all recipients listed, in those cases only the first email address is used for macro expansion
{smtp:rcpt_to_domain}		SMTP RCPT TO domain data (text to the right of the "@") or "no_rcpt_to_domain" if no RCPT TO data is provided by the mail server; some mail servers present an email with multiple recipients to the content filter only once with all recipients listed, in those cases only the first email address is used for macro expansion
{smtp:recipient_id}		2-digit recipient id (index of which recipient in RCPT TO is being processed)

Revision History:

- Multiple <imap> nodes is supported in v2.0.23 and higher