docs: Use example.com in documentation

Closes #96

docs/meli.1

@@ -171,7 +171,7 @@ To search in specific fields, prepend your search keyword with "field:" like so:
 .Pp
 .D1 not ((from:unrealistic and (to:complex or not "query")) or flags:seen,draft)
 .Pp
-.D1 alladdresses:mailing@list.tld and cc:me@domain.tld
+.D1 alladdresses:mailing@example.com and cc:me@example.com
 .Pp
 Boolean operators are
 .Em or Ns

docs/meli.conf.5

@@ -78,7 +78,7 @@ example configuration
 root_mailbox = "/path/to/root/folder"
 format = "Maildir"
 index_style = "Compact"
-identity="email@address.tld"
+identity="email@example.com"
 subscribed_mailboxes = ["folder", "folder/Sent"] # or [ "*", ] for all mailboxes
 display_name = "Name"
 
@@ -107,7 +107,7 @@ script = "notify-send"
 [composing]
 # required for sending e-mail
 send_mail = 'msmtp --read-recipients --read-envelope-from'
-#send_mail = { hostname = "smtp.mail.tld", port = 587, auth = { type = "auto", username = "user", password = { type = "command_eval", value = "gpg2 --no-tty -q -d ~/.passwords/user.gpg" } }, security = { type = "STARTTLS" } }
+#send_mail = { hostname = "smtp.example.com", port = 587, auth = { type = "auto", username = "user", password = { type = "command_eval", value = "gpg2 --no-tty -q -d ~/.passwords/user.gpg" } }, security = { type = "STARTTLS" } }
 editor_command = 'vim +/^$'
 
 [shortcuts]
@@ -152,7 +152,7 @@ plain:shows one row per mail, regardless of threading
 .Bl -tag -width 36n
 .It Ic display_name Ar String
 .Pq Em optional
-A name which can be combined with your address: "Name <email@address.tld>".
+A name which can be combined with your address: "Name <email@example.com>".
 .It Ic read_only Ar boolean
 Attempt to not make any changes to this account.
 .Pq Em false
@@ -199,14 +199,14 @@ format = "notmuch"
   [accounts.notmuch.mailboxes]
   "INBOX" = {  query="tag:inbox", subscribe = true }
   "Drafts" = {  query="tag:draft", subscribe = true }
-  "Sent" = {  query="from:username@server.tld from:username2@server.tld", subscribe = true }
+  "Sent" = {  query="from:username@example.com from:username2@example.com", subscribe = true }
 .Ed
 .Ss IMAP only
 IMAP specific options are:
 .Bl -tag -width 36n
 .It Ic server_hostname Ar String
 example:
-.Qq mail.example.tld
+.Qq mail.example.com
 .It Ic server_username Ar String
 Server username
 .It Ic server_password Ar String
@@ -295,7 +295,7 @@ JMAP specific options
 .Bl -tag -width 36n
 .It Ic server_hostname Ar String
 example:
-.Qq mail.example.tld
+.Qq mail.example.com
 .It Ic server_username Ar String
 Server username
 .It Ic server_password Ar String
@@ -403,9 +403,9 @@ and
 \&.
 Example:
 .Bd -literal
-[accounts."imap.domain.tld".mailboxes."INBOX"]
+[accounts."imap.example.com".mailboxes."INBOX"]
   index_style = "plain"
-  [accounts."imap.domain.tld".mailboxes."INBOX".pager]
+  [accounts."imap.example.com".mailboxes."INBOX".pager]
     filter = ""
 .Ed
 .El

docs/samples/sample-config.toml

@@ -12,7 +12,7 @@
 #root_mailbox = "/path/to/root/mailbox"
 #format = "Maildir"
 #index_style = "Conversations" # or [plain, threaded, compact]
-#identity="email@address.tld"
+#identity="email@example.com"
 #display_name = "Name"
 #subscribed_mailboxes = ["INBOX", "INBOX/Sent", "INBOX/Drafts", "INBOX/Junk"]
 #
@@ -33,14 +33,14 @@
 #[accounts."imap"]
 #root_mailbox = "INBOX"
 #format = "imap"
-#server_hostname="mail.server.tld"
+#server_hostname="mail.example.com"
 #server_password="pha2hiLohs2eeeish2phaii1We3ood4chakaiv0hien2ahie3m"
-#server_username="username@server.tld"
+#server_username="username@example.com"
 #server_port="993" # imaps
 #server_port="143" # STARTTLS
 #use_starttls=true #optional
 #index_style = "Conversations"
-#identity = "username@server.tld"
+#identity = "username@example.com"
 #display_name = "Name Name"
 ### match every mailbox:
 #subscribed_mailboxes = ["*" ]
@@ -52,13 +52,13 @@
 #root_mailbox = "/path/to/folder" # where .notmuch/ directory is located
 #format = "notmuch"
 #index_style = "conversations"
-#identity="username@server.tld"
+#identity="username@example.com"
 #display_name = "Name Name"
 #  # notmuch mailboxes are virtual, they are defined by their alias and the notmuch query that corresponds to their content.
 #  [accounts.notmuch.mailboxes]
 #  "INBOX" = {  query="tag:inbox", subscribe = true }
 #  "Drafts" = {  query="tag:draft", subscribe = true }
-#  "Sent" = {  query="from:username@server.tld from:username2@server.tld", subscribe = true }
+#  "Sent" = {  query="from:username@example.com from:username2@example.com", subscribe = true }
 #
 ## Setting up a Gmail account
 #[accounts."gmail"]
@@ -69,7 +69,7 @@
 #server_username="username@gmail.com"
 #server_port="993"
 #index_style = "Conversations"
