cms.apps.newsletter package
Submodules
cms.apps.newsletter.admin module
cms.apps.newsletter.cms_plugin module
-
class
cms.apps.newsletter.cms_plugin.
CMSPlugin
Bases: cms.core.plugins.CMSPluginBase
-
admin_icon_class
= 'icon-mailbox'
-
description
= <django.utils.functional.__proxy__ object at 0xa7b0610>
-
description_long
= <django.utils.functional.__proxy__ object at 0xa7b0650>
-
license
= 'Simplified BSD'
-
status
= 'beta'
-
verbose_name
= <django.utils.functional.__proxy__ object at 0xa7b0690>
-
version
= '0.4'
cms.apps.newsletter.management module
-
cms.apps.newsletter.management.
create_group
(sender, **kwargs)
cms.apps.newsletter.messages module
cms.apps.newsletter.models module
-
class
cms.apps.newsletter.models.
NewsletterCategory
(*args, **kwargs)
Bases: cms.core.models.Content
, cms.core.models.Ownable
A category for grouping newsletter members into a series.
-
exception
DoesNotExist
Bases: django.core.exceptions.ObjectDoesNotExist
-
exception
NewsletterCategory.
MultipleObjectsReturned
Bases: django.core.exceptions.MultipleObjectsReturned
-
class
NewsletterCategory.
Settings
-
ITEMS_PER_PAGE
= {'default': 6}
-
MEDIA_PATH
= {'default': 'categories'}
-
SCHEMA
= {'default': 'CollectionPage'}
-
SITEMAP_CHANGEFREQ
= 'daily'
-
SITEMAP_PRIORITY
= 1
-
NewsletterCategory.
author
-
NewsletterCategory.
created_by
-
NewsletterCategory.
get_keywordsfield_name
()
-
NewsletterCategory.
get_mark_display
(*moreargs, **morekwargs)
-
NewsletterCategory.
get_next_by_created_date
(*moreargs, **morekwargs)
-
NewsletterCategory.
get_next_by_modified_date
(*moreargs, **morekwargs)
-
NewsletterCategory.
get_next_by_published_date
(*moreargs, **morekwargs)
-
NewsletterCategory.
get_previous_by_created_date
(*moreargs, **morekwargs)
-
NewsletterCategory.
get_previous_by_modified_date
(*moreargs, **morekwargs)
-
NewsletterCategory.
get_previous_by_published_date
(*moreargs, **morekwargs)
-
NewsletterCategory.
get_published_subscriptions
(language)
-
NewsletterCategory.
get_schema_display
(*moreargs, **morekwargs)
-
NewsletterCategory.
get_status_display
(*moreargs, **morekwargs)
-
NewsletterCategory.
image
A placeholder class that provides a way to set the attribute on the model.
-
NewsletterCategory.
imageteaser
A placeholder class that provides a way to set the attribute on the model.
-
NewsletterCategory.
keywords
This class provides the functionality that makes the related-object
managers available as attributes on a model class, for fields that have
multiple “remote” values and have a GenericRelation defined in their model
(rather than having another model pointed at them). In the example
“article.publications”, the publications attribute is a
ReverseGenericRelatedObjectsDescriptor instance.
-
NewsletterCategory.
license
-
NewsletterCategory.
modified_by
-
NewsletterCategory.
newsletter
-
NewsletterCategory.
objects
= <cms.core.managers.ContentManager object at 0xa7bbb50>
-
NewsletterCategory.
sites
-
NewsletterCategory.
subscriptions
-
class
cms.apps.newsletter.models.
NewsletterItem
(id, comments_count, comments_count_all, keywords_string, ratings_count, ratings_sum, ratings_average, created_date, modified_date, created_by_id, modified_by_id, description, description_auto, login_required, title, slug, status, published_date, expired_date, sitemapped, mark, content, teaser, teaser_auto, image, imagedescription, imageteaser, imageteaserdescription, license_id, schema, comments_allow, comments_close, author_id, ratings_allow, pretitle, send_date, send_status)
Bases: cms.core.models.Content
, cms.core.models.Ownable
, cms.core.models.Ratable
, cms.core.models.Commentable
, cms.core.models.Siblings
-
class
ApiPrivate
-
fields
= ('categories', 'pretitle', 'send_date', 'send_status')
-
queryset_prefetch_related
= ('categories',)
-
exception
NewsletterItem.
DoesNotExist
Bases: django.core.exceptions.ObjectDoesNotExist
-
exception
NewsletterItem.
MultipleObjectsReturned
Bases: django.core.exceptions.MultipleObjectsReturned
-
NewsletterItem.
SEND_STATUS_CHOICES
= ((1, <django.utils.functional.__proxy__ object at 0xa7c0e90>), (2, <django.utils.functional.__proxy__ object at 0xa7c0ed0>), (3, <django.utils.functional.__proxy__ object at 0xa7c0f10>), (4, <django.utils.functional.__proxy__ object at 0xa7c0f50>))
-
NewsletterItem.
SEND_STATUS_NOTSENT
= 1
-
NewsletterItem.
SEND_STATUS_PENDING
= 2
-
NewsletterItem.
SEND_STATUS_SENDING
= 3
-
NewsletterItem.
SEND_STATUS_SENT
= 4
-
class
NewsletterItem.
Settings
-
MEDIA_PATH
= {'default': 'newsletter'}
-
SCHEMA
= {'default': 'Article'}
-
SITEMAP_CHANGEFREQ
= 'daily'
-
SITEMAP_PRIORITY
= 1
-
class
NewsletterItem.
Translation
-
fields
= ('pretitle',)
-
NewsletterItem.
author
-
NewsletterItem.
categories
-
NewsletterItem.
category
This class provides the functionality that makes the related-object
managers available as attributes on a model class, for fields that have
multiple “remote” values and have a GenericRelation defined in their model
(rather than having another model pointed at them). In the example
“article.publications”, the publications attribute is a
ReverseGenericRelatedObjectsDescriptor instance.
-
NewsletterItem.
content_filtered
-
NewsletterItem.
created_by
-
NewsletterItem.
get_keywordsfield_name
()
-
NewsletterItem.
get_mark_display
(*moreargs, **morekwargs)
-
NewsletterItem.
get_next_by_created_date
(*moreargs, **morekwargs)
-
NewsletterItem.
get_next_by_modified_date
(*moreargs, **morekwargs)
-
NewsletterItem.
get_next_by_published_date
(*moreargs, **morekwargs)
-
NewsletterItem.
get_previous_by_created_date
(*moreargs, **morekwargs)
-
NewsletterItem.
get_previous_by_modified_date
(*moreargs, **morekwargs)
-
NewsletterItem.
get_previous_by_published_date
(*moreargs, **morekwargs)
-
NewsletterItem.
get_ratingfield_name
()
-
NewsletterItem.
get_schema_display
(*moreargs, **morekwargs)
-
NewsletterItem.
get_send_status_boolean_icon
-
NewsletterItem.
get_send_status_display
(*moreargs, **morekwargs)
-
NewsletterItem.
get_status_display
(*moreargs, **morekwargs)
-
NewsletterItem.
image
A placeholder class that provides a way to set the attribute on the model.
-
NewsletterItem.
imageteaser
A placeholder class that provides a way to set the attribute on the model.
-
NewsletterItem.
keywords
This class provides the functionality that makes the related-object
managers available as attributes on a model class, for fields that have
multiple “remote” values and have a GenericRelation defined in their model
(rather than having another model pointed at them). In the example
“article.publications”, the publications attribute is a
ReverseGenericRelatedObjectsDescriptor instance.
-
NewsletterItem.
license
-
NewsletterItem.
modified_by
-
NewsletterItem.
objects
= <cms.core.managers.ContentManager object at 0xa6c9150>
-
NewsletterItem.
ratings
This class provides the functionality that makes the related-object
managers available as attributes on a model class, for fields that have
multiple “remote” values and have a GenericRelation defined in their model
(rather than having another model pointed at them). In the example
“article.publications”, the publications attribute is a
ReverseGenericRelatedObjectsDescriptor instance.
-
NewsletterItem.
send
(request)
Sends the mails to the recipients.
-
NewsletterItem.
send_test_to_user
(request)
-
NewsletterItem.
sent
-
NewsletterItem.
sites
-
class
cms.apps.newsletter.models.
NewsletterSubscription
(id, keywords_string, created_date, modified_date, created_by_id, modified_by_id, description, description_auto, login_required, title, slug, status, published_date, expired_date, sitemapped, mark, author_id, category_id, email, language, name, user_id)
Bases: cms.core.models.Displayable
, cms.core.models.Ownable
-
class
ApiPrivate
-
fields
= ('category', 'email', 'language', 'name', 'user')
-
exception
NewsletterSubscription.
DoesNotExist
Bases: django.core.exceptions.ObjectDoesNotExist
-
exception
NewsletterSubscription.
MultipleObjectsReturned
Bases: django.core.exceptions.MultipleObjectsReturned
-
NewsletterSubscription.
STATUS_CHOICES
= ((1, <django.utils.functional.__proxy__ object at 0xa7b89d0>), (2, <django.utils.functional.__proxy__ object at 0xa7bbf10>))
-
NewsletterSubscription.
STATUS_SUBSCRIBED
= 1
-
NewsletterSubscription.
STATUS_UNSUBSCRIBED
= 2
-
class
NewsletterSubscription.
Translation
-
fields
= ('description', '-keywords_string', '-title', '-slug')
-
NewsletterSubscription.
author
-
NewsletterSubscription.
category
-
NewsletterSubscription.
created_by
-
NewsletterSubscription.
get_keywordsfield_name
()
-
NewsletterSubscription.
get_language_display
(*moreargs, **morekwargs)
-
NewsletterSubscription.
get_mark_display
(*moreargs, **morekwargs)
-
NewsletterSubscription.
get_next_by_created_date
(*moreargs, **morekwargs)
-
NewsletterSubscription.
get_next_by_modified_date
(*moreargs, **morekwargs)
-
NewsletterSubscription.
get_next_by_published_date
(*moreargs, **morekwargs)
-
NewsletterSubscription.
get_previous_by_created_date
(*moreargs, **morekwargs)
-
NewsletterSubscription.
get_previous_by_modified_date
(*moreargs, **morekwargs)
-
NewsletterSubscription.
get_previous_by_published_date
(*moreargs, **morekwargs)
-
NewsletterSubscription.
get_recipient
()
-
NewsletterSubscription.
get_recipient_pk
()
-
NewsletterSubscription.
get_status_display
(*moreargs, **morekwargs)
-
NewsletterSubscription.
keywords
This class provides the functionality that makes the related-object
managers available as attributes on a model class, for fields that have
multiple “remote” values and have a GenericRelation defined in their model
(rather than having another model pointed at them). In the example
“article.publications”, the publications attribute is a
ReverseGenericRelatedObjectsDescriptor instance.
-
NewsletterSubscription.
modified_by
-
NewsletterSubscription.
need_confirmation
()
-
NewsletterSubscription.
objects
= <cms.core.managers.DisplayableManager object at 0xa7c0950>
-
NewsletterSubscription.
save
(*args, **kwargs)
-
NewsletterSubscription.
sites
-
NewsletterSubscription.
user
-
NewsletterSubscription.
userinfo
Get a dictionary that pulls together information about the subscriber
safely for both authenticated and non-authenticated comments.
This dict will have name
, email
, fields.
cms.apps.newsletter.tasks module
-
cms.apps.newsletter.tasks.
job_send_newsletter
(addr_to, context, subject, template, count_current, count_all, lang, newsletter_pk, subscription_pk)
-
cms.apps.newsletter.tasks.
send_newsletter
(item, request, test_to_user=None)
Does the actual work
cms.apps.newsletter.tokens module
-
class
cms.apps.newsletter.tokens.
NewsletterSubscriptionTokenGenerator
Bases: django.contrib.auth.tokens.PasswordResetTokenGenerator
cms.apps.newsletter.urls module
cms.apps.newsletter.utils module
-
cms.apps.newsletter.utils.
send_aleady_subscribed
(request, category, subscription)
-
cms.apps.newsletter.utils.
send_aleady_unsubscribed
(request, category, subscription)
-
cms.apps.newsletter.utils.
send_verification_mail
(request, action, category, subscription, verification_type, subject)
Sends an email with a verification link to users when
ACCOUNTS_VERIFICATION_REQUIRED
is `True
and they’re signing
up, or when they reset a lost password.
The verification_type
arg is both the name of the urlpattern for
the verification link, as well as the names of the email templates
to use.
cms.apps.newsletter.views module
-
class
cms.apps.newsletter.views.
NewsletterBaseView
(**kwargs)
Bases: cms.core.views.GenericTemplateView
-
get_category
(category)
-
get_data
(request, category)
-
use_deferred_manager
= True
-
class
cms.apps.newsletter.views.
NewsletterSubscriptionBaseView
(**kwargs)
Bases: cms.apps.newsletter.views.NewsletterBaseView
, cms.core.views.GenericCSRFProtectedView
-
get
(request, category)
-
post
(request, category)
-
template_name
= 'newsletter/subscription_subscribe.html'
-
class
cms.apps.newsletter.views.
NewsletterSubscriptionSubscribeVerifyView
(**kwargs)
Bases: cms.apps.newsletter.views.NewsletterBaseView
-
get
(request, category, uidb64, token)
-
template_name
= 'newsletter/subscription_subscribe.html'
-
template_title
= <django.utils.functional.__proxy__ object at 0x7abd8d0>
-
class
cms.apps.newsletter.views.
NewsletterSubscriptionSubscribeView
(**kwargs)
Bases: cms.apps.newsletter.views.NewsletterSubscriptionBaseView
-
action
= 'subscribe'
-
info
= (<django.utils.functional.__proxy__ object at 0x7abda10>,)
-
template_title
= <django.utils.functional.__proxy__ object at 0x7abde50>
-
url_reverse
= 'apps.newsletter.category.subscribe'
-
class
cms.apps.newsletter.views.
NewsletterSubscriptionUnSubscribeView
(**kwargs)
Bases: cms.apps.newsletter.views.NewsletterSubscriptionBaseView
-
action
= 'unsubscribe'
-
info
= (<django.utils.functional.__proxy__ object at 0x7abd710>,)
-
template_title
= <django.utils.functional.__proxy__ object at 0x7abdc90>
-
url_reverse
= 'apps.newsletter.category.unsubscribe'
-
class
cms.apps.newsletter.views.
NewsletterSubscriptionUnubscribeVerifyView
(**kwargs)
Bases: cms.apps.newsletter.views.NewsletterBaseView
-
get
(request, category, uidb64, token)
-
template_name
= 'newsletter/subscription_subscribe.html'
-
template_title
= <django.utils.functional.__proxy__ object at 0x7abd3d0>
Module contents