view release on metacpan or  search on metacpan

lib/Mail/Transport/POP3.pod  view on Meta::CPAN

Extends L<"Constructors" in Mail::Transport::Receive|Mail::Transport::Receive/"Constructors">.

=over 4

=item $class-E<gt>B<new>(%options)

Create a new pop3 server connection.  One object can only handle one
connection: for a single user to one single server.  If the server
could not be reached, or when the login fails, this instantiating C<new>
will return C<undef>.
Improves base, see L<Mail::Reporter/"Constructors">

 -Option      --Defined in     --Default
  authenticate                   'AUTO'
  executable    Mail::Transport  undef
  hostname      Mail::Transport  'localhost'
  interval      Mail::Transport  30
  password      Mail::Transport  undef
  port          Mail::Transport  110
  proxy         Mail::Transport  undef
  retry         Mail::Transport  <unlimited>
  ssl_options                    undef
  timeout       Mail::Transport  120
  use_ssl                        false
  username      Mail::Transport  undef
  via           Mail::Transport  'sendmail'

=over 2

=item authenticate => 'LOGIN'|'APOP'|'AUTO'|'OAUTH2'|'OAUTH2_SEP'

Authenthication method.  The standard defines two methods, named LOGIN and
APOP.  The first sends the username and password in plain text to the server
to get permission, the latter encrypts this data using MD5.  When AUTO is
used, first APOP is tried, and then LOGIN.

OAUTH* requires the authorization token to be passed as Password.
Microsoft Office365 needs C<OAUTH2_SEP>, where other oauth2
implementations use C<OAUTH2>.

=item executable => $file

=item hostname => $host|\@hosts

=item interval => $span

=item password => $password

=item port => $port

=item proxy => $path

=item retry => $count|undef

=item ssl_options => HASH

Unless overruled, C<verify_hostname> will be set to C<false> and
C<SSL_verify_mode> to C<SSL_VERIFY_NONE}>

You can also set the SSL parameters via IO::Socket::SSL subroutine set_defaults.
Connections will get restarted when they are lost: you have to keep the
defaults in place during POP actions.

=item timeout => $span

=item use_ssl => BOOLEAN

=item username => $username

=item via => CLASS|$name

=back

=back

=head2 Attributes

Extends L<"Attributes" in Mail::Transport::Receive|Mail::Transport::Receive/"Attributes">.

=over 4

=item $obj-E<gt>B<SSLOptions>()

Z<>

=item $obj-E<gt>B<supportsUIDL>()

Z<>

=item $obj-E<gt>B<useSSL>()

Returns C<true> when SSL must be used.

=back

=head2 Receiving mail

Extends L<"Receiving mail" in Mail::Transport::Receive|Mail::Transport::Receive/"Receiving mail">.

=over 4

=item $obj-E<gt>B<receive>( [$unique_message_id] )

Inherited, see L<Mail::Transport::Receive/"Receiving mail">

=back

=head2 Exchanging information

=over 4

=item $obj-E<gt>B<deleteFetched>()

Mark all messages that have been fetched with L<message()|Mail::Transport::POP3/"Exchanging information"> for deletion.
See L<fetched()|Mail::Transport::POP3/"Exchanging information">.

=item $obj-E<gt>B<deleted>(BOOLEAN, @ids)

Either mark the specified message(s) to be deleted on the remote server or
unmark them for deletion (if the first parameter is C<false>).  Deletion of