python-doc-tw.github.io/library/email.parser.html at master · python-doc-tw/python-doc-tw.github.io

History

503 lines (466 loc) · 46.5 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>20.1.2. email.parser: Parsing email messages — Python 3.7.0 說明文件</title>

title="在 Python 3.7.0 說明文件中搜尋"

href="../_static/opensearch.xml"/>

</head><body>

<ul>

<a href="../genindex.html" title="General Index"

accesskey="I">索引</a></li>

<a href="../py-modindex.html" title="Python 模組索引"

>模組</a> |</li>

<a href="email.generator.html" title="20.1.3. email.generator: Generating MIME documents"

accesskey="N">下一頁</a> |</li>

<a href="email.message.html" title="20.1.1. email.message: Representing an email message"

accesskey="P">上一頁</a> |</li>

<li><img src="../_static/py.png" alt=""

style="vertical-align: middle; margin-top: -1px"/></li>

<li><a href="https://www.python.org/">Python</a> »</li>

<li>

zh_TW

3.7.0

<a href="../index.html">Documentation </a> »

</li>

<li class="nav-item nav-item-1"><a href="index.html" >Python 標準函式庫 (Standard Library)</a> »</li>

<li class="nav-item nav-item-2"><a href="netdata.html" >20. Internet Data Handling</a> »</li>

<li class="nav-item nav-item-3"><a href="email.html" accesskey="U">20.1. <code class="docutils literal notranslate">email</code> — An email and MIME handling package</a> »</li>

</form>

</div>

</li>

</ul>

</div>

<h1>20.1.2. <a class="reference internal" href="#module-email.parser" title="email.parser: Parse flat text email messages to produce a message object structure."><code class="xref py py-mod docutils literal notranslate">email.parser</code></a>: Parsing email messages<a class="headerlink" href="#module-email.parser" title="本標題的永久連結">¶</a></h1>

Source code: <a class="reference external" href="https://github.com/python/cpython/tree/3.7/Lib/email/parser.py">Lib/email/parser.py</a>

Message object structures can be created in one of two ways: they can be

created from whole cloth by creating an <a class="reference internal" href="email.message.html#email.message.EmailMessage" title="email.message.EmailMessage"><code class="xref py py-class docutils literal notranslate">EmailMessage</code></a>

object, adding headers using the dictionary interface, and adding payload(s)

using <a class="reference internal" href="email.message.html#email.message.EmailMessage.set_content" title="email.message.EmailMessage.set_content"><code class="xref py py-meth docutils literal notranslate">set_content()</code></a> and related methods, or

they can be created by parsing a serialized representation of the email

message.

The <a class="reference internal" href="email.html#module-email" title="email: Package supporting the parsing, manipulating, and generating email messages."><code class="xref py py-mod docutils literal notranslate">email</code></a> package provides a standard parser that understands most email

document structures, including MIME documents. You can pass the parser a

bytes, string or file object, and the parser will return to you the root

<a class="reference internal" href="email.message.html#email.message.EmailMessage" title="email.message.EmailMessage"><code class="xref py py-class docutils literal notranslate">EmailMessage</code></a> instance of the object structure. For

simple, non-MIME messages the payload of this root object will likely be a

string containing the text of the message. For MIME messages, the root object

will return <code class="docutils literal notranslate">True</code> from its <a class="reference internal" href="email.message.html#email.message.EmailMessage.is_multipart" title="email.message.EmailMessage.is_multipart"><code class="xref py py-meth docutils literal notranslate">is_multipart()</code></a>

method, and the subparts can be accessed via the payload manipulation methods,

such as <a class="reference internal" href="email.message.html#email.message.EmailMessage.get_body" title="email.message.EmailMessage.get_body"><code class="xref py py-meth docutils literal notranslate">get_body()</code></a>,

<a class="reference internal" href="email.message.html#email.message.EmailMessage.iter_parts" title="email.message.EmailMessage.iter_parts"><code class="xref py py-meth docutils literal notranslate">iter_parts()</code></a>, and

<a class="reference internal" href="email.message.html#email.message.EmailMessage.walk" title="email.message.EmailMessage.walk"><code class="xref py py-meth docutils literal notranslate">walk()</code></a>.

