Pop3mail.EpopDownloader.Options (pop3mail v1.5.2)

View Source

A struct that holds pop3mail parameter options.

It's fields are:

  • cacertfile - full filename of the CA certifications file. nil = OS CA Certificates.
  • delete - delete email after downloading. Default: false.
  • delivered - true/false/nil. Skip emails with/without/never a 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.
  • verify - true/false. verify certificate of the mailserver.

Summary

Types

t()

Types

t()

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