references.rst 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091
  1. References
  2. ==========
  3. Sender
  4. ------
  5. .. autoclass:: redmail.EmailSender
  6. :members:
  7. Format Classes
  8. --------------
  9. .. autoclass:: redmail.models.EmailAddress
  10. .. autoclass:: redmail.models.Error
  11. Logging Classes
  12. ---------------
  13. .. autoclass:: redmail.EmailHandler
  14. .. autoclass:: redmail.MultiEmailHandler
  15. .. _email_structure:
  16. Email Strucure (MIME)
  17. ---------------------
  18. This section covers how Red Mail structures emails with MIME parts.
  19. You may need this information if you are creating unit tests or
  20. if you face problems with rendering your emails by your email provider.
  21. Empty Email
  22. ^^^^^^^^^^^
  23. Empty email has no MIME parts attached. It only has the headers.
  24. Email with a text body
  25. ^^^^^^^^^^^^^^^^^^^^^^
  26. * text/plain
  27. Email with an HTML body
  28. ^^^^^^^^^^^^^^^^^^^^^^^
  29. * multipart/mixed
  30. * multipart/alternative
  31. * text/html
  32. Email with an HTML body and inline JPG image
  33. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  34. * multipart/mixed
  35. * multipart/alternative
  36. * multipart/related
  37. * text/html
  38. * image/jpg
  39. Email with an attachment
  40. ^^^^^^^^^^^^^^^^^^^^^^^^
  41. * multipart/mixed
  42. * application/octet-stream
  43. Email with all elements
  44. ^^^^^^^^^^^^^^^^^^^^^^^
  45. * multipart/mixed
  46. * multipart/alternative
  47. * text/plain
  48. * multipart/related
  49. * text/html
  50. * image/jpg
  51. * application/octet-stream