Add documentation

This commit is contained in:
Alexis Mousset
2015-10-11 21:21:31 +02:00
parent fefb5f7978
commit 51de392086
2 changed files with 5 additions and 3 deletions

View File

@@ -28,11 +28,11 @@ impl Connector for NetworkStream {
}
}
/// TODO
/// Represents the different types of underlying network streams
pub enum NetworkStream {
/// TODO
/// Plain TCP
Plain(TcpStream),
/// TODO
/// SSL over TCP
Ssl(SslStream<TcpStream>),
}

View File

@@ -77,6 +77,8 @@
//! .hello_name("my.hostname.tld")
//! // Add credentials for authentication
//! .credentials("username", "password")
//! // Use smtps, you can also specify a specific SSL context with `.ssl_context(context)`
//! .ssl()
//! // Configure accepted authetication mecanisms
//! .authentication_mecanisms(vec![Mecanism::CramMd5])
//! // Enable connection reuse