> For the complete documentation index, see [llms.txt](https://quantumphp.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://quantumphp.gitbook.io/docs/packages/mailer/contracts.md). # Contracts The Mailer package keeps a small shared contract and a few adapter-specific runtime rules. ## The common adapter surface Every adapter resolved by the factory implements `Quantum\Mailer\Contracts\MailerInterface`. That gives you this common API: * `setFrom(string $email, ?string $name = null)` * `getFrom(): array` * `setAddress(string $email, ?string $name = null)` * `getAddresses(): array` * `setSubject(?string $subject)` * `getSubject(): ?string` * `setTemplate(string $templatePath)` * `getTemplate(): ?string` * `setBody(array|string|null $message)` * `getBody()` * `send(): bool` If you want code that works across all mailer adapters, stay within that surface. ## Adapter-specific methods `Quantum\Mailer\Mailer` forwards unknown methods directly to the adapter instance. That means methods such as `setCC()` or `setAttachment()` are adapter features rather than package-wide features. Use them when you know which transport is active. If the active adapter does not provide the method, the wrapper throws a mailer exception. ## `send()` is a per-message workflow The shared trait resets the composed fluent fields after each send attempt. In practice, the reliable workflow is: * compose the sender, recipients, subject, and body or template * call `send()` once * compose the next message again `MailerFactory` also reuses one wrapper per adapter name, so a fully composed message on every send keeps shared adapter instances consistent across loops, jobs, and long-running workers. ## Template contract `setTemplate()` stores a base path, not a full filename. At send time the package requires: ``` .php ``` If the body is an array, the package extracts it into local variables before requiring the template. ## Delivery result contract `send()` reports delivery state as `true` or `false`. It does not return a provider response object. Built-in transport details are mirrored into the debugger mails tab from the adapter error list. ## Mail trap contract When `mailer.mail_trap` is enabled, `send()` means "save locally" rather than "deliver remotely". That flow writes a `.eml` file into `shared/emails`, and `MailTrap` can parse that file later for subject, addresses, body, and attachments. ## Message ID contract In long-running processes, the package can reuse the same generated message ID across multiple sends from the same adapter class. If your workflow depends on a fresh ID per message, provide your own naming or tracking value alongside the mailer flow. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://quantumphp.gitbook.io/docs/packages/mailer/contracts.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.