Skip to content

Latest commit

 

History

History
87 lines (49 loc) · 2.17 KB

Transaction.md

File metadata and controls

87 lines (49 loc) · 2.17 KB
Raw

Transaction Object

An SMTP transaction is valid from MAIL FROM time until RSET or "final-dot".

API

  • transaction.uuid

A unique UUID for this transaction. Is equal to the connection.uuid + '.N' where N increments for each transaction on this connection.

  • transaction.mail_from

The value of the MAIL FROM command as an Address object.

  • transaction.rcpt_to

An Array of Address objects of recipients from the RCPT TO command.

  • transaction.data_lines

An Array of the lines of the email after DATA.

  • transaction.data_bytes

The number of bytes in the email after DATA.

  • transaction.add_data(line)

Adds a line of data to the email. Note this is RAW email - it isn't useful for adding banners to the email.

  • transaction.notes

A safe place to store transaction specific values.

  • transaction.add_leading_header(key, value)

Adds a header to the top of the header list. This should only be used in very specific cases. Most people will want to use add_header() instead.

  • transaction.add_header(key, value)

Adds a header to the email.

  • transaction.remove_header(key)

Deletes a header from the email.

  • transaction.header

The header of the email. See Header Object.

  • transaction.parse_body

Set to 1 to enable parsing of the mail body. Make sure you set this in hook_data or before.

  • transaction.body

The body of the email if you set parse_body above. See Body Object.

  • transaction.attachment_hooks(start, data, end)

Sets event emitter hooks for attachments if you set parse_body above.

The start event will receive (content_type, filename, body) as parameters.

The data event will receive a Buffer object containing some of the attachment data.

The end event will be called with no parameters when an attachment ends.

Both the data and end params are optional.

Note that in the start event, you can set per-attachment events via:

body.on('attachment_data', cb)
body.on('attachment_end', cb)
  • transaction.set_banner(text, html)

Sets a banner to be added to the end of the email. If the html part is not given (optional) then the text part will have each line ending replaced with <br/> when being inserted into HTML parts.