libmail - A mail handling library Code

.\" This file is part of libmail.
.\" 
.\"	(c) 2009 - Dimitris Mandalidis <mandas@users.sourceforge.net>
.\"
.\" libmail is free software: you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation, either version 3 of the License, or
.\" (at your option) any later version.
.\" 
.\" libmail is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\" 
.\" You should have received a copy of the GNU General Public License
.\" along with libmail.  If not, see <http://www.gnu.org/licenses/>.
.TH POP3_CONNECT 3 "2009-06-20" "version 0.3" "libmail - A mail handling library"
.SH NAME
pop3_disconnect, pop3_connect - Connect/Disconnect to/from POP3 remote server
.SH SYNOPSIS
.nf
.B #include <libmail/libmail.h>
.B #include <libmail/pop3.h>
.sp
.BI "int pop3_connect(pop3_mailbox_t *" "mailbox" );
.sp
.BI "int pop3_disconnect(pop3_mailbox_t *" "mailbox" );
.sp
.fi
.SH DESCRIPTION
Used to connect or disconnect from an POP3 remote server.  All the above functions takes a pointer to 
.B pop3_mailbox_t 
structure which identify the server's configuration. 
.SH "RETURN VALUE"
.B LIBMAIL_SUCCESS 
is returned on success. On error they return the following non-zero error codes :
.TP
.B LIBMAIL_SYSERROR
A system error occurred, errno defined in <errno.h> was set. 
.TP
.B LIBMAIL_DNSERROR
The remote hostname was invalid resulting in "unresolved hostname"\-like error. 
.TP
.B LIBMAIL_SRVERROR
Indicates that the server responded with an "BAD" or "NO" to a command.
.TP
.B LIBMAIL_TLSERROR
Indicates an error in TLS/SSL transaction context. 
.TP
.B LIBMAIL_ALREADY_CONNECTED
A connect call was made while already being connected.
.TP
.B LIBMAIL_ALREADY_DISCONNECTED
A disconnect call was made while already being disconnected.
.SH "SEE ALSO"
.B RFC 1939, RFC 2595, RFC 1734
.sp
.BR "libmail_strerror" "(3), " "set_pop3_auth_type" "(3), " "set_pop3_hostname" "(3), " "set_pop3_inet_family" "(3), " "set_pop3_mailbox" "(3), "
.BR "set_pop3_password" "(3), " "set_pop3_port" "(3), " "set_pop3_security_level" "(3), " "set_pop3_username" "(3), " "libmail_init_pop3_mailbox" "(3)."
.SH "AUTHOR"
Dimitris Mandalidis <mandas AT users DOT sourceforge DOT net>