Transfer Event

Fired while the message text gets transferred to MailServer .

Syntax

htmlmailer.on('Transfer', [callback])

Callback

The 'callback' is called when the 'Transfer' event is emited.

function(e){ }

The argument 'e' has the following properties:

e.direction
e.bytesTransferred
e.percentDone

Remarks

One or more Transfer events are fired during message delivery. Messages consist of MessageText and an optional AttachedFile. The BytesTransferred parameter shows the number of bytes sent starting from the beginning of MessageText and/or AttachedFile.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note that events are not re-entrant. Performing time consuming operations within this event will prevent it from firing again in a timely manner and may impact overall performance.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks 2020 Node.js Edition - Version 20.0 [Build 8307]