There are actually two parser interfaces available for use, the <a class="reference internal" href="#email.parser.Parser" title="email.parser.Parser"><code class="xref py py-class docutils literal notranslate">Parser</code></a>

API and the incremental <a class="reference internal" href="#email.parser.FeedParser" title="email.parser.FeedParser"><code class="xref py py-class docutils literal notranslate">FeedParser</code></a> API. The <a class="reference internal" href="#email.parser.Parser" title="email.parser.Parser"><code class="xref py py-class docutils literal notranslate">Parser</code></a> API is

most useful if you have the entire text of the message in memory, or if the

entire message lives in a file on the file system. <a class="reference internal" href="#email.parser.FeedParser" title="email.parser.FeedParser"><code class="xref py py-class docutils literal notranslate">FeedParser</code></a> is more

appropriate when you are reading the message from a stream which might block

waiting for more input (such as reading an email message from a socket). The

<a class="reference internal" href="#email.parser.FeedParser" title="email.parser.FeedParser"><code class="xref py py-class docutils literal notranslate">FeedParser</code></a> can consume and parse the message incrementally, and only

returns the root object when you close the parser.

Note that the parser can be extended in limited ways, and of course you can

implement your own parser completely from scratch. All of the logic that

connects the <a class="reference internal" href="email.html#module-email" title="email: Package supporting the parsing, manipulating, and generating email messages."><code class="xref py py-mod docutils literal notranslate">email</code></a> package’s bundled parser and the

class, so a custom parser can create message object trees any way it finds

necessary by implementing custom versions of the appropriate <code class="xref py py-mod docutils literal notranslate">policy</code>

methods.

<h2>20.1.2.1. FeedParser API<a class="headerlink" href="#feedparser-api" title="本標題的永久連結">¶</a></h2>

The <a class="reference internal" href="#email.parser.BytesFeedParser" title="email.parser.BytesFeedParser"><code class="xref py py-class docutils literal notranslate">BytesFeedParser</code></a>, imported from the <code class="xref py py-mod docutils literal notranslate">email.feedparser</code> module,

provides an API that is conducive to incremental parsing of email messages,

such as would be necessary when reading the text of an email message from a

source that can block (such as a socket). The <a class="reference internal" href="#email.parser.BytesFeedParser" title="email.parser.BytesFeedParser"><code class="xref py py-class docutils literal notranslate">BytesFeedParser</code></a> can of

course be used to parse an email message fully contained in a <a class="reference internal" href="../glossary.html#term-bytes-like-object">bytes-like

object</a>, string, or file, but the <a class="reference internal" href="#email.parser.BytesParser" title="email.parser.BytesParser"><code class="xref py py-class docutils literal notranslate">BytesParser</code></a> API may be more

convenient for such use cases. The semantics and results of the two parser

APIs are identical.

The <a class="reference internal" href="#email.parser.BytesFeedParser" title="email.parser.BytesFeedParser"><code class="xref py py-class docutils literal notranslate">BytesFeedParser</code></a>’s API is simple; you create an instance, feed it a

bunch of bytes until there’s no more to feed it, then close the parser to

retrieve the root message object. The <a class="reference internal" href="#email.parser.BytesFeedParser" title="email.parser.BytesFeedParser"><code class="xref py py-class docutils literal notranslate">BytesFeedParser</code></a> is extremely

accurate when parsing standards-compliant messages, and it does a very good job

of parsing non-compliant messages, providing information about how a message

was deemed broken. It will populate a message object’s

<a class="reference internal" href="email.message.html#email.message.EmailMessage.defects" title="email.message.EmailMessage.defects"><code class="xref py py-attr docutils literal notranslate">defects</code></a> attribute with a list of any

problems it found in a message. See the <a class="reference internal" href="email.errors.html#module-email.errors" title="email.errors: The exception classes used by the email package."><code class="xref py py-mod docutils literal notranslate">email.errors</code></a> module for the

list of defects that it can find.

Here is the API for the <a class="reference internal" href="#email.parser.BytesFeedParser" title="email.parser.BytesFeedParser"><code class="xref py py-class docutils literal notranslate">BytesFeedParser</code></a>:

class <code class="descclassname">email.parser.</code><code class="descname">BytesFeedParser</code>(_factory=None, *, policy=policy.compat32)<a class="headerlink" href="#email.parser.BytesFeedParser" title="本定義的永久連結">¶</a></dt>

