Flask- Documentation

Transcription

1 Flask- Documentation Release Allan Lei Sep 09, 2017

2

3 Contents 1 Installion 3 2 Usage Sending an Shortcuts Configuration 7 4 Backends SMTPMail FilebasedMail Consol DummyMail LocmemMail API 11 6 Extend 13 7 Changelog Version Notes 17 Python Module Index 19 i

4 ii

5 Flask- Documentation, Release Flask- is a fork of the core backends in Django to be used with Flask. In addition there are extra backends that might be useful. Documentation: TODO: Finish documentation Contents 1

6 Flask- Documentation, Release Contents

7 CHAPTER 1 Installion Install with pip: pip install Flask- or install with easy_install: easy_install Flask- 3

8 Flask- Documentation, Release Chapter 1. Installion

9 CHAPTER 2 Usage Instantiate a backend: from flask import Flask from flask.ext. import Consol app = Flask( name ) mailbox = Consol (app) or initialize it later init_app(): mailbox = Consol () def create_app(config='settings.cfg'): app = Flask( name ) app.config.from_pyfile(config) mailbox.init_app(app) return app Sending an = Message( 'Subject', 'Content', 'bounce@example.com', ['to@example.com'], headers={'from': 'from@example.com'} ) .send(mailbox) 5

10 Flask- Documentation, Release Shortcuts send_mail('subject', 'Content', 6 Chapter 2. Usage

11 CHAPTER 3 Configuration Flask- accepts the following settings regardless of backend DEFAULT_CHARSET Default charset to use for all Message. Defaults to 'utf-8' DEFAULT_FROM_ Default address to use for when the sender parameter not present. Defaults to 'webmaster@localhost' SERVER_ The address that messages come from when using mail_admins() and mail_managers() and no sender is provided. Defaults to 'root@localhost' _SUBJECT_PREFIX Subject-line prefix for messages sent with mail_admins() or mail_managers(). You ll probably want to include the trailing space. Defaults to '[Flask] ' ADMINS A tuple following one of the below formats that specifies who should receive messages from mail_admins(). Tuple of name and (('John', 'john@example.com'), ('Mary', 'mary@example.com')) format name < >: ('John <john@example.com>', 'Mary <mary@example.com>') Defaults to () (Empty tuple) MANAGERS A tuple in the same format as ADMINS that specifies who should receive messages from mail_managers() Defaults to () (Empty tuple) 7

12 Flask- Documentation, Release _BACKEND The backend to use for sending s. Defaults to 'flask.ext. .backends.locmem.mail' 8 Chapter 3. Configuration

13 CHAPTER 4 Backends SMTPMail _HOST The host to use for sending . Defaults to 'localhost' _PORT Port to use for the SMTP server defined in _HOST. Defaults to 25 _HOST_USER Username to use for the SMTP server defined in _HOST. If empty, authentication will be skipped. Defaults to '' (Empty string) _HOST_PASSWORD Password to use for the SMTP server defined in _HOST. This setting is used in conjunction with _HOST_USER when authenticating to the SMTP server. If either of these settings is empty, authentication will be skipped. Defaults to '' (Empty string) _USE_TLS Whether to use a TLS (secure) connection when talking to the SMTP server. Defaults to False _USE_SSL Whether to use a TLS (secure) connection when talking to the SMTP server. Defaults to False FilebasedMail _FILE_PATH The directory used by the file backend to store output files. Defaults to None 9

14 Flask- Documentation, Release Consol DummyMail LocmemMail 10 Chapter 4. Backends

15 CHAPTER 5 API 11

16 Flask- Documentation, Release Chapter 5. API

17 CHAPTER 6 Extend 13

18 Flask- Documentation, Release Chapter 6. Extend

19 CHAPTER 7 Changelog Version Released Jan 9, 2013 Initial port of Django

20 Flask- Documentation, Release Chapter 7. Changelog

21 CHAPTER 8 Notes 17

22 Flask- Documentation, Release Chapter 8. Notes

23 Python Module Index f flask- , 1 19

24 Flask- Documentation, Release Python Module Index

25 Index F flask- (module), 1 21