1        ConeĀ©
2
3MAIL::LOGINURLENCODE(3x)Cone: COnsole Newsreader And EMAIL::LOGINURLENCODE(3x)
4
5
6

NAME

8       mail::loginUrlEncode - Create a mail account URL
9

SYNOPSIS

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

USAGE

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

RETURN CODES

45       This function returns the resulting URL.
46

SEE ALSO

48       mail::account::open(3x), mail::loginUrlEncode(3x).
49

AUTHOR

51       Sam Varshavchik
52
53
54
55ConeĀ©                             08/25/2016          MAIL::LOGINURLENCODE(3x)
Impressum