<dd>Create a <a class="reference internal" href="#email.parser.BytesFeedParser" title="email.parser.BytesFeedParser"><code class="xref py py-class docutils literal notranslate">BytesFeedParser</code></a> instance. Optional _factory is a

no-argument callable; if not specified use the

<a class="reference internal" href="email.policy.html#email.policy.Policy.message_factory" title="email.policy.Policy.message_factory"><code class="xref py py-attr docutils literal notranslate">message_factory</code></a> from the policy. Call

_factory whenever a new message object is needed.

If policy is specified use the rules it specifies to update the

representation of the message. If policy is not set, use the

<a class="reference internal" href="email.policy.html#email.policy.Compat32" title="email.policy.Compat32"><code class="xref py py-class docutils literal notranslate">compat32</code></a> policy, which maintains backward

compatibility with the Python 3.2 version of the email package and provides

<a class="reference internal" href="email.compat32-message.html#email.message.Message" title="email.message.Message"><code class="xref py py-class docutils literal notranslate">Message</code></a> as the default factory. All other policies

provide <a class="reference internal" href="email.message.html#email.message.EmailMessage" title="email.message.EmailMessage"><code class="xref py py-class docutils literal notranslate">EmailMessage</code></a> as the default _factory. For

more information on what else policy controls, see the

<a class="reference internal" href="email.policy.html#module-email.policy" title="email.policy: Controlling the parsing and generating of messages"><code class="xref py py-mod docutils literal notranslate">policy</code></a> documentation.

Note: The policy keyword should always be specified; The default will

change to <a class="reference internal" href="email.policy.html#email.policy.default" title="email.policy.default"><code class="xref py py-data docutils literal notranslate">email.policy.default</code></a> in a future version of Python.

3.2 版新加入.

</div>

3.3 版更變: Added the policy keyword.

</div>

3.6 版更變: _factory defaults to the policy <code class="docutils literal notranslate">message_factory</code>.

</div>

<dd>Feed the parser some more data. data should be a <a class="reference internal" href="../glossary.html#term-bytes-like-object">bytes-like

object</a> containing one or more lines. The lines can be partial and the

parser will stitch such partial lines together properly. The lines can

have any of the three common line endings: carriage return, newline, or

carriage return and newline (they can even be mixed).

</dd></dl>

<code class="descname">close</code>()<a class="headerlink" href="#email.parser.BytesFeedParser.close" title="本定義的永久連結">¶</a></dt>

<dd>Complete the parsing of all previously fed data and return the root

message object. It is undefined what happens if <a class="reference internal" href="#email.parser.BytesFeedParser.feed" title="email.parser.BytesFeedParser.feed"><code class="xref py py-meth docutils literal notranslate">feed()</code></a> is called

after this method has been called.

</dd></dl>

class <code class="descclassname">email.parser.</code><code class="descname">FeedParser</code>(_factory=None, *, policy=policy.compat32)<a class="headerlink" href="#email.parser.FeedParser" title="本定義的永久連結">¶</a></dt>

<dd>Works like <a class="reference internal" href="#email.parser.BytesFeedParser" title="email.parser.BytesFeedParser"><code class="xref py py-class docutils literal notranslate">BytesFeedParser</code></a> except that the input to the

<a class="reference internal" href="#email.parser.BytesFeedParser.feed" title="email.parser.BytesFeedParser.feed"><code class="xref py py-meth docutils literal notranslate">feed()</code></a> method must be a string. This is of limited

utility, since the only way for such a message to be valid is for it to

contain only ASCII text or, if <code class="xref py py-attr docutils literal notranslate">utf8</code> is

<code class="docutils literal notranslate">True</code>, no binary attachments.

3.3 版更變: Added the policy keyword.

</div>

</dd></dl>

</div>

<h2>20.1.2.2. Parser API<a class="headerlink" href="#parser-api" title="本標題的永久連結">¶</a></h2>

The <a class="reference internal" href="#email.parser.BytesParser" title="email.parser.BytesParser"><code class="xref py py-class docutils literal notranslate">BytesParser</code></a> class, imported from the <a class="reference internal" href="#module-email.parser" title="email.parser: Parse flat text email messages to produce a message object structure."><code class="xref py py-mod docutils literal notranslate">email.parser</code></a> module,

