1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 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
//! The IMAP QUOTA Extension
//!
//! This extends ...
//!
//! * [`Capability`](crate::response::Capability) with new variants:
//!
//! - [`Capability::Quota`](crate::response::Capability::Quota)
//! - [`Capability::QuotaRes`](crate::response::Capability::QuotaRes)
//! - [`Capability::QuotaSet`](crate::response::Capability::QuotaSet)
//!
//! * [`CommandBod`y](crate::command::CommandBody) with new variants:
//!
//! - [`Command::GetQuota`](crate::command::CommandBody::GetQuota)
//! - [`Command::GetQuotaRoot`](crate::command::CommandBody::GetQuotaRoot)
//! - [`Command::SetQuota`](crate::command::CommandBody::SetQuota)
//!
//! * [`Data`](crate::response::Data) with new variants:
//!
//! - [`Data::Quota`](crate::response::Data::Quota)
//! - [`Data::QuotaRoot`](crate::response::Data::QuotaRoot)
//!
//! * [`Code`](crate::response::Code) with a new variant:
//!
//! - [`Code::OverQuota`](crate::response::Code::OverQuota)
//!
//! * [`StatusDataItemName`](crate::status::StatusDataItemName) with new variants:
//!
//! - [`StatusDataItemName::Deleted`](crate::status::StatusDataItemName::Deleted)
//! - [`StatusDataItemName::DeletedStorage`](crate::status::StatusDataItemName::DeletedStorage)
//!
//! * [`StatusDataItem`](crate::status::StatusDataItem) with new variants:
//!
//! - [`StatusDataItem::Deleted`](crate::status::StatusDataItem::Deleted)
//! - [`StatusDataItem::DeletedStorage`](crate::status::StatusDataItem::DeletedStorage)
use std::{
borrow::Cow,
fmt::{Display, Formatter},
};
#[cfg(feature = "arbitrary")]
use arbitrary::Arbitrary;
#[cfg(feature = "bounded-static")]
use bounded_static::ToStatic;
#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};
use thiserror::Error;
use crate::{
command::CommandBody,
core::{impl_try_from, AString, Atom, NonEmptyVec},
mailbox::Mailbox,
response::Data,
};
impl<'a> CommandBody<'a> {
pub fn get_quota<A>(root: A) -> Result<Self, A::Error>
where
A: TryInto<AString<'a>>,
{
Ok(CommandBody::GetQuota {
root: root.try_into()?,
})
}
pub fn get_quota_root<M>(mailbox: M) -> Result<Self, M::Error>
where
M: TryInto<Mailbox<'a>>,
{
Ok(CommandBody::GetQuotaRoot {
mailbox: mailbox.try_into()?,
})
}
pub fn set_quota<R, S>(root: R, quotas: S) -> Result<Self, SetQuotaError<R::Error, S::Error>>
where
R: TryInto<AString<'a>>,
S: TryInto<Vec<QuotaSet<'a>>>,
{
Ok(CommandBody::SetQuota {
root: root.try_into().map_err(SetQuotaError::Root)?,
quotas: quotas.try_into().map_err(SetQuotaError::QuotaSet)?,
})
}
}
impl<'a> Data<'a> {
pub fn quota<R, Q>(root: R, quotas: Q) -> Result<Self, QuotaError<R::Error, Q::Error>>
where
R: TryInto<AString<'a>>,
Q: TryInto<NonEmptyVec<QuotaGet<'a>>>,
{
Ok(Self::Quota {
root: root.try_into().map_err(QuotaError::Root)?,
quotas: quotas.try_into().map_err(QuotaError::Quotas)?,
})
}
pub fn quota_root<M, R>(
mailbox: M,
roots: R,
) -> Result<Self, QuotaRootError<M::Error, R::Error>>
where
M: TryInto<Mailbox<'a>>,
R: TryInto<Vec<AString<'a>>>,
{
Ok(Self::QuotaRoot {
mailbox: mailbox.try_into().map_err(QuotaRootError::Mailbox)?,
roots: roots.try_into().map_err(QuotaRootError::Roots)?,
})
}
}
#[cfg_attr(feature = "bounded-static", derive(ToStatic))]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct Resource<'a>(Inner<'a>);
/// A resource type for use in IMAP's QUOTA extension.
///
/// Supported resource names MUST be advertised as a capability by prepending the resource name with "QUOTA=RES-".
impl Resource<'static> {
/// The physical space estimate, in units of 1024 octets, of the mailboxes governed by the quota
/// root.
///
/// This MAY not be the same as the sum of the RFC822.SIZE of the messages. Some implementations
/// MAY include metadata sizes for the messages and mailboxes, and other implementations MAY
/// store messages in such a way that the physical space used is smaller, for example, due to
/// use of compression. Additional messages might not increase the usage. Clients MUST NOT use
/// the usage figure for anything other than informational purposes; for example, they MUST NOT
/// refuse to APPEND a message if the limit less the usage is smaller than the RFC822.SIZE
/// divided by 1024 octets of the message, but it MAY warn about such condition. The usage
/// figure may change as a result of performing actions not associated with adding new messages
/// to the mailbox, such as SEARCH, since this may increase the amount of metadata included in
/// the calculations.
///
/// When the server supports this resource type, it MUST also support the DELETED-STORAGE status
/// data item.
///
/// Support for this resource MUST be indicated by the server by advertising the
/// "QUOTA=RES-STORAGE" capability.
pub const STORAGE: Self = Resource(Inner::Storage);
/// The number of messages stored within the mailboxes governed by the quota root.
///
/// This MUST be an exact number; however, clients MUST NOT assume that a change in the usage
/// indicates a change in the number of messages available, since the quota root may include
/// mailboxes the client has no access to.
///
/// When the server supports this resource type, it MUST also support the DELETED status data
/// item.
///
/// Support for this resource MUST be indicated by the server by advertising the
/// "QUOTA=RES-MESSAGE" capability.
pub const MESSAGE: Self = Resource(Inner::Message);
/// The number of mailboxes governed by the quota root.
///
/// This MUST be an exact number; however, clients MUST NOT assume that a change in the usage
/// indicates a change in the number of mailboxes, since the quota root may include mailboxes
/// the client has no access to.
///
/// Support for this resource MUST be indicated by the server by advertising the
/// "QUOTA=RES-MAILBOX" capability.
pub const MAILBOX: Self = Resource(Inner::Mailbox);
/// The maximum size of all annotations \[RFC5257\], in units of 1024 octets, associated with all
/// messages in the mailboxes governed by the quota root.
///
/// Support for this resource MUST be indicated by the server by advertising the
/// "QUOTA=RES-ANNOTATION-STORAGE" capability.
pub const ANNOTATION_STORAGE: Self = Resource(Inner::AnnotationStorage);
}
#[cfg_attr(feature = "bounded-static", derive(ToStatic))]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
enum Inner<'a> {
Storage,
Message,
Mailbox,
AnnotationStorage,
Other(Atom<'a>),
}
impl_try_from!(Atom<'a>, 'a, &'a [u8], Resource<'a>);
impl_try_from!(Atom<'a>, 'a, Vec<u8>, Resource<'a>);
impl_try_from!(Atom<'a>, 'a, &'a str, Resource<'a>);
impl_try_from!(Atom<'a>, 'a, String, Resource<'a>);
impl_try_from!(Atom<'a>, 'a, Cow<'a, str>, Resource<'a>);
impl<'a> From<Atom<'a>> for Resource<'a> {
fn from(atom: Atom<'a>) -> Self {
match atom.inner().to_ascii_uppercase().as_ref() {
"STORAGE" => Resource::STORAGE,
"MESSAGE" => Resource::MESSAGE,
"MAILBOX" => Resource::MAILBOX,
"ANNOTATION-STORAGE" => Resource::ANNOTATION_STORAGE,
_ => Resource(Inner::Other(atom)),
}
}
}
impl<'a> Display for Resource<'a> {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
f.write_str(match &self.0 {
Inner::Storage => "STORAGE",
Inner::Message => "MESSAGE",
Inner::Mailbox => "MAILBOX",
Inner::AnnotationStorage => "ANNOTATION-STORAGE",
Inner::Other(atom) => atom.as_ref(),
})
}
}
/// A type that holds a resource name, usage, and limit.
/// Used in the response of the GETQUOTA command.
#[cfg_attr(feature = "arbitrary", derive(Arbitrary))]
#[cfg_attr(feature = "bounded-static", derive(ToStatic))]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct QuotaGet<'a> {
pub resource: Resource<'a>,
pub usage: u64,
pub limit: u64,
}
impl<'a> QuotaGet<'a> {
pub fn new(resource: Resource<'a>, usage: u64, limit: u64) -> Self {
Self {
resource,
usage,
limit,
}
}
}
/// A type that holds a resource name and limit.
/// Used in the SETQUOTA command.
#[cfg_attr(feature = "arbitrary", derive(Arbitrary))]
#[cfg_attr(feature = "bounded-static", derive(ToStatic))]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct QuotaSet<'a> {
pub resource: Resource<'a>,
pub limit: u64,
}
impl<'a> QuotaSet<'a> {
pub fn new(resource: Resource<'a>, limit: u64) -> Self {
Self { resource, limit }
}
}
#[derive(Clone, Debug, Eq, Error, Hash, Ord, PartialEq, PartialOrd)]
pub enum QuotaError<R, Q> {
#[error("Invalid root: {0}")]
Root(R),
#[error("Invalid quotas: {0}")]
Quotas(Q),
}
#[derive(Clone, Debug, Eq, Error, Hash, Ord, PartialEq, PartialOrd)]
pub enum QuotaRootError<M, R> {
#[error("Invalid mailbox: {0}")]
Mailbox(M),
#[error("Invalid roots: {0}")]
Roots(R),
}
#[derive(Clone, Debug, Eq, Error, Hash, Ord, PartialEq, PartialOrd)]
pub enum SetQuotaError<R, S> {
#[error("Invalid root: {0}")]
Root(R),
#[error("Invalid quota set: {0}")]
QuotaSet(S),
}