Attributes

action_types

Reference to an array of the set of actions defined within Sendmail's milter code.

content_types

Reference to an array of the set of content types which may be witheld.

Methods

new

Constructor, creates a new blank Net::Milter object.

open

Open a socket to a milter filter. Takes three arguments, the last argument, can be 'tcp' or 'unix' depending if the connection is to be made to a TCP socket or through a UNIX file system socket. For TCP sockets, the first two argument are the IP address and the port number; for UNIX sockets the first argument is the file path, the second the timeout value. Accepted synonyms for tcp and unix are inet and local respecively.

e.g.

    $milter->open('127.0.0.1',5513,'tcp');
    

to open a connection to port 5513 on address 127.0.0.1, or

    $milter->open('/tmp/file.sck',10,'unix');
    

to open a connection to /tmp/file.sck with a timeout of 10 seconds.

The method creates the attribute, 'socket' containing an IO::Handle object.

protocol_negotiation

Talk to the milter filter, describing the list of actions it may perform, and any email content that won't be sent. Accepts as argument the hash of allowable actions and withheld content. The hash keys are : Allowable actions by the filter :

    $milter->protocol_negotiation(
        SMFIF_ADDHDRS => 0,
        SMFIF_CHGBODY => 1
        );

    $milter->protocol_negotiation(
        SMFIF_ADDHDRS => 0,
        SMFIF_CHGBODY => 1,
        SMFIP_NOEHO => 1,
        SMFIP_NOCONNECT => 1
    );

send_abort

Send an abort signal to the mail filter. Accepts nothing, returns nothing.

send_body

Send the body of the email to the mail filter. NOTE the filter will only accept up to 65535 bytes of body at a time. Feed the body to the filter piece by piece by repeat calls to send_body with each body chunk until all the body is sent. Accepts the message body, returns reference to an array of return codes (see RETURN CODE section).

send_end_body

Send an end of body signal, i.e. no more body information will follow. Returns a reference to an array of return codes (see RETURN CODE section).

send_connect

Send the SMTP connect information to the mail filter. Accepts the hostname, the family ('unix' for file sockets, 'tcp4' for tcp connections (v4), 'tcp6' for version 6 tcp connections), the sending connection port, the IP address of the sender. Returns a reference to an array of return codes (see RETURN CODE section).

e.g.

    $milter->send_connect(
                          'host.domain',
                          'tcp4',
                          '12345',
                          '127.0.0.1'
                          );
    

The machine host.domain with IP address 127.0.0.1 connected to us from port 12345 using TCP version 4.

send_helo

Send the HELO (or EHLO) string provided by the connecting computer. Accepts the HELO string as an argument. Returns a reference to an array of return codes (see RETURN CODE section).

send_header

Send a single header name and contents to the filter, accepts two arguments, the header name and the header contents. Returns a reference to an array of return codes (see RETURN CODE section).

send_mail_from

Send the MAIL FROM string to the filter, accepts the MAIL FROM data as an argument. Returns a reference to an array of return codes (see RETURN CODE section).

send_end_headers

Send an end of headers signal, i.e. no more header information will follow. Returns a reference to an array of return codes (see RETURN CODE section).

send_rcpt_to

Send the RCPT TO string to the filter, accepts an array of RCPT TO recipients as argument. Returns a reference to an array of return codes (see RETURN CODE section).

send_quit

Quit the milter communication, accepts nothing, returns nothing.

send_macros

Send Sendmail macro information to the filter. The method accepts a hash of the Sendmail macro names, returns a reference to an array of return codes (see RETURN CODE section).

The potential macro names (hash keys) are :