---
title: SAIF.Framework.Mail configuration settings
summary: Configuration keys consumed by this library, retrieval methods, and runtime dependencies.
status: draft
owner: <owner>
last_reviewed: 2026-07-24
library: SAIF.Framework.Mail
reference_type: package
---

# SAIF.Framework.Mail configuration settings

SAIF.Framework.Mail uses `AppGlobal.EnvironmentService.GetConfigSetting(...)` to resolve the live `legacyMailServiceUrl` endpoint before every SOAP call. No `ConfigurationManager.AppSettings`, secure-setting, or database configuration patterns were found, but the generated `SAIFMail` proxy also includes a typed `ApplicationSettingsBase` default endpoint setting (`SAIF_Framework_Mail_SAIFMail_clsSAIFMessage`) in `app.config` and `My.Settings`.

## Configuration retrieval methods

| Method | Class / Interface | Namespace | Usage pattern |
| --- | --- | --- | --- |
| `GetConfigSetting(...)` | `AppGlobal.EnvironmentService` | `SAIF.Framework.Security` | Every `SendMail`, `SendMailWithOptions`, and `SendMailWithAttachment` overload resolves `legacyMailServiceUrl` before invoking the generated SOAP client. |
| `ApplicationSettingsBase` | `My.MySettings` | `SAIF.Framework.Mail.My` | The generated `SAIFMail.clsSAIFMessage` proxy reads `SAIF_Framework_Mail_SAIFMail_clsSAIFMessage` as its design-time default endpoint. |

## Environment API settings

Settings retrieved via `IEnvironmentService` (centralized environment configuration service).

| Setting key | Method | Data type | Purpose | Consuming class | Source |
| --- | --- | --- | --- | --- | --- |
| `legacyMailServiceUrl` | `GetConfigSetting` | URL string | Supplies the SOAP endpoint used by all outbound mail operations. | `Public Module Mail` | `SAIF.Framework.Mail\MailServices.vb` |

## AppSettings (Web.config)

Settings retrieved via `ConfigurationManager.AppSettings`.

None detected. The library does not call `ConfigurationManager.AppSettings`; its only library-local endpoint default is the `applicationSettings` value `SAIF_Framework_Mail_SAIFMail_clsSAIFMessage`.

## Database connection configuration

Connection strings and database provider settings consumed by this library.

None detected.

## Secure settings

Settings that require decryption or credential retrieval.

None detected.

## Transitive configuration (from dependencies)

Settings required at runtime by referenced libraries or packages, not directly consumed by this library's code.

None detected.

## Configuration dependencies

| Dependency | Type | Required at | Impact if missing |
| --- | --- | --- | --- |
| `legacyMailServiceUrl` | service endpoint | runtime | All outbound mail operations target the wrong SOAP endpoint or fail to resolve an endpoint when this value is missing or incorrect. |
| `SAIF_Framework_Mail_SAIFMail_clsSAIFMessage` | `applicationSettings` entry | runtime | Provides the generated proxy's design-time default URL before `legacyMailServiceUrl` overrides it. |

## Related documentation
- [Library index](index.md)
- [Overview](overview.md)
- [Architecture](architecture.md)
- [Dependencies](dependencies.md)
- [Operations and processes](operations-processes.md)
- [Business rules](business-rules.md)
- [API reference](api/index.md)

<!-- Omit configuration.md — that is this page. -->

## Sources
- `SAIF.Framework.Mail\MailServices.vb`
- `SAIF.Framework.Mail\app.config`
- `SAIF.Framework.Mail\My Project\Settings.Designer.vb`
- `SAIF.Framework.Mail\Web References\SAIFMail\Reference.vb`
- `SAIF.Framework.Mail\SAIF.BOF.Framework.Mail.vbproj`