-#identity = "username@server.tld"
+#identity = "username@gmail.com"
 #display_name = "Name Name"
 ### match every mailbox:
 #subscribed_mailboxes = ["*" ]
@@ -123,7 +123,7 @@
 #[composing]
 ##required for sending e-mail
 #send_mail = 'msmtp --read-recipients --read-envelope-from'
-##send_mail = { hostname = "smtp.mail.tld", port = 587, auth = { type = "auto", username = "user", password = { type = "command_eval", value = "gpg2 --no-tty -q -d ~/.passwords/user.gpg" } }, security = { type = "STARTTLS" } }
+##send_mail = { hostname = "smtp.example.com", port = 587, auth = { type = "auto", username = "user", password = { type = "command_eval", value = "gpg2 --no-tty -q -d ~/.passwords/user.gpg" } }, security = { type = "STARTTLS" } }
 #editor_command = 'vim +/^$' # optional, by default $EDITOR is used.
 #
 #

melib/README.md

@@ -29,11 +29,11 @@ and body structure. Addresses in `To`, `From` fields etc are parsed into
 ```rust
 use melib::{Attachment, Envelope};
 
-let raw_mail = r#"From: "some name" <some@address.com>
-To: "me" <myself@i.tld>
+let raw_mail = r#"From: "some name" <some@example.com>
+To: "me" <myself@example.com>
 Cc:
 Subject: =?utf-8?Q?gratuitously_encoded_subject?=
-Message-ID: <h2g7f.z0gy2pgaen5m@address.com>
+Message-ID: <h2g7f.z0gy2pgaen5m@example.com>
 MIME-Version: 1.0
 Content-Type: multipart/mixed; charset="utf-8";
  boundary="bzz_bzz__bzz__"
@@ -74,7 +74,7 @@ ouiijDaaCCGQRgrpH3q4QYYXWDihxBE+7KCDDjnUIEVAADs=
 
 let envelope = Envelope::from_bytes(raw_mail.as_bytes(), None).expect("Could not parse mail");
 assert_eq!(envelope.subject().as_ref(), "gratuitously encoded subject");
-assert_eq!(envelope.message_id_display().as_ref(), "<h2g7f.z0gy2pgaen5m@address.com>");
+assert_eq!(envelope.message_id_display().as_ref(), "<h2g7f.z0gy2pgaen5m@example.com>");
 
 let body = envelope.body_bytes(raw_mail.as_bytes());
 assert_eq!(body.content_type().to_string().as_str(), "multipart/mixed");

melib/src/email.rs

@@ -30,11 +30,11 @@
  * ```
  * use melib::{Attachment, Envelope};
  *
- * let raw_mail = r#"From: "some name" <some@address.com>
- * To: "me" <myself@i.tld>
+ * let raw_mail = r#"From: "some name" <some@example.com>
+ * To: "me" <myself@example.com>
  * Cc:
  * Subject: =?utf-8?Q?gratuitously_encoded_subject?=
- * Message-ID: <h2g7f.z0gy2pgaen5m@address.com>
+ * Message-ID: <h2g7f.z0gy2pgaen5m@example.com>
  * MIME-Version: 1.0
  * Content-Type: multipart/mixed; charset="utf-8";
  *  boundary="bzz_bzz__bzz__"
@@ -75,7 +75,7 @@
  *
  * let envelope = Envelope::from_bytes(raw_mail.as_bytes(), None).expect("Could not parse mail");
  * assert_eq!(envelope.subject().as_ref(), "gratuitously encoded subject");
- * assert_eq!(envelope.message_id_display().as_ref(), "<h2g7f.z0gy2pgaen5m@address.com>");
+ * assert_eq!(envelope.message_id_display().as_ref(), "<h2g7f.z0gy2pgaen5m@example.com>");
  *
  * let body = envelope.body_bytes(raw_mail.as_bytes());
  * assert_eq!(body.content_type().to_string().as_str(), "multipart/mixed");

tools/README.md

@@ -8,7 +8,7 @@ This crate holds a collection of small binaries used for meli development. Of no
 cd tools/
 cargo build --bin imapshell
 # Usage: imap_conn server_hostname server_username server_password server_port
-rlwrap ./target/debug/imapshell "mail.domain.tld" "epilys@domain.tld" "hunter2" 143
+rlwrap ./target/debug/imapshell "mail.example.com" "epilys@example.com" "hunter2" 143
 ```
 
 Example session:
@@ -18,7 +18,7 @@ First, the IMAP connections performs its own non-interactive setup:
 ```text
 [2020-08-27 17:11:33]["main"] melib/src/backends/imap/connection.rs:459_25: sent: M1 CAPABILITY
 [2020-08-27 17:11:33]["main"] melib/src/backends/imap/connection.rs:408_33: &ret[last_line_idx..] = "M1 OK Pre-login capabilities listed, post-login capabilities have more.\r\n"
-[2020-08-27 17:11:33]["main"] melib/src/backends/imap/connection.rs:459_25: sent: M2 LOGIN "epilys@domain.tld" "hunter2"
+[2020-08-27 17:11:33]["main"] melib/src/backends/imap/connection.rs:459_25: sent: M2 LOGIN "epilys@example.com" "hunter2"
 [2020-08-27 17:11:34]["main"] melib/src/backends/imap/connection.rs:459_25: sent: M3 CAPABILITY
 [2020-08-27 17:11:34]["main"] melib/src/backends/imap/connection.rs:408_33: &ret[last_line_idx..] = "M3 OK Capability completed (0.000 + 0.120 + 0.119 secs).\r\n"
 [2020-08-27 17:11:34]["main"] melib/src/backends/imap/connection.rs:459_25: sent: M4 ENABLE CONDSTORE