Struct milter::ActionContext

pub struct ActionContext<T> {
    pub data: DataHandle<T>,
    // some fields omitted
}

Context supplied to the eom milter callback, where message-modifying actions can be taken.

The ActionContext struct supports the same operations as Context. The safety note regarding Context applies here as well.

Important: Action methods may only be called if they have been configured with Milter::actions or during negotiation.

Fields

data: DataHandle<T>

A handle on user data associated with this context.

Methods

impl<T> ActionContext<T>

pub fn new(ptr: *mut SMFICTX) -> Self

Constructs a new ActionContext from the milter library-supplied raw context pointer.

You do not normally need to use new; an ActionContext is already supplied to the on_eom callback.

Panics

Panics if ptr is null.

pub fn macro_value(&self, name: &str) -> Result<Option<&str>>

Same as Context::macro_value.

pub fn set_error_reply(
    &self,
    code: &str,
    ext_code: Option<&str>,
    msg_lines: Vec<&str>
) -> Result<()>

Same as Context::set_error_reply.

pub fn replace_sender(
    &self,
    mail_from: &str,
    esmtp_args: Option<&str>
) -> Result<()>

Replaces the envelope sender (MAIL FROM address) of the current message with mail_from. Optional additional ESMTP arguments to the MAIL command may be given in esmtp_args.

This action is enabled with the flag Actions::REPLACE_SENDER.

Errors

An error variant is returned if type conversion at the FFI boundary fails, or if the milter library returns a failure status.

pub fn add_recipient(
    &self,
    rcpt_to: &str,
    esmtp_args: Option<&str>
) -> Result<()>

Adds envelope recipient (RCPT TO address) rcpt_to to the current message. Optional additional ESMTP arguments to the RCPT command may be given in esmtp_args.

This action is enabled with two distinct flags:

• Actions::ADD_RECIPIENT if no ESMTP arguments are specified
• Actions::ADD_RECIPIENT_EXT if additional ESMTP arguments are specified

Errors

An error variant is returned if type conversion at the FFI boundary fails, or if the milter library returns a failure status.

pub fn remove_recipient(&self, rcpt_to: &str) -> Result<()>

Removes envelope recipient (RCPT TO address) rcpt_to from the current message.

This action is enabled with the flag Actions::REMOVE_RECIPIENT.

Errors

An error variant is returned if type conversion at the FFI boundary fails, or if the milter library returns a failure status.

pub fn add_header(&self, name: &str, value: &str) -> Result<()>

Appends a header to the list of headers of the current message. If the header value is to span multiple lines, use \n (followed by whitespace) as the line separator, not \r\n.

This action is enabled with the flag Actions::ADD_HEADER.

Errors

An error variant is returned if type conversion at the FFI boundary fails, or if the milter library returns a failure status.

Examples

context.add_header(
    "Content-Type",
    "multipart/signed; micalg=pgp-sha512;
\tprotocol=\"application/pgp-signature\"; boundary=\"=-=-=\"",
)?;

pub fn insert_header(&self, index: usize, name: &str, value: &str) -> Result<()>

Inserts a header at index in the list of headers of the current message. If the header value is to span multiple lines, use \n (followed by whitespace) as the line separator, not \r\n.

This action is enabled with the flag Actions::ADD_HEADER.

Errors

An error variant is returned if type conversion at the FFI boundary fails, or if the milter library returns a failure status.

pub fn replace_header(
    &self,
    name: &str,
    index: usize,
    value: Option<&str>
) -> Result<()>

Replaces (or removes, or appends) a header at the index’th occurrence of headers with the given name for the current message. The index is 1-based (starts at 1).

More precisely,

• replaces the index’th occurrence of headers named name with the specified value;
• if the value is None, the header is instead removed;
• if index is greater than the number of occurrences of headers named name, a new header is instead appended.

If the header value is to span multiple lines, use \n (followed by whitespace) as the line separator, not \r\n.

This action is enabled with the flag Actions::REPLACE_HEADER.

Errors

An error variant is returned if type conversion at the FFI boundary fails, or if the milter library returns a failure status.

pub fn append_new_body_chunk(&self, content: &[u8]) -> Result<()>

Appends a chunk of bytes to the new message body of the current message.

This method may be called repeatedly: initially empty, the new body is augmented with additional content with each call. If this method is not called, the original message body remains unchanged.

This action is enabled with the flag Actions::REPLACE_BODY.

Errors

An error variant is returned if the milter library returns a failure status.

pub fn quarantine(&self, reason: &str) -> Result<()>

Quarantines the current message for the given reason.

This action is enabled with the flag Actions::QUARANTINE.

Errors

An error variant is returned if type conversion at the FFI boundary fails, or if the milter library returns a failure status.

pub fn keepalive(&self) -> Result<()>

Signals to the milter library that this milter is still active, causing it to reset timeouts.

Errors

An error variant is returned if the milter library returns a failure status.

Trait Implementations

impl<T: Debug> Debug for ActionContext<T>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.