Sisimai::Bite::Email::UserDefined(3pm)

Sisimai::Bite::Email::UserDefined3pm

User defined mta module as an example

Usage

    use lib '/path/to/your/lib/dir';
    use Your::Custom::Bite::Email::Module;
    use Sisimai::Mail;
    use Sisimai::Data;
    use Sisimai::Message;
    my $file = '/path/to/mailbox';
    my $mail = Sisimai::Mail->new($file);
    my $mesg = undef;
    my $data = undef;
    while( my $r = $mail->read ){ 
        $mesg = Sisimai::Message->new( 
                    'data' => $r,
                    'load' => ['Your::Custom::Bite::Email::Module']
                ); 
        $data = Sisimai::Data->make('data' => $mesg); 
        ...
    }

Overview

Sisimai::Bite::Email::UserDefined is an example module as a template to implement your custom MTA module.

Class methods

"description()"

"description()" returns description string of this module.

    print Your::Custom::Bite::Email::Module->description;

"smtpagent()"

"smtpagent()" returns MTA name.

    print Your::Custom::Bite::Email::Module->smtpagent;

"scan(header data, reference to body string)"

"scan()" method parses a bounced email and return results as a array reference. See Sisimai::Message for more details.

Author

azumakuniyuki

License

This software is distributed under The BSD 2-Clause License.

From libsisimai-perl 4.24.1-1 in Debian 10 (Buster). Parsed by carta from the page's man source.