Get the address of the client.

Effective smtp stage

All of them.

Return

• string - the client’s address with the ip:port format.

Examples

#{
  connect: [
    action "log client address" || {
      log("info", `new client: ${ctx::client_address()}`);
    },
  ],
}

Get the ip address of the client.

Effective smtp stage

All of them.

Return

• string - the client’s ip address.

Example

#{
  connect: [
    action "log client ip" || {
      log("info", `new client: ${ctx::client_ip()}`);
    },
  ],
}

Get the ip port of the client.

Effective smtp stage

All of them.

Return

• int - the client’s port.

Example

#{
  connect: [
    action "log client address" || {
      log("info", `new client: ${ctx::client_ip()}:${ctx::client_port()}`);
    },
  ],
}

Get a the timestamp of the client’s connection time.

Effective smtp stage

All of them.

Return

• timestamp - the connexion timestamp of the client.

Example

#{
  connect: [
    action "log client" || {
      log("info", `new client connected at ${ctx::connection_timestamp()}`);
    },
  ],
}

Get the value of the HELO/EHLO command sent by the client.

Effective smtp stage

helo and onwards.

Return

• string - the value of the HELO/EHLO command.

Examples

#{
    helo: [
       action "log info" || log("info", `helo/ehlo value: ${ctx::helo()}`),
    ]
}

Has the connection been secured under the encryption protocol SSL/TLS.

Effective smtp stage

all of them.

Return

• bool - true if the connection is secured, false otherwise.

Example

#{
  connect: [
    action "log ssl/tls" || {
      log("info", `The client is ${if ctx::is_secured() { "secured" } else { "unsecured!!!" }}`)
    }
  ],
}

Get the value of the MAIL FROM command sent by the client.

Effective smtp stage

mail and onwards.

Return

• address - the sender address.

Examples

#{
    helo: [
       action "log info" || log("info", `received sender: ${ctx::mail_from()}`),
    ]
}

Get the time of reception of the email.

Effective smtp stage

preq and onwards.

Return

• string - the timestamp.

Examples

#{
    preq: [
       action "receiving the email" || log("info", `time of reception: ${ctx::mail_timestamp()}`),
    ]
}

Get the unique id of the received message.

Effective smtp stage

preq and onwards.

Return

• string - the message id.

Examples

#{
    preq: [
       action "message received" || log("info", `message id: ${ctx::message_id()}`),
    ]
}

Get the value of the current RCPT TO command sent by the client.

Effective smtp stage

rcpt and onwards. Please note that ctx::rcpt() will always return the last recipient received in stages after the rcpt stage. Therefore, this functions is best used in the rcpt stage.

Return

• address - the address of the received recipient.

Examples

#{
    rcpt: [
       action "log recipients" || log("info", `new recipient: ${ctx::rcpt()}`),
    ]
}

Get the list of recipients received by the client.

Effective smtp stage

rcpt and onwards. Note that you will not have all recipients received all at once in the rcpt stage. It is better to use this function in the later stages.

Return

• Array of addresses - the list containing all recipients.

Examples

#{
    preq: [
       action "log recipients" || log("info", `recipients: ${ctx::rcpt_list()}`),
    ]
}

Get the full server address.

Effective smtp stage

All of them.

Return

• string - the server’s address with the ip:port format.

Example

#{
  connect: [
    action "log server address" || {
      log("info", `server: ${ctx::server_address()}`);
    },
  ],
}

Get the server’s ip.

Effective smtp stage

All of them.

Return

• string - the server’s ip.

Example

#{
  connect: [
    action "log server ip" || {
      log("info", `server: ${ctx::server_ip()}`);
    },
  ],
}

Get the name of the server.

Effective smtp stage

All of them.

Return

• string - the name of the server.

Example

#{
  connect: [
    action "log server" || {
      log("info", `server name: ${ctx::server_name()}`);
    },
  ],
}

Get the server’s port.

Effective smtp stage

All of them.

Return

• string - the server’s port.

Example

#{
  connect: [
    action "log server address" || {
      log("info", `server: ${ctx::server_ip()}:${ctx::server_port()}`);
    },
  ],
}

Produce a serialized JSON representation of the mail context.