provides an API that can be used to parse a message when the complete contents

of the message are available in a <a class="reference internal" href="../glossary.html#term-bytes-like-object">bytes-like object</a> or file. The

<a class="reference internal" href="#module-email.parser" title="email.parser: Parse flat text email messages to produce a message object structure."><code class="xref py py-mod docutils literal notranslate">email.parser</code></a> module also provides <a class="reference internal" href="#email.parser.Parser" title="email.parser.Parser"><code class="xref py py-class docutils literal notranslate">Parser</code></a> for parsing strings,

and header-only parsers, <a class="reference internal" href="#email.parser.BytesHeaderParser" title="email.parser.BytesHeaderParser"><code class="xref py py-class docutils literal notranslate">BytesHeaderParser</code></a> and

<a class="reference internal" href="#email.parser.HeaderParser" title="email.parser.HeaderParser"><code class="xref py py-class docutils literal notranslate">HeaderParser</code></a>, which can be used if you’re only interested in the

headers of the message. <a class="reference internal" href="#email.parser.BytesHeaderParser" title="email.parser.BytesHeaderParser"><code class="xref py py-class docutils literal notranslate">BytesHeaderParser</code></a> and <a class="reference internal" href="#email.parser.HeaderParser" title="email.parser.HeaderParser"><code class="xref py py-class docutils literal notranslate">HeaderParser</code></a>

can be much faster in these situations, since they do not attempt to parse the

message body, instead setting the payload to the raw body.

class <code class="descclassname">email.parser.</code><code class="descname">BytesParser</code>(_class=None, *, policy=policy.compat32)<a class="headerlink" href="#email.parser.BytesParser" title="本定義的永久連結">¶</a></dt>

<dd>Create a <a class="reference internal" href="#email.parser.BytesParser" title="email.parser.BytesParser"><code class="xref py py-class docutils literal notranslate">BytesParser</code></a> instance. The _class and policy

arguments have the same meaning and semantics as the _factory

and policy arguments of <a class="reference internal" href="#email.parser.BytesFeedParser" title="email.parser.BytesFeedParser"><code class="xref py py-class docutils literal notranslate">BytesFeedParser</code></a>.

Note: The policy keyword should always be specified; The default will

3.3 版更變: Removed the strict argument that was deprecated in 2.4. Added the

policy keyword.

</div>

3.6 版更變: _class defaults to the policy <code class="docutils literal notranslate">message_factory</code>.

</div>

<code class="descname">parse</code>(fp, headersonly=False)<a class="headerlink" href="#email.parser.BytesParser.parse" title="本定義的永久連結">¶</a></dt>

<dd>Read all the data from the binary file-like object fp, parse the

resulting bytes, and return the message object. fp must support

both the <a class="reference internal" href="io.html#io.IOBase.readline" title="io.IOBase.readline"><code class="xref py py-meth docutils literal notranslate">readline()</code></a> and the <code class="xref py py-meth docutils literal notranslate">read()</code>

methods.

The bytes contained in fp must be formatted as a block of <a class="rfc reference external" href="https://tools.ietf.org/html/rfc5322.html">RFC 5322</a>

(or, if <code class="xref py py-attr docutils literal notranslate">utf8</code> is <code class="docutils literal notranslate">True</code>, <a class="rfc reference external" href="https://tools.ietf.org/html/rfc6532.html">RFC 6532</a>)

style headers and header continuation lines, optionally preceded by an

envelope header. The header block is terminated either by the end of the

data or by a blank line. Following the header block is the body of the

