mail::loginUrlEncode(3x)

1mail::loginUrlEncode(3x)    Miscellaneous functions   mail::loginUrlEncode(3x)
2
3
4

NAME

6       mail::loginUrlEncode - Create a mail account URL
7

SYNOPSIS

9             #include <libmail/mail.H>
10
11
12
13       std::string  url=mail::loginUrlEncode  (std::string method, std::string
14       server, std::string uid, std::string password);
15

USAGE

17       This    utility    function    creates    a    URL,    suitable     for
18       mail::account::open(3x), for opening a mail account on a remote server.
19
20       method  is  one  of  the  supported  libmail network protocols: "imap",
21       "imaps", "pop3", "pop3s", "nntp", "nntps", "smtp", or "smtps".   server
22       is the remote server name.  The server name is optionally appended by a
23       colon and a port number, to specify a non-default port for  the  proto‐
24       col.
25
26       uid  identifies  the mail account's login id.  With "smtp", or "smtps",
27       uid specifies the userid for  authenticated  ESMTP.   The  password  is
28       optional.   mail::account::open(3x) accepts a separate password parame‐
29       ter.  This password should be an empty string, so  that  the  resulting
30       URL does not include the password.  The real password is then passed as
31       a parameter to mail::account::open(3x).  As an alternative, this  pass‐
32       word  parameter can be initialized.  The resulting URL will include the
33       password, and the the password  parameter  to  mail::account::open(3x).
34       should be set to an empty string.
35
36   OPTIONS
37       Additional protocol options are specified by prefixing each option with
38       the forward-slash character, "/", and appending all options  to  server
39       (after any optional protocol port number).
40

RETURN CODES

42       This function returns the resulting URL.
43

NAME

SYNOPSIS

USAGE

RETURN CODES

SEE ALSO