myl-discovery 0.5.3__tar.gz → 0.5.4__tar.gz

myl-discovery-0.5.3/README.md → myl-discovery-0.5.4/HACKING.md

@@ -1,23 +1,3 @@
-# myl-discovery
-
-Email autoconfig library
-
-## Installation
-
-```shell
-pip install myl-discovery
-```
-
-## Usage
-
-```python
-from myldiscovery import autodiscover
-autodiscover("me@example.com")
-# {'imap': {'server': 'mail.example.com', 'port': 993, 'starttls': False},
-#  'smtp': {'server': 'mail.example.com', 'port': 587, 'starttls': False}}
-```
-
-
 ## Development
 
 ### Autodiscovery

{myl-discovery-0.5.3 → myl-discovery-0.5.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: myl-discovery
-Version: 0.5.3
+Version: 0.5.4
 Summary: email autodiscovery
 Author-email: Philipp Schmitt <philipp@schmitt.co>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -684,130 +684,92 @@ Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 
-# myl-discovery
+# 📩 myl-discovery
 
-Email autoconfig library
+myl-discovery is a Python library designed to detect email settings of a given 
+email address or domain.
 
-## Installation
+## 📥 Installation
 
-```shell
+To install myl-discovery, run the following command:
+
+```bash
 pip install myl-discovery
 ```
 
-## Usage
+## 📖 Usage
+
+After installing the package, you can use the `autodiscover` function to 
+discover the email settings for a domain. Here's an example:
 
 ```python
 from myldiscovery import autodiscover
-autodiscover("me@example.com")
-# {'imap': {'server': 'mail.example.com', 'port': 993, 'starttls': False},
-#  'smtp': {'server': 'mail.example.com', 'port': 587, 'starttls': False}}
-```
-
 
-## Development
+settings = autodiscover("yourdomain.com")  # or me@yourdomain.com
+print(settings)
 
-### Autodiscovery
-
-#### autoconfig
-
-```shell
-curl -L https://mail.example.com/mail/config-v1.1.xml
+# For Exchange autodiscovery you need to provide credentials
+settings = autodiscover(
+    'me@yourdomain.com', 
+    username='WORKGROUP\me', 
+    password='mypassword1234'
+)
 ```
 
-Response:
-
-```xml
-<?xml version="1.0" encoding="UTF-8"?>
-<clientConfig version="1.1">
-	<emailProvider id="example.com">
-	    <domain>example.com</domain>
+## 📄 Output
 
-	    <displayName>example.com Email</displayName>
-	    <displayShortName>%EMAILLOCALPART%</displayShortName>
-	    <incomingServer type="imap">
-			<hostname>mail.example.com</hostname>
-			<port>143</port>
-			<socketType>STARTTLS</socketType>
-			<authentication>password-cleartext</authentication>
-			<username>%EMAILADDRESS%</username>
-		</incomingServer>
-	    <outgoingServer type="smtp">
-			<hostname>mail.example.com</hostname>
-			<port>587</port>
-			<socketType>STARTTLS</socketType>
-			<authentication>password-cleartext</authentication>
-			<username>%EMAILADDRESS%</username>
-	    </outgoingServer>
-		<documentation url="https://autodiscover.example.com">
-			<descr lang="en">Generic settings page</descr>
-			<descr lang="fr">Paramètres généraux</descr>
-			<descr lang="es">Configuraciones genéricas</descr>
-			<descr lang="de">Allgemeine Beschreibung der Einstellungen</descr>
-			<descr lang="ru">Страница общих настроек</descr>
-		</documentation>
-	</emailProvider>
-</clientConfig>
-```
+The `autodiscover` function returns a dictionary with the detected settings. 
+The dictionary contains two keys, `imap` and `smtp`, each containing a 
+dictionary with the keys `server`, `port`, and `starttls`. 
 
-### autodiscover
+Here's an example:
 
-```shell
-curl -L mail.example.com/autodiscover/autodiscover.xml
+```json
+{
+  "imap": {
+    "server": "imap.yourdomain.com",
+    "port": 993,
+    "starttls": false
+  },
+  "smtp": {
+    "server": "smtp.yourdomain.com",
+    "port": 587,
+    "starttls": true
+  }
+}
 ```
 
-Response:
-
-```xml
-<?xml version="1.0" encoding="utf-8" ?>
-<Autodiscover xmlns="http://schemas.microsoft.com/exchange/autodiscover/responseschema/2006">
-        <Response xmlns="http://schemas.microsoft.com/exchange/autodiscover/responseschema/2006">
-                <User>
-                        <DisplayName>example.com Email</DisplayName>
-                </User>
-                <Account>
-                        <AccountType>email</AccountType>
-                        <Action>settings</Action>
-                        <ServiceHome>https://autodiscover.example.com</ServiceHome>
-
-                        <Protocol>
-                                <Type>IMAP</Type>
-                                <TTL>1</TTL>
-
-                                <Server>mail.example.com</Server>
-                                <Port>143</Port>
+## 🧩 Autodiscover Functions
 
-                                <LoginName></LoginName>
+myl-discovery exposes several functions to discover email settings:
 
-                                <DomainRequired>on</DomainRequired>
-                                <DomainName>example.com</DomainName>
+- `autodiscover`: This function wraps the below function do automatically detect
+the right settings. (See Autodiscover strategy for more information)
+- `autodiscover_srv`: This function attempts to resolve SRV records for 
+the domain to discover IMAP and SMTP servers.
+- `autodiscover_exchange`: This function attempts to use the Exchange 
+Autodiscover service to discover email settings. It requires a username and 
+password.
+- `autodiscover_autoconfig`: This function attempts to fetch and parse an 
+autoconfig XML file from a URL specified in the domain's TXT records.
+- `autodiscover_port_scan`: This function performs a port scan on the domain 
+to discover open IMAP and SMTP ports.
 
-                                <SPA>off</SPA>
-                                <Encryption>TLS</Encryption>
-                                <AuthRequired>on</AuthRequired>
-                        </Protocol>
-                </Account>
-                <Account>
-                        <AccountType>email</AccountType>
-                        <Action>settings</Action>
-                        <ServiceHome>https://autodiscover.example.com</ServiceHome>
+## 🧠 Autodiscover Strategy
 
-                        <Protocol>
-                                <Type>SMTP</Type>
-                                <TTL>1</TTL>
+The `autodiscover` function uses the following strategy to discover 
+email settings:
 
-                                <Server>mail.example.com</Server>
-                                <Port>587</Port>
+1. It first attempts to use `autodiscover_autoconfig` to discover settings 
+from an autoconfig/autodiscover URL specified in the domain's TXT records.
+2. If that fails, it attempts to use `autodiscover_srv` to discover settings 
+from the domain's SRV records.
+3. If that fails and a password is provided, it attempts to use 
+`autodiscover_exchange` to discover settings using the 
+Exchange Autodiscover service (only if credentials were provided)
+4. If all else fails, it uses `autodiscover_port_scan` to discover settings by 
+performing a port scan on the domain.
 
-                                <LoginName></LoginName>
-
-                                <DomainRequired>on</DomainRequired>
-                                <DomainName>example.com</DomainName>
-
-                                <SPA>off</SPA>
-                                <Encryption>TLS</Encryption>
-                                <AuthRequired>on</AuthRequired>
-                        </Protocol>
-                </Account></Response>
-</Autodiscover>
-```
+## 📜 License
 
+myl-discovery is licensed under the [GNU General Public License v3.0](LICENSE).

myl-discovery-0.5.4/README.md

@@ -0,0 +1,89 @@
+# 📩 myl-discovery
+
+myl-discovery is a Python library designed to detect email settings of a given 
+email address or domain.
+
+## 📥 Installation
+
+To install myl-discovery, run the following command:
+
+```bash
+pip install myl-discovery
+```
+
+## 📖 Usage
+
+After installing the package, you can use the `autodiscover` function to 
+discover the email settings for a domain. Here's an example:
+
+```python
+from myldiscovery import autodiscover
+
+settings = autodiscover("yourdomain.com")  # or me@yourdomain.com
+print(settings)
+
+# For Exchange autodiscovery you need to provide credentials
+settings = autodiscover(
+    'me@yourdomain.com', 
+    username='WORKGROUP\me', 
+    password='mypassword1234'
+)
+```
+
+## 📄 Output
+
+The `autodiscover` function returns a dictionary with the detected settings. 
+The dictionary contains two keys, `imap` and `smtp`, each containing a 
+dictionary with the keys `server`, `port`, and `starttls`. 
+
+Here's an example:
+
+```json
+{
+  "imap": {
+    "server": "imap.yourdomain.com",
+    "port": 993,
+    "starttls": false
+  },
+  "smtp": {
+    "server": "smtp.yourdomain.com",
+    "port": 587,
+    "starttls": true
+  }
+}
+```
+
+## 🧩 Autodiscover Functions
+
+myl-discovery exposes several functions to discover email settings:
+
+- `autodiscover`: This function wraps the below function do automatically detect
+the right settings. (See Autodiscover strategy for more information)
+- `autodiscover_srv`: This function attempts to resolve SRV records for 
+the domain to discover IMAP and SMTP servers.
+- `autodiscover_exchange`: This function attempts to use the Exchange 
+Autodiscover service to discover email settings. It requires a username and 
+password.
+- `autodiscover_autoconfig`: This function attempts to fetch and parse an 
+autoconfig XML file from a URL specified in the domain's TXT records.
+- `autodiscover_port_scan`: This function performs a port scan on the domain 
+to discover open IMAP and SMTP ports.
+
+## 🧠 Autodiscover Strategy
+
+The `autodiscover` function uses the following strategy to discover 
+email settings:
+
+1. It first attempts to use `autodiscover_autoconfig` to discover settings 
+from an autoconfig/autodiscover URL specified in the domain's TXT records.
+2. If that fails, it attempts to use `autodiscover_srv` to discover settings 
+from the domain's SRV records.
+3. If that fails and a password is provided, it attempts to use 
+`autodiscover_exchange` to discover settings using the 
+Exchange Autodiscover service (only if credentials were provided)
+4. If all else fails, it uses `autodiscover_port_scan` to discover settings by 
+performing a port scan on the domain.
+
+## 📜 License
+
+myl-discovery is licensed under the [GNU General Public License v3.0](LICENSE).

{myl-discovery-0.5.3 → myl-discovery-0.5.4}/myl_discovery.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: myl-discovery
-Version: 0.5.3
+Version: 0.5.4
 Summary: email autodiscovery
 Author-email: Philipp Schmitt <philipp@schmitt.co>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -684,130 +684,92 @@ Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 
-# myl-discovery
+# 📩 myl-discovery
 
-Email autoconfig library
+myl-discovery is a Python library designed to detect email settings of a given 
+email address or domain.
 
-## Installation
+## 📥 Installation
 
-```shell
+To install myl-discovery, run the following command:
+
+```bash
 pip install myl-discovery
 ```
 
-## Usage
+## 📖 Usage
+
+After installing the package, you can use the `autodiscover` function to 
+discover the email settings for a domain. Here's an example:
 
 ```python
 from myldiscovery import autodiscover
-autodiscover("me@example.com")
-# {'imap': {'server': 'mail.example.com', 'port': 993, 'starttls': False},
-#  'smtp': {'server': 'mail.example.com', 'port': 587, 'starttls': False}}
-```
-
 
-## Development
+settings = autodiscover("yourdomain.com")  # or me@yourdomain.com
+print(settings)
 
-### Autodiscovery
-
-#### autoconfig
-
-```shell
-curl -L https://mail.example.com/mail/config-v1.1.xml
+# For Exchange autodiscovery you need to provide credentials
+settings = autodiscover(
+    'me@yourdomain.com', 
+    username='WORKGROUP\me', 
+    password='mypassword1234'
+)
 ```
 
-Response:
-
-```xml
-<?xml version="1.0" encoding="UTF-8"?>
-<clientConfig version="1.1">
-	<emailProvider id="example.com">
-	    <domain>example.com</domain>
+## 📄 Output
 
-	    <displayName>example.com Email</displayName>
-	    <displayShortName>%EMAILLOCALPART%</displayShortName>
-	    <incomingServer type="imap">
-			<hostname>mail.example.com</hostname>
-			<port>143</port>
-			<socketType>STARTTLS</socketType>
-			<authentication>password-cleartext</authentication>
-			<username>%EMAILADDRESS%</username>
-		</incomingServer>
-	    <outgoingServer type="smtp">
-			<hostname>mail.example.com</hostname>
-			<port>587</port>
-			<socketType>STARTTLS</socketType>
-			<authentication>password-cleartext</authentication>
-			<username>%EMAILADDRESS%</username>
-	    </outgoingServer>
-		<documentation url="https://autodiscover.example.com">
-			<descr lang="en">Generic settings page</descr>
-			<descr lang="fr">Paramètres généraux</descr>
-			<descr lang="es">Configuraciones genéricas</descr>
-			<descr lang="de">Allgemeine Beschreibung der Einstellungen</descr>
-			<descr lang="ru">Страница общих настроек</descr>
-		</documentation>
-	</emailProvider>
-</clientConfig>
-```
+The `autodiscover` function returns a dictionary with the detected settings. 
+The dictionary contains two keys, `imap` and `smtp`, each containing a 
+dictionary with the keys `server`, `port`, and `starttls`. 
 
-### autodiscover
+Here's an example:
 
-```shell
-curl -L mail.example.com/autodiscover/autodiscover.xml
+```json
+{
+  "imap": {
+    "server": "imap.yourdomain.com",
+    "port": 993,
+    "starttls": false
+  },
+  "smtp": {
+    "server": "smtp.yourdomain.com",
+    "port": 587,
+    "starttls": true
+  }
+}
 ```
 
-Response:
-
-```xml
-<?xml version="1.0" encoding="utf-8" ?>
-<Autodiscover xmlns="http://schemas.microsoft.com/exchange/autodiscover/responseschema/2006">
-        <Response xmlns="http://schemas.microsoft.com/exchange/autodiscover/responseschema/2006">
-                <User>
-                        <DisplayName>example.com Email</DisplayName>
-                </User>
-                <Account>
-                        <AccountType>email</AccountType>
-                        <Action>settings</Action>
-                        <ServiceHome>https://autodiscover.example.com</ServiceHome>
-
-                        <Protocol>
-                                <Type>IMAP</Type>
-                                <TTL>1</TTL>
-
-                                <Server>mail.example.com</Server>
-                                <Port>143</Port>
+## 🧩 Autodiscover Functions
 
-                                <LoginName></LoginName>
+myl-discovery exposes several functions to discover email settings:
 
-                                <DomainRequired>on</DomainRequired>
-                                <DomainName>example.com</DomainName>
+- `autodiscover`: This function wraps the below function do automatically detect
+the right settings. (See Autodiscover strategy for more information)
+- `autodiscover_srv`: This function attempts to resolve SRV records for 
+the domain to discover IMAP and SMTP servers.
+- `autodiscover_exchange`: This function attempts to use the Exchange 
+Autodiscover service to discover email settings. It requires a username and 
+password.
+- `autodiscover_autoconfig`: This function attempts to fetch and parse an 
+autoconfig XML file from a URL specified in the domain's TXT records.
+- `autodiscover_port_scan`: This function performs a port scan on the domain 
+to discover open IMAP and SMTP ports.
 
-                                <SPA>off</SPA>
-                                <Encryption>TLS</Encryption>
-                                <AuthRequired>on</AuthRequired>
-                        </Protocol>
-                </Account>
-                <Account>
-                        <AccountType>email</AccountType>
-                        <Action>settings</Action>
-                        <ServiceHome>https://autodiscover.example.com</ServiceHome>
+## 🧠 Autodiscover Strategy
 
-                        <Protocol>
-                                <Type>SMTP</Type>
-                                <TTL>1</TTL>
+The `autodiscover` function uses the following strategy to discover 
+email settings:
 
-                                <Server>mail.example.com</Server>
-                                <Port>587</Port>
+1. It first attempts to use `autodiscover_autoconfig` to discover settings 
+from an autoconfig/autodiscover URL specified in the domain's TXT records.
+2. If that fails, it attempts to use `autodiscover_srv` to discover settings 
+from the domain's SRV records.
+3. If that fails and a password is provided, it attempts to use 
+`autodiscover_exchange` to discover settings using the 
+Exchange Autodiscover service (only if credentials were provided)
+4. If all else fails, it uses `autodiscover_port_scan` to discover settings by 
+performing a port scan on the domain.
 
-                                <LoginName></LoginName>
-
-                                <DomainRequired>on</DomainRequired>
-                                <DomainName>example.com</DomainName>
-
-                                <SPA>off</SPA>
-                                <Encryption>TLS</Encryption>
-                                <AuthRequired>on</AuthRequired>
-                        </Protocol>
-                </Account></Response>
-</Autodiscover>
-```
+## 📜 License
 
+myl-discovery is licensed under the [GNU General Public License v3.0](LICENSE).

{myl-discovery-0.5.3 → myl-discovery-0.5.4}/myl_discovery.egg-info/SOURCES.txt

@@ -1,4 +1,5 @@
 .gitignore
+HACKING.md
 LICENSE
 README.md
 pyproject.toml

{myl-discovery-0.5.3 → myl-discovery-0.5.4}/myldiscovery/__init__.py

@@ -1,6 +1,11 @@
-from .discovery import (autodiscover, autodiscover_autoconfig,
-                        autodiscover_exchange, autodiscover_port_scan,
-                        autodiscover_srv, autodiscover_txt)
+from .discovery import (
+    autodiscover,
+    autodiscover_autoconfig,
+    autodiscover_exchange,
+    autodiscover_port_scan,
+    autodiscover_srv,
+    autodiscover_txt,
+)
 from .main import main
 
 __all__ = [

{myl-discovery-0.5.3 → myl-discovery-0.5.4}/pyproject.toml

@@ -22,7 +22,7 @@ dependencies = [
   "rich == 13.4.2",
   "xmltodict == 0.13.0"
 ]
-version = "0.5.3"
+version = "0.5.4"
 
 [project.scripts]
 myl-discovery = "myldiscovery:main"