Emakefile Makefile src/imapd.app.src src/smtpd.app.src @@ -1,123 +1,123 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<title>Module dets_store</title> -<link rel="stylesheet" type="text/css" href="stylesheet.css"> -</head> -<body bgcolor="white"> - -<h1>Module dets_store</h1> - -<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> - -<h2><a name="index">Function Index</a></h2> -<table width="100%" border="1"><tr><td valign="top"><a href="#check-1">check/1</a></td><td/></tr> -<tr><td valign="top"><a href="#config-0">config/0</a></td><td/></tr> -<tr><td valign="top"><a href="#create-1">create/1</a></td><td/></tr> -<tr><td valign="top"><a href="#delete-1">delete/1</a></td><td/></tr> -<tr><td valign="top"><a href="#delete-2">delete/2</a></td><td/></tr> -<tr><td valign="top"><a href="#deliver-1">deliver/1</a></td><td/></tr> -<tr><td valign="top"><a href="#drop-1">drop/1</a></td><td/></tr> -<tr><td valign="top"><a href="#ensure_inbox-1">ensure_inbox/1</a></td><td/></tr> -<tr><td valign="top"><a href="#filename-1">filename/1</a></td><td/></tr> -<tr><td valign="top"><a href="#info-1">info/1</a></td><td/></tr> -<tr><td valign="top"><a href="#info-2">info/2</a></td><td/></tr> -<tr><td valign="top"><a href="#insert-1">insert/1</a></td><td/></tr> -<tr><td valign="top"><a href="#list-0">list/0</a></td><td/></tr> -<tr><td valign="top"><a href="#list-1">list/1</a></td><td/></tr> -<tr><td valign="top"><a href="#message_name-1">message_name/1</a></td><td/></tr> -<tr><td valign="top"><a href="#mlist-3">mlist/3</a></td><td/></tr> -<tr><td valign="top"><a href="#recent-1">recent/1</a></td><td/></tr> -<tr><td valign="top"><a href="#select-1">select/1</a></td><td/></tr> -<tr><td valign="top"><a href="#select-2">select/2</a></td><td/></tr> -<tr><td valign="top"><a href="#unseen-1">unseen/1</a></td><td/></tr> -<tr><td valign="top"><a href="#update-1">update/1</a></td><td/></tr> -</table> - -<h2><a name="functions">Function Details</a></h2> - -<h3><a name="check-1">check/1</a></h3> -<tt>check(Type) -> term() -</tt> - -<h3><a name="config-0">config/0</a></h3> -<tt>config() -> term() -</tt> - -<h3><a name="create-1">create/1</a></h3> -<tt>create(Type) -> term() -</tt> - -<h3><a name="delete-1">delete/1</a></h3> -<tt>delete(X1) -> term() -</tt> - -<h3><a name="delete-2">delete/2</a></h3> -<tt>delete(Type, Key) -> term() -</tt> - -<h3><a name="deliver-1">deliver/1</a></h3> -<tt>deliver(Message) -> term() -</tt> - -<h3><a name="drop-1">drop/1</a></h3> -<tt>drop(Type) -> term() -</tt> - -<h3><a name="ensure_inbox-1">ensure_inbox/1</a></h3> -<tt>ensure_inbox(User) -> term() -</tt> - -<h3><a name="filename-1">filename/1</a></h3> -<tt>filename(Type) -> term() -</tt> - -<h3><a name="info-1">info/1</a></h3> -<tt>info(Type) -> term() -</tt> - -<h3><a name="info-2">info/2</a></h3> -<tt>info(Type, Key) -> term() -</tt> - -<h3><a name="insert-1">insert/1</a></h3> -<tt>insert(Domain) -> term() -</tt> - -<h3><a name="list-0">list/0</a></h3> -<tt>list() -> term() -</tt> - -<h3><a name="list-1">list/1</a></h3> -<tt>list(DomainName) -> term() -</tt> - -<h3><a name="message_name-1">message_name/1</a></h3> -<tt>message_name(Args) -> term() -</tt> - -<h3><a name="mlist-3">mlist/3</a></h3> -<tt>mlist(MailBoxName, X2, Subscribed) -> term() -</tt> - -<h3><a name="recent-1">recent/1</a></h3> -<tt>recent(X1) -> term() -</tt> - -<h3><a name="select-1">select/1</a></h3> -<tt>select(Domain) -> term() -</tt> - -<h3><a name="select-2">select/2</a></h3> -<tt>select(Type, Key) -> term() -</tt> - -<h3><a name="unseen-1">unseen/1</a></h3> -<tt>unseen(X1) -> term() -</tt> - -<h3><a name="update-1">update/1</a></h3> -<tt>update(Record) -> term() -</tt> -</body> -</html> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>Module dets_store</title> +<link rel="stylesheet" type="text/css" href="stylesheet.css"> +</head> +<body bgcolor="white"> + +<h1>Module dets_store</h1> + +<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> + +<h2><a name="index">Function Index</a></h2> +<table width="100%" border="1"><tr><td valign="top"><a href="#check-1">check/1</a></td><td/></tr> +<tr><td valign="top"><a href="#config-0">config/0</a></td><td/></tr> +<tr><td valign="top"><a href="#create-1">create/1</a></td><td/></tr> +<tr><td valign="top"><a href="#delete-1">delete/1</a></td><td/></tr> +<tr><td valign="top"><a href="#delete-2">delete/2</a></td><td/></tr> +<tr><td valign="top"><a href="#deliver-1">deliver/1</a></td><td/></tr> +<tr><td valign="top"><a href="#drop-1">drop/1</a></td><td/></tr> +<tr><td valign="top"><a href="#ensure_inbox-1">ensure_inbox/1</a></td><td/></tr> +<tr><td valign="top"><a href="#filename-1">filename/1</a></td><td/></tr> +<tr><td valign="top"><a href="#info-1">info/1</a></td><td/></tr> +<tr><td valign="top"><a href="#info-2">info/2</a></td><td/></tr> +<tr><td valign="top"><a href="#insert-1">insert/1</a></td><td/></tr> +<tr><td valign="top"><a href="#list-0">list/0</a></td><td/></tr> +<tr><td valign="top"><a href="#list-1">list/1</a></td><td/></tr> +<tr><td valign="top"><a href="#message_name-1">message_name/1</a></td><td/></tr> +<tr><td valign="top"><a href="#mlist-3">mlist/3</a></td><td/></tr> +<tr><td valign="top"><a href="#recent-1">recent/1</a></td><td/></tr> +<tr><td valign="top"><a href="#select-1">select/1</a></td><td/></tr> +<tr><td valign="top"><a href="#select-2">select/2</a></td><td/></tr> +<tr><td valign="top"><a href="#unseen-1">unseen/1</a></td><td/></tr> +<tr><td valign="top"><a href="#update-1">update/1</a></td><td/></tr> +</table> + +<h2><a name="functions">Function Details</a></h2> + +<h3><a name="check-1">check/1</a></h3> +<tt>check(Type) -> term() +</tt> + +<h3><a name="config-0">config/0</a></h3> +<tt>config() -> term() +</tt> + +<h3><a name="create-1">create/1</a></h3> +<tt>create(Type) -> term() +</tt> + +<h3><a name="delete-1">delete/1</a></h3> +<tt>delete(X1) -> term() +</tt> + +<h3><a name="delete-2">delete/2</a></h3> +<tt>delete(Type, Key) -> term() +</tt> + +<h3><a name="deliver-1">deliver/1</a></h3> +<tt>deliver(Message) -> term() +</tt> + +<h3><a name="drop-1">drop/1</a></h3> +<tt>drop(Type) -> term() +</tt> + +<h3><a name="ensure_inbox-1">ensure_inbox/1</a></h3> +<tt>ensure_inbox(User) -> term() +</tt> + +<h3><a name="filename-1">filename/1</a></h3> +<tt>filename(Type) -> term() +</tt> + +<h3><a name="info-1">info/1</a></h3> +<tt>info(Type) -> term() +</tt> + +<h3><a name="info-2">info/2</a></h3> +<tt>info(Type, Key) -> term() +</tt> + +<h3><a name="insert-1">insert/1</a></h3> +<tt>insert(Domain) -> term() +</tt> + +<h3><a name="list-0">list/0</a></h3> +<tt>list() -> term() +</tt> + +<h3><a name="list-1">list/1</a></h3> +<tt>list(DomainName) -> term() +</tt> + +<h3><a name="message_name-1">message_name/1</a></h3> +<tt>message_name(Args) -> term() +</tt> + +<h3><a name="mlist-3">mlist/3</a></h3> +<tt>mlist(MailBoxName, X2, Subscribed) -> term() +</tt> + +<h3><a name="recent-1">recent/1</a></h3> +<tt>recent(X1) -> term() +</tt> + +<h3><a name="select-1">select/1</a></h3> +<tt>select(Domain) -> term() +</tt> + +<h3><a name="select-2">select/2</a></h3> +<tt>select(Type, Key) -> term() +</tt> + +<h3><a name="unseen-1">unseen/1</a></h3> +<tt>unseen(X1) -> term() +</tt> + +<h3><a name="update-1">update/1</a></h3> +<tt>update(Record) -> term() +</tt> +</body> +</html> doc/dets_store.html @@ -1,28 +1,27 @@ -{application,erlmail}. -{packages,[]}. -{modules,[dets_store, - erlmail, - erlmail_conf, - erlmail_test, - erlmail_util, - gen_store, - imap_parser, - imap_scan, - imapc, - imapc_fsm, - imapc_util, - imapd, - imapd_app, - imapd_cmd, - imapd_ext, - imapd_fsm, - imapd_listener, - imapd_util, - mnesia_store, - mysql_store, - smtpc, - smtpc_fsm, - smtpd_app, - smtpd_cmd, - smtpd_fsm, - smtpd_listener]}. +{application,erlmail}. +{packages,[]}. +{modules,[dets_store, + erlmail_conf, + erlmail_test, + erlmail_util, + gen_store, + imap_parser, + imap_scan, + imapc, + imapc_fsm, + imapc_util, + imapd, + imapd_app, + imapd_cmd, + imapd_ext, + imapd_fsm, + imapd_listener, + imapd_util, + mnesia_store, + mysql_store, + smtpc, + smtpc_fsm, + smtpd_app, + smtpd_cmd, + smtpd_fsm, + smtpd_listener]}. doc/edoc-info @@ -1,38 +1,38 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<title>Module erlmail</title> -<link rel="stylesheet" type="text/css" href="stylesheet.css"> -</head> -<body bgcolor="white"> - -<h1>Module erlmail</h1> - -<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> - -<h2><a name="index">Function Index</a></h2> -<table width="100%" border="1"><tr><td valign="top"><a href="#reload-0">reload/0</a></td><td/></tr> -<tr><td valign="top"><a href="#restart-0">restart/0</a></td><td/></tr> -<tr><td valign="top"><a href="#start-0">start/0</a></td><td/></tr> -<tr><td valign="top"><a href="#stop-0">stop/0</a></td><td/></tr> -</table> - -<h2><a name="functions">Function Details</a></h2> - -<h3><a name="reload-0">reload/0</a></h3> -<tt>reload() -> term() -</tt> - -<h3><a name="restart-0">restart/0</a></h3> -<tt>restart() -> term() -</tt> - -<h3><a name="start-0">start/0</a></h3> -<tt>start() -> term() -</tt> - -<h3><a name="stop-0">stop/0</a></h3> -<tt>stop() -> term() -</tt> -</body> -</html> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>Module erlmail</title> +<link rel="stylesheet" type="text/css" href="stylesheet.css"> +</head> +<body bgcolor="white"> + +<h1>Module erlmail</h1> + +<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> + +<h2><a name="index">Function Index</a></h2> +<table width="100%" border="1"><tr><td valign="top"><a href="#reload-0">reload/0</a></td><td/></tr> +<tr><td valign="top"><a href="#restart-0">restart/0</a></td><td/></tr> +<tr><td valign="top"><a href="#start-0">start/0</a></td><td/></tr> +<tr><td valign="top"><a href="#stop-0">stop/0</a></td><td/></tr> +</table> + +<h2><a name="functions">Function Details</a></h2> + +<h3><a name="reload-0">reload/0</a></h3> +<tt>reload() -> term() +</tt> + +<h3><a name="restart-0">restart/0</a></h3> +<tt>restart() -> term() +</tt> + +<h3><a name="start-0">start/0</a></h3> +<tt>start() -> term() +</tt> + +<h3><a name="stop-0">stop/0</a></h3> +<tt>stop() -> term() +</tt> +</body> +</html> doc/erlmail.html @@ -1,53 +1,53 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<title>Module erlmail_conf</title> -<link rel="stylesheet" type="text/css" href="stylesheet.css"> -</head> -<body bgcolor="white"> - -<h1>Module erlmail_conf</h1> - -<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> - -<h2><a name="index">Function Index</a></h2> -<table width="100%" border="1"><tr><td valign="top"><a href="#filename-0">filename/0</a></td><td/></tr> -<tr><td valign="top"><a href="#lookup-1">lookup/1</a></td><td/></tr> -<tr><td valign="top"><a href="#lookup-2">lookup/2</a></td><td/></tr> -<tr><td valign="top"><a href="#lookup_atom-1">lookup_atom/1</a></td><td/></tr> -<tr><td valign="top"><a href="#lookup_atom-2">lookup_atom/2</a></td><td/></tr> -<tr><td valign="top"><a href="#read-0">read/0</a></td><td/></tr> -<tr><td valign="top"><a href="#read-1">read/1</a></td><td/></tr> -</table> - -<h2><a name="functions">Function Details</a></h2> - -<h3><a name="filename-0">filename/0</a></h3> -<tt>filename() -> term() -</tt> - -<h3><a name="lookup-1">lookup/1</a></h3> -<tt>lookup(Key) -> term() -</tt> - -<h3><a name="lookup-2">lookup/2</a></h3> -<tt>lookup(Key, State) -> term() -</tt> - -<h3><a name="lookup_atom-1">lookup_atom/1</a></h3> -<tt>lookup_atom(Key) -> term() -</tt> - -<h3><a name="lookup_atom-2">lookup_atom/2</a></h3> -<tt>lookup_atom(Key, State) -> term() -</tt> - -<h3><a name="read-0">read/0</a></h3> -<tt>read() -> term() -</tt> - -<h3><a name="read-1">read/1</a></h3> -<tt>read(FileName) -> term() -</tt> -</body> -</html> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>Module erlmail_conf</title> +<link rel="stylesheet" type="text/css" href="stylesheet.css"> +</head> +<body bgcolor="white"> + +<h1>Module erlmail_conf</h1> + +<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> + +<h2><a name="index">Function Index</a></h2> +<table width="100%" border="1"><tr><td valign="top"><a href="#filename-0">filename/0</a></td><td/></tr> +<tr><td valign="top"><a href="#lookup-1">lookup/1</a></td><td/></tr> +<tr><td valign="top"><a href="#lookup-2">lookup/2</a></td><td/></tr> +<tr><td valign="top"><a href="#lookup_atom-1">lookup_atom/1</a></td><td/></tr> +<tr><td valign="top"><a href="#lookup_atom-2">lookup_atom/2</a></td><td/></tr> +<tr><td valign="top"><a href="#read-0">read/0</a></td><td/></tr> +<tr><td valign="top"><a href="#read-1">read/1</a></td><td/></tr> +</table> + +<h2><a name="functions">Function Details</a></h2> + +<h3><a name="filename-0">filename/0</a></h3> +<tt>filename() -> term() +</tt> + +<h3><a name="lookup-1">lookup/1</a></h3> +<tt>lookup(Key) -> term() +</tt> + +<h3><a name="lookup-2">lookup/2</a></h3> +<tt>lookup(Key, State) -> term() +</tt> + +<h3><a name="lookup_atom-1">lookup_atom/1</a></h3> +<tt>lookup_atom(Key) -> term() +</tt> + +<h3><a name="lookup_atom-2">lookup_atom/2</a></h3> +<tt>lookup_atom(Key, State) -> term() +</tt> + +<h3><a name="read-0">read/0</a></h3> +<tt>read() -> term() +</tt> + +<h3><a name="read-1">read/1</a></h3> +<tt>read(FileName) -> term() +</tt> +</body> +</html> doc/erlmail_conf.html @@ -1,13 +1,13 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<title>Module erlmail_test</title> -<link rel="stylesheet" type="text/css" href="stylesheet.css"> -</head> -<body bgcolor="white"> - -<h1>Module erlmail_test</h1> - - -</body> -</html> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>Module erlmail_test</title> +<link rel="stylesheet" type="text/css" href="stylesheet.css"> +</head> +<body bgcolor="white"> + +<h1>Module erlmail_test</h1> + + +</body> +</html> doc/erlmail_test.html @@ -1,33 +1,33 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<title>Module erlmail_util</title> -<link rel="stylesheet" type="text/css" href="stylesheet.css"> -</head> -<body bgcolor="white"> - -<h1>Module erlmail_util</h1> - -<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> - -<h2><a name="index">Function Index</a></h2> -<table width="100%" border="1"><tr><td valign="top"><a href="#combine_email-1">combine_email/1</a></td><td/></tr> -<tr><td valign="top"><a href="#combine_email-2">combine_email/2</a></td><td/></tr> -<tr><td valign="top"><a href="#split_email-1">split_email/1</a></td><td/></tr> -</table> - -<h2><a name="functions">Function Details</a></h2> - -<h3><a name="combine_email-1">combine_email/1</a></h3> -<tt>combine_email(X1) -> term() -</tt> - -<h3><a name="combine_email-2">combine_email/2</a></h3> -<tt>combine_email(Atom, DomainName) -> term() -</tt> - -<h3><a name="split_email-1">split_email/1</a></h3> -<tt>split_email(Atom) -> term() -</tt> -</body> -</html> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>Module erlmail_util</title> +<link rel="stylesheet" type="text/css" href="stylesheet.css"> +</head> +<body bgcolor="white"> + +<h1>Module erlmail_util</h1> + +<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> + +<h2><a name="index">Function Index</a></h2> +<table width="100%" border="1"><tr><td valign="top"><a href="#combine_email-1">combine_email/1</a></td><td/></tr> +<tr><td valign="top"><a href="#combine_email-2">combine_email/2</a></td><td/></tr> +<tr><td valign="top"><a href="#split_email-1">split_email/1</a></td><td/></tr> +</table> + +<h2><a name="functions">Function Details</a></h2> + +<h3><a name="combine_email-1">combine_email/1</a></h3> +<tt>combine_email(X1) -> term() +</tt> + +<h3><a name="combine_email-2">combine_email/2</a></h3> +<tt>combine_email(Atom, DomainName) -> term() +</tt> + +<h3><a name="split_email-1">split_email/1</a></h3> +<tt>split_email(Atom) -> term() +</tt> +</body> +</html> doc/erlmail_util.html @@ -1,39 +1,39 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<title>Module gen_store</title> -<link rel="stylesheet" type="text/css" href="stylesheet.css"> -</head> -<body bgcolor="white"> - -<h1>Module gen_store</h1> - -<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> -<p><b>This module defines the <tt>gen_store</tt> behaviour.</b><br> Required callback functions: <tt>create/1</tt>, <tt>drop/1</tt>, <tt>insert/1</tt>, <tt>update/1</tt>, <tt>delete/1</tt>, <tt>select/2</tt>, <tt>info/1</tt>, <tt>config/0</tt>, <tt>list/0</tt>, <tt>list/1</tt>, <tt>message_name/1</tt>, <tt>ensure_inbox/1</tt>, <tt>deliver/1</tt>, <tt>check/1</tt>, <tt>unseen/1</tt>, <tt>recent/1</tt>, <tt>mlist/3</tt>.</p> - -<h2><a name="index">Function Index</a></h2> -<table width="100%" border="1"><tr><td valign="top"><a href="#behaviour_info-1">behaviour_info/1</a></td><td/></tr> -<tr><td valign="top"><a href="#lookup-1">lookup/1</a></td><td/></tr> -<tr><td valign="top"><a href="#lookup-2">lookup/2</a></td><td/></tr> -<tr><td valign="top"><a href="#message_name-1">message_name/1</a></td><td/></tr> -</table> - -<h2><a name="functions">Function Details</a></h2> - -<h3><a name="behaviour_info-1">behaviour_info/1</a></h3> -<tt>behaviour_info(Other) -> term() -</tt> - -<h3><a name="lookup-1">lookup/1</a></h3> -<tt>lookup(Type) -> term() -</tt> - -<h3><a name="lookup-2">lookup/2</a></h3> -<tt>lookup(X1, State) -> term() -</tt> - -<h3><a name="message_name-1">message_name/1</a></h3> -<tt>message_name(Args) -> term() -</tt> -</body> -</html> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>Module gen_store</title> +<link rel="stylesheet" type="text/css" href="stylesheet.css"> +</head> +<body bgcolor="white"> + +<h1>Module gen_store</h1> + +<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> +<p><b>This module defines the <tt>gen_store</tt> behaviour.</b><br> Required callback functions: <tt>create/1</tt>, <tt>drop/1</tt>, <tt>insert/1</tt>, <tt>update/1</tt>, <tt>delete/1</tt>, <tt>select/2</tt>, <tt>list/0</tt>, <tt>list/1</tt>, <tt>message_name/1</tt>, <tt>ensure_inbox/1</tt>, <tt>deliver/1</tt>, <tt>check/1</tt>, <tt>unseen/1</tt>, <tt>recent/1</tt>, <tt>mlist/3</tt>.</p> + +<h2><a name="index">Function Index</a></h2> +<table width="100%" border="1"><tr><td valign="top"><a href="#behaviour_info-1">behaviour_info/1</a></td><td/></tr> +<tr><td valign="top"><a href="#lookup-1">lookup/1</a></td><td/></tr> +<tr><td valign="top"><a href="#lookup-2">lookup/2</a></td><td/></tr> +<tr><td valign="top"><a href="#message_name-1">message_name/1</a></td><td/></tr> +</table> + +<h2><a name="functions">Function Details</a></h2> + +<h3><a name="behaviour_info-1">behaviour_info/1</a></h3> +<tt>behaviour_info(Other) -> term() +</tt> + +<h3><a name="lookup-1">lookup/1</a></h3> +<tt>lookup(Type) -> term() +</tt> + +<h3><a name="lookup-2">lookup/2</a></h3> +<tt>lookup(X1, State) -> term() +</tt> + +<h3><a name="message_name-1">message_name/1</a></h3> +<tt>message_name(Args) -> term() +</tt> +</body> +</html> doc/gen_store.html @@ -1,33 +1,33 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<title>Module imap_parser</title> -<link rel="stylesheet" type="text/css" href="stylesheet.css"> -</head> -<body bgcolor="white"> - -<h1>Module imap_parser</h1> - -<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> - -<h2><a name="index">Function Index</a></h2> -<table width="100%" border="1"><tr><td valign="top"><a href="#format_error-1">format_error/1</a></td><td/></tr> -<tr><td valign="top"><a href="#parse-1">parse/1</a></td><td/></tr> -<tr><td valign="top"><a href="#parse_and_scan-1">parse_and_scan/1</a></td><td/></tr> -</table> - -<h2><a name="functions">Function Details</a></h2> - -<h3><a name="format_error-1">format_error/1</a></h3> -<tt>format_error(Message) -> term() -</tt> - -<h3><a name="parse-1">parse/1</a></h3> -<tt>parse(Tokens) -> term() -</tt> - -<h3><a name="parse_and_scan-1">parse_and_scan/1</a></h3> -<tt>parse_and_scan(X1) -> term() -</tt> -</body> -</html> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>Module imap_parser</title> +<link rel="stylesheet" type="text/css" href="stylesheet.css"> +</head> +<body bgcolor="white"> + +<h1>Module imap_parser</h1> + +<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> + +<h2><a name="index">Function Index</a></h2> +<table width="100%" border="1"><tr><td valign="top"><a href="#format_error-1">format_error/1</a></td><td/></tr> +<tr><td valign="top"><a href="#parse-1">parse/1</a></td><td/></tr> +<tr><td valign="top"><a href="#parse_and_scan-1">parse_and_scan/1</a></td><td/></tr> +</table> + +<h2><a name="functions">Function Details</a></h2> + +<h3><a name="format_error-1">format_error/1</a></h3> +<tt>format_error(Message) -> term() +</tt> + +<h3><a name="parse-1">parse/1</a></h3> +<tt>parse(Tokens) -> term() +</tt> + +<h3><a name="parse_and_scan-1">parse_and_scan/1</a></h3> +<tt>parse_and_scan(X1) -> term() +</tt> +</body> +</html> doc/imap_parser.html @@ -1,58 +1,58 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<title>Module imap_scan</title> -<link rel="stylesheet" type="text/css" href="stylesheet.css"> -</head> -<body bgcolor="white"> - -<h1>Module imap_scan</h1> - -<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> - -<h2><a name="index">Function Index</a></h2> -<table width="100%" border="1"><tr><td valign="top"><a href="#format_error-1">format_error/1</a></td><td/></tr> -<tr><td valign="top"><a href="#imap_string-1">imap_string/1</a></td><td/></tr> -<tr><td valign="top"><a href="#string-1">string/1</a></td><td/></tr> -<tr><td valign="top"><a href="#string-2">string/2</a></td><td/></tr> -<tr><td valign="top"><a href="#token-2">token/2</a></td><td/></tr> -<tr><td valign="top"><a href="#token-3">token/3</a></td><td/></tr> -<tr><td valign="top"><a href="#tokens-2">tokens/2</a></td><td/></tr> -<tr><td valign="top"><a href="#tokens-3">tokens/3</a></td><td/></tr> -</table> - -<h2><a name="functions">Function Details</a></h2> - -<h3><a name="format_error-1">format_error/1</a></h3> -<tt>format_error(X1) -> term() -</tt> - -<h3><a name="imap_string-1">imap_string/1</a></h3> -<tt>imap_string(String) -> term() -</tt> - -<h3><a name="string-1">string/1</a></h3> -<tt>string(String) -> term() -</tt> - -<h3><a name="string-2">string/2</a></h3> -<tt>string(String, Line) -> term() -</tt> - -<h3><a name="token-2">token/2</a></h3> -<tt>token(Cont, Chars) -> term() -</tt> - -<h3><a name="token-3">token/3</a></h3> -<tt>token(X1, Chars, Line) -> term() -</tt> - -<h3><a name="tokens-2">tokens/2</a></h3> -<tt>tokens(Cont, Chars) -> term() -</tt> - -<h3><a name="tokens-3">tokens/3</a></h3> -<tt>tokens(X1, Chars, Line) -> term() -</tt> -</body> -</html> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>Module imap_scan</title> +<link rel="stylesheet" type="text/css" href="stylesheet.css"> +</head> +<body bgcolor="white"> + +<h1>Module imap_scan</h1> + +<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> + +<h2><a name="index">Function Index</a></h2> +<table width="100%" border="1"><tr><td valign="top"><a href="#format_error-1">format_error/1</a></td><td/></tr> +<tr><td valign="top"><a href="#imap_string-1">imap_string/1</a></td><td/></tr> +<tr><td valign="top"><a href="#string-1">string/1</a></td><td/></tr> +<tr><td valign="top"><a href="#string-2">string/2</a></td><td/></tr> +<tr><td valign="top"><a href="#token-2">token/2</a></td><td/></tr> +<tr><td valign="top"><a href="#token-3">token/3</a></td><td/></tr> +<tr><td valign="top"><a href="#tokens-2">tokens/2</a></td><td/></tr> +<tr><td valign="top"><a href="#tokens-3">tokens/3</a></td><td/></tr> +</table> + +<h2><a name="functions">Function Details</a></h2> + +<h3><a name="format_error-1">format_error/1</a></h3> +<tt>format_error(X1) -> term() +</tt> + +<h3><a name="imap_string-1">imap_string/1</a></h3> +<tt>imap_string(String) -> term() +</tt> + +<h3><a name="string-1">string/1</a></h3> +<tt>string(String) -> term() +</tt> + +<h3><a name="string-2">string/2</a></h3> +<tt>string(String, Line) -> term() +</tt> + +<h3><a name="token-2">token/2</a></h3> +<tt>token(Cont, Chars) -> term() +</tt> + +<h3><a name="token-3">token/3</a></h3> +<tt>token(X1, Chars, Line) -> term() +</tt> + +<h3><a name="tokens-2">tokens/2</a></h3> +<tt>tokens(Cont, Chars) -> term() +</tt> + +<h3><a name="tokens-3">tokens/3</a></h3> +<tt>tokens(X1, Chars, Line) -> term() +</tt> +</body> +</html> doc/imap_scan.html @@ -1,248 +1,248 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<title>Module imapc</title> -<link rel="stylesheet" type="text/css" href="stylesheet.css"> -</head> -<body bgcolor="white"> - -<h1>Module imapc</h1> - -<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> - -<h2><a name="index">Function Index</a></h2> -<table width="100%" border="1"><tr><td valign="top"><a href="#append-3">append/3</a></td><td/></tr> -<tr><td valign="top"><a href="#append-4">append/4</a></td><td/></tr> -<tr><td valign="top"><a href="#authenticate-2">authenticate/2</a></td><td/></tr> -<tr><td valign="top"><a href="#build-0">build/0</a></td><td/></tr> -<tr><td valign="top"><a href="#build-1">build/1</a></td><td/></tr> -<tr><td valign="top"><a href="#capability-1">capability/1</a></td><td/></tr> -<tr><td valign="top"><a href="#check-1">check/1</a></td><td/></tr> -<tr><td valign="top"><a href="#close-1">close/1</a></td><td/></tr> -<tr><td valign="top"><a href="#connect-1">connect/1</a></td><td/></tr> -<tr><td valign="top"><a href="#connect-2">connect/2</a></td><td/></tr> -<tr><td valign="top"><a href="#copy-3">copy/3</a></td><td/></tr> -<tr><td valign="top"><a href="#create-2">create/2</a></td><td/></tr> -<tr><td valign="top"><a href="#delete-2">delete/2</a></td><td/></tr> -<tr><td valign="top"><a href="#deletef-2">deletef/2</a></td><td/></tr> -<tr><td valign="top"><a href="#draft-2">draft/2</a></td><td/></tr> -<tr><td valign="top"><a href="#examine-1">examine/1</a></td><td/></tr> -<tr><td valign="top"><a href="#examine-2">examine/2</a></td><td/></tr> -<tr><td valign="top"><a href="#expunge-1">expunge/1</a></td><td/></tr> -<tr><td valign="top"><a href="#fetch-3">fetch/3</a></td><td/></tr> -<tr><td valign="top"><a href="#flag-2">flag/2</a></td><td/></tr> -<tr><td valign="top"><a href="#info-1">info/1</a></td><td/></tr> -<tr><td valign="top"><a href="#info-2">info/2</a></td><td/></tr> -<tr><td valign="top"><a href="#list-3">list/3</a></td><td/></tr> -<tr><td valign="top"><a href="#login-3">login/3</a></td><td/></tr> -<tr><td valign="top"><a href="#logout-1">logout/1</a></td><td/></tr> -<tr><td valign="top"><a href="#lsub-3">lsub/3</a></td><td/></tr> -<tr><td valign="top"><a href="#move-3">move/3</a></td><td/></tr> -<tr><td valign="top"><a href="#noop-1">noop/1</a></td><td/></tr> -<tr><td valign="top"><a href="#rename-3">rename/3</a></td><td/></tr> -<tr><td valign="top"><a href="#search-2">search/2</a></td><td/></tr> -<tr><td valign="top"><a href="#seen-2">seen/2</a></td><td/></tr> -<tr><td valign="top"><a href="#select-1">select/1</a></td><td/></tr> -<tr><td valign="top"><a href="#select-2">select/2</a></td><td/></tr> -<tr><td valign="top"><a href="#sort-3">sort/3</a></td><td/></tr> -<tr><td valign="top"><a href="#sort-4">sort/4</a></td><td/></tr> -<tr><td valign="top"><a href="#status-2">status/2</a></td><td/></tr> -<tr><td valign="top"><a href="#status-3">status/3</a></td><td/></tr> -<tr><td valign="top"><a href="#store-4">store/4</a></td><td/></tr> -<tr><td valign="top"><a href="#subscribe-2">subscribe/2</a></td><td/></tr> -<tr><td valign="top"><a href="#switch-2">switch/2</a></td><td/></tr> -<tr><td valign="top"><a href="#uid-3">uid/3</a></td><td/></tr> -<tr><td valign="top"><a href="#undeletef-2">undeletef/2</a></td><td/></tr> -<tr><td valign="top"><a href="#undraft-2">undraft/2</a></td><td/></tr> -<tr><td valign="top"><a href="#unflag-2">unflag/2</a></td><td/></tr> -<tr><td valign="top"><a href="#unseen-2">unseen/2</a></td><td/></tr> -<tr><td valign="top"><a href="#unsubscribe-2">unsubscribe/2</a></td><td/></tr> -</table> - -<h2><a name="functions">Function Details</a></h2> - -<h3><a name="append-3">append/3</a></h3> -<tt>append(Pid, Mailbox, Message) -> term() -</tt> - -<h3><a name="append-4">append/4</a></h3> -<tt>append(Pid, Mailbox, Message, Rest) -> term() -</tt> - -<h3><a name="authenticate-2">authenticate/2</a></h3> -<tt>authenticate(Pid, Method) -> term() -</tt> - -<h3><a name="build-0">build/0</a></h3> -<tt>build() -> term() -</tt> - -<h3><a name="build-1">build/1</a></h3> -<tt>build(X1) -> term() -</tt> - -<h3><a name="capability-1">capability/1</a></h3> -<tt>capability(Pid) -> term() -</tt> - -<h3><a name="check-1">check/1</a></h3> -<tt>check(Pid) -> term() -</tt> - -<h3><a name="close-1">close/1</a></h3> -<tt>close(Pid) -> term() -</tt> - -<h3><a name="connect-1">connect/1</a></h3> -<tt>connect(IPAddress) -> term() -</tt> - -<h3><a name="connect-2">connect/2</a></h3> -<tt>connect(IPAddress, Port) -> term() -</tt> - -<h3><a name="copy-3">copy/3</a></h3> -<tt>copy(Pid, Set, MailBox) -> term() -</tt> - -<h3><a name="create-2">create/2</a></h3> -<tt>create(Pid, MailBox) -> term() -</tt> - -<h3><a name="delete-2">delete/2</a></h3> -<tt>delete(Pid, MailBox) -> term() -</tt> - -<h3><a name="deletef-2">deletef/2</a></h3> -<tt>deletef(Pid, Set) -> term() -</tt> - -<h3><a name="draft-2">draft/2</a></h3> -<tt>draft(Pid, Set) -> term() -</tt> - -<h3><a name="examine-1">examine/1</a></h3> -<tt>examine(Pid) -> term() -</tt> - -<h3><a name="examine-2">examine/2</a></h3> -<tt>examine(Pid, MailBox) -> term() -</tt> - -<h3><a name="expunge-1">expunge/1</a></h3> -<tt>expunge(Pid) -> term() -</tt> - -<h3><a name="fetch-3">fetch/3</a></h3> -<tt>fetch(Pid, Set, Query) -> term() -</tt> - -<h3><a name="flag-2">flag/2</a></h3> -<tt>flag(Pid, Set) -> term() -</tt> - -<h3><a name="info-1">info/1</a></h3> -<tt>info(Pid) -> term() -</tt> - -<h3><a name="info-2">info/2</a></h3> -<tt>info(Pid, Type) -> term() -</tt> - -<h3><a name="list-3">list/3</a></h3> -<tt>list(Pid, RefName, Mailbox) -> term() -</tt> - -<h3><a name="login-3">login/3</a></h3> -<tt>login(Pid, UserName, Password) -> term() -</tt> - -<h3><a name="logout-1">logout/1</a></h3> -<tt>logout(Pid) -> term() -</tt> - -<h3><a name="lsub-3">lsub/3</a></h3> -<tt>lsub(Pid, RefName, Mailbox) -> term() -</tt> - -<h3><a name="move-3">move/3</a></h3> -<tt>move(Pid, Set, MailBox) -> term() -</tt> - -<h3><a name="noop-1">noop/1</a></h3> -<tt>noop(Pid) -> term() -</tt> - -<h3><a name="rename-3">rename/3</a></h3> -<tt>rename(Pid, OrgMailBox, NewMailBox) -> term() -</tt> - -<h3><a name="search-2">search/2</a></h3> -<tt>search(Pid, Query) -> term() -</tt> - -<h3><a name="seen-2">seen/2</a></h3> -<tt>seen(Pid, Set) -> term() -</tt> - -<h3><a name="select-1">select/1</a></h3> -<tt>select(Pid) -> term() -</tt> - -<h3><a name="select-2">select/2</a></h3> -<tt>select(Pid, MailBox) -> term() -</tt> - -<h3><a name="sort-3">sort/3</a></h3> -<tt>sort(Pid, Order, Query) -> term() -</tt> - -<h3><a name="sort-4">sort/4</a></h3> -<tt>sort(Pid, Order, Query, Charset) -> term() -</tt> - -<h3><a name="status-2">status/2</a></h3> -<tt>status(Pid, MailBox) -> term() -</tt> - -<h3><a name="status-3">status/3</a></h3> -<tt>status(Pid, MailBox, StatusCodes) -> term() -</tt> - -<h3><a name="store-4">store/4</a></h3> -<tt>store(Pid, Set, ItemName, Flags) -> term() -</tt> - -<h3><a name="subscribe-2">subscribe/2</a></h3> -<tt>subscribe(Pid, MailBox) -> term() -</tt> - -<h3><a name="switch-2">switch/2</a></h3> -<tt>switch(Pid, MailBox) -> term() -</tt> - -<h3><a name="uid-3">uid/3</a></h3> -<tt>uid(Pid, X2, Query) -> term() -</tt> - -<h3><a name="undeletef-2">undeletef/2</a></h3> -<tt>undeletef(Pid, Set) -> term() -</tt> - -<h3><a name="undraft-2">undraft/2</a></h3> -<tt>undraft(Pid, Set) -> term() -</tt> - -<h3><a name="unflag-2">unflag/2</a></h3> -<tt>unflag(Pid, Set) -> term() -</tt> - -<h3><a name="unseen-2">unseen/2</a></h3> -<tt>unseen(Pid, Set) -> term() -</tt> - -<h3><a name="unsubscribe-2">unsubscribe/2</a></h3> -<tt>unsubscribe(Pid, MailBox) -> term() -</tt> -</body> -</html> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>Module imapc</title> +<link rel="stylesheet" type="text/css" href="stylesheet.css"> +</head> +<body bgcolor="white"> + +<h1>Module imapc</h1> + +<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> + +<h2><a name="index">Function Index</a></h2> +<table width="100%" border="1"><tr><td valign="top"><a href="#append-3">append/3</a></td><td/></tr> +<tr><td valign="top"><a href="#append-4">append/4</a></td><td/></tr> +<tr><td valign="top"><a href="#authenticate-2">authenticate/2</a></td><td/></tr> +<tr><td valign="top"><a href="#build-0">build/0</a></td><td/></tr> +<tr><td valign="top"><a href="#build-1">build/1</a></td><td/></tr> +<tr><td valign="top"><a href="#capability-1">capability/1</a></td><td/></tr> +<tr><td valign="top"><a href="#check-1">check/1</a></td><td/></tr> +<tr><td valign="top"><a href="#close-1">close/1</a></td><td/></tr> +<tr><td valign="top"><a href="#connect-1">connect/1</a></td><td/></tr> +<tr><td valign="top"><a href="#connect-2">connect/2</a></td><td/></tr> +<tr><td valign="top"><a href="#copy-3">copy/3</a></td><td/></tr> +<tr><td valign="top"><a href="#create-2">create/2</a></td><td/></tr> +<tr><td valign="top"><a href="#delete-2">delete/2</a></td><td/></tr> +<tr><td valign="top"><a href="#deletef-2">deletef/2</a></td><td/></tr> +<tr><td valign="top"><a href="#draft-2">draft/2</a></td><td/></tr> +<tr><td valign="top"><a href="#examine-1">examine/1</a></td><td/></tr> +<tr><td valign="top"><a href="#examine-2">examine/2</a></td><td/></tr> +<tr><td valign="top"><a href="#expunge-1">expunge/1</a></td><td/></tr> +<tr><td valign="top"><a href="#fetch-3">fetch/3</a></td><td/></tr> +<tr><td valign="top"><a href="#flag-2">flag/2</a></td><td/></tr> +<tr><td valign="top"><a href="#info-1">info/1</a></td><td/></tr> +<tr><td valign="top"><a href="#info-2">info/2</a></td><td/></tr> +<tr><td valign="top"><a href="#list-3">list/3</a></td><td/></tr> +<tr><td valign="top"><a href="#login-3">login/3</a></td><td/></tr> +<tr><td valign="top"><a href="#logout-1">logout/1</a></td><td/></tr> +<tr><td valign="top"><a href="#lsub-3">lsub/3</a></td><td/></tr> +<tr><td valign="top"><a href="#move-3">move/3</a></td><td/></tr> +<tr><td valign="top"><a href="#noop-1">noop/1</a></td><td/></tr> +<tr><td valign="top"><a href="#rename-3">rename/3</a></td><td/></tr> +<tr><td valign="top"><a href="#search-2">search/2</a></td><td/></tr> +<tr><td valign="top"><a href="#seen-2">seen/2</a></td><td/></tr> +<tr><td valign="top"><a href="#select-1">select/1</a></td><td/></tr> +<tr><td valign="top"><a href="#select-2">select/2</a></td><td/></tr> +<tr><td valign="top"><a href="#sort-3">sort/3</a></td><td/></tr> +<tr><td valign="top"><a href="#sort-4">sort/4</a></td><td/></tr> +<tr><td valign="top"><a href="#status-2">status/2</a></td><td/></tr> +<tr><td valign="top"><a href="#status-3">status/3</a></td><td/></tr> +<tr><td valign="top"><a href="#store-4">store/4</a></td><td/></tr> +<tr><td valign="top"><a href="#subscribe-2">subscribe/2</a></td><td/></tr> +<tr><td valign="top"><a href="#switch-2">switch/2</a></td><td/></tr> +<tr><td valign="top"><a href="#uid-3">uid/3</a></td><td/></tr> +<tr><td valign="top"><a href="#undeletef-2">undeletef/2</a></td><td/></tr> +<tr><td valign="top"><a href="#undraft-2">undraft/2</a></td><td/></tr> +<tr><td valign="top"><a href="#unflag-2">unflag/2</a></td><td/></tr> +<tr><td valign="top"><a href="#unseen-2">unseen/2</a></td><td/></tr> +<tr><td valign="top"><a href="#unsubscribe-2">unsubscribe/2</a></td><td/></tr> +</table> + +<h2><a name="functions">Function Details</a></h2> + +<h3><a name="append-3">append/3</a></h3> +<tt>append(Pid, Mailbox, Message) -> term() +</tt> + +<h3><a name="append-4">append/4</a></h3> +<tt>append(Pid, Mailbox, Message, Rest) -> term() +</tt> + +<h3><a name="authenticate-2">authenticate/2</a></h3> +<tt>authenticate(Pid, Method) -> term() +</tt> + +<h3><a name="build-0">build/0</a></h3> +<tt>build() -> term() +</tt> + +<h3><a name="build-1">build/1</a></h3> +<tt>build(X1) -> term() +</tt> + +<h3><a name="capability-1">capability/1</a></h3> +<tt>capability(Pid) -> term() +</tt> + +<h3><a name="check-1">check/1</a></h3> +<tt>check(Pid) -> term() +</tt> + +<h3><a name="close-1">close/1</a></h3> +<tt>close(Pid) -> term() +</tt> + +<h3><a name="connect-1">connect/1</a></h3> +<tt>connect(IPAddress) -> term() +</tt> + +<h3><a name="connect-2">connect/2</a></h3> +<tt>connect(IPAddress, Port) -> term() +</tt> + +<h3><a name="copy-3">copy/3</a></h3> +<tt>copy(Pid, Set, MailBox) -> term() +</tt> + +<h3><a name="create-2">create/2</a></h3> +<tt>create(Pid, MailBox) -> term() +</tt> + +<h3><a name="delete-2">delete/2</a></h3> +<tt>delete(Pid, MailBox) -> term() +</tt> + +<h3><a name="deletef-2">deletef/2</a></h3> +<tt>deletef(Pid, Set) -> term() +</tt> + +<h3><a name="draft-2">draft/2</a></h3> +<tt>draft(Pid, Set) -> term() +</tt> + +<h3><a name="examine-1">examine/1</a></h3> +<tt>examine(Pid) -> term() +</tt> + +<h3><a name="examine-2">examine/2</a></h3> +<tt>examine(Pid, MailBox) -> term() +</tt> + +<h3><a name="expunge-1">expunge/1</a></h3> +<tt>expunge(Pid) -> term() +</tt> + +<h3><a name="fetch-3">fetch/3</a></h3> +<tt>fetch(Pid, Set, Query) -> term() +</tt> + +<h3><a name="flag-2">flag/2</a></h3> +<tt>flag(Pid, Set) -> term() +</tt> + +<h3><a name="info-1">info/1</a></h3> +<tt>info(Pid) -> term() +</tt> + +<h3><a name="info-2">info/2</a></h3> +<tt>info(Pid, Type) -> term() +</tt> + +<h3><a name="list-3">list/3</a></h3> +<tt>list(Pid, RefName, Mailbox) -> term() +</tt> + +<h3><a name="login-3">login/3</a></h3> +<tt>login(Pid, UserName, Password) -> term() +</tt> + +<h3><a name="logout-1">logout/1</a></h3> +<tt>logout(Pid) -> term() +</tt> + +<h3><a name="lsub-3">lsub/3</a></h3> +<tt>lsub(Pid, RefName, Mailbox) -> term() +</tt> + +<h3><a name="move-3">move/3</a></h3> +<tt>move(Pid, Set, MailBox) -> term() +</tt> + +<h3><a name="noop-1">noop/1</a></h3> +<tt>noop(Pid) -> term() +</tt> + +<h3><a name="rename-3">rename/3</a></h3> +<tt>rename(Pid, OrgMailBox, NewMailBox) -> term() +</tt> + +<h3><a name="search-2">search/2</a></h3> +<tt>search(Pid, Query) -> term() +</tt> + +<h3><a name="seen-2">seen/2</a></h3> +<tt>seen(Pid, Set) -> term() +</tt> + +<h3><a name="select-1">select/1</a></h3> +<tt>select(Pid) -> term() +</tt> + +<h3><a name="select-2">select/2</a></h3> +<tt>select(Pid, MailBox) -> term() +</tt> + +<h3><a name="sort-3">sort/3</a></h3> +<tt>sort(Pid, Order, Query) -> term() +</tt> + +<h3><a name="sort-4">sort/4</a></h3> +<tt>sort(Pid, Order, Query, Charset) -> term() +</tt> + +<h3><a name="status-2">status/2</a></h3> +<tt>status(Pid, MailBox) -> term() +</tt> + +<h3><a name="status-3">status/3</a></h3> +<tt>status(Pid, MailBox, StatusCodes) -> term() +</tt> + +<h3><a name="store-4">store/4</a></h3> +<tt>store(Pid, Set, ItemName, Flags) -> term() +</tt> + +<h3><a name="subscribe-2">subscribe/2</a></h3> +<tt>subscribe(Pid, MailBox) -> term() +</tt> + +<h3><a name="switch-2">switch/2</a></h3> +<tt>switch(Pid, MailBox) -> term() +</tt> + +<h3><a name="uid-3">uid/3</a></h3> +<tt>uid(Pid, X2, Query) -> term() +</tt> + +<h3><a name="undeletef-2">undeletef/2</a></h3> +<tt>undeletef(Pid, Set) -> term() +</tt> + +<h3><a name="undraft-2">undraft/2</a></h3> +<tt>undraft(Pid, Set) -> term() +</tt> + +<h3><a name="unflag-2">unflag/2</a></h3> +<tt>unflag(Pid, Set) -> term() +</tt> + +<h3><a name="unseen-2">unseen/2</a></h3> +<tt>unseen(Pid, Set) -> term() +</tt> + +<h3><a name="unsubscribe-2">unsubscribe/2</a></h3> +<tt>unsubscribe(Pid, MailBox) -> term() +</tt> +</body> +</html> doc/imapc.html @@ -1,78 +1,78 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<title>Module imapc_fsm</title> -<link rel="stylesheet" type="text/css" href="stylesheet.css"> -</head> -<body bgcolor="white"> - -<h1>Module imapc_fsm</h1> - -<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> - -<h2><a name="index">Function Index</a></h2> -<table width="100%" border="1"><tr><td valign="top"><a href="#IMAP_CMD-2">IMAP_CMD/2</a></td><td/></tr> -<tr><td valign="top"><a href="#IMAP_CMD-3">IMAP_CMD/3</a></td><td/></tr> -<tr><td valign="top"><a href="#code_change-4">code_change/4</a></td><td/></tr> -<tr><td valign="top"><a href="#handle_event-3">handle_event/3</a></td><td/></tr> -<tr><td valign="top"><a href="#handle_info-3">handle_info/3</a></td><td/></tr> -<tr><td valign="top"><a href="#handle_sync_event-4">handle_sync_event/4</a></td><td/></tr> -<tr><td valign="top"><a href="#init-1">init/1</a></td><td/></tr> -<tr><td valign="top"><a href="#set_socket-2">set_socket/2</a></td><td/></tr> -<tr><td valign="top"><a href="#set_socket_opts-1">set_socket_opts/1</a></td><td/></tr> -<tr><td valign="top"><a href="#start_link-1">start_link/1</a></td><td/></tr> -<tr><td valign="top"><a href="#start_link-2">start_link/2</a></td><td/></tr> -<tr><td valign="top"><a href="#terminate-3">terminate/3</a></td><td/></tr> -</table> - -<h2><a name="functions">Function Details</a></h2> - -<h3><a name="IMAP_CMD-2">IMAP_CMD/2</a></h3> -<tt>IMAP_CMD(Data, State) -> term() -</tt> - -<h3><a name="IMAP_CMD-3">IMAP_CMD/3</a></h3> -<tt>IMAP_CMD(Event, From, Imapc_fsm) -> term() -</tt> - -<h3><a name="code_change-4">code_change/4</a></h3> -<tt>code_change(OldVsn, StateName, StateData, Extra) -> term() -</tt> - -<h3><a name="handle_event-3">handle_event/3</a></h3> -<tt>handle_event(X1, AnyState, IMAPC) -> term() -</tt> - -<h3><a name="handle_info-3">handle_info/3</a></h3> -<tt>handle_info(Info, StateName, Imapc_fsm) -> term() -</tt> - -<h3><a name="handle_sync_event-4">handle_sync_event/4</a></h3> -<tt>handle_sync_event(Event, From, StateName, StateData) -> term() -</tt> - -<h3><a name="init-1">init/1</a></h3> -<tt>init(X1) -> term() -</tt> - -<h3><a name="set_socket-2">set_socket/2</a></h3> -<tt>set_socket(Pid, Socket) -> term() -</tt> - -<h3><a name="set_socket_opts-1">set_socket_opts/1</a></h3> -<tt>set_socket_opts(Socket) -> term() -</tt> - -<h3><a name="start_link-1">start_link/1</a></h3> -<tt>start_link(Host) -> term() -</tt> - -<h3><a name="start_link-2">start_link/2</a></h3> -<tt>start_link(Host, Port) -> term() -</tt> - -<h3><a name="terminate-3">terminate/3</a></h3> -<tt>terminate(Reason, StateName, StateData) -> term() -</tt> -</body> -</html> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>Module imapc_fsm</title> +<link rel="stylesheet" type="text/css" href="stylesheet.css"> +</head> +<body bgcolor="white"> + +<h1>Module imapc_fsm</h1> + +<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> + +<h2><a name="index">Function Index</a></h2> +<table width="100%" border="1"><tr><td valign="top"><a href="#IMAP_CMD-2">IMAP_CMD/2</a></td><td/></tr> +<tr><td valign="top"><a href="#IMAP_CMD-3">IMAP_CMD/3</a></td><td/></tr> +<tr><td valign="top"><a href="#code_change-4">code_change/4</a></td><td/></tr> +<tr><td valign="top"><a href="#handle_event-3">handle_event/3</a></td><td/></tr> +<tr><td valign="top"><a href="#handle_info-3">handle_info/3</a></td><td/></tr> +<tr><td valign="top"><a href="#handle_sync_event-4">handle_sync_event/4</a></td><td/></tr> +<tr><td valign="top"><a href="#init-1">init/1</a></td><td/></tr> +<tr><td valign="top"><a href="#set_socket-2">set_socket/2</a></td><td/></tr> +<tr><td valign="top"><a href="#set_socket_opts-1">set_socket_opts/1</a></td><td/></tr> +<tr><td valign="top"><a href="#start_link-1">start_link/1</a></td><td/></tr> +<tr><td valign="top"><a href="#start_link-2">start_link/2</a></td><td/></tr> +<tr><td valign="top"><a href="#terminate-3">terminate/3</a></td><td/></tr> +</table> + +<h2><a name="functions">Function Details</a></h2> + +<h3><a name="IMAP_CMD-2">IMAP_CMD/2</a></h3> +<tt>IMAP_CMD(Data, State) -> term() +</tt> + +<h3><a name="IMAP_CMD-3">IMAP_CMD/3</a></h3> +<tt>IMAP_CMD(Event, From, Imapc_fsm) -> term() +</tt> + +<h3><a name="code_change-4">code_change/4</a></h3> +<tt>code_change(OldVsn, StateName, StateData, Extra) -> term() +</tt> + +<h3><a name="handle_event-3">handle_event/3</a></h3> +<tt>handle_event(X1, AnyState, IMAPC) -> term() +</tt> + +<h3><a name="handle_info-3">handle_info/3</a></h3> +<tt>handle_info(Info, StateName, Imapc_fsm) -> term() +</tt> + +<h3><a name="handle_sync_event-4">handle_sync_event/4</a></h3> +<tt>handle_sync_event(Event, From, StateName, StateData) -> term() +</tt> + +<h3><a name="init-1">init/1</a></h3> +<tt>init(X1) -> term() +</tt> + +<h3><a name="set_socket-2">set_socket/2</a></h3> +<tt>set_socket(Pid, Socket) -> term() +</tt> + +<h3><a name="set_socket_opts-1">set_socket_opts/1</a></h3> +<tt>set_socket_opts(Socket) -> term() +</tt> + +<h3><a name="start_link-1">start_link/1</a></h3> +<tt>start_link(Host) -> term() +</tt> + +<h3><a name="start_link-2">start_link/2</a></h3> +<tt>start_link(Host, Port) -> term() +</tt> + +<h3><a name="terminate-3">terminate/3</a></h3> +<tt>terminate(Reason, StateName, StateData) -> term() +</tt> +</body> +</html> doc/imapc_fsm.html @@ -1,113 +1,113 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<title>Module imapc_util</title> -<link rel="stylesheet" type="text/css" href="stylesheet.css"> -</head> -<body bgcolor="white"> - -<h1>Module imapc_util</h1> - -<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> - -<h2><a name="index">Function Index</a></h2> -<table width="100%" border="1"><tr><td valign="top"><a href="#build_fetch-1">build_fetch/1</a></td><td/></tr> -<tr><td valign="top"><a href="#build_flags-1">build_flags/1</a></td><td/></tr> -<tr><td valign="top"><a href="#build_order-1">build_order/1</a></td><td/></tr> -<tr><td valign="top"><a href="#build_search-1">build_search/1</a></td><td/></tr> -<tr><td valign="top"><a href="#build_statuscodes-1">build_statuscodes/1</a></td><td/></tr> -<tr><td valign="top"><a href="#build_store-1">build_store/1</a></td><td/></tr> -<tr><td valign="top"><a href="#expunge_response-2">expunge_response/2</a></td><td/></tr> -<tr><td valign="top"><a href="#fetch_response-2">fetch_response/2</a></td><td/></tr> -<tr><td valign="top"><a href="#fetch_split-1">fetch_split/1</a></td><td/></tr> -<tr><td valign="top"><a href="#mailbox-1">mailbox/1</a></td><td/></tr> -<tr><td valign="top"><a href="#mailbox-2">mailbox/2</a></td><td/></tr> -<tr><td valign="top"><a href="#reduce-1">reduce/1</a></td><td/></tr> -<tr><td valign="top"><a href="#response-1">response/1</a></td><td/></tr> -<tr><td valign="top"><a href="#response-2">response/2</a></td><td/></tr> -<tr><td valign="top"><a href="#status-2">status/2</a></td><td/></tr> -<tr><td valign="top"><a href="#tag-0">tag/0</a></td><td/></tr> -<tr><td valign="top"><a href="#to_low_atom-1">to_low_atom/1</a></td><td/></tr> -<tr><td valign="top"><a href="#to_seq-1">to_seq/1</a></td><td/></tr> -<tr><td valign="top"><a href="#write-2">write/2</a></td><td/></tr> -</table> - -<h2><a name="functions">Function Details</a></h2> - -<h3><a name="build_fetch-1">build_fetch/1</a></h3> -<tt>build_fetch(List) -> term() -</tt> - -<h3><a name="build_flags-1">build_flags/1</a></h3> -<tt>build_flags(List) -> term() -</tt> - -<h3><a name="build_order-1">build_order/1</a></h3> -<tt>build_order(List) -> term() -</tt> - -<h3><a name="build_search-1">build_search/1</a></h3> -<tt>build_search(List) -> term() -</tt> - -<h3><a name="build_statuscodes-1">build_statuscodes/1</a></h3> -<tt>build_statuscodes(List) -> term() -</tt> - -<h3><a name="build_store-1">build_store/1</a></h3> -<tt>build_store(ItemName) -> term() -</tt> - -<h3><a name="expunge_response-2">expunge_response/2</a></h3> -<tt>expunge_response(List, State) -> term() -</tt> - -<h3><a name="fetch_response-2">fetch_response/2</a></h3> -<tt>fetch_response(Socket, Tag) -> term() -</tt> - -<h3><a name="fetch_split-1">fetch_split/1</a></h3> -<tt>fetch_split(Binary) -> term() -</tt> - -<h3><a name="mailbox-1">mailbox/1</a></h3> -<tt>mailbox(List) -> term() -</tt> - -<h3><a name="mailbox-2">mailbox/2</a></h3> -<tt>mailbox(List, MailBox) -> term() -</tt> - -<h3><a name="reduce-1">reduce/1</a></h3> -<tt>reduce(List) -> term() -</tt> - -<h3><a name="response-1">response/1</a></h3> -<tt>response(Socket) -> term() -</tt> - -<h3><a name="response-2">response/2</a></h3> -<tt>response(Socket, Tag) -> term() -</tt> - -<h3><a name="status-2">status/2</a></h3> -<tt>status(List, MailBox) -> term() -</tt> - -<h3><a name="tag-0">tag/0</a></h3> -<tt>tag() -> term() -</tt> - -<h3><a name="to_low_atom-1">to_low_atom/1</a></h3> -<tt>to_low_atom(String) -> term() -</tt> - -<h3><a name="to_seq-1">to_seq/1</a></h3> -<tt>to_seq(Number) -> term() -</tt> - -<h3><a name="write-2">write/2</a></h3> -<tt>write(Socket, Msg) -> term() -</tt> -</body> -</html> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>Module imapc_util</title> +<link rel="stylesheet" type="text/css" href="stylesheet.css"> +</head> +<body bgcolor="white"> + +<h1>Module imapc_util</h1> + +<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> + +<h2><a name="index">Function Index</a></h2> +<table width="100%" border="1"><tr><td valign="top"><a href="#build_fetch-1">build_fetch/1</a></td><td/></tr> +<tr><td valign="top"><a href="#build_flags-1">build_flags/1</a></td><td/></tr> +<tr><td valign="top"><a href="#build_order-1">build_order/1</a></td><td/></tr> +<tr><td valign="top"><a href="#build_search-1">build_search/1</a></td><td/></tr> +<tr><td valign="top"><a href="#build_statuscodes-1">build_statuscodes/1</a></td><td/></tr> +<tr><td valign="top"><a href="#build_store-1">build_store/1</a></td><td/></tr> +<tr><td valign="top"><a href="#expunge_response-2">expunge_response/2</a></td><td/></tr> +<tr><td valign="top"><a href="#fetch_response-2">fetch_response/2</a></td><td/></tr> +<tr><td valign="top"><a href="#fetch_split-1">fetch_split/1</a></td><td/></tr> +<tr><td valign="top"><a href="#mailbox-1">mailbox/1</a></td><td/></tr> +<tr><td valign="top"><a href="#mailbox-2">mailbox/2</a></td><td/></tr> +<tr><td valign="top"><a href="#reduce-1">reduce/1</a></td><td/></tr> +<tr><td valign="top"><a href="#response-1">response/1</a></td><td/></tr> +<tr><td valign="top"><a href="#response-2">response/2</a></td><td/></tr> +<tr><td valign="top"><a href="#status-2">status/2</a></td><td/></tr> +<tr><td valign="top"><a href="#tag-0">tag/0</a></td><td/></tr> +<tr><td valign="top"><a href="#to_low_atom-1">to_low_atom/1</a></td><td/></tr> +<tr><td valign="top"><a href="#to_seq-1">to_seq/1</a></td><td/></tr> +<tr><td valign="top"><a href="#write-2">write/2</a></td><td/></tr> +</table> + +<h2><a name="functions">Function Details</a></h2> + +<h3><a name="build_fetch-1">build_fetch/1</a></h3> +<tt>build_fetch(List) -> term() +</tt> + +<h3><a name="build_flags-1">build_flags/1</a></h3> +<tt>build_flags(List) -> term() +</tt> + +<h3><a name="build_order-1">build_order/1</a></h3> +<tt>build_order(List) -> term() +</tt> + +<h3><a name="build_search-1">build_search/1</a></h3> +<tt>build_search(List) -> term() +</tt> + +<h3><a name="build_statuscodes-1">build_statuscodes/1</a></h3> +<tt>build_statuscodes(List) -> term() +</tt> + +<h3><a name="build_store-1">build_store/1</a></h3> +<tt>build_store(ItemName) -> term() +</tt> + +<h3><a name="expunge_response-2">expunge_response/2</a></h3> +<tt>expunge_response(List, State) -> term() +</tt> + +<h3><a name="fetch_response-2">fetch_response/2</a></h3> +<tt>fetch_response(Socket, Tag) -> term() +</tt> + +<h3><a name="fetch_split-1">fetch_split/1</a></h3> +<tt>fetch_split(Binary) -> term() +</tt> + +<h3><a name="mailbox-1">mailbox/1</a></h3> +<tt>mailbox(List) -> term() +</tt> + +<h3><a name="mailbox-2">mailbox/2</a></h3> +<tt>mailbox(List, MailBox) -> term() +</tt> + +<h3><a name="reduce-1">reduce/1</a></h3> +<tt>reduce(List) -> term() +</tt> + +<h3><a name="response-1">response/1</a></h3> +<tt>response(Socket) -> term() +</tt> + +<h3><a name="response-2">response/2</a></h3> +<tt>response(Socket, Tag) -> term() +</tt> + +<h3><a name="status-2">status/2</a></h3> +<tt>status(List, MailBox) -> term() +</tt> + +<h3><a name="tag-0">tag/0</a></h3> +<tt>tag() -> term() +</tt> + +<h3><a name="to_low_atom-1">to_low_atom/1</a></h3> +<tt>to_low_atom(String) -> term() +</tt> + +<h3><a name="to_seq-1">to_seq/1</a></h3> +<tt>to_seq(Number) -> term() +</tt> + +<h3><a name="write-2">write/2</a></h3> +<tt>write(Socket, Msg) -> term() +</tt> +</body> +</html> doc/imapc_util.html @@ -1,13 +1,13 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<title>Module imapd</title> -<link rel="stylesheet" type="text/css" href="stylesheet.css"> -</head> -<body bgcolor="white"> - -<h1>Module imapd</h1> - - -</body> -</html> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>Module imapd</title> +<link rel="stylesheet" type="text/css" href="stylesheet.css"> +</head> +<body bgcolor="white"> + +<h1>Module imapd</h1> + + +</body> +</html> doc/imapd.html @@ -1,39 +1,39 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<title>Module imapd_app</title> -<link rel="stylesheet" type="text/css" href="stylesheet.css"> -</head> -<body bgcolor="white"> - -<h1>Module imapd_app</h1> - -<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> -<p><b>Behaviours:</b> <a href="application.html"><tt>application</tt></a>.</p> - -<h2><a name="index">Function Index</a></h2> -<table width="100%" border="1"><tr><td valign="top"><a href="#init-1">init/1</a></td><td/></tr> -<tr><td valign="top"><a href="#start-2">start/2</a></td><td/></tr> -<tr><td valign="top"><a href="#start_client-0">start_client/0</a></td><td/></tr> -<tr><td valign="top"><a href="#stop-1">stop/1</a></td><td/></tr> -</table> - -<h2><a name="functions">Function Details</a></h2> - -<h3><a name="init-1">init/1</a></h3> -<tt>init(X1) -> term() -</tt> - -<h3><a name="start-2">start/2</a></h3> -<tt>start(Type, Args) -> term() -</tt> - -<h3><a name="start_client-0">start_client/0</a></h3> -<tt>start_client() -> term() -</tt> - -<h3><a name="stop-1">stop/1</a></h3> -<tt>stop(S) -> term() -</tt> -</body> -</html> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>Module imapd_app</title> +<link rel="stylesheet" type="text/css" href="stylesheet.css"> +</head> +<body bgcolor="white"> + +<h1>Module imapd_app</h1> + +<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> +<p><b>Behaviours:</b> <a href="application.html"><tt>application</tt></a>.</p> + +<h2><a name="index">Function Index</a></h2> +<table width="100%" border="1"><tr><td valign="top"><a href="#init-1">init/1</a></td><td/></tr> +<tr><td valign="top"><a href="#start-2">start/2</a></td><td/></tr> +<tr><td valign="top"><a href="#start_client-0">start_client/0</a></td><td/></tr> +<tr><td valign="top"><a href="#stop-1">stop/1</a></td><td/></tr> +</table> + +<h2><a name="functions">Function Details</a></h2> + +<h3><a name="init-1">init/1</a></h3> +<tt>init(X1) -> term() +</tt> + +<h3><a name="start-2">start/2</a></h3> +<tt>start(Type, Args) -> term() +</tt> + +<h3><a name="start_client-0">start_client/0</a></h3> +<tt>start_client() -> term() +</tt> + +<h3><a name="stop-1">stop/1</a></h3> +<tt>stop(S) -> term() +</tt> +</body> +</html> doc/imapd_app.html @@ -1,28 +1,29 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<title>Module imapd_cmd</title> -<link rel="stylesheet" type="text/css" href="stylesheet.css"> -</head> -<body bgcolor="white"> - -<h1>Module imapd_cmd</h1> - -<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> - -<h2><a name="index">Function Index</a></h2> -<table width="100%" border="1"><tr><td valign="top"><a href="#command-1">command/1</a></td><td/></tr> -<tr><td valign="top"><a href="#command-2">command/2</a></td><td/></tr> -</table> - -<h2><a name="functions">Function Details</a></h2> - -<h3><a name="command-1">command/1</a></h3> -<tt>command(Imapd_fsm) -> term() -</tt> - -<h3><a name="command-2">command/2</a></h3> -<tt>command(Imap_cmd, State) -> term() -</tt> -</body> -</html> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>Module imapd_cmd</title> +<link rel="stylesheet" type="text/css" href="stylesheet.css"> +</head> +<body bgcolor="white"> + +<h1>Module imapd_cmd</h1> + IMAP server command processing. +<p>Copyright © 2006 - 2007 Simple Enigma, Inc. All Rights Reserved.</p> +<ul><li><a href="#description">Description</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> +<p><b>Version:</b> 0.0.6</p> +<p><b>Introduced in:</b> 0.0.6</p> +<p><b>Authors:</b> Stuart Jackson (<a href="mailto:sjackson@simpleenigma.com"><tt>sjackson@simpleenigma.com</tt></a>) [<em>web site:</em> <tt><a href="http://erlsoft.org" target="_top">http://erlsoft.org</a></tt>].</p> +<p><b>References</b><ul><li> See <a href="http://erlsoft.org/modules/erlmail" target="_top">Erlang Software Framework</a> for more information</li></ul></p> + +<h2><a name="description">Description</a></h2> IMAP server command processing +<h2><a name="index">Function Index</a></h2> +<table width="100%" border="1"><tr><td valign="top"><a href="#command-1">command/1</a></td><td> Processes all IMAP commands and checks for extention processing.</td></tr> +</table> + +<h2><a name="functions">Function Details</a></h2> + +<h3><a name="command-1">command/1</a></h3> +<p><tt>command(State::<a href="#type-imapd_fsm">imapd_fsm()</a>) -> NewState::<a href="#type-imapd_fsm">imapd_fsm()</a></tt></p> +<p> Processes all IMAP commands and checks for extention processing</p> +</body> +</html> doc/imapd_cmd.html @@ -1,43 +1,43 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<title>Module imapd_ext</title> -<link rel="stylesheet" type="text/css" href="stylesheet.css"> -</head> -<body bgcolor="white"> - -<h1>Module imapd_ext</h1> - -<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> - -<h2><a name="index">Function Index</a></h2> -<table width="100%" border="1"><tr><td valign="top"><a href="#capability-0">capability/0</a></td><td>Check and verify extentions and return capability string.</td></tr> -<tr><td valign="top"><a href="#check-1">check/1</a></td><td>Check to see if extention is in the config file.</td></tr> -<tr><td valign="top"><a href="#list-0">list/0</a></td><td>List all verified extentions from config file.</td></tr> -<tr><td valign="top"><a href="#list-1">list/1</a></td><td>List all verified extentions from ExtentionList.</td></tr> -<tr><td valign="top"><a href="#verify-2">verify/2</a></td><td>Verify that Module:Function/2 exists in Erlang path.</td></tr> -</table> - -<h2><a name="functions">Function Details</a></h2> - -<h3><a name="capability-0">capability/0</a></h3> -<p><tt>capability() -> string()</tt></p> -<p>Check and verify extentions and return capability string</p> - -<h3><a name="check-1">check/1</a></h3> -<p><tt>check(Key::atom()) -> {ok, tuple()} | {error, atom()}</tt></p> -<p>Check to see if extention is in the config file</p> - -<h3><a name="list-0">list/0</a></h3> -<p><tt>list() -> list()</tt></p> -<p>List all verified extentions from config file</p> - -<h3><a name="list-1">list/1</a></h3> -<p><tt>list(ExtentionList::list()) -> list()</tt></p> -<p>List all verified extentions from ExtentionList</p> - -<h3><a name="verify-2">verify/2</a></h3> -<p><tt>verify(Module::atom(), Funcation::atom()) -> bool()</tt></p> -<p>Verify that Module:Function/2 exists in Erlang path</p> -</body> -</html> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>Module imapd_ext</title> +<link rel="stylesheet" type="text/css" href="stylesheet.css"> +</head> +<body bgcolor="white"> + +<h1>Module imapd_ext</h1> + +<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> + +<h2><a name="index">Function Index</a></h2> +<table width="100%" border="1"><tr><td valign="top"><a href="#capability-0">capability/0</a></td><td>Check and verify extentions and return capability string.</td></tr> +<tr><td valign="top"><a href="#check-1">check/1</a></td><td>Check to see if extention is in the config file.</td></tr> +<tr><td valign="top"><a href="#list-0">list/0</a></td><td>List all verified extentions from config file.</td></tr> +<tr><td valign="top"><a href="#list-1">list/1</a></td><td>List all verified extentions from ExtentionList.</td></tr> +<tr><td valign="top"><a href="#verify-2">verify/2</a></td><td>Verify that Module:Function/2 exists in Erlang path.</td></tr> +</table> + +<h2><a name="functions">Function Details</a></h2> + +<h3><a name="capability-0">capability/0</a></h3> +<p><tt>capability() -> string()</tt></p> +<p>Check and verify extentions and return capability string</p> + +<h3><a name="check-1">check/1</a></h3> +<p><tt>check(Key::atom()) -> {ok, tuple()} | {error, atom()}</tt></p> +<p>Check to see if extention is in the config file</p> + +<h3><a name="list-0">list/0</a></h3> +<p><tt>list() -> list()</tt></p> +<p>List all verified extentions from config file</p> + +<h3><a name="list-1">list/1</a></h3> +<p><tt>list(ExtentionList::list()) -> list()</tt></p> +<p>List all verified extentions from ExtentionList</p> + +<h3><a name="verify-2">verify/2</a></h3> +<p><tt>verify(Module::atom(), Funcation::atom()) -> bool()</tt></p> +<p>Verify that Module:Function/2 exists in Erlang path</p> +</body> +</html> doc/imapd_ext.html @@ -1,34 +1,34 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<title>Module imapd_fsm</title> -<link rel="stylesheet" type="text/css" href="stylesheet.css"> -</head> -<body bgcolor="white"> - -<h1>Module imapd_fsm</h1> - -<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> -<p><b>Behaviours:</b> <a href="gen_fsm.html"><tt>gen_fsm</tt></a>.</p> - -<h2><a name="index">Function Index</a></h2> -<table width="100%" border="1"><tr><td valign="top"><a href="#WAIT_FOR_DATA-2">WAIT_FOR_DATA/2</a></td><td/></tr> -<tr><td valign="top"><a href="#set_socket-2">set_socket/2</a></td><td/></tr> -<tr><td valign="top"><a href="#start_link-0">start_link/0</a></td><td/></tr> -</table> - -<h2><a name="functions">Function Details</a></h2> - -<h3><a name="WAIT_FOR_DATA-2">WAIT_FOR_DATA/2</a></h3> -<tt>WAIT_FOR_DATA(Data, Imapd_fsm) -> term() -</tt> - -<h3><a name="set_socket-2">set_socket/2</a></h3> -<tt>set_socket(Pid, Socket) -> term() -</tt> - -<h3><a name="start_link-0">start_link/0</a></h3> -<tt>start_link() -> term() -</tt> -</body> -</html> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>Module imapd_fsm</title> +<link rel="stylesheet" type="text/css" href="stylesheet.css"> +</head> +<body bgcolor="white"> + +<h1>Module imapd_fsm</h1> + +<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> +<p><b>Behaviours:</b> <a href="gen_fsm.html"><tt>gen_fsm</tt></a>.</p> + +<h2><a name="index">Function Index</a></h2> +<table width="100%" border="1"><tr><td valign="top"><a href="#WAIT_FOR_DATA-2">WAIT_FOR_DATA/2</a></td><td/></tr> +<tr><td valign="top"><a href="#set_socket-2">set_socket/2</a></td><td/></tr> +<tr><td valign="top"><a href="#start_link-0">start_link/0</a></td><td/></tr> +</table> + +<h2><a name="functions">Function Details</a></h2> + +<h3><a name="WAIT_FOR_DATA-2">WAIT_FOR_DATA/2</a></h3> +<tt>WAIT_FOR_DATA(Data, Imapd_fsm) -> term() +</tt> + +<h3><a name="set_socket-2">set_socket/2</a></h3> +<tt>set_socket(Pid, Socket) -> term() +</tt> + +<h3><a name="start_link-0">start_link/0</a></h3> +<tt>start_link() -> term() +</tt> +</body> +</html> doc/imapd_fsm.html @@ -1,30 +1,30 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<title>Module imapd_listener</title> -<link rel="stylesheet" type="text/css" href="stylesheet.css"> -</head> -<body bgcolor="white"> - -<h1>Module imapd_listener</h1> - -<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> -<p><b>Behaviours:</b> <a href="gen_server.html"><tt>gen_server</tt></a>.</p> - -<h2><a name="index">Function Index</a></h2> -<table width="100%" border="1"><tr><td valign="top"><a href="#init-1">init/1</a></td><td>Called by gen_server framework at process startup.</td></tr> -<tr><td valign="top"><a href="#start_link-2">start_link/2</a></td><td>Called by a supervisor to start the listening process.</td></tr> -</table> - -<h2><a name="functions">Function Details</a></h2> - -<h3><a name="init-1">init/1</a></h3> -<p><tt>init(Port::integer()) -> {ok, State} | {ok, State, Timeout} | ignore | {stop, Reason}</tt></p> -<p>Called by gen_server framework at process startup. - Create listening socket.</p> - -<h3><a name="start_link-2">start_link/2</a></h3> -<p><tt>start_link(Port::integer(), Module) -> {ok, Pid} | {error, Reason}</tt></p> -<p>Called by a supervisor to start the listening process.</p> -</body> -</html> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>Module imapd_listener</title> +<link rel="stylesheet" type="text/css" href="stylesheet.css"> +</head> +<body bgcolor="white"> + +<h1>Module imapd_listener</h1> + +<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> +<p><b>Behaviours:</b> <a href="gen_server.html"><tt>gen_server</tt></a>.</p> + +<h2><a name="index">Function Index</a></h2> +<table width="100%" border="1"><tr><td valign="top"><a href="#init-1">init/1</a></td><td>Called by gen_server framework at process startup.</td></tr> +<tr><td valign="top"><a href="#start_link-2">start_link/2</a></td><td>Called by a supervisor to start the listening process.</td></tr> +</table> + +<h2><a name="functions">Function Details</a></h2> + +<h3><a name="init-1">init/1</a></h3> +<p><tt>init(Port::integer()) -> {ok, State} | {ok, State, Timeout} | ignore | {stop, Reason}</tt></p> +<p>Called by gen_server framework at process startup. + Create listening socket.</p> + +<h3><a name="start_link-2">start_link/2</a></h3> +<p><tt>start_link(Port::integer(), Module) -> {ok, Pid} | {error, Reason}</tt></p> +<p>Called by a supervisor to start the listening process.</p> +</body> +</html> doc/imapd_listener.html @@ -1,182 +1,182 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<title>Module imapd_util</title> -<link rel="stylesheet" type="text/css" href="stylesheet.css"> -</head> -<body bgcolor="white"> - -<h1>Module imapd_util</h1> - IMAP server utility functions. -<p>Copyright © 2006 - 2007 Simple Enigma, Inc. All Rights Reserved.</p> -<ul><li><a href="#description">Description</a></li><li><a href="#types">Data Types</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> -<p><b>Version:</b> 0.0.6</p> -<p><b>Introduced in:</b> 0.0.6</p> -<p><b>Authors:</b> Stuart Jackson (<a href="mailto:sjackson@simpleenigma.com"><tt>sjackson@simpleenigma.com</tt></a>) [<em>web site:</em> <tt><a href="http://erlsoft.org" target="_top">http://erlsoft.org</a></tt>].</p> -<p><b>References</b><ul><li>See <a href="http://erlsoft.org/modules/erlmail" target="_top">Erlang Software Framework</a> for more information</li></ul></p> - -<h2><a name="description">Description</a></h2> IMAP server utility functions -<h2><a name="types">Data Types</a></h2> - -<h3><a name="type-cmd_data">cmd_data()</a></h3> -<p><tt>cmd_data() = term()</tt></p> - - -<h3><a name="type-command">command()</a></h3> -<p><tt>command() = atom()</tt></p> - - -<h3><a name="type-imap_cmd">imap_cmd()</a></h3> -<p><tt>imap_cmd() = {imap_cmd, <a href="#type-line">line()</a>, <a href="#type-tag">tag()</a>, <a href="#type-comamnd">comamnd()</a>, <a href="#type-cmd_data">cmd_data()</a>}</tt></p> - - -<h3><a name="type-imap_resp">imap_resp()</a></h3> -<p><tt>imap_resp() = {imap_resp, record}</tt></p> - - -<h3><a name="type-line">line()</a></h3> -<p><tt>line() = string()</tt></p> - - -<h3><a name="type-quoteoptions">quoteoptions()</a></h3> -<p><tt>quoteoptions() = true | false | optional</tt></p> - - -<h3><a name="type-tag">tag()</a></h3> -<p><tt>tag() = atom()</tt></p> - - -<h2><a name="index">Function Index</a></h2> -<table width="100%" border="1"><tr><td valign="top"><a href="#clean-1">clean/1</a></td><td>Removes whitespace and Doule Quotes from a string.</td></tr> -<tr><td valign="top"><a href="#flags_resp-1">flags_resp/1</a></td><td>Takes a list of flags and returns a response string.</td></tr> -<tr><td valign="top"><a href="#greeting-1">greeting/1</a></td><td>Returns IMAP greeting string from config file or uses Default.</td></tr> -<tr><td valign="top"><a href="#greeting_capability-1">greeting_capability/1</a></td><td>Check if capability data should be returned in greeting.</td></tr> -<tr><td valign="top"><a href="#heirachy_char-0">heirachy_char/0</a></td><td>Gets Heirarchy chara from config file.</td></tr> -<tr><td valign="top"><a href="#inbox-1">inbox/1</a></td><td>Make sure that the string INBOX is always capitalized at the - begining of the mailbox name.</td></tr> -<tr><td valign="top"><a href="#list_to_seq-1">list_to_seq/1</a></td><td>Converts a list of integers into an IMAP sequence.</td></tr> -<tr><td valign="top"><a href="#mailbox_info-1">mailbox_info/1</a></td><td>Takes a #mailbox_store{} record and returns all information in a - #mailbox{} record.</td></tr> -<tr><td valign="top"><a href="#mailbox_info-2">mailbox_info/2</a></td><td>Takes a #mailbox_store{} record and returns information from Flags - in a #mailbox{} record.</td></tr> -<tr><td valign="top"><a href="#parse-1">parse/1</a></td><td>Takes a command line from the connected IMAP client and parses the - it into an imap_cmd{} record.</td></tr> -<tr><td valign="top"><a href="#quote-1">quote/1</a></td><td>Determines if the given string needs to have Double Quotes - around it or not.</td></tr> -<tr><td valign="top"><a href="#quote-2">quote/2</a></td><td>Determines if the given string needs to have Double Quotes - around it or not based on the given options.</td></tr> -<tr><td valign="top"><a href="#re_split-1">re_split/1</a></td><td>Finds space to break string when double quotes strings are found.</td></tr> -<tr><td valign="top"><a href="#response-1">response/1</a></td><td>Take an #imap_resp{} record and returns a response string.</td></tr> -<tr><td valign="top"><a href="#send-2">send/2</a></td><td>Sends a Message to Socket adds CRLF if needed.</td></tr> -<tr><td valign="top"><a href="#seq_to_list-1">seq_to_list/1</a></td><td>Converts an IMAP sequence string into a lsit of intgers.</td></tr> -<tr><td valign="top"><a href="#split_at-1">split_at/1</a></td><td>Splits the given string into two strings at the first SPACE (chr(32)).</td></tr> -<tr><td valign="top"><a href="#split_at-2">split_at/2</a></td><td>Splits the given string into two strings at the first instace of Chr.</td></tr> -<tr><td valign="top"><a href="#status_flags-1">status_flags/1</a></td><td>Takes a string os status requests and returns a list of - status requests.</td></tr> -<tr><td valign="top"><a href="#status_info-2">status_info/2</a></td><td>Takes a list of status flags or a status string and returns - information for each requested flag.</td></tr> -<tr><td valign="top"><a href="#status_resp-1">status_resp/1</a></td><td>Takes a list of status information and returns a response string.</td></tr> -<tr><td valign="top"><a href="#unquote-1">unquote/1</a></td><td>Removes Double Quotes and white space from both sides of a string.</td></tr> -</table> - -<h2><a name="functions">Function Details</a></h2> - -<h3><a name="clean-1">clean/1</a></h3> -<p><tt>clean(String::string()) -> string()</tt></p> -<p>Removes whitespace and Doule Quotes from a string.</p> - -<h3><a name="flags_resp-1">flags_resp/1</a></h3> -<p><tt>flags_resp(List::list()) -> string()</tt></p> -<p>Takes a list of flags and returns a response string.</p> - -<h3><a name="greeting-1">greeting/1</a></h3> -<p><tt>greeting(Options::list()) -> string()</tt></p> -<p>Returns IMAP greeting string from config file or uses Default.</p> - -<h3><a name="greeting_capability-1">greeting_capability/1</a></h3> -<p><tt>greeting_capability(Options::list()) -> string()</tt></p> -<p>Check if capability data should be returned in greeting. - Default: false</p> - -<h3><a name="heirachy_char-0">heirachy_char/0</a></h3> -<p><tt>heirachy_char() -> string()</tt></p> -<p>Gets Heirarchy chara from config file. - Default: "/"</p> - -<h3><a name="inbox-1">inbox/1</a></h3> -<p><tt>inbox(MailBoxName::string()) -> string()</tt></p> -<p>Make sure that the string INBOX is always capitalized at the - begining of the mailbox name</p> - -<h3><a name="list_to_seq-1">list_to_seq/1</a></h3> -<p><tt>list_to_seq(List::list()) -> string()</tt></p> -<p>Converts a list of integers into an IMAP sequence</p> - -<h3><a name="mailbox_info-1">mailbox_info/1</a></h3> -<p><tt>mailbox_info(MailBoxStore::tuple()) -> tuple()</tt></p> -<p>Takes a #mailbox_store{} record and returns all information in a - #mailbox{} record</p> - -<h3><a name="mailbox_info-2">mailbox_info/2</a></h3> -<p><tt>mailbox_info(MailBoxStore::tuple(), Flags::list()) -> tuple()</tt></p> -<p>Takes a #mailbox_store{} record and returns information from Flags - in a #mailbox{} record</p> - -<h3><a name="parse-1">parse/1</a></h3> -<p><tt>parse(Line::string()) -> <a href="#type-imap_cmd">imap_cmd()</a></tt></p> -<p>Takes a command line from the connected IMAP client and parses the - it into an imap_cmd{} record</p> - -<h3><a name="quote-1">quote/1</a></h3> -<p><tt>quote(String::string()) -> string()</tt></p> -<p>Determines if the given string needs to have Double Quotes - around it or not</p> - -<h3><a name="quote-2">quote/2</a></h3> -<p><tt>quote(String::string(), Options::<a href="#type-quoteoptions">quoteoptions()</a>) -> string()</tt></p> -<p>Determines if the given string needs to have Double Quotes - around it or not based on the given options. Default = false</p> - -<h3><a name="re_split-1">re_split/1</a></h3> -<p><tt>re_split(String::string()) -> {string(), string()}</tt></p> -<p>Finds space to break string when double quotes strings are found</p> - -<h3><a name="response-1">response/1</a></h3> -<p><tt>response(Resp::<a href="#type-imap_resp">imap_resp()</a>) -> string()</tt></p> -<p>Take an #imap_resp{} record and returns a response string</p> - -<h3><a name="send-2">send/2</a></h3> -<p><tt>send(Message::string(), Socket::port()) -> ok | {error, string()}</tt></p> -<p>Sends a Message to Socket adds CRLF if needed.</p> - -<h3><a name="seq_to_list-1">seq_to_list/1</a></h3> -<p><tt>seq_to_list(Sequence::string()) -> list()</tt></p> -<p>Converts an IMAP sequence string into a lsit of intgers</p> - -<h3><a name="split_at-1">split_at/1</a></h3> -<p><tt>split_at(String::string()) -> {string(), string()}</tt></p> -<p>Splits the given string into two strings at the first SPACE (chr(32))</p> - -<h3><a name="split_at-2">split_at/2</a></h3> -<p><tt>split_at(String::string(), Chr::char()) -> {string(), string()}</tt></p> -<p>Splits the given string into two strings at the first instace of Chr</p> - -<h3><a name="status_flags-1">status_flags/1</a></h3> -<p><tt>status_flags(String::string()) -> list()</tt></p> -<p>Takes a string os status requests and returns a list of - status requests</p> - -<h3><a name="status_info-2">status_info/2</a></h3> -<p><tt>status_info(MailBoxInfo::tuple(), List::list()) -> list()</tt></p> -<p>Takes a list of status flags or a status string and returns - information for each requested flag</p> - -<h3><a name="status_resp-1">status_resp/1</a></h3> -<p><tt>status_resp(List::list()) -> string()</tt></p> -<p>Takes a list of status information and returns a response string</p> - -<h3><a name="unquote-1">unquote/1</a></h3> -<p><tt>unquote(String::string()) -> string()</tt></p> -<p>Removes Double Quotes and white space from both sides of a string</p> -</body> -</html> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>Module imapd_util</title> +<link rel="stylesheet" type="text/css" href="stylesheet.css"> +</head> +<body bgcolor="white"> + +<h1>Module imapd_util</h1> + IMAP server utility functions. +<p>Copyright © 2006 - 2007 Simple Enigma, Inc. All Rights Reserved.</p> +<ul><li><a href="#description">Description</a></li><li><a href="#types">Data Types</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> +<p><b>Version:</b> 0.0.6</p> +<p><b>Introduced in:</b> 0.0.6</p> +<p><b>Authors:</b> Stuart Jackson (<a href="mailto:sjackson@simpleenigma.com"><tt>sjackson@simpleenigma.com</tt></a>) [<em>web site:</em> <tt><a href="http://erlsoft.org" target="_top">http://erlsoft.org</a></tt>].</p> +<p><b>References</b><ul><li> See <a href="http://erlsoft.org/modules/erlmail" target="_top">Erlang Software Framework</a> for more information</li></ul></p> + +<h2><a name="description">Description</a></h2> IMAP server utility functions +<h2><a name="types">Data Types</a></h2> + +<h3><a name="type-cmd_data">cmd_data()</a></h3> +<p><tt>cmd_data() = term()</tt></p> + + +<h3><a name="type-command">command()</a></h3> +<p><tt>command() = atom()</tt></p> + + +<h3><a name="type-imap_cmd">imap_cmd()</a></h3> +<p><tt>imap_cmd() = {imap_cmd, <a href="#type-line">line()</a>, <a href="#type-tag">tag()</a>, <a href="#type-comamnd">comamnd()</a>, <a href="#type-cmd_data">cmd_data()</a>}</tt></p> + + +<h3><a name="type-imap_resp">imap_resp()</a></h3> +<p><tt>imap_resp() = {imap_resp, record}</tt></p> + + +<h3><a name="type-line">line()</a></h3> +<p><tt>line() = string()</tt></p> + + +<h3><a name="type-quoteoptions">quoteoptions()</a></h3> +<p><tt>quoteoptions() = true | false | optional</tt></p> + + +<h3><a name="type-tag">tag()</a></h3> +<p><tt>tag() = atom()</tt></p> + + +<h2><a name="index">Function Index</a></h2> +<table width="100%" border="1"><tr><td valign="top"><a href="#clean-1">clean/1</a></td><td>Removes whitespace and Doule Quotes from a string.</td></tr> +<tr><td valign="top"><a href="#flags_resp-1">flags_resp/1</a></td><td>Takes a list of flags and returns a response string.</td></tr> +<tr><td valign="top"><a href="#greeting-1">greeting/1</a></td><td>Returns IMAP greeting string from config file or uses Default.</td></tr> +<tr><td valign="top"><a href="#greeting_capability-1">greeting_capability/1</a></td><td>Check if capability data should be returned in greeting.</td></tr> +<tr><td valign="top"><a href="#heirachy_char-0">heirachy_char/0</a></td><td>Gets Heirarchy chara from config file.</td></tr> +<tr><td valign="top"><a href="#inbox-1">inbox/1</a></td><td>Make sure that the string INBOX is always capitalized at the + begining of the mailbox name.</td></tr> +<tr><td valign="top"><a href="#list_to_seq-1">list_to_seq/1</a></td><td>Converts a list of integers into an IMAP sequence.</td></tr> +<tr><td valign="top"><a href="#mailbox_info-1">mailbox_info/1</a></td><td>Takes a #mailbox_store{} record and returns all information in a + #mailbox{} record.</td></tr> +<tr><td valign="top"><a href="#mailbox_info-2">mailbox_info/2</a></td><td>Takes a #mailbox_store{} record and returns information from Flags + in a #mailbox{} record.</td></tr> +<tr><td valign="top"><a href="#parse-1">parse/1</a></td><td>Takes a command line from the connected IMAP client and parses the + it into an imap_cmd{} record.</td></tr> +<tr><td valign="top"><a href="#quote-1">quote/1</a></td><td>Determines if the given string needs to have Double Quotes + around it or not.</td></tr> +<tr><td valign="top"><a href="#quote-2">quote/2</a></td><td>Determines if the given string needs to have Double Quotes + around it or not based on the given options.</td></tr> +<tr><td valign="top"><a href="#re_split-1">re_split/1</a></td><td>Finds space to break string when double quotes strings are found.</td></tr> +<tr><td valign="top"><a href="#response-1">response/1</a></td><td>Take an #imap_resp{} record and returns a response string.</td></tr> +<tr><td valign="top"><a href="#send-2">send/2</a></td><td>Sends a Message to Socket adds CRLF if needed.</td></tr> +<tr><td valign="top"><a href="#seq_to_list-1">seq_to_list/1</a></td><td>Converts an IMAP sequence string into a lsit of intgers.</td></tr> +<tr><td valign="top"><a href="#split_at-1">split_at/1</a></td><td>Splits the given string into two strings at the first SPACE (chr(32)).</td></tr> +<tr><td valign="top"><a href="#split_at-2">split_at/2</a></td><td>Splits the given string into two strings at the first instace of Chr.</td></tr> +<tr><td valign="top"><a href="#status_flags-1">status_flags/1</a></td><td>Takes a string os status requests and returns a list of + status requests.</td></tr> +<tr><td valign="top"><a href="#status_info-2">status_info/2</a></td><td>Takes a list of status flags or a status string and returns + information for each requested flag.</td></tr> +<tr><td valign="top"><a href="#status_resp-1">status_resp/1</a></td><td>Takes a list of status information and returns a response string.</td></tr> +<tr><td valign="top"><a href="#unquote-1">unquote/1</a></td><td>Removes Double Quotes and white space from both sides of a string.</td></tr> +</table> + +<h2><a name="functions">Function Details</a></h2> + +<h3><a name="clean-1">clean/1</a></h3> +<p><tt>clean(String::string()) -> string()</tt></p> +<p>Removes whitespace and Doule Quotes from a string.</p> + +<h3><a name="flags_resp-1">flags_resp/1</a></h3> +<p><tt>flags_resp(List::list()) -> string()</tt></p> +<p>Takes a list of flags and returns a response string.</p> + +<h3><a name="greeting-1">greeting/1</a></h3> +<p><tt>greeting(Options::list()) -> string()</tt></p> +<p>Returns IMAP greeting string from config file or uses Default.</p> + +<h3><a name="greeting_capability-1">greeting_capability/1</a></h3> +<p><tt>greeting_capability(Options::list()) -> string()</tt></p> +<p>Check if capability data should be returned in greeting. + Default: false</p> + +<h3><a name="heirachy_char-0">heirachy_char/0</a></h3> +<p><tt>heirachy_char() -> string()</tt></p> +<p>Gets Heirarchy chara from config file. + Default: "/"</p> + +<h3><a name="inbox-1">inbox/1</a></h3> +<p><tt>inbox(MailBoxName::string()) -> string()</tt></p> +<p>Make sure that the string INBOX is always capitalized at the + begining of the mailbox name</p> + +<h3><a name="list_to_seq-1">list_to_seq/1</a></h3> +<p><tt>list_to_seq(List::list()) -> string()</tt></p> +<p>Converts a list of integers into an IMAP sequence</p> + +<h3><a name="mailbox_info-1">mailbox_info/1</a></h3> +<p><tt>mailbox_info(MailBoxStore::tuple()) -> tuple()</tt></p> +<p>Takes a #mailbox_store{} record and returns all information in a + #mailbox{} record</p> + +<h3><a name="mailbox_info-2">mailbox_info/2</a></h3> +<p><tt>mailbox_info(MailBoxStore::tuple(), Flags::list()) -> tuple()</tt></p> +<p>Takes a #mailbox_store{} record and returns information from Flags + in a #mailbox{} record</p> + +<h3><a name="parse-1">parse/1</a></h3> +<p><tt>parse(Line::string()) -> <a href="#type-imap_cmd">imap_cmd()</a></tt></p> +<p>Takes a command line from the connected IMAP client and parses the + it into an imap_cmd{} record</p> + +<h3><a name="quote-1">quote/1</a></h3> +<p><tt>quote(String::string()) -> string()</tt></p> +<p>Determines if the given string needs to have Double Quotes + around it or not</p> + +<h3><a name="quote-2">quote/2</a></h3> +<p><tt>quote(String::string(), Options::<a href="#type-quoteoptions">quoteoptions()</a>) -> string()</tt></p> +<p>Determines if the given string needs to have Double Quotes + around it or not based on the given options. Default = false</p> + +<h3><a name="re_split-1">re_split/1</a></h3> +<p><tt>re_split(String::string()) -> {string(), string()}</tt></p> +<p>Finds space to break string when double quotes strings are found</p> + +<h3><a name="response-1">response/1</a></h3> +<p><tt>response(Resp::<a href="#type-imap_resp">imap_resp()</a>) -> string()</tt></p> +<p>Take an #imap_resp{} record and returns a response string</p> + +<h3><a name="send-2">send/2</a></h3> +<p><tt>send(Message::string(), Socket::port()) -> ok | {error, string()}</tt></p> +<p>Sends a Message to Socket adds CRLF if needed.</p> + +<h3><a name="seq_to_list-1">seq_to_list/1</a></h3> +<p><tt>seq_to_list(Sequence::string()) -> list()</tt></p> +<p>Converts an IMAP sequence string into a lsit of intgers</p> + +<h3><a name="split_at-1">split_at/1</a></h3> +<p><tt>split_at(String::string()) -> {string(), string()}</tt></p> +<p>Splits the given string into two strings at the first SPACE (chr(32))</p> + +<h3><a name="split_at-2">split_at/2</a></h3> +<p><tt>split_at(String::string(), Chr::char()) -> {string(), string()}</tt></p> +<p>Splits the given string into two strings at the first instace of Chr</p> + +<h3><a name="status_flags-1">status_flags/1</a></h3> +<p><tt>status_flags(String::string()) -> list()</tt></p> +<p>Takes a string os status requests and returns a list of + status requests</p> + +<h3><a name="status_info-2">status_info/2</a></h3> +<p><tt>status_info(MailBoxInfo::tuple(), List::list()) -> list()</tt></p> +<p>Takes a list of status flags or a status string and returns + information for each requested flag</p> + +<h3><a name="status_resp-1">status_resp/1</a></h3> +<p><tt>status_resp(List::list()) -> string()</tt></p> +<p>Takes a list of status information and returns a response string</p> + +<h3><a name="unquote-1">unquote/1</a></h3> +<p><tt>unquote(String::string()) -> string()</tt></p> +<p>Removes Double Quotes and white space from both sides of a string</p> +</body> +</html> doc/imapd_util.html @@ -1,17 +1,17 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<title>The erlmail application</title> -</head> -<frameset cols="20%,80%"> -<frame src="modules-frame.html" name="modulesFrame" title=""> - -<frame src="overview-summary.html" name="overviewFrame" title=""> -<noframes> -<h2>This page uses frames</h2> -<p>Your browser does not accept frames. -<br>You should go to the <a href="overview-summary.html">non-frame version</a> instead. -</p> -</noframes> -</frameset> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>The erlmail application</title> +</head> +<frameset cols="20%,80%"> +<frame src="modules-frame.html" name="modulesFrame" title=""> + +<frame src="overview-summary.html" name="overviewFrame" title=""> +<noframes> +<h2>This page uses frames</h2> +<p>Your browser does not accept frames. +<br>You should go to the <a href="overview-summary.html">non-frame version</a> instead. +</p> +</noframes> +</frameset> </html> \ No newline at end of file doc/index.html @@ -1,116 +1,116 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<title>Module mnesia_store</title> -<link rel="stylesheet" type="text/css" href="stylesheet.css"> -</head> -<body bgcolor="white"> - -<h1>Module mnesia_store</h1> - MNESIA email store. -<p>Copyright © 2006 - 2007 Simple Enigma, Inc. All Rights Reserved.</p> -<ul><li><a href="#description">Description</a></li><li><a href="#types">Data Types</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> -<p><b>Version:</b> 0.0.6</p> -<p><b>Introduced in:</b> 0.0.6</p> -<p><b>Authors:</b> Stuart Jackson (<a href="mailto:sjackson@simpleenigma.com"><tt>sjackson@simpleenigma.com</tt></a>) [<em>web site:</em> <tt><a href="http://erlsoft.org" target="_top">http://erlsoft.org</a></tt>].</p> -<p><b>References</b><ul><li>See <a href="http://erlsoft.org/modules/erlmail" target="_top">Erlang Software Framework</a> for more information</li></ul></p> - -<h2><a name="description">Description</a></h2> MNESIA email store -<h2><a name="types">Data Types</a></h2> - -<h3><a name="type-store_type">store_type()</a></h3> -<p><tt>store_type() = domain | user | message | mailbox_store</tt></p> - - -<h2><a name="index">Function Index</a></h2> -<table width="100%" border="1"><tr><td valign="top"><a href="#check-1">check/1</a></td><td>Performs check command on store of Type.</td></tr> -<tr><td valign="top"><a href="#create-1">create/1</a></td><td>Creates store for Type.</td></tr> -<tr><td valign="top"><a href="#delete-1">delete/1</a></td><td>Deletes entry in store of Type.</td></tr> -<tr><td valign="top"><a href="#deliver-1">deliver/1</a></td><td>Takes a #message{} record and deilvers it to a users INBOX.</td></tr> -<tr><td valign="top"><a href="#drop-1">drop/1</a></td><td> Creates store for Type.</td></tr> -<tr><td valign="top"><a href="#ensure_inbox-1">ensure_inbox/1</a></td><td> Makes sure that the specified user has an INBOX.</td></tr> -<tr><td valign="top"><a href="#init-1">init/1</a></td><td> Initalizes data store.</td></tr> -<tr><td valign="top"><a href="#insert-1">insert/1</a></td><td> Inserts Record into correct store.</td></tr> -<tr><td valign="top"><a href="#list-0">list/0</a></td><td> Lists all domains.</td></tr> -<tr><td valign="top"><a href="#list-1">list/1</a></td><td> Lists all domains, users, messges or mailboxes depnding on - term that is given.</td></tr> -<tr><td valign="top"><a href="#message_name-1">message_name/1</a></td><td> Generates message name.</td></tr> -<tr><td valign="top"><a href="#mlist-3">mlist/3</a></td><td>Lists mailbox information for LIST and LSUB commands.</td></tr> -<tr><td valign="top"><a href="#recent-1">recent/1</a></td><td>Generates a list of message names that have the \Recent flag set.</td></tr> -<tr><td valign="top"><a href="#select-1">select/1</a></td><td> Retrives Record from the correct store.</td></tr> -<tr><td valign="top"><a href="#unseen-1">unseen/1</a></td><td>Generates a list of message names that have the \Unseen flag set.</td></tr> -<tr><td valign="top"><a href="#update-1">update/1</a></td><td> Update Record into correct store.</td></tr> -</table> - -<h2><a name="functions">Function Details</a></h2> - -<h3><a name="check-1">check/1</a></h3> -<p><tt>check(Type::<a href="#type-store_type">store_type()</a>) -> ok | undefined | {error, string()}</tt></p> -<p>Performs check command on store of Type. Commits and cleans up any - actions that are not writen to disk on a regualr basis</p> - -<h3><a name="create-1">create/1</a></h3> -<p><tt>create(Type::<a href="#type-store_type">store_type()</a>) -> ok | undefined | {error, string()}</tt></p> -<p>Creates store for Type.</p> - -<h3><a name="delete-1">delete/1</a></h3> -<p><tt>delete(Type::<a href="#type-store_type">store_type()</a>) -> ok | undefined | {error, string()}</tt></p> -<p>Deletes entry in store of Type.</p> - -<h3><a name="deliver-1">deliver/1</a></h3> -<p><tt>deliver(Message::tuple()) -> ok | undefined | {error, string()}</tt></p> -<p>Takes a #message{} record and deilvers it to a users INBOX</p> - -<h3><a name="drop-1">drop/1</a></h3> -<p><tt>drop(Type::<a href="#type-store_type">store_type()</a>) -> ok | undefined | {error, string()}</tt></p> -<p> Creates store for Type.</p> - -<h3><a name="ensure_inbox-1">ensure_inbox/1</a></h3> -<p><tt>ensure_inbox(User::{UserName::string(), DomainName::string()}) -> {ok, create} | {ok, exists} | undefined | {error, string()}</tt></p> -<p> Makes sure that the specified user has an INBOX. Used in deliver command.</p> - -<h3><a name="init-1">init/1</a></h3> -<p><tt>init(NodeList::list()) -> ok | undefined | {error, string()}</tt></p> -<p> Initalizes data store. Mnesia specific command.</p> - -<h3><a name="insert-1">insert/1</a></h3> -<p><tt>insert(Record::tuple()) -> ok | undefined | {error, string()}</tt></p> -<p> Inserts Record into correct store. Records can be of types: - #domain{}, #user{}, #message{} or #mailbox_store{}</p> - -<h3><a name="list-0">list/0</a></h3> -<p><tt>list() -> ok | undefined | {error, string()}</tt></p> -<p> Lists all domains.</p> - -<h3><a name="list-1">list/1</a></h3> -<p><tt>list(Type::any()) -> ok | undefined | {error, string()}</tt></p> -<p> Lists all domains, users, messges or mailboxes depnding on - term that is given</p> - -<h3><a name="message_name-1">message_name/1</a></h3> -<p><tt>message_name(Args::any()) -> string() | undefined | {error, string()}</tt></p> -<p> Generates message name. May use gen_store:message_name/1 or - be specific to the message store.</p> - -<h3><a name="mlist-3">mlist/3</a></h3> -<p><tt>mlist(MailBoxName::string(), X2::{UserName::string(), DomainName::string()}, Subscribed::bool()) -> list()</tt></p> -<p>Lists mailbox information for LIST and LSUB commands</p> - -<h3><a name="recent-1">recent/1</a></h3> -<p><tt>recent(X1::{MailBoxName::string(), UserName::string(), DomainName::string()}) -> list() | {error, Reason}</tt></p> -<p>Generates a list of message names that have the \Recent flag set</p> - -<h3><a name="select-1">select/1</a></h3> -<p><tt>select(Name::any()) -> ok | undefined | {error, string()}</tt></p> -<p> Retrives Record from the correct store.</p> - -<h3><a name="unseen-1">unseen/1</a></h3> -<p><tt>unseen(X1::{MailBoxName::string(), UserName::string(), DomainName::string()}) -> list() | {error, Reason}</tt></p> -<p>Generates a list of message names that have the \Unseen flag set</p> - -<h3><a name="update-1">update/1</a></h3> -<p><tt>update(Record::tuple()) -> ok | undefined | {error, string()}</tt></p> -<p> Update Record into correct store. Records can be of types: - #domain{}, #user{}, #message{} or #mailbox_store{}</p> -</body> -</html> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>Module mnesia_store</title> +<link rel="stylesheet" type="text/css" href="stylesheet.css"> +</head> +<body bgcolor="white"> + +<h1>Module mnesia_store</h1> + MNESIA email store. +<p>Copyright © 2006 - 2007 Simple Enigma, Inc. All Rights Reserved.</p> +<ul><li><a href="#description">Description</a></li><li><a href="#types">Data Types</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> +<p><b>Version:</b> 0.0.6</p> +<p><b>Introduced in:</b> 0.0.6</p> +<p><b>Authors:</b> Stuart Jackson (<a href="mailto:sjackson@simpleenigma.com"><tt>sjackson@simpleenigma.com</tt></a>) [<em>web site:</em> <tt><a href="http://erlsoft.org" target="_top">http://erlsoft.org</a></tt>].</p> +<p><b>References</b><ul><li>See <a href="http://erlsoft.org/modules/erlmail" target="_top">Erlang Software Framework</a> for more information</li></ul></p> + +<h2><a name="description">Description</a></h2> MNESIA email store +<h2><a name="types">Data Types</a></h2> + +<h3><a name="type-store_type">store_type()</a></h3> +<p><tt>store_type() = domain | user | message | mailbox_store</tt></p> + + +<h2><a name="index">Function Index</a></h2> +<table width="100%" border="1"><tr><td valign="top"><a href="#check-1">check/1</a></td><td>Performs check command on store of Type.</td></tr> +<tr><td valign="top"><a href="#create-1">create/1</a></td><td>Creates store for Type.</td></tr> +<tr><td valign="top"><a href="#delete-1">delete/1</a></td><td>Deletes entry in store of Type.</td></tr> +<tr><td valign="top"><a href="#deliver-1">deliver/1</a></td><td>Takes a #message{} record and deilvers it to a users INBOX.</td></tr> +<tr><td valign="top"><a href="#drop-1">drop/1</a></td><td> Creates store for Type.</td></tr> +<tr><td valign="top"><a href="#ensure_inbox-1">ensure_inbox/1</a></td><td> Makes sure that the specified user has an INBOX.</td></tr> +<tr><td valign="top"><a href="#init-1">init/1</a></td><td> Initalizes data store.</td></tr> +<tr><td valign="top"><a href="#insert-1">insert/1</a></td><td> Inserts Record into correct store.</td></tr> +<tr><td valign="top"><a href="#list-0">list/0</a></td><td> Lists all domains.</td></tr> +<tr><td valign="top"><a href="#list-1">list/1</a></td><td> Lists all domains, users, messges or mailboxes depnding on + term that is given.</td></tr> +<tr><td valign="top"><a href="#message_name-1">message_name/1</a></td><td> Generates message name.</td></tr> +<tr><td valign="top"><a href="#mlist-3">mlist/3</a></td><td>Lists mailbox information for LIST and LSUB commands.</td></tr> +<tr><td valign="top"><a href="#recent-1">recent/1</a></td><td>Generates a list of message names that have the \Recent flag set.</td></tr> +<tr><td valign="top"><a href="#select-1">select/1</a></td><td> Retrives Record from the correct store.</td></tr> +<tr><td valign="top"><a href="#unseen-1">unseen/1</a></td><td>Generates a list of message names that have the \Unseen flag set.</td></tr> +<tr><td valign="top"><a href="#update-1">update/1</a></td><td> Update Record into correct store.</td></tr> +</table> + +<h2><a name="functions">Function Details</a></h2> + +<h3><a name="check-1">check/1</a></h3> +<p><tt>check(Type::<a href="#type-store_type">store_type()</a>) -> ok | undefined | {error, string()}</tt></p> +<p>Performs check command on store of Type. Commits and cleans up any + actions that are not writen to disk on a regualr basis</p> + +<h3><a name="create-1">create/1</a></h3> +<p><tt>create(Type::<a href="#type-store_type">store_type()</a>) -> ok | undefined | {error, string()}</tt></p> +<p>Creates store for Type.</p> + +<h3><a name="delete-1">delete/1</a></h3> +<p><tt>delete(Type::<a href="#type-store_type">store_type()</a>) -> ok | undefined | {error, string()}</tt></p> +<p>Deletes entry in store of Type.</p> + +<h3><a name="deliver-1">deliver/1</a></h3> +<p><tt>deliver(Message::tuple()) -> ok | undefined | {error, string()}</tt></p> +<p>Takes a #message{} record and deilvers it to a users INBOX</p> + +<h3><a name="drop-1">drop/1</a></h3> +<p><tt>drop(Type::<a href="#type-store_type">store_type()</a>) -> ok | undefined | {error, string()}</tt></p> +<p> Creates store for Type.</p> + +<h3><a name="ensure_inbox-1">ensure_inbox/1</a></h3> +<p><tt>ensure_inbox(User::{UserName::string(), DomainName::string()}) -> {ok, create} | {ok, exists} | undefined | {error, string()}</tt></p> +<p> Makes sure that the specified user has an INBOX. Used in deliver command.</p> + +<h3><a name="init-1">init/1</a></h3> +<p><tt>init(NodeList::list()) -> ok | undefined | {error, string()}</tt></p> +<p> Initalizes data store. Mnesia specific command.</p> + +<h3><a name="insert-1">insert/1</a></h3> +<p><tt>insert(Record::tuple()) -> ok | undefined | {error, string()}</tt></p> +<p> Inserts Record into correct store. Records can be of types: + #domain{}, #user{}, #message{} or #mailbox_store{}</p> + +<h3><a name="list-0">list/0</a></h3> +<p><tt>list() -> ok | undefined | {error, string()}</tt></p> +<p> Lists all domains.</p> + +<h3><a name="list-1">list/1</a></h3> +<p><tt>list(Type::any()) -> ok | undefined | {error, string()}</tt></p> +<p> Lists all domains, users, messges or mailboxes depnding on + term that is given</p> + +<h3><a name="message_name-1">message_name/1</a></h3> +<p><tt>message_name(Args::any()) -> string() | undefined | {error, string()}</tt></p> +<p> Generates message name. May use gen_store:message_name/1 or + be specific to the message store.</p> + +<h3><a name="mlist-3">mlist/3</a></h3> +<p><tt>mlist(MailBoxName::string(), X2::{UserName::string(), DomainName::string()}, Subscribed::bool()) -> list()</tt></p> +<p>Lists mailbox information for LIST and LSUB commands</p> + +<h3><a name="recent-1">recent/1</a></h3> +<p><tt>recent(X1::{MailBoxName::string(), UserName::string(), DomainName::string()}) -> list() | {error, Reason}</tt></p> +<p>Generates a list of message names that have the \Recent flag set</p> + +<h3><a name="select-1">select/1</a></h3> +<p><tt>select(Name::any()) -> ok | undefined | {error, string()}</tt></p> +<p> Retrives Record from the correct store.</p> + +<h3><a name="unseen-1">unseen/1</a></h3> +<p><tt>unseen(X1::{MailBoxName::string(), UserName::string(), DomainName::string()}) -> list() | {error, Reason}</tt></p> +<p>Generates a list of message names that have the \Unseen flag set</p> + +<h3><a name="update-1">update/1</a></h3> +<p><tt>update(Record::tuple()) -> ok | undefined | {error, string()}</tt></p> +<p> Update Record into correct store. Records can be of types: + #domain{}, #user{}, #message{} or #mailbox_store{}</p> +</body> +</html> doc/mnesia_store.html @@ -1,11 +1,11 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<title>The erlmail application</title> -<link rel="stylesheet" type="text/css" href="stylesheet.css"> -</head> -<body bgcolor="white"> -<h2>Modules</h2> -<table width="100%" border="0"><tr><td><a href="dets_store.html" target="overviewFrame">dets_store</a></td></tr><tr><td><a href="erlmail.html" target="overviewFrame">erlmail</a></td></tr><tr><td><a href="erlmail_conf.html" target="overviewFrame">erlmail_conf</a></td></tr><tr><td><a href="erlmail_test.html" target="overviewFrame">erlmail_test</a></td></tr><tr><td><a href="erlmail_util.html" target="overviewFrame">erlmail_util</a></td></tr><tr><td><a href="gen_store.html" target="overviewFrame">gen_store</a></td></tr><tr><td><a href="imap_parser.html" target="overviewFrame">imap_parser</a></td></tr><tr><td><a href="imap_scan.html" target="overviewFrame">imap_scan</a></td></tr><tr><td><a href="imapc.html" target="overviewFrame">imapc</a></td></tr><tr><td><a href="imapc_fsm.html" target="overviewFrame">imapc_fsm</a></td></tr><tr><td><a href="imapc_util.html" target="overviewFrame">imapc_util</a></td></tr><tr><td><a href="imapd.html" target="overviewFrame">imapd</a></td></tr><tr><td><a href="imapd_app.html" target="overviewFrame">imapd_app</a></td></tr><tr><td><a href="imapd_cmd.html" target="overviewFrame">imapd_cmd</a></td></tr><tr><td><a href="imapd_ext.html" target="overviewFrame">imapd_ext</a></td></tr><tr><td><a href="imapd_fsm.html" target="overviewFrame">imapd_fsm</a></td></tr><tr><td><a href="imapd_listener.html" target="overviewFrame">imapd_listener</a></td></tr><tr><td><a href="imapd_util.html" target="overviewFrame">imapd_util</a></td></tr><tr><td><a href="mnesia_store.html" target="overviewFrame">mnesia_store</a></td></tr><tr><td><a href="mysql_store.html" target="overviewFrame">mysql_store</a></td></tr><tr><td><a href="smtpc.html" target="overviewFrame">smtpc</a></td></tr><tr><td><a href="smtpc_fsm.html" target="overviewFrame">smtpc_fsm</a></td></tr><tr><td><a href="smtpd_app.html" target="overviewFrame">smtpd_app</a></td></tr><tr><td><a href="smtpd_cmd.html" target="overviewFrame">smtpd_cmd</a></td></tr><tr><td><a href="smtpd_fsm.html" target="overviewFrame">smtpd_fsm</a></td></tr><tr><td><a href="smtpd_listener.html" target="overviewFrame">smtpd_listener</a></td></tr></table> -</body> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>The erlmail application</title> +<link rel="stylesheet" type="text/css" href="stylesheet.css"> +</head> +<body bgcolor="white"> +<h2>Modules</h2> +<table width="100%" border="0"><tr><td><a href="dets_store.html" target="overviewFrame">dets_store</a></td></tr><tr><td><a href="erlmail_conf.html" target="overviewFrame">erlmail_conf</a></td></tr><tr><td><a href="erlmail_test.html" target="overviewFrame">erlmail_test</a></td></tr><tr><td><a href="erlmail_util.html" target="overviewFrame">erlmail_util</a></td></tr><tr><td><a href="gen_store.html" target="overviewFrame">gen_store</a></td></tr><tr><td><a href="imap_parser.html" target="overviewFrame">imap_parser</a></td></tr><tr><td><a href="imap_scan.html" target="overviewFrame">imap_scan</a></td></tr><tr><td><a href="imapc.html" target="overviewFrame">imapc</a></td></tr><tr><td><a href="imapc_fsm.html" target="overviewFrame">imapc_fsm</a></td></tr><tr><td><a href="imapc_util.html" target="overviewFrame">imapc_util</a></td></tr><tr><td><a href="imapd.html" target="overviewFrame">imapd</a></td></tr><tr><td><a href="imapd_app.html" target="overviewFrame">imapd_app</a></td></tr><tr><td><a href="imapd_cmd.html" target="overviewFrame">imapd_cmd</a></td></tr><tr><td><a href="imapd_ext.html" target="overviewFrame">imapd_ext</a></td></tr><tr><td><a href="imapd_fsm.html" target="overviewFrame">imapd_fsm</a></td></tr><tr><td><a href="imapd_listener.html" target="overviewFrame">imapd_listener</a></td></tr><tr><td><a href="imapd_util.html" target="overviewFrame">imapd_util</a></td></tr><tr><td><a href="mnesia_store.html" target="overviewFrame">mnesia_store</a></td></tr><tr><td><a href="mysql_store.html" target="overviewFrame">mysql_store</a></td></tr><tr><td><a href="smtpc.html" target="overviewFrame">smtpc</a></td></tr><tr><td><a href="smtpc_fsm.html" target="overviewFrame">smtpc_fsm</a></td></tr><tr><td><a href="smtpd_app.html" target="overviewFrame">smtpd_app</a></td></tr><tr><td><a href="smtpd_cmd.html" target="overviewFrame">smtpd_cmd</a></td></tr><tr><td><a href="smtpd_fsm.html" target="overviewFrame">smtpd_fsm</a></td></tr><tr><td><a href="smtpd_listener.html" target="overviewFrame">smtpd_listener</a></td></tr></table> +</body> </html> \ No newline at end of file doc/modules-frame.html @@ -1,105 +1,105 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<title>Module mysql_store</title> -<link rel="stylesheet" type="text/css" href="stylesheet.css"> -</head> -<body bgcolor="white"> - -<h1>Module mysql_store</h1> - -<ul><li><a href="#types">Data Types</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> - -<h2><a name="types">Data Types</a></h2> - -<h3><a name="type-store_type">store_type()</a></h3> -<p><tt>store_type() = domain | user | message | mailbox_store</tt></p> - - -<h2><a name="index">Function Index</a></h2> -<table width="100%" border="1"><tr><td valign="top"><a href="#check-1">check/1</a></td><td>Performs check command on store of Type.</td></tr> -<tr><td valign="top"><a href="#create-1">create/1</a></td><td>Creates store for Type.</td></tr> -<tr><td valign="top"><a href="#delete-1">delete/1</a></td><td>Deletes entry in store of Type.</td></tr> -<tr><td valign="top"><a href="#deliver-1">deliver/1</a></td><td>Takes a #message{} record and deilvers it to a users INBOX.</td></tr> -<tr><td valign="top"><a href="#drop-1">drop/1</a></td><td> Creates store for Type.</td></tr> -<tr><td valign="top"><a href="#ensure_inbox-1">ensure_inbox/1</a></td><td> Makes sure that the specified user has an INBOX.</td></tr> -<tr><td valign="top"><a href="#insert-1">insert/1</a></td><td> Inserts Record into correct store.</td></tr> -<tr><td valign="top"><a href="#list-0">list/0</a></td><td> Lists all domains.</td></tr> -<tr><td valign="top"><a href="#list-1">list/1</a></td><td> Lists all domains, users, messges or mailboxes depnding on - term that is given.</td></tr> -<tr><td valign="top"><a href="#message_name-1">message_name/1</a></td><td> Generates message name.</td></tr> -<tr><td valign="top"><a href="#mlist-3">mlist/3</a></td><td>Lists mailbox information for LIST and LSUB commands.</td></tr> -<tr><td valign="top"><a href="#recent-1">recent/1</a></td><td>Generates a list of message names that have the \Recent flag set.</td></tr> -<tr><td valign="top"><a href="#select-1">select/1</a></td><td> Retrives Record from the correct store.</td></tr> -<tr><td valign="top"><a href="#unseen-1">unseen/1</a></td><td>Generates a list of message names that have the \Unseen flag set.</td></tr> -<tr><td valign="top"><a href="#update-1">update/1</a></td><td> Update Record into correct store.</td></tr> -</table> - -<h2><a name="functions">Function Details</a></h2> - -<h3><a name="check-1">check/1</a></h3> -<p><tt>check(Type::<a href="#type-store_type">store_type()</a>) -> ok | undefined | {error, string()}</tt></p> -<p>Performs check command on store of Type. Commits and cleans up any - actions that are not writen to disk on a regualr basis</p> - -<h3><a name="create-1">create/1</a></h3> -<p><tt>create(Type::<a href="#type-store_type">store_type()</a>) -> ok | undefined | {error, string()}</tt></p> -<p>Creates store for Type.</p> - -<h3><a name="delete-1">delete/1</a></h3> -<p><tt>delete(Type::<a href="#type-store_type">store_type()</a>) -> ok | undefined | {error, string()}</tt></p> -<p>Deletes entry in store of Type.</p> - -<h3><a name="deliver-1">deliver/1</a></h3> -<p><tt>deliver(Message::tuple()) -> ok | undefined | {error, string()}</tt></p> -<p>Takes a #message{} record and deilvers it to a users INBOX</p> - -<h3><a name="drop-1">drop/1</a></h3> -<p><tt>drop(Type::<a href="#type-store_type">store_type()</a>) -> ok | undefined | {error, string()}</tt></p> -<p> Creates store for Type.</p> - -<h3><a name="ensure_inbox-1">ensure_inbox/1</a></h3> -<p><tt>ensure_inbox(User::{UserName::string(), DomainName::string()}) -> {ok, create} | {ok, exists} | undefined | {error, string()}</tt></p> -<p> Makes sure that the specified user has an INBOX. Used in deliver command.</p> - -<h3><a name="insert-1">insert/1</a></h3> -<p><tt>insert(Record::tuple()) -> ok | undefined | {error, string()}</tt></p> -<p> Inserts Record into correct store. Records can be of types: - #domain{}, #user{}, #message{} or #mailbox_store{}</p> - -<h3><a name="list-0">list/0</a></h3> -<p><tt>list() -> ok | undefined | {error, string()}</tt></p> -<p> Lists all domains.</p> - -<h3><a name="list-1">list/1</a></h3> -<p><tt>list(Type::any()) -> ok | undefined | {error, string()}</tt></p> -<p> Lists all domains, users, messges or mailboxes depnding on - term that is given</p> - -<h3><a name="message_name-1">message_name/1</a></h3> -<p><tt>message_name(Args::any()) -> string() | undefined | {error, string()}</tt></p> -<p> Generates message name. May use gen_store:message_name/1 or - be specific to the message store.</p> - -<h3><a name="mlist-3">mlist/3</a></h3> -<p><tt>mlist(MailBoxName::string(), X2::{UserName::string(), DomainName::string()}, Subscribed::bool()) -> list()</tt></p> -<p>Lists mailbox information for LIST and LSUB commands</p> - -<h3><a name="recent-1">recent/1</a></h3> -<p><tt>recent(X1::{MailBoxName::string(), UserName::string(), DomainName::string()}) -> list() | {error, Reason}</tt></p> -<p>Generates a list of message names that have the \Recent flag set</p> - -<h3><a name="select-1">select/1</a></h3> -<p><tt>select(Name::any()) -> ok | undefined | {error, string()}</tt></p> -<p> Retrives Record from the correct store.</p> - -<h3><a name="unseen-1">unseen/1</a></h3> -<p><tt>unseen(X1::{MailBoxName::string(), UserName::string(), DomainName::string()}) -> list() | {error, Reason}</tt></p> -<p>Generates a list of message names that have the \Unseen flag set</p> - -<h3><a name="update-1">update/1</a></h3> -<p><tt>update(Record::tuple()) -> ok | undefined | {error, string()}</tt></p> -<p> Update Record into correct store. Records can be of types: - #domain{}, #user{}, #message{} or #mailbox_store{}</p> -</body> -</html> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>Module mysql_store</title> +<link rel="stylesheet" type="text/css" href="stylesheet.css"> +</head> +<body bgcolor="white"> + +<h1>Module mysql_store</h1> + +<ul><li><a href="#types">Data Types</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> + +<h2><a name="types">Data Types</a></h2> + +<h3><a name="type-store_type">store_type()</a></h3> +<p><tt>store_type() = domain | user | message | mailbox_store</tt></p> + + +<h2><a name="index">Function Index</a></h2> +<table width="100%" border="1"><tr><td valign="top"><a href="#check-1">check/1</a></td><td>Performs check command on store of Type.</td></tr> +<tr><td valign="top"><a href="#create-1">create/1</a></td><td>Creates store for Type.</td></tr> +<tr><td valign="top"><a href="#delete-1">delete/1</a></td><td>Deletes entry in store of Type.</td></tr> +<tr><td valign="top"><a href="#deliver-1">deliver/1</a></td><td>Takes a #message{} record and deilvers it to a users INBOX.</td></tr> +<tr><td valign="top"><a href="#drop-1">drop/1</a></td><td> Creates store for Type.</td></tr> +<tr><td valign="top"><a href="#ensure_inbox-1">ensure_inbox/1</a></td><td> Makes sure that the specified user has an INBOX.</td></tr> +<tr><td valign="top"><a href="#insert-1">insert/1</a></td><td> Inserts Record into correct store.</td></tr> +<tr><td valign="top"><a href="#list-0">list/0</a></td><td> Lists all domains.</td></tr> +<tr><td valign="top"><a href="#list-1">list/1</a></td><td> Lists all domains, users, messges or mailboxes depnding on + term that is given.</td></tr> +<tr><td valign="top"><a href="#message_name-1">message_name/1</a></td><td> Generates message name.</td></tr> +<tr><td valign="top"><a href="#mlist-3">mlist/3</a></td><td>Lists mailbox information for LIST and LSUB commands.</td></tr> +<tr><td valign="top"><a href="#recent-1">recent/1</a></td><td>Generates a list of message names that have the \Recent flag set.</td></tr> +<tr><td valign="top"><a href="#select-1">select/1</a></td><td> Retrives Record from the correct store.</td></tr> +<tr><td valign="top"><a href="#unseen-1">unseen/1</a></td><td>Generates a list of message names that have the \Unseen flag set.</td></tr> +<tr><td valign="top"><a href="#update-1">update/1</a></td><td> Update Record into correct store.</td></tr> +</table> + +<h2><a name="functions">Function Details</a></h2> + +<h3><a name="check-1">check/1</a></h3> +<p><tt>check(Type::<a href="#type-store_type">store_type()</a>) -> ok | undefined | {error, string()}</tt></p> +<p>Performs check command on store of Type. Commits and cleans up any + actions that are not writen to disk on a regualr basis</p> + +<h3><a name="create-1">create/1</a></h3> +<p><tt>create(Type::<a href="#type-store_type">store_type()</a>) -> ok | undefined | {error, string()}</tt></p> +<p>Creates store for Type.</p> + +<h3><a name="delete-1">delete/1</a></h3> +<p><tt>delete(Type::<a href="#type-store_type">store_type()</a>) -> ok | undefined | {error, string()}</tt></p> +<p>Deletes entry in store of Type.</p> + +<h3><a name="deliver-1">deliver/1</a></h3> +<p><tt>deliver(Message::tuple()) -> ok | undefined | {error, string()}</tt></p> +<p>Takes a #message{} record and deilvers it to a users INBOX</p> + +<h3><a name="drop-1">drop/1</a></h3> +<p><tt>drop(Type::<a href="#type-store_type">store_type()</a>) -> ok | undefined | {error, string()}</tt></p> +<p> Creates store for Type.</p> + +<h3><a name="ensure_inbox-1">ensure_inbox/1</a></h3> +<p><tt>ensure_inbox(User::{UserName::string(), DomainName::string()}) -> {ok, create} | {ok, exists} | undefined | {error, string()}</tt></p> +<p> Makes sure that the specified user has an INBOX. Used in deliver command.</p> + +<h3><a name="insert-1">insert/1</a></h3> +<p><tt>insert(Record::tuple()) -> ok | undefined | {error, string()}</tt></p> +<p> Inserts Record into correct store. Records can be of types: + #domain{}, #user{}, #message{} or #mailbox_store{}</p> + +<h3><a name="list-0">list/0</a></h3> +<p><tt>list() -> ok | undefined | {error, string()}</tt></p> +<p> Lists all domains.</p> + +<h3><a name="list-1">list/1</a></h3> +<p><tt>list(Type::any()) -> ok | undefined | {error, string()}</tt></p> +<p> Lists all domains, users, messges or mailboxes depnding on + term that is given</p> + +<h3><a name="message_name-1">message_name/1</a></h3> +<p><tt>message_name(Args::any()) -> string() | undefined | {error, string()}</tt></p> +<p> Generates message name. May use gen_store:message_name/1 or + be specific to the message store.</p> + +<h3><a name="mlist-3">mlist/3</a></h3> +<p><tt>mlist(MailBoxName::string(), X2::{UserName::string(), DomainName::string()}, Subscribed::bool()) -> list()</tt></p> +<p>Lists mailbox information for LIST and LSUB commands</p> + +<h3><a name="recent-1">recent/1</a></h3> +<p><tt>recent(X1::{MailBoxName::string(), UserName::string(), DomainName::string()}) -> list() | {error, Reason}</tt></p> +<p>Generates a list of message names that have the \Recent flag set</p> + +<h3><a name="select-1">select/1</a></h3> +<p><tt>select(Name::any()) -> ok | undefined | {error, string()}</tt></p> +<p> Retrives Record from the correct store.</p> + +<h3><a name="unseen-1">unseen/1</a></h3> +<p><tt>unseen(X1::{MailBoxName::string(), UserName::string(), DomainName::string()}) -> list() | {error, Reason}</tt></p> +<p>Generates a list of message names that have the \Unseen flag set</p> + +<h3><a name="update-1">update/1</a></h3> +<p><tt>update(Record::tuple()) -> ok | undefined | {error, string()}</tt></p> +<p> Update Record into correct store. Records can be of types: + #domain{}, #user{}, #message{} or #mailbox_store{}</p> +</body> +</html> doc/mysql_store.html @@ -1,10 +1,10 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<title>The erlmail application</title> -<link rel="stylesheet" type="text/css" href="stylesheet.css"> -</head> -<body bgcolor="white"> -<h1>The erlmail application</h1> -</body> -</html> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>The erlmail application</title> +<link rel="stylesheet" type="text/css" href="stylesheet.css"> +</head> +<body bgcolor="white"> +<h1>The erlmail application</h1> +</body> +</html> doc/overview-summary.html @@ -1,11 +1,11 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<title>The erlmail application</title> -<link rel="stylesheet" type="text/css" href="stylesheet.css"> -</head> -<body bgcolor="white"> -<h2>Packages</h2> -<table width="100%" border="0"/> -</body> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>The erlmail application</title> +<link rel="stylesheet" type="text/css" href="stylesheet.css"> +</head> +<body bgcolor="white"> +<h2>Packages</h2> +<table width="100%" border="0"/> +</body> </html> \ No newline at end of file doc/packages-frame.html @@ -1,98 +1,98 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<title>Module smtpc</title> -<link rel="stylesheet" type="text/css" href="stylesheet.css"> -</head> -<body bgcolor="white"> - -<h1>Module smtpc</h1> - -<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> - -<h2><a name="index">Function Index</a></h2> -<table width="100%" border="1"><tr><td valign="top"><a href="#connect-1">connect/1</a></td><td/></tr> -<tr><td valign="top"><a href="#connect-2">connect/2</a></td><td/></tr> -<tr><td valign="top"><a href="#data-2">data/2</a></td><td/></tr> -<tr><td valign="top"><a href="#ehlo-2">ehlo/2</a></td><td/></tr> -<tr><td valign="top"><a href="#etrn-2">etrn/2</a></td><td/></tr> -<tr><td valign="top"><a href="#expn-2">expn/2</a></td><td/></tr> -<tr><td valign="top"><a href="#helo-2">helo/2</a></td><td/></tr> -<tr><td valign="top"><a href="#help-1">help/1</a></td><td/></tr> -<tr><td valign="top"><a href="#mail-2">mail/2</a></td><td/></tr> -<tr><td valign="top"><a href="#noop-1">noop/1</a></td><td/></tr> -<tr><td valign="top"><a href="#quit-1">quit/1</a></td><td/></tr> -<tr><td valign="top"><a href="#rcpt-2">rcpt/2</a></td><td/></tr> -<tr><td valign="top"><a href="#rset-1">rset/1</a></td><td/></tr> -<tr><td valign="top"><a href="#sendmail-5">sendmail/5</a></td><td/></tr> -<tr><td valign="top"><a href="#sendmail-6">sendmail/6</a></td><td/></tr> -<tr><td valign="top"><a href="#vrfy-2">vrfy/2</a></td><td/></tr> -</table> - -<h2><a name="functions">Function Details</a></h2> - -<h3><a name="connect-1">connect/1</a></h3> -<tt>connect(IPAddress) -> term() -</tt> - -<h3><a name="connect-2">connect/2</a></h3> -<tt>connect(IPAddress, Port) -> term() -</tt> - -<h3><a name="data-2">data/2</a></h3> -<tt>data(Pid, Message) -> term() -</tt> - -<h3><a name="ehlo-2">ehlo/2</a></h3> -<tt>ehlo(Pid, HostName) -> term() -</tt> - -<h3><a name="etrn-2">etrn/2</a></h3> -<tt>etrn(Pid, Queue) -> term() -</tt> - -<h3><a name="expn-2">expn/2</a></h3> -<tt>expn(Pid, Alias) -> term() -</tt> - -<h3><a name="helo-2">helo/2</a></h3> -<tt>helo(Pid, HostName) -> term() -</tt> - -<h3><a name="help-1">help/1</a></h3> -<tt>help(Pid) -> term() -</tt> - -<h3><a name="mail-2">mail/2</a></h3> -<tt>mail(Pid, From) -> term() -</tt> - -<h3><a name="noop-1">noop/1</a></h3> -<tt>noop(Pid) -> term() -</tt> - -<h3><a name="quit-1">quit/1</a></h3> -<tt>quit(Pid) -> term() -</tt> - -<h3><a name="rcpt-2">rcpt/2</a></h3> -<tt>rcpt(Pid, To) -> term() -</tt> - -<h3><a name="rset-1">rset/1</a></h3> -<tt>rset(Pid) -> term() -</tt> - -<h3><a name="sendmail-5">sendmail/5</a></h3> -<tt>sendmail(IPAddress, Host, From, To, Message) -> term() -</tt> - -<h3><a name="sendmail-6">sendmail/6</a></h3> -<tt>sendmail(IPAddress, Port, Host, From, To, Message) -> term() -</tt> - -<h3><a name="vrfy-2">vrfy/2</a></h3> -<tt>vrfy(Pid, Address) -> term() -</tt> -</body> -</html> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>Module smtpc</title> +<link rel="stylesheet" type="text/css" href="stylesheet.css"> +</head> +<body bgcolor="white"> + +<h1>Module smtpc</h1> + +<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> + +<h2><a name="index">Function Index</a></h2> +<table width="100%" border="1"><tr><td valign="top"><a href="#connect-1">connect/1</a></td><td/></tr> +<tr><td valign="top"><a href="#connect-2">connect/2</a></td><td/></tr> +<tr><td valign="top"><a href="#data-2">data/2</a></td><td/></tr> +<tr><td valign="top"><a href="#ehlo-2">ehlo/2</a></td><td/></tr> +<tr><td valign="top"><a href="#etrn-2">etrn/2</a></td><td/></tr> +<tr><td valign="top"><a href="#expn-2">expn/2</a></td><td/></tr> +<tr><td valign="top"><a href="#helo-2">helo/2</a></td><td/></tr> +<tr><td valign="top"><a href="#help-1">help/1</a></td><td/></tr> +<tr><td valign="top"><a href="#mail-2">mail/2</a></td><td/></tr> +<tr><td valign="top"><a href="#noop-1">noop/1</a></td><td/></tr> +<tr><td valign="top"><a href="#quit-1">quit/1</a></td><td/></tr> +<tr><td valign="top"><a href="#rcpt-2">rcpt/2</a></td><td/></tr> +<tr><td valign="top"><a href="#rset-1">rset/1</a></td><td/></tr> +<tr><td valign="top"><a href="#sendmail-5">sendmail/5</a></td><td/></tr> +<tr><td valign="top"><a href="#sendmail-6">sendmail/6</a></td><td/></tr> +<tr><td valign="top"><a href="#vrfy-2">vrfy/2</a></td><td/></tr> +</table> + +<h2><a name="functions">Function Details</a></h2> + +<h3><a name="connect-1">connect/1</a></h3> +<tt>connect(IPAddress) -> term() +</tt> + +<h3><a name="connect-2">connect/2</a></h3> +<tt>connect(IPAddress, Port) -> term() +</tt> + +<h3><a name="data-2">data/2</a></h3> +<tt>data(Pid, Message) -> term() +</tt> + +<h3><a name="ehlo-2">ehlo/2</a></h3> +<tt>ehlo(Pid, HostName) -> term() +</tt> + +<h3><a name="etrn-2">etrn/2</a></h3> +<tt>etrn(Pid, Queue) -> term() +</tt> + +<h3><a name="expn-2">expn/2</a></h3> +<tt>expn(Pid, Alias) -> term() +</tt> + +<h3><a name="helo-2">helo/2</a></h3> +<tt>helo(Pid, HostName) -> term() +</tt> + +<h3><a name="help-1">help/1</a></h3> +<tt>help(Pid) -> term() +</tt> + +<h3><a name="mail-2">mail/2</a></h3> +<tt>mail(Pid, From) -> term() +</tt> + +<h3><a name="noop-1">noop/1</a></h3> +<tt>noop(Pid) -> term() +</tt> + +<h3><a name="quit-1">quit/1</a></h3> +<tt>quit(Pid) -> term() +</tt> + +<h3><a name="rcpt-2">rcpt/2</a></h3> +<tt>rcpt(Pid, To) -> term() +</tt> + +<h3><a name="rset-1">rset/1</a></h3> +<tt>rset(Pid) -> term() +</tt> + +<h3><a name="sendmail-5">sendmail/5</a></h3> +<tt>sendmail(IPAddress, Host, From, To, Message) -> term() +</tt> + +<h3><a name="sendmail-6">sendmail/6</a></h3> +<tt>sendmail(IPAddress, Port, Host, From, To, Message) -> term() +</tt> + +<h3><a name="vrfy-2">vrfy/2</a></h3> +<tt>vrfy(Pid, Address) -> term() +</tt> +</body> +</html> doc/smtpc.html @@ -1,73 +1,73 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<title>Module smtpc_fsm</title> -<link rel="stylesheet" type="text/css" href="stylesheet.css"> -</head> -<body bgcolor="white"> - -<h1>Module smtpc_fsm</h1> - -<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> - -<h2><a name="index">Function Index</a></h2> -<table width="100%" border="1"><tr><td valign="top"><a href="#code_change-4">code_change/4</a></td><td/></tr> -<tr><td valign="top"><a href="#handle_event-3">handle_event/3</a></td><td/></tr> -<tr><td valign="top"><a href="#handle_info-3">handle_info/3</a></td><td/></tr> -<tr><td valign="top"><a href="#handle_sync_event-4">handle_sync_event/4</a></td><td/></tr> -<tr><td valign="top"><a href="#init-1">init/1</a></td><td/></tr> -<tr><td valign="top"><a href="#smtp_cmd-3">smtp_cmd/3</a></td><td/></tr> -<tr><td valign="top"><a href="#start-1">start/1</a></td><td/></tr> -<tr><td valign="top"><a href="#start-2">start/2</a></td><td/></tr> -<tr><td valign="top"><a href="#start_link-1">start_link/1</a></td><td/></tr> -<tr><td valign="top"><a href="#start_link-2">start_link/2</a></td><td/></tr> -<tr><td valign="top"><a href="#terminate-3">terminate/3</a></td><td/></tr> -</table> - -<h2><a name="functions">Function Details</a></h2> - -<h3><a name="code_change-4">code_change/4</a></h3> -<tt>code_change(OldVsn, StateName, StateData, Extra) -> term() -</tt> - -<h3><a name="handle_event-3">handle_event/3</a></h3> -<tt>handle_event(X1, AnyState, State) -> term() -</tt> - -<h3><a name="handle_info-3">handle_info/3</a></h3> -<tt>handle_info(Info, StateName, StateData) -> term() -</tt> - -<h3><a name="handle_sync_event-4">handle_sync_event/4</a></h3> -<tt>handle_sync_event(X1, From, AnyState, State) -> term() -</tt> - -<h3><a name="init-1">init/1</a></h3> -<tt>init(X1) -> term() -</tt> - -<h3><a name="smtp_cmd-3">smtp_cmd/3</a></h3> -<tt>smtp_cmd(X1, From, State) -> term() -</tt> - -<h3><a name="start-1">start/1</a></h3> -<tt>start(Host) -> term() -</tt> - -<h3><a name="start-2">start/2</a></h3> -<tt>start(Host, Port) -> term() -</tt> - -<h3><a name="start_link-1">start_link/1</a></h3> -<tt>start_link(Host) -> term() -</tt> - -<h3><a name="start_link-2">start_link/2</a></h3> -<tt>start_link(Host, Port) -> term() -</tt> - -<h3><a name="terminate-3">terminate/3</a></h3> -<tt>terminate(Reason, StateName, StateData) -> term() -</tt> -</body> -</html> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>Module smtpc_fsm</title> +<link rel="stylesheet" type="text/css" href="stylesheet.css"> +</head> +<body bgcolor="white"> + +<h1>Module smtpc_fsm</h1> + +<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> + +<h2><a name="index">Function Index</a></h2> +<table width="100%" border="1"><tr><td valign="top"><a href="#code_change-4">code_change/4</a></td><td/></tr> +<tr><td valign="top"><a href="#handle_event-3">handle_event/3</a></td><td/></tr> +<tr><td valign="top"><a href="#handle_info-3">handle_info/3</a></td><td/></tr> +<tr><td valign="top"><a href="#handle_sync_event-4">handle_sync_event/4</a></td><td/></tr> +<tr><td valign="top"><a href="#init-1">init/1</a></td><td/></tr> +<tr><td valign="top"><a href="#smtp_cmd-3">smtp_cmd/3</a></td><td/></tr> +<tr><td valign="top"><a href="#start-1">start/1</a></td><td/></tr> +<tr><td valign="top"><a href="#start-2">start/2</a></td><td/></tr> +<tr><td valign="top"><a href="#start_link-1">start_link/1</a></td><td/></tr> +<tr><td valign="top"><a href="#start_link-2">start_link/2</a></td><td/></tr> +<tr><td valign="top"><a href="#terminate-3">terminate/3</a></td><td/></tr> +</table> + +<h2><a name="functions">Function Details</a></h2> + +<h3><a name="code_change-4">code_change/4</a></h3> +<tt>code_change(OldVsn, StateName, StateData, Extra) -> term() +</tt> + +<h3><a name="handle_event-3">handle_event/3</a></h3> +<tt>handle_event(X1, AnyState, State) -> term() +</tt> + +<h3><a name="handle_info-3">handle_info/3</a></h3> +<tt>handle_info(Info, StateName, StateData) -> term() +</tt> + +<h3><a name="handle_sync_event-4">handle_sync_event/4</a></h3> +<tt>handle_sync_event(X1, From, AnyState, State) -> term() +</tt> + +<h3><a name="init-1">init/1</a></h3> +<tt>init(X1) -> term() +</tt> + +<h3><a name="smtp_cmd-3">smtp_cmd/3</a></h3> +<tt>smtp_cmd(X1, From, State) -> term() +</tt> + +<h3><a name="start-1">start/1</a></h3> +<tt>start(Host) -> term() +</tt> + +<h3><a name="start-2">start/2</a></h3> +<tt>start(Host, Port) -> term() +</tt> + +<h3><a name="start_link-1">start_link/1</a></h3> +<tt>start_link(Host) -> term() +</tt> + +<h3><a name="start_link-2">start_link/2</a></h3> +<tt>start_link(Host, Port) -> term() +</tt> + +<h3><a name="terminate-3">terminate/3</a></h3> +<tt>terminate(Reason, StateName, StateData) -> term() +</tt> +</body> +</html> doc/smtpc_fsm.html @@ -1,39 +1,39 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<title>Module smtpd_app</title> -<link rel="stylesheet" type="text/css" href="stylesheet.css"> -</head> -<body bgcolor="white"> - -<h1>Module smtpd_app</h1> - -<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> -<p><b>Behaviours:</b> <a href="application.html"><tt>application</tt></a>.</p> - -<h2><a name="index">Function Index</a></h2> -<table width="100%" border="1"><tr><td valign="top"><a href="#init-1">init/1</a></td><td/></tr> -<tr><td valign="top"><a href="#start-2">start/2</a></td><td/></tr> -<tr><td valign="top"><a href="#start_client-0">start_client/0</a></td><td/></tr> -<tr><td valign="top"><a href="#stop-1">stop/1</a></td><td/></tr> -</table> - -<h2><a name="functions">Function Details</a></h2> - -<h3><a name="init-1">init/1</a></h3> -<tt>init(X1) -> term() -</tt> - -<h3><a name="start-2">start/2</a></h3> -<tt>start(Type, Args) -> term() -</tt> - -<h3><a name="start_client-0">start_client/0</a></h3> -<tt>start_client() -> term() -</tt> - -<h3><a name="stop-1">stop/1</a></h3> -<tt>stop(S) -> term() -</tt> -</body> -</html> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>Module smtpd_app</title> +<link rel="stylesheet" type="text/css" href="stylesheet.css"> +</head> +<body bgcolor="white"> + +<h1>Module smtpd_app</h1> + +<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> +<p><b>Behaviours:</b> <a href="application.html"><tt>application</tt></a>.</p> + +<h2><a name="index">Function Index</a></h2> +<table width="100%" border="1"><tr><td valign="top"><a href="#init-1">init/1</a></td><td/></tr> +<tr><td valign="top"><a href="#start-2">start/2</a></td><td/></tr> +<tr><td valign="top"><a href="#start_client-0">start_client/0</a></td><td/></tr> +<tr><td valign="top"><a href="#stop-1">stop/1</a></td><td/></tr> +</table> + +<h2><a name="functions">Function Details</a></h2> + +<h3><a name="init-1">init/1</a></h3> +<tt>init(X1) -> term() +</tt> + +<h3><a name="start-2">start/2</a></h3> +<tt>start(Type, Args) -> term() +</tt> + +<h3><a name="start_client-0">start_client/0</a></h3> +<tt>start_client() -> term() +</tt> + +<h3><a name="stop-1">stop/1</a></h3> +<tt>stop(S) -> term() +</tt> +</body> +</html> doc/smtpd_app.html @@ -1,43 +1,43 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<title>Module smtpd_cmd</title> -<link rel="stylesheet" type="text/css" href="stylesheet.css"> -</head> -<body bgcolor="white"> - -<h1>Module smtpd_cmd</h1> - -<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> - -<h2><a name="index">Function Index</a></h2> -<table width="100%" border="1"><tr><td valign="top"><a href="#command-2">command/2</a></td><td/></tr> -<tr><td valign="top"><a href="#out-3">out/3</a></td><td/></tr> -<tr><td valign="top"><a href="#send-2">send/2</a></td><td/></tr> -<tr><td valign="top"><a href="#store_message-2">store_message/2</a></td><td/></tr> -<tr><td valign="top"><a href="#store_message-4">store_message/4</a></td><td/></tr> -</table> - -<h2><a name="functions">Function Details</a></h2> - -<h3><a name="command-2">command/2</a></h3> -<tt>command(Line, State) -> term() -</tt> - -<h3><a name="out-3">out/3</a></h3> -<tt>out(Command, Param, State) -> term() -</tt> - -<h3><a name="send-2">send/2</a></h3> -<tt>send(State, Code) -> term() -</tt> - -<h3><a name="store_message-2">store_message/2</a></h3> -<tt>store_message(Message, State) -> term() -</tt> - -<h3><a name="store_message-4">store_message/4</a></h3> -<tt>store_message(MessageName, X2, Message, State) -> term() -</tt> -</body> -</html> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>Module smtpd_cmd</title> +<link rel="stylesheet" type="text/css" href="stylesheet.css"> +</head> +<body bgcolor="white"> + +<h1>Module smtpd_cmd</h1> + +<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> + +<h2><a name="index">Function Index</a></h2> +<table width="100%" border="1"><tr><td valign="top"><a href="#command-2">command/2</a></td><td/></tr> +<tr><td valign="top"><a href="#out-3">out/3</a></td><td/></tr> +<tr><td valign="top"><a href="#send-2">send/2</a></td><td/></tr> +<tr><td valign="top"><a href="#store_message-2">store_message/2</a></td><td/></tr> +<tr><td valign="top"><a href="#store_message-4">store_message/4</a></td><td/></tr> +</table> + +<h2><a name="functions">Function Details</a></h2> + +<h3><a name="command-2">command/2</a></h3> +<tt>command(Line, State) -> term() +</tt> + +<h3><a name="out-3">out/3</a></h3> +<tt>out(Command, Param, State) -> term() +</tt> + +<h3><a name="send-2">send/2</a></h3> +<tt>send(State, Code) -> term() +</tt> + +<h3><a name="store_message-2">store_message/2</a></h3> +<tt>store_message(Message, State) -> term() +</tt> + +<h3><a name="store_message-4">store_message/4</a></h3> +<tt>store_message(MessageName, X2, Message, State) -> term() +</tt> +</body> +</html> doc/smtpd_cmd.html @@ -1,39 +1,39 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<title>Module smtpd_fsm</title> -<link rel="stylesheet" type="text/css" href="stylesheet.css"> -</head> -<body bgcolor="white"> - -<h1>Module smtpd_fsm</h1> - -<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> -<p><b>Behaviours:</b> <a href="gen_fsm.html"><tt>gen_fsm</tt></a>.</p> - -<h2><a name="index">Function Index</a></h2> -<table width="100%" border="1"><tr><td valign="top"><a href="#WAIT_FOR_CMD-2">WAIT_FOR_CMD/2</a></td><td/></tr> -<tr><td valign="top"><a href="#WAIT_FOR_DATA-2">WAIT_FOR_DATA/2</a></td><td/></tr> -<tr><td valign="top"><a href="#set_socket-2">set_socket/2</a></td><td/></tr> -<tr><td valign="top"><a href="#start_link-0">start_link/0</a></td><td/></tr> -</table> - -<h2><a name="functions">Function Details</a></h2> - -<h3><a name="WAIT_FOR_CMD-2">WAIT_FOR_CMD/2</a></h3> -<tt>WAIT_FOR_CMD(Data, Smtpd_fsm) -> term() -</tt> - -<h3><a name="WAIT_FOR_DATA-2">WAIT_FOR_DATA/2</a></h3> -<tt>WAIT_FOR_DATA(Data, Smtpd_fsm) -> term() -</tt> - -<h3><a name="set_socket-2">set_socket/2</a></h3> -<tt>set_socket(Pid, Socket) -> term() -</tt> - -<h3><a name="start_link-0">start_link/0</a></h3> -<tt>start_link() -> term() -</tt> -</body> -</html> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>Module smtpd_fsm</title> +<link rel="stylesheet" type="text/css" href="stylesheet.css"> +</head> +<body bgcolor="white"> + +<h1>Module smtpd_fsm</h1> + +<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> +<p><b>Behaviours:</b> <a href="gen_fsm.html"><tt>gen_fsm</tt></a>.</p> + +<h2><a name="index">Function Index</a></h2> +<table width="100%" border="1"><tr><td valign="top"><a href="#WAIT_FOR_CMD-2">WAIT_FOR_CMD/2</a></td><td/></tr> +<tr><td valign="top"><a href="#WAIT_FOR_DATA-2">WAIT_FOR_DATA/2</a></td><td/></tr> +<tr><td valign="top"><a href="#set_socket-2">set_socket/2</a></td><td/></tr> +<tr><td valign="top"><a href="#start_link-0">start_link/0</a></td><td/></tr> +</table> + +<h2><a name="functions">Function Details</a></h2> + +<h3><a name="WAIT_FOR_CMD-2">WAIT_FOR_CMD/2</a></h3> +<tt>WAIT_FOR_CMD(Data, Smtpd_fsm) -> term() +</tt> + +<h3><a name="WAIT_FOR_DATA-2">WAIT_FOR_DATA/2</a></h3> +<tt>WAIT_FOR_DATA(Data, Smtpd_fsm) -> term() +</tt> + +<h3><a name="set_socket-2">set_socket/2</a></h3> +<tt>set_socket(Pid, Socket) -> term() +</tt> + +<h3><a name="start_link-0">start_link/0</a></h3> +<tt>start_link() -> term() +</tt> +</body> +</html> doc/smtpd_fsm.html @@ -1,30 +1,30 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<title>Module smtpd_listener</title> -<link rel="stylesheet" type="text/css" href="stylesheet.css"> -</head> -<body bgcolor="white"> - -<h1>Module smtpd_listener</h1> - -<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> -<p><b>Behaviours:</b> <a href="gen_server.html"><tt>gen_server</tt></a>.</p> - -<h2><a name="index">Function Index</a></h2> -<table width="100%" border="1"><tr><td valign="top"><a href="#init-1">init/1</a></td><td>Called by gen_server framework at process startup.</td></tr> -<tr><td valign="top"><a href="#start_link-2">start_link/2</a></td><td>Called by a supervisor to start the listening process.</td></tr> -</table> - -<h2><a name="functions">Function Details</a></h2> - -<h3><a name="init-1">init/1</a></h3> -<p><tt>init(Port::integer()) -> {ok, State} | {ok, State, Timeout} | ignore | {stop, Reason}</tt></p> -<p>Called by gen_server framework at process startup. - Create listening socket.</p> - -<h3><a name="start_link-2">start_link/2</a></h3> -<p><tt>start_link(Port::integer(), Module) -> {ok, Pid} | {error, Reason}</tt></p> -<p>Called by a supervisor to start the listening process.</p> -</body> -</html> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<title>Module smtpd_listener</title> +<link rel="stylesheet" type="text/css" href="stylesheet.css"> +</head> +<body bgcolor="white"> + +<h1>Module smtpd_listener</h1> + +<ul><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul> +<p><b>Behaviours:</b> <a href="gen_server.html"><tt>gen_server</tt></a>.</p> + +<h2><a name="index">Function Index</a></h2> +<table width="100%" border="1"><tr><td valign="top"><a href="#init-1">init/1</a></td><td>Called by gen_server framework at process startup.</td></tr> +<tr><td valign="top"><a href="#start_link-2">start_link/2</a></td><td>Called by a supervisor to start the listening process.</td></tr> +</table> + +<h2><a name="functions">Function Details</a></h2> + +<h3><a name="init-1">init/1</a></h3> +<p><tt>init(Port::integer()) -> {ok, State} | {ok, State, Timeout} | ignore | {stop, Reason}</tt></p> +<p>Called by gen_server framework at process startup. + Create listening socket.</p> + +<h3><a name="start_link-2">start_link/2</a></h3> +<p><tt>start_link(Port::integer(), Module) -> {ok, Pid} | {error, Reason}</tt></p> +<p>Called by a supervisor to start the listening process.</p> +</body> +</html> doc/smtpd_listener.html @@ -1,8 +1,8 @@ -body { font-family: Verdana, Arial, Helvetica, sans-serif; - margin-left: .25in; - margin-right: .2in; - margin-top: 0.2in; - margin-bottom: 0.2in; - color: #000000; - background-color: #ffffff } -h1,h2 { margin-left: -0.2in } +body { font-family: Verdana, Arial, Helvetica, sans-serif; + margin-left: .25in; + margin-right: .2in; + margin-top: 0.2in; + margin-bottom: 0.2in; + color: #000000; + background-color: #ffffff } +h1,h2 { margin-left: -0.2in } doc/stylesheet.css @@ -7,6 +7,6 @@ {registered, [imapd_sup, imapd_listner]}, {applications, [kernel, stdlib]}, {mod, {imapd_app, []}}, - {env, []} + {env, [{listen_port, 143}]} ] }. ebin/imapd.app @@ -7,6 +7,6 @@ {registered, [smtpd_sup, smtpd_listner]}, {applications, [kernel, stdlib]}, {mod, {smtpd_app, []}}, - {env, []} + {env, [{listen_port, 25}]} ] }. ebin/smtpd.app ee1179f205fe8a0da4dcadff2e72f0d04afd94f8 simpleenigmainc simpleenigmainc@a0ed728d-bb3d-0410-838c-d777afece975 http://github.com/JackDanger/erlmail/commit/16776bcc50add27c78c3f41483545d7466c05750 16776bcc50add27c78c3f41483545d7466c05750

2007-11-04T09:29:28-08:00

initial work with Makefile git-svn-id: http://erlmail.googlecode.com/svn/trunk@18 a0ed728d-bb3d-0410-838c-d777afece975 c6de772190158126b5fc2df8e199998e029f9373 simpleenigmainc simpleenigmainc@a0ed728d-bb3d-0410-838c-d777afece975