message (which may contain MIME-encoded subparts, including subparts

with a Content-Transfer-Encoding of <code class="docutils literal notranslate">8bit</code>.

Optional headersonly is a flag specifying whether to stop parsing after

reading the headers or not. The default is <code class="docutils literal notranslate">False</code>, meaning it parses

the entire contents of the file.

</dd></dl>

<code class="descname">parsebytes</code>(bytes, headersonly=False)<a class="headerlink" href="#email.parser.BytesParser.parsebytes" title="本定義的永久連結">¶</a></dt>

<dd>Similar to the <a class="reference internal" href="#email.parser.BytesParser.parse" title="email.parser.BytesParser.parse"><code class="xref py py-meth docutils literal notranslate">parse()</code></a> method, except it takes a <a class="reference internal" href="../glossary.html#term-bytes-like-object">bytes-like

object</a> instead of a file-like object. Calling this method on a

<a class="reference internal" href="../glossary.html#term-bytes-like-object">bytes-like object</a> is equivalent to wrapping bytes in a

<a class="reference internal" href="io.html#io.BytesIO" title="io.BytesIO"><code class="xref py py-class docutils literal notranslate">BytesIO</code></a> instance first and calling <a class="reference internal" href="#email.parser.BytesParser.parse" title="email.parser.BytesParser.parse"><code class="xref py py-meth docutils literal notranslate">parse()</code></a>.

Optional headersonly is as with the <a class="reference internal" href="#email.parser.BytesParser.parse" title="email.parser.BytesParser.parse"><code class="xref py py-meth docutils literal notranslate">parse()</code></a> method.

</dd></dl>

3.2 版新加入.

</div>

</dd></dl>

class <code class="descclassname">email.parser.</code><code class="descname">BytesHeaderParser</code>(_class=None, *, policy=policy.compat32)<a class="headerlink" href="#email.parser.BytesHeaderParser" title="本定義的永久連結">¶</a></dt>

<dd>Exactly like <a class="reference internal" href="#email.parser.BytesParser" title="email.parser.BytesParser"><code class="xref py py-class docutils literal notranslate">BytesParser</code></a>, except that headersonly

defaults to <code class="docutils literal notranslate">True</code>.

3.3 版新加入.

</div>

</dd></dl>

class <code class="descclassname">email.parser.</code><code class="descname">Parser</code>(_class=None, *, policy=policy.compat32)<a class="headerlink" href="#email.parser.Parser" title="本定義的永久連結">¶</a></dt>

<dd>This class is parallel to <a class="reference internal" href="#email.parser.BytesParser" title="email.parser.BytesParser"><code class="xref py py-class docutils literal notranslate">BytesParser</code></a>, but handles string input.

3.3 版更變: Removed the strict argument. Added the policy keyword.

</div>

3.6 版更變: _class defaults to the policy <code class="docutils literal notranslate">message_factory</code>.

</div>

<code class="descname">parse</code>(fp, headersonly=False)<a class="headerlink" href="#email.parser.Parser.parse" title="本定義的永久連結">¶</a></dt>

<dd>Read all the data from the text-mode file-like object fp, parse the

resulting text, and return the root message object. fp must support

both the <a class="reference internal" href="io.html#io.TextIOBase.readline" title="io.TextIOBase.readline"><code class="xref py py-meth docutils literal notranslate">readline()</code></a> and the

<a class="reference internal" href="io.html#io.TextIOBase.read" title="io.TextIOBase.read"><code class="xref py py-meth docutils literal notranslate">read()</code></a> methods on file-like objects.

Other than the text mode requirement, this method operates like

<a class="reference internal" href="#email.parser.BytesParser.parse" title="email.parser.BytesParser.parse"><code class="xref py py-meth docutils literal notranslate">BytesParser.parse()</code></a>.

</dd></dl>

<code class="descname">parsestr</code>(text, headersonly=False)<a class="headerlink" href="#email.parser.Parser.parsestr" title="本定義的永久連結">¶</a></dt>

<dd>Similar to the <a class="reference internal" href="#email.parser.Parser.parse" title="email.parser.Parser.parse"><code class="xref py py-meth docutils literal notranslate">parse()</code></a> method, except it takes a string object

instead of a file-like object. Calling this method on a string is

equivalent to wrapping text in a <a class="reference internal" href="io.html#io.StringIO" title="io.StringIO"><code class="xref py py-class docutils literal notranslate">StringIO</code></a> instance first

and calling <a class="reference internal" href="#email.parser.Parser.parse" title="email.parser.Parser.parse"><code class="xref py py-meth docutils literal notranslate">parse()</code></a>.

Optional headersonly is as with the <a class="reference internal" href="#email.parser.Parser.parse" title="email.parser.Parser.parse"><code class="xref py py-meth docutils literal notranslate">parse()</code></a> method.

</dd></dl>

class <code class="descclassname">email.parser.</code><code class="descname">HeaderParser</code>(_class=None, *, policy=policy.compat32)<a class="headerlink" href="#email.parser.HeaderParser" title="本定義的永久連結">¶</a></dt>

<dd>Exactly like <a class="reference internal" href="#email.parser.Parser" title="email.parser.Parser"><code class="xref py py-class docutils literal notranslate">Parser</code></a>, except that headersonly

defaults to <code class="docutils literal notranslate">True</code>.

</dd></dl>

Since creating a message object structure from a string or a file object is such

a common task, four functions are provided as a convenience. They are available

in the top-level <a class="reference internal" href="email.html#module-email" title="email: Package supporting the parsing, manipulating, and generating email messages."><code class="xref py py-mod docutils literal notranslate">email</code></a> package namespace.

<code class="descclassname">email.</code><code class="descname">message_from_bytes</code>(s, _class=None, *, policy=policy.compat32)<a class="headerlink" href="#email.message_from_bytes" title="本定義的永久連結">¶</a></dt>

<dd>Return a message object structure from a <a class="reference internal" href="../glossary.html#term-bytes-like-object">bytes-like object</a>. This is

equivalent to <code class="docutils literal notranslate">BytesParser().parsebytes(s)</code>. Optional _class and

strict are interpreted as with the <a class="reference internal" href="#email.parser.BytesParser" title="email.parser.BytesParser"><code class="xref py py-class docutils literal notranslate">BytesParser</code></a> class

constructor.

3.2 版新加入.

</div>

3.3 版更變: Removed the strict argument. Added the policy keyword.

</div>

</dd></dl>

<code class="descclassname">email.</code><code class="descname">message_from_binary_file</code>(fp, _class=None, *, policy=policy.compat32)<a class="headerlink" href="#email.message_from_binary_file" title="本定義的永久連結">¶</a></dt>

<dd>Return a message object structure tree from an open binary <a class="reference internal" href="../glossary.html#term-file-object">file

object</a>. This is equivalent to <code class="docutils literal notranslate">BytesParser().parse(fp)</code>. _class and

policy are interpreted as with the <a class="reference internal" href="#email.parser.BytesParser" title="email.parser.BytesParser"><code class="xref py py-class docutils literal notranslate">BytesParser</code></a> class

constructor.

3.2 版新加入.

</div>

3.3 版更變: Removed the strict argument. Added the policy keyword.

</div>

</dd></dl>

<code class="descclassname">email.</code><code class="descname">message_from_string</code>(s, _class=None, *, policy=policy.compat32)<a class="headerlink" href="#email.message_from_string" title="本定義的永久連結">¶</a></dt>

<dd>Return a message object structure from a string. This is equivalent to

<code class="docutils literal notranslate">Parser().parsestr(s)</code>. _class and policy are interpreted as

with the <a class="reference internal" href="#email.parser.Parser" title="email.parser.Parser"><code class="xref py py-class docutils literal notranslate">Parser</code></a> class constructor.

3.3 版更變: Removed the strict argument. Added the policy keyword.

</div>

</dd></dl>

<code class="descclassname">email.</code><code class="descname">message_from_file</code>(fp, _class=None, *, policy=policy.compat32)<a class="headerlink" href="#email.message_from_file" title="本定義的永久連結">¶</a></dt>

<dd>Return a message object structure tree from an open <a class="reference internal" href="../glossary.html#term-file-object">file object</a>.

This is equivalent to <code class="docutils literal notranslate">Parser().parse(fp)</code>. _class and policy are

interpreted as with the <a class="reference internal" href="#email.parser.Parser" title="email.parser.Parser"><code class="xref py py-class docutils literal notranslate">Parser</code></a> class constructor.

3.3 版更變: Removed the strict argument. Added the policy keyword.

</div>

3.6 版更變: _class defaults to the policy <code class="docutils literal notranslate">message_factory</code>.

</div>

</dd></dl>

Here’s an example of how you might use <a class="reference internal" href="#email.message_from_bytes" title="email.message_from_bytes"><code class="xref py py-func docutils literal notranslate">message_from_bytes()</code></a> at an

interactive Python prompt:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>>>> import email

>>> msg = email.message_from_bytes(myBytes)

</pre></div>

</div>

<h2>20.1.2.3. Additional notes<a class="headerlink" href="#additional-notes" title="本標題的永久連結">¶</a></h2>

Here are some notes on the parsing semantics:

<li>Most non-multipart type messages are parsed as a single message

object with a string payload. These objects will return <code class="docutils literal notranslate">False</code> for

<a class="reference internal" href="email.message.html#email.message.EmailMessage.is_multipart" title="email.message.EmailMessage.is_multipart"><code class="xref py py-meth docutils literal notranslate">is_multipart()</code></a>, and

<li>All multipart type messages will be parsed as a container message

object with a list of sub-message objects for their payload. The outer

container message will return <code class="docutils literal notranslate">True</code> for

<li>Most messages with a content type of message/* (such as

message/delivery-status and message/rfc822) will also

be parsed as container object containing a list payload of length 1. Their

The single element yielded by <a class="reference internal" href="email.message.html#email.message.EmailMessage.iter_parts" title="email.message.EmailMessage.iter_parts"><code class="xref py py-meth docutils literal notranslate">iter_parts()</code></a>

will be a sub-message object.</li>

<li>Some non-standards-compliant messages may not be internally consistent about

their multipart-edness. Such messages may have a

Content-Type header of type multipart, but their

If such messages were parsed with the <a class="reference internal" href="#email.parser.FeedParser" title="email.parser.FeedParser"><code class="xref py py-class docutils literal notranslate">FeedParser</code></a>,

they will have an instance of the

<code class="xref py py-class docutils literal notranslate">MultipartInvariantViolationDefect</code> class in their

defects attribute list. See <a class="reference internal" href="email.errors.html#module-email.errors" title="email.errors: The exception classes used by the email package."><code class="xref py py-mod docutils literal notranslate">email.errors</code></a> for details.</li>

</ul>

</div>

<ul>

<li><a class="reference internal" href="#">20.1.2. <code class="docutils literal notranslate">email.parser</code>: Parsing email messages</a><ul>

<li><a class="reference internal" href="#feedparser-api">20.1.2.1. FeedParser API</a></li>

<li><a class="reference internal" href="#parser-api">20.1.2.2. Parser API</a></li>

<li><a class="reference internal" href="#additional-notes">20.1.2.3. Additional notes</a></li>

</ul>

</li>

</ul>

<a href="email.message.html"

title="上一章">20.1.1. <code class="docutils literal notranslate">email.message</code>: Representing an email message</a>

<a href="email.generator.html"

title="下一章">20.1.3. <code class="docutils literal notranslate">email.generator</code>: Generating MIME documents</a>

<li><a href="../bugs.html">Report a Bug</a></li>

<li>

<a href="https://github.com/python/cpython/blob/3.7/Doc/library/email.parser.rst"

rel="nofollow">Show Source

</a>

</li>

</ul>

</div>

</div>

<ul>

<a href="../genindex.html" title="General Index"

>索引</a></li>

<a href="../py-modindex.html" title="Python 模組索引"

>模組</a> |</li>

<a href="email.generator.html" title="20.1.3. email.generator: Generating MIME documents"

>下一頁</a> |</li>

<a href="email.message.html" title="20.1.1. email.message: Representing an email message"

>上一頁</a> |</li>

<li><img src="../_static/py.png" alt=""

style="vertical-align: middle; margin-top: -1px"/></li>

<li><a href="https://www.python.org/">Python</a> »</li>

<li>

zh_TW

3.7.0

<a href="../index.html">Documentation </a> »

</li>

<li class="nav-item nav-item-1"><a href="index.html" >Python 標準函式庫 (Standard Library)</a> »</li>

<li class="nav-item nav-item-2"><a href="netdata.html" >20. Internet Data Handling</a> »</li>

<li class="nav-item nav-item-3"><a href="email.html" >20.1. <code class="docutils literal notranslate">email</code> — An email and MIME handling package</a> »</li>

</form>

</div>

</li>

</ul>

</div>

The Python Software Foundation is a non-profit corporation.

<a href="https://www.python.org/psf/donations/">Please donate.</a>

Last updated on 8月 22, 2018.

<a href="../bugs.html">Found a bug</a>?

Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.7.7.

</div>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

email.parser.html

Latest commit

History

email.parser.html

File metadata and controls