1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629
use std::io::BufRead;
use std::io::{BufReader, Write};
use std::net::TcpStream;
use bytes::{Bytes, BytesMut, BufMut};
#[cfg(feature = "with-rustls")]
use {
rustls::StreamOwned,
rustls::{ClientConfig, ClientSession},
std::sync::Arc,
webpki::DNSNameRef,
};
pub type Result<T> = std::result::Result<T, String>;
/// A builder to create a [`Client`] with a connection.
///
/// As it is possible to create the [`Client`] without using `Builder`, we recommend to only use in when you with to define a custom [`ClientConfig`] for the TLS connection.
///
/// [`Client`]: struct.Client
/// [`ClientConfig`]: https://docs.rs/rustls/0.15.2/rustls/struct.ClientConfig.html
pub struct Builder {
#[cfg(feature = "with-rustls")]
config: Arc<ClientConfig>,
}
impl Default for Builder {
#[cfg(not(feature = "with-rustls"))]
fn default() -> Self {
Self {}
}
#[cfg(feature = "with-rustls")]
fn default() -> Self {
let mut config = ClientConfig::new();
config
.root_store
.add_server_trust_anchors(&webpki_roots::TLS_SERVER_ROOTS);
let config = Arc::new(config);
Self { config }
}
}
impl Builder {
/// Vanilla (no-tls) connection to the designated host and port
///
/// # Example
///
/// ```no_run
/// # use std::result::Result;
/// # use pop3_client::Builder;
/// #
/// # fn main() -> Result<(), String> {
/// let client = Builder::default().connect("my.host.com", 110)?;
///
/// # Ok(())
/// # }
/// ```
/// # Errors
/// The errors are defined by [`Client::connect()`] method.
///
/// [`Client::connect()`]: struct.Client.html#method.connect
#[cfg(not(feature = "with-rustls"))]
pub fn connect(&mut self, host: &str, port: u16) -> Result<Client> {
Client::connect_notls(host, port)
}
/// Connect to the designated host and port using TLS
///
/// The usage is pretty much the same as in the no-tls option of connect().
/// # Errors
/// The errors are defined by [`Client::connect()`] method.
///
/// [`Client::connect()`]: struct.Client.html#method.connect
#[cfg(feature = "with-rustls")]
pub fn connect(&mut self, host: &str, port: u16) -> Result<Client> {
Client::connect_rustls(host, port, self.config.clone())
}
/// Define a custom config for the TLS connection
///
/// # Example
/// ```no_run
/// # use std::result::Result;
/// # use pop3_client::Builder;
/// use rustls::ClientConfig;
/// #
/// # fn main() -> Result<(), String> {
///
/// let mut config = ClientConfig::new();
/// config
/// .root_store
/// .add_server_trust_anchors(&webpki_roots::TLS_SERVER_ROOTS);
///
/// let client = Builder::default().rustls_config(config).connect("my.host.com", 995)?;
/// # Ok(())
/// # }
/// ```
#[cfg(feature = "with-rustls")]
pub fn rustls_config(&mut self, config: ClientConfig) -> &mut Self {
self.config = Arc::new(config);
self
}
}
/// The key structure for the crate, delineating capabilities of the POP3 client as per the protocol [RFC]
///
/// # Errors and problems
/// **All** the methods this `Client` has are susceptible to errors. The common reasons for those are:
/// - Not possible to establish connection
/// - The server does not support the protocol
/// - Connection aborted
/// - Some data got lost or modified, and now it's not possible to decode the obtained message
/// - The server does not recognize the command. This might happen even if by [RFC], the command is mandatory, as most of the servers do not follow the protocol letter by letter
/// - The command was sent on the wrong stage. In other words, you tried to do something before you authorized.
/// - The server returned an error response. We'll look at those within each separate method
///
/// To find out more, read the output of the error you've got -- it's always a string!
///
/// [RFC]: https://tools.ietf.org/html/rfc1081
pub struct Client {
#[cfg(feature = "with-rustls")]
client: BufReader<StreamOwned<ClientSession, TcpStream>>,
#[cfg(not(feature = "with-rustls"))]
client: BufReader<TcpStream>,
authorized: bool,
}
impl Client {
/// Connect to given host and port.
///
/// This is the simplest way to initiate connection, so it's preferable to use it in a straightforward manner unless you have specific [`ClientConfig`] reservations.
///
/// # Example
///
/// ```no_run
/// # use std::result::Result;
/// # use pop3_client::Client;
/// #
/// # fn main() -> Result<(), String> {
///let client = Client::connect("my.host.com", 110)?;
///
/// # Ok(())
/// # }
/// ```
///
/// [`ClientConfig`]: https://docs.rs/rustls/0.15.2/rustls/struct.ClientConfig.html
pub fn connect(host: &str, port: u16) -> Result<Self> {
Builder::default().connect(host, port)
}
/// Authorization through plaintext login and password
///
/// # Example
///
/// ```no_run
/// # use std::result::Result;
/// # use pop3_client::Client;
/// #
/// # fn main() -> Result<(), String> {
/// # let mut client = Client::connect("my.host.com", 110)?;
/// client.login("sweet_username", "very_secret_password")?;
/// # Ok(())
/// # }
/// ```
/// # Errors
/// The server may return an error response if:
/// - the username was not found
/// - the password does not match the username
/// - the connection to this mailbox has been locked by another device -- so you won't be able to connect until the lock is released.
pub fn login(&mut self, username: &str, password: &str) -> Result<()> {
if self.authorized {
return Err("login is only allowed in Authorization stage".to_string());
}
let username_query = format!("USER {}\r\n", username);
let password_query = format!("PASS {}\r\n", password);
self.query(&username_query, false)
.and_then(|s1| {
self.query(&password_query, false)
.map(|s2| {
let mut buf = BytesMut::with_capacity(64);
buf.put(&s1[..]);
buf.put(&s2[..]);
buf.freeze()
})
.map(|s| {
self.authorized = true;
s
})
})
.map(|_| ())
}
/// End the session, consuming the client
///
/// # Example
///
/// ```compile_fail
/// # use std::result::Result;
/// #
/// # use pop3_client::Client;
/// # fn main() -> Result<(), String> {
/// # let mut client = Client::connect("my.host.com", 110)?;
///client.quit()?;
///client.noop()?; // Shouldn't compile, as the client has been consumed upon quitting
/// # Ok(())
/// # }
/// ```
pub fn quit(mut self) -> Result<()> {
self.query("QUIT\r\n", false).map(|_| ())
}
/// Display the statistics for the mailbox (that's what the `STAT` command does).
///
/// In the resulting u32 tuple, the first number is the number of messages, and the second one is number of octets in those messages.
///
/// # Example
///
/// ```no_run
/// # use std::result::Result;
/// #
/// # use pop3_client::Client;
/// # fn main() -> Result<(), String> {
/// # let mut client = Client::connect("my.host.com", 110)?;
/// let (messages, octets) = client.stat()?;
/// assert_eq!(messages, 2);
/// assert_eq!(octets, 340);
/// # Ok(())
/// # }
/// ```
pub fn stat(&mut self) -> Result<(u32, u32)> {
match self.query_string("STAT\r\n", false) {
Err(e) => Err(e),
Ok(ref s) => {
let mut s = s
.trim()
.split(' ')
.map(|i| i.parse::<u32>().map_err(|e| e.to_string()));
Ok((
s.next().ok_or("INVALID_REPLY")??,
s.next().ok_or("INVALID_REPLY")??,
))
}
}
}
/// Show the statistical information on a chosen letter, or all letters. The information in question always required to start with the letter size, but use of additional stats is not regimented in any way.
///
///
/// # Example
///
/// ```no_run
/// # use std::result::Result;
/// #
/// # use pop3_client::Client;
/// # fn main() -> Result<(), String> {
/// # let mut client = Client::connect("my.host.com", 110)?;
/// let single_stats = client.list(Some(1))?; // show info on the letter number 1
/// let all_stats = client.list(None)?; // show info on all letters
///
/// # Ok(())
/// # }
/// ```
/// # Errors
/// The server may return an error response if:
/// - The letter under the given index does not exist in the mailbox
/// - The letter under the given index has been marked deleted
pub fn list(&mut self, msg: Option<u32>) -> Result<Bytes> {
let query = if let Some(num) = msg {
format!("LIST {}\r\n", num)
} else {
"LIST\r\n".to_string()
};
self.query(&query, msg.is_none())
}
/// Show the full content of the chosen message
///
///
/// # Example
///
/// ```no_run
/// # use std::result::Result;
/// #
/// # use pop3_client::Client;
/// # fn main() -> Result<(), String> {
/// # let mut client = Client::connect("my.host.com", 110)?;
/// let letter_content = client.retr(5)?;
///
/// # Ok(())
/// # }
/// ```
/// # Errors
/// The server may return an error response if:
/// - The letter under the given index does not exist in the mailbox
/// - The letter under the given index has been marked deleted
pub fn retr(&mut self, msg: u32) -> Result<Bytes> {
let query = format!("RETR {}\r\n", msg);
self.query(&query, true)
.map(|s| {
let tmp = join_bytes(
&s[..]
.split(|&b| b == b'\n')
.skip(1)
.collect::<Vec<&[u8]>>(),
b'\n'
);
Bytes::copy_from_slice(&tmp)
})
}
/// Mark the chosen message as deleted
///
///
/// # Example
///
/// ```no_run
/// # use std::result::Result;
/// #
/// # use pop3_client::Client;
/// # fn main() -> Result<(), String> {
/// # let mut client = Client::connect("my.host.com", 110)?;
/// client.dele(3)?; // now, the THIRD message is marked as deleted, and no new manipulations on it are possible
///
/// # Ok(())
/// # }
/// ```
/// # Errors
/// The server may return an error response if:
/// - The letter under the given index does not exist in the mailbox
/// - The letter under the given index has been marked deleted
pub fn dele(&mut self, msg: u32) -> Result<Bytes> {
let query = format!("DELE {}\r\n", msg);
self.query(&query, false)
}
/// Do nothing and return a positive response
///
/// # Example
///
/// ```no_run
/// # use std::result::Result;
/// #
/// # use pop3_client::Client;
/// # fn main() -> Result<(), String> {
/// # let mut client = Client::connect("my.host.com", 110)?;
/// assert!(client.noop().is_ok());
///
/// # Ok(())
/// # }
/// ```
pub fn noop(&mut self) -> Result<()> {
self.query("NOOP\r\n", false).map(|_| ())
}
/// Reset the session state, unmarking the items marked as deleted
///
///
/// # Example
///
/// ```no_run
/// # use std::result::Result;
/// #
/// # use pop3_client::Client;
/// # fn main() -> Result<(), String> {
/// # let mut client = Client::connect("my.host.com", 110)?;
/// client.dele(3)?;
/// client.dele(4)?;
/// client.rset()?; // undo all the previous deletions
/// # Ok(())
/// # }
/// ```
pub fn rset(&mut self) -> Result<Bytes> {
self.query("RSET\r\n", false)
}
/// Show top n lines of a chosen message
///
///
/// # Example
///
/// ```no_run
/// # use std::result::Result;
/// #
/// # use pop3_client::Client;
/// # fn main() -> Result<(), String> {
/// # let mut client = Client::connect("my.host.com", 110)?;
/// let top = client.top(1, 2)?; // Get TWO first lines of the FIRST message
///
/// # Ok(())
/// # }
/// ```
///
/// # Errors
/// The server may return an error response if:
/// - The letter under the given index does not exist in the mailbox
/// - The letter under the given index has been marked deleted
pub fn top(&mut self, msg: u32, n: u32) -> Result<Bytes> {
let query = format!("TOP {} {}\r\n", msg, n);
self.query(&query, true)
}
/// Show the unique ID listing for the chosen message or for all the messages. Unlike message numbering, this ID does not change between sessions.
///
///
/// # Example
///
/// ```no_run
/// # use std::result::Result;
/// #
/// # use pop3_client::Client;
/// # fn main() -> Result<(), String> {
/// # let mut client = Client::connect("my.host.com", 110)?;
/// let uidl_all = client.uidl(None)?;
/// let uidl_one = client.uidl(Some(1));
///
/// # Ok(())
/// # }
/// ```
///
/// # Errors
/// The server may return an error response if:
/// - The letter under the given index does not exist in the mailbox
/// - The letter under the given index has been marked deleted
pub fn uidl(&mut self, msg: Option<u32>) -> Result<Bytes> {
let query = if let Some(num) = msg {
format!("UIDL {}\r\n", num)
} else {
"UIDL\r\n".to_string()
};
self.query(&query, msg.is_none())
}
/// Authorise using the APOP method
///
/// Refer to the POP3 [RFC] for details.
///
/// # Example
///
/// ```no_run
/// # use std::result::Result;
/// #
/// # use pop3_client::Client;
/// # fn main() -> Result<(), String> {
/// # let mut client = Client::connect("my.host.com", 110)?;
/// client.apop("another_sweet_username", "c4c9334bac560ecc979e58001b3e22fb")?;
///
/// # Ok(())
/// # }
/// ```
/// # Errors
/// The server will return error if permission was denied.
///
/// [RFC]: https://tools.ietf.org/html/rfc1081
pub fn apop(&mut self, name: &str, digest: &str) -> Result<Bytes> {
if self.authorized {
return Err("login is only allowed in Authorization stage".to_string());
}
let query = format!("APOP {} {}\r\n", name, digest);
self.query(&query, false).map(|s| {
self.authorized = true;
s
})
}
#[cfg(not(feature = "with-rustls"))]
fn connect_notls(host: &str, port: u16) -> Result<Self> {
TcpStream::connect((host, port))
.map(|client| Self {
client: BufReader::new(client),
authorized: false,
})
.map_err(|e| format!("{:?}", e))
.and_then(|mut client| client.read_response(false).map(|_| client))
}
#[cfg(feature = "with-rustls")]
fn connect_rustls(host: &str, port: u16, config: Arc<ClientConfig>) -> Result<Self> {
let hostname = DNSNameRef::try_from_ascii_str(host).map_err(|_| "DNS_NAMEREF_FAILED")?;
let session = ClientSession::new(&config, hostname);
let socket = TcpStream::connect((host, port))
.map(BufReader::new)
.map_err(|e| format!("{:?}", e))
.and_then(|mut client| {
let mut buf = String::new();
client
.read_line(&mut buf)
.map_err(|e| e.to_string())
.and_then(|_| {
if buf.starts_with("+OK") {
Ok(buf[4..].to_owned())
} else {
Err(buf[5..].to_owned())
}
})
.map(|_| client)
})
.and_then(|mut client| {
client
.get_mut()
.write_all("STLS\r\n".as_bytes())
.map_err(|e| e.to_string())
.and_then(|_| {
let mut buf = String::new();
client
.read_line(&mut buf)
.map_err(|e| e.to_string())
.and_then(|_| {
println!("STLS: {}", &buf);
if buf.starts_with("+OK") {
Ok(buf[4..].to_owned())
} else {
Err(buf[5..].to_owned())
}
})
})
.map(|_| client.into_inner())
})?;
let tls_stream = StreamOwned::new(session, socket);
Ok(Self {
client: BufReader::new(tls_stream),
authorized: false,
})
}
fn read_response(&mut self, multiline: bool) -> Result<Bytes> {
let mut response = BytesMut::new();
let mut buffer = vec![];
self.client
.read_until(b'\n', &mut buffer)
.map_err(|e| e.to_string())
.and_then(|x| {
if x == 0 {
Err("Connection aborted".to_string())
} else {
Ok(x)
}
})
.and_then(|_| {
if buffer.starts_with(b"+OK") {
Ok(Bytes::copy_from_slice(&buffer[4..]))
} else {
Err(std::str::from_utf8(
if buffer.len() < 6 {
&buffer
} else {
&buffer[5..]
})
.unwrap_or_else(|_| "Error is not valid utf-8")
.to_string()
)
}
})
.and_then(|s| {
if multiline {
response.put(&s[..]);
while !buffer.ends_with(b".\r\n") {
buffer.clear();
let read = self
.client
.read_until(b'\n', &mut buffer)
.map_err(|e| e.to_string())
.and_then(|x| {
if x == 0 {
Err("Connection aborted".to_string())
} else {
Ok(x)
}
})
.map(|_| Bytes::new());
if read.is_err() {
return read;
}
response.put(
&buffer[..buffer.len() - if buffer.ends_with(b".\r\n") { 3 } else { 0 }],
);
}
Ok(response.freeze())
} else {
Ok(s)
}
})
}
fn query(&mut self, query: &str, multiline: bool) -> Result<Bytes> {
self.client
.get_mut()
.write_all(query.as_bytes())
.map_err(|e| e.to_string())
.and_then(|_| self.read_response(multiline))
}
fn query_string(&mut self, query: &str, multiline: bool) -> Result<String> {
let reply = self.query(query, multiline)?;
std::str::from_utf8(&reply[..])
.map(|s| s.to_string())
.map_err(|_| String::from("Error is not valid utf-8"))
}
}
fn join_bytes(arrays: &[&[u8]], separator: u8) -> Vec<u8> {
let cap: usize = arrays.iter().map(|a| a.len()).sum();
let mut result = Vec::with_capacity(cap + arrays.len() - 1);
for (i, array) in arrays.iter().enumerate() {
result.extend_from_slice(array);
if i < arrays.len() - 1 {
result.push(separator);
}
}
result
}