View Source Pop3mail.EpopDownloader.Options (pop3mail v1.4.0)

A struct that holds pop3mail parameter options.

It's fields are:

  • delete - delete email after downloading. Default: false.
  • delivered - true/false/nil. Skip emails with/without/whatever Delivered-To header.
  • max_mails - maximum number of emails to download. nil = unlimited
  • output_dir - output directory.
  • password - email account password.
  • port - pop3 server port.
  • save_raw - also save the unprocessed mail in a file called 'raw.eml'.
  • server - pop3 server address.
  • ssl - true/false. Turn on/off Secure Socket Layer.
  • username - email account name.

Summary

Types

@type t() :: %Pop3mail.EpopDownloader.Options{
  delete: boolean(),
  delivered: boolean(),
  max_mails: integer(),
  output_dir: String.t(),
  password: String.t(),
  port: integer(),
  save_raw: boolean(),
  server: String.t(),
  ssl: boolean(),
  username: String.t()
}