Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename all backends to "EmailBackend" for consistency with Django #49

Closed
medmunds opened this issue Jan 19, 2017 · 3 comments
Closed

Rename all backends to "EmailBackend" for consistency with Django #49

medmunds opened this issue Jan 19, 2017 · 3 comments
Assignees
Milestone

Comments

@medmunds
Copy link
Contributor

Django's built-in email backend class names are all EmailBackend; the type of backend is indicated by the module:

  • django.core.mail.backends.smtp.EmailBackend
  • django.core.mail.backends.console.EmailBackend
  • django.core.mail.backends.filebased.EmailBackend
  • django.core.mail.backends.locmem.EmailBackend
  • django.core.mail.backends.dummy.EmailBackend

Before 1.0-alpha, Anymail should change to follow Django's naming convention:

  • anymail.backends.mailgun.MailgunBackend → anymail.backends.mailgun.EmailBackend
  • anymail.backends.mandrill. MandrillBackend → anymail.backends.mandrill.EmailBackend
  • anymail.backends.postmark.PostmarkBackend → anymail.backends.postmark.EmailBackend
  • anymail.backends.sendgrid.SendGridBackend → anymail.backends.sendgrid.EmailBackend
  • anymail.backends.sparkpost.SparkPostBackend → anymail.backends.sparkpost.EmailBackend

To avoid breaking code, the current names should still be supported with a deprecation warning.

(As an additional benefit, this would eliminate the need for admonishments throughout the docs on how to properly capitalize each ESP's name.)

@medmunds medmunds added this to the 1.0-alpha milestone Jan 19, 2017
@medmunds medmunds self-assigned this Jan 19, 2017
medmunds added a commit that referenced this issue Jan 19, 2017
(Since it's being renamed anyway as v3 is added,
get a jump on the upcoming name change in #49.)
@areski
Copy link

areski commented Jan 26, 2017

This names change is a great idea.
My 2 cents for someone using your project for the first time it was a bit confusing as https://anymail.readthedocs.io/en/latest/installation/ was telling me to use the new naming convention but that wasn't supported on the pypi version.
It might be best that the doc point to the last official release.

Thanks for your hard work!

@medmunds
Copy link
Contributor Author

@areski sorry for the confusion. I've changed readthedocs to default to the stable release version, and updated the links in the readme to point to those, too.

@areski
Copy link

areski commented Jan 26, 2017

Thanks a lot 👍 :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants