Struct imap::ClientBuilder

pub struct ClientBuilder<D> where
    D: AsRef<str>,  { /* private fields */ }

A convenience builder for Client structs over various encrypted transports.

Creating a Client using native-tls transport is straightforward:

let client = ClientBuilder::new("imap.example.com", 993).native_tls()?;

Similarly, if using the rustls-tls feature you can create a Client using rustls:

let client = ClientBuilder::new("imap.example.com", 993).rustls()?;

To use STARTTLS, just call starttls() before one of the Client-yielding functions:

let client = ClientBuilder::new("imap.example.com", 993)
    .starttls()
    .rustls()?;

The returned Client is unauthenticated; to access session-related methods (through Session), use Client::login or Client::authenticate.

Implementations

impl<D> ClientBuilder<D> where
    D: AsRef<str>, 

pub fn new(domain: D, port: u16) -> Self

Make a new ClientBuilder using the given domain and port.

pub fn starttls(&mut self) -> &mut Self

Use STARTTLS for this connection.

pub fn native_tls(&mut self) -> Result<Client<TlsStream<TcpStream>>>

Return a new Client using a native-tls transport.

pub fn connect<F, C>(&mut self, handshake: F) -> Result<Client<C>> where
    F: FnOnce(&str, TcpStream) -> Result<C>,
    C: Read + Write, 

Make a Client using a custom TLS initialization. This function is intended to be used if your TLS setup requires custom work such as adding private CAs or other specific TLS parameters.

The handshake argument should accept two parameters:

• domain: &str
• tcp: TcpStream

and yield a Result<C> where C is Read + Write. It should only perform TLS initialization over the given tcp socket and return the encrypted stream object, such as a native_tls::TlsStream or a [rustls_connector::TlsStream].

If the caller is using STARTTLS and previously called starttls then the tcp socket given to the handshake function will be connected and will have initiated the STARTTLS handshake.

let client = ClientBuilder::new("imap.example.com", 993)
    .starttls()
    .connect(|domain, tcp| {
        let ssl_conn = RustlsConnector::new_with_native_certs()?;
        Ok(ssl_conn.connect(domain, tcp)?)
    })?;