flux-mail-api

Mail Api for fetch or send mails

Installation

Native

Download

RUN (mkdir -p /%path%/libs/flux-mail-api && cd /%path%/libs/flux-mail-api && wget -O - https://github.com/fluxfw/flux-mail-api/releases/download/%tag%/flux-mail-api-%tag%-build.tar.gz | tar -xz --strip-components=1)

Download https://github.com/fluxfw/flux-mail-api/releases/download/%tag%/flux-mail-api-%tag%-build.tar.gz and extract it to /%path%/libs/flux-mail-api

Load

require_once __DIR__ . "/%path%/libs/flux-mail-api/autoload.php";

Composer

{
    "repositories": [
        {
            "type": "package",
            "package": {
                "name": "flux/flux-mail-api",
                "version": "%tag%",
                "dist": {
                    "url": "https://github.com/fluxfw/flux-mail-api/releases/download/%tag%/flux-mail-api-%tag%-build.tar.gz",
                    "type": "tar"
                },
                "autoload": {
                    "files": [
                        "autoload.php"
                    ]
                }
            }
        }
    ],
    "require": {
        "flux/flux-mail-api": "*"
    }
}

Environment variables

Variable	Description	Default value
FLUX_MAIL_API_MAIL_HOST	Mail server host name	-
FLUX_MAIL_API_MAIL_PORT	Mail server port	-
FLUX_MAIL_API_MAIL_TYPE	Mail server type imap, pop3 or nntp	-
FLUX_MAIL_API_MAIL_USER_NAME	Mail user name Use FLUX_MAIL_API_MAIL_USER_NAME_FILE for docker secrets	-
FLUX_MAIL_API_MAIL_PASSWORD	Mail password Use FLUX_MAIL_API_MAIL_PASSWORD_FILE for docker secrets	-
FLUX_MAIL_API_MAIL_ENCRYPTION_TYPE	Type to encrypt the connection to the server ssl, tls or tls-auto	-
FLUX_MAIL_API_MAIL_BOX	Mail box path	INBOX
FLUX_MAIL_API_MAIL_MARK_AS_READ	Mark fetched mails as read	true
FLUX_MAIL_API_SMTP_HOST	SMTP server host name	-
FLUX_MAIL_API_SMTP_PORT	SMTP server port	-
FLUX_MAIL_API_SMTP_FROM	From email address	-
FLUX_MAIL_API_SMTP_FROM_NAME	From name	-
FLUX_MAIL_API_SMTP_ENCRYPTION_TYPE	Type to encrypt the connection to the server ssl, tls or tls-auto	-
FLUX_MAIL_API_SMTP_USER_NAME	SMTP user name Use FLUX_MAIL_API_SMTP_USER_NAME_FILE for docker secrets	-
FLUX_MAIL_API_SMTP_PASSWORD	SMTP password Use FLUX_MAIL_API_SMTP_PASSWORD_FILE for docker secrets	-
FLUX_MAIL_API_SMTP_AUTH_TYPE	Type to authenticate on the server PLAIN, LOGIN, CRAM-MD5 or XOAUTH2	(Auto detect)

Minimal variables required to set are bold

Example

Look at flux-mail-rest-api

You might also like...

💌 Mail app for Nextcloud

Nextcloud Mail 💌 A mail app for Nextcloud Why is this so awesome? 🚀 Integration with other Nextcloud apps! Currently Contacts, Calendar & Files – mo

684 Dec 26, 2022

Crud PHP 8 com Form E-mail

Crud com PHP 8 PDO Login - Cadastro de Usuários - Edição - Deleção - Adição | Formulário envio de e-mail Para rodar o Crud é preciso instalar um servi

4 Nov 16, 2021

Mail Web is a Laravel package which catches emails locally for debugging

Mail Web is a Laravel package which catches emails locally for debugging Installation Use the package manager composer to install Mail Web. composer r

64 Dec 24, 2022

Simple mail sending by PHPMailer and Create your local system.

Simple mail sending by PHPMailer and Create your local system. Send mail zero of cost and also send Attachment like Photo, pdf and multiple files. You should be create a login and verify two steps authentication like OTP, verifications 🔗 link. PHPMailer make your dreams project eassy and simple also free of cost.