MailKit.xml 3.1 MB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484134851348613487134881348913490134911349213493134941349513496134971349813499135001350113502135031350413505135061350713508135091351013511135121351313514135151351613517135181351913520135211352213523135241352513526135271352813529135301353113532135331353413535135361353713538135391354013541135421354313544135451354613547135481354913550135511355213553135541355513556135571355813559135601356113562135631356413565135661356713568135691357013571135721357313574135751357613577135781357913580135811358213583135841358513586135871358813589135901359113592135931359413595135961359713598135991360013601136021360313604136051360613607136081360913610136111361213613136141361513616136171361813619136201362113622136231362413625136261362713628136291363013631136321363313634136351363613637136381363913640136411364213643136441364513646136471364813649136501365113652136531365413655136561365713658136591366013661136621366313664136651366613667136681366913670136711367213673136741367513676136771367813679136801368113682136831368413685136861368713688136891369013691136921369313694136951369613697136981369913700137011370213703137041370513706137071370813709137101371113712137131371413715137161371713718137191372013721137221372313724137251372613727137281372913730137311373213733137341373513736137371373813739137401374113742137431374413745137461374713748137491375013751137521375313754137551375613757137581375913760137611376213763137641376513766137671376813769137701377113772137731377413775137761377713778137791378013781137821378313784137851378613787137881378913790137911379213793137941379513796137971379813799138001380113802138031380413805138061380713808138091381013811138121381313814138151381613817138181381913820138211382213823138241382513826138271382813829138301383113832138331383413835138361383713838138391384013841138421384313844138451384613847138481384913850138511385213853138541385513856138571385813859138601386113862138631386413865138661386713868138691387013871138721387313874138751387613877138781387913880138811388213883138841388513886138871388813889138901389113892138931389413895138961389713898138991390013901139021390313904139051390613907139081390913910139111391213913139141391513916139171391813919139201392113922139231392413925139261392713928139291393013931139321393313934139351393613937139381393913940139411394213943139441394513946139471394813949139501395113952139531395413955139561395713958139591396013961139621396313964139651396613967139681396913970139711397213973139741397513976139771397813979139801398113982139831398413985139861398713988139891399013991139921399313994139951399613997139981399914000140011400214003140041400514006140071400814009140101401114012140131401414015140161401714018140191402014021140221402314024140251402614027140281402914030140311403214033140341403514036140371403814039140401404114042140431404414045140461404714048140491405014051140521405314054140551405614057140581405914060140611406214063140641406514066140671406814069140701407114072140731407414075140761407714078140791408014081140821408314084140851408614087140881408914090140911409214093140941409514096140971409814099141001410114102141031410414105141061410714108141091411014111141121411314114141151411614117141181411914120141211412214123141241412514126141271412814129141301413114132141331413414135141361413714138141391414014141141421414314144141451414614147141481414914150141511415214153141541415514156141571415814159141601416114162141631416414165141661416714168141691417014171141721417314174141751417614177141781417914180141811418214183141841418514186141871418814189141901419114192141931419414195141961419714198141991420014201142021420314204142051420614207142081420914210142111421214213142141421514216142171421814219142201422114222142231422414225142261422714228142291423014231142321423314234142351423614237142381423914240142411424214243142441424514246142471424814249142501425114252142531425414255142561425714258142591426014261142621426314264142651426614267142681426914270142711427214273142741427514276142771427814279142801428114282142831428414285142861428714288142891429014291142921429314294142951429614297142981429914300143011430214303143041430514306143071430814309143101431114312143131431414315143161431714318143191432014321143221432314324143251432614327143281432914330143311433214333143341433514336143371433814339143401434114342143431434414345143461434714348143491435014351143521435314354143551435614357143581435914360143611436214363143641436514366143671436814369143701437114372143731437414375143761437714378143791438014381143821438314384143851438614387143881438914390143911439214393143941439514396143971439814399144001440114402144031440414405144061440714408144091441014411144121441314414144151441614417144181441914420144211442214423144241442514426144271442814429144301443114432144331443414435144361443714438144391444014441144421444314444144451444614447144481444914450144511445214453144541445514456144571445814459144601446114462144631446414465144661446714468144691447014471144721447314474144751447614477144781447914480144811448214483144841448514486144871448814489144901449114492144931449414495144961449714498144991450014501145021450314504145051450614507145081450914510145111451214513145141451514516145171451814519145201452114522145231452414525145261452714528145291453014531145321453314534145351453614537145381453914540145411454214543145441454514546145471454814549145501455114552145531455414555145561455714558145591456014561145621456314564145651456614567145681456914570145711457214573145741457514576145771457814579145801458114582145831458414585145861458714588145891459014591145921459314594145951459614597145981459914600146011460214603146041460514606146071460814609146101461114612146131461414615146161461714618146191462014621146221462314624146251462614627146281462914630146311463214633146341463514636146371463814639146401464114642146431464414645146461464714648146491465014651146521465314654146551465614657146581465914660146611466214663146641466514666146671466814669146701467114672146731467414675146761467714678146791468014681146821468314684146851468614687146881468914690146911469214693146941469514696146971469814699147001470114702147031470414705147061470714708147091471014711147121471314714147151471614717147181471914720147211472214723147241472514726147271472814729147301473114732147331473414735147361473714738147391474014741147421474314744147451474614747147481474914750147511475214753147541475514756147571475814759147601476114762147631476414765147661476714768147691477014771147721477314774147751477614777147781477914780147811478214783147841478514786147871478814789147901479114792147931479414795147961479714798147991480014801148021480314804148051480614807148081480914810148111481214813148141481514816148171481814819148201482114822148231482414825148261482714828148291483014831148321483314834148351483614837148381483914840148411484214843148441484514846148471484814849148501485114852148531485414855148561485714858148591486014861148621486314864148651486614867148681486914870148711487214873148741487514876148771487814879148801488114882148831488414885148861488714888148891489014891148921489314894148951489614897148981489914900149011490214903149041490514906149071490814909149101491114912149131491414915149161491714918149191492014921149221492314924149251492614927149281492914930149311493214933149341493514936149371493814939149401494114942149431494414945149461494714948149491495014951149521495314954149551495614957149581495914960149611496214963149641496514966149671496814969149701497114972149731497414975149761497714978149791498014981149821498314984149851498614987149881498914990149911499214993149941499514996149971499814999150001500115002150031500415005150061500715008150091501015011150121501315014150151501615017150181501915020150211502215023150241502515026150271502815029150301503115032150331503415035150361503715038150391504015041150421504315044150451504615047150481504915050150511505215053150541505515056150571505815059150601506115062150631506415065150661506715068150691507015071150721507315074150751507615077150781507915080150811508215083150841508515086150871508815089150901509115092150931509415095150961509715098150991510015101151021510315104151051510615107151081510915110151111511215113151141511515116151171511815119151201512115122151231512415125151261512715128151291513015131151321513315134151351513615137151381513915140151411514215143151441514515146151471514815149151501515115152151531515415155151561515715158151591516015161151621516315164151651516615167151681516915170151711517215173151741517515176151771517815179151801518115182151831518415185151861518715188151891519015191151921519315194151951519615197151981519915200152011520215203152041520515206152071520815209152101521115212152131521415215152161521715218152191522015221152221522315224152251522615227152281522915230152311523215233152341523515236152371523815239152401524115242152431524415245152461524715248152491525015251152521525315254152551525615257152581525915260152611526215263152641526515266152671526815269152701527115272152731527415275152761527715278152791528015281152821528315284152851528615287152881528915290152911529215293152941529515296152971529815299153001530115302153031530415305153061530715308153091531015311153121531315314153151531615317153181531915320153211532215323153241532515326153271532815329153301533115332153331533415335153361533715338153391534015341153421534315344153451534615347153481534915350153511535215353153541535515356153571535815359153601536115362153631536415365153661536715368153691537015371153721537315374153751537615377153781537915380153811538215383153841538515386153871538815389153901539115392153931539415395153961539715398153991540015401154021540315404154051540615407154081540915410154111541215413154141541515416154171541815419154201542115422154231542415425154261542715428154291543015431154321543315434154351543615437154381543915440154411544215443154441544515446154471544815449154501545115452154531545415455154561545715458154591546015461154621546315464154651546615467154681546915470154711547215473154741547515476154771547815479154801548115482154831548415485154861548715488154891549015491154921549315494154951549615497154981549915500155011550215503155041550515506155071550815509155101551115512155131551415515155161551715518155191552015521155221552315524155251552615527155281552915530155311553215533155341553515536155371553815539155401554115542155431554415545155461554715548155491555015551155521555315554155551555615557155581555915560155611556215563155641556515566155671556815569155701557115572155731557415575155761557715578155791558015581155821558315584155851558615587155881558915590155911559215593155941559515596155971559815599156001560115602156031560415605156061560715608156091561015611156121561315614156151561615617156181561915620156211562215623156241562515626156271562815629156301563115632156331563415635156361563715638156391564015641156421564315644156451564615647156481564915650156511565215653156541565515656156571565815659156601566115662156631566415665156661566715668156691567015671156721567315674156751567615677156781567915680156811568215683156841568515686156871568815689156901569115692156931569415695156961569715698156991570015701157021570315704157051570615707157081570915710157111571215713157141571515716157171571815719157201572115722157231572415725157261572715728157291573015731157321573315734157351573615737157381573915740157411574215743157441574515746157471574815749157501575115752157531575415755157561575715758157591576015761157621576315764157651576615767157681576915770157711577215773157741577515776157771577815779157801578115782157831578415785157861578715788157891579015791157921579315794157951579615797157981579915800158011580215803158041580515806158071580815809158101581115812158131581415815158161581715818158191582015821158221582315824158251582615827158281582915830158311583215833158341583515836158371583815839158401584115842158431584415845158461584715848158491585015851158521585315854158551585615857158581585915860158611586215863158641586515866158671586815869158701587115872158731587415875158761587715878158791588015881158821588315884158851588615887158881588915890158911589215893158941589515896158971589815899159001590115902159031590415905159061590715908159091591015911159121591315914159151591615917159181591915920159211592215923159241592515926159271592815929159301593115932159331593415935159361593715938159391594015941159421594315944159451594615947159481594915950159511595215953159541595515956159571595815959159601596115962159631596415965159661596715968159691597015971159721597315974159751597615977159781597915980159811598215983159841598515986159871598815989159901599115992159931599415995159961599715998159991600016001160021600316004160051600616007160081600916010160111601216013160141601516016160171601816019160201602116022160231602416025160261602716028160291603016031160321603316034160351603616037160381603916040160411604216043160441604516046160471604816049160501605116052160531605416055160561605716058160591606016061160621606316064160651606616067160681606916070160711607216073160741607516076160771607816079160801608116082160831608416085160861608716088160891609016091160921609316094160951609616097160981609916100161011610216103161041610516106161071610816109161101611116112161131611416115161161611716118161191612016121161221612316124161251612616127161281612916130161311613216133161341613516136161371613816139161401614116142161431614416145161461614716148161491615016151161521615316154161551615616157161581615916160161611616216163161641616516166161671616816169161701617116172161731617416175161761617716178161791618016181161821618316184161851618616187161881618916190161911619216193161941619516196161971619816199162001620116202162031620416205162061620716208162091621016211162121621316214162151621616217162181621916220162211622216223162241622516226162271622816229162301623116232162331623416235162361623716238162391624016241162421624316244162451624616247162481624916250162511625216253162541625516256162571625816259162601626116262162631626416265162661626716268162691627016271162721627316274162751627616277162781627916280162811628216283162841628516286162871628816289162901629116292162931629416295162961629716298162991630016301163021630316304163051630616307163081630916310163111631216313163141631516316163171631816319163201632116322163231632416325163261632716328163291633016331163321633316334163351633616337163381633916340163411634216343163441634516346163471634816349163501635116352163531635416355163561635716358163591636016361163621636316364163651636616367163681636916370163711637216373163741637516376163771637816379163801638116382163831638416385163861638716388163891639016391163921639316394163951639616397163981639916400164011640216403164041640516406164071640816409164101641116412164131641416415164161641716418164191642016421164221642316424164251642616427164281642916430164311643216433164341643516436164371643816439164401644116442164431644416445164461644716448164491645016451164521645316454164551645616457164581645916460164611646216463164641646516466164671646816469164701647116472164731647416475164761647716478164791648016481164821648316484164851648616487164881648916490164911649216493164941649516496164971649816499165001650116502165031650416505165061650716508165091651016511165121651316514165151651616517165181651916520165211652216523165241652516526165271652816529165301653116532165331653416535165361653716538165391654016541165421654316544165451654616547165481654916550165511655216553165541655516556165571655816559165601656116562165631656416565165661656716568165691657016571165721657316574165751657616577165781657916580165811658216583165841658516586165871658816589165901659116592165931659416595165961659716598165991660016601166021660316604166051660616607166081660916610166111661216613166141661516616166171661816619166201662116622166231662416625166261662716628166291663016631166321663316634166351663616637166381663916640166411664216643166441664516646166471664816649166501665116652166531665416655166561665716658166591666016661166621666316664166651666616667166681666916670166711667216673166741667516676166771667816679166801668116682166831668416685166861668716688166891669016691166921669316694166951669616697166981669916700167011670216703167041670516706167071670816709167101671116712167131671416715167161671716718167191672016721167221672316724167251672616727167281672916730167311673216733167341673516736167371673816739167401674116742167431674416745167461674716748167491675016751167521675316754167551675616757167581675916760167611676216763167641676516766167671676816769167701677116772167731677416775167761677716778167791678016781167821678316784167851678616787167881678916790167911679216793167941679516796167971679816799168001680116802168031680416805168061680716808168091681016811168121681316814168151681616817168181681916820168211682216823168241682516826168271682816829168301683116832168331683416835168361683716838168391684016841168421684316844168451684616847168481684916850168511685216853168541685516856168571685816859168601686116862168631686416865168661686716868168691687016871168721687316874168751687616877168781687916880168811688216883168841688516886168871688816889168901689116892168931689416895168961689716898168991690016901169021690316904169051690616907169081690916910169111691216913169141691516916169171691816919169201692116922169231692416925169261692716928169291693016931169321693316934169351693616937169381693916940169411694216943169441694516946169471694816949169501695116952169531695416955169561695716958169591696016961169621696316964169651696616967169681696916970169711697216973169741697516976169771697816979169801698116982169831698416985169861698716988169891699016991169921699316994169951699616997169981699917000170011700217003170041700517006170071700817009170101701117012170131701417015170161701717018170191702017021170221702317024170251702617027170281702917030170311703217033170341703517036170371703817039170401704117042170431704417045170461704717048170491705017051170521705317054170551705617057170581705917060170611706217063170641706517066170671706817069170701707117072170731707417075170761707717078170791708017081170821708317084170851708617087170881708917090170911709217093170941709517096170971709817099171001710117102171031710417105171061710717108171091711017111171121711317114171151711617117171181711917120171211712217123171241712517126171271712817129171301713117132171331713417135171361713717138171391714017141171421714317144171451714617147171481714917150171511715217153171541715517156171571715817159171601716117162171631716417165171661716717168171691717017171171721717317174171751717617177171781717917180171811718217183171841718517186171871718817189171901719117192171931719417195171961719717198171991720017201172021720317204172051720617207172081720917210172111721217213172141721517216172171721817219172201722117222172231722417225172261722717228172291723017231172321723317234172351723617237172381723917240172411724217243172441724517246172471724817249172501725117252172531725417255172561725717258172591726017261172621726317264172651726617267172681726917270172711727217273172741727517276172771727817279172801728117282172831728417285172861728717288172891729017291172921729317294172951729617297172981729917300173011730217303173041730517306173071730817309173101731117312173131731417315173161731717318173191732017321173221732317324173251732617327173281732917330173311733217333173341733517336173371733817339173401734117342173431734417345173461734717348173491735017351173521735317354173551735617357173581735917360173611736217363173641736517366173671736817369173701737117372173731737417375173761737717378173791738017381173821738317384173851738617387173881738917390173911739217393173941739517396173971739817399174001740117402174031740417405174061740717408174091741017411174121741317414174151741617417174181741917420174211742217423174241742517426174271742817429174301743117432174331743417435174361743717438174391744017441174421744317444174451744617447174481744917450174511745217453174541745517456174571745817459174601746117462174631746417465174661746717468174691747017471174721747317474174751747617477174781747917480174811748217483174841748517486174871748817489174901749117492174931749417495174961749717498174991750017501175021750317504175051750617507175081750917510175111751217513175141751517516175171751817519175201752117522175231752417525175261752717528175291753017531175321753317534175351753617537175381753917540175411754217543175441754517546175471754817549175501755117552175531755417555175561755717558175591756017561175621756317564175651756617567175681756917570175711757217573175741757517576175771757817579175801758117582175831758417585175861758717588175891759017591175921759317594175951759617597175981759917600176011760217603176041760517606176071760817609176101761117612176131761417615176161761717618176191762017621176221762317624176251762617627176281762917630176311763217633176341763517636176371763817639176401764117642176431764417645176461764717648176491765017651176521765317654176551765617657176581765917660176611766217663176641766517666176671766817669176701767117672176731767417675176761767717678176791768017681176821768317684176851768617687176881768917690176911769217693176941769517696176971769817699177001770117702177031770417705177061770717708177091771017711177121771317714177151771617717177181771917720177211772217723177241772517726177271772817729177301773117732177331773417735177361773717738177391774017741177421774317744177451774617747177481774917750177511775217753177541775517756177571775817759177601776117762177631776417765177661776717768177691777017771177721777317774177751777617777177781777917780177811778217783177841778517786177871778817789177901779117792177931779417795177961779717798177991780017801178021780317804178051780617807178081780917810178111781217813178141781517816178171781817819178201782117822178231782417825178261782717828178291783017831178321783317834178351783617837178381783917840178411784217843178441784517846178471784817849178501785117852178531785417855178561785717858178591786017861178621786317864178651786617867178681786917870178711787217873178741787517876178771787817879178801788117882178831788417885178861788717888178891789017891178921789317894178951789617897178981789917900179011790217903179041790517906179071790817909179101791117912179131791417915179161791717918179191792017921179221792317924179251792617927179281792917930179311793217933179341793517936179371793817939179401794117942179431794417945179461794717948179491795017951179521795317954179551795617957179581795917960179611796217963179641796517966179671796817969179701797117972179731797417975179761797717978179791798017981179821798317984179851798617987179881798917990179911799217993179941799517996179971799817999180001800118002180031800418005180061800718008180091801018011180121801318014180151801618017180181801918020180211802218023180241802518026180271802818029180301803118032180331803418035180361803718038180391804018041180421804318044180451804618047180481804918050180511805218053180541805518056180571805818059180601806118062180631806418065180661806718068180691807018071180721807318074180751807618077180781807918080180811808218083180841808518086180871808818089180901809118092180931809418095180961809718098180991810018101181021810318104181051810618107181081810918110181111811218113181141811518116181171811818119181201812118122181231812418125181261812718128181291813018131181321813318134181351813618137181381813918140181411814218143181441814518146181471814818149181501815118152181531815418155181561815718158181591816018161181621816318164181651816618167181681816918170181711817218173181741817518176181771817818179181801818118182181831818418185181861818718188181891819018191181921819318194181951819618197181981819918200182011820218203182041820518206182071820818209182101821118212182131821418215182161821718218182191822018221182221822318224182251822618227182281822918230182311823218233182341823518236182371823818239182401824118242182431824418245182461824718248182491825018251182521825318254182551825618257182581825918260182611826218263182641826518266182671826818269182701827118272182731827418275182761827718278182791828018281182821828318284182851828618287182881828918290182911829218293182941829518296182971829818299183001830118302183031830418305183061830718308183091831018311183121831318314183151831618317183181831918320183211832218323183241832518326183271832818329183301833118332183331833418335183361833718338183391834018341183421834318344183451834618347183481834918350183511835218353183541835518356183571835818359183601836118362183631836418365183661836718368183691837018371183721837318374183751837618377183781837918380183811838218383183841838518386183871838818389183901839118392183931839418395183961839718398183991840018401184021840318404184051840618407184081840918410184111841218413184141841518416184171841818419184201842118422184231842418425184261842718428184291843018431184321843318434184351843618437184381843918440184411844218443184441844518446184471844818449184501845118452184531845418455184561845718458184591846018461184621846318464184651846618467184681846918470184711847218473184741847518476184771847818479184801848118482184831848418485184861848718488184891849018491184921849318494184951849618497184981849918500185011850218503185041850518506185071850818509185101851118512185131851418515185161851718518185191852018521185221852318524185251852618527185281852918530185311853218533185341853518536185371853818539185401854118542185431854418545185461854718548185491855018551185521855318554185551855618557185581855918560185611856218563185641856518566185671856818569185701857118572185731857418575185761857718578185791858018581185821858318584185851858618587185881858918590185911859218593185941859518596185971859818599186001860118602186031860418605186061860718608186091861018611186121861318614186151861618617186181861918620186211862218623186241862518626186271862818629186301863118632186331863418635186361863718638186391864018641186421864318644186451864618647186481864918650186511865218653186541865518656186571865818659186601866118662186631866418665186661866718668186691867018671186721867318674186751867618677186781867918680186811868218683186841868518686186871868818689186901869118692186931869418695186961869718698186991870018701187021870318704187051870618707187081870918710187111871218713187141871518716187171871818719187201872118722187231872418725187261872718728187291873018731187321873318734187351873618737187381873918740187411874218743187441874518746187471874818749187501875118752187531875418755187561875718758187591876018761187621876318764187651876618767187681876918770187711877218773187741877518776187771877818779187801878118782187831878418785187861878718788187891879018791187921879318794187951879618797187981879918800188011880218803188041880518806188071880818809188101881118812188131881418815188161881718818188191882018821188221882318824188251882618827188281882918830188311883218833188341883518836188371883818839188401884118842188431884418845188461884718848188491885018851188521885318854188551885618857188581885918860188611886218863188641886518866188671886818869188701887118872188731887418875188761887718878188791888018881188821888318884188851888618887188881888918890188911889218893188941889518896188971889818899189001890118902189031890418905189061890718908189091891018911189121891318914189151891618917189181891918920189211892218923189241892518926189271892818929189301893118932189331893418935189361893718938189391894018941189421894318944189451894618947189481894918950189511895218953189541895518956189571895818959189601896118962189631896418965189661896718968189691897018971189721897318974189751897618977189781897918980189811898218983189841898518986189871898818989189901899118992189931899418995189961899718998189991900019001190021900319004190051900619007190081900919010190111901219013190141901519016190171901819019190201902119022190231902419025190261902719028190291903019031190321903319034190351903619037190381903919040190411904219043190441904519046190471904819049190501905119052190531905419055190561905719058190591906019061190621906319064190651906619067190681906919070190711907219073190741907519076190771907819079190801908119082190831908419085190861908719088190891909019091190921909319094190951909619097190981909919100191011910219103191041910519106191071910819109191101911119112191131911419115191161911719118191191912019121191221912319124191251912619127191281912919130191311913219133191341913519136191371913819139191401914119142191431914419145191461914719148191491915019151191521915319154191551915619157191581915919160191611916219163191641916519166191671916819169191701917119172191731917419175191761917719178191791918019181191821918319184191851918619187191881918919190191911919219193191941919519196191971919819199192001920119202192031920419205192061920719208192091921019211192121921319214192151921619217192181921919220192211922219223192241922519226192271922819229192301923119232192331923419235192361923719238192391924019241192421924319244192451924619247192481924919250192511925219253192541925519256192571925819259192601926119262192631926419265192661926719268192691927019271192721927319274192751927619277192781927919280192811928219283192841928519286192871928819289192901929119292192931929419295192961929719298192991930019301193021930319304193051930619307193081930919310193111931219313193141931519316193171931819319193201932119322193231932419325193261932719328193291933019331193321933319334193351933619337193381933919340193411934219343193441934519346193471934819349193501935119352193531935419355193561935719358193591936019361193621936319364193651936619367193681936919370193711937219373193741937519376193771937819379193801938119382193831938419385193861938719388193891939019391193921939319394193951939619397193981939919400194011940219403194041940519406194071940819409194101941119412194131941419415194161941719418194191942019421194221942319424194251942619427194281942919430194311943219433194341943519436194371943819439194401944119442194431944419445194461944719448194491945019451194521945319454194551945619457194581945919460194611946219463194641946519466194671946819469194701947119472194731947419475194761947719478194791948019481194821948319484194851948619487194881948919490194911949219493194941949519496194971949819499195001950119502195031950419505195061950719508195091951019511195121951319514195151951619517195181951919520195211952219523195241952519526195271952819529195301953119532195331953419535195361953719538195391954019541195421954319544195451954619547195481954919550195511955219553195541955519556195571955819559195601956119562195631956419565195661956719568195691957019571195721957319574195751957619577195781957919580195811958219583195841958519586195871958819589195901959119592195931959419595195961959719598195991960019601196021960319604196051960619607196081960919610196111961219613196141961519616196171961819619196201962119622196231962419625196261962719628196291963019631196321963319634196351963619637196381963919640196411964219643196441964519646196471964819649196501965119652196531965419655196561965719658196591966019661196621966319664196651966619667196681966919670196711967219673196741967519676196771967819679196801968119682196831968419685196861968719688196891969019691196921969319694196951969619697196981969919700197011970219703197041970519706197071970819709197101971119712197131971419715197161971719718197191972019721197221972319724197251972619727197281972919730197311973219733197341973519736197371973819739197401974119742197431974419745197461974719748197491975019751197521975319754197551975619757197581975919760197611976219763197641976519766197671976819769197701977119772197731977419775197761977719778197791978019781197821978319784197851978619787197881978919790197911979219793197941979519796197971979819799198001980119802198031980419805198061980719808198091981019811198121981319814198151981619817198181981919820198211982219823198241982519826198271982819829198301983119832198331983419835198361983719838198391984019841198421984319844198451984619847198481984919850198511985219853198541985519856198571985819859198601986119862198631986419865198661986719868198691987019871198721987319874198751987619877198781987919880198811988219883198841988519886198871988819889198901989119892198931989419895198961989719898198991990019901199021990319904199051990619907199081990919910199111991219913199141991519916199171991819919199201992119922199231992419925199261992719928199291993019931199321993319934199351993619937199381993919940199411994219943199441994519946199471994819949199501995119952199531995419955199561995719958199591996019961199621996319964199651996619967199681996919970199711997219973199741997519976199771997819979199801998119982199831998419985199861998719988199891999019991199921999319994199951999619997199981999920000200012000220003200042000520006200072000820009200102001120012200132001420015200162001720018200192002020021200222002320024200252002620027200282002920030200312003220033200342003520036200372003820039200402004120042200432004420045200462004720048200492005020051200522005320054200552005620057200582005920060200612006220063200642006520066200672006820069200702007120072200732007420075200762007720078200792008020081200822008320084200852008620087200882008920090200912009220093200942009520096200972009820099201002010120102201032010420105201062010720108201092011020111201122011320114201152011620117201182011920120201212012220123201242012520126201272012820129201302013120132201332013420135201362013720138201392014020141201422014320144201452014620147201482014920150201512015220153201542015520156201572015820159201602016120162201632016420165201662016720168201692017020171201722017320174201752017620177201782017920180201812018220183201842018520186201872018820189201902019120192201932019420195201962019720198201992020020201202022020320204202052020620207202082020920210202112021220213202142021520216202172021820219202202022120222202232022420225202262022720228202292023020231202322023320234202352023620237202382023920240202412024220243202442024520246202472024820249202502025120252202532025420255202562025720258202592026020261202622026320264202652026620267202682026920270202712027220273202742027520276202772027820279202802028120282202832028420285202862028720288202892029020291202922029320294202952029620297202982029920300203012030220303203042030520306203072030820309203102031120312203132031420315203162031720318203192032020321203222032320324203252032620327203282032920330203312033220333203342033520336203372033820339203402034120342203432034420345203462034720348203492035020351203522035320354203552035620357203582035920360203612036220363203642036520366203672036820369203702037120372203732037420375203762037720378203792038020381203822038320384203852038620387203882038920390203912039220393203942039520396203972039820399204002040120402204032040420405204062040720408204092041020411204122041320414204152041620417204182041920420204212042220423204242042520426204272042820429204302043120432204332043420435204362043720438204392044020441204422044320444204452044620447204482044920450204512045220453204542045520456204572045820459204602046120462204632046420465204662046720468204692047020471204722047320474204752047620477204782047920480204812048220483204842048520486204872048820489204902049120492204932049420495204962049720498204992050020501205022050320504205052050620507205082050920510205112051220513205142051520516205172051820519205202052120522205232052420525205262052720528205292053020531205322053320534205352053620537205382053920540205412054220543205442054520546205472054820549205502055120552205532055420555205562055720558205592056020561205622056320564205652056620567205682056920570205712057220573205742057520576205772057820579205802058120582205832058420585205862058720588205892059020591205922059320594205952059620597205982059920600206012060220603206042060520606206072060820609206102061120612206132061420615206162061720618206192062020621206222062320624206252062620627206282062920630206312063220633206342063520636206372063820639206402064120642206432064420645206462064720648206492065020651206522065320654206552065620657206582065920660206612066220663206642066520666206672066820669206702067120672206732067420675206762067720678206792068020681206822068320684206852068620687206882068920690206912069220693206942069520696206972069820699207002070120702207032070420705207062070720708207092071020711207122071320714207152071620717207182071920720207212072220723207242072520726207272072820729207302073120732207332073420735207362073720738207392074020741207422074320744207452074620747207482074920750207512075220753207542075520756207572075820759207602076120762207632076420765207662076720768207692077020771207722077320774207752077620777207782077920780207812078220783207842078520786207872078820789207902079120792207932079420795207962079720798207992080020801208022080320804208052080620807208082080920810208112081220813208142081520816208172081820819208202082120822208232082420825208262082720828208292083020831208322083320834208352083620837208382083920840208412084220843208442084520846208472084820849208502085120852208532085420855208562085720858208592086020861208622086320864208652086620867208682086920870208712087220873208742087520876208772087820879208802088120882208832088420885208862088720888208892089020891208922089320894208952089620897208982089920900209012090220903209042090520906209072090820909209102091120912209132091420915209162091720918209192092020921209222092320924209252092620927209282092920930209312093220933209342093520936209372093820939209402094120942209432094420945209462094720948209492095020951209522095320954209552095620957209582095920960209612096220963209642096520966209672096820969209702097120972209732097420975209762097720978209792098020981209822098320984209852098620987209882098920990209912099220993209942099520996209972099820999210002100121002210032100421005210062100721008210092101021011210122101321014210152101621017210182101921020210212102221023210242102521026210272102821029210302103121032210332103421035210362103721038210392104021041210422104321044210452104621047210482104921050210512105221053210542105521056210572105821059210602106121062210632106421065210662106721068210692107021071210722107321074210752107621077210782107921080210812108221083210842108521086210872108821089210902109121092210932109421095210962109721098210992110021101211022110321104211052110621107211082110921110211112111221113211142111521116211172111821119211202112121122211232112421125211262112721128211292113021131211322113321134211352113621137211382113921140211412114221143211442114521146211472114821149211502115121152211532115421155211562115721158211592116021161211622116321164211652116621167211682116921170211712117221173211742117521176211772117821179211802118121182211832118421185211862118721188211892119021191211922119321194211952119621197211982119921200212012120221203212042120521206212072120821209212102121121212212132121421215212162121721218212192122021221212222122321224212252122621227212282122921230212312123221233212342123521236212372123821239212402124121242212432124421245212462124721248212492125021251212522125321254212552125621257212582125921260212612126221263212642126521266212672126821269212702127121272212732127421275212762127721278212792128021281212822128321284212852128621287212882128921290212912129221293212942129521296212972129821299213002130121302213032130421305213062130721308213092131021311213122131321314213152131621317213182131921320213212132221323213242132521326213272132821329213302133121332213332133421335213362133721338213392134021341213422134321344213452134621347213482134921350213512135221353213542135521356213572135821359213602136121362213632136421365213662136721368213692137021371213722137321374213752137621377213782137921380213812138221383213842138521386213872138821389213902139121392213932139421395213962139721398213992140021401214022140321404214052140621407214082140921410214112141221413214142141521416214172141821419214202142121422214232142421425214262142721428214292143021431214322143321434214352143621437214382143921440214412144221443214442144521446214472144821449214502145121452214532145421455214562145721458214592146021461214622146321464214652146621467214682146921470214712147221473214742147521476214772147821479214802148121482214832148421485214862148721488214892149021491214922149321494214952149621497214982149921500215012150221503215042150521506215072150821509215102151121512215132151421515215162151721518215192152021521215222152321524215252152621527215282152921530215312153221533215342153521536215372153821539215402154121542215432154421545215462154721548215492155021551215522155321554215552155621557215582155921560215612156221563215642156521566215672156821569215702157121572215732157421575215762157721578215792158021581215822158321584215852158621587215882158921590215912159221593215942159521596215972159821599216002160121602216032160421605216062160721608216092161021611216122161321614216152161621617216182161921620216212162221623216242162521626216272162821629216302163121632216332163421635216362163721638216392164021641216422164321644216452164621647216482164921650216512165221653216542165521656216572165821659216602166121662216632166421665216662166721668216692167021671216722167321674216752167621677216782167921680216812168221683216842168521686216872168821689216902169121692216932169421695216962169721698216992170021701217022170321704217052170621707217082170921710217112171221713217142171521716217172171821719217202172121722217232172421725217262172721728217292173021731217322173321734217352173621737217382173921740217412174221743217442174521746217472174821749217502175121752217532175421755217562175721758217592176021761217622176321764217652176621767217682176921770217712177221773217742177521776217772177821779217802178121782217832178421785217862178721788217892179021791217922179321794217952179621797217982179921800218012180221803218042180521806218072180821809218102181121812218132181421815218162181721818218192182021821218222182321824218252182621827218282182921830218312183221833218342183521836218372183821839218402184121842218432184421845218462184721848218492185021851218522185321854218552185621857218582185921860218612186221863218642186521866218672186821869218702187121872218732187421875218762187721878218792188021881218822188321884218852188621887218882188921890218912189221893218942189521896218972189821899219002190121902219032190421905219062190721908219092191021911219122191321914219152191621917219182191921920219212192221923219242192521926219272192821929219302193121932219332193421935219362193721938219392194021941219422194321944219452194621947219482194921950219512195221953219542195521956219572195821959219602196121962219632196421965219662196721968219692197021971219722197321974219752197621977219782197921980219812198221983219842198521986219872198821989219902199121992219932199421995219962199721998219992200022001220022200322004220052200622007220082200922010220112201222013220142201522016220172201822019220202202122022220232202422025220262202722028220292203022031220322203322034220352203622037220382203922040220412204222043220442204522046220472204822049220502205122052220532205422055220562205722058220592206022061220622206322064220652206622067220682206922070220712207222073220742207522076220772207822079220802208122082220832208422085220862208722088220892209022091220922209322094220952209622097220982209922100221012210222103221042210522106221072210822109221102211122112221132211422115221162211722118221192212022121221222212322124221252212622127221282212922130221312213222133221342213522136221372213822139221402214122142221432214422145221462214722148221492215022151221522215322154221552215622157221582215922160221612216222163221642216522166221672216822169221702217122172221732217422175221762217722178221792218022181221822218322184221852218622187221882218922190221912219222193221942219522196221972219822199222002220122202222032220422205222062220722208222092221022211222122221322214222152221622217222182221922220222212222222223222242222522226222272222822229222302223122232222332223422235222362223722238222392224022241222422224322244222452224622247222482224922250222512225222253222542225522256222572225822259222602226122262222632226422265222662226722268222692227022271222722227322274222752227622277222782227922280222812228222283222842228522286222872228822289222902229122292222932229422295222962229722298222992230022301223022230322304223052230622307223082230922310223112231222313223142231522316223172231822319223202232122322223232232422325223262232722328223292233022331223322233322334223352233622337223382233922340223412234222343223442234522346223472234822349223502235122352223532235422355223562235722358223592236022361223622236322364223652236622367223682236922370223712237222373223742237522376223772237822379223802238122382223832238422385223862238722388223892239022391223922239322394223952239622397223982239922400224012240222403224042240522406224072240822409224102241122412224132241422415224162241722418224192242022421224222242322424224252242622427224282242922430224312243222433224342243522436224372243822439224402244122442224432244422445224462244722448224492245022451224522245322454224552245622457224582245922460224612246222463224642246522466224672246822469224702247122472224732247422475224762247722478224792248022481224822248322484224852248622487224882248922490224912249222493224942249522496224972249822499225002250122502225032250422505225062250722508225092251022511225122251322514225152251622517225182251922520225212252222523225242252522526225272252822529225302253122532225332253422535225362253722538225392254022541225422254322544225452254622547225482254922550225512255222553225542255522556225572255822559225602256122562225632256422565225662256722568225692257022571225722257322574225752257622577225782257922580225812258222583225842258522586225872258822589225902259122592225932259422595225962259722598225992260022601226022260322604226052260622607226082260922610226112261222613226142261522616226172261822619226202262122622226232262422625226262262722628226292263022631226322263322634226352263622637226382263922640226412264222643226442264522646226472264822649226502265122652226532265422655226562265722658226592266022661226622266322664226652266622667226682266922670226712267222673226742267522676226772267822679226802268122682226832268422685226862268722688226892269022691226922269322694226952269622697226982269922700227012270222703227042270522706227072270822709227102271122712227132271422715227162271722718227192272022721227222272322724227252272622727227282272922730227312273222733227342273522736227372273822739227402274122742227432274422745227462274722748227492275022751227522275322754227552275622757227582275922760227612276222763227642276522766227672276822769227702277122772227732277422775227762277722778227792278022781227822278322784227852278622787227882278922790227912279222793227942279522796227972279822799228002280122802228032280422805228062280722808228092281022811228122281322814228152281622817228182281922820228212282222823228242282522826228272282822829228302283122832228332283422835228362283722838228392284022841228422284322844228452284622847228482284922850228512285222853228542285522856228572285822859228602286122862228632286422865228662286722868228692287022871228722287322874228752287622877228782287922880228812288222883228842288522886228872288822889228902289122892228932289422895228962289722898228992290022901229022290322904229052290622907229082290922910229112291222913229142291522916229172291822919229202292122922229232292422925229262292722928229292293022931229322293322934229352293622937229382293922940229412294222943229442294522946229472294822949229502295122952229532295422955229562295722958229592296022961229622296322964229652296622967229682296922970229712297222973229742297522976229772297822979229802298122982229832298422985229862298722988229892299022991229922299322994229952299622997229982299923000230012300223003230042300523006230072300823009230102301123012230132301423015230162301723018230192302023021230222302323024230252302623027230282302923030230312303223033230342303523036230372303823039230402304123042230432304423045230462304723048230492305023051230522305323054230552305623057230582305923060230612306223063230642306523066230672306823069230702307123072230732307423075230762307723078230792308023081230822308323084230852308623087230882308923090230912309223093230942309523096230972309823099231002310123102231032310423105231062310723108231092311023111231122311323114231152311623117231182311923120231212312223123231242312523126231272312823129231302313123132231332313423135231362313723138231392314023141231422314323144231452314623147231482314923150231512315223153231542315523156231572315823159231602316123162231632316423165231662316723168231692317023171231722317323174231752317623177231782317923180231812318223183231842318523186231872318823189231902319123192231932319423195231962319723198231992320023201232022320323204232052320623207232082320923210232112321223213232142321523216232172321823219232202322123222232232322423225232262322723228232292323023231232322323323234232352323623237232382323923240232412324223243232442324523246232472324823249232502325123252232532325423255232562325723258232592326023261232622326323264232652326623267232682326923270232712327223273232742327523276232772327823279232802328123282232832328423285232862328723288232892329023291232922329323294232952329623297232982329923300233012330223303233042330523306233072330823309233102331123312233132331423315233162331723318233192332023321233222332323324233252332623327233282332923330233312333223333233342333523336233372333823339233402334123342233432334423345233462334723348233492335023351233522335323354233552335623357233582335923360233612336223363233642336523366233672336823369233702337123372233732337423375233762337723378233792338023381233822338323384233852338623387233882338923390233912339223393233942339523396233972339823399234002340123402234032340423405234062340723408234092341023411234122341323414234152341623417234182341923420234212342223423234242342523426234272342823429234302343123432234332343423435234362343723438234392344023441234422344323444234452344623447234482344923450234512345223453234542345523456234572345823459234602346123462234632346423465234662346723468234692347023471234722347323474234752347623477234782347923480234812348223483234842348523486234872348823489234902349123492234932349423495234962349723498234992350023501235022350323504235052350623507235082350923510235112351223513235142351523516235172351823519235202352123522235232352423525235262352723528235292353023531235322353323534235352353623537235382353923540235412354223543235442354523546235472354823549235502355123552235532355423555235562355723558235592356023561235622356323564235652356623567235682356923570235712357223573235742357523576235772357823579235802358123582235832358423585235862358723588235892359023591235922359323594235952359623597235982359923600236012360223603236042360523606236072360823609236102361123612236132361423615236162361723618236192362023621236222362323624236252362623627236282362923630236312363223633236342363523636236372363823639236402364123642236432364423645236462364723648236492365023651236522365323654236552365623657236582365923660236612366223663236642366523666236672366823669236702367123672236732367423675236762367723678236792368023681236822368323684236852368623687236882368923690236912369223693236942369523696236972369823699237002370123702237032370423705237062370723708237092371023711237122371323714237152371623717237182371923720237212372223723237242372523726237272372823729237302373123732237332373423735237362373723738237392374023741237422374323744237452374623747237482374923750237512375223753237542375523756237572375823759237602376123762237632376423765237662376723768237692377023771237722377323774237752377623777237782377923780237812378223783237842378523786237872378823789237902379123792237932379423795237962379723798237992380023801238022380323804238052380623807238082380923810238112381223813238142381523816238172381823819238202382123822238232382423825238262382723828238292383023831238322383323834238352383623837238382383923840238412384223843238442384523846238472384823849238502385123852238532385423855238562385723858238592386023861238622386323864238652386623867238682386923870238712387223873238742387523876238772387823879238802388123882238832388423885238862388723888238892389023891238922389323894238952389623897238982389923900239012390223903239042390523906239072390823909239102391123912239132391423915239162391723918239192392023921239222392323924239252392623927239282392923930239312393223933239342393523936239372393823939239402394123942239432394423945239462394723948239492395023951239522395323954239552395623957239582395923960239612396223963239642396523966239672396823969239702397123972239732397423975239762397723978239792398023981239822398323984239852398623987239882398923990239912399223993239942399523996239972399823999240002400124002240032400424005240062400724008240092401024011240122401324014240152401624017240182401924020240212402224023240242402524026240272402824029240302403124032240332403424035240362403724038240392404024041240422404324044240452404624047240482404924050240512405224053240542405524056240572405824059240602406124062240632406424065240662406724068240692407024071240722407324074240752407624077240782407924080240812408224083240842408524086240872408824089240902409124092240932409424095240962409724098240992410024101241022410324104241052410624107241082410924110241112411224113241142411524116241172411824119241202412124122241232412424125241262412724128241292413024131241322413324134241352413624137241382413924140241412414224143241442414524146241472414824149241502415124152241532415424155241562415724158241592416024161241622416324164241652416624167241682416924170241712417224173241742417524176241772417824179241802418124182241832418424185241862418724188241892419024191241922419324194241952419624197241982419924200242012420224203242042420524206242072420824209242102421124212242132421424215242162421724218242192422024221242222422324224242252422624227242282422924230242312423224233242342423524236242372423824239242402424124242242432424424245242462424724248242492425024251242522425324254242552425624257242582425924260242612426224263242642426524266242672426824269242702427124272242732427424275242762427724278242792428024281242822428324284242852428624287242882428924290242912429224293242942429524296242972429824299243002430124302243032430424305243062430724308243092431024311243122431324314243152431624317243182431924320243212432224323243242432524326243272432824329243302433124332243332433424335243362433724338243392434024341243422434324344243452434624347243482434924350243512435224353243542435524356243572435824359243602436124362243632436424365243662436724368243692437024371243722437324374243752437624377243782437924380243812438224383243842438524386243872438824389243902439124392243932439424395243962439724398243992440024401244022440324404244052440624407244082440924410244112441224413244142441524416244172441824419244202442124422244232442424425244262442724428244292443024431244322443324434244352443624437244382443924440244412444224443244442444524446244472444824449244502445124452244532445424455244562445724458244592446024461244622446324464244652446624467244682446924470244712447224473244742447524476244772447824479244802448124482244832448424485244862448724488244892449024491244922449324494244952449624497244982449924500245012450224503245042450524506245072450824509245102451124512245132451424515245162451724518245192452024521245222452324524245252452624527245282452924530245312453224533245342453524536245372453824539245402454124542245432454424545245462454724548245492455024551245522455324554245552455624557245582455924560245612456224563245642456524566245672456824569245702457124572245732457424575245762457724578245792458024581245822458324584245852458624587245882458924590245912459224593245942459524596245972459824599246002460124602246032460424605246062460724608246092461024611246122461324614246152461624617246182461924620246212462224623246242462524626246272462824629246302463124632246332463424635246362463724638246392464024641246422464324644246452464624647246482464924650246512465224653246542465524656246572465824659246602466124662246632466424665246662466724668246692467024671246722467324674246752467624677246782467924680246812468224683246842468524686246872468824689246902469124692246932469424695246962469724698246992470024701247022470324704247052470624707247082470924710247112471224713247142471524716247172471824719247202472124722247232472424725247262472724728247292473024731247322473324734247352473624737247382473924740247412474224743247442474524746247472474824749247502475124752247532475424755247562475724758247592476024761247622476324764247652476624767247682476924770247712477224773247742477524776247772477824779247802478124782247832478424785247862478724788247892479024791247922479324794247952479624797247982479924800248012480224803248042480524806248072480824809248102481124812248132481424815248162481724818248192482024821248222482324824248252482624827248282482924830248312483224833248342483524836248372483824839248402484124842248432484424845248462484724848248492485024851248522485324854248552485624857248582485924860248612486224863248642486524866248672486824869248702487124872248732487424875248762487724878248792488024881248822488324884248852488624887248882488924890248912489224893248942489524896248972489824899249002490124902249032490424905249062490724908249092491024911249122491324914249152491624917249182491924920249212492224923249242492524926249272492824929249302493124932249332493424935249362493724938249392494024941249422494324944249452494624947249482494924950249512495224953249542495524956249572495824959249602496124962249632496424965249662496724968249692497024971249722497324974249752497624977249782497924980249812498224983249842498524986249872498824989249902499124992249932499424995249962499724998249992500025001250022500325004250052500625007250082500925010250112501225013250142501525016250172501825019250202502125022250232502425025250262502725028250292503025031250322503325034250352503625037250382503925040250412504225043250442504525046250472504825049250502505125052250532505425055250562505725058250592506025061250622506325064250652506625067250682506925070250712507225073250742507525076250772507825079250802508125082250832508425085250862508725088250892509025091250922509325094250952509625097250982509925100251012510225103251042510525106251072510825109251102511125112251132511425115251162511725118251192512025121251222512325124251252512625127251282512925130251312513225133251342513525136251372513825139251402514125142251432514425145251462514725148251492515025151251522515325154251552515625157251582515925160251612516225163251642516525166251672516825169251702517125172251732517425175251762517725178251792518025181251822518325184251852518625187251882518925190251912519225193251942519525196251972519825199252002520125202252032520425205252062520725208252092521025211252122521325214252152521625217252182521925220252212522225223252242522525226252272522825229252302523125232252332523425235252362523725238252392524025241252422524325244252452524625247252482524925250252512525225253252542525525256252572525825259252602526125262252632526425265252662526725268252692527025271252722527325274252752527625277252782527925280252812528225283252842528525286252872528825289252902529125292252932529425295252962529725298252992530025301253022530325304253052530625307253082530925310253112531225313253142531525316253172531825319253202532125322253232532425325253262532725328253292533025331253322533325334253352533625337253382533925340253412534225343253442534525346253472534825349253502535125352253532535425355253562535725358253592536025361253622536325364253652536625367253682536925370253712537225373253742537525376253772537825379253802538125382253832538425385253862538725388253892539025391253922539325394253952539625397253982539925400254012540225403254042540525406254072540825409254102541125412254132541425415254162541725418254192542025421254222542325424254252542625427254282542925430254312543225433254342543525436254372543825439254402544125442254432544425445254462544725448254492545025451254522545325454254552545625457254582545925460254612546225463254642546525466254672546825469254702547125472254732547425475254762547725478254792548025481254822548325484254852548625487254882548925490254912549225493254942549525496254972549825499255002550125502255032550425505255062550725508255092551025511255122551325514255152551625517255182551925520255212552225523255242552525526255272552825529255302553125532255332553425535255362553725538255392554025541255422554325544255452554625547255482554925550255512555225553255542555525556255572555825559255602556125562255632556425565255662556725568255692557025571255722557325574255752557625577255782557925580255812558225583255842558525586255872558825589255902559125592255932559425595255962559725598255992560025601256022560325604256052560625607256082560925610256112561225613256142561525616256172561825619256202562125622256232562425625256262562725628256292563025631256322563325634256352563625637256382563925640256412564225643256442564525646256472564825649256502565125652256532565425655256562565725658256592566025661256622566325664256652566625667256682566925670256712567225673256742567525676256772567825679256802568125682256832568425685256862568725688256892569025691256922569325694256952569625697256982569925700257012570225703257042570525706257072570825709257102571125712257132571425715257162571725718257192572025721257222572325724257252572625727257282572925730257312573225733257342573525736257372573825739257402574125742257432574425745257462574725748257492575025751257522575325754257552575625757257582575925760257612576225763257642576525766257672576825769257702577125772257732577425775257762577725778257792578025781257822578325784257852578625787257882578925790257912579225793257942579525796257972579825799258002580125802258032580425805258062580725808258092581025811258122581325814258152581625817258182581925820258212582225823258242582525826258272582825829258302583125832258332583425835258362583725838258392584025841258422584325844258452584625847258482584925850258512585225853258542585525856258572585825859258602586125862258632586425865258662586725868258692587025871258722587325874258752587625877258782587925880258812588225883258842588525886258872588825889258902589125892258932589425895258962589725898258992590025901259022590325904259052590625907259082590925910259112591225913259142591525916259172591825919259202592125922259232592425925259262592725928259292593025931259322593325934259352593625937259382593925940259412594225943259442594525946259472594825949259502595125952259532595425955259562595725958259592596025961259622596325964259652596625967259682596925970259712597225973259742597525976259772597825979259802598125982259832598425985259862598725988259892599025991259922599325994259952599625997259982599926000260012600226003260042600526006260072600826009260102601126012260132601426015260162601726018260192602026021260222602326024260252602626027260282602926030260312603226033260342603526036260372603826039260402604126042260432604426045260462604726048260492605026051260522605326054260552605626057260582605926060260612606226063260642606526066260672606826069260702607126072260732607426075260762607726078260792608026081260822608326084260852608626087260882608926090260912609226093260942609526096260972609826099261002610126102261032610426105261062610726108261092611026111261122611326114261152611626117261182611926120261212612226123261242612526126261272612826129261302613126132261332613426135261362613726138261392614026141261422614326144261452614626147261482614926150261512615226153261542615526156261572615826159261602616126162261632616426165261662616726168261692617026171261722617326174261752617626177261782617926180261812618226183261842618526186261872618826189261902619126192261932619426195261962619726198261992620026201262022620326204262052620626207262082620926210262112621226213262142621526216262172621826219262202622126222262232622426225262262622726228262292623026231262322623326234262352623626237262382623926240262412624226243262442624526246262472624826249262502625126252262532625426255262562625726258262592626026261262622626326264262652626626267262682626926270262712627226273262742627526276262772627826279262802628126282262832628426285262862628726288262892629026291262922629326294262952629626297262982629926300263012630226303263042630526306263072630826309263102631126312263132631426315263162631726318263192632026321263222632326324263252632626327263282632926330263312633226333263342633526336263372633826339263402634126342263432634426345263462634726348263492635026351263522635326354263552635626357263582635926360263612636226363263642636526366263672636826369263702637126372263732637426375263762637726378263792638026381263822638326384263852638626387263882638926390263912639226393263942639526396263972639826399264002640126402264032640426405264062640726408264092641026411264122641326414264152641626417264182641926420264212642226423264242642526426264272642826429264302643126432264332643426435264362643726438264392644026441264422644326444264452644626447264482644926450264512645226453264542645526456264572645826459264602646126462264632646426465264662646726468264692647026471264722647326474264752647626477264782647926480264812648226483264842648526486264872648826489264902649126492264932649426495264962649726498264992650026501265022650326504265052650626507265082650926510265112651226513265142651526516265172651826519265202652126522265232652426525265262652726528265292653026531265322653326534265352653626537265382653926540265412654226543265442654526546265472654826549265502655126552265532655426555265562655726558265592656026561265622656326564265652656626567265682656926570265712657226573265742657526576265772657826579265802658126582265832658426585265862658726588265892659026591265922659326594265952659626597265982659926600266012660226603266042660526606266072660826609266102661126612266132661426615266162661726618266192662026621266222662326624266252662626627266282662926630266312663226633266342663526636266372663826639266402664126642266432664426645266462664726648266492665026651266522665326654266552665626657266582665926660266612666226663266642666526666266672666826669266702667126672266732667426675266762667726678266792668026681266822668326684266852668626687266882668926690266912669226693266942669526696266972669826699267002670126702267032670426705267062670726708267092671026711267122671326714267152671626717267182671926720267212672226723267242672526726267272672826729267302673126732267332673426735267362673726738267392674026741267422674326744267452674626747267482674926750267512675226753267542675526756267572675826759267602676126762267632676426765267662676726768267692677026771267722677326774267752677626777267782677926780267812678226783267842678526786267872678826789267902679126792267932679426795267962679726798267992680026801268022680326804268052680626807268082680926810268112681226813268142681526816268172681826819268202682126822268232682426825268262682726828268292683026831268322683326834268352683626837268382683926840268412684226843268442684526846268472684826849268502685126852268532685426855268562685726858268592686026861268622686326864268652686626867268682686926870268712687226873268742687526876268772687826879268802688126882268832688426885268862688726888268892689026891268922689326894268952689626897268982689926900269012690226903269042690526906269072690826909269102691126912269132691426915269162691726918269192692026921269222692326924269252692626927269282692926930269312693226933269342693526936269372693826939269402694126942269432694426945269462694726948269492695026951269522695326954269552695626957269582695926960269612696226963269642696526966269672696826969269702697126972269732697426975269762697726978269792698026981269822698326984269852698626987269882698926990269912699226993269942699526996269972699826999270002700127002270032700427005270062700727008270092701027011270122701327014270152701627017270182701927020270212702227023270242702527026270272702827029270302703127032270332703427035270362703727038270392704027041270422704327044270452704627047270482704927050270512705227053270542705527056270572705827059270602706127062270632706427065270662706727068270692707027071270722707327074270752707627077270782707927080270812708227083270842708527086270872708827089270902709127092270932709427095270962709727098270992710027101271022710327104271052710627107271082710927110271112711227113271142711527116271172711827119271202712127122271232712427125271262712727128271292713027131271322713327134271352713627137271382713927140271412714227143271442714527146271472714827149271502715127152271532715427155271562715727158271592716027161271622716327164271652716627167271682716927170271712717227173271742717527176271772717827179271802718127182271832718427185271862718727188271892719027191271922719327194271952719627197271982719927200272012720227203272042720527206272072720827209272102721127212272132721427215272162721727218272192722027221272222722327224272252722627227272282722927230272312723227233272342723527236272372723827239272402724127242272432724427245272462724727248272492725027251272522725327254272552725627257272582725927260272612726227263272642726527266272672726827269272702727127272272732727427275272762727727278272792728027281272822728327284272852728627287272882728927290272912729227293272942729527296272972729827299273002730127302273032730427305273062730727308273092731027311273122731327314273152731627317273182731927320273212732227323273242732527326273272732827329273302733127332273332733427335273362733727338273392734027341273422734327344273452734627347273482734927350273512735227353273542735527356273572735827359273602736127362273632736427365273662736727368273692737027371273722737327374273752737627377273782737927380273812738227383273842738527386273872738827389273902739127392273932739427395273962739727398273992740027401274022740327404274052740627407274082740927410274112741227413274142741527416274172741827419274202742127422274232742427425274262742727428274292743027431274322743327434274352743627437274382743927440274412744227443274442744527446274472744827449274502745127452274532745427455274562745727458274592746027461274622746327464274652746627467274682746927470274712747227473274742747527476274772747827479274802748127482274832748427485274862748727488274892749027491274922749327494274952749627497274982749927500275012750227503275042750527506275072750827509275102751127512275132751427515275162751727518275192752027521275222752327524275252752627527275282752927530275312753227533275342753527536275372753827539275402754127542275432754427545275462754727548275492755027551275522755327554275552755627557275582755927560275612756227563275642756527566275672756827569275702757127572275732757427575275762757727578275792758027581275822758327584275852758627587275882758927590275912759227593275942759527596275972759827599276002760127602276032760427605276062760727608276092761027611276122761327614276152761627617276182761927620276212762227623276242762527626276272762827629276302763127632276332763427635276362763727638276392764027641276422764327644276452764627647276482764927650276512765227653276542765527656276572765827659276602766127662276632766427665276662766727668276692767027671276722767327674276752767627677276782767927680276812768227683276842768527686276872768827689276902769127692276932769427695276962769727698276992770027701277022770327704277052770627707277082770927710277112771227713277142771527716277172771827719277202772127722277232772427725277262772727728277292773027731277322773327734277352773627737277382773927740277412774227743277442774527746277472774827749277502775127752277532775427755277562775727758277592776027761277622776327764277652776627767277682776927770277712777227773277742777527776277772777827779277802778127782277832778427785277862778727788277892779027791277922779327794277952779627797277982779927800278012780227803278042780527806278072780827809278102781127812278132781427815278162781727818278192782027821278222782327824278252782627827278282782927830278312783227833278342783527836278372783827839278402784127842278432784427845278462784727848278492785027851278522785327854278552785627857278582785927860278612786227863278642786527866278672786827869278702787127872278732787427875278762787727878278792788027881278822788327884278852788627887278882788927890278912789227893278942789527896278972789827899279002790127902279032790427905279062790727908279092791027911279122791327914279152791627917279182791927920279212792227923279242792527926279272792827929279302793127932279332793427935279362793727938279392794027941279422794327944279452794627947279482794927950279512795227953279542795527956279572795827959279602796127962279632796427965279662796727968279692797027971279722797327974279752797627977279782797927980279812798227983279842798527986279872798827989279902799127992279932799427995279962799727998279992800028001280022800328004280052800628007280082800928010280112801228013280142801528016280172801828019280202802128022280232802428025280262802728028280292803028031280322803328034280352803628037280382803928040280412804228043280442804528046280472804828049280502805128052280532805428055280562805728058280592806028061280622806328064280652806628067280682806928070280712807228073280742807528076280772807828079280802808128082280832808428085280862808728088280892809028091280922809328094280952809628097280982809928100281012810228103281042810528106281072810828109281102811128112281132811428115281162811728118281192812028121281222812328124281252812628127281282812928130281312813228133281342813528136281372813828139281402814128142281432814428145281462814728148281492815028151281522815328154281552815628157281582815928160281612816228163281642816528166281672816828169281702817128172281732817428175281762817728178281792818028181281822818328184281852818628187281882818928190281912819228193281942819528196281972819828199282002820128202282032820428205282062820728208282092821028211282122821328214282152821628217282182821928220282212822228223282242822528226282272822828229282302823128232282332823428235282362823728238282392824028241282422824328244282452824628247282482824928250282512825228253282542825528256282572825828259282602826128262282632826428265282662826728268282692827028271282722827328274282752827628277282782827928280282812828228283282842828528286282872828828289282902829128292282932829428295282962829728298282992830028301283022830328304283052830628307283082830928310283112831228313283142831528316283172831828319283202832128322283232832428325283262832728328283292833028331283322833328334283352833628337283382833928340283412834228343283442834528346283472834828349283502835128352283532835428355283562835728358283592836028361283622836328364283652836628367283682836928370283712837228373283742837528376283772837828379283802838128382283832838428385283862838728388283892839028391283922839328394283952839628397283982839928400284012840228403284042840528406284072840828409284102841128412284132841428415284162841728418284192842028421284222842328424284252842628427284282842928430284312843228433284342843528436284372843828439284402844128442284432844428445284462844728448284492845028451284522845328454284552845628457284582845928460284612846228463284642846528466284672846828469284702847128472284732847428475284762847728478284792848028481284822848328484284852848628487284882848928490284912849228493284942849528496284972849828499285002850128502285032850428505285062850728508285092851028511285122851328514285152851628517285182851928520285212852228523285242852528526285272852828529285302853128532285332853428535285362853728538285392854028541285422854328544285452854628547285482854928550285512855228553285542855528556285572855828559285602856128562285632856428565285662856728568285692857028571285722857328574285752857628577285782857928580285812858228583285842858528586285872858828589285902859128592285932859428595285962859728598285992860028601286022860328604286052860628607286082860928610286112861228613286142861528616286172861828619286202862128622286232862428625286262862728628286292863028631286322863328634286352863628637286382863928640286412864228643286442864528646286472864828649286502865128652286532865428655286562865728658286592866028661286622866328664286652866628667286682866928670286712867228673286742867528676286772867828679286802868128682286832868428685286862868728688286892869028691286922869328694286952869628697286982869928700287012870228703287042870528706287072870828709287102871128712287132871428715287162871728718287192872028721287222872328724287252872628727287282872928730287312873228733287342873528736287372873828739287402874128742287432874428745287462874728748287492875028751287522875328754287552875628757287582875928760287612876228763287642876528766287672876828769287702877128772287732877428775287762877728778287792878028781287822878328784287852878628787287882878928790287912879228793287942879528796287972879828799288002880128802288032880428805288062880728808288092881028811288122881328814288152881628817288182881928820288212882228823288242882528826288272882828829288302883128832288332883428835288362883728838288392884028841288422884328844288452884628847288482884928850288512885228853288542885528856288572885828859288602886128862288632886428865288662886728868288692887028871288722887328874288752887628877288782887928880288812888228883288842888528886288872888828889288902889128892288932889428895288962889728898288992890028901289022890328904289052890628907289082890928910289112891228913289142891528916289172891828919289202892128922289232892428925289262892728928289292893028931289322893328934289352893628937289382893928940289412894228943289442894528946289472894828949289502895128952289532895428955289562895728958289592896028961289622896328964289652896628967289682896928970289712897228973289742897528976289772897828979289802898128982289832898428985289862898728988289892899028991289922899328994289952899628997289982899929000290012900229003290042900529006290072900829009290102901129012290132901429015290162901729018290192902029021290222902329024290252902629027290282902929030290312903229033290342903529036290372903829039290402904129042290432904429045290462904729048290492905029051290522905329054290552905629057290582905929060290612906229063290642906529066290672906829069290702907129072290732907429075290762907729078290792908029081290822908329084290852908629087290882908929090290912909229093290942909529096290972909829099291002910129102291032910429105291062910729108291092911029111291122911329114291152911629117291182911929120291212912229123291242912529126291272912829129291302913129132291332913429135291362913729138291392914029141291422914329144291452914629147291482914929150291512915229153291542915529156291572915829159291602916129162291632916429165291662916729168291692917029171291722917329174291752917629177291782917929180291812918229183291842918529186291872918829189291902919129192291932919429195291962919729198291992920029201292022920329204292052920629207292082920929210292112921229213292142921529216292172921829219292202922129222292232922429225292262922729228292292923029231292322923329234292352923629237292382923929240292412924229243292442924529246292472924829249292502925129252292532925429255292562925729258292592926029261292622926329264292652926629267292682926929270292712927229273292742927529276292772927829279292802928129282292832928429285292862928729288292892929029291292922929329294292952929629297292982929929300293012930229303293042930529306293072930829309293102931129312293132931429315293162931729318293192932029321293222932329324293252932629327293282932929330293312933229333293342933529336293372933829339293402934129342293432934429345293462934729348293492935029351293522935329354293552935629357293582935929360293612936229363293642936529366293672936829369293702937129372293732937429375293762937729378293792938029381293822938329384293852938629387293882938929390293912939229393293942939529396293972939829399294002940129402294032940429405294062940729408294092941029411294122941329414294152941629417294182941929420294212942229423294242942529426294272942829429294302943129432294332943429435294362943729438294392944029441294422944329444294452944629447294482944929450294512945229453294542945529456294572945829459294602946129462294632946429465294662946729468294692947029471294722947329474294752947629477294782947929480294812948229483294842948529486294872948829489294902949129492294932949429495294962949729498294992950029501295022950329504295052950629507295082950929510295112951229513295142951529516295172951829519295202952129522295232952429525295262952729528295292953029531295322953329534295352953629537295382953929540295412954229543295442954529546295472954829549295502955129552295532955429555295562955729558295592956029561295622956329564295652956629567295682956929570295712957229573295742957529576295772957829579295802958129582295832958429585295862958729588295892959029591295922959329594295952959629597295982959929600296012960229603296042960529606296072960829609296102961129612296132961429615296162961729618296192962029621296222962329624296252962629627296282962929630296312963229633296342963529636296372963829639296402964129642296432964429645296462964729648296492965029651296522965329654296552965629657296582965929660296612966229663296642966529666296672966829669296702967129672296732967429675296762967729678296792968029681296822968329684296852968629687296882968929690296912969229693296942969529696296972969829699297002970129702297032970429705297062970729708297092971029711297122971329714297152971629717297182971929720297212972229723297242972529726297272972829729297302973129732297332973429735297362973729738297392974029741297422974329744297452974629747297482974929750297512975229753297542975529756297572975829759297602976129762297632976429765297662976729768297692977029771297722977329774297752977629777297782977929780297812978229783297842978529786297872978829789297902979129792297932979429795297962979729798297992980029801298022980329804298052980629807298082980929810298112981229813298142981529816298172981829819298202982129822298232982429825298262982729828298292983029831298322983329834298352983629837298382983929840298412984229843298442984529846298472984829849298502985129852298532985429855298562985729858298592986029861298622986329864298652986629867298682986929870298712987229873298742987529876298772987829879298802988129882298832988429885298862988729888298892989029891298922989329894298952989629897298982989929900299012990229903299042990529906299072990829909299102991129912299132991429915299162991729918299192992029921299222992329924299252992629927299282992929930299312993229933299342993529936299372993829939299402994129942299432994429945299462994729948299492995029951299522995329954299552995629957299582995929960299612996229963299642996529966299672996829969299702997129972299732997429975299762997729978299792998029981299822998329984299852998629987299882998929990299912999229993299942999529996299972999829999300003000130002300033000430005300063000730008300093001030011300123001330014300153001630017300183001930020300213002230023300243002530026300273002830029300303003130032300333003430035300363003730038300393004030041300423004330044300453004630047300483004930050300513005230053300543005530056300573005830059300603006130062300633006430065300663006730068300693007030071300723007330074300753007630077300783007930080300813008230083300843008530086300873008830089300903009130092300933009430095300963009730098300993010030101301023010330104301053010630107301083010930110301113011230113301143011530116301173011830119301203012130122301233012430125301263012730128301293013030131301323013330134301353013630137301383013930140301413014230143301443014530146301473014830149301503015130152301533015430155301563015730158301593016030161301623016330164301653016630167301683016930170301713017230173301743017530176301773017830179301803018130182301833018430185301863018730188301893019030191301923019330194301953019630197301983019930200302013020230203302043020530206302073020830209302103021130212302133021430215302163021730218302193022030221302223022330224302253022630227302283022930230302313023230233302343023530236302373023830239302403024130242302433024430245302463024730248302493025030251302523025330254302553025630257302583025930260302613026230263302643026530266302673026830269302703027130272302733027430275302763027730278302793028030281302823028330284302853028630287302883028930290302913029230293302943029530296302973029830299303003030130302303033030430305303063030730308303093031030311303123031330314303153031630317303183031930320303213032230323303243032530326303273032830329303303033130332303333033430335303363033730338303393034030341303423034330344303453034630347303483034930350303513035230353303543035530356303573035830359303603036130362303633036430365303663036730368303693037030371303723037330374303753037630377303783037930380303813038230383303843038530386303873038830389303903039130392303933039430395303963039730398303993040030401304023040330404304053040630407304083040930410304113041230413304143041530416304173041830419304203042130422304233042430425304263042730428304293043030431304323043330434304353043630437304383043930440304413044230443304443044530446304473044830449304503045130452304533045430455304563045730458304593046030461304623046330464304653046630467304683046930470304713047230473304743047530476304773047830479304803048130482304833048430485304863048730488304893049030491304923049330494304953049630497304983049930500305013050230503305043050530506305073050830509305103051130512305133051430515305163051730518305193052030521305223052330524305253052630527305283052930530305313053230533305343053530536305373053830539305403054130542305433054430545305463054730548305493055030551305523055330554305553055630557305583055930560305613056230563305643056530566305673056830569305703057130572305733057430575305763057730578305793058030581305823058330584305853058630587305883058930590305913059230593305943059530596305973059830599306003060130602306033060430605306063060730608306093061030611306123061330614306153061630617306183061930620306213062230623306243062530626306273062830629306303063130632306333063430635306363063730638306393064030641306423064330644306453064630647306483064930650306513065230653306543065530656306573065830659306603066130662306633066430665306663066730668306693067030671306723067330674306753067630677306783067930680306813068230683306843068530686306873068830689306903069130692306933069430695306963069730698306993070030701307023070330704307053070630707307083070930710307113071230713307143071530716307173071830719307203072130722307233072430725307263072730728307293073030731307323073330734307353073630737307383073930740307413074230743307443074530746307473074830749307503075130752307533075430755307563075730758307593076030761307623076330764307653076630767307683076930770307713077230773307743077530776307773077830779307803078130782307833078430785307863078730788307893079030791307923079330794307953079630797307983079930800308013080230803308043080530806308073080830809308103081130812308133081430815308163081730818308193082030821308223082330824308253082630827308283082930830308313083230833308343083530836308373083830839308403084130842308433084430845308463084730848308493085030851308523085330854308553085630857308583085930860308613086230863308643086530866308673086830869308703087130872308733087430875308763087730878308793088030881308823088330884308853088630887308883088930890308913089230893308943089530896308973089830899309003090130902309033090430905309063090730908309093091030911309123091330914309153091630917309183091930920309213092230923309243092530926309273092830929309303093130932309333093430935309363093730938309393094030941309423094330944309453094630947309483094930950309513095230953309543095530956309573095830959309603096130962309633096430965309663096730968309693097030971309723097330974309753097630977309783097930980309813098230983309843098530986309873098830989309903099130992309933099430995309963099730998309993100031001310023100331004310053100631007310083100931010310113101231013310143101531016310173101831019310203102131022310233102431025310263102731028310293103031031310323103331034310353103631037310383103931040310413104231043310443104531046310473104831049310503105131052310533105431055310563105731058310593106031061310623106331064310653106631067310683106931070310713107231073310743107531076310773107831079310803108131082310833108431085310863108731088310893109031091310923109331094310953109631097310983109931100311013110231103311043110531106311073110831109311103111131112311133111431115311163111731118311193112031121311223112331124311253112631127311283112931130311313113231133311343113531136311373113831139311403114131142311433114431145311463114731148311493115031151311523115331154311553115631157311583115931160311613116231163311643116531166311673116831169311703117131172311733117431175311763117731178311793118031181311823118331184311853118631187311883118931190311913119231193311943119531196311973119831199312003120131202312033120431205312063120731208312093121031211312123121331214312153121631217312183121931220312213122231223312243122531226312273122831229312303123131232312333123431235312363123731238312393124031241312423124331244312453124631247312483124931250312513125231253312543125531256312573125831259312603126131262312633126431265312663126731268312693127031271312723127331274312753127631277312783127931280312813128231283312843128531286312873128831289312903129131292312933129431295312963129731298312993130031301313023130331304313053130631307313083130931310313113131231313313143131531316313173131831319313203132131322313233132431325313263132731328313293133031331313323133331334313353133631337313383133931340313413134231343313443134531346313473134831349313503135131352313533135431355313563135731358313593136031361313623136331364313653136631367313683136931370313713137231373313743137531376313773137831379313803138131382313833138431385313863138731388313893139031391313923139331394313953139631397313983139931400314013140231403314043140531406314073140831409314103141131412314133141431415314163141731418314193142031421314223142331424314253142631427314283142931430314313143231433314343143531436314373143831439314403144131442314433144431445314463144731448314493145031451314523145331454314553145631457314583145931460314613146231463314643146531466314673146831469314703147131472314733147431475314763147731478314793148031481314823148331484314853148631487314883148931490314913149231493314943149531496314973149831499315003150131502315033150431505315063150731508315093151031511315123151331514315153151631517315183151931520315213152231523315243152531526315273152831529315303153131532315333153431535315363153731538315393154031541315423154331544315453154631547315483154931550315513155231553315543155531556315573155831559315603156131562315633156431565315663156731568315693157031571315723157331574315753157631577315783157931580315813158231583315843158531586315873158831589315903159131592315933159431595315963159731598315993160031601316023160331604316053160631607316083160931610316113161231613316143161531616316173161831619316203162131622316233162431625316263162731628316293163031631316323163331634316353163631637316383163931640316413164231643316443164531646316473164831649316503165131652316533165431655316563165731658316593166031661316623166331664316653166631667316683166931670316713167231673316743167531676316773167831679316803168131682316833168431685316863168731688316893169031691316923169331694316953169631697316983169931700317013170231703317043170531706317073170831709317103171131712317133171431715317163171731718317193172031721317223172331724317253172631727317283172931730317313173231733317343173531736317373173831739317403174131742317433174431745317463174731748317493175031751317523175331754317553175631757317583175931760317613176231763317643176531766317673176831769317703177131772317733177431775317763177731778317793178031781317823178331784317853178631787317883178931790317913179231793317943179531796317973179831799318003180131802318033180431805318063180731808318093181031811318123181331814318153181631817318183181931820318213182231823318243182531826318273182831829318303183131832318333183431835318363183731838318393184031841318423184331844318453184631847318483184931850318513185231853318543185531856318573185831859318603186131862318633186431865318663186731868318693187031871318723187331874318753187631877318783187931880318813188231883318843188531886318873188831889318903189131892318933189431895318963189731898318993190031901319023190331904319053190631907319083190931910319113191231913319143191531916319173191831919319203192131922319233192431925319263192731928319293193031931319323193331934319353193631937319383193931940319413194231943319443194531946319473194831949319503195131952319533195431955319563195731958319593196031961319623196331964319653196631967319683196931970319713197231973319743197531976319773197831979319803198131982319833198431985319863198731988319893199031991319923199331994319953199631997319983199932000320013200232003320043200532006320073200832009320103201132012320133201432015320163201732018320193202032021320223202332024320253202632027320283202932030320313203232033320343203532036320373203832039320403204132042320433204432045320463204732048320493205032051320523205332054320553205632057320583205932060320613206232063320643206532066320673206832069320703207132072320733207432075320763207732078320793208032081320823208332084320853208632087320883208932090320913209232093320943209532096320973209832099321003210132102321033210432105321063210732108321093211032111321123211332114321153211632117321183211932120321213212232123321243212532126321273212832129321303213132132321333213432135321363213732138321393214032141321423214332144321453214632147321483214932150321513215232153321543215532156321573215832159321603216132162321633216432165321663216732168321693217032171321723217332174321753217632177321783217932180321813218232183321843218532186321873218832189321903219132192321933219432195321963219732198321993220032201322023220332204322053220632207322083220932210322113221232213322143221532216322173221832219322203222132222322233222432225322263222732228322293223032231322323223332234322353223632237322383223932240322413224232243322443224532246322473224832249322503225132252322533225432255322563225732258322593226032261322623226332264322653226632267322683226932270322713227232273322743227532276322773227832279322803228132282322833228432285322863228732288322893229032291322923229332294322953229632297322983229932300323013230232303323043230532306323073230832309323103231132312323133231432315323163231732318323193232032321323223232332324323253232632327323283232932330323313233232333323343233532336323373233832339323403234132342323433234432345323463234732348323493235032351323523235332354323553235632357323583235932360323613236232363323643236532366323673236832369323703237132372323733237432375323763237732378323793238032381323823238332384323853238632387323883238932390323913239232393323943239532396323973239832399324003240132402324033240432405324063240732408324093241032411324123241332414324153241632417324183241932420324213242232423324243242532426324273242832429324303243132432324333243432435324363243732438324393244032441324423244332444324453244632447324483244932450324513245232453324543245532456324573245832459324603246132462324633246432465324663246732468324693247032471324723247332474324753247632477324783247932480324813248232483324843248532486324873248832489324903249132492324933249432495324963249732498324993250032501325023250332504325053250632507325083250932510325113251232513325143251532516325173251832519325203252132522325233252432525325263252732528325293253032531325323253332534325353253632537325383253932540325413254232543325443254532546325473254832549325503255132552325533255432555325563255732558325593256032561325623256332564325653256632567325683256932570325713257232573325743257532576325773257832579325803258132582325833258432585325863258732588325893259032591325923259332594325953259632597325983259932600326013260232603326043260532606326073260832609326103261132612326133261432615326163261732618326193262032621326223262332624326253262632627326283262932630326313263232633326343263532636326373263832639326403264132642326433264432645326463264732648326493265032651326523265332654326553265632657326583265932660326613266232663326643266532666326673266832669326703267132672326733267432675326763267732678326793268032681326823268332684326853268632687326883268932690326913269232693326943269532696326973269832699327003270132702327033270432705327063270732708327093271032711327123271332714327153271632717327183271932720327213272232723327243272532726327273272832729327303273132732327333273432735327363273732738327393274032741327423274332744327453274632747327483274932750327513275232753327543275532756327573275832759327603276132762327633276432765327663276732768327693277032771327723277332774327753277632777327783277932780327813278232783327843278532786327873278832789327903279132792327933279432795327963279732798327993280032801328023280332804328053280632807328083280932810328113281232813328143281532816328173281832819328203282132822328233282432825328263282732828328293283032831328323283332834328353283632837328383283932840328413284232843328443284532846328473284832849328503285132852328533285432855328563285732858328593286032861328623286332864328653286632867328683286932870328713287232873328743287532876328773287832879328803288132882328833288432885328863288732888328893289032891328923289332894328953289632897328983289932900329013290232903329043290532906329073290832909329103291132912329133291432915329163291732918329193292032921329223292332924329253292632927329283292932930329313293232933329343293532936329373293832939329403294132942329433294432945329463294732948329493295032951329523295332954329553295632957329583295932960329613296232963329643296532966329673296832969329703297132972329733297432975329763297732978329793298032981329823298332984329853298632987329883298932990329913299232993329943299532996329973299832999330003300133002330033300433005330063300733008330093301033011330123301333014330153301633017330183301933020330213302233023330243302533026330273302833029330303303133032330333303433035330363303733038330393304033041330423304333044330453304633047330483304933050330513305233053330543305533056330573305833059330603306133062330633306433065330663306733068330693307033071330723307333074330753307633077330783307933080330813308233083330843308533086330873308833089330903309133092330933309433095330963309733098330993310033101331023310333104331053310633107331083310933110331113311233113331143311533116331173311833119331203312133122331233312433125331263312733128331293313033131331323313333134331353313633137331383313933140331413314233143331443314533146331473314833149331503315133152331533315433155331563315733158331593316033161331623316333164331653316633167331683316933170331713317233173331743317533176331773317833179331803318133182331833318433185331863318733188331893319033191331923319333194331953319633197331983319933200332013320233203332043320533206332073320833209332103321133212332133321433215332163321733218332193322033221332223322333224332253322633227332283322933230332313323233233332343323533236332373323833239332403324133242332433324433245332463324733248332493325033251332523325333254332553325633257332583325933260332613326233263332643326533266332673326833269332703327133272332733327433275332763327733278332793328033281332823328333284332853328633287332883328933290332913329233293332943329533296332973329833299333003330133302333033330433305333063330733308333093331033311333123331333314333153331633317333183331933320333213332233323333243332533326333273332833329333303333133332333333333433335333363333733338333393334033341333423334333344333453334633347333483334933350333513335233353333543335533356333573335833359333603336133362333633336433365333663336733368333693337033371333723337333374333753337633377333783337933380333813338233383333843338533386333873338833389333903339133392333933339433395333963339733398333993340033401334023340333404334053340633407334083340933410334113341233413334143341533416334173341833419334203342133422334233342433425334263342733428334293343033431334323343333434334353343633437334383343933440334413344233443334443344533446334473344833449334503345133452334533345433455334563345733458334593346033461334623346333464334653346633467334683346933470334713347233473334743347533476334773347833479334803348133482334833348433485334863348733488334893349033491334923349333494334953349633497334983349933500335013350233503335043350533506335073350833509335103351133512335133351433515335163351733518335193352033521335223352333524335253352633527335283352933530335313353233533335343353533536335373353833539335403354133542335433354433545335463354733548335493355033551335523355333554335553355633557335583355933560335613356233563335643356533566335673356833569335703357133572335733357433575335763357733578335793358033581335823358333584335853358633587335883358933590335913359233593335943359533596335973359833599336003360133602336033360433605336063360733608336093361033611336123361333614336153361633617336183361933620336213362233623336243362533626336273362833629336303363133632336333363433635336363363733638336393364033641336423364333644336453364633647336483364933650336513365233653336543365533656336573365833659336603366133662336633366433665336663366733668336693367033671336723367333674336753367633677336783367933680336813368233683336843368533686336873368833689336903369133692336933369433695336963369733698336993370033701337023370333704337053370633707337083370933710337113371233713337143371533716337173371833719337203372133722337233372433725337263372733728337293373033731337323373333734337353373633737337383373933740337413374233743337443374533746337473374833749337503375133752337533375433755337563375733758337593376033761337623376333764337653376633767337683376933770337713377233773337743377533776337773377833779337803378133782337833378433785337863378733788337893379033791337923379333794337953379633797337983379933800338013380233803338043380533806338073380833809338103381133812338133381433815338163381733818338193382033821338223382333824338253382633827338283382933830338313383233833338343383533836338373383833839338403384133842338433384433845338463384733848338493385033851338523385333854338553385633857338583385933860338613386233863338643386533866338673386833869338703387133872338733387433875338763387733878338793388033881338823388333884338853388633887338883388933890338913389233893338943389533896338973389833899339003390133902339033390433905339063390733908339093391033911339123391333914339153391633917339183391933920339213392233923339243392533926339273392833929339303393133932339333393433935339363393733938339393394033941339423394333944339453394633947339483394933950339513395233953339543395533956339573395833959339603396133962339633396433965339663396733968339693397033971339723397333974339753397633977339783397933980339813398233983339843398533986339873398833989339903399133992339933399433995339963399733998339993400034001340023400334004340053400634007340083400934010340113401234013340143401534016340173401834019340203402134022340233402434025340263402734028340293403034031340323403334034340353403634037340383403934040340413404234043340443404534046340473404834049340503405134052340533405434055340563405734058340593406034061340623406334064340653406634067340683406934070340713407234073340743407534076340773407834079340803408134082340833408434085340863408734088340893409034091340923409334094340953409634097340983409934100341013410234103341043410534106341073410834109341103411134112341133411434115341163411734118341193412034121341223412334124341253412634127341283412934130341313413234133341343413534136341373413834139341403414134142341433414434145341463414734148341493415034151341523415334154341553415634157341583415934160341613416234163341643416534166341673416834169341703417134172341733417434175341763417734178341793418034181341823418334184341853418634187341883418934190341913419234193341943419534196341973419834199342003420134202342033420434205342063420734208342093421034211342123421334214342153421634217342183421934220342213422234223342243422534226342273422834229342303423134232342333423434235342363423734238342393424034241342423424334244342453424634247342483424934250342513425234253342543425534256342573425834259342603426134262342633426434265342663426734268342693427034271342723427334274342753427634277342783427934280342813428234283342843428534286342873428834289342903429134292342933429434295342963429734298342993430034301343023430334304343053430634307343083430934310343113431234313343143431534316343173431834319343203432134322343233432434325343263432734328343293433034331343323433334334343353433634337343383433934340343413434234343343443434534346343473434834349343503435134352343533435434355343563435734358343593436034361343623436334364343653436634367343683436934370343713437234373343743437534376343773437834379343803438134382343833438434385343863438734388343893439034391343923439334394343953439634397343983439934400344013440234403344043440534406344073440834409344103441134412344133441434415344163441734418344193442034421344223442334424344253442634427344283442934430344313443234433344343443534436344373443834439344403444134442344433444434445344463444734448344493445034451344523445334454344553445634457344583445934460344613446234463344643446534466344673446834469344703447134472344733447434475344763447734478344793448034481344823448334484344853448634487344883448934490344913449234493344943449534496344973449834499345003450134502345033450434505345063450734508345093451034511345123451334514345153451634517345183451934520345213452234523345243452534526345273452834529345303453134532345333453434535345363453734538345393454034541345423454334544345453454634547345483454934550345513455234553345543455534556345573455834559345603456134562345633456434565345663456734568345693457034571345723457334574345753457634577345783457934580345813458234583345843458534586345873458834589345903459134592345933459434595345963459734598345993460034601346023460334604346053460634607346083460934610346113461234613346143461534616346173461834619346203462134622346233462434625346263462734628346293463034631346323463334634346353463634637346383463934640346413464234643346443464534646346473464834649346503465134652346533465434655346563465734658346593466034661346623466334664346653466634667346683466934670346713467234673346743467534676346773467834679346803468134682346833468434685346863468734688346893469034691346923469334694346953469634697346983469934700347013470234703347043470534706347073470834709347103471134712347133471434715347163471734718347193472034721347223472334724347253472634727347283472934730347313473234733347343473534736347373473834739347403474134742347433474434745347463474734748347493475034751347523475334754347553475634757347583475934760347613476234763347643476534766347673476834769347703477134772347733477434775347763477734778347793478034781347823478334784347853478634787347883478934790347913479234793347943479534796347973479834799348003480134802348033480434805348063480734808348093481034811348123481334814348153481634817348183481934820348213482234823348243482534826348273482834829348303483134832348333483434835348363483734838348393484034841348423484334844348453484634847348483484934850348513485234853348543485534856348573485834859348603486134862348633486434865348663486734868348693487034871348723487334874348753487634877348783487934880348813488234883348843488534886348873488834889348903489134892348933489434895348963489734898348993490034901349023490334904349053490634907349083490934910349113491234913349143491534916349173491834919349203492134922349233492434925349263492734928349293493034931349323493334934349353493634937349383493934940349413494234943349443494534946349473494834949349503495134952349533495434955349563495734958349593496034961349623496334964349653496634967349683496934970349713497234973349743497534976349773497834979349803498134982349833498434985349863498734988349893499034991349923499334994349953499634997349983499935000350013500235003350043500535006350073500835009350103501135012350133501435015350163501735018350193502035021350223502335024350253502635027350283502935030350313503235033350343503535036350373503835039350403504135042350433504435045350463504735048350493505035051350523505335054350553505635057350583505935060350613506235063350643506535066350673506835069350703507135072350733507435075350763507735078350793508035081350823508335084350853508635087350883508935090350913509235093350943509535096350973509835099351003510135102351033510435105351063510735108351093511035111351123511335114351153511635117351183511935120351213512235123351243512535126351273512835129351303513135132351333513435135351363513735138351393514035141351423514335144351453514635147351483514935150351513515235153351543515535156351573515835159351603516135162351633516435165351663516735168351693517035171351723517335174351753517635177351783517935180351813518235183351843518535186351873518835189351903519135192351933519435195351963519735198351993520035201352023520335204352053520635207352083520935210352113521235213352143521535216352173521835219352203522135222352233522435225352263522735228352293523035231352323523335234352353523635237352383523935240352413524235243352443524535246352473524835249352503525135252352533525435255352563525735258352593526035261352623526335264352653526635267352683526935270352713527235273352743527535276352773527835279352803528135282352833528435285352863528735288352893529035291352923529335294352953529635297352983529935300353013530235303353043530535306353073530835309353103531135312353133531435315353163531735318353193532035321353223532335324353253532635327353283532935330353313533235333353343533535336353373533835339353403534135342353433534435345353463534735348353493535035351353523535335354353553535635357353583535935360353613536235363353643536535366353673536835369353703537135372353733537435375353763537735378353793538035381353823538335384353853538635387353883538935390353913539235393353943539535396353973539835399354003540135402354033540435405354063540735408354093541035411354123541335414354153541635417354183541935420354213542235423354243542535426354273542835429354303543135432354333543435435354363543735438354393544035441354423544335444354453544635447354483544935450354513545235453354543545535456354573545835459354603546135462354633546435465354663546735468354693547035471354723547335474354753547635477354783547935480354813548235483354843548535486354873548835489354903549135492354933549435495354963549735498354993550035501355023550335504355053550635507355083550935510355113551235513355143551535516355173551835519355203552135522355233552435525355263552735528355293553035531355323553335534355353553635537355383553935540355413554235543355443554535546355473554835549355503555135552355533555435555355563555735558355593556035561355623556335564355653556635567355683556935570355713557235573355743557535576355773557835579355803558135582355833558435585355863558735588355893559035591355923559335594355953559635597355983559935600356013560235603356043560535606356073560835609356103561135612356133561435615356163561735618356193562035621356223562335624356253562635627356283562935630356313563235633356343563535636356373563835639356403564135642356433564435645356463564735648356493565035651356523565335654356553565635657356583565935660356613566235663356643566535666356673566835669356703567135672356733567435675356763567735678356793568035681356823568335684356853568635687356883568935690356913569235693356943569535696356973569835699357003570135702357033570435705357063570735708357093571035711357123571335714357153571635717357183571935720357213572235723357243572535726357273572835729357303573135732357333573435735357363573735738357393574035741357423574335744357453574635747357483574935750357513575235753357543575535756357573575835759357603576135762357633576435765357663576735768357693577035771357723577335774357753577635777357783577935780357813578235783357843578535786357873578835789357903579135792357933579435795357963579735798357993580035801358023580335804358053580635807358083580935810358113581235813358143581535816358173581835819358203582135822358233582435825358263582735828358293583035831358323583335834358353583635837358383583935840358413584235843358443584535846358473584835849358503585135852358533585435855358563585735858358593586035861358623586335864358653586635867358683586935870358713587235873358743587535876358773587835879358803588135882358833588435885358863588735888358893589035891358923589335894358953589635897358983589935900359013590235903359043590535906359073590835909359103591135912359133591435915359163591735918359193592035921359223592335924359253592635927359283592935930359313593235933359343593535936359373593835939359403594135942359433594435945359463594735948359493595035951359523595335954359553595635957359583595935960359613596235963359643596535966359673596835969359703597135972359733597435975359763597735978359793598035981359823598335984359853598635987359883598935990359913599235993359943599535996359973599835999360003600136002360033600436005360063600736008360093601036011360123601336014360153601636017360183601936020360213602236023360243602536026360273602836029360303603136032360333603436035360363603736038360393604036041360423604336044360453604636047360483604936050360513605236053360543605536056360573605836059360603606136062360633606436065360663606736068360693607036071360723607336074360753607636077360783607936080360813608236083360843608536086360873608836089360903609136092360933609436095360963609736098360993610036101361023610336104361053610636107361083610936110361113611236113361143611536116361173611836119361203612136122361233612436125361263612736128361293613036131361323613336134361353613636137361383613936140361413614236143361443614536146361473614836149361503615136152361533615436155361563615736158361593616036161361623616336164361653616636167361683616936170361713617236173361743617536176361773617836179361803618136182361833618436185361863618736188361893619036191361923619336194361953619636197361983619936200362013620236203362043620536206362073620836209362103621136212362133621436215362163621736218362193622036221362223622336224362253622636227362283622936230362313623236233362343623536236362373623836239362403624136242362433624436245362463624736248362493625036251362523625336254362553625636257362583625936260362613626236263362643626536266362673626836269362703627136272362733627436275362763627736278362793628036281362823628336284362853628636287362883628936290362913629236293362943629536296362973629836299363003630136302363033630436305363063630736308363093631036311363123631336314363153631636317363183631936320363213632236323363243632536326363273632836329363303633136332363333633436335363363633736338363393634036341363423634336344363453634636347363483634936350363513635236353363543635536356363573635836359363603636136362363633636436365363663636736368363693637036371363723637336374363753637636377363783637936380363813638236383363843638536386363873638836389363903639136392363933639436395363963639736398363993640036401364023640336404364053640636407364083640936410364113641236413364143641536416364173641836419364203642136422364233642436425364263642736428364293643036431364323643336434364353643636437364383643936440364413644236443364443644536446364473644836449364503645136452364533645436455364563645736458364593646036461364623646336464364653646636467364683646936470364713647236473364743647536476364773647836479364803648136482364833648436485364863648736488364893649036491364923649336494364953649636497364983649936500365013650236503365043650536506365073650836509365103651136512365133651436515365163651736518365193652036521365223652336524365253652636527365283652936530365313653236533365343653536536365373653836539365403654136542365433654436545365463654736548365493655036551365523655336554365553655636557365583655936560365613656236563365643656536566365673656836569365703657136572365733657436575365763657736578365793658036581365823658336584365853658636587365883658936590365913659236593365943659536596365973659836599366003660136602366033660436605366063660736608366093661036611366123661336614366153661636617366183661936620366213662236623366243662536626366273662836629366303663136632366333663436635366363663736638366393664036641366423664336644366453664636647366483664936650366513665236653366543665536656366573665836659366603666136662366633666436665366663666736668366693667036671366723667336674366753667636677366783667936680366813668236683366843668536686366873668836689366903669136692366933669436695366963669736698366993670036701367023670336704367053670636707367083670936710367113671236713367143671536716367173671836719367203672136722367233672436725367263672736728367293673036731367323673336734367353673636737367383673936740367413674236743367443674536746367473674836749367503675136752367533675436755367563675736758367593676036761367623676336764367653676636767367683676936770367713677236773367743677536776367773677836779367803678136782367833678436785367863678736788367893679036791367923679336794367953679636797367983679936800368013680236803368043680536806368073680836809368103681136812368133681436815368163681736818368193682036821368223682336824368253682636827368283682936830368313683236833368343683536836368373683836839368403684136842368433684436845368463684736848368493685036851368523685336854368553685636857368583685936860368613686236863368643686536866368673686836869368703687136872368733687436875368763687736878368793688036881368823688336884368853688636887368883688936890368913689236893368943689536896368973689836899369003690136902369033690436905369063690736908369093691036911369123691336914369153691636917369183691936920369213692236923369243692536926369273692836929369303693136932369333693436935369363693736938369393694036941369423694336944369453694636947369483694936950369513695236953369543695536956369573695836959369603696136962369633696436965369663696736968369693697036971369723697336974369753697636977369783697936980369813698236983369843698536986369873698836989369903699136992369933699436995369963699736998369993700037001370023700337004370053700637007370083700937010370113701237013370143701537016370173701837019370203702137022370233702437025370263702737028370293703037031370323703337034370353703637037370383703937040370413704237043370443704537046370473704837049370503705137052370533705437055370563705737058370593706037061370623706337064370653706637067370683706937070370713707237073370743707537076370773707837079370803708137082370833708437085370863708737088370893709037091370923709337094370953709637097370983709937100371013710237103371043710537106371073710837109371103711137112371133711437115371163711737118371193712037121371223712337124371253712637127371283712937130371313713237133371343713537136371373713837139371403714137142371433714437145371463714737148371493715037151371523715337154371553715637157371583715937160371613716237163371643716537166371673716837169371703717137172371733717437175371763717737178371793718037181371823718337184371853718637187371883718937190371913719237193371943719537196371973719837199372003720137202372033720437205372063720737208372093721037211372123721337214372153721637217372183721937220372213722237223372243722537226372273722837229372303723137232372333723437235372363723737238372393724037241372423724337244372453724637247372483724937250372513725237253372543725537256372573725837259372603726137262372633726437265372663726737268372693727037271372723727337274372753727637277372783727937280372813728237283372843728537286372873728837289372903729137292372933729437295372963729737298372993730037301373023730337304373053730637307373083730937310373113731237313373143731537316373173731837319373203732137322373233732437325373263732737328373293733037331373323733337334373353733637337373383733937340373413734237343373443734537346373473734837349373503735137352373533735437355373563735737358373593736037361373623736337364373653736637367373683736937370373713737237373373743737537376373773737837379373803738137382373833738437385373863738737388373893739037391373923739337394373953739637397373983739937400374013740237403374043740537406374073740837409374103741137412374133741437415374163741737418374193742037421374223742337424374253742637427374283742937430374313743237433374343743537436374373743837439374403744137442374433744437445374463744737448374493745037451374523745337454374553745637457374583745937460374613746237463374643746537466374673746837469374703747137472374733747437475374763747737478374793748037481374823748337484374853748637487374883748937490374913749237493374943749537496374973749837499375003750137502375033750437505375063750737508375093751037511375123751337514375153751637517375183751937520375213752237523375243752537526375273752837529375303753137532375333753437535375363753737538375393754037541375423754337544375453754637547375483754937550375513755237553375543755537556375573755837559375603756137562375633756437565375663756737568375693757037571375723757337574375753757637577375783757937580375813758237583375843758537586375873758837589375903759137592375933759437595375963759737598375993760037601376023760337604376053760637607376083760937610376113761237613376143761537616376173761837619376203762137622376233762437625376263762737628376293763037631376323763337634376353763637637376383763937640376413764237643376443764537646376473764837649376503765137652376533765437655376563765737658376593766037661376623766337664376653766637667376683766937670376713767237673376743767537676376773767837679376803768137682376833768437685376863768737688376893769037691376923769337694376953769637697376983769937700377013770237703377043770537706377073770837709377103771137712377133771437715377163771737718377193772037721377223772337724377253772637727377283772937730377313773237733377343773537736377373773837739377403774137742377433774437745377463774737748377493775037751377523775337754377553775637757377583775937760377613776237763377643776537766377673776837769377703777137772377733777437775377763777737778377793778037781377823778337784377853778637787377883778937790377913779237793377943779537796377973779837799378003780137802378033780437805378063780737808378093781037811378123781337814378153781637817378183781937820378213782237823378243782537826378273782837829378303783137832378333783437835378363783737838378393784037841378423784337844378453784637847378483784937850378513785237853378543785537856378573785837859378603786137862378633786437865378663786737868378693787037871378723787337874378753787637877378783787937880378813788237883378843788537886378873788837889378903789137892378933789437895378963789737898378993790037901379023790337904379053790637907379083790937910379113791237913379143791537916379173791837919379203792137922379233792437925379263792737928379293793037931379323793337934379353793637937379383793937940379413794237943379443794537946379473794837949379503795137952379533795437955379563795737958379593796037961379623796337964379653796637967379683796937970379713797237973379743797537976379773797837979379803798137982379833798437985379863798737988379893799037991379923799337994379953799637997379983799938000380013800238003380043800538006380073800838009380103801138012380133801438015380163801738018380193802038021380223802338024380253802638027380283802938030380313803238033380343803538036380373803838039380403804138042380433804438045380463804738048380493805038051380523805338054380553805638057380583805938060380613806238063380643806538066380673806838069380703807138072380733807438075380763807738078380793808038081380823808338084380853808638087380883808938090380913809238093380943809538096380973809838099381003810138102381033810438105381063810738108381093811038111381123811338114381153811638117381183811938120381213812238123381243812538126381273812838129381303813138132381333813438135381363813738138381393814038141381423814338144381453814638147381483814938150381513815238153381543815538156381573815838159381603816138162381633816438165381663816738168381693817038171381723817338174381753817638177381783817938180381813818238183381843818538186381873818838189381903819138192381933819438195381963819738198381993820038201382023820338204382053820638207382083820938210382113821238213382143821538216382173821838219382203822138222382233822438225382263822738228382293823038231382323823338234382353823638237382383823938240382413824238243382443824538246382473824838249382503825138252382533825438255382563825738258382593826038261382623826338264382653826638267382683826938270382713827238273382743827538276382773827838279382803828138282382833828438285382863828738288382893829038291382923829338294382953829638297382983829938300383013830238303383043830538306383073830838309383103831138312383133831438315383163831738318383193832038321383223832338324383253832638327383283832938330383313833238333383343833538336383373833838339383403834138342383433834438345383463834738348383493835038351383523835338354383553835638357383583835938360383613836238363383643836538366383673836838369383703837138372383733837438375383763837738378383793838038381383823838338384383853838638387383883838938390383913839238393383943839538396383973839838399384003840138402384033840438405384063840738408384093841038411384123841338414384153841638417384183841938420384213842238423384243842538426384273842838429384303843138432384333843438435384363843738438384393844038441384423844338444384453844638447384483844938450384513845238453384543845538456384573845838459384603846138462384633846438465384663846738468384693847038471384723847338474384753847638477384783847938480384813848238483384843848538486384873848838489384903849138492384933849438495384963849738498384993850038501385023850338504385053850638507385083850938510385113851238513385143851538516385173851838519385203852138522385233852438525385263852738528385293853038531385323853338534385353853638537385383853938540385413854238543385443854538546385473854838549385503855138552385533855438555385563855738558385593856038561385623856338564385653856638567385683856938570385713857238573385743857538576385773857838579385803858138582385833858438585385863858738588385893859038591385923859338594385953859638597385983859938600386013860238603386043860538606386073860838609386103861138612386133861438615386163861738618386193862038621386223862338624386253862638627386283862938630386313863238633386343863538636386373863838639386403864138642386433864438645386463864738648386493865038651386523865338654386553865638657386583865938660386613866238663386643866538666386673866838669386703867138672386733867438675386763867738678386793868038681386823868338684386853868638687386883868938690386913869238693386943869538696386973869838699387003870138702387033870438705387063870738708387093871038711387123871338714387153871638717387183871938720387213872238723387243872538726387273872838729387303873138732387333873438735387363873738738387393874038741387423874338744387453874638747387483874938750387513875238753387543875538756387573875838759387603876138762387633876438765387663876738768387693877038771387723877338774387753877638777387783877938780387813878238783387843878538786387873878838789387903879138792387933879438795387963879738798387993880038801388023880338804388053880638807388083880938810388113881238813388143881538816388173881838819388203882138822388233882438825388263882738828388293883038831388323883338834388353883638837388383883938840388413884238843388443884538846388473884838849388503885138852388533885438855388563885738858388593886038861388623886338864388653886638867388683886938870388713887238873388743887538876388773887838879388803888138882388833888438885388863888738888388893889038891388923889338894388953889638897388983889938900389013890238903389043890538906389073890838909389103891138912389133891438915389163891738918389193892038921389223892338924389253892638927389283892938930389313893238933389343893538936389373893838939389403894138942389433894438945389463894738948389493895038951389523895338954389553895638957389583895938960389613896238963389643896538966389673896838969389703897138972389733897438975389763897738978389793898038981389823898338984389853898638987389883898938990389913899238993389943899538996389973899838999390003900139002390033900439005390063900739008390093901039011390123901339014390153901639017390183901939020390213902239023390243902539026390273902839029390303903139032390333903439035390363903739038390393904039041390423904339044390453904639047390483904939050390513905239053390543905539056390573905839059390603906139062390633906439065390663906739068390693907039071390723907339074390753907639077390783907939080390813908239083390843908539086390873908839089390903909139092390933909439095390963909739098390993910039101391023910339104391053910639107391083910939110391113911239113391143911539116391173911839119391203912139122391233912439125391263912739128391293913039131391323913339134391353913639137391383913939140391413914239143391443914539146391473914839149391503915139152391533915439155391563915739158391593916039161391623916339164391653916639167391683916939170391713917239173391743917539176391773917839179391803918139182391833918439185391863918739188391893919039191391923919339194391953919639197391983919939200392013920239203392043920539206392073920839209392103921139212392133921439215392163921739218392193922039221392223922339224392253922639227392283922939230392313923239233392343923539236392373923839239392403924139242392433924439245392463924739248392493925039251392523925339254392553925639257392583925939260392613926239263392643926539266392673926839269392703927139272392733927439275392763927739278392793928039281392823928339284392853928639287392883928939290392913929239293392943929539296392973929839299393003930139302393033930439305393063930739308393093931039311393123931339314393153931639317393183931939320393213932239323393243932539326393273932839329393303933139332393333933439335393363933739338393393934039341393423934339344393453934639347393483934939350393513935239353393543935539356393573935839359393603936139362393633936439365393663936739368393693937039371393723937339374393753937639377393783937939380393813938239383393843938539386393873938839389393903939139392393933939439395393963939739398393993940039401394023940339404394053940639407394083940939410394113941239413394143941539416394173941839419394203942139422394233942439425394263942739428394293943039431394323943339434394353943639437394383943939440394413944239443394443944539446394473944839449394503945139452394533945439455394563945739458394593946039461394623946339464394653946639467394683946939470394713947239473394743947539476394773947839479394803948139482394833948439485394863948739488394893949039491394923949339494394953949639497394983949939500395013950239503395043950539506395073950839509395103951139512395133951439515395163951739518395193952039521395223952339524395253952639527395283952939530395313953239533395343953539536395373953839539395403954139542395433954439545395463954739548395493955039551395523955339554395553955639557395583955939560395613956239563395643956539566395673956839569395703957139572395733957439575395763957739578395793958039581395823958339584395853958639587395883958939590395913959239593395943959539596395973959839599396003960139602396033960439605396063960739608396093961039611396123961339614396153961639617396183961939620396213962239623396243962539626396273962839629396303963139632396333963439635396363963739638396393964039641396423964339644396453964639647396483964939650396513965239653396543965539656396573965839659396603966139662396633966439665396663966739668396693967039671396723967339674396753967639677396783967939680396813968239683396843968539686396873968839689396903969139692396933969439695396963969739698396993970039701397023970339704397053970639707397083970939710397113971239713397143971539716397173971839719397203972139722397233972439725397263972739728397293973039731397323973339734397353973639737397383973939740397413974239743397443974539746397473974839749397503975139752397533975439755397563975739758397593976039761397623976339764397653976639767397683976939770397713977239773397743977539776397773977839779397803978139782397833978439785397863978739788397893979039791397923979339794397953979639797397983979939800398013980239803398043980539806398073980839809398103981139812398133981439815398163981739818398193982039821398223982339824398253982639827398283982939830398313983239833398343983539836398373983839839398403984139842398433984439845398463984739848398493985039851398523985339854398553985639857398583985939860398613986239863398643986539866398673986839869398703987139872398733987439875398763987739878398793988039881398823988339884398853988639887398883988939890398913989239893398943989539896398973989839899399003990139902399033990439905399063990739908399093991039911399123991339914399153991639917399183991939920399213992239923399243992539926399273992839929399303993139932399333993439935399363993739938399393994039941399423994339944399453994639947399483994939950399513995239953399543995539956399573995839959399603996139962399633996439965399663996739968399693997039971399723997339974399753997639977399783997939980399813998239983399843998539986399873998839989399903999139992399933999439995399963999739998399994000040001400024000340004400054000640007400084000940010400114001240013400144001540016400174001840019400204002140022400234002440025400264002740028400294003040031400324003340034400354003640037400384003940040400414004240043400444004540046400474004840049400504005140052400534005440055400564005740058400594006040061400624006340064400654006640067400684006940070400714007240073400744007540076400774007840079400804008140082400834008440085400864008740088400894009040091400924009340094400954009640097400984009940100401014010240103401044010540106401074010840109401104011140112401134011440115401164011740118401194012040121401224012340124401254012640127401284012940130401314013240133401344013540136401374013840139401404014140142401434014440145401464014740148401494015040151401524015340154401554015640157401584015940160401614016240163401644016540166401674016840169401704017140172401734017440175401764017740178401794018040181401824018340184401854018640187401884018940190401914019240193401944019540196401974019840199402004020140202402034020440205402064020740208402094021040211402124021340214402154021640217402184021940220402214022240223402244022540226402274022840229402304023140232402334023440235402364023740238402394024040241402424024340244402454024640247402484024940250402514025240253402544025540256402574025840259402604026140262402634026440265402664026740268402694027040271402724027340274402754027640277402784027940280402814028240283402844028540286402874028840289402904029140292402934029440295402964029740298402994030040301403024030340304403054030640307403084030940310403114031240313403144031540316403174031840319403204032140322403234032440325403264032740328403294033040331403324033340334403354033640337403384033940340403414034240343403444034540346403474034840349403504035140352403534035440355403564035740358403594036040361403624036340364403654036640367403684036940370403714037240373403744037540376403774037840379403804038140382403834038440385403864038740388403894039040391403924039340394403954039640397403984039940400404014040240403404044040540406404074040840409404104041140412404134041440415404164041740418404194042040421404224042340424404254042640427404284042940430404314043240433404344043540436404374043840439404404044140442404434044440445404464044740448404494045040451404524045340454404554045640457404584045940460404614046240463404644046540466404674046840469404704047140472404734047440475404764047740478404794048040481404824048340484404854048640487404884048940490404914049240493404944049540496404974049840499405004050140502405034050440505405064050740508405094051040511405124051340514405154051640517405184051940520405214052240523405244052540526405274052840529405304053140532405334053440535405364053740538405394054040541405424054340544405454054640547405484054940550405514055240553405544055540556405574055840559405604056140562405634056440565405664056740568405694057040571405724057340574405754057640577405784057940580405814058240583405844058540586405874058840589405904059140592405934059440595405964059740598405994060040601406024060340604406054060640607406084060940610406114061240613406144061540616406174061840619406204062140622406234062440625406264062740628406294063040631406324063340634406354063640637406384063940640406414064240643406444064540646406474064840649406504065140652406534065440655406564065740658406594066040661406624066340664406654066640667406684066940670406714067240673406744067540676406774067840679406804068140682406834068440685406864068740688406894069040691406924069340694406954069640697406984069940700407014070240703407044070540706407074070840709407104071140712407134071440715407164071740718407194072040721407224072340724407254072640727407284072940730407314073240733407344073540736407374073840739407404074140742407434074440745407464074740748407494075040751407524075340754407554075640757407584075940760407614076240763407644076540766407674076840769407704077140772407734077440775407764077740778407794078040781407824078340784407854078640787407884078940790407914079240793407944079540796407974079840799408004080140802408034080440805408064080740808408094081040811408124081340814408154081640817408184081940820408214082240823408244082540826408274082840829408304083140832408334083440835408364083740838408394084040841408424084340844408454084640847408484084940850408514085240853408544085540856408574085840859408604086140862408634086440865408664086740868408694087040871408724087340874408754087640877408784087940880408814088240883408844088540886408874088840889408904089140892408934089440895408964089740898408994090040901409024090340904409054090640907409084090940910409114091240913409144091540916409174091840919409204092140922409234092440925409264092740928409294093040931409324093340934409354093640937409384093940940409414094240943409444094540946409474094840949409504095140952409534095440955409564095740958409594096040961409624096340964409654096640967409684096940970409714097240973409744097540976409774097840979409804098140982409834098440985409864098740988409894099040991409924099340994409954099640997409984099941000410014100241003410044100541006410074100841009410104101141012410134101441015410164101741018410194102041021410224102341024410254102641027410284102941030410314103241033410344103541036410374103841039410404104141042410434104441045410464104741048410494105041051410524105341054410554105641057410584105941060410614106241063410644106541066410674106841069410704107141072410734107441075410764107741078410794108041081410824108341084410854108641087410884108941090410914109241093410944109541096410974109841099411004110141102411034110441105411064110741108411094111041111411124111341114411154111641117411184111941120411214112241123411244112541126411274112841129411304113141132411334113441135411364113741138411394114041141411424114341144411454114641147411484114941150411514115241153411544115541156411574115841159411604116141162411634116441165411664116741168411694117041171411724117341174411754117641177411784117941180411814118241183411844118541186411874118841189411904119141192411934119441195411964119741198411994120041201412024120341204412054120641207412084120941210412114121241213412144121541216412174121841219412204122141222412234122441225412264122741228412294123041231412324123341234412354123641237412384123941240412414124241243412444124541246412474124841249412504125141252412534125441255412564125741258412594126041261412624126341264412654126641267412684126941270412714127241273412744127541276412774127841279412804128141282412834128441285412864128741288412894129041291412924129341294412954129641297412984129941300413014130241303413044130541306413074130841309413104131141312413134131441315413164131741318413194132041321413224132341324413254132641327413284132941330413314133241333413344133541336413374133841339413404134141342413434134441345413464134741348413494135041351413524135341354413554135641357413584135941360413614136241363413644136541366413674136841369413704137141372413734137441375413764137741378413794138041381413824138341384413854138641387413884138941390413914139241393413944139541396413974139841399414004140141402414034140441405414064140741408414094141041411414124141341414414154141641417414184141941420414214142241423414244142541426414274142841429414304143141432414334143441435414364143741438414394144041441414424144341444414454144641447414484144941450414514145241453414544145541456414574145841459414604146141462414634146441465414664146741468414694147041471414724147341474414754147641477414784147941480414814148241483414844148541486414874148841489414904149141492414934149441495414964149741498414994150041501415024150341504415054150641507415084150941510415114151241513415144151541516415174151841519415204152141522415234152441525415264152741528415294153041531415324153341534415354153641537415384153941540415414154241543415444154541546415474154841549415504155141552415534155441555415564155741558415594156041561415624156341564415654156641567415684156941570415714157241573415744157541576415774157841579415804158141582415834158441585415864158741588415894159041591415924159341594415954159641597415984159941600416014160241603416044160541606416074160841609416104161141612416134161441615416164161741618416194162041621416224162341624416254162641627416284162941630416314163241633416344163541636416374163841639416404164141642416434164441645416464164741648416494165041651416524165341654416554165641657416584165941660416614166241663416644166541666416674166841669416704167141672416734167441675416764167741678416794168041681416824168341684416854168641687416884168941690416914169241693416944169541696416974169841699417004170141702417034170441705417064170741708417094171041711417124171341714417154171641717417184171941720417214172241723417244172541726417274172841729417304173141732417334173441735417364173741738417394174041741417424174341744417454174641747417484174941750417514175241753417544175541756417574175841759417604176141762417634176441765417664176741768417694177041771417724177341774417754177641777417784177941780417814178241783417844178541786417874178841789417904179141792417934179441795417964179741798417994180041801418024180341804418054180641807418084180941810418114181241813418144181541816418174181841819418204182141822418234182441825418264182741828418294183041831418324183341834418354183641837418384183941840418414184241843418444184541846418474184841849418504185141852418534185441855418564185741858418594186041861418624186341864418654186641867418684186941870418714187241873418744187541876418774187841879418804188141882418834188441885418864188741888418894189041891418924189341894418954189641897418984189941900419014190241903419044190541906419074190841909419104191141912419134191441915419164191741918419194192041921419224192341924419254192641927419284192941930419314193241933419344193541936419374193841939419404194141942419434194441945419464194741948419494195041951419524195341954419554195641957419584195941960419614196241963419644196541966419674196841969419704197141972419734197441975419764197741978419794198041981419824198341984419854198641987419884198941990419914199241993419944199541996419974199841999420004200142002420034200442005420064200742008420094201042011420124201342014420154201642017420184201942020420214202242023420244202542026420274202842029420304203142032420334203442035420364203742038420394204042041420424204342044420454204642047420484204942050420514205242053420544205542056420574205842059420604206142062420634206442065420664206742068420694207042071420724207342074420754207642077420784207942080420814208242083420844208542086420874208842089420904209142092420934209442095420964209742098420994210042101421024210342104421054210642107421084210942110421114211242113421144211542116421174211842119421204212142122421234212442125421264212742128421294213042131421324213342134421354213642137421384213942140421414214242143421444214542146421474214842149421504215142152421534215442155421564215742158421594216042161421624216342164421654216642167421684216942170421714217242173421744217542176421774217842179421804218142182421834218442185421864218742188421894219042191421924219342194421954219642197421984219942200422014220242203422044220542206422074220842209422104221142212422134221442215422164221742218422194222042221422224222342224422254222642227422284222942230422314223242233422344223542236422374223842239422404224142242422434224442245422464224742248422494225042251422524225342254422554225642257422584225942260422614226242263422644226542266422674226842269422704227142272422734227442275422764227742278422794228042281422824228342284422854228642287422884228942290422914229242293422944229542296422974229842299423004230142302423034230442305423064230742308423094231042311423124231342314423154231642317423184231942320423214232242323423244232542326423274232842329423304233142332423334233442335423364233742338423394234042341423424234342344423454234642347423484234942350423514235242353423544235542356423574235842359423604236142362423634236442365423664236742368423694237042371423724237342374423754237642377423784237942380423814238242383423844238542386423874238842389423904239142392423934239442395423964239742398423994240042401424024240342404424054240642407424084240942410424114241242413424144241542416424174241842419424204242142422424234242442425424264242742428424294243042431424324243342434424354243642437424384243942440424414244242443424444244542446424474244842449424504245142452424534245442455424564245742458424594246042461424624246342464424654246642467424684246942470424714247242473424744247542476424774247842479424804248142482424834248442485424864248742488424894249042491424924249342494424954249642497424984249942500425014250242503425044250542506425074250842509425104251142512425134251442515425164251742518425194252042521425224252342524425254252642527425284252942530425314253242533425344253542536425374253842539425404254142542425434254442545425464254742548425494255042551425524255342554425554255642557425584255942560425614256242563425644256542566425674256842569425704257142572425734257442575425764257742578425794258042581425824258342584425854258642587425884258942590425914259242593425944259542596425974259842599426004260142602426034260442605426064260742608426094261042611426124261342614426154261642617426184261942620426214262242623426244262542626426274262842629426304263142632426334263442635426364263742638426394264042641426424264342644426454264642647426484264942650426514265242653426544265542656426574265842659426604266142662426634266442665426664266742668426694267042671426724267342674426754267642677426784267942680426814268242683426844268542686426874268842689426904269142692426934269442695426964269742698426994270042701427024270342704427054270642707427084270942710427114271242713427144271542716427174271842719427204272142722427234272442725427264272742728427294273042731427324273342734427354273642737427384273942740427414274242743427444274542746427474274842749427504275142752427534275442755427564275742758427594276042761427624276342764427654276642767427684276942770427714277242773427744277542776427774277842779427804278142782427834278442785427864278742788427894279042791427924279342794427954279642797427984279942800428014280242803428044280542806428074280842809428104281142812428134281442815428164281742818428194282042821428224282342824428254282642827428284282942830428314283242833428344283542836428374283842839428404284142842428434284442845428464284742848428494285042851428524285342854428554285642857428584285942860428614286242863428644286542866428674286842869428704287142872428734287442875428764287742878428794288042881428824288342884428854288642887428884288942890428914289242893428944289542896428974289842899429004290142902429034290442905429064290742908429094291042911429124291342914429154291642917429184291942920429214292242923429244292542926429274292842929429304293142932429334293442935429364293742938429394294042941429424294342944429454294642947429484294942950429514295242953429544295542956429574295842959429604296142962429634296442965429664296742968429694297042971429724297342974429754297642977429784297942980429814298242983429844298542986429874298842989429904299142992429934299442995429964299742998429994300043001430024300343004430054300643007430084300943010430114301243013430144301543016430174301843019430204302143022430234302443025430264302743028430294303043031430324303343034430354303643037430384303943040430414304243043430444304543046430474304843049430504305143052430534305443055430564305743058430594306043061430624306343064430654306643067430684306943070430714307243073430744307543076430774307843079430804308143082430834308443085430864308743088430894309043091430924309343094430954309643097430984309943100431014310243103431044310543106431074310843109431104311143112431134311443115431164311743118431194312043121431224312343124431254312643127431284312943130431314313243133431344313543136431374313843139431404314143142431434314443145431464314743148431494315043151431524315343154431554315643157431584315943160431614316243163431644316543166431674316843169431704317143172431734317443175431764317743178431794318043181431824318343184431854318643187431884318943190431914319243193431944319543196431974319843199432004320143202432034320443205432064320743208432094321043211432124321343214432154321643217432184321943220432214322243223432244322543226432274322843229432304323143232432334323443235432364323743238432394324043241432424324343244432454324643247432484324943250432514325243253432544325543256432574325843259432604326143262432634326443265432664326743268432694327043271432724327343274432754327643277432784327943280432814328243283432844328543286432874328843289432904329143292432934329443295432964329743298432994330043301433024330343304433054330643307433084330943310433114331243313433144331543316433174331843319433204332143322433234332443325433264332743328433294333043331433324333343334433354333643337433384333943340433414334243343433444334543346433474334843349433504335143352433534335443355433564335743358433594336043361433624336343364433654336643367433684336943370433714337243373433744337543376433774337843379433804338143382433834338443385433864338743388433894339043391433924339343394433954339643397433984339943400434014340243403434044340543406434074340843409434104341143412434134341443415434164341743418434194342043421434224342343424434254342643427434284342943430434314343243433434344343543436434374343843439434404344143442434434344443445434464344743448434494345043451434524345343454434554345643457434584345943460434614346243463434644346543466434674346843469434704347143472434734347443475434764347743478434794348043481434824348343484434854348643487434884348943490434914349243493434944349543496434974349843499435004350143502435034350443505435064350743508435094351043511435124351343514435154351643517435184351943520435214352243523435244352543526435274352843529435304353143532435334353443535435364353743538435394354043541435424354343544435454354643547435484354943550435514355243553435544355543556435574355843559435604356143562435634356443565435664356743568435694357043571435724357343574435754357643577435784357943580435814358243583435844358543586435874358843589435904359143592435934359443595435964359743598435994360043601436024360343604436054360643607436084360943610436114361243613436144361543616436174361843619436204362143622436234362443625436264362743628436294363043631436324363343634436354363643637436384363943640436414364243643436444364543646436474364843649436504365143652436534365443655436564365743658436594366043661436624366343664436654366643667436684366943670436714367243673436744367543676436774367843679436804368143682436834368443685436864368743688436894369043691436924369343694436954369643697436984369943700437014370243703437044370543706437074370843709437104371143712437134371443715437164371743718437194372043721437224372343724437254372643727437284372943730437314373243733437344373543736437374373843739437404374143742437434374443745437464374743748437494375043751437524375343754437554375643757437584375943760437614376243763437644376543766437674376843769437704377143772437734377443775437764377743778437794378043781437824378343784437854378643787437884378943790437914379243793437944379543796437974379843799438004380143802438034380443805438064380743808438094381043811438124381343814438154381643817438184381943820438214382243823438244382543826438274382843829438304383143832438334383443835438364383743838438394384043841438424384343844438454384643847438484384943850438514385243853438544385543856438574385843859438604386143862438634386443865438664386743868438694387043871438724387343874438754387643877438784387943880438814388243883438844388543886438874388843889438904389143892438934389443895438964389743898438994390043901439024390343904439054390643907439084390943910439114391243913439144391543916439174391843919439204392143922439234392443925439264392743928439294393043931439324393343934439354393643937439384393943940439414394243943439444394543946439474394843949439504395143952439534395443955439564395743958439594396043961439624396343964439654396643967439684396943970439714397243973439744397543976439774397843979439804398143982439834398443985439864398743988439894399043991439924399343994439954399643997439984399944000440014400244003440044400544006440074400844009440104401144012440134401444015440164401744018440194402044021440224402344024440254402644027440284402944030440314403244033440344403544036440374403844039440404404144042440434404444045440464404744048440494405044051440524405344054440554405644057440584405944060440614406244063440644406544066440674406844069440704407144072440734407444075440764407744078440794408044081440824408344084440854408644087440884408944090440914409244093440944409544096440974409844099441004410144102441034410444105441064410744108441094411044111441124411344114441154411644117441184411944120441214412244123441244412544126441274412844129441304413144132441334413444135441364413744138441394414044141441424414344144441454414644147441484414944150441514415244153441544415544156441574415844159441604416144162441634416444165441664416744168441694417044171441724417344174441754417644177441784417944180441814418244183441844418544186441874418844189441904419144192441934419444195441964419744198441994420044201442024420344204442054420644207442084420944210442114421244213442144421544216442174421844219442204422144222442234422444225442264422744228442294423044231442324423344234442354423644237442384423944240442414424244243442444424544246442474424844249442504425144252442534425444255442564425744258442594426044261442624426344264442654426644267442684426944270442714427244273442744427544276442774427844279442804428144282442834428444285442864428744288442894429044291442924429344294442954429644297442984429944300443014430244303443044430544306443074430844309443104431144312443134431444315443164431744318443194432044321443224432344324443254432644327443284432944330443314433244333443344433544336443374433844339443404434144342443434434444345443464434744348443494435044351443524435344354443554435644357443584435944360443614436244363443644436544366443674436844369443704437144372443734437444375443764437744378443794438044381443824438344384443854438644387443884438944390443914439244393443944439544396443974439844399444004440144402444034440444405444064440744408444094441044411444124441344414444154441644417444184441944420444214442244423444244442544426444274442844429444304443144432444334443444435444364443744438444394444044441444424444344444444454444644447444484444944450444514445244453444544445544456444574445844459444604446144462444634446444465444664446744468444694447044471444724447344474444754447644477444784447944480444814448244483444844448544486444874448844489444904449144492444934449444495444964449744498444994450044501445024450344504445054450644507445084450944510445114451244513445144451544516445174451844519445204452144522445234452444525445264452744528445294453044531445324453344534445354453644537445384453944540445414454244543445444454544546445474454844549445504455144552445534455444555445564455744558445594456044561445624456344564445654456644567445684456944570445714457244573445744457544576445774457844579445804458144582445834458444585445864458744588445894459044591445924459344594445954459644597445984459944600446014460244603446044460544606446074460844609446104461144612446134461444615446164461744618446194462044621446224462344624446254462644627446284462944630446314463244633446344463544636446374463844639446404464144642446434464444645446464464744648446494465044651446524465344654446554465644657446584465944660446614466244663446644466544666446674466844669446704467144672446734467444675446764467744678446794468044681446824468344684446854468644687446884468944690446914469244693446944469544696446974469844699447004470144702447034470444705447064470744708447094471044711447124471344714447154471644717447184471944720447214472244723447244472544726447274472844729447304473144732447334473444735447364473744738447394474044741447424474344744447454474644747447484474944750447514475244753447544475544756447574475844759447604476144762447634476444765447664476744768447694477044771447724477344774447754477644777447784477944780447814478244783447844478544786447874478844789447904479144792447934479444795447964479744798447994480044801448024480344804448054480644807448084480944810448114481244813448144481544816448174481844819448204482144822448234482444825448264482744828448294483044831448324483344834448354483644837448384483944840448414484244843448444484544846448474484844849448504485144852448534485444855448564485744858448594486044861448624486344864448654486644867448684486944870448714487244873448744487544876448774487844879448804488144882448834488444885448864488744888448894489044891448924489344894448954489644897448984489944900449014490244903449044490544906449074490844909449104491144912449134491444915449164491744918449194492044921449224492344924449254492644927449284492944930449314493244933449344493544936449374493844939449404494144942449434494444945449464494744948449494495044951449524495344954449554495644957449584495944960449614496244963449644496544966449674496844969449704497144972449734497444975449764497744978449794498044981449824498344984449854498644987449884498944990449914499244993449944499544996449974499844999450004500145002450034500445005450064500745008450094501045011450124501345014450154501645017450184501945020450214502245023450244502545026450274502845029450304503145032450334503445035450364503745038450394504045041450424504345044450454504645047450484504945050450514505245053450544505545056450574505845059450604506145062450634506445065450664506745068450694507045071450724507345074450754507645077450784507945080450814508245083450844508545086450874508845089450904509145092450934509445095450964509745098450994510045101451024510345104451054510645107451084510945110451114511245113451144511545116451174511845119451204512145122451234512445125451264512745128451294513045131451324513345134451354513645137451384513945140451414514245143451444514545146451474514845149451504515145152451534515445155451564515745158451594516045161451624516345164451654516645167451684516945170451714517245173451744517545176451774517845179451804518145182451834518445185451864518745188451894519045191451924519345194451954519645197451984519945200452014520245203452044520545206452074520845209452104521145212452134521445215452164521745218452194522045221452224522345224452254522645227452284522945230452314523245233452344523545236452374523845239452404524145242452434524445245452464524745248452494525045251452524525345254452554525645257452584525945260452614526245263452644526545266452674526845269452704527145272452734527445275452764527745278452794528045281452824528345284452854528645287452884528945290452914529245293452944529545296452974529845299453004530145302453034530445305453064530745308453094531045311453124531345314453154531645317453184531945320453214532245323453244532545326453274532845329453304533145332453334533445335453364533745338453394534045341453424534345344453454534645347453484534945350453514535245353453544535545356453574535845359453604536145362453634536445365453664536745368453694537045371453724537345374453754537645377453784537945380453814538245383453844538545386453874538845389453904539145392453934539445395453964539745398453994540045401454024540345404454054540645407454084540945410454114541245413454144541545416454174541845419454204542145422454234542445425454264542745428454294543045431454324543345434454354543645437454384543945440454414544245443454444544545446454474544845449454504545145452454534545445455454564545745458454594546045461454624546345464454654546645467454684546945470454714547245473454744547545476454774547845479454804548145482454834548445485454864548745488454894549045491454924549345494454954549645497454984549945500455014550245503455044550545506455074550845509455104551145512455134551445515455164551745518455194552045521455224552345524455254552645527455284552945530455314553245533455344553545536455374553845539455404554145542455434554445545455464554745548455494555045551455524555345554455554555645557455584555945560455614556245563455644556545566455674556845569455704557145572455734557445575455764557745578455794558045581455824558345584455854558645587455884558945590455914559245593455944559545596455974559845599456004560145602456034560445605456064560745608456094561045611456124561345614456154561645617456184561945620456214562245623456244562545626456274562845629456304563145632456334563445635456364563745638456394564045641456424564345644456454564645647456484564945650456514565245653456544565545656456574565845659456604566145662456634566445665456664566745668456694567045671456724567345674456754567645677456784567945680456814568245683456844568545686456874568845689456904569145692456934569445695456964569745698456994570045701457024570345704457054570645707457084570945710457114571245713457144571545716457174571845719457204572145722457234572445725457264572745728457294573045731457324573345734457354573645737457384573945740457414574245743457444574545746457474574845749457504575145752457534575445755457564575745758457594576045761457624576345764457654576645767457684576945770457714577245773457744577545776457774577845779457804578145782457834578445785457864578745788457894579045791457924579345794457954579645797457984579945800458014580245803458044580545806458074580845809458104581145812458134581445815458164581745818458194582045821458224582345824458254582645827458284582945830458314583245833458344583545836458374583845839458404584145842458434584445845458464584745848458494585045851458524585345854458554585645857458584585945860458614586245863458644586545866458674586845869458704587145872458734587445875458764587745878458794588045881458824588345884458854588645887458884588945890458914589245893458944589545896458974589845899459004590145902459034590445905459064590745908459094591045911459124591345914459154591645917459184591945920459214592245923459244592545926459274592845929459304593145932459334593445935459364593745938459394594045941459424594345944459454594645947459484594945950459514595245953459544595545956459574595845959459604596145962459634596445965459664596745968459694597045971459724597345974459754597645977459784597945980459814598245983459844598545986459874598845989459904599145992459934599445995459964599745998459994600046001460024600346004460054600646007460084600946010460114601246013460144601546016460174601846019460204602146022460234602446025460264602746028460294603046031460324603346034460354603646037460384603946040460414604246043460444604546046460474604846049460504605146052460534605446055460564605746058460594606046061460624606346064460654606646067460684606946070460714607246073460744607546076460774607846079460804608146082460834608446085460864608746088460894609046091460924609346094460954609646097460984609946100461014610246103461044610546106461074610846109461104611146112461134611446115461164611746118461194612046121461224612346124461254612646127461284612946130461314613246133461344613546136461374613846139461404614146142461434614446145461464614746148461494615046151461524615346154461554615646157461584615946160461614616246163461644616546166461674616846169461704617146172461734617446175461764617746178461794618046181461824618346184461854618646187461884618946190461914619246193461944619546196461974619846199462004620146202462034620446205462064620746208462094621046211462124621346214462154621646217462184621946220462214622246223462244622546226462274622846229462304623146232462334623446235462364623746238462394624046241462424624346244462454624646247462484624946250462514625246253462544625546256462574625846259462604626146262462634626446265462664626746268462694627046271462724627346274462754627646277462784627946280462814628246283462844628546286462874628846289462904629146292462934629446295462964629746298462994630046301463024630346304463054630646307463084630946310463114631246313463144631546316463174631846319463204632146322463234632446325463264632746328463294633046331463324633346334463354633646337463384633946340463414634246343463444634546346463474634846349463504635146352463534635446355463564635746358463594636046361463624636346364463654636646367463684636946370463714637246373463744637546376463774637846379463804638146382463834638446385463864638746388463894639046391463924639346394463954639646397463984639946400464014640246403464044640546406464074640846409464104641146412464134641446415464164641746418464194642046421464224642346424464254642646427464284642946430464314643246433464344643546436464374643846439464404644146442464434644446445464464644746448464494645046451464524645346454464554645646457464584645946460464614646246463464644646546466464674646846469464704647146472464734647446475464764647746478464794648046481464824648346484464854648646487464884648946490464914649246493464944649546496464974649846499465004650146502465034650446505465064650746508465094651046511465124651346514465154651646517465184651946520465214652246523465244652546526465274652846529465304653146532465334653446535465364653746538465394654046541465424654346544465454654646547465484654946550465514655246553465544655546556465574655846559465604656146562465634656446565465664656746568465694657046571465724657346574465754657646577465784657946580465814658246583465844658546586465874658846589465904659146592465934659446595465964659746598465994660046601466024660346604466054660646607466084660946610466114661246613466144661546616466174661846619466204662146622466234662446625466264662746628466294663046631466324663346634466354663646637466384663946640466414664246643466444664546646466474664846649466504665146652466534665446655466564665746658466594666046661466624666346664466654666646667466684666946670466714667246673466744667546676466774667846679466804668146682466834668446685466864668746688466894669046691466924669346694466954669646697466984669946700467014670246703467044670546706467074670846709467104671146712467134671446715467164671746718467194672046721467224672346724467254672646727467284672946730467314673246733467344673546736467374673846739467404674146742467434674446745467464674746748467494675046751467524675346754467554675646757467584675946760467614676246763467644676546766467674676846769467704677146772467734677446775467764677746778467794678046781467824678346784467854678646787467884678946790467914679246793467944679546796467974679846799468004680146802468034680446805468064680746808468094681046811468124681346814468154681646817468184681946820468214682246823468244682546826468274682846829468304683146832468334683446835468364683746838468394684046841468424684346844468454684646847468484684946850468514685246853468544685546856468574685846859468604686146862468634686446865468664686746868468694687046871468724687346874468754687646877468784687946880468814688246883468844688546886468874688846889468904689146892468934689446895468964689746898468994690046901469024690346904469054690646907469084690946910469114691246913469144691546916469174691846919469204692146922469234692446925469264692746928469294693046931469324693346934469354693646937469384693946940469414694246943469444694546946469474694846949469504695146952469534695446955469564695746958469594696046961469624696346964469654696646967469684696946970469714697246973469744697546976469774697846979469804698146982469834698446985469864698746988469894699046991469924699346994469954699646997469984699947000470014700247003470044700547006470074700847009470104701147012470134701447015470164701747018470194702047021470224702347024470254702647027470284702947030470314703247033470344703547036470374703847039470404704147042470434704447045470464704747048470494705047051470524705347054470554705647057470584705947060470614706247063470644706547066470674706847069470704707147072470734707447075470764707747078470794708047081470824708347084470854708647087470884708947090470914709247093470944709547096470974709847099471004710147102471034710447105471064710747108471094711047111471124711347114471154711647117471184711947120471214712247123471244712547126471274712847129471304713147132471334713447135471364713747138471394714047141471424714347144471454714647147471484714947150471514715247153471544715547156471574715847159471604716147162471634716447165471664716747168471694717047171471724717347174471754717647177471784717947180471814718247183471844718547186471874718847189471904719147192471934719447195471964719747198471994720047201472024720347204472054720647207472084720947210472114721247213472144721547216472174721847219472204722147222472234722447225472264722747228472294723047231472324723347234472354723647237472384723947240472414724247243472444724547246472474724847249472504725147252472534725447255472564725747258472594726047261472624726347264472654726647267472684726947270472714727247273472744727547276472774727847279472804728147282472834728447285472864728747288472894729047291472924729347294472954729647297472984729947300473014730247303473044730547306473074730847309473104731147312473134731447315473164731747318473194732047321473224732347324473254732647327473284732947330473314733247333473344733547336473374733847339473404734147342473434734447345473464734747348473494735047351473524735347354473554735647357473584735947360473614736247363473644736547366473674736847369473704737147372473734737447375473764737747378473794738047381473824738347384473854738647387473884738947390473914739247393473944739547396473974739847399474004740147402474034740447405474064740747408474094741047411474124741347414474154741647417474184741947420474214742247423474244742547426474274742847429474304743147432474334743447435474364743747438474394744047441474424744347444474454744647447474484744947450474514745247453474544745547456474574745847459474604746147462474634746447465474664746747468474694747047471474724747347474474754747647477474784747947480474814748247483474844748547486474874748847489474904749147492474934749447495474964749747498474994750047501475024750347504475054750647507475084750947510475114751247513475144751547516475174751847519475204752147522475234752447525475264752747528475294753047531475324753347534475354753647537475384753947540475414754247543475444754547546475474754847549475504755147552475534755447555475564755747558475594756047561475624756347564475654756647567475684756947570475714757247573475744757547576475774757847579475804758147582475834758447585475864758747588475894759047591475924759347594475954759647597475984759947600476014760247603476044760547606476074760847609476104761147612476134761447615476164761747618476194762047621476224762347624476254762647627476284762947630476314763247633476344763547636476374763847639476404764147642476434764447645476464764747648476494765047651476524765347654476554765647657476584765947660476614766247663476644766547666476674766847669476704767147672476734767447675476764767747678476794768047681476824768347684476854768647687476884768947690476914769247693476944769547696476974769847699477004770147702477034770447705477064770747708477094771047711477124771347714477154771647717477184771947720477214772247723477244772547726477274772847729477304773147732477334773447735477364773747738477394774047741477424774347744477454774647747477484774947750477514775247753477544775547756477574775847759477604776147762477634776447765477664776747768477694777047771477724777347774477754777647777477784777947780477814778247783477844778547786477874778847789477904779147792477934779447795477964779747798477994780047801478024780347804478054780647807478084780947810478114781247813478144781547816478174781847819478204782147822478234782447825478264782747828478294783047831478324783347834478354783647837478384783947840478414784247843478444784547846478474784847849478504785147852478534785447855478564785747858478594786047861478624786347864478654786647867478684786947870478714787247873478744787547876478774787847879478804788147882478834788447885478864788747888478894789047891478924789347894478954789647897478984789947900479014790247903479044790547906479074790847909479104791147912479134791447915479164791747918479194792047921479224792347924479254792647927479284792947930479314793247933479344793547936479374793847939479404794147942479434794447945479464794747948479494795047951479524795347954479554795647957479584795947960479614796247963479644796547966479674796847969479704797147972479734797447975479764797747978479794798047981479824798347984479854798647987479884798947990479914799247993479944799547996479974799847999480004800148002480034800448005480064800748008480094801048011480124801348014480154801648017480184801948020480214802248023480244802548026480274802848029480304803148032480334803448035480364803748038480394804048041480424804348044480454804648047480484804948050480514805248053480544805548056480574805848059480604806148062480634806448065480664806748068480694807048071480724807348074480754807648077480784807948080480814808248083480844808548086480874808848089480904809148092480934809448095480964809748098480994810048101481024810348104481054810648107481084810948110481114811248113481144811548116481174811848119481204812148122481234812448125481264812748128481294813048131481324813348134481354813648137481384813948140481414814248143481444814548146481474814848149481504815148152481534815448155481564815748158481594816048161481624816348164481654816648167481684816948170481714817248173481744817548176481774817848179481804818148182481834818448185481864818748188481894819048191481924819348194481954819648197481984819948200482014820248203482044820548206482074820848209482104821148212482134821448215482164821748218482194822048221482224822348224482254822648227482284822948230482314823248233482344823548236482374823848239482404824148242482434824448245482464824748248482494825048251482524825348254482554825648257482584825948260482614826248263482644826548266482674826848269482704827148272482734827448275482764827748278482794828048281482824828348284482854828648287482884828948290482914829248293482944829548296482974829848299483004830148302483034830448305483064830748308483094831048311483124831348314483154831648317483184831948320483214832248323483244832548326483274832848329483304833148332483334833448335483364833748338483394834048341483424834348344483454834648347483484834948350483514835248353483544835548356483574835848359483604836148362483634836448365483664836748368483694837048371483724837348374483754837648377483784837948380483814838248383483844838548386483874838848389483904839148392483934839448395483964839748398483994840048401484024840348404484054840648407484084840948410484114841248413484144841548416484174841848419484204842148422484234842448425484264842748428484294843048431484324843348434484354843648437484384843948440484414844248443484444844548446484474844848449484504845148452484534845448455484564845748458484594846048461484624846348464484654846648467484684846948470484714847248473484744847548476484774847848479484804848148482484834848448485484864848748488484894849048491484924849348494484954849648497484984849948500485014850248503485044850548506485074850848509485104851148512485134851448515485164851748518485194852048521485224852348524485254852648527485284852948530485314853248533485344853548536485374853848539485404854148542485434854448545485464854748548485494855048551485524855348554485554855648557485584855948560485614856248563485644856548566485674856848569485704857148572485734857448575485764857748578485794858048581485824858348584485854858648587485884858948590485914859248593485944859548596485974859848599486004860148602486034860448605486064860748608486094861048611486124861348614486154861648617486184861948620486214862248623486244862548626486274862848629486304863148632486334863448635486364863748638486394864048641486424864348644486454864648647486484864948650486514865248653486544865548656486574865848659486604866148662486634866448665486664866748668486694867048671486724867348674486754867648677486784867948680486814868248683486844868548686486874868848689486904869148692486934869448695486964869748698486994870048701487024870348704487054870648707487084870948710487114871248713487144871548716487174871848719487204872148722487234872448725487264872748728487294873048731487324873348734487354873648737487384873948740487414874248743487444874548746487474874848749487504875148752487534875448755487564875748758487594876048761487624876348764487654876648767487684876948770487714877248773487744877548776487774877848779487804878148782487834878448785487864878748788487894879048791487924879348794487954879648797487984879948800488014880248803488044880548806488074880848809488104881148812488134881448815488164881748818488194882048821488224882348824488254882648827488284882948830488314883248833488344883548836488374883848839488404884148842488434884448845488464884748848488494885048851488524885348854488554885648857488584885948860488614886248863488644886548866488674886848869488704887148872488734887448875488764887748878488794888048881488824888348884488854888648887488884888948890488914889248893488944889548896488974889848899489004890148902489034890448905489064890748908489094891048911489124891348914489154891648917489184891948920489214892248923489244892548926489274892848929489304893148932489334893448935489364893748938489394894048941489424894348944489454894648947489484894948950489514895248953489544895548956489574895848959489604896148962489634896448965489664896748968489694897048971489724897348974489754897648977489784897948980489814898248983489844898548986489874898848989489904899148992489934899448995489964899748998489994900049001490024900349004490054900649007490084900949010490114901249013490144901549016490174901849019490204902149022490234902449025490264902749028490294903049031490324903349034490354903649037490384903949040490414904249043490444904549046490474904849049490504905149052490534905449055490564905749058490594906049061490624906349064490654906649067490684906949070490714907249073490744907549076490774907849079490804908149082490834908449085490864908749088490894909049091490924909349094490954909649097490984909949100491014910249103491044910549106491074910849109491104911149112491134911449115491164911749118491194912049121491224912349124491254912649127491284912949130491314913249133491344913549136491374913849139491404914149142491434914449145491464914749148491494915049151491524915349154491554915649157491584915949160491614916249163491644916549166491674916849169491704917149172491734917449175491764917749178491794918049181491824918349184491854918649187491884918949190491914919249193491944919549196491974919849199492004920149202492034920449205492064920749208492094921049211492124921349214492154921649217492184921949220492214922249223492244922549226492274922849229492304923149232492334923449235492364923749238492394924049241492424924349244492454924649247492484924949250492514925249253492544925549256492574925849259492604926149262492634926449265492664926749268492694927049271492724927349274492754927649277492784927949280492814928249283492844928549286492874928849289492904929149292492934929449295492964929749298492994930049301493024930349304493054930649307493084930949310493114931249313493144931549316493174931849319493204932149322493234932449325493264932749328493294933049331493324933349334493354933649337493384933949340493414934249343493444934549346493474934849349493504935149352493534935449355493564935749358493594936049361493624936349364493654936649367493684936949370493714937249373493744937549376493774937849379493804938149382493834938449385493864938749388493894939049391493924939349394493954939649397493984939949400494014940249403494044940549406494074940849409494104941149412494134941449415494164941749418494194942049421494224942349424494254942649427494284942949430494314943249433494344943549436494374943849439494404944149442494434944449445494464944749448494494945049451494524945349454494554945649457494584945949460494614946249463494644946549466494674946849469494704947149472494734947449475494764947749478494794948049481494824948349484494854948649487494884948949490494914949249493494944949549496494974949849499495004950149502495034950449505495064950749508495094951049511495124951349514495154951649517495184951949520495214952249523495244952549526495274952849529495304953149532495334953449535495364953749538495394954049541495424954349544495454954649547495484954949550495514955249553495544955549556495574955849559495604956149562495634956449565495664956749568495694957049571495724957349574495754957649577495784957949580495814958249583495844958549586495874958849589495904959149592495934959449595495964959749598495994960049601496024960349604496054960649607496084960949610496114961249613496144961549616496174961849619496204962149622496234962449625496264962749628496294963049631496324963349634496354963649637496384963949640496414964249643496444964549646496474964849649496504965149652496534965449655496564965749658496594966049661496624966349664496654966649667496684966949670496714967249673496744967549676496774967849679496804968149682496834968449685496864968749688496894969049691496924969349694496954969649697496984969949700497014970249703497044970549706497074970849709497104971149712497134971449715497164971749718497194972049721497224972349724497254972649727497284972949730497314973249733497344973549736497374973849739497404974149742497434974449745497464974749748497494975049751497524975349754497554975649757497584975949760497614976249763497644976549766497674976849769497704977149772497734977449775497764977749778497794978049781497824978349784497854978649787497884978949790497914979249793497944979549796497974979849799498004980149802498034980449805498064980749808498094981049811498124981349814498154981649817498184981949820498214982249823498244982549826498274982849829498304983149832498334983449835498364983749838498394984049841498424984349844498454984649847498484984949850498514985249853498544985549856498574985849859498604986149862498634986449865498664986749868498694987049871498724987349874498754987649877498784987949880498814988249883498844988549886498874988849889498904989149892498934989449895498964989749898498994990049901499024990349904499054990649907499084990949910499114991249913499144991549916499174991849919499204992149922499234992449925499264992749928499294993049931499324993349934499354993649937499384993949940499414994249943499444994549946499474994849949499504995149952499534995449955499564995749958499594996049961499624996349964499654996649967499684996949970499714997249973499744997549976499774997849979499804998149982499834998449985499864998749988499894999049991499924999349994499954999649997499984999950000500015000250003500045000550006500075000850009500105001150012500135001450015500165001750018500195002050021500225002350024500255002650027500285002950030500315003250033500345003550036500375003850039500405004150042500435004450045500465004750048500495005050051500525005350054500555005650057500585005950060500615006250063500645006550066500675006850069500705007150072500735007450075500765007750078500795008050081500825008350084500855008650087500885008950090500915009250093500945009550096500975009850099501005010150102501035010450105501065010750108501095011050111501125011350114501155011650117501185011950120501215012250123501245012550126501275012850129501305013150132501335013450135501365013750138501395014050141501425014350144501455014650147501485014950150501515015250153501545015550156501575015850159501605016150162501635016450165501665016750168501695017050171501725017350174501755017650177501785017950180501815018250183501845018550186501875018850189501905019150192501935019450195501965019750198501995020050201502025020350204502055020650207502085020950210502115021250213502145021550216502175021850219502205022150222502235022450225502265022750228502295023050231502325023350234502355023650237502385023950240502415024250243502445024550246502475024850249502505025150252502535025450255502565025750258502595026050261502625026350264502655026650267502685026950270502715027250273502745027550276502775027850279502805028150282502835028450285502865028750288502895029050291502925029350294502955029650297502985029950300503015030250303503045030550306503075030850309503105031150312503135031450315503165031750318503195032050321503225032350324503255032650327503285032950330503315033250333503345033550336503375033850339503405034150342503435034450345503465034750348503495035050351503525035350354503555035650357503585035950360503615036250363503645036550366503675036850369503705037150372503735037450375503765037750378503795038050381503825038350384503855038650387503885038950390503915039250393503945039550396503975039850399504005040150402504035040450405504065040750408504095041050411504125041350414504155041650417504185041950420504215042250423504245042550426504275042850429504305043150432504335043450435504365043750438504395044050441504425044350444504455044650447504485044950450504515045250453504545045550456504575045850459504605046150462504635046450465504665046750468504695047050471504725047350474504755047650477504785047950480504815048250483504845048550486504875048850489504905049150492504935049450495504965049750498504995050050501505025050350504505055050650507505085050950510505115051250513505145051550516505175051850519505205052150522505235052450525505265052750528505295053050531505325053350534505355053650537505385053950540505415054250543505445054550546505475054850549505505055150552505535055450555505565055750558505595056050561505625056350564505655056650567505685056950570505715057250573505745057550576505775057850579505805058150582505835058450585505865058750588505895059050591505925059350594505955059650597505985059950600506015060250603506045060550606506075060850609506105061150612506135061450615506165061750618506195062050621506225062350624506255062650627506285062950630506315063250633506345063550636506375063850639506405064150642506435064450645506465064750648506495065050651506525065350654506555065650657506585065950660506615066250663506645066550666506675066850669506705067150672506735067450675506765067750678506795068050681506825068350684506855068650687506885068950690506915069250693506945069550696506975069850699507005070150702507035070450705507065070750708507095071050711507125071350714507155071650717507185071950720507215072250723507245072550726507275072850729507305073150732507335073450735507365073750738507395074050741507425074350744507455074650747507485074950750507515075250753507545075550756507575075850759507605076150762507635076450765507665076750768507695077050771507725077350774507755077650777507785077950780507815078250783507845078550786507875078850789507905079150792507935079450795507965079750798507995080050801508025080350804508055080650807508085080950810508115081250813508145081550816508175081850819508205082150822508235082450825508265082750828508295083050831508325083350834508355083650837508385083950840508415084250843508445084550846508475084850849508505085150852508535085450855508565085750858508595086050861508625086350864508655086650867508685086950870508715087250873508745087550876508775087850879508805088150882508835088450885508865088750888508895089050891508925089350894508955089650897508985089950900509015090250903509045090550906509075090850909509105091150912509135091450915509165091750918509195092050921509225092350924509255092650927509285092950930509315093250933509345093550936509375093850939509405094150942509435094450945509465094750948509495095050951509525095350954509555095650957509585095950960509615096250963509645096550966509675096850969509705097150972509735097450975509765097750978509795098050981509825098350984509855098650987509885098950990509915099250993509945099550996509975099850999510005100151002510035100451005510065100751008510095101051011510125101351014510155101651017510185101951020510215102251023510245102551026510275102851029510305103151032510335103451035510365103751038510395104051041510425104351044510455104651047510485104951050510515105251053510545105551056510575105851059510605106151062510635106451065510665106751068510695107051071510725107351074510755107651077510785107951080510815108251083510845108551086510875108851089510905109151092510935109451095510965109751098510995110051101511025110351104511055110651107511085110951110511115111251113511145111551116511175111851119511205112151122511235112451125511265112751128511295113051131511325113351134511355113651137511385113951140511415114251143511445114551146511475114851149511505115151152511535115451155511565115751158511595116051161511625116351164511655116651167511685116951170511715117251173511745117551176511775117851179511805118151182511835118451185511865118751188511895119051191511925119351194511955119651197511985119951200512015120251203512045120551206512075120851209512105121151212512135121451215512165121751218512195122051221512225122351224512255122651227512285122951230512315123251233512345123551236512375123851239512405124151242512435124451245512465124751248512495125051251512525125351254512555125651257512585125951260512615126251263512645126551266512675126851269512705127151272512735127451275512765127751278512795128051281512825128351284512855128651287512885128951290512915129251293512945129551296512975129851299513005130151302513035130451305513065130751308513095131051311513125131351314513155131651317513185131951320513215132251323513245132551326513275132851329513305133151332513335133451335513365133751338513395134051341513425134351344513455134651347513485134951350513515135251353513545135551356513575135851359513605136151362513635136451365513665136751368513695137051371513725137351374513755137651377513785137951380513815138251383513845138551386513875138851389513905139151392513935139451395513965139751398513995140051401514025140351404514055140651407514085140951410514115141251413514145141551416514175141851419514205142151422514235142451425514265142751428514295143051431514325143351434514355143651437514385143951440514415144251443514445144551446514475144851449514505145151452514535145451455514565145751458514595146051461514625146351464514655146651467514685146951470514715147251473514745147551476514775147851479514805148151482514835148451485514865148751488514895149051491514925149351494514955149651497514985149951500515015150251503515045150551506515075150851509515105151151512515135151451515515165151751518515195152051521515225152351524515255152651527515285152951530515315153251533515345153551536515375153851539515405154151542515435154451545515465154751548515495155051551515525155351554515555155651557515585155951560515615156251563515645156551566515675156851569515705157151572515735157451575515765157751578515795158051581515825158351584515855158651587515885158951590515915159251593515945159551596515975159851599516005160151602516035160451605516065160751608516095161051611516125161351614516155161651617516185161951620516215162251623516245162551626516275162851629516305163151632516335163451635516365163751638516395164051641516425164351644516455164651647516485164951650516515165251653516545165551656516575165851659516605166151662516635166451665516665166751668516695167051671516725167351674516755167651677516785167951680516815168251683516845168551686516875168851689516905169151692516935169451695516965169751698516995170051701517025170351704517055170651707517085170951710517115171251713517145171551716517175171851719517205172151722517235172451725517265172751728517295173051731517325173351734517355173651737517385173951740517415174251743517445174551746517475174851749517505175151752517535175451755517565175751758517595176051761517625176351764517655176651767517685176951770517715177251773517745177551776517775177851779517805178151782517835178451785517865178751788517895179051791517925179351794517955179651797517985179951800518015180251803518045180551806518075180851809518105181151812518135181451815518165181751818518195182051821518225182351824518255182651827518285182951830518315183251833518345183551836518375183851839518405184151842518435184451845518465184751848518495185051851518525185351854518555185651857518585185951860518615186251863518645186551866518675186851869518705187151872518735187451875518765187751878518795188051881518825188351884518855188651887518885188951890518915189251893518945189551896518975189851899519005190151902519035190451905519065190751908519095191051911519125191351914519155191651917519185191951920519215192251923519245192551926519275192851929519305193151932519335193451935519365193751938519395194051941519425194351944519455194651947519485194951950519515195251953519545195551956519575195851959519605196151962519635196451965519665196751968519695197051971519725197351974519755197651977519785197951980519815198251983519845198551986519875198851989519905199151992519935199451995519965199751998519995200052001520025200352004520055200652007520085200952010520115201252013520145201552016520175201852019520205202152022520235202452025520265202752028520295203052031520325203352034520355203652037520385203952040520415204252043520445204552046520475204852049520505205152052520535205452055520565205752058520595206052061520625206352064520655206652067520685206952070520715207252073520745207552076520775207852079520805208152082520835208452085520865208752088520895209052091520925209352094520955209652097520985209952100521015210252103521045210552106521075210852109521105211152112521135211452115521165211752118521195212052121521225212352124521255212652127521285212952130521315213252133521345213552136521375213852139521405214152142521435214452145521465214752148521495215052151521525215352154521555215652157521585215952160521615216252163521645216552166521675216852169521705217152172521735217452175521765217752178521795218052181521825218352184521855218652187521885218952190521915219252193521945219552196521975219852199522005220152202522035220452205522065220752208522095221052211522125221352214522155221652217522185221952220522215222252223522245222552226522275222852229522305223152232522335223452235522365223752238522395224052241522425224352244522455224652247522485224952250522515225252253522545225552256522575225852259522605226152262522635226452265522665226752268522695227052271522725227352274522755227652277522785227952280522815228252283522845228552286522875228852289522905229152292522935229452295522965229752298522995230052301523025230352304523055230652307523085230952310523115231252313523145231552316523175231852319523205232152322523235232452325523265232752328523295233052331523325233352334523355233652337523385233952340523415234252343523445234552346523475234852349523505235152352523535235452355523565235752358523595236052361523625236352364523655236652367523685236952370523715237252373523745237552376523775237852379523805238152382523835238452385523865238752388523895239052391523925239352394523955239652397523985239952400524015240252403524045240552406524075240852409524105241152412524135241452415524165241752418524195242052421524225242352424524255242652427524285242952430524315243252433524345243552436524375243852439524405244152442524435244452445524465244752448524495245052451524525245352454524555245652457524585245952460524615246252463524645246552466524675246852469524705247152472524735247452475524765247752478524795248052481524825248352484524855248652487524885248952490524915249252493524945249552496524975249852499525005250152502525035250452505525065250752508525095251052511525125251352514525155251652517525185251952520525215252252523525245252552526525275252852529525305253152532525335253452535525365253752538525395254052541525425254352544525455254652547525485254952550525515255252553525545255552556525575255852559525605256152562525635256452565525665256752568525695257052571525725257352574525755257652577525785257952580525815258252583525845258552586525875258852589525905259152592525935259452595525965259752598525995260052601526025260352604526055260652607526085260952610526115261252613526145261552616526175261852619526205262152622526235262452625526265262752628526295263052631526325263352634526355263652637526385263952640526415264252643526445264552646526475264852649526505265152652526535265452655526565265752658526595266052661526625266352664526655266652667526685266952670526715267252673526745267552676526775267852679526805268152682526835268452685526865268752688526895269052691526925269352694526955269652697526985269952700527015270252703527045270552706527075270852709527105271152712527135271452715527165271752718527195272052721527225272352724527255272652727527285272952730527315273252733527345273552736527375273852739527405274152742527435274452745527465274752748527495275052751527525275352754527555275652757527585275952760527615276252763527645276552766527675276852769527705277152772527735277452775527765277752778527795278052781527825278352784527855278652787527885278952790527915279252793527945279552796527975279852799528005280152802528035280452805528065280752808528095281052811528125281352814528155281652817528185281952820528215282252823528245282552826528275282852829528305283152832528335283452835528365283752838528395284052841528425284352844528455284652847528485284952850528515285252853528545285552856528575285852859528605286152862528635286452865528665286752868528695287052871528725287352874528755287652877528785287952880528815288252883528845288552886528875288852889528905289152892528935289452895528965289752898528995290052901529025290352904529055290652907529085290952910529115291252913529145291552916529175291852919529205292152922529235292452925529265292752928529295293052931529325293352934529355293652937529385293952940529415294252943529445294552946529475294852949529505295152952529535295452955529565295752958529595296052961529625296352964529655296652967529685296952970529715297252973529745297552976529775297852979529805298152982529835298452985529865298752988529895299052991529925299352994529955299652997529985299953000530015300253003530045300553006530075300853009530105301153012530135301453015530165301753018530195302053021530225302353024530255302653027530285302953030530315303253033530345303553036530375303853039530405304153042530435304453045530465304753048530495305053051530525305353054530555305653057530585305953060530615306253063530645306553066530675306853069530705307153072530735307453075530765307753078530795308053081530825308353084530855308653087530885308953090530915309253093530945309553096530975309853099531005310153102531035310453105531065310753108531095311053111531125311353114531155311653117531185311953120531215312253123531245312553126531275312853129531305313153132531335313453135531365313753138531395314053141531425314353144531455314653147531485314953150531515315253153531545315553156531575315853159531605316153162531635316453165531665316753168531695317053171531725317353174531755317653177531785317953180531815318253183531845318553186531875318853189531905319153192531935319453195531965319753198531995320053201532025320353204532055320653207532085320953210532115321253213532145321553216532175321853219532205322153222532235322453225532265322753228532295323053231532325323353234532355323653237532385323953240532415324253243532445324553246532475324853249532505325153252532535325453255532565325753258532595326053261532625326353264532655326653267532685326953270532715327253273532745327553276532775327853279532805328153282532835328453285532865328753288532895329053291532925329353294532955329653297532985329953300533015330253303533045330553306533075330853309533105331153312533135331453315533165331753318533195332053321533225332353324533255332653327533285332953330533315333253333533345333553336533375333853339533405334153342533435334453345533465334753348533495335053351533525335353354533555335653357533585335953360533615336253363533645336553366533675336853369533705337153372533735337453375533765337753378533795338053381533825338353384533855338653387533885338953390533915339253393533945339553396533975339853399534005340153402534035340453405534065340753408534095341053411534125341353414534155341653417534185341953420534215342253423534245342553426534275342853429534305343153432534335343453435534365343753438534395344053441534425344353444534455344653447534485344953450534515345253453534545345553456534575345853459534605346153462534635346453465534665346753468534695347053471534725347353474534755347653477534785347953480534815348253483534845348553486534875348853489534905349153492534935349453495534965349753498534995350053501535025350353504535055350653507535085350953510535115351253513535145351553516535175351853519535205352153522535235352453525535265352753528535295353053531535325353353534535355353653537535385353953540535415354253543535445354553546535475354853549535505355153552535535355453555535565355753558535595356053561535625356353564535655356653567535685356953570535715357253573535745357553576535775357853579535805358153582535835358453585535865358753588535895359053591535925359353594535955359653597535985359953600536015360253603536045360553606536075360853609536105361153612536135361453615536165361753618536195362053621536225362353624536255362653627536285362953630536315363253633536345363553636536375363853639536405364153642536435364453645536465364753648536495365053651536525365353654536555365653657536585365953660536615366253663536645366553666536675366853669536705367153672536735367453675536765367753678536795368053681536825368353684536855368653687536885368953690536915369253693536945369553696536975369853699537005370153702537035370453705537065370753708537095371053711537125371353714537155371653717537185371953720537215372253723537245372553726537275372853729537305373153732537335373453735537365373753738537395374053741537425374353744537455374653747537485374953750537515375253753537545375553756537575375853759537605376153762537635376453765537665376753768537695377053771537725377353774537755377653777537785377953780537815378253783537845378553786537875378853789537905379153792537935379453795537965379753798537995380053801538025380353804538055380653807538085380953810538115381253813538145381553816538175381853819538205382153822538235382453825538265382753828538295383053831538325383353834538355383653837538385383953840538415384253843538445384553846538475384853849538505385153852538535385453855538565385753858538595386053861538625386353864538655386653867538685386953870538715387253873538745387553876538775387853879538805388153882538835388453885538865388753888538895389053891538925389353894538955389653897538985389953900539015390253903539045390553906539075390853909539105391153912539135391453915539165391753918539195392053921539225392353924539255392653927539285392953930539315393253933539345393553936539375393853939539405394153942539435394453945539465394753948539495395053951539525395353954539555395653957539585395953960539615396253963539645396553966539675396853969539705397153972539735397453975539765397753978539795398053981539825398353984539855398653987539885398953990539915399253993539945399553996539975399853999540005400154002540035400454005540065400754008540095401054011540125401354014540155401654017540185401954020540215402254023540245402554026540275402854029540305403154032540335403454035540365403754038540395404054041540425404354044540455404654047540485404954050540515405254053540545405554056540575405854059540605406154062540635406454065540665406754068540695407054071540725407354074540755407654077540785407954080540815408254083540845408554086540875408854089540905409154092540935409454095540965409754098540995410054101541025410354104541055410654107541085410954110541115411254113541145411554116541175411854119541205412154122541235412454125541265412754128541295413054131541325413354134541355413654137541385413954140541415414254143541445414554146541475414854149541505415154152541535415454155541565415754158541595416054161541625416354164541655416654167541685416954170541715417254173541745417554176541775417854179541805418154182541835418454185541865418754188541895419054191541925419354194541955419654197541985419954200542015420254203542045420554206542075420854209542105421154212542135421454215542165421754218542195422054221542225422354224542255422654227542285422954230542315423254233542345423554236542375423854239542405424154242542435424454245542465424754248542495425054251542525425354254542555425654257542585425954260542615426254263542645426554266542675426854269542705427154272542735427454275542765427754278542795428054281542825428354284542855428654287542885428954290542915429254293542945429554296542975429854299543005430154302543035430454305543065430754308543095431054311543125431354314543155431654317543185431954320543215432254323543245432554326543275432854329543305433154332543335433454335543365433754338543395434054341543425434354344543455434654347543485434954350543515435254353543545435554356543575435854359543605436154362543635436454365543665436754368543695437054371543725437354374543755437654377543785437954380543815438254383543845438554386543875438854389543905439154392543935439454395543965439754398543995440054401544025440354404544055440654407544085440954410544115441254413544145441554416544175441854419544205442154422544235442454425544265442754428544295443054431544325443354434544355443654437544385443954440544415444254443544445444554446544475444854449544505445154452544535445454455544565445754458544595446054461544625446354464544655446654467544685446954470544715447254473544745447554476544775447854479544805448154482544835448454485544865448754488544895449054491544925449354494544955449654497544985449954500545015450254503545045450554506545075450854509545105451154512545135451454515545165451754518545195452054521545225452354524545255452654527545285452954530545315453254533545345453554536545375453854539545405454154542545435454454545545465454754548545495455054551545525455354554545555455654557545585455954560545615456254563545645456554566545675456854569545705457154572545735457454575545765457754578545795458054581545825458354584545855458654587545885458954590545915459254593545945459554596545975459854599546005460154602546035460454605546065460754608546095461054611546125461354614546155461654617546185461954620546215462254623546245462554626546275462854629546305463154632546335463454635546365463754638546395464054641546425464354644546455464654647546485464954650546515465254653546545465554656546575465854659546605466154662546635466454665546665466754668546695467054671546725467354674546755467654677546785467954680546815468254683546845468554686546875468854689546905469154692546935469454695546965469754698546995470054701547025470354704547055470654707547085470954710547115471254713547145471554716547175471854719547205472154722547235472454725547265472754728547295473054731547325473354734547355473654737547385473954740547415474254743547445474554746547475474854749547505475154752547535475454755547565475754758547595476054761547625476354764547655476654767547685476954770547715477254773547745477554776547775477854779547805478154782547835478454785547865478754788547895479054791547925479354794547955479654797547985479954800548015480254803548045480554806548075480854809548105481154812548135481454815548165481754818548195482054821548225482354824548255482654827548285482954830548315483254833548345483554836548375483854839548405484154842548435484454845548465484754848548495485054851548525485354854548555485654857548585485954860548615486254863548645486554866548675486854869548705487154872548735487454875548765487754878548795488054881548825488354884548855488654887548885488954890548915489254893548945489554896548975489854899549005490154902549035490454905549065490754908549095491054911549125491354914549155491654917549185491954920549215492254923549245492554926549275492854929549305493154932549335493454935549365493754938549395494054941549425494354944549455494654947549485494954950549515495254953549545495554956549575495854959549605496154962549635496454965549665496754968549695497054971549725497354974549755497654977549785497954980549815498254983549845498554986549875498854989549905499154992549935499454995549965499754998549995500055001550025500355004550055500655007550085500955010550115501255013550145501555016550175501855019550205502155022550235502455025550265502755028550295503055031550325503355034550355503655037550385503955040550415504255043550445504555046550475504855049550505505155052550535505455055550565505755058550595506055061550625506355064550655506655067550685506955070550715507255073550745507555076550775507855079550805508155082550835508455085550865508755088550895509055091550925509355094550955509655097550985509955100551015510255103551045510555106551075510855109551105511155112551135511455115551165511755118551195512055121551225512355124551255512655127551285512955130551315513255133551345513555136551375513855139551405514155142551435514455145551465514755148551495515055151551525515355154551555515655157551585515955160551615516255163551645516555166551675516855169551705517155172551735517455175551765517755178551795518055181551825518355184551855518655187551885518955190551915519255193551945519555196551975519855199552005520155202552035520455205552065520755208552095521055211552125521355214552155521655217552185521955220552215522255223552245522555226552275522855229552305523155232552335523455235552365523755238552395524055241552425524355244552455524655247552485524955250552515525255253552545525555256552575525855259552605526155262552635526455265552665526755268552695527055271552725527355274552755527655277552785527955280552815528255283552845528555286552875528855289552905529155292552935529455295552965529755298552995530055301553025530355304553055530655307553085530955310553115531255313553145531555316553175531855319553205532155322553235532455325553265532755328553295533055331553325533355334553355533655337553385533955340553415534255343553445534555346553475534855349553505535155352553535535455355553565535755358553595536055361553625536355364553655536655367553685536955370553715537255373553745537555376553775537855379553805538155382553835538455385553865538755388553895539055391553925539355394553955539655397553985539955400554015540255403554045540555406554075540855409554105541155412554135541455415554165541755418554195542055421554225542355424554255542655427554285542955430554315543255433554345543555436554375543855439554405544155442554435544455445554465544755448554495545055451554525545355454554555545655457554585545955460554615546255463554645546555466554675546855469554705547155472554735547455475554765547755478554795548055481554825548355484554855548655487554885548955490554915549255493554945549555496554975549855499555005550155502555035550455505555065550755508555095551055511555125551355514555155551655517555185551955520555215552255523555245552555526555275552855529555305553155532555335553455535555365553755538555395554055541555425554355544555455554655547555485554955550555515555255553555545555555556555575555855559555605556155562555635556455565555665556755568555695557055571555725557355574555755557655577555785557955580555815558255583555845558555586555875558855589555905559155592555935559455595555965559755598555995560055601556025560355604556055560655607556085560955610556115561255613556145561555616556175561855619556205562155622556235562455625556265562755628556295563055631556325563355634556355563655637556385563955640556415564255643556445564555646556475564855649556505565155652556535565455655556565565755658556595566055661556625566355664556655566655667556685566955670556715567255673556745567555676556775567855679556805568155682556835568455685556865568755688556895569055691556925569355694556955569655697556985569955700557015570255703557045570555706557075570855709557105571155712557135571455715557165571755718557195572055721557225572355724557255572655727557285572955730557315573255733557345573555736557375573855739557405574155742557435574455745557465574755748557495575055751557525575355754557555575655757557585575955760557615576255763557645576555766557675576855769557705577155772557735577455775557765577755778557795578055781557825578355784557855578655787557885578955790557915579255793557945579555796557975579855799558005580155802558035580455805558065580755808558095581055811558125581355814558155581655817558185581955820558215582255823558245582555826558275582855829558305583155832558335583455835558365583755838558395584055841558425584355844558455584655847558485584955850558515585255853558545585555856558575585855859558605586155862558635586455865558665586755868558695587055871558725587355874558755587655877558785587955880558815588255883558845588555886558875588855889558905589155892558935589455895558965589755898558995590055901559025590355904559055590655907559085590955910559115591255913559145591555916559175591855919559205592155922559235592455925559265592755928559295593055931559325593355934559355593655937559385593955940559415594255943559445594555946559475594855949559505595155952559535595455955559565595755958559595596055961559625596355964559655596655967559685596955970559715597255973559745597555976559775597855979559805598155982559835598455985559865598755988559895599055991559925599355994559955599655997559985599956000560015600256003560045600556006560075600856009560105601156012560135601456015560165601756018560195602056021560225602356024560255602656027560285602956030560315603256033560345603556036560375603856039560405604156042560435604456045560465604756048560495605056051560525605356054560555605656057560585605956060560615606256063560645606556066560675606856069560705607156072560735607456075560765607756078560795608056081560825608356084560855608656087560885608956090560915609256093560945609556096560975609856099561005610156102561035610456105561065610756108561095611056111561125611356114561155611656117561185611956120561215612256123561245612556126561275612856129561305613156132561335613456135561365613756138561395614056141561425614356144561455614656147561485614956150561515615256153561545615556156561575615856159561605616156162561635616456165561665616756168561695617056171561725617356174561755617656177561785617956180561815618256183561845618556186561875618856189561905619156192561935619456195561965619756198561995620056201562025620356204562055620656207562085620956210562115621256213562145621556216562175621856219562205622156222562235622456225562265622756228562295623056231562325623356234562355623656237562385623956240562415624256243562445624556246562475624856249562505625156252562535625456255562565625756258562595626056261562625626356264562655626656267562685626956270562715627256273562745627556276562775627856279562805628156282562835628456285562865628756288562895629056291562925629356294562955629656297562985629956300563015630256303563045630556306563075630856309563105631156312563135631456315563165631756318563195632056321563225632356324563255632656327563285632956330563315633256333563345633556336563375633856339563405634156342563435634456345563465634756348563495635056351563525635356354563555635656357563585635956360563615636256363563645636556366563675636856369563705637156372563735637456375563765637756378563795638056381563825638356384563855638656387563885638956390563915639256393563945639556396563975639856399564005640156402564035640456405564065640756408564095641056411564125641356414564155641656417564185641956420564215642256423564245642556426564275642856429564305643156432564335643456435564365643756438564395644056441564425644356444564455644656447564485644956450564515645256453564545645556456564575645856459564605646156462564635646456465564665646756468564695647056471564725647356474564755647656477564785647956480564815648256483564845648556486564875648856489564905649156492564935649456495564965649756498564995650056501565025650356504565055650656507565085650956510565115651256513565145651556516565175651856519565205652156522565235652456525565265652756528565295653056531565325653356534565355653656537565385653956540565415654256543565445654556546565475654856549565505655156552565535655456555565565655756558565595656056561565625656356564565655656656567565685656956570565715657256573565745657556576565775657856579565805658156582565835658456585565865658756588565895659056591565925659356594565955659656597565985659956600566015660256603566045660556606566075660856609566105661156612566135661456615566165661756618566195662056621566225662356624566255662656627566285662956630566315663256633566345663556636566375663856639566405664156642566435664456645566465664756648566495665056651566525665356654566555665656657566585665956660566615666256663566645666556666566675666856669566705667156672566735667456675566765667756678566795668056681566825668356684566855668656687566885668956690566915669256693566945669556696566975669856699567005670156702567035670456705567065670756708567095671056711567125671356714567155671656717567185671956720567215672256723567245672556726567275672856729567305673156732567335673456735567365673756738567395674056741567425674356744567455674656747567485674956750567515675256753567545675556756567575675856759567605676156762567635676456765567665676756768567695677056771567725677356774567755677656777567785677956780567815678256783567845678556786567875678856789567905679156792567935679456795567965679756798567995680056801568025680356804568055680656807568085680956810568115681256813568145681556816568175681856819568205682156822568235682456825568265682756828568295683056831568325683356834568355683656837568385683956840568415684256843568445684556846568475684856849568505685156852568535685456855568565685756858568595686056861568625686356864568655686656867568685686956870568715687256873568745687556876568775687856879568805688156882568835688456885568865688756888568895689056891568925689356894568955689656897568985689956900569015690256903569045690556906569075690856909569105691156912569135691456915569165691756918569195692056921569225692356924569255692656927569285692956930569315693256933569345693556936569375693856939569405694156942569435694456945569465694756948569495695056951569525695356954569555695656957569585695956960569615696256963569645696556966569675696856969569705697156972569735697456975569765697756978569795698056981569825698356984569855698656987569885698956990569915699256993569945699556996569975699856999570005700157002570035700457005570065700757008570095701057011570125701357014570155701657017570185701957020570215702257023570245702557026570275702857029570305703157032570335703457035570365703757038570395704057041570425704357044570455704657047570485704957050570515705257053570545705557056570575705857059570605706157062570635706457065570665706757068570695707057071570725707357074570755707657077570785707957080570815708257083570845708557086570875708857089570905709157092570935709457095570965709757098570995710057101571025710357104571055710657107571085710957110571115711257113571145711557116571175711857119571205712157122571235712457125571265712757128571295713057131571325713357134571355713657137571385713957140571415714257143571445714557146571475714857149571505715157152571535715457155571565715757158571595716057161571625716357164571655716657167571685716957170571715717257173571745717557176571775717857179571805718157182571835718457185571865718757188571895719057191571925719357194571955719657197571985719957200572015720257203572045720557206572075720857209572105721157212572135721457215572165721757218572195722057221572225722357224572255722657227572285722957230572315723257233572345723557236572375723857239572405724157242572435724457245572465724757248572495725057251572525725357254572555725657257572585725957260572615726257263572645726557266572675726857269572705727157272572735727457275572765727757278572795728057281572825728357284572855728657287572885728957290572915729257293572945729557296572975729857299573005730157302573035730457305573065730757308573095731057311573125731357314573155731657317573185731957320573215732257323573245732557326573275732857329573305733157332573335733457335573365733757338573395734057341573425734357344573455734657347573485734957350573515735257353573545735557356573575735857359573605736157362573635736457365573665736757368573695737057371573725737357374573755737657377573785737957380573815738257383573845738557386573875738857389573905739157392573935739457395573965739757398573995740057401574025740357404574055740657407574085740957410574115741257413574145741557416574175741857419574205742157422574235742457425574265742757428574295743057431574325743357434574355743657437574385743957440574415744257443574445744557446574475744857449574505745157452574535745457455574565745757458574595746057461574625746357464574655746657467574685746957470574715747257473574745747557476574775747857479574805748157482574835748457485574865748757488574895749057491574925749357494574955749657497574985749957500575015750257503575045750557506575075750857509575105751157512575135751457515575165751757518575195752057521575225752357524575255752657527575285752957530575315753257533575345753557536575375753857539575405754157542575435754457545575465754757548575495755057551575525755357554575555755657557575585755957560575615756257563575645756557566575675756857569575705757157572575735757457575575765757757578575795758057581575825758357584575855758657587575885758957590575915759257593575945759557596575975759857599576005760157602576035760457605576065760757608576095761057611576125761357614576155761657617576185761957620576215762257623576245762557626576275762857629576305763157632576335763457635576365763757638576395764057641576425764357644576455764657647576485764957650576515765257653576545765557656576575765857659576605766157662576635766457665576665766757668576695767057671576725767357674576755767657677576785767957680576815768257683576845768557686576875768857689576905769157692576935769457695576965769757698576995770057701577025770357704577055770657707577085770957710577115771257713577145771557716577175771857719577205772157722577235772457725577265772757728577295773057731577325773357734577355773657737577385773957740577415774257743577445774557746577475774857749577505775157752577535775457755577565775757758577595776057761577625776357764577655776657767577685776957770577715777257773577745777557776577775777857779577805778157782577835778457785577865778757788577895779057791577925779357794577955779657797577985779957800578015780257803578045780557806578075780857809578105781157812578135781457815578165781757818578195782057821578225782357824578255782657827578285782957830578315783257833578345783557836578375783857839578405784157842578435784457845578465784757848578495785057851578525785357854578555785657857578585785957860578615786257863578645786557866578675786857869578705787157872578735787457875578765787757878578795788057881578825788357884578855788657887578885788957890578915789257893578945789557896578975789857899579005790157902579035790457905579065790757908579095791057911579125791357914579155791657917579185791957920579215792257923579245792557926579275792857929579305793157932579335793457935579365793757938579395794057941579425794357944579455794657947579485794957950579515795257953579545795557956579575795857959579605796157962579635796457965579665796757968579695797057971579725797357974579755797657977579785797957980579815798257983579845798557986579875798857989579905799157992579935799457995579965799757998579995800058001580025800358004580055800658007580085800958010580115801258013580145801558016580175801858019580205802158022580235802458025580265802758028580295803058031580325803358034580355803658037580385803958040580415804258043580445804558046580475804858049580505805158052580535805458055580565805758058580595806058061580625806358064580655806658067580685806958070580715807258073580745807558076580775807858079580805808158082580835808458085580865808758088580895809058091580925809358094580955809658097580985809958100581015810258103581045810558106581075810858109581105811158112581135811458115581165811758118581195812058121581225812358124581255812658127581285812958130581315813258133581345813558136581375813858139581405814158142581435814458145581465814758148581495815058151581525815358154581555815658157581585815958160581615816258163581645816558166581675816858169581705817158172581735817458175581765817758178581795818058181581825818358184581855818658187581885818958190581915819258193581945819558196581975819858199582005820158202582035820458205582065820758208582095821058211582125821358214582155821658217582185821958220582215822258223582245822558226582275822858229582305823158232582335823458235582365823758238582395824058241582425824358244582455824658247582485824958250582515825258253582545825558256582575825858259582605826158262582635826458265582665826758268582695827058271582725827358274582755827658277582785827958280582815828258283582845828558286582875828858289582905829158292582935829458295582965829758298582995830058301583025830358304583055830658307583085830958310583115831258313583145831558316583175831858319583205832158322583235832458325583265832758328583295833058331583325833358334583355833658337583385833958340583415834258343583445834558346583475834858349583505835158352583535835458355583565835758358583595836058361583625836358364583655836658367583685836958370583715837258373583745837558376583775837858379583805838158382583835838458385583865838758388583895839058391583925839358394583955839658397583985839958400584015840258403584045840558406584075840858409584105841158412584135841458415584165841758418584195842058421584225842358424584255842658427584285842958430584315843258433584345843558436584375843858439584405844158442584435844458445584465844758448584495845058451584525845358454584555845658457584585845958460584615846258463584645846558466584675846858469584705847158472584735847458475584765847758478584795848058481584825848358484584855848658487584885848958490584915849258493584945849558496584975849858499585005850158502585035850458505585065850758508585095851058511585125851358514585155851658517585185851958520585215852258523585245852558526585275852858529585305853158532585335853458535585365853758538585395854058541585425854358544585455854658547585485854958550585515855258553585545855558556585575855858559585605856158562585635856458565585665856758568585695857058571585725857358574585755857658577585785857958580585815858258583585845858558586585875858858589585905859158592585935859458595585965859758598585995860058601586025860358604586055860658607586085860958610586115861258613586145861558616586175861858619586205862158622586235862458625586265862758628586295863058631586325863358634586355863658637586385863958640586415864258643586445864558646586475864858649586505865158652586535865458655586565865758658586595866058661586625866358664586655866658667586685866958670586715867258673586745867558676586775867858679586805868158682586835868458685586865868758688586895869058691586925869358694586955869658697586985869958700587015870258703587045870558706587075870858709587105871158712587135871458715587165871758718587195872058721587225872358724587255872658727587285872958730587315873258733587345873558736587375873858739587405874158742587435874458745587465874758748587495875058751587525875358754587555875658757587585875958760587615876258763587645876558766587675876858769587705877158772587735877458775587765877758778587795878058781587825878358784587855878658787587885878958790587915879258793587945879558796587975879858799588005880158802588035880458805588065880758808588095881058811588125881358814588155881658817588185881958820588215882258823588245882558826588275882858829588305883158832588335883458835588365883758838588395884058841588425884358844588455884658847588485884958850588515885258853588545885558856588575885858859588605886158862588635886458865588665886758868588695887058871588725887358874588755887658877588785887958880588815888258883588845888558886588875888858889588905889158892588935889458895588965889758898588995890058901589025890358904589055890658907589085890958910589115891258913589145891558916589175891858919589205892158922589235892458925589265892758928589295893058931589325893358934589355893658937589385893958940589415894258943589445894558946589475894858949589505895158952589535895458955589565895758958589595896058961589625896358964589655896658967589685896958970589715897258973589745897558976589775897858979589805898158982589835898458985589865898758988589895899058991589925899358994589955899658997589985899959000590015900259003590045900559006590075900859009590105901159012590135901459015590165901759018590195902059021590225902359024590255902659027590285902959030590315903259033590345903559036590375903859039590405904159042590435904459045590465904759048590495905059051590525905359054590555905659057590585905959060590615906259063590645906559066590675906859069590705907159072590735907459075590765907759078590795908059081590825908359084590855908659087590885908959090590915909259093590945909559096590975909859099591005910159102591035910459105591065910759108591095911059111591125911359114591155911659117591185911959120591215912259123591245912559126591275912859129591305913159132591335913459135591365913759138591395914059141591425914359144591455914659147591485914959150591515915259153591545915559156591575915859159591605916159162591635916459165591665916759168591695917059171591725917359174591755917659177591785917959180591815918259183591845918559186591875918859189591905919159192591935919459195591965919759198591995920059201592025920359204592055920659207592085920959210592115921259213592145921559216592175921859219592205922159222592235922459225592265922759228592295923059231592325923359234592355923659237592385923959240592415924259243592445924559246592475924859249592505925159252592535925459255592565925759258592595926059261592625926359264592655926659267592685926959270592715927259273592745927559276592775927859279592805928159282592835928459285592865928759288592895929059291592925929359294592955929659297592985929959300593015930259303593045930559306593075930859309593105931159312593135931459315593165931759318593195932059321593225932359324593255932659327593285932959330593315933259333593345933559336593375933859339593405934159342593435934459345593465934759348593495935059351593525935359354593555935659357593585935959360593615936259363593645936559366593675936859369593705937159372593735937459375593765937759378593795938059381593825938359384593855938659387593885938959390593915939259393593945939559396593975939859399594005940159402594035940459405594065940759408594095941059411594125941359414594155941659417594185941959420594215942259423594245942559426594275942859429594305943159432594335943459435594365943759438594395944059441594425944359444594455944659447594485944959450594515945259453594545945559456594575945859459594605946159462594635946459465594665946759468594695947059471594725947359474594755947659477594785947959480594815948259483594845948559486594875948859489594905949159492594935949459495594965949759498594995950059501595025950359504595055950659507595085950959510595115951259513595145951559516595175951859519595205952159522595235952459525595265952759528595295953059531595325953359534595355953659537595385953959540595415954259543595445954559546595475954859549595505955159552595535955459555595565955759558595595956059561595625956359564595655956659567595685956959570595715957259573595745957559576595775957859579595805958159582595835958459585595865958759588595895959059591595925959359594595955959659597595985959959600596015960259603596045960559606596075960859609596105961159612596135961459615596165961759618596195962059621596225962359624596255962659627596285962959630596315963259633596345963559636596375963859639596405964159642596435964459645596465964759648596495965059651596525965359654596555965659657596585965959660596615966259663596645966559666596675966859669596705967159672596735967459675596765967759678596795968059681596825968359684596855968659687596885968959690596915969259693596945969559696596975969859699597005970159702597035970459705597065970759708597095971059711597125971359714597155971659717597185971959720597215972259723597245972559726597275972859729597305973159732597335973459735597365973759738597395974059741597425974359744597455974659747597485974959750597515975259753597545975559756597575975859759597605976159762597635976459765597665976759768597695977059771597725977359774597755977659777597785977959780597815978259783597845978559786597875978859789597905979159792597935979459795597965979759798597995980059801598025980359804598055980659807598085980959810598115981259813598145981559816598175981859819598205982159822598235982459825598265982759828598295983059831598325983359834598355983659837598385983959840598415984259843598445984559846598475984859849598505985159852598535985459855598565985759858598595986059861598625986359864598655986659867598685986959870598715987259873598745987559876598775987859879598805988159882598835988459885598865988759888598895989059891598925989359894598955989659897598985989959900599015990259903599045990559906599075990859909599105991159912599135991459915599165991759918599195992059921599225992359924599255992659927599285992959930599315993259933599345993559936599375993859939599405994159942599435994459945599465994759948599495995059951599525995359954599555995659957599585995959960599615996259963599645996559966599675996859969599705997159972599735997459975599765997759978599795998059981599825998359984599855998659987599885998959990599915999259993599945999559996599975999859999600006000160002600036000460005600066000760008600096001060011600126001360014600156001660017600186001960020600216002260023600246002560026600276002860029600306003160032600336003460035600366003760038600396004060041600426004360044600456004660047600486004960050600516005260053600546005560056600576005860059600606006160062600636006460065600666006760068600696007060071600726007360074600756007660077600786007960080600816008260083600846008560086600876008860089600906009160092600936009460095600966009760098600996010060101601026010360104601056010660107601086010960110601116011260113601146011560116601176011860119601206012160122601236012460125601266012760128601296013060131601326013360134601356013660137601386013960140601416014260143601446014560146601476014860149601506015160152601536015460155601566015760158601596016060161601626016360164601656016660167601686016960170601716017260173601746017560176601776017860179601806018160182601836018460185601866018760188601896019060191601926019360194601956019660197601986019960200602016020260203602046020560206602076020860209602106021160212602136021460215602166021760218602196022060221602226022360224602256022660227602286022960230602316023260233602346023560236602376023860239602406024160242602436024460245602466024760248602496025060251602526025360254602556025660257602586025960260602616026260263602646026560266602676026860269602706027160272602736027460275602766027760278602796028060281602826028360284602856028660287602886028960290602916029260293602946029560296602976029860299603006030160302603036030460305603066030760308603096031060311603126031360314603156031660317603186031960320603216032260323603246032560326603276032860329603306033160332603336033460335603366033760338603396034060341603426034360344603456034660347603486034960350603516035260353603546035560356603576035860359603606036160362603636036460365603666036760368603696037060371603726037360374603756037660377603786037960380603816038260383603846038560386603876038860389603906039160392603936039460395603966039760398603996040060401604026040360404604056040660407604086040960410604116041260413604146041560416604176041860419604206042160422604236042460425604266042760428604296043060431604326043360434604356043660437604386043960440604416044260443604446044560446604476044860449604506045160452604536045460455604566045760458604596046060461604626046360464604656046660467604686046960470604716047260473604746047560476604776047860479604806048160482604836048460485604866048760488604896049060491604926049360494604956049660497604986049960500605016050260503605046050560506605076050860509605106051160512605136051460515605166051760518605196052060521605226052360524605256052660527605286052960530605316053260533605346053560536605376053860539605406054160542605436054460545605466054760548605496055060551605526055360554605556055660557605586055960560605616056260563605646056560566605676056860569605706057160572605736057460575605766057760578605796058060581605826058360584605856058660587605886058960590605916059260593605946059560596605976059860599606006060160602606036060460605606066060760608606096061060611606126061360614606156061660617606186061960620606216062260623606246062560626606276062860629606306063160632606336063460635606366063760638606396064060641606426064360644606456064660647606486064960650606516065260653606546065560656606576065860659606606066160662606636066460665606666066760668606696067060671606726067360674606756067660677606786067960680606816068260683606846068560686606876068860689606906069160692606936069460695606966069760698606996070060701607026070360704607056070660707607086070960710607116071260713607146071560716607176071860719607206072160722607236072460725607266072760728607296073060731607326073360734607356073660737607386073960740607416074260743607446074560746607476074860749607506075160752607536075460755607566075760758607596076060761607626076360764607656076660767607686076960770607716077260773607746077560776607776077860779607806078160782607836078460785607866078760788607896079060791607926079360794607956079660797607986079960800608016080260803608046080560806608076080860809608106081160812608136081460815608166081760818608196082060821608226082360824608256082660827608286082960830608316083260833608346083560836608376083860839608406084160842608436084460845608466084760848608496085060851608526085360854608556085660857608586085960860608616086260863608646086560866608676086860869608706087160872608736087460875608766087760878608796088060881608826088360884608856088660887608886088960890608916089260893608946089560896608976089860899609006090160902609036090460905609066090760908609096091060911609126091360914609156091660917609186091960920609216092260923609246092560926609276092860929609306093160932609336093460935609366093760938609396094060941609426094360944609456094660947609486094960950609516095260953609546095560956609576095860959609606096160962609636096460965609666096760968609696097060971609726097360974609756097660977609786097960980609816098260983
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>MailKit</name>
  5. </assembly>
  6. <members>
  7. <member name="T:MailKit.Net.Imap.ImapClient">
  8. <summary>
  9. An IMAP client that can be used to retrieve messages from a server.
  10. </summary>
  11. <remarks>
  12. The <see cref="T:MailKit.Net.Imap.ImapClient"/> class supports both the "imap" and "imaps"
  13. protocols. The "imap" protocol makes a clear-text connection to the IMAP
  14. server and does not use SSL or TLS unless the IMAP server supports the
  15. <a href="https://tools.ietf.org/html/rfc3501#section-6.2.1">STARTTLS</a> extension.
  16. The "imaps" protocol, however, connects to the IMAP server using an
  17. SSL-wrapped connection.
  18. </remarks>
  19. <example>
  20. <code language="c#" source="Examples\ImapExamples.cs" region="DownloadMessages"/>
  21. </example>
  22. <example>
  23. <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
  24. </example>
  25. </member>
  26. <member name="M:MailKit.Net.Imap.ImapClient.CompressAsync(System.Threading.CancellationToken)">
  27. <summary>
  28. Asynchronously enable compression over the IMAP connection.
  29. </summary>
  30. <remarks>
  31. <para>Asynchronously enables compression over the IMAP connection.</para>
  32. <para>If the IMAP server supports the <see cref="F:MailKit.Net.Imap.ImapCapabilities.Compress"/> extension,
  33. it is possible at any point after connecting to enable compression to reduce network
  34. bandwidth usage. Ideally, this method should be called before authenticating.</para>
  35. </remarks>
  36. <returns>An asynchronous task context.</returns>
  37. <param name="cancellationToken">The cancellation token.</param>
  38. <exception cref="T:System.ObjectDisposedException">
  39. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  40. </exception>
  41. <exception cref="T:MailKit.ServiceNotConnectedException">
  42. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  43. </exception>
  44. <exception cref="T:System.InvalidOperationException">
  45. Compression must be enabled before a folder has been selected.
  46. </exception>
  47. <exception cref="T:System.NotSupportedException">
  48. The IMAP server does not support the COMPRESS extension.
  49. </exception>
  50. <exception cref="T:System.OperationCanceledException">
  51. The operation was canceled via the cancellation token.
  52. </exception>
  53. <exception cref="T:System.IO.IOException">
  54. An I/O error occurred.
  55. </exception>
  56. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  57. The server replied to the COMPRESS command with a NO or BAD response.
  58. </exception>
  59. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  60. An IMAP protocol error occurred.
  61. </exception>
  62. </member>
  63. <member name="M:MailKit.Net.Imap.ImapClient.EnableQuickResyncAsync(System.Threading.CancellationToken)">
  64. <summary>
  65. Asynchronously enable the QRESYNC feature.
  66. </summary>
  67. <remarks>
  68. <para>Enables the <a href="https://tools.ietf.org/html/rfc5162">QRESYNC</a> feature.</para>
  69. <para>The QRESYNC extension improves resynchronization performance of folders by
  70. querying the IMAP server for a list of changes when the folder is opened using the
  71. <see cref="M:MailKit.Net.Imap.ImapFolder.Open(MailKit.FolderAccess,System.UInt32,System.UInt64,System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)"/>
  72. method.</para>
  73. <para>If this feature is enabled, the <see cref="E:MailKit.MailFolder.MessageExpunged"/> event is replaced
  74. with the <see cref="E:MailKit.MailFolder.MessagesVanished"/> event.</para>
  75. <para>This method needs to be called immediately after calling one of the
  76. <a href="Overload_MailKit_Net_Imap_ImapClient_Authenticate.htm">Authenticate</a> methods, before
  77. opening any folders.</para>
  78. </remarks>
  79. <returns>An asynchronous task context.</returns>
  80. <param name="cancellationToken">The cancellation token.</param>
  81. <exception cref="T:System.ObjectDisposedException">
  82. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  83. </exception>
  84. <exception cref="T:MailKit.ServiceNotConnectedException">
  85. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  86. </exception>
  87. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  88. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  89. </exception>
  90. <exception cref="T:System.InvalidOperationException">
  91. Quick resynchronization needs to be enabled before selecting a folder.
  92. </exception>
  93. <exception cref="T:System.NotSupportedException">
  94. The IMAP server does not support the QRESYNC extension.
  95. </exception>
  96. <exception cref="T:System.OperationCanceledException">
  97. The operation was canceled via the cancellation token.
  98. </exception>
  99. <exception cref="T:System.IO.IOException">
  100. An I/O error occurred.
  101. </exception>
  102. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  103. The server replied to the ENABLE command with a NO or BAD response.
  104. </exception>
  105. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  106. An IMAP protocol error occurred.
  107. </exception>
  108. </member>
  109. <member name="M:MailKit.Net.Imap.ImapClient.EnableUTF8Async(System.Threading.CancellationToken)">
  110. <summary>
  111. Asynchronously enable the UTF8=ACCEPT extension.
  112. </summary>
  113. <remarks>
  114. Enables the <a href="https://tools.ietf.org/html/rfc6855">UTF8=ACCEPT</a> extension.
  115. </remarks>
  116. <returns>An asynchronous task context.</returns>
  117. <param name="cancellationToken">The cancellation token.</param>
  118. <exception cref="T:System.ObjectDisposedException">
  119. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  120. </exception>
  121. <exception cref="T:MailKit.ServiceNotConnectedException">
  122. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  123. </exception>
  124. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  125. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  126. </exception>
  127. <exception cref="T:System.InvalidOperationException">
  128. UTF8=ACCEPT needs to be enabled before selecting a folder.
  129. </exception>
  130. <exception cref="T:System.NotSupportedException">
  131. The IMAP server does not support the UTF8=ACCEPT extension.
  132. </exception>
  133. <exception cref="T:System.OperationCanceledException">
  134. The operation was canceled via the cancellation token.
  135. </exception>
  136. <exception cref="T:System.IO.IOException">
  137. An I/O error occurred.
  138. </exception>
  139. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  140. The server replied to the ENABLE command with a NO or BAD response.
  141. </exception>
  142. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  143. An IMAP protocol error occurred.
  144. </exception>
  145. </member>
  146. <member name="M:MailKit.Net.Imap.ImapClient.IdentifyAsync(MailKit.Net.Imap.ImapImplementation,System.Threading.CancellationToken)">
  147. <summary>
  148. Asynchronously identify the client implementation to the server and obtain the server implementation details.
  149. </summary>
  150. <remarks>
  151. <para>Passes along the client implementation details to the server while also obtaining implementation
  152. details from the server.</para>
  153. <para>If the <paramref name="clientImplementation"/> is <c>null</c> or no properties have been set, no
  154. identifying information will be sent to the server.</para>
  155. <note type="security">
  156. <para>Security Implications</para>
  157. <para>This command has the danger of violating the privacy of users if misused. Clients should
  158. notify users that they send the ID command.</para>
  159. <para>It is highly desirable that implementations provide a method of disabling ID support, perhaps by
  160. not calling this method at all, or by passing <c>null</c> as the <paramref name="clientImplementation"/>
  161. argument.</para>
  162. <para>Implementors must exercise extreme care in adding properties to the <paramref name="clientImplementation"/>.
  163. Some properties, such as a processor ID number, Ethernet address, or other unique (or mostly unique) identifier
  164. would allow tracking of users in ways that violate user privacy expectations and may also make it easier for
  165. attackers to exploit security holes in the client.</para>
  166. </note>
  167. </remarks>
  168. <returns>The implementation details of the server if available; otherwise, <c>null</c>.</returns>
  169. <param name="clientImplementation">The client implementation.</param>
  170. <param name="cancellationToken">The cancellation token.</param>
  171. <exception cref="T:System.ObjectDisposedException">
  172. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  173. </exception>
  174. <exception cref="T:MailKit.ServiceNotConnectedException">
  175. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  176. </exception>
  177. <exception cref="T:System.NotSupportedException">
  178. The IMAP server does not support the ID extension.
  179. </exception>
  180. <exception cref="T:System.OperationCanceledException">
  181. The operation was canceled via the cancellation token.
  182. </exception>
  183. <exception cref="T:System.IO.IOException">
  184. An I/O error occurred.
  185. </exception>
  186. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  187. The server replied to the ID command with a NO or BAD response.
  188. </exception>
  189. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  190. An IMAP protocol error occurred.
  191. </exception>
  192. </member>
  193. <member name="M:MailKit.Net.Imap.ImapClient.AuthenticateAsync(MailKit.Security.SaslMechanism,System.Threading.CancellationToken)">
  194. <summary>
  195. Asynchronously authenticate using the specified SASL mechanism.
  196. </summary>
  197. <remarks>
  198. <para>Authenticates using the specified SASL mechanism.</para>
  199. <para>For a list of available SASL authentication mechanisms supported by the server,
  200. check the <see cref="P:MailKit.Net.Imap.ImapClient.AuthenticationMechanisms"/> property after the service has been
  201. connected.</para>
  202. </remarks>
  203. <returns>An asynchronous task context.</returns>
  204. <param name="mechanism">The SASL mechanism.</param>
  205. <param name="cancellationToken">The cancellation token.</param>
  206. <exception cref="T:System.ArgumentNullException">
  207. <paramref name="mechanism"/> is <c>null</c>.
  208. </exception>
  209. <exception cref="T:System.ObjectDisposedException">
  210. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  211. </exception>
  212. <exception cref="T:MailKit.ServiceNotConnectedException">
  213. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  214. </exception>
  215. <exception cref="T:System.InvalidOperationException">
  216. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is already authenticated.
  217. </exception>
  218. <exception cref="T:System.OperationCanceledException">
  219. The operation was canceled via the cancellation token.
  220. </exception>
  221. <exception cref="T:MailKit.Security.AuthenticationException">
  222. Authentication using the supplied credentials has failed.
  223. </exception>
  224. <exception cref="T:MailKit.Security.SaslException">
  225. A SASL authentication error occurred.
  226. </exception>
  227. <exception cref="T:System.IO.IOException">
  228. An I/O error occurred.
  229. </exception>
  230. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  231. An IMAP command failed.
  232. </exception>
  233. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  234. An IMAP protocol error occurred.
  235. </exception>
  236. </member>
  237. <member name="M:MailKit.Net.Imap.ImapClient.AuthenticateAsync(System.Text.Encoding,System.Net.ICredentials,System.Threading.CancellationToken)">
  238. <summary>
  239. Asynchronously authenticate using the supplied credentials.
  240. </summary>
  241. <remarks>
  242. <para>If the IMAP server supports one or more SASL authentication mechanisms,
  243. then the SASL mechanisms that both the client and server support are tried
  244. in order of greatest security to weakest security. Once a SASL
  245. authentication mechanism is found that both client and server support,
  246. the credentials are used to authenticate.</para>
  247. <para>If the server does not support SASL or if no common SASL mechanisms
  248. can be found, then LOGIN command is used as a fallback.</para>
  249. <note type="tip">To prevent the usage of certain authentication mechanisms,
  250. simply remove them from the <see cref="P:MailKit.Net.Imap.ImapClient.AuthenticationMechanisms"/> hash set
  251. before calling this method.</note>
  252. </remarks>
  253. <returns>An asynchronous task context.</returns>
  254. <param name="encoding">The text encoding to use for the user's credentials.</param>
  255. <param name="credentials">The user's credentials.</param>
  256. <param name="cancellationToken">The cancellation token.</param>
  257. <exception cref="T:System.ArgumentNullException">
  258. <para><paramref name="encoding"/> is <c>null</c>.</para>
  259. <para>-or-</para>
  260. <para><paramref name="credentials"/> is <c>null</c>.</para>
  261. </exception>
  262. <exception cref="T:System.ObjectDisposedException">
  263. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  264. </exception>
  265. <exception cref="T:MailKit.ServiceNotConnectedException">
  266. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  267. </exception>
  268. <exception cref="T:System.InvalidOperationException">
  269. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is already authenticated.
  270. </exception>
  271. <exception cref="T:System.OperationCanceledException">
  272. The operation was canceled via the cancellation token.
  273. </exception>
  274. <exception cref="T:MailKit.Security.AuthenticationException">
  275. Authentication using the supplied credentials has failed.
  276. </exception>
  277. <exception cref="T:MailKit.Security.SaslException">
  278. A SASL authentication error occurred.
  279. </exception>
  280. <exception cref="T:System.IO.IOException">
  281. An I/O error occurred.
  282. </exception>
  283. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  284. An IMAP command failed.
  285. </exception>
  286. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  287. An IMAP protocol error occurred.
  288. </exception>
  289. </member>
  290. <member name="M:MailKit.Net.Imap.ImapClient.ConnectAsync(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
  291. <summary>
  292. Asynchronously establish a connection to the specified IMAP server.
  293. </summary>
  294. <remarks>
  295. <para>Establishes a connection to the specified IMAP or IMAP/S server.</para>
  296. <para>If the <paramref name="port"/> has a value of <c>0</c>, then the
  297. <paramref name="options"/> parameter is used to determine the default port to
  298. connect to. The default port used with <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>
  299. is <c>993</c>. All other values will use a default port of <c>143</c>.</para>
  300. <para>If the <paramref name="options"/> has a value of
  301. <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
  302. to determine the default security options. If the <paramref name="port"/> has a value
  303. of <c>993</c>, then the default options used will be
  304. <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
  305. <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
  306. <para>Once a connection is established, properties such as
  307. <see cref="P:MailKit.Net.Imap.ImapClient.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Imap.ImapClient.Capabilities"/> will be
  308. populated.</para>
  309. </remarks>
  310. <example>
  311. <code language="c#" source="Examples\ImapExamples.cs" region="DownloadMessages"/>
  312. </example>
  313. <returns>An asynchronous task context.</returns>
  314. <param name="host">The host name to connect to.</param>
  315. <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
  316. <param name="options">The secure socket options to when connecting.</param>
  317. <param name="cancellationToken">The cancellation token.</param>
  318. <exception cref="T:System.ArgumentNullException">
  319. <paramref name="host"/> is <c>null</c>.
  320. </exception>
  321. <exception cref="T:System.ArgumentOutOfRangeException">
  322. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  323. </exception>
  324. <exception cref="T:System.ArgumentException">
  325. The <paramref name="host"/> is a zero-length string.
  326. </exception>
  327. <exception cref="T:System.ObjectDisposedException">
  328. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  329. </exception>
  330. <exception cref="T:System.InvalidOperationException">
  331. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is already connected.
  332. </exception>
  333. <exception cref="T:System.NotSupportedException">
  334. <paramref name="options"/> was set to
  335. <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
  336. and the IMAP server does not support the STARTTLS extension.
  337. </exception>
  338. <exception cref="T:System.OperationCanceledException">
  339. The operation was canceled via the cancellation token.
  340. </exception>
  341. <exception cref="T:System.Net.Sockets.SocketException">
  342. A socket error occurred trying to connect to the remote host.
  343. </exception>
  344. <exception cref="T:MailKit.Security.SslHandshakeException">
  345. An error occurred during the SSL/TLS negotiations.
  346. </exception>
  347. <exception cref="T:System.IO.IOException">
  348. An I/O error occurred.
  349. </exception>
  350. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  351. An IMAP command failed.
  352. </exception>
  353. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  354. An IMAP protocol error occurred.
  355. </exception>
  356. </member>
  357. <member name="M:MailKit.Net.Imap.ImapClient.ConnectAsync(System.Net.Sockets.Socket,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
  358. <summary>
  359. Asynchronously establish a connection to the specified IMAP or IMAP/S server using the provided socket.
  360. </summary>
  361. <remarks>
  362. <para>Establishes a connection to the specified IMAP or IMAP/S server using
  363. the provided socket.</para>
  364. <para>If the <paramref name="options"/> has a value of
  365. <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
  366. to determine the default security options. If the <paramref name="port"/> has a value
  367. of <c>993</c>, then the default options used will be
  368. <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
  369. <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
  370. <para>Once a connection is established, properties such as
  371. <see cref="P:MailKit.Net.Imap.ImapClient.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Imap.ImapClient.Capabilities"/> will be
  372. populated.</para>
  373. <note type="info">With the exception of using the <paramref name="port"/> to determine the
  374. default <see cref="T:MailKit.Security.SecureSocketOptions"/> to use when the <paramref name="options"/> value
  375. is <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, the <paramref name="host"/> and
  376. <paramref name="port"/> parameters are only used for logging purposes.</note>
  377. </remarks>
  378. <returns>An asynchronous task context.</returns>
  379. <param name="socket">The socket to use for the connection.</param>
  380. <param name="host">The host name to connect to.</param>
  381. <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
  382. <param name="options">The secure socket options to when connecting.</param>
  383. <param name="cancellationToken">The cancellation token.</param>
  384. <exception cref="T:System.ArgumentNullException">
  385. <para><paramref name="socket"/> is <c>null</c>.</para>
  386. <para>-or-</para>
  387. <para><paramref name="host"/> is <c>null</c>.</para>
  388. </exception>
  389. <exception cref="T:System.ArgumentOutOfRangeException">
  390. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  391. </exception>
  392. <exception cref="T:System.ArgumentException">
  393. <para><paramref name="socket"/> is not connected.</para>
  394. <para>-or-</para>
  395. The <paramref name="host"/> is a zero-length string.
  396. </exception>
  397. <exception cref="T:System.ObjectDisposedException">
  398. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  399. </exception>
  400. <exception cref="T:System.InvalidOperationException">
  401. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is already connected.
  402. </exception>
  403. <exception cref="T:System.NotSupportedException">
  404. <paramref name="options"/> was set to
  405. <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
  406. and the IMAP server does not support the STARTTLS extension.
  407. </exception>
  408. <exception cref="T:System.OperationCanceledException">
  409. The operation was canceled via the cancellation token.
  410. </exception>
  411. <exception cref="T:MailKit.Security.SslHandshakeException">
  412. An error occurred during the SSL/TLS negotiations.
  413. </exception>
  414. <exception cref="T:System.IO.IOException">
  415. An I/O error occurred.
  416. </exception>
  417. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  418. An IMAP command failed.
  419. </exception>
  420. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  421. An IMAP protocol error occurred.
  422. </exception>
  423. </member>
  424. <member name="M:MailKit.Net.Imap.ImapClient.ConnectAsync(System.IO.Stream,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
  425. <summary>
  426. Asynchronously establish a connection to the specified IMAP or IMAP/S server using the provided stream.
  427. </summary>
  428. <remarks>
  429. <para>Establishes a connection to the specified IMAP or IMAP/S server using
  430. the provided stream.</para>
  431. <para>If the <paramref name="options"/> has a value of
  432. <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
  433. to determine the default security options. If the <paramref name="port"/> has a value
  434. of <c>993</c>, then the default options used will be
  435. <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
  436. <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
  437. <para>Once a connection is established, properties such as
  438. <see cref="P:MailKit.Net.Imap.ImapClient.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Imap.ImapClient.Capabilities"/> will be
  439. populated.</para>
  440. <note type="info">With the exception of using the <paramref name="port"/> to determine the
  441. default <see cref="T:MailKit.Security.SecureSocketOptions"/> to use when the <paramref name="options"/> value
  442. is <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, the <paramref name="host"/> and
  443. <paramref name="port"/> parameters are only used for logging purposes.</note>
  444. </remarks>
  445. <returns>An asynchronous task context.</returns>
  446. <param name="stream">The stream to use for the connection.</param>
  447. <param name="host">The host name to connect to.</param>
  448. <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
  449. <param name="options">The secure socket options to when connecting.</param>
  450. <param name="cancellationToken">The cancellation token.</param>
  451. <exception cref="T:System.ArgumentNullException">
  452. <para><paramref name="stream"/> is <c>null</c>.</para>
  453. <para>-or-</para>
  454. <para><paramref name="host"/> is <c>null</c>.</para>
  455. </exception>
  456. <exception cref="T:System.ArgumentOutOfRangeException">
  457. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  458. </exception>
  459. <exception cref="T:System.ArgumentException">
  460. The <paramref name="host"/> is a zero-length string.
  461. </exception>
  462. <exception cref="T:System.ObjectDisposedException">
  463. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  464. </exception>
  465. <exception cref="T:System.InvalidOperationException">
  466. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is already connected.
  467. </exception>
  468. <exception cref="T:System.NotSupportedException">
  469. <paramref name="options"/> was set to
  470. <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
  471. and the IMAP server does not support the STARTTLS extension.
  472. </exception>
  473. <exception cref="T:System.OperationCanceledException">
  474. The operation was canceled via the cancellation token.
  475. </exception>
  476. <exception cref="T:MailKit.Security.SslHandshakeException">
  477. An error occurred during the SSL/TLS negotiations.
  478. </exception>
  479. <exception cref="T:System.IO.IOException">
  480. An I/O error occurred.
  481. </exception>
  482. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  483. An IMAP command failed.
  484. </exception>
  485. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  486. An IMAP protocol error occurred.
  487. </exception>
  488. </member>
  489. <member name="M:MailKit.Net.Imap.ImapClient.DisconnectAsync(System.Boolean,System.Threading.CancellationToken)">
  490. <summary>
  491. Asynchronously disconnect the service.
  492. </summary>
  493. <remarks>
  494. If <paramref name="quit"/> is <c>true</c>, a <c>LOGOUT</c> command will be issued in order to disconnect cleanly.
  495. </remarks>
  496. <example>
  497. <code language="c#" source="Examples\ImapExamples.cs" region="DownloadMessages"/>
  498. </example>
  499. <returns>An asynchronous task context.</returns>
  500. <param name="quit">If set to <c>true</c>, a <c>LOGOUT</c> command will be issued in order to disconnect cleanly.</param>
  501. <param name="cancellationToken">The cancellation token.</param>
  502. <exception cref="T:System.ObjectDisposedException">
  503. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  504. </exception>
  505. </member>
  506. <member name="M:MailKit.Net.Imap.ImapClient.NoOpAsync(System.Threading.CancellationToken)">
  507. <summary>
  508. Asynchronously ping the IMAP server to keep the connection alive.
  509. </summary>
  510. <remarks>
  511. <para>The <c>NOOP</c> command is typically used to keep the connection with the IMAP server
  512. alive. When a client goes too long (typically 30 minutes) without sending any commands to the
  513. IMAP server, the IMAP server will close the connection with the client, forcing the client to
  514. reconnect before it can send any more commands.</para>
  515. <para>The <c>NOOP</c> command also provides a great way for a client to check for new
  516. messages.</para>
  517. <para>When the IMAP server receives a <c>NOOP</c> command, it will reply to the client with a
  518. list of pending updates such as <c>EXISTS</c> and <c>RECENT</c> counts on the currently
  519. selected folder. To receive these notifications, subscribe to the
  520. <see cref="E:MailKit.MailFolder.CountChanged"/> and <see cref="E:MailKit.MailFolder.RecentChanged"/> events,
  521. respectively.</para>
  522. <para>For more information about the <c>NOOP</c> command, see
  523. <a href="https://tools.ietf.org/html/rfc3501#section-6.1.2">rfc3501</a>.</para>
  524. </remarks>
  525. <example>
  526. <code language="c#" source="Examples\ImapIdleExample.cs"/>
  527. </example>
  528. <returns>An asynchronous task context.</returns>
  529. <param name="cancellationToken">The cancellation token.</param>
  530. <exception cref="T:System.ObjectDisposedException">
  531. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  532. </exception>
  533. <exception cref="T:MailKit.ServiceNotConnectedException">
  534. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  535. </exception>
  536. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  537. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  538. </exception>
  539. <exception cref="T:System.OperationCanceledException">
  540. The operation was canceled via the cancellation token.
  541. </exception>
  542. <exception cref="T:System.IO.IOException">
  543. An I/O error occurred.
  544. </exception>
  545. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  546. The server replied to the NOOP command with a NO or BAD response.
  547. </exception>
  548. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  549. The server responded with an unexpected token.
  550. </exception>
  551. </member>
  552. <member name="M:MailKit.Net.Imap.ImapClient.IdleAsync(System.Threading.CancellationToken,System.Threading.CancellationToken)">
  553. <summary>
  554. Asynchronously toggle the <see cref="T:MailKit.Net.Imap.ImapClient"/> into the IDLE state.
  555. </summary>
  556. <remarks>
  557. <para>When a client enters the IDLE state, the IMAP server will send
  558. events to the client as they occur on the selected folder. These events
  559. may include notifications of new messages arriving, expunge notifications,
  560. flag changes, etc.</para>
  561. <para>Due to the nature of the IDLE command, a folder must be selected
  562. before a client can enter into the IDLE state. This can be done by
  563. opening a folder using
  564. <see cref="M:MailKit.MailFolder.Open(MailKit.FolderAccess,System.Threading.CancellationToken)"/>
  565. or any of the other variants.</para>
  566. <para>While the IDLE command is running, no other commands may be issued until the
  567. <paramref name="doneToken"/> is cancelled.</para>
  568. <note type="note">It is especially important to cancel the <paramref name="doneToken"/>
  569. before cancelling the <paramref name="cancellationToken"/> when using SSL or TLS due to
  570. the fact that <see cref="T:System.Net.Security.SslStream"/> cannot be polled.</note>
  571. </remarks>
  572. <returns>An asynchronous task context.</returns>
  573. <param name="doneToken">The cancellation token used to return to the non-idle state.</param>
  574. <param name="cancellationToken">The cancellation token.</param>
  575. <exception cref="T:System.ArgumentException">
  576. <paramref name="doneToken"/> must be cancellable (i.e. <see cref="P:System.Threading.CancellationToken.None"/> cannot be used).
  577. </exception>
  578. <exception cref="T:System.ObjectDisposedException">
  579. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  580. </exception>
  581. <exception cref="T:MailKit.ServiceNotConnectedException">
  582. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  583. </exception>
  584. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  585. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  586. </exception>
  587. <exception cref="T:System.InvalidOperationException">
  588. A <see cref="T:MailKit.Net.Imap.ImapFolder"/> has not been opened.
  589. </exception>
  590. <exception cref="T:System.NotSupportedException">
  591. The IMAP server does not support the IDLE extension.
  592. </exception>
  593. <exception cref="T:System.OperationCanceledException">
  594. The operation was canceled via the cancellation token.
  595. </exception>
  596. <exception cref="T:System.IO.IOException">
  597. An I/O error occurred.
  598. </exception>
  599. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  600. The server replied to the IDLE command with a NO or BAD response.
  601. </exception>
  602. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  603. The server responded with an unexpected token.
  604. </exception>
  605. </member>
  606. <member name="M:MailKit.Net.Imap.ImapClient.NotifyAsync(System.Boolean,System.Collections.Generic.IList{MailKit.Net.Imap.ImapEventGroup},System.Threading.CancellationToken)">
  607. <summary>
  608. Asynchronously request the specified notification events from the IMAP server.
  609. </summary>
  610. <remarks>
  611. <para>The <a href="https://tools.ietf.org/html/rfc5465">NOTIFY</a> command is used to expand
  612. which notifications the client wishes to be notified about, including status notifications
  613. about folders other than the currently selected folder. It can also be used to automatically
  614. FETCH information about new messages that have arrived in the currently selected folder.</para>
  615. <para>This, combined with <see cref="M:MailKit.Net.Imap.ImapClient.IdleAsync(System.Threading.CancellationToken,System.Threading.CancellationToken)"/>,
  616. can be used to get instant notifications for changes to any of the specified folders.</para>
  617. </remarks>
  618. <returns>An asynchronous task context.</returns>
  619. <param name="status"><c>true</c> if the server should immediately notify the client of the
  620. selected folder's status; otherwise, <c>false</c>.</param>
  621. <param name="eventGroups">The specific event groups that the client would like to receive notifications for.</param>
  622. <param name="cancellationToken">The cancellation token.</param>
  623. <exception cref="T:System.ArgumentNullException">
  624. <paramref name="eventGroups"/> is <c>null</c>.
  625. </exception>
  626. <exception cref="T:System.ArgumentException">
  627. <paramref name="eventGroups"/> is empty.
  628. </exception>
  629. <exception cref="T:System.ObjectDisposedException">
  630. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  631. </exception>
  632. <exception cref="T:MailKit.ServiceNotConnectedException">
  633. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  634. </exception>
  635. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  636. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  637. </exception>
  638. <exception cref="T:System.InvalidOperationException">
  639. One or more <see cref="T:MailKit.Net.Imap.ImapEventGroup"/> is invalid.
  640. </exception>
  641. <exception cref="T:System.NotSupportedException">
  642. The IMAP server does not support the NOTIFY extension.
  643. </exception>
  644. <exception cref="T:System.OperationCanceledException">
  645. The operation was canceled via the cancellation token.
  646. </exception>
  647. <exception cref="T:System.IO.IOException">
  648. An I/O error occurred.
  649. </exception>
  650. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  651. The server replied to the NOTIFY command with a NO or BAD response.
  652. </exception>
  653. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  654. The server responded with an unexpected token.
  655. </exception>
  656. </member>
  657. <member name="M:MailKit.Net.Imap.ImapClient.DisableNotifyAsync(System.Threading.CancellationToken)">
  658. <summary>
  659. Asynchronously disable any previously requested notification events from the IMAP server.
  660. </summary>
  661. <remarks>
  662. Disables any notification events requested in a prior call to
  663. <see cref="M:MailKit.Net.Imap.ImapClient.NotifyAsync(System.Boolean,System.Collections.Generic.IList{MailKit.Net.Imap.ImapEventGroup},System.Threading.CancellationToken)"/>.
  664. request.
  665. </remarks>
  666. <returns>An asynchronous task context.</returns>
  667. <param name="cancellationToken">The cancellation token.</param>
  668. <exception cref="T:System.ObjectDisposedException">
  669. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  670. </exception>
  671. <exception cref="T:MailKit.ServiceNotConnectedException">
  672. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  673. </exception>
  674. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  675. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  676. </exception>
  677. <exception cref="T:System.NotSupportedException">
  678. The IMAP server does not support the NOTIFY extension.
  679. </exception>
  680. <exception cref="T:System.OperationCanceledException">
  681. The operation was canceled via the cancellation token.
  682. </exception>
  683. <exception cref="T:System.IO.IOException">
  684. An I/O error occurred.
  685. </exception>
  686. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  687. The server replied to the NOTIFY command with a NO or BAD response.
  688. </exception>
  689. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  690. The server responded with an unexpected token.
  691. </exception>
  692. </member>
  693. <member name="M:MailKit.Net.Imap.ImapClient.GetFoldersAsync(MailKit.FolderNamespace,MailKit.StatusItems,System.Boolean,System.Threading.CancellationToken)">
  694. <summary>
  695. Asynchronously get all of the folders within the specified namespace.
  696. </summary>
  697. <remarks>
  698. Gets all of the folders within the specified namespace.
  699. </remarks>
  700. <returns>The folders.</returns>
  701. <param name="namespace">The namespace.</param>
  702. <param name="items">The status items to pre-populate.</param>
  703. <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
  704. <param name="cancellationToken">The cancellation token.</param>
  705. <exception cref="T:System.ArgumentNullException">
  706. <paramref name="namespace"/> is <c>null</c>.
  707. </exception>
  708. <exception cref="T:System.ObjectDisposedException">
  709. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  710. </exception>
  711. <exception cref="T:MailKit.ServiceNotConnectedException">
  712. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  713. </exception>
  714. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  715. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  716. </exception>
  717. <exception cref="T:System.OperationCanceledException">
  718. The operation was canceled via the cancellation token.
  719. </exception>
  720. <exception cref="T:MailKit.FolderNotFoundException">
  721. The namespace folder could not be found.
  722. </exception>
  723. <exception cref="T:System.IO.IOException">
  724. An I/O error occurred.
  725. </exception>
  726. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  727. The server replied to the LIST or LSUB command with a NO or BAD response.
  728. </exception>
  729. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  730. The server responded with an unexpected token.
  731. </exception>
  732. </member>
  733. <member name="M:MailKit.Net.Imap.ImapClient.GetFolderAsync(System.String,System.Threading.CancellationToken)">
  734. <summary>
  735. Asynchronously get the folder for the specified path.
  736. </summary>
  737. <remarks>
  738. Gets the folder for the specified path.
  739. </remarks>
  740. <returns>The folder.</returns>
  741. <param name="path">The folder path.</param>
  742. <param name="cancellationToken">The cancellation token.</param>
  743. <exception cref="T:System.ArgumentNullException">
  744. <paramref name="path"/> is <c>null</c>.
  745. </exception>
  746. <exception cref="T:System.ObjectDisposedException">
  747. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  748. </exception>
  749. <exception cref="T:MailKit.ServiceNotConnectedException">
  750. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  751. </exception>
  752. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  753. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  754. </exception>
  755. <exception cref="T:System.OperationCanceledException">
  756. The operation was canceled via the cancellation token.
  757. </exception>
  758. <exception cref="T:MailKit.FolderNotFoundException">
  759. The folder could not be found.
  760. </exception>
  761. <exception cref="T:System.IO.IOException">
  762. An I/O error occurred.
  763. </exception>
  764. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  765. The server replied to the IDLE command with a NO or BAD response.
  766. </exception>
  767. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  768. The server responded with an unexpected token.
  769. </exception>
  770. </member>
  771. <member name="M:MailKit.Net.Imap.ImapClient.GetMetadataAsync(MailKit.MetadataTag,System.Threading.CancellationToken)">
  772. <summary>
  773. Asynchronously gets the specified metadata.
  774. </summary>
  775. <remarks>
  776. Gets the specified metadata.
  777. </remarks>
  778. <returns>The requested metadata value.</returns>
  779. <param name="tag">The metadata tag.</param>
  780. <param name="cancellationToken">The cancellation token.</param>
  781. <exception cref="T:System.ObjectDisposedException">
  782. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  783. </exception>
  784. <exception cref="T:MailKit.ServiceNotConnectedException">
  785. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  786. </exception>
  787. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  788. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  789. </exception>
  790. <exception cref="T:System.NotSupportedException">
  791. The IMAP server does not support the METADATA or METADATA-SERVER extension.
  792. </exception>
  793. <exception cref="T:System.OperationCanceledException">
  794. The operation was canceled via the cancellation token.
  795. </exception>
  796. <exception cref="T:System.IO.IOException">
  797. An I/O error occurred.
  798. </exception>
  799. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  800. The server's response contained unexpected tokens.
  801. </exception>
  802. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  803. The server replied with a NO or BAD response.
  804. </exception>
  805. </member>
  806. <member name="M:MailKit.Net.Imap.ImapClient.GetMetadataAsync(MailKit.MetadataOptions,System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
  807. <summary>
  808. Asynchronously gets the specified metadata.
  809. </summary>
  810. <remarks>
  811. Gets the specified metadata.
  812. </remarks>
  813. <returns>The requested metadata.</returns>
  814. <param name="options">The metadata options.</param>
  815. <param name="tags">The metadata tags.</param>
  816. <param name="cancellationToken">The cancellation token.</param>
  817. <exception cref="T:System.ArgumentNullException">
  818. <para><paramref name="options"/> is <c>null</c>.</para>
  819. <para>-or-</para>
  820. <para><paramref name="tags"/> is <c>null</c>.</para>
  821. </exception>
  822. <exception cref="T:System.ObjectDisposedException">
  823. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  824. </exception>
  825. <exception cref="T:MailKit.ServiceNotConnectedException">
  826. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  827. </exception>
  828. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  829. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  830. </exception>
  831. <exception cref="T:System.NotSupportedException">
  832. The IMAP server does not support the METADATA or METADATA-SERVER extension.
  833. </exception>
  834. <exception cref="T:System.OperationCanceledException">
  835. The operation was canceled via the cancellation token.
  836. </exception>
  837. <exception cref="T:System.IO.IOException">
  838. An I/O error occurred.
  839. </exception>
  840. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  841. The server's response contained unexpected tokens.
  842. </exception>
  843. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  844. The server replied with a NO or BAD response.
  845. </exception>
  846. </member>
  847. <member name="M:MailKit.Net.Imap.ImapClient.SetMetadataAsync(MailKit.MetadataCollection,System.Threading.CancellationToken)">
  848. <summary>
  849. Asynchronously gets the specified metadata.
  850. </summary>
  851. <remarks>
  852. Sets the specified metadata.
  853. </remarks>
  854. <returns>An asynchronous task context.</returns>
  855. <param name="metadata">The metadata.</param>
  856. <param name="cancellationToken">The cancellation token.</param>
  857. <exception cref="T:System.ArgumentNullException">
  858. <paramref name="metadata"/> is <c>null</c>.
  859. </exception>
  860. <exception cref="T:System.ObjectDisposedException">
  861. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  862. </exception>
  863. <exception cref="T:MailKit.ServiceNotConnectedException">
  864. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  865. </exception>
  866. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  867. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  868. </exception>
  869. <exception cref="T:System.NotSupportedException">
  870. The IMAP server does not support the METADATA or METADATA-SERVER extension.
  871. </exception>
  872. <exception cref="T:System.OperationCanceledException">
  873. The operation was canceled via the cancellation token.
  874. </exception>
  875. <exception cref="T:System.IO.IOException">
  876. An I/O error occurred.
  877. </exception>
  878. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  879. The server's response contained unexpected tokens.
  880. </exception>
  881. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  882. The server replied with a NO or BAD response.
  883. </exception>
  884. </member>
  885. <member name="M:MailKit.Net.Imap.ImapClient.#ctor">
  886. <summary>
  887. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapClient"/> class.
  888. </summary>
  889. <remarks>
  890. Before you can retrieve messages with the <see cref="T:MailKit.Net.Imap.ImapClient"/>, you must first
  891. call one of the <a href="Overload_MailKit_Net_Imap_ImapClient_Connect.htm">Connect</a>
  892. methods and then authenticate with the one of the
  893. <a href="Overload_MailKit_Net_Imap_ImapClient_Authenticate.htm">Authenticate</a>
  894. methods.
  895. </remarks>
  896. <example>
  897. <code language="c#" source="Examples\ImapExamples.cs" region="DownloadMessages"/>
  898. </example>
  899. </member>
  900. <member name="M:MailKit.Net.Imap.ImapClient.#ctor(MailKit.IProtocolLogger)">
  901. <summary>
  902. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapClient"/> class.
  903. </summary>
  904. <remarks>
  905. Before you can retrieve messages with the <see cref="T:MailKit.Net.Imap.ImapClient"/>, you must first
  906. call one of the <a href="Overload_MailKit_Net_Imap_ImapClient_Connect.htm">Connect</a>
  907. methods and then authenticate with the one of the
  908. <a href="Overload_MailKit_Net_Imap_ImapClient_Authenticate.htm">Authenticate</a>
  909. methods.
  910. </remarks>
  911. <example>
  912. <code language="c#" source="Examples\ImapExamples.cs" region="ProtocolLogger"/>
  913. </example>
  914. <param name="protocolLogger">The protocol logger.</param>
  915. <exception cref="T:System.ArgumentNullException">
  916. <paramref name="protocolLogger"/> is <c>null</c>.
  917. </exception>
  918. </member>
  919. <member name="P:MailKit.Net.Imap.ImapClient.SyncRoot">
  920. <summary>
  921. Gets an object that can be used to synchronize access to the IMAP server.
  922. </summary>
  923. <remarks>
  924. <para>Gets an object that can be used to synchronize access to the IMAP server.</para>
  925. <para>When using the non-Async methods from multiple threads, it is important to lock the
  926. <see cref="P:MailKit.Net.Imap.ImapClient.SyncRoot"/> object for thread safety when using the synchronous methods.</para>
  927. </remarks>
  928. <value>The lock object.</value>
  929. </member>
  930. <member name="P:MailKit.Net.Imap.ImapClient.Protocol">
  931. <summary>
  932. Get the protocol supported by the message service.
  933. </summary>
  934. <remarks>
  935. Gets the protocol supported by the message service.
  936. </remarks>
  937. <value>The protocol.</value>
  938. </member>
  939. <member name="P:MailKit.Net.Imap.ImapClient.Capabilities">
  940. <summary>
  941. Get the capabilities supported by the IMAP server.
  942. </summary>
  943. <remarks>
  944. The capabilities will not be known until a successful connection has been made via one of
  945. the <a href="Overload_MailKit_Net_Imap_ImapClient_Connect.htm">Connect</a> methods and may
  946. change as a side-effect of calling one of the
  947. <a href="Overload_MailKit_Net_Imap_ImapClient_Authenticate.htm">Authenticate</a>
  948. methods.
  949. </remarks>
  950. <example>
  951. <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
  952. </example>
  953. <value>The capabilities.</value>
  954. <exception cref="T:System.ArgumentException">
  955. Capabilities cannot be enabled, they may only be disabled.
  956. </exception>
  957. </member>
  958. <member name="P:MailKit.Net.Imap.ImapClient.AppendLimit">
  959. <summary>
  960. Gets the maximum size of a message that can be appended to a folder.
  961. </summary>
  962. <remarks>
  963. <para>Gets the maximum size of a message, in bytes, that can be appended to a folder.</para>
  964. <note type="note">If the value is not set, then the limit is unspecified.</note>
  965. </remarks>
  966. <value>The append limit.</value>
  967. </member>
  968. <member name="P:MailKit.Net.Imap.ImapClient.InternationalizationLevel">
  969. <summary>
  970. Gets the internationalization level supported by the IMAP server.
  971. </summary>
  972. <remarks>
  973. <para>Gets the internationalization level supported by the IMAP server.</para>
  974. <para>For more information, see
  975. <a href="https://tools.ietf.org/html/rfc5255#section-4">section 4 of rfc5255</a>.</para>
  976. </remarks>
  977. <value>The internationalization level.</value>
  978. </member>
  979. <member name="P:MailKit.Net.Imap.ImapClient.Rights">
  980. <summary>
  981. Get the access rights supported by the IMAP server.
  982. </summary>
  983. <remarks>
  984. These rights are additional rights supported by the IMAP server beyond the standard rights
  985. defined in <a href="https://tools.ietf.org/html/rfc4314#section-2.1">section 2.1 of rfc4314</a>
  986. and will not be populated until the client is successfully connected.
  987. </remarks>
  988. <example>
  989. <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
  990. </example>
  991. <value>The rights.</value>
  992. </member>
  993. <member name="M:MailKit.Net.Imap.ImapClient.CreateImapFolder(MailKit.Net.Imap.ImapFolderConstructorArgs)">
  994. <summary>
  995. Instantiate a new <see cref="T:MailKit.Net.Imap.ImapFolder"/>.
  996. </summary>
  997. <remarks>
  998. <para>Creates a new <see cref="T:MailKit.Net.Imap.ImapFolder"/> instance.</para>
  999. <note type="note">This method's purpose is to allow subclassing <see cref="T:MailKit.Net.Imap.ImapFolder"/>.</note>
  1000. </remarks>
  1001. <returns>The IMAP folder instance.</returns>
  1002. <param name="args">The constructior arguments.</param>
  1003. <exception cref="T:System.ArgumentNullException">
  1004. <paramref name="args"/> is <c>null</c>.
  1005. </exception>
  1006. </member>
  1007. <member name="M:MailKit.Net.Imap.ImapClient.Compress(System.Threading.CancellationToken)">
  1008. <summary>
  1009. Enable compression over the IMAP connection.
  1010. </summary>
  1011. <remarks>
  1012. <para>Enables compression over the IMAP connection.</para>
  1013. <para>If the IMAP server supports the <see cref="F:MailKit.Net.Imap.ImapCapabilities.Compress"/> extension,
  1014. it is possible at any point after connecting to enable compression to reduce network
  1015. bandwidth usage. Ideally, this method should be called before authenticating.</para>
  1016. </remarks>
  1017. <param name="cancellationToken">The cancellation token.</param>
  1018. <exception cref="T:System.ObjectDisposedException">
  1019. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  1020. </exception>
  1021. <exception cref="T:MailKit.ServiceNotConnectedException">
  1022. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  1023. </exception>
  1024. <exception cref="T:System.InvalidOperationException">
  1025. Compression must be enabled before a folder has been selected.
  1026. </exception>
  1027. <exception cref="T:System.NotSupportedException">
  1028. The IMAP server does not support the <see cref="F:MailKit.Net.Imap.ImapCapabilities.Compress"/> extension.
  1029. </exception>
  1030. <exception cref="T:System.OperationCanceledException">
  1031. The operation was canceled via the cancellation token.
  1032. </exception>
  1033. <exception cref="T:System.IO.IOException">
  1034. An I/O error occurred.
  1035. </exception>
  1036. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  1037. The server replied to the COMPRESS command with a NO or BAD response.
  1038. </exception>
  1039. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  1040. An IMAP protocol error occurred.
  1041. </exception>
  1042. </member>
  1043. <member name="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)">
  1044. <summary>
  1045. Enable the QRESYNC feature.
  1046. </summary>
  1047. <remarks>
  1048. <para>Enables the <a href="https://tools.ietf.org/html/rfc5162">QRESYNC</a> feature.</para>
  1049. <para>The QRESYNC extension improves resynchronization performance of folders by
  1050. querying the IMAP server for a list of changes when the folder is opened using the
  1051. <see cref="M:MailKit.Net.Imap.ImapFolder.Open(MailKit.FolderAccess,System.UInt32,System.UInt64,System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)"/>
  1052. method.</para>
  1053. <para>If this feature is enabled, the <see cref="E:MailKit.MailFolder.MessageExpunged"/> event is replaced
  1054. with the <see cref="E:MailKit.MailFolder.MessagesVanished"/> event.</para>
  1055. <para>This method needs to be called immediately after calling one of the
  1056. <a href="Overload_MailKit_Net_Imap_ImapClient_Authenticate.htm">Authenticate</a> methods, before
  1057. opening any folders.</para>
  1058. </remarks>
  1059. <param name="cancellationToken">The cancellation token.</param>
  1060. <exception cref="T:System.ObjectDisposedException">
  1061. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  1062. </exception>
  1063. <exception cref="T:MailKit.ServiceNotConnectedException">
  1064. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  1065. </exception>
  1066. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  1067. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  1068. </exception>
  1069. <exception cref="T:System.InvalidOperationException">
  1070. Quick resynchronization needs to be enabled before selecting a folder.
  1071. </exception>
  1072. <exception cref="T:System.NotSupportedException">
  1073. The IMAP server does not support the QRESYNC extension.
  1074. </exception>
  1075. <exception cref="T:System.OperationCanceledException">
  1076. The operation was canceled via the cancellation token.
  1077. </exception>
  1078. <exception cref="T:System.IO.IOException">
  1079. An I/O error occurred.
  1080. </exception>
  1081. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  1082. The server replied to the ENABLE command with a NO or BAD response.
  1083. </exception>
  1084. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  1085. An IMAP protocol error occurred.
  1086. </exception>
  1087. </member>
  1088. <member name="M:MailKit.Net.Imap.ImapClient.EnableUTF8(System.Threading.CancellationToken)">
  1089. <summary>
  1090. Enable the UTF8=ACCEPT extension.
  1091. </summary>
  1092. <remarks>
  1093. Enables the <a href="https://tools.ietf.org/html/rfc6855">UTF8=ACCEPT</a> extension.
  1094. </remarks>
  1095. <param name="cancellationToken">The cancellation token.</param>
  1096. <exception cref="T:System.ObjectDisposedException">
  1097. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  1098. </exception>
  1099. <exception cref="T:MailKit.ServiceNotConnectedException">
  1100. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  1101. </exception>
  1102. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  1103. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  1104. </exception>
  1105. <exception cref="T:System.InvalidOperationException">
  1106. UTF8=ACCEPT needs to be enabled before selecting a folder.
  1107. </exception>
  1108. <exception cref="T:System.NotSupportedException">
  1109. The IMAP server does not support the UTF8=ACCEPT extension.
  1110. </exception>
  1111. <exception cref="T:System.OperationCanceledException">
  1112. The operation was canceled via the cancellation token.
  1113. </exception>
  1114. <exception cref="T:System.IO.IOException">
  1115. An I/O error occurred.
  1116. </exception>
  1117. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  1118. The server replied to the ENABLE command with a NO or BAD response.
  1119. </exception>
  1120. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  1121. An IMAP protocol error occurred.
  1122. </exception>
  1123. </member>
  1124. <member name="M:MailKit.Net.Imap.ImapClient.Identify(MailKit.Net.Imap.ImapImplementation,System.Threading.CancellationToken)">
  1125. <summary>
  1126. Identify the client implementation to the server and obtain the server implementation details.
  1127. </summary>
  1128. <remarks>
  1129. <para>Passes along the client implementation details to the server while also obtaining implementation
  1130. details from the server.</para>
  1131. <para>If the <paramref name="clientImplementation"/> is <c>null</c> or no properties have been set, no
  1132. identifying information will be sent to the server.</para>
  1133. <note type="security">
  1134. <para>Security Implications</para>
  1135. <para>This command has the danger of violating the privacy of users if misused. Clients should
  1136. notify users that they send the ID command.</para>
  1137. <para>It is highly desirable that implementations provide a method of disabling ID support, perhaps by
  1138. not calling this method at all, or by passing <c>null</c> as the <paramref name="clientImplementation"/>
  1139. argument.</para>
  1140. <para>Implementors must exercise extreme care in adding properties to the <paramref name="clientImplementation"/>.
  1141. Some properties, such as a processor ID number, Ethernet address, or other unique (or mostly unique) identifier
  1142. would allow tracking of users in ways that violate user privacy expectations and may also make it easier for
  1143. attackers to exploit security holes in the client.</para>
  1144. </note>
  1145. </remarks>
  1146. <example>
  1147. <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
  1148. </example>
  1149. <returns>The implementation details of the server if available; otherwise, <c>null</c>.</returns>
  1150. <param name="clientImplementation">The client implementation.</param>
  1151. <param name="cancellationToken">The cancellation token.</param>
  1152. <exception cref="T:System.ObjectDisposedException">
  1153. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  1154. </exception>
  1155. <exception cref="T:MailKit.ServiceNotConnectedException">
  1156. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  1157. </exception>
  1158. <exception cref="T:System.NotSupportedException">
  1159. The IMAP server does not support the ID extension.
  1160. </exception>
  1161. <exception cref="T:System.OperationCanceledException">
  1162. The operation was canceled via the cancellation token.
  1163. </exception>
  1164. <exception cref="T:System.IO.IOException">
  1165. An I/O error occurred.
  1166. </exception>
  1167. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  1168. The server replied to the ID command with a NO or BAD response.
  1169. </exception>
  1170. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  1171. An IMAP protocol error occurred.
  1172. </exception>
  1173. </member>
  1174. <member name="P:MailKit.Net.Imap.ImapClient.AuthenticationMechanisms">
  1175. <summary>
  1176. Get the authentication mechanisms supported by the IMAP server.
  1177. </summary>
  1178. <remarks>
  1179. <para>The authentication mechanisms are queried as part of the
  1180. <a href="Overload_MailKit_Net_Imap_ImapClient_Connect.htm">Connect</a>
  1181. method.</para>
  1182. <note type="tip">To prevent the usage of certain authentication mechanisms,
  1183. simply remove them from the <see cref="P:MailKit.Net.Imap.ImapClient.AuthenticationMechanisms"/> hash set
  1184. before authenticating.</note>
  1185. </remarks>
  1186. <example>
  1187. <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
  1188. </example>
  1189. <value>The authentication mechanisms.</value>
  1190. </member>
  1191. <member name="P:MailKit.Net.Imap.ImapClient.ThreadingAlgorithms">
  1192. <summary>
  1193. Get the threading algorithms supported by the IMAP server.
  1194. </summary>
  1195. <remarks>
  1196. The threading algorithms are queried as part of the
  1197. <a href="Overload_MailKit_Net_Imap_ImapClient_Connect.htm">Connect</a>
  1198. and <a href="Overload_MailKit_Net_Imap_ImapClient_Authenticate.htm">Authenticate</a> methods.
  1199. </remarks>
  1200. <example>
  1201. <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
  1202. </example>
  1203. <value>The supported threading algorithms.</value>
  1204. </member>
  1205. <member name="P:MailKit.Net.Imap.ImapClient.Timeout">
  1206. <summary>
  1207. Get or set the timeout for network streaming operations, in milliseconds.
  1208. </summary>
  1209. <remarks>
  1210. Gets or sets the underlying socket stream's <see cref="P:System.IO.Stream.ReadTimeout"/>
  1211. and <see cref="P:System.IO.Stream.WriteTimeout"/> values.
  1212. </remarks>
  1213. <value>The timeout in milliseconds.</value>
  1214. </member>
  1215. <member name="P:MailKit.Net.Imap.ImapClient.IsConnected">
  1216. <summary>
  1217. Get whether or not the client is currently connected to an IMAP server.
  1218. </summary>
  1219. <remarks>
  1220. <para>The <see cref="P:MailKit.Net.Imap.ImapClient.IsConnected"/> state is set to <c>true</c> immediately after
  1221. one of the <a href="Overload_MailKit_Net_Imap_ImapClient_Connect.htm">Connect</a>
  1222. methods succeeds and is not set back to <c>false</c> until either the client
  1223. is disconnected via <see cref="M:MailKit.Net.Imap.ImapClient.Disconnect(System.Boolean,System.Threading.CancellationToken)"/> or until an
  1224. <see cref="T:MailKit.Net.Imap.ImapProtocolException"/> is thrown while attempting to read or write to
  1225. the underlying network socket.</para>
  1226. <para>When an <see cref="T:MailKit.Net.Imap.ImapProtocolException"/> is caught, the connection state of the
  1227. <see cref="T:MailKit.Net.Imap.ImapClient"/> should be checked before continuing.</para>
  1228. </remarks>
  1229. <value><c>true</c> if the client is connected; otherwise, <c>false</c>.</value>
  1230. </member>
  1231. <member name="P:MailKit.Net.Imap.ImapClient.IsSecure">
  1232. <summary>
  1233. Get whether or not the connection is secure (typically via SSL or TLS).
  1234. </summary>
  1235. <remarks>
  1236. Gets whether or not the connection is secure (typically via SSL or TLS).
  1237. </remarks>
  1238. <value><c>true</c> if the connection is secure; otherwise, <c>false</c>.</value>
  1239. </member>
  1240. <member name="P:MailKit.Net.Imap.ImapClient.IsAuthenticated">
  1241. <summary>
  1242. Get whether or not the client is currently authenticated with the IMAP server.
  1243. </summary>
  1244. <remarks>
  1245. <para>Gets whether or not the client is currently authenticated with the IMAP server.</para>
  1246. <para>To authenticate with the IMAP server, use one of the
  1247. <a href="Overload_MailKit_Net_Imap_ImapClient_Authenticate.htm">Authenticate</a>
  1248. methods.</para>
  1249. </remarks>
  1250. <value><c>true</c> if the client is connected; otherwise, <c>false</c>.</value>
  1251. </member>
  1252. <member name="P:MailKit.Net.Imap.ImapClient.IsIdle">
  1253. <summary>
  1254. Get whether or not the client is currently in the IDLE state.
  1255. </summary>
  1256. <remarks>
  1257. Gets whether or not the client is currently in the IDLE state.
  1258. </remarks>
  1259. <value><c>true</c> if an IDLE command is active; otherwise, <c>false</c>.</value>
  1260. </member>
  1261. <member name="M:MailKit.Net.Imap.ImapClient.Authenticate(MailKit.Security.SaslMechanism,System.Threading.CancellationToken)">
  1262. <summary>
  1263. Authenticate using the specified SASL mechanism.
  1264. </summary>
  1265. <remarks>
  1266. <para>Authenticates using the specified SASL mechanism.</para>
  1267. <para>For a list of available SASL authentication mechanisms supported by the server,
  1268. check the <see cref="P:MailKit.Net.Imap.ImapClient.AuthenticationMechanisms"/> property after the service has been
  1269. connected.</para>
  1270. </remarks>
  1271. <param name="mechanism">The SASL mechanism.</param>
  1272. <param name="cancellationToken">The cancellation token.</param>
  1273. <exception cref="T:System.ArgumentNullException">
  1274. <paramref name="mechanism"/> is <c>null</c>.
  1275. </exception>
  1276. <exception cref="T:System.ObjectDisposedException">
  1277. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  1278. </exception>
  1279. <exception cref="T:MailKit.ServiceNotConnectedException">
  1280. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  1281. </exception>
  1282. <exception cref="T:System.InvalidOperationException">
  1283. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is already authenticated.
  1284. </exception>
  1285. <exception cref="T:System.OperationCanceledException">
  1286. The operation was canceled via the cancellation token.
  1287. </exception>
  1288. <exception cref="T:MailKit.Security.AuthenticationException">
  1289. Authentication using the supplied credentials has failed.
  1290. </exception>
  1291. <exception cref="T:MailKit.Security.SaslException">
  1292. A SASL authentication error occurred.
  1293. </exception>
  1294. <exception cref="T:System.IO.IOException">
  1295. An I/O error occurred.
  1296. </exception>
  1297. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  1298. An IMAP command failed.
  1299. </exception>
  1300. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  1301. An IMAP protocol error occurred.
  1302. </exception>
  1303. </member>
  1304. <member name="M:MailKit.Net.Imap.ImapClient.Authenticate(System.Text.Encoding,System.Net.ICredentials,System.Threading.CancellationToken)">
  1305. <summary>
  1306. Authenticate using the supplied credentials.
  1307. </summary>
  1308. <remarks>
  1309. <para>If the IMAP server supports one or more SASL authentication mechanisms,
  1310. then the SASL mechanisms that both the client and server support are tried
  1311. in order of greatest security to weakest security. Once a SASL
  1312. authentication mechanism is found that both client and server support,
  1313. the credentials are used to authenticate.</para>
  1314. <para>If the server does not support SASL or if no common SASL mechanisms
  1315. can be found, then LOGIN command is used as a fallback.</para>
  1316. <note type="tip">To prevent the usage of certain authentication mechanisms,
  1317. simply remove them from the <see cref="P:MailKit.Net.Imap.ImapClient.AuthenticationMechanisms"/> hash set
  1318. before calling this method.</note>
  1319. </remarks>
  1320. <param name="encoding">The text encoding to use for the user's credentials.</param>
  1321. <param name="credentials">The user's credentials.</param>
  1322. <param name="cancellationToken">The cancellation token.</param>
  1323. <exception cref="T:System.ArgumentNullException">
  1324. <para><paramref name="encoding"/> is <c>null</c>.</para>
  1325. <para>-or-</para>
  1326. <para><paramref name="credentials"/> is <c>null</c>.</para>
  1327. </exception>
  1328. <exception cref="T:System.ObjectDisposedException">
  1329. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  1330. </exception>
  1331. <exception cref="T:MailKit.ServiceNotConnectedException">
  1332. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  1333. </exception>
  1334. <exception cref="T:System.InvalidOperationException">
  1335. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is already authenticated.
  1336. </exception>
  1337. <exception cref="T:System.OperationCanceledException">
  1338. The operation was canceled via the cancellation token.
  1339. </exception>
  1340. <exception cref="T:MailKit.Security.AuthenticationException">
  1341. Authentication using the supplied credentials has failed.
  1342. </exception>
  1343. <exception cref="T:MailKit.Security.SaslException">
  1344. A SASL authentication error occurred.
  1345. </exception>
  1346. <exception cref="T:System.IO.IOException">
  1347. An I/O error occurred.
  1348. </exception>
  1349. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  1350. An IMAP command failed.
  1351. </exception>
  1352. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  1353. An IMAP protocol error occurred.
  1354. </exception>
  1355. </member>
  1356. <member name="M:MailKit.Net.Imap.ImapClient.Connect(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
  1357. <summary>
  1358. Establish a connection to the specified IMAP server.
  1359. </summary>
  1360. <remarks>
  1361. <para>Establishes a connection to the specified IMAP or IMAP/S server.</para>
  1362. <para>If the <paramref name="port"/> has a value of <c>0</c>, then the
  1363. <paramref name="options"/> parameter is used to determine the default port to
  1364. connect to. The default port used with <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>
  1365. is <c>993</c>. All other values will use a default port of <c>143</c>.</para>
  1366. <para>If the <paramref name="options"/> has a value of
  1367. <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
  1368. to determine the default security options. If the <paramref name="port"/> has a value
  1369. of <c>993</c>, then the default options used will be
  1370. <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
  1371. <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
  1372. <para>Once a connection is established, properties such as
  1373. <see cref="P:MailKit.Net.Imap.ImapClient.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Imap.ImapClient.Capabilities"/> will be
  1374. populated.</para>
  1375. </remarks>
  1376. <example>
  1377. <code language="c#" source="Examples\ImapExamples.cs" region="DownloadMessages"/>
  1378. </example>
  1379. <param name="host">The host name to connect to.</param>
  1380. <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
  1381. <param name="options">The secure socket options to when connecting.</param>
  1382. <param name="cancellationToken">The cancellation token.</param>
  1383. <exception cref="T:System.ArgumentNullException">
  1384. <paramref name="host"/> is <c>null</c>.
  1385. </exception>
  1386. <exception cref="T:System.ArgumentOutOfRangeException">
  1387. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  1388. </exception>
  1389. <exception cref="T:System.ArgumentException">
  1390. The <paramref name="host"/> is a zero-length string.
  1391. </exception>
  1392. <exception cref="T:System.ObjectDisposedException">
  1393. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  1394. </exception>
  1395. <exception cref="T:System.InvalidOperationException">
  1396. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is already connected.
  1397. </exception>
  1398. <exception cref="T:System.NotSupportedException">
  1399. <paramref name="options"/> was set to
  1400. <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
  1401. and the IMAP server does not support the STARTTLS extension.
  1402. </exception>
  1403. <exception cref="T:System.OperationCanceledException">
  1404. The operation was canceled via the cancellation token.
  1405. </exception>
  1406. <exception cref="T:System.Net.Sockets.SocketException">
  1407. A socket error occurred trying to connect to the remote host.
  1408. </exception>
  1409. <exception cref="T:System.IO.IOException">
  1410. An I/O error occurred.
  1411. </exception>
  1412. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  1413. An IMAP command failed.
  1414. </exception>
  1415. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  1416. An IMAP protocol error occurred.
  1417. </exception>
  1418. </member>
  1419. <member name="M:MailKit.Net.Imap.ImapClient.Connect(System.Net.Sockets.Socket,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
  1420. <summary>
  1421. Establish a connection to the specified IMAP or IMAP/S server using the provided socket.
  1422. </summary>
  1423. <remarks>
  1424. <para>Establishes a connection to the specified IMAP or IMAP/S server using
  1425. the provided socket.</para>
  1426. <para>If the <paramref name="options"/> has a value of
  1427. <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
  1428. to determine the default security options. If the <paramref name="port"/> has a value
  1429. of <c>993</c>, then the default options used will be
  1430. <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
  1431. <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
  1432. <para>Once a connection is established, properties such as
  1433. <see cref="P:MailKit.Net.Imap.ImapClient.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Imap.ImapClient.Capabilities"/> will be
  1434. populated.</para>
  1435. <note type="info">With the exception of using the <paramref name="port"/> to determine the
  1436. default <see cref="T:MailKit.Security.SecureSocketOptions"/> to use when the <paramref name="options"/> value
  1437. is <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, the <paramref name="host"/> and
  1438. <paramref name="port"/> parameters are only used for logging purposes.</note>
  1439. </remarks>
  1440. <param name="socket">The socket to use for the connection.</param>
  1441. <param name="host">The host name to connect to.</param>
  1442. <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
  1443. <param name="options">The secure socket options to when connecting.</param>
  1444. <param name="cancellationToken">The cancellation token.</param>
  1445. <exception cref="T:System.ArgumentNullException">
  1446. <para><paramref name="socket"/> is <c>null</c>.</para>
  1447. <para>-or-</para>
  1448. <para><paramref name="host"/> is <c>null</c>.</para>
  1449. </exception>
  1450. <exception cref="T:System.ArgumentOutOfRangeException">
  1451. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  1452. </exception>
  1453. <exception cref="T:System.ArgumentException">
  1454. <para><paramref name="socket"/> is not connected.</para>
  1455. <para>-or-</para>
  1456. <para>The <paramref name="host"/> is a zero-length string.</para>
  1457. </exception>
  1458. <exception cref="T:System.ObjectDisposedException">
  1459. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  1460. </exception>
  1461. <exception cref="T:System.InvalidOperationException">
  1462. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is already connected.
  1463. </exception>
  1464. <exception cref="T:System.NotSupportedException">
  1465. <paramref name="options"/> was set to
  1466. <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
  1467. and the IMAP server does not support the STARTTLS extension.
  1468. </exception>
  1469. <exception cref="T:System.OperationCanceledException">
  1470. The operation was canceled via the cancellation token.
  1471. </exception>
  1472. <exception cref="T:System.IO.IOException">
  1473. An I/O error occurred.
  1474. </exception>
  1475. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  1476. An IMAP command failed.
  1477. </exception>
  1478. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  1479. An IMAP protocol error occurred.
  1480. </exception>
  1481. </member>
  1482. <member name="M:MailKit.Net.Imap.ImapClient.Connect(System.IO.Stream,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
  1483. <summary>
  1484. Establish a connection to the specified IMAP or IMAP/S server using the provided stream.
  1485. </summary>
  1486. <remarks>
  1487. <para>Establishes a connection to the specified IMAP or IMAP/S server using
  1488. the provided stream.</para>
  1489. <para>If the <paramref name="options"/> has a value of
  1490. <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
  1491. to determine the default security options. If the <paramref name="port"/> has a value
  1492. of <c>993</c>, then the default options used will be
  1493. <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
  1494. <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
  1495. <para>Once a connection is established, properties such as
  1496. <see cref="P:MailKit.Net.Imap.ImapClient.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Imap.ImapClient.Capabilities"/> will be
  1497. populated.</para>
  1498. <note type="info">With the exception of using the <paramref name="port"/> to determine the
  1499. default <see cref="T:MailKit.Security.SecureSocketOptions"/> to use when the <paramref name="options"/> value
  1500. is <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, the <paramref name="host"/> and
  1501. <paramref name="port"/> parameters are only used for logging purposes.</note>
  1502. </remarks>
  1503. <param name="stream">The stream to use for the connection.</param>
  1504. <param name="host">The host name to connect to.</param>
  1505. <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
  1506. <param name="options">The secure socket options to when connecting.</param>
  1507. <param name="cancellationToken">The cancellation token.</param>
  1508. <exception cref="T:System.ArgumentNullException">
  1509. <para><paramref name="stream"/> is <c>null</c>.</para>
  1510. <para>-or-</para>
  1511. <para><paramref name="host"/> is <c>null</c>.</para>
  1512. </exception>
  1513. <exception cref="T:System.ArgumentOutOfRangeException">
  1514. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  1515. </exception>
  1516. <exception cref="T:System.ArgumentException">
  1517. The <paramref name="host"/> is a zero-length string.
  1518. </exception>
  1519. <exception cref="T:System.ObjectDisposedException">
  1520. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  1521. </exception>
  1522. <exception cref="T:System.InvalidOperationException">
  1523. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is already connected.
  1524. </exception>
  1525. <exception cref="T:System.NotSupportedException">
  1526. <paramref name="options"/> was set to
  1527. <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
  1528. and the IMAP server does not support the STARTTLS extension.
  1529. </exception>
  1530. <exception cref="T:System.OperationCanceledException">
  1531. The operation was canceled via the cancellation token.
  1532. </exception>
  1533. <exception cref="T:System.IO.IOException">
  1534. An I/O error occurred.
  1535. </exception>
  1536. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  1537. An IMAP command failed.
  1538. </exception>
  1539. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  1540. An IMAP protocol error occurred.
  1541. </exception>
  1542. </member>
  1543. <member name="M:MailKit.Net.Imap.ImapClient.Disconnect(System.Boolean,System.Threading.CancellationToken)">
  1544. <summary>
  1545. Disconnect the service.
  1546. </summary>
  1547. <remarks>
  1548. If <paramref name="quit"/> is <c>true</c>, a <c>LOGOUT</c> command will be issued in order to disconnect cleanly.
  1549. </remarks>
  1550. <example>
  1551. <code language="c#" source="Examples\ImapExamples.cs" region="DownloadMessages"/>
  1552. </example>
  1553. <param name="quit">If set to <c>true</c>, a <c>LOGOUT</c> command will be issued in order to disconnect cleanly.</param>
  1554. <param name="cancellationToken">The cancellation token.</param>
  1555. <exception cref="T:System.ObjectDisposedException">
  1556. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  1557. </exception>
  1558. </member>
  1559. <member name="M:MailKit.Net.Imap.ImapClient.NoOp(System.Threading.CancellationToken)">
  1560. <summary>
  1561. Ping the IMAP server to keep the connection alive.
  1562. </summary>
  1563. <remarks>
  1564. <para>The <c>NOOP</c> command is typically used to keep the connection with the IMAP server
  1565. alive. When a client goes too long (typically 30 minutes) without sending any commands to the
  1566. IMAP server, the IMAP server will close the connection with the client, forcing the client to
  1567. reconnect before it can send any more commands.</para>
  1568. <para>The <c>NOOP</c> command also provides a great way for a client to check for new
  1569. messages.</para>
  1570. <para>When the IMAP server receives a <c>NOOP</c> command, it will reply to the client with a
  1571. list of pending updates such as <c>EXISTS</c> and <c>RECENT</c> counts on the currently
  1572. selected folder. To receive these notifications, subscribe to the
  1573. <see cref="E:MailKit.MailFolder.CountChanged"/> and <see cref="E:MailKit.MailFolder.RecentChanged"/> events,
  1574. respectively.</para>
  1575. <para>For more information about the <c>NOOP</c> command, see
  1576. <a href="https://tools.ietf.org/html/rfc3501#section-6.1.2">rfc3501</a>.</para>
  1577. </remarks>
  1578. <example>
  1579. <code language="c#" source="Examples\ImapIdleExample.cs"/>
  1580. </example>
  1581. <param name="cancellationToken">The cancellation token.</param>
  1582. <exception cref="T:System.ObjectDisposedException">
  1583. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  1584. </exception>
  1585. <exception cref="T:MailKit.ServiceNotConnectedException">
  1586. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  1587. </exception>
  1588. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  1589. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  1590. </exception>
  1591. <exception cref="T:System.OperationCanceledException">
  1592. The operation was canceled via the cancellation token.
  1593. </exception>
  1594. <exception cref="T:System.IO.IOException">
  1595. An I/O error occurred.
  1596. </exception>
  1597. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  1598. The server replied to the NOOP command with a NO or BAD response.
  1599. </exception>
  1600. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  1601. The server responded with an unexpected token.
  1602. </exception>
  1603. </member>
  1604. <member name="M:MailKit.Net.Imap.ImapClient.Idle(System.Threading.CancellationToken,System.Threading.CancellationToken)">
  1605. <summary>
  1606. Toggle the <see cref="T:MailKit.Net.Imap.ImapClient"/> into the IDLE state.
  1607. </summary>
  1608. <remarks>
  1609. <para>When a client enters the IDLE state, the IMAP server will send
  1610. events to the client as they occur on the selected folder. These events
  1611. may include notifications of new messages arriving, expunge notifications,
  1612. flag changes, etc.</para>
  1613. <para>Due to the nature of the IDLE command, a folder must be selected
  1614. before a client can enter into the IDLE state. This can be done by
  1615. opening a folder using
  1616. <see cref="M:MailKit.MailFolder.Open(MailKit.FolderAccess,System.Threading.CancellationToken)"/>
  1617. or any of the other variants.</para>
  1618. <para>While the IDLE command is running, no other commands may be issued until the
  1619. <paramref name="doneToken"/> is cancelled.</para>
  1620. <note type="note">It is especially important to cancel the <paramref name="doneToken"/>
  1621. before cancelling the <paramref name="cancellationToken"/> when using SSL or TLS due to
  1622. the fact that <see cref="T:System.Net.Security.SslStream"/> cannot be polled.</note>
  1623. </remarks>
  1624. <example>
  1625. <code language="c#" source="Examples\ImapIdleExample.cs"/>
  1626. </example>
  1627. <param name="doneToken">The cancellation token used to return to the non-idle state.</param>
  1628. <param name="cancellationToken">The cancellation token.</param>
  1629. <exception cref="T:System.ArgumentException">
  1630. <paramref name="doneToken"/> must be cancellable (i.e. <see cref="P:System.Threading.CancellationToken.None"/> cannot be used).
  1631. </exception>
  1632. <exception cref="T:System.ObjectDisposedException">
  1633. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  1634. </exception>
  1635. <exception cref="T:MailKit.ServiceNotConnectedException">
  1636. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  1637. </exception>
  1638. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  1639. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  1640. </exception>
  1641. <exception cref="T:System.InvalidOperationException">
  1642. A <see cref="T:MailKit.Net.Imap.ImapFolder"/> has not been opened.
  1643. </exception>
  1644. <exception cref="T:System.NotSupportedException">
  1645. The IMAP server does not support the IDLE extension.
  1646. </exception>
  1647. <exception cref="T:System.OperationCanceledException">
  1648. The operation was canceled via the cancellation token.
  1649. </exception>
  1650. <exception cref="T:System.IO.IOException">
  1651. An I/O error occurred.
  1652. </exception>
  1653. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  1654. The server replied to the IDLE command with a NO or BAD response.
  1655. </exception>
  1656. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  1657. The server responded with an unexpected token.
  1658. </exception>
  1659. </member>
  1660. <member name="M:MailKit.Net.Imap.ImapClient.Notify(System.Boolean,System.Collections.Generic.IList{MailKit.Net.Imap.ImapEventGroup},System.Threading.CancellationToken)">
  1661. <summary>
  1662. Request the specified notification events from the IMAP server.
  1663. </summary>
  1664. <remarks>
  1665. <para>The <a href="https://tools.ietf.org/html/rfc5465">NOTIFY</a> command is used to expand
  1666. which notifications the client wishes to be notified about, including status notifications
  1667. about folders other than the currently selected folder. It can also be used to automatically
  1668. FETCH information about new messages that have arrived in the currently selected folder.</para>
  1669. <para>This, combined with <see cref="M:MailKit.Net.Imap.ImapClient.Idle(System.Threading.CancellationToken,System.Threading.CancellationToken)"/>,
  1670. can be used to get instant notifications for changes to any of the specified folders.</para>
  1671. </remarks>
  1672. <param name="status"><c>true</c> if the server should immediately notify the client of the
  1673. selected folder's status; otherwise, <c>false</c>.</param>
  1674. <param name="eventGroups">The specific event groups that the client would like to receive notifications for.</param>
  1675. <param name="cancellationToken">The cancellation token.</param>
  1676. <exception cref="T:System.ArgumentNullException">
  1677. <paramref name="eventGroups"/> is <c>null</c>.
  1678. </exception>
  1679. <exception cref="T:System.ArgumentException">
  1680. <paramref name="eventGroups"/> is empty.
  1681. </exception>
  1682. <exception cref="T:System.ObjectDisposedException">
  1683. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  1684. </exception>
  1685. <exception cref="T:MailKit.ServiceNotConnectedException">
  1686. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  1687. </exception>
  1688. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  1689. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  1690. </exception>
  1691. <exception cref="T:System.InvalidOperationException">
  1692. One or more <see cref="T:MailKit.Net.Imap.ImapEventGroup"/> is invalid.
  1693. </exception>
  1694. <exception cref="T:System.NotSupportedException">
  1695. The IMAP server does not support the NOTIFY extension.
  1696. </exception>
  1697. <exception cref="T:System.OperationCanceledException">
  1698. The operation was canceled via the cancellation token.
  1699. </exception>
  1700. <exception cref="T:System.IO.IOException">
  1701. An I/O error occurred.
  1702. </exception>
  1703. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  1704. The server replied to the NOTIFY command with a NO or BAD response.
  1705. </exception>
  1706. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  1707. The server responded with an unexpected token.
  1708. </exception>
  1709. </member>
  1710. <member name="M:MailKit.Net.Imap.ImapClient.DisableNotify(System.Threading.CancellationToken)">
  1711. <summary>
  1712. Disable any previously requested notification events from the IMAP server.
  1713. </summary>
  1714. <remarks>
  1715. Disables any notification events requested in a prior call to
  1716. <see cref="M:MailKit.Net.Imap.ImapClient.Notify(System.Boolean,System.Collections.Generic.IList{MailKit.Net.Imap.ImapEventGroup},System.Threading.CancellationToken)"/>.
  1717. request.
  1718. </remarks>
  1719. <param name="cancellationToken">The cancellation token.</param>
  1720. <exception cref="T:System.ObjectDisposedException">
  1721. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  1722. </exception>
  1723. <exception cref="T:MailKit.ServiceNotConnectedException">
  1724. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  1725. </exception>
  1726. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  1727. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  1728. </exception>
  1729. <exception cref="T:System.NotSupportedException">
  1730. The IMAP server does not support the NOTIFY extension.
  1731. </exception>
  1732. <exception cref="T:System.OperationCanceledException">
  1733. The operation was canceled via the cancellation token.
  1734. </exception>
  1735. <exception cref="T:System.IO.IOException">
  1736. An I/O error occurred.
  1737. </exception>
  1738. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  1739. The server replied to the NOTIFY command with a NO or BAD response.
  1740. </exception>
  1741. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  1742. The server responded with an unexpected token.
  1743. </exception>
  1744. </member>
  1745. <member name="P:MailKit.Net.Imap.ImapClient.PersonalNamespaces">
  1746. <summary>
  1747. Get the personal namespaces.
  1748. </summary>
  1749. <remarks>
  1750. The personal folder namespaces contain a user's personal mailbox folders.
  1751. </remarks>
  1752. <value>The personal namespaces.</value>
  1753. </member>
  1754. <member name="P:MailKit.Net.Imap.ImapClient.SharedNamespaces">
  1755. <summary>
  1756. Get the shared namespaces.
  1757. </summary>
  1758. <remarks>
  1759. The shared folder namespaces contain mailbox folders that are shared with the user.
  1760. </remarks>
  1761. <value>The shared namespaces.</value>
  1762. </member>
  1763. <member name="P:MailKit.Net.Imap.ImapClient.OtherNamespaces">
  1764. <summary>
  1765. Get the other namespaces.
  1766. </summary>
  1767. <remarks>
  1768. The other folder namespaces contain other mailbox folders.
  1769. </remarks>
  1770. <value>The other namespaces.</value>
  1771. </member>
  1772. <member name="P:MailKit.Net.Imap.ImapClient.SupportsQuotas">
  1773. <summary>
  1774. Get whether or not the mail store supports quotas.
  1775. </summary>
  1776. <remarks>
  1777. Gets whether or not the mail store supports quotas.
  1778. </remarks>
  1779. <value><c>true</c> if the mail store supports quotas; otherwise, <c>false</c>.</value>
  1780. </member>
  1781. <member name="P:MailKit.Net.Imap.ImapClient.Inbox">
  1782. <summary>
  1783. Get the Inbox folder.
  1784. </summary>
  1785. <remarks>
  1786. <para>The Inbox folder is the default folder and always exists on the server.</para>
  1787. <note type="note">This property will only be available after the client has been authenticated.</note>
  1788. </remarks>
  1789. <example>
  1790. <code language="c#" source="Examples\ImapExamples.cs" region="DownloadMessages"/>
  1791. </example>
  1792. <value>The Inbox folder.</value>
  1793. <exception cref="T:System.ObjectDisposedException">
  1794. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  1795. </exception>
  1796. <exception cref="T:MailKit.ServiceNotConnectedException">
  1797. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  1798. </exception>
  1799. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  1800. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  1801. </exception>
  1802. </member>
  1803. <member name="M:MailKit.Net.Imap.ImapClient.GetFolder(MailKit.SpecialFolder)">
  1804. <summary>
  1805. Get the specified special folder.
  1806. </summary>
  1807. <remarks>
  1808. Not all IMAP servers support special folders. Only IMAP servers
  1809. supporting the <see cref="F:MailKit.Net.Imap.ImapCapabilities.SpecialUse"/> or
  1810. <see cref="F:MailKit.Net.Imap.ImapCapabilities.XList"/> extensions may have
  1811. special folders.
  1812. </remarks>
  1813. <returns>The folder if available; otherwise <c>null</c>.</returns>
  1814. <param name="folder">The type of special folder.</param>
  1815. <exception cref="T:System.ArgumentOutOfRangeException">
  1816. <paramref name="folder"/> is out of range.
  1817. </exception>
  1818. <exception cref="T:System.ObjectDisposedException">
  1819. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  1820. </exception>
  1821. <exception cref="T:MailKit.ServiceNotConnectedException">
  1822. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  1823. </exception>
  1824. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  1825. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  1826. </exception>
  1827. <exception cref="T:System.NotSupportedException">
  1828. The IMAP server does not support the SPECIAL-USE nor XLIST extensions.
  1829. </exception>
  1830. </member>
  1831. <member name="M:MailKit.Net.Imap.ImapClient.GetFolder(MailKit.FolderNamespace)">
  1832. <summary>
  1833. Get the folder for the specified namespace.
  1834. </summary>
  1835. <remarks>
  1836. Gets the folder for the specified namespace.
  1837. </remarks>
  1838. <returns>The folder.</returns>
  1839. <param name="namespace">The namespace.</param>
  1840. <exception cref="T:System.ArgumentNullException">
  1841. <paramref name="namespace"/> is <c>null</c>.
  1842. </exception>
  1843. <exception cref="T:System.ObjectDisposedException">
  1844. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  1845. </exception>
  1846. <exception cref="T:MailKit.ServiceNotConnectedException">
  1847. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  1848. </exception>
  1849. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  1850. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  1851. </exception>
  1852. <exception cref="T:MailKit.FolderNotFoundException">
  1853. The folder could not be found.
  1854. </exception>
  1855. </member>
  1856. <member name="M:MailKit.Net.Imap.ImapClient.GetFolders(MailKit.FolderNamespace,MailKit.StatusItems,System.Boolean,System.Threading.CancellationToken)">
  1857. <summary>
  1858. Get all of the folders within the specified namespace.
  1859. </summary>
  1860. <remarks>
  1861. Gets all of the folders within the specified namespace.
  1862. </remarks>
  1863. <returns>The folders.</returns>
  1864. <param name="namespace">The namespace.</param>
  1865. <param name="items">The status items to pre-populate.</param>
  1866. <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
  1867. <param name="cancellationToken">The cancellation token.</param>
  1868. <exception cref="T:System.ArgumentNullException">
  1869. <paramref name="namespace"/> is <c>null</c>.
  1870. </exception>
  1871. <exception cref="T:System.ObjectDisposedException">
  1872. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  1873. </exception>
  1874. <exception cref="T:MailKit.ServiceNotConnectedException">
  1875. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  1876. </exception>
  1877. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  1878. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  1879. </exception>
  1880. <exception cref="T:System.OperationCanceledException">
  1881. The operation was canceled via the cancellation token.
  1882. </exception>
  1883. <exception cref="T:MailKit.FolderNotFoundException">
  1884. The namespace folder could not be found.
  1885. </exception>
  1886. <exception cref="T:System.IO.IOException">
  1887. An I/O error occurred.
  1888. </exception>
  1889. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  1890. The server replied to the LIST or LSUB command with a NO or BAD response.
  1891. </exception>
  1892. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  1893. The server responded with an unexpected token.
  1894. </exception>
  1895. </member>
  1896. <member name="M:MailKit.Net.Imap.ImapClient.GetFolder(System.String,System.Threading.CancellationToken)">
  1897. <summary>
  1898. Get the folder for the specified path.
  1899. </summary>
  1900. <remarks>
  1901. Gets the folder for the specified path.
  1902. </remarks>
  1903. <returns>The folder.</returns>
  1904. <param name="path">The folder path.</param>
  1905. <param name="cancellationToken">The cancellation token.</param>
  1906. <exception cref="T:System.ArgumentNullException">
  1907. <paramref name="path"/> is <c>null</c>.
  1908. </exception>
  1909. <exception cref="T:System.ObjectDisposedException">
  1910. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  1911. </exception>
  1912. <exception cref="T:MailKit.ServiceNotConnectedException">
  1913. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  1914. </exception>
  1915. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  1916. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  1917. </exception>
  1918. <exception cref="T:System.OperationCanceledException">
  1919. The operation was canceled via the cancellation token.
  1920. </exception>
  1921. <exception cref="T:MailKit.FolderNotFoundException">
  1922. The folder could not be found.
  1923. </exception>
  1924. <exception cref="T:System.IO.IOException">
  1925. An I/O error occurred.
  1926. </exception>
  1927. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  1928. The server replied to the IDLE command with a NO or BAD response.
  1929. </exception>
  1930. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  1931. The server responded with an unexpected token.
  1932. </exception>
  1933. </member>
  1934. <member name="M:MailKit.Net.Imap.ImapClient.GetMetadata(MailKit.MetadataTag,System.Threading.CancellationToken)">
  1935. <summary>
  1936. Gets the specified metadata.
  1937. </summary>
  1938. <remarks>
  1939. Gets the specified metadata.
  1940. </remarks>
  1941. <returns>The requested metadata value.</returns>
  1942. <param name="tag">The metadata tag.</param>
  1943. <param name="cancellationToken">The cancellation token.</param>
  1944. <exception cref="T:System.ObjectDisposedException">
  1945. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  1946. </exception>
  1947. <exception cref="T:MailKit.ServiceNotConnectedException">
  1948. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  1949. </exception>
  1950. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  1951. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  1952. </exception>
  1953. <exception cref="T:System.NotSupportedException">
  1954. The IMAP server does not support the METADATA or METADATA-SERVER extension.
  1955. </exception>
  1956. <exception cref="T:System.OperationCanceledException">
  1957. The operation was canceled via the cancellation token.
  1958. </exception>
  1959. <exception cref="T:System.IO.IOException">
  1960. An I/O error occurred.
  1961. </exception>
  1962. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  1963. The server's response contained unexpected tokens.
  1964. </exception>
  1965. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  1966. The server replied with a NO or BAD response.
  1967. </exception>
  1968. </member>
  1969. <member name="M:MailKit.Net.Imap.ImapClient.GetMetadata(MailKit.MetadataOptions,System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
  1970. <summary>
  1971. Gets the specified metadata.
  1972. </summary>
  1973. <remarks>
  1974. Gets the specified metadata.
  1975. </remarks>
  1976. <returns>The requested metadata.</returns>
  1977. <param name="options">The metadata options.</param>
  1978. <param name="tags">The metadata tags.</param>
  1979. <param name="cancellationToken">The cancellation token.</param>
  1980. <exception cref="T:System.ArgumentNullException">
  1981. <para><paramref name="options"/> is <c>null</c>.</para>
  1982. <para>-or-</para>
  1983. <para><paramref name="tags"/> is <c>null</c>.</para>
  1984. </exception>
  1985. <exception cref="T:System.ObjectDisposedException">
  1986. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  1987. </exception>
  1988. <exception cref="T:MailKit.ServiceNotConnectedException">
  1989. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  1990. </exception>
  1991. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  1992. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  1993. </exception>
  1994. <exception cref="T:System.NotSupportedException">
  1995. The IMAP server does not support the METADATA or METADATA-SERVER extension.
  1996. </exception>
  1997. <exception cref="T:System.OperationCanceledException">
  1998. The operation was canceled via the cancellation token.
  1999. </exception>
  2000. <exception cref="T:System.IO.IOException">
  2001. An I/O error occurred.
  2002. </exception>
  2003. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  2004. The server's response contained unexpected tokens.
  2005. </exception>
  2006. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  2007. The server replied with a NO or BAD response.
  2008. </exception>
  2009. </member>
  2010. <member name="M:MailKit.Net.Imap.ImapClient.SetMetadata(MailKit.MetadataCollection,System.Threading.CancellationToken)">
  2011. <summary>
  2012. Sets the specified metadata.
  2013. </summary>
  2014. <remarks>
  2015. Sets the specified metadata.
  2016. </remarks>
  2017. <param name="metadata">The metadata.</param>
  2018. <param name="cancellationToken">The cancellation token.</param>
  2019. <exception cref="T:System.ArgumentNullException">
  2020. <paramref name="metadata"/> is <c>null</c>.
  2021. </exception>
  2022. <exception cref="T:System.ObjectDisposedException">
  2023. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  2024. </exception>
  2025. <exception cref="T:MailKit.ServiceNotConnectedException">
  2026. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  2027. </exception>
  2028. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  2029. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  2030. </exception>
  2031. <exception cref="T:System.NotSupportedException">
  2032. The IMAP server does not support the METADATA or METADATA-SERVER extension.
  2033. </exception>
  2034. <exception cref="T:System.OperationCanceledException">
  2035. The operation was canceled via the cancellation token.
  2036. </exception>
  2037. <exception cref="T:System.IO.IOException">
  2038. An I/O error occurred.
  2039. </exception>
  2040. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  2041. The server's response contained unexpected tokens.
  2042. </exception>
  2043. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  2044. The server replied with a NO or BAD response.
  2045. </exception>
  2046. </member>
  2047. <member name="M:MailKit.Net.Imap.ImapClient.Dispose(System.Boolean)">
  2048. <summary>
  2049. Releases the unmanaged resources used by the <see cref="T:MailKit.Net.Imap.ImapClient"/> and
  2050. optionally releases the managed resources.
  2051. </summary>
  2052. <remarks>
  2053. Releases the unmanaged resources used by the <see cref="T:MailKit.Net.Imap.ImapClient"/> and
  2054. optionally releases the managed resources.
  2055. </remarks>
  2056. <param name="disposing"><c>true</c> to release both managed and unmanaged resources;
  2057. <c>false</c> to release only the unmanaged resources.</param>
  2058. </member>
  2059. <member name="T:MailKit.Net.Imap.IImapClient">
  2060. <summary>
  2061. An interface for an IMAP client.
  2062. </summary>
  2063. <remarks>
  2064. Implemented by <see cref="T:MailKit.Net.Imap.ImapClient"/>.
  2065. </remarks>
  2066. </member>
  2067. <member name="P:MailKit.Net.Imap.IImapClient.Capabilities">
  2068. <summary>
  2069. Get the capabilities supported by the IMAP server.
  2070. </summary>
  2071. <remarks>
  2072. The capabilities will not be known until a successful connection has been made via one of
  2073. the <a href="Overload_MailKit_Net_Imap_ImapClient_Connect.htm">Connect</a> methods and may
  2074. change as a side-effect of calling one of the
  2075. <a href="Overload_MailKit_Net_Imap_ImapClient_Authenticate.htm">Authenticate</a>
  2076. methods.
  2077. </remarks>
  2078. <example>
  2079. <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
  2080. </example>
  2081. <value>The capabilities.</value>
  2082. <exception cref="T:System.ArgumentException">
  2083. Capabilities cannot be enabled, they may only be disabled.
  2084. </exception>
  2085. </member>
  2086. <member name="P:MailKit.Net.Imap.IImapClient.AppendLimit">
  2087. <summary>
  2088. Gets the maximum size of a message that can be appended to a folder.
  2089. </summary>
  2090. <remarks>
  2091. <para>Gets the maximum size of a message, in bytes, that can be appended to a folder.</para>
  2092. <note type="note">If the value is not set, then the limit is unspecified.</note>
  2093. </remarks>
  2094. <value>The append limit.</value>
  2095. </member>
  2096. <member name="P:MailKit.Net.Imap.IImapClient.InternationalizationLevel">
  2097. <summary>
  2098. Gets the internationalization level supported by the IMAP server.
  2099. </summary>
  2100. <remarks>
  2101. <para>Gets the internationalization level supported by the IMAP server.</para>
  2102. <para>For more information, see
  2103. <a href="https://tools.ietf.org/html/rfc5255#section-4">section 4 of rfc5255</a>.</para>
  2104. </remarks>
  2105. <value>The internationalization level.</value>
  2106. </member>
  2107. <member name="P:MailKit.Net.Imap.IImapClient.Rights">
  2108. <summary>
  2109. Get the access rights supported by the IMAP server.
  2110. </summary>
  2111. <remarks>
  2112. These rights are additional rights supported by the IMAP server beyond the standard rights
  2113. defined in <a href="https://tools.ietf.org/html/rfc4314#section-2.1">section 2.1 of rfc4314</a>
  2114. and will not be populated until the client is successfully connected.
  2115. </remarks>
  2116. <example>
  2117. <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
  2118. </example>
  2119. <value>The rights.</value>
  2120. </member>
  2121. <member name="P:MailKit.Net.Imap.IImapClient.IsIdle">
  2122. <summary>
  2123. Get whether or not the client is currently in the IDLE state.
  2124. </summary>
  2125. <remarks>
  2126. Gets whether or not the client is currently in the IDLE state.
  2127. </remarks>
  2128. <value><c>true</c> if an IDLE command is active; otherwise, <c>false</c>.</value>
  2129. </member>
  2130. <member name="M:MailKit.Net.Imap.IImapClient.Compress(System.Threading.CancellationToken)">
  2131. <summary>
  2132. Enable compression over the IMAP connection.
  2133. </summary>
  2134. <remarks>
  2135. <para>Enables compression over the IMAP connection.</para>
  2136. <para>If the IMAP server supports the <see cref="F:MailKit.Net.Imap.ImapCapabilities.Compress"/> extension,
  2137. it is possible at any point after connecting to enable compression to reduce network
  2138. bandwidth usage. Ideally, this method should be called before authenticating.</para>
  2139. </remarks>
  2140. <param name="cancellationToken">The cancellation token.</param>
  2141. <exception cref="T:System.ObjectDisposedException">
  2142. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  2143. </exception>
  2144. <exception cref="T:MailKit.ServiceNotConnectedException">
  2145. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  2146. </exception>
  2147. <exception cref="T:System.InvalidOperationException">
  2148. Compression must be enabled before a folder has been selected.
  2149. </exception>
  2150. <exception cref="T:System.NotSupportedException">
  2151. The IMAP server does not support the <see cref="F:MailKit.Net.Imap.ImapCapabilities.Compress"/> extension.
  2152. </exception>
  2153. <exception cref="T:System.OperationCanceledException">
  2154. The operation was canceled via the cancellation token.
  2155. </exception>
  2156. <exception cref="T:System.IO.IOException">
  2157. An I/O error occurred.
  2158. </exception>
  2159. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  2160. The server replied to the COMPRESS command with a NO or BAD response.
  2161. </exception>
  2162. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  2163. An IMAP protocol error occurred.
  2164. </exception>
  2165. </member>
  2166. <member name="M:MailKit.Net.Imap.IImapClient.CompressAsync(System.Threading.CancellationToken)">
  2167. <summary>
  2168. Asynchronously enable compression over the IMAP connection.
  2169. </summary>
  2170. <remarks>
  2171. <para>Asynchronously enables compression over the IMAP connection.</para>
  2172. <para>If the IMAP server supports the <see cref="F:MailKit.Net.Imap.ImapCapabilities.Compress"/> extension,
  2173. it is possible at any point after connecting to enable compression to reduce network
  2174. bandwidth usage. Ideally, this method should be called before authenticating.</para>
  2175. </remarks>
  2176. <returns>An asynchronous task context.</returns>
  2177. <param name="cancellationToken">The cancellation token.</param>
  2178. <exception cref="T:System.ObjectDisposedException">
  2179. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  2180. </exception>
  2181. <exception cref="T:MailKit.ServiceNotConnectedException">
  2182. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  2183. </exception>
  2184. <exception cref="T:System.InvalidOperationException">
  2185. Compression must be enabled before a folder has been selected.
  2186. </exception>
  2187. <exception cref="T:System.NotSupportedException">
  2188. The IMAP server does not support the COMPRESS extension.
  2189. </exception>
  2190. <exception cref="T:System.OperationCanceledException">
  2191. The operation was canceled via the cancellation token.
  2192. </exception>
  2193. <exception cref="T:System.IO.IOException">
  2194. An I/O error occurred.
  2195. </exception>
  2196. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  2197. The server replied to the COMPRESS command with a NO or BAD response.
  2198. </exception>
  2199. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  2200. An IMAP protocol error occurred.
  2201. </exception>
  2202. </member>
  2203. <member name="M:MailKit.Net.Imap.IImapClient.EnableUTF8(System.Threading.CancellationToken)">
  2204. <summary>
  2205. Enable the UTF8=ACCEPT extension.
  2206. </summary>
  2207. <remarks>
  2208. Enables the <a href="https://tools.ietf.org/html/rfc6855">UTF8=ACCEPT</a> extension.
  2209. </remarks>
  2210. <param name="cancellationToken">The cancellation token.</param>
  2211. <exception cref="T:System.ObjectDisposedException">
  2212. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  2213. </exception>
  2214. <exception cref="T:MailKit.ServiceNotConnectedException">
  2215. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  2216. </exception>
  2217. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  2218. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  2219. </exception>
  2220. <exception cref="T:System.InvalidOperationException">
  2221. UTF8=ACCEPT needs to be enabled before selecting a folder.
  2222. </exception>
  2223. <exception cref="T:System.NotSupportedException">
  2224. The IMAP server does not support the UTF8=ACCEPT extension.
  2225. </exception>
  2226. <exception cref="T:System.OperationCanceledException">
  2227. The operation was canceled via the cancellation token.
  2228. </exception>
  2229. <exception cref="T:System.IO.IOException">
  2230. An I/O error occurred.
  2231. </exception>
  2232. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  2233. The server replied to the ENABLE command with a NO or BAD response.
  2234. </exception>
  2235. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  2236. An IMAP protocol error occurred.
  2237. </exception>
  2238. </member>
  2239. <member name="M:MailKit.Net.Imap.IImapClient.EnableUTF8Async(System.Threading.CancellationToken)">
  2240. <summary>
  2241. Asynchronously enable the UTF8=ACCEPT extension.
  2242. </summary>
  2243. <remarks>
  2244. Enables the <a href="https://tools.ietf.org/html/rfc6855">UTF8=ACCEPT</a> extension.
  2245. </remarks>
  2246. <returns>An asynchronous task context.</returns>
  2247. <param name="cancellationToken">The cancellation token.</param>
  2248. <exception cref="T:System.ObjectDisposedException">
  2249. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  2250. </exception>
  2251. <exception cref="T:MailKit.ServiceNotConnectedException">
  2252. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  2253. </exception>
  2254. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  2255. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  2256. </exception>
  2257. <exception cref="T:System.InvalidOperationException">
  2258. UTF8=ACCEPT needs to be enabled before selecting a folder.
  2259. </exception>
  2260. <exception cref="T:System.NotSupportedException">
  2261. The IMAP server does not support the UTF8=ACCEPT extension.
  2262. </exception>
  2263. <exception cref="T:System.OperationCanceledException">
  2264. The operation was canceled via the cancellation token.
  2265. </exception>
  2266. <exception cref="T:System.IO.IOException">
  2267. An I/O error occurred.
  2268. </exception>
  2269. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  2270. The server replied to the ENABLE command with a NO or BAD response.
  2271. </exception>
  2272. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  2273. An IMAP protocol error occurred.
  2274. </exception>
  2275. </member>
  2276. <member name="M:MailKit.Net.Imap.IImapClient.Identify(MailKit.Net.Imap.ImapImplementation,System.Threading.CancellationToken)">
  2277. <summary>
  2278. Identify the client implementation to the server and obtain the server implementation details.
  2279. </summary>
  2280. <remarks>
  2281. <para>Passes along the client implementation details to the server while also obtaining implementation
  2282. details from the server.</para>
  2283. <para>If the <paramref name="clientImplementation"/> is <c>null</c> or no properties have been set, no
  2284. identifying information will be sent to the server.</para>
  2285. <note type="security">
  2286. <para>Security Implications</para>
  2287. <para>This command has the danger of violating the privacy of users if misused. Clients should
  2288. notify users that they send the ID command.</para>
  2289. <para>It is highly desirable that implementations provide a method of disabling ID support, perhaps by
  2290. not calling this method at all, or by passing <c>null</c> as the <paramref name="clientImplementation"/>
  2291. argument.</para>
  2292. <para>Implementors must exercise extreme care in adding properties to the <paramref name="clientImplementation"/>.
  2293. Some properties, such as a processor ID number, Ethernet address, or other unique (or mostly unique) identifier
  2294. would allow tracking of users in ways that violate user privacy expectations and may also make it easier for
  2295. attackers to exploit security holes in the client.</para>
  2296. </note>
  2297. </remarks>
  2298. <example>
  2299. <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
  2300. </example>
  2301. <returns>The implementation details of the server if available; otherwise, <c>null</c>.</returns>
  2302. <param name="clientImplementation">The client implementation.</param>
  2303. <param name="cancellationToken">The cancellation token.</param>
  2304. <exception cref="T:System.ObjectDisposedException">
  2305. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  2306. </exception>
  2307. <exception cref="T:MailKit.ServiceNotConnectedException">
  2308. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  2309. </exception>
  2310. <exception cref="T:System.NotSupportedException">
  2311. The IMAP server does not support the ID extension.
  2312. </exception>
  2313. <exception cref="T:System.OperationCanceledException">
  2314. The operation was canceled via the cancellation token.
  2315. </exception>
  2316. <exception cref="T:System.IO.IOException">
  2317. An I/O error occurred.
  2318. </exception>
  2319. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  2320. The server replied to the ID command with a NO or BAD response.
  2321. </exception>
  2322. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  2323. An IMAP protocol error occurred.
  2324. </exception>
  2325. </member>
  2326. <member name="M:MailKit.Net.Imap.IImapClient.IdentifyAsync(MailKit.Net.Imap.ImapImplementation,System.Threading.CancellationToken)">
  2327. <summary>
  2328. Asynchronously identify the client implementation to the server and obtain the server implementation details.
  2329. </summary>
  2330. <remarks>
  2331. <para>Passes along the client implementation details to the server while also obtaining implementation
  2332. details from the server.</para>
  2333. <para>If the <paramref name="clientImplementation"/> is <c>null</c> or no properties have been set, no
  2334. identifying information will be sent to the server.</para>
  2335. <note type="security">
  2336. <para>Security Implications</para>
  2337. <para>This command has the danger of violating the privacy of users if misused. Clients should
  2338. notify users that they send the ID command.</para>
  2339. <para>It is highly desirable that implementations provide a method of disabling ID support, perhaps by
  2340. not calling this method at all, or by passing <c>null</c> as the <paramref name="clientImplementation"/>
  2341. argument.</para>
  2342. <para>Implementors must exercise extreme care in adding properties to the <paramref name="clientImplementation"/>.
  2343. Some properties, such as a processor ID number, Ethernet address, or other unique (or mostly unique) identifier
  2344. would allow tracking of users in ways that violate user privacy expectations and may also make it easier for
  2345. attackers to exploit security holes in the client.</para>
  2346. </note>
  2347. </remarks>
  2348. <returns>The implementation details of the server if available; otherwise, <c>null</c>.</returns>
  2349. <param name="clientImplementation">The client implementation.</param>
  2350. <param name="cancellationToken">The cancellation token.</param>
  2351. <exception cref="T:System.ObjectDisposedException">
  2352. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  2353. </exception>
  2354. <exception cref="T:MailKit.ServiceNotConnectedException">
  2355. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  2356. </exception>
  2357. <exception cref="T:System.NotSupportedException">
  2358. The IMAP server does not support the ID extension.
  2359. </exception>
  2360. <exception cref="T:System.OperationCanceledException">
  2361. The operation was canceled via the cancellation token.
  2362. </exception>
  2363. <exception cref="T:System.IO.IOException">
  2364. An I/O error occurred.
  2365. </exception>
  2366. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  2367. The server replied to the ID command with a NO or BAD response.
  2368. </exception>
  2369. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  2370. An IMAP protocol error occurred.
  2371. </exception>
  2372. </member>
  2373. <member name="M:MailKit.Net.Imap.IImapClient.Idle(System.Threading.CancellationToken,System.Threading.CancellationToken)">
  2374. <summary>
  2375. Toggle the <see cref="T:MailKit.Net.Imap.ImapClient"/> into the IDLE state.
  2376. </summary>
  2377. <remarks>
  2378. <para>When a client enters the IDLE state, the IMAP server will send
  2379. events to the client as they occur on the selected folder. These events
  2380. may include notifications of new messages arriving, expunge notifications,
  2381. flag changes, etc.</para>
  2382. <para>Due to the nature of the IDLE command, a folder must be selected
  2383. before a client can enter into the IDLE state. This can be done by
  2384. opening a folder using
  2385. <see cref="M:MailKit.MailFolder.Open(MailKit.FolderAccess,System.Threading.CancellationToken)"/>
  2386. or any of the other variants.</para>
  2387. <para>While the IDLE command is running, no other commands may be issued until the
  2388. <paramref name="doneToken"/> is cancelled.</para>
  2389. <note type="note">It is especially important to cancel the <paramref name="doneToken"/>
  2390. before cancelling the <paramref name="cancellationToken"/> when using SSL or TLS due to
  2391. the fact that <see cref="T:System.Net.Security.SslStream"/> cannot be polled.</note>
  2392. </remarks>
  2393. <example>
  2394. <code language="c#" source="Examples\ImapIdleExample.cs"/>
  2395. </example>
  2396. <param name="doneToken">The cancellation token used to return to the non-idle state.</param>
  2397. <param name="cancellationToken">The cancellation token.</param>
  2398. <exception cref="T:System.ArgumentException">
  2399. <paramref name="doneToken"/> must be cancellable (i.e. <see cref="P:System.Threading.CancellationToken.None"/> cannot be used).
  2400. </exception>
  2401. <exception cref="T:System.ObjectDisposedException">
  2402. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  2403. </exception>
  2404. <exception cref="T:MailKit.ServiceNotConnectedException">
  2405. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  2406. </exception>
  2407. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  2408. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  2409. </exception>
  2410. <exception cref="T:System.InvalidOperationException">
  2411. A <see cref="T:MailKit.Net.Imap.ImapFolder"/> has not been opened.
  2412. </exception>
  2413. <exception cref="T:System.NotSupportedException">
  2414. The IMAP server does not support the IDLE extension.
  2415. </exception>
  2416. <exception cref="T:System.OperationCanceledException">
  2417. The operation was canceled via the cancellation token.
  2418. </exception>
  2419. <exception cref="T:System.IO.IOException">
  2420. An I/O error occurred.
  2421. </exception>
  2422. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  2423. The server replied to the IDLE command with a NO or BAD response.
  2424. </exception>
  2425. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  2426. The server responded with an unexpected token.
  2427. </exception>
  2428. </member>
  2429. <member name="M:MailKit.Net.Imap.IImapClient.IdleAsync(System.Threading.CancellationToken,System.Threading.CancellationToken)">
  2430. <summary>
  2431. Asynchronously toggle the <see cref="T:MailKit.Net.Imap.ImapClient"/> into the IDLE state.
  2432. </summary>
  2433. <remarks>
  2434. <para>When a client enters the IDLE state, the IMAP server will send
  2435. events to the client as they occur on the selected folder. These events
  2436. may include notifications of new messages arriving, expunge notifications,
  2437. flag changes, etc.</para>
  2438. <para>Due to the nature of the IDLE command, a folder must be selected
  2439. before a client can enter into the IDLE state. This can be done by
  2440. opening a folder using
  2441. <see cref="M:MailKit.MailFolder.Open(MailKit.FolderAccess,System.Threading.CancellationToken)"/>
  2442. or any of the other variants.</para>
  2443. <para>While the IDLE command is running, no other commands may be issued until the
  2444. <paramref name="doneToken"/> is cancelled.</para>
  2445. <note type="note">It is especially important to cancel the <paramref name="doneToken"/>
  2446. before cancelling the <paramref name="cancellationToken"/> when using SSL or TLS due to
  2447. the fact that <see cref="T:System.Net.Security.SslStream"/> cannot be polled.</note>
  2448. </remarks>
  2449. <returns>An asynchronous task context.</returns>
  2450. <param name="doneToken">The cancellation token used to return to the non-idle state.</param>
  2451. <param name="cancellationToken">The cancellation token.</param>
  2452. <exception cref="T:System.ArgumentException">
  2453. <paramref name="doneToken"/> must be cancellable (i.e. <see cref="P:System.Threading.CancellationToken.None"/> cannot be used).
  2454. </exception>
  2455. <exception cref="T:System.ObjectDisposedException">
  2456. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  2457. </exception>
  2458. <exception cref="T:MailKit.ServiceNotConnectedException">
  2459. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  2460. </exception>
  2461. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  2462. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  2463. </exception>
  2464. <exception cref="T:System.InvalidOperationException">
  2465. A <see cref="T:MailKit.Net.Imap.ImapFolder"/> has not been opened.
  2466. </exception>
  2467. <exception cref="T:System.NotSupportedException">
  2468. The IMAP server does not support the IDLE extension.
  2469. </exception>
  2470. <exception cref="T:System.OperationCanceledException">
  2471. The operation was canceled via the cancellation token.
  2472. </exception>
  2473. <exception cref="T:System.IO.IOException">
  2474. An I/O error occurred.
  2475. </exception>
  2476. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  2477. The server replied to the IDLE command with a NO or BAD response.
  2478. </exception>
  2479. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  2480. The server responded with an unexpected token.
  2481. </exception>
  2482. </member>
  2483. <member name="M:MailKit.Net.Imap.IImapClient.Notify(System.Boolean,System.Collections.Generic.IList{MailKit.Net.Imap.ImapEventGroup},System.Threading.CancellationToken)">
  2484. <summary>
  2485. Request the specified notification events from the IMAP server.
  2486. </summary>
  2487. <remarks>
  2488. <para>The <a href="https://tools.ietf.org/html/rfc5465">NOTIFY</a> command is used to expand
  2489. which notifications the client wishes to be notified about, including status notifications
  2490. about folders other than the currently selected folder. It can also be used to automatically
  2491. FETCH information about new messages that have arrived in the currently selected folder.</para>
  2492. <para>This, combined with <see cref="M:MailKit.Net.Imap.IImapClient.Idle(System.Threading.CancellationToken,System.Threading.CancellationToken)"/>,
  2493. can be used to get instant notifications for changes to any of the specified folders.</para>
  2494. </remarks>
  2495. <param name="status"><c>true</c> if the server should immediately notify the client of the
  2496. selected folder's status; otherwise, <c>false</c>.</param>
  2497. <param name="eventGroups">The specific event groups that the client would like to receive notifications for.</param>
  2498. <param name="cancellationToken">The cancellation token.</param>
  2499. <exception cref="T:System.ArgumentNullException">
  2500. <paramref name="eventGroups"/> is <c>null</c>.
  2501. </exception>
  2502. <exception cref="T:System.ArgumentException">
  2503. <paramref name="eventGroups"/> is empty.
  2504. </exception>
  2505. <exception cref="T:System.ObjectDisposedException">
  2506. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  2507. </exception>
  2508. <exception cref="T:MailKit.ServiceNotConnectedException">
  2509. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  2510. </exception>
  2511. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  2512. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  2513. </exception>
  2514. <exception cref="T:System.InvalidOperationException">
  2515. One or more <see cref="T:MailKit.Net.Imap.ImapEventGroup"/> is invalid.
  2516. </exception>
  2517. <exception cref="T:System.NotSupportedException">
  2518. The IMAP server does not support the NOTIFY extension.
  2519. </exception>
  2520. <exception cref="T:System.OperationCanceledException">
  2521. The operation was canceled via the cancellation token.
  2522. </exception>
  2523. <exception cref="T:System.IO.IOException">
  2524. An I/O error occurred.
  2525. </exception>
  2526. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  2527. The server replied to the NOTIFY command with a NO or BAD response.
  2528. </exception>
  2529. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  2530. The server responded with an unexpected token.
  2531. </exception>
  2532. </member>
  2533. <member name="M:MailKit.Net.Imap.IImapClient.NotifyAsync(System.Boolean,System.Collections.Generic.IList{MailKit.Net.Imap.ImapEventGroup},System.Threading.CancellationToken)">
  2534. <summary>
  2535. Asynchronously request the specified notification events from the IMAP server.
  2536. </summary>
  2537. <remarks>
  2538. <para>The <a href="https://tools.ietf.org/html/rfc5465">NOTIFY</a> command is used to expand
  2539. which notifications the client wishes to be notified about, including status notifications
  2540. about folders other than the currently selected folder. It can also be used to automatically
  2541. FETCH information about new messages that have arrived in the currently selected folder.</para>
  2542. <para>This, combined with <see cref="M:MailKit.Net.Imap.IImapClient.IdleAsync(System.Threading.CancellationToken,System.Threading.CancellationToken)"/>,
  2543. can be used to get instant notifications for changes to any of the specified folders.</para>
  2544. </remarks>
  2545. <returns>An asynchronous task context.</returns>
  2546. <param name="status"><c>true</c> if the server should immediately notify the client of the
  2547. selected folder's status; otherwise, <c>false</c>.</param>
  2548. <param name="eventGroups">The specific event groups that the client would like to receive notifications for.</param>
  2549. <param name="cancellationToken">The cancellation token.</param>
  2550. <exception cref="T:System.ArgumentNullException">
  2551. <paramref name="eventGroups"/> is <c>null</c>.
  2552. </exception>
  2553. <exception cref="T:System.ArgumentException">
  2554. <paramref name="eventGroups"/> is empty.
  2555. </exception>
  2556. <exception cref="T:System.ObjectDisposedException">
  2557. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  2558. </exception>
  2559. <exception cref="T:MailKit.ServiceNotConnectedException">
  2560. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  2561. </exception>
  2562. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  2563. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  2564. </exception>
  2565. <exception cref="T:System.InvalidOperationException">
  2566. One or more <see cref="T:MailKit.Net.Imap.ImapEventGroup"/> is invalid.
  2567. </exception>
  2568. <exception cref="T:System.NotSupportedException">
  2569. The IMAP server does not support the NOTIFY extension.
  2570. </exception>
  2571. <exception cref="T:System.OperationCanceledException">
  2572. The operation was canceled via the cancellation token.
  2573. </exception>
  2574. <exception cref="T:System.IO.IOException">
  2575. An I/O error occurred.
  2576. </exception>
  2577. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  2578. The server replied to the NOTIFY command with a NO or BAD response.
  2579. </exception>
  2580. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  2581. The server responded with an unexpected token.
  2582. </exception>
  2583. </member>
  2584. <member name="M:MailKit.Net.Imap.IImapClient.DisableNotify(System.Threading.CancellationToken)">
  2585. <summary>
  2586. Disable any previously requested notification events from the IMAP server.
  2587. </summary>
  2588. <remarks>
  2589. Disables any notification events requested in a prior call to
  2590. <see cref="M:MailKit.Net.Imap.IImapClient.Notify(System.Boolean,System.Collections.Generic.IList{MailKit.Net.Imap.ImapEventGroup},System.Threading.CancellationToken)"/>.
  2591. request.
  2592. </remarks>
  2593. <param name="cancellationToken">The cancellation token.</param>
  2594. <exception cref="T:System.ObjectDisposedException">
  2595. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  2596. </exception>
  2597. <exception cref="T:MailKit.ServiceNotConnectedException">
  2598. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  2599. </exception>
  2600. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  2601. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  2602. </exception>
  2603. <exception cref="T:System.NotSupportedException">
  2604. The IMAP server does not support the NOTIFY extension.
  2605. </exception>
  2606. <exception cref="T:System.OperationCanceledException">
  2607. The operation was canceled via the cancellation token.
  2608. </exception>
  2609. <exception cref="T:System.IO.IOException">
  2610. An I/O error occurred.
  2611. </exception>
  2612. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  2613. The server replied to the NOTIFY command with a NO or BAD response.
  2614. </exception>
  2615. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  2616. The server responded with an unexpected token.
  2617. </exception>
  2618. </member>
  2619. <member name="M:MailKit.Net.Imap.IImapClient.DisableNotifyAsync(System.Threading.CancellationToken)">
  2620. <summary>
  2621. Asynchronously disable any previously requested notification events from the IMAP server.
  2622. </summary>
  2623. <remarks>
  2624. Disables any notification events requested in a prior call to
  2625. <see cref="M:MailKit.Net.Imap.IImapClient.NotifyAsync(System.Boolean,System.Collections.Generic.IList{MailKit.Net.Imap.ImapEventGroup},System.Threading.CancellationToken)"/>.
  2626. request.
  2627. </remarks>
  2628. <returns>An asynchronous task context.</returns>
  2629. <param name="cancellationToken">The cancellation token.</param>
  2630. <exception cref="T:System.ObjectDisposedException">
  2631. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  2632. </exception>
  2633. <exception cref="T:MailKit.ServiceNotConnectedException">
  2634. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  2635. </exception>
  2636. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  2637. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  2638. </exception>
  2639. <exception cref="T:System.NotSupportedException">
  2640. The IMAP server does not support the NOTIFY extension.
  2641. </exception>
  2642. <exception cref="T:System.OperationCanceledException">
  2643. The operation was canceled via the cancellation token.
  2644. </exception>
  2645. <exception cref="T:System.IO.IOException">
  2646. An I/O error occurred.
  2647. </exception>
  2648. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  2649. The server replied to the NOTIFY command with a NO or BAD response.
  2650. </exception>
  2651. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  2652. The server responded with an unexpected token.
  2653. </exception>
  2654. </member>
  2655. <member name="T:MailKit.Net.Imap.IImapFolder">
  2656. <summary>
  2657. An interface for an IMAP folder.
  2658. </summary>
  2659. <remarks>
  2660. Implemented by <see cref="T:MailKit.Net.Imap.ImapFolder"/>.
  2661. </remarks>
  2662. <example>
  2663. <code language="c#" source="Examples\ImapExamples.cs" region="DownloadMessages"/>
  2664. </example>
  2665. <example>
  2666. <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
  2667. </example>
  2668. </member>
  2669. <member name="M:MailKit.Net.Imap.IImapFolder.GetHeaders(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  2670. <summary>
  2671. Get the specified body part headers.
  2672. </summary>
  2673. <remarks>
  2674. Gets the specified body part headers.
  2675. </remarks>
  2676. <returns>The body part headers.</returns>
  2677. <param name="uid">The UID of the message.</param>
  2678. <param name="partSpecifier">The body part specifier.</param>
  2679. <param name="cancellationToken">The cancellation token.</param>
  2680. <param name="progress">The progress reporting mechanism.</param>
  2681. <exception cref="T:System.ArgumentNullException">
  2682. <paramref name="partSpecifier"/> is <c>null</c>.
  2683. </exception>
  2684. <exception cref="T:System.ArgumentException">
  2685. <paramref name="uid"/> is invalid.
  2686. </exception>
  2687. <exception cref="T:System.ObjectDisposedException">
  2688. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  2689. </exception>
  2690. <exception cref="T:MailKit.ServiceNotConnectedException">
  2691. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  2692. </exception>
  2693. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  2694. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  2695. </exception>
  2696. <exception cref="T:MailKit.FolderNotOpenException">
  2697. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  2698. </exception>
  2699. <exception cref="T:MailKit.MessageNotFoundException">
  2700. The IMAP server did not return the requested body part headers.
  2701. </exception>
  2702. <exception cref="T:System.OperationCanceledException">
  2703. The operation was canceled via the cancellation token.
  2704. </exception>
  2705. <exception cref="T:System.IO.IOException">
  2706. An I/O error occurred.
  2707. </exception>
  2708. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  2709. The server's response contained unexpected tokens.
  2710. </exception>
  2711. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  2712. The server replied with a NO or BAD response.
  2713. </exception>
  2714. </member>
  2715. <member name="M:MailKit.Net.Imap.IImapFolder.GetHeadersAsync(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  2716. <summary>
  2717. Asynchronously get the specified body part headers.
  2718. </summary>
  2719. <remarks>
  2720. Gets the specified body part headers.
  2721. </remarks>
  2722. <returns>The body part headers.</returns>
  2723. <param name="uid">The UID of the message.</param>
  2724. <param name="partSpecifier">The body part specifier.</param>
  2725. <param name="cancellationToken">The cancellation token.</param>
  2726. <param name="progress">The progress reporting mechanism.</param>
  2727. <exception cref="T:System.ArgumentNullException">
  2728. <paramref name="partSpecifier"/> is <c>null</c>.
  2729. </exception>
  2730. <exception cref="T:System.ArgumentException">
  2731. <paramref name="uid"/> is invalid.
  2732. </exception>
  2733. <exception cref="T:System.ObjectDisposedException">
  2734. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  2735. </exception>
  2736. <exception cref="T:MailKit.ServiceNotConnectedException">
  2737. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  2738. </exception>
  2739. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  2740. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  2741. </exception>
  2742. <exception cref="T:MailKit.FolderNotOpenException">
  2743. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  2744. </exception>
  2745. <exception cref="T:MailKit.MessageNotFoundException">
  2746. The IMAP server did not return the requested body part headers.
  2747. </exception>
  2748. <exception cref="T:System.OperationCanceledException">
  2749. The operation was canceled via the cancellation token.
  2750. </exception>
  2751. <exception cref="T:System.IO.IOException">
  2752. An I/O error occurred.
  2753. </exception>
  2754. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  2755. The server's response contained unexpected tokens.
  2756. </exception>
  2757. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  2758. The server replied with a NO or BAD response.
  2759. </exception>
  2760. </member>
  2761. <member name="M:MailKit.Net.Imap.IImapFolder.GetHeaders(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  2762. <summary>
  2763. Get the specified body part headers.
  2764. </summary>
  2765. <remarks>
  2766. Gets the specified body part headers.
  2767. </remarks>
  2768. <returns>The body part headers.</returns>
  2769. <param name="index">The index of the message.</param>
  2770. <param name="partSpecifier">The body part specifier.</param>
  2771. <param name="cancellationToken">The cancellation token.</param>
  2772. <param name="progress">The progress reporting mechanism.</param>
  2773. <exception cref="T:System.ArgumentOutOfRangeException">
  2774. <paramref name="index"/> is out of range.
  2775. </exception>
  2776. <exception cref="T:System.ArgumentNullException">
  2777. <paramref name="partSpecifier"/> is <c>null</c>.
  2778. </exception>
  2779. <exception cref="T:System.ObjectDisposedException">
  2780. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  2781. </exception>
  2782. <exception cref="T:MailKit.ServiceNotConnectedException">
  2783. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  2784. </exception>
  2785. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  2786. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  2787. </exception>
  2788. <exception cref="T:MailKit.FolderNotOpenException">
  2789. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  2790. </exception>
  2791. <exception cref="T:MailKit.MessageNotFoundException">
  2792. The IMAP server did not return the requested body part headers.
  2793. </exception>
  2794. <exception cref="T:System.OperationCanceledException">
  2795. The operation was canceled via the cancellation token.
  2796. </exception>
  2797. <exception cref="T:System.IO.IOException">
  2798. An I/O error occurred.
  2799. </exception>
  2800. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  2801. The server's response contained unexpected tokens.
  2802. </exception>
  2803. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  2804. The server replied with a NO or BAD response.
  2805. </exception>
  2806. </member>
  2807. <member name="M:MailKit.Net.Imap.IImapFolder.GetHeadersAsync(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  2808. <summary>
  2809. Asynchronously get the specified body part headers.
  2810. </summary>
  2811. <remarks>
  2812. Gets the specified body part headers.
  2813. </remarks>
  2814. <returns>The body part headers.</returns>
  2815. <param name="index">The index of the message.</param>
  2816. <param name="partSpecifier">The body part specifier.</param>
  2817. <param name="cancellationToken">The cancellation token.</param>
  2818. <param name="progress">The progress reporting mechanism.</param>
  2819. <exception cref="T:System.ArgumentOutOfRangeException">
  2820. <paramref name="index"/> is out of range.
  2821. </exception>
  2822. <exception cref="T:System.ArgumentNullException">
  2823. <paramref name="partSpecifier"/> is <c>null</c>.
  2824. </exception>
  2825. <exception cref="T:System.ObjectDisposedException">
  2826. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  2827. </exception>
  2828. <exception cref="T:MailKit.ServiceNotConnectedException">
  2829. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  2830. </exception>
  2831. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  2832. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  2833. </exception>
  2834. <exception cref="T:MailKit.FolderNotOpenException">
  2835. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  2836. </exception>
  2837. <exception cref="T:MailKit.MessageNotFoundException">
  2838. The IMAP server did not return the requested body part headers.
  2839. </exception>
  2840. <exception cref="T:System.OperationCanceledException">
  2841. The operation was canceled via the cancellation token.
  2842. </exception>
  2843. <exception cref="T:System.IO.IOException">
  2844. An I/O error occurred.
  2845. </exception>
  2846. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  2847. The server's response contained unexpected tokens.
  2848. </exception>
  2849. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  2850. The server replied with a NO or BAD response.
  2851. </exception>
  2852. </member>
  2853. <member name="M:MailKit.Net.Imap.IImapFolder.GetBodyPart(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  2854. <summary>
  2855. Get the specified body part.
  2856. </summary>
  2857. <remarks>
  2858. Gets the specified body part.
  2859. </remarks>
  2860. <returns>The body part.</returns>
  2861. <param name="uid">The UID of the message.</param>
  2862. <param name="partSpecifier">The body part specifier.</param>
  2863. <param name="cancellationToken">The cancellation token.</param>
  2864. <param name="progress">The progress reporting mechanism.</param>
  2865. <exception cref="T:System.ArgumentNullException">
  2866. <paramref name="partSpecifier"/> is <c>null</c>.
  2867. </exception>
  2868. <exception cref="T:System.ArgumentException">
  2869. <paramref name="uid"/> is invalid.
  2870. </exception>
  2871. <exception cref="T:System.ObjectDisposedException">
  2872. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  2873. </exception>
  2874. <exception cref="T:MailKit.ServiceNotConnectedException">
  2875. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  2876. </exception>
  2877. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  2878. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  2879. </exception>
  2880. <exception cref="T:MailKit.FolderNotOpenException">
  2881. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  2882. </exception>
  2883. <exception cref="T:MailKit.MessageNotFoundException">
  2884. The IMAP server did not return the requested message body.
  2885. </exception>
  2886. <exception cref="T:System.OperationCanceledException">
  2887. The operation was canceled via the cancellation token.
  2888. </exception>
  2889. <exception cref="T:System.IO.IOException">
  2890. An I/O error occurred.
  2891. </exception>
  2892. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  2893. The server's response contained unexpected tokens.
  2894. </exception>
  2895. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  2896. The server replied with a NO or BAD response.
  2897. </exception>
  2898. </member>
  2899. <member name="M:MailKit.Net.Imap.IImapFolder.GetBodyPartAsync(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  2900. <summary>
  2901. Asynchronously get the specified body part.
  2902. </summary>
  2903. <remarks>
  2904. Gets the specified body part.
  2905. </remarks>
  2906. <returns>The body part.</returns>
  2907. <param name="uid">The UID of the message.</param>
  2908. <param name="partSpecifier">The body part specifier.</param>
  2909. <param name="cancellationToken">The cancellation token.</param>
  2910. <param name="progress">The progress reporting mechanism.</param>
  2911. <exception cref="T:System.ArgumentNullException">
  2912. <paramref name="partSpecifier"/> is <c>null</c>.
  2913. </exception>
  2914. <exception cref="T:System.ArgumentException">
  2915. <paramref name="uid"/> is invalid.
  2916. </exception>
  2917. <exception cref="T:System.ObjectDisposedException">
  2918. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  2919. </exception>
  2920. <exception cref="T:MailKit.ServiceNotConnectedException">
  2921. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  2922. </exception>
  2923. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  2924. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  2925. </exception>
  2926. <exception cref="T:MailKit.FolderNotOpenException">
  2927. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  2928. </exception>
  2929. <exception cref="T:MailKit.MessageNotFoundException">
  2930. The IMAP server did not return the requested message body.
  2931. </exception>
  2932. <exception cref="T:System.OperationCanceledException">
  2933. The operation was canceled via the cancellation token.
  2934. </exception>
  2935. <exception cref="T:System.IO.IOException">
  2936. An I/O error occurred.
  2937. </exception>
  2938. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  2939. The server's response contained unexpected tokens.
  2940. </exception>
  2941. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  2942. The server replied with a NO or BAD response.
  2943. </exception>
  2944. </member>
  2945. <member name="M:MailKit.Net.Imap.IImapFolder.GetBodyPart(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  2946. <summary>
  2947. Get the specified body part.
  2948. </summary>
  2949. <remarks>
  2950. Gets the specified body part.
  2951. </remarks>
  2952. <returns>The body part.</returns>
  2953. <param name="index">The index of the message.</param>
  2954. <param name="partSpecifier">The body part specifier.</param>
  2955. <param name="cancellationToken">The cancellation token.</param>
  2956. <param name="progress">The progress reporting mechanism.</param>
  2957. <exception cref="T:System.ArgumentNullException">
  2958. <paramref name="partSpecifier"/> is <c>null</c>.
  2959. </exception>
  2960. <exception cref="T:System.ArgumentOutOfRangeException">
  2961. <paramref name="index"/> is out of range.
  2962. </exception>
  2963. <exception cref="T:System.ObjectDisposedException">
  2964. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  2965. </exception>
  2966. <exception cref="T:MailKit.ServiceNotConnectedException">
  2967. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  2968. </exception>
  2969. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  2970. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  2971. </exception>
  2972. <exception cref="T:MailKit.FolderNotOpenException">
  2973. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  2974. </exception>
  2975. <exception cref="T:MailKit.MessageNotFoundException">
  2976. The IMAP server did not return the requested message.
  2977. </exception>
  2978. <exception cref="T:System.OperationCanceledException">
  2979. The operation was canceled via the cancellation token.
  2980. </exception>
  2981. <exception cref="T:System.IO.IOException">
  2982. An I/O error occurred.
  2983. </exception>
  2984. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  2985. The server's response contained unexpected tokens.
  2986. </exception>
  2987. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  2988. The server replied with a NO or BAD response.
  2989. </exception>
  2990. </member>
  2991. <member name="M:MailKit.Net.Imap.IImapFolder.GetBodyPartAsync(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  2992. <summary>
  2993. Asynchronously get the specified body part.
  2994. </summary>
  2995. <remarks>
  2996. Gets the specified body part.
  2997. </remarks>
  2998. <returns>The body part.</returns>
  2999. <param name="index">The index of the message.</param>
  3000. <param name="partSpecifier">The body part specifier.</param>
  3001. <param name="cancellationToken">The cancellation token.</param>
  3002. <param name="progress">The progress reporting mechanism.</param>
  3003. <exception cref="T:System.ArgumentNullException">
  3004. <paramref name="partSpecifier"/> is <c>null</c>.
  3005. </exception>
  3006. <exception cref="T:System.ArgumentOutOfRangeException">
  3007. <paramref name="index"/> is out of range.
  3008. </exception>
  3009. <exception cref="T:System.ObjectDisposedException">
  3010. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  3011. </exception>
  3012. <exception cref="T:MailKit.ServiceNotConnectedException">
  3013. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  3014. </exception>
  3015. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  3016. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  3017. </exception>
  3018. <exception cref="T:MailKit.FolderNotOpenException">
  3019. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  3020. </exception>
  3021. <exception cref="T:MailKit.MessageNotFoundException">
  3022. The IMAP server did not return the requested message.
  3023. </exception>
  3024. <exception cref="T:System.OperationCanceledException">
  3025. The operation was canceled via the cancellation token.
  3026. </exception>
  3027. <exception cref="T:System.IO.IOException">
  3028. An I/O error occurred.
  3029. </exception>
  3030. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  3031. The server's response contained unexpected tokens.
  3032. </exception>
  3033. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  3034. The server replied with a NO or BAD response.
  3035. </exception>
  3036. </member>
  3037. <member name="M:MailKit.Net.Imap.IImapFolder.GetStreams(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Net.Imap.ImapFetchStreamCallback,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  3038. <summary>
  3039. Get the streams for the specified messages.
  3040. </summary>
  3041. <remarks>
  3042. <para>Gets the streams for the specified messages.</para>
  3043. </remarks>
  3044. <param name="uids">The uids of the messages.</param>
  3045. <param name="callback"></param>
  3046. <param name="cancellationToken">The cancellation token.</param>
  3047. <param name="progress">The progress reporting mechanism.</param>
  3048. <exception cref="T:System.ArgumentNullException">
  3049. <para><paramref name="uids"/> is <c>null</c>.</para>
  3050. <para>-or-</para>
  3051. <para><paramref name="callback"/> is <c>null</c>.</para>
  3052. </exception>
  3053. <exception cref="T:System.ArgumentException">
  3054. One or more of the <paramref name="uids"/> is invalid.
  3055. </exception>
  3056. <exception cref="T:System.ObjectDisposedException">
  3057. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  3058. </exception>
  3059. <exception cref="T:MailKit.ServiceNotConnectedException">
  3060. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  3061. </exception>
  3062. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  3063. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  3064. </exception>
  3065. <exception cref="T:MailKit.FolderNotOpenException">
  3066. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  3067. </exception>
  3068. <exception cref="T:System.OperationCanceledException">
  3069. The operation was canceled via the cancellation token.
  3070. </exception>
  3071. <exception cref="T:System.IO.IOException">
  3072. An I/O error occurred.
  3073. </exception>
  3074. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  3075. The server's response contained unexpected tokens.
  3076. </exception>
  3077. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  3078. The server replied with a NO or BAD response.
  3079. </exception>
  3080. </member>
  3081. <member name="M:MailKit.Net.Imap.IImapFolder.GetStreamsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Net.Imap.ImapFetchStreamAsyncCallback,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  3082. <summary>
  3083. Asynchronously get the streams for the specified messages.
  3084. </summary>
  3085. <remarks>
  3086. <para>Asynchronously gets the streams for the specified messages.</para>
  3087. </remarks>
  3088. <returns>An awaitable task.</returns>
  3089. <param name="uids">The uids of the messages.</param>
  3090. <param name="callback"></param>
  3091. <param name="cancellationToken">The cancellation token.</param>
  3092. <param name="progress">The progress reporting mechanism.</param>
  3093. <exception cref="T:System.ArgumentNullException">
  3094. <para><paramref name="uids"/> is <c>null</c>.</para>
  3095. <para>-or-</para>
  3096. <para><paramref name="callback"/> is <c>null</c>.</para>
  3097. </exception>
  3098. <exception cref="T:System.ArgumentException">
  3099. One or more of the <paramref name="uids"/> is invalid.
  3100. </exception>
  3101. <exception cref="T:System.ObjectDisposedException">
  3102. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  3103. </exception>
  3104. <exception cref="T:MailKit.ServiceNotConnectedException">
  3105. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  3106. </exception>
  3107. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  3108. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  3109. </exception>
  3110. <exception cref="T:MailKit.FolderNotOpenException">
  3111. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  3112. </exception>
  3113. <exception cref="T:System.OperationCanceledException">
  3114. The operation was canceled via the cancellation token.
  3115. </exception>
  3116. <exception cref="T:System.IO.IOException">
  3117. An I/O error occurred.
  3118. </exception>
  3119. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  3120. The server's response contained unexpected tokens.
  3121. </exception>
  3122. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  3123. The server replied with a NO or BAD response.
  3124. </exception>
  3125. </member>
  3126. <member name="M:MailKit.Net.Imap.IImapFolder.GetStreams(System.Collections.Generic.IList{System.Int32},MailKit.Net.Imap.ImapFetchStreamCallback,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  3127. <summary>
  3128. Get the streams for the specified messages.
  3129. </summary>
  3130. <remarks>
  3131. <para>Gets the streams for the specified messages.</para>
  3132. </remarks>
  3133. <param name="indexes">The indexes of the messages.</param>
  3134. <param name="callback"></param>
  3135. <param name="cancellationToken">The cancellation token.</param>
  3136. <param name="progress">The progress reporting mechanism.</param>
  3137. <exception cref="T:System.ArgumentNullException">
  3138. <para><paramref name="indexes"/> is <c>null</c>.</para>
  3139. <para>-or-</para>
  3140. <para><paramref name="callback"/> is <c>null</c>.</para>
  3141. </exception>
  3142. <exception cref="T:System.ArgumentException">
  3143. One or more of the <paramref name="indexes"/> is invalid.
  3144. </exception>
  3145. <exception cref="T:System.ObjectDisposedException">
  3146. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  3147. </exception>
  3148. <exception cref="T:MailKit.ServiceNotConnectedException">
  3149. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  3150. </exception>
  3151. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  3152. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  3153. </exception>
  3154. <exception cref="T:MailKit.FolderNotOpenException">
  3155. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  3156. </exception>
  3157. <exception cref="T:System.OperationCanceledException">
  3158. The operation was canceled via the cancellation token.
  3159. </exception>
  3160. <exception cref="T:System.IO.IOException">
  3161. An I/O error occurred.
  3162. </exception>
  3163. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  3164. The server's response contained unexpected tokens.
  3165. </exception>
  3166. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  3167. The server replied with a NO or BAD response.
  3168. </exception>
  3169. </member>
  3170. <member name="M:MailKit.Net.Imap.IImapFolder.GetStreamsAsync(System.Collections.Generic.IList{System.Int32},MailKit.Net.Imap.ImapFetchStreamAsyncCallback,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  3171. <summary>
  3172. Asynchronously get the streams for the specified messages.
  3173. </summary>
  3174. <remarks>
  3175. <para>Asynchronously gets the streams for the specified messages.</para>
  3176. </remarks>
  3177. <returns>An awaitable task.</returns>
  3178. <param name="indexes">The indexes of the messages.</param>
  3179. <param name="callback"></param>
  3180. <param name="cancellationToken">The cancellation token.</param>
  3181. <param name="progress">The progress reporting mechanism.</param>
  3182. <exception cref="T:System.ArgumentNullException">
  3183. <para><paramref name="indexes"/> is <c>null</c>.</para>
  3184. <para>-or-</para>
  3185. <para><paramref name="callback"/> is <c>null</c>.</para>
  3186. </exception>
  3187. <exception cref="T:System.ArgumentException">
  3188. One or more of the <paramref name="indexes"/> is invalid.
  3189. </exception>
  3190. <exception cref="T:System.ObjectDisposedException">
  3191. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  3192. </exception>
  3193. <exception cref="T:MailKit.ServiceNotConnectedException">
  3194. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  3195. </exception>
  3196. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  3197. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  3198. </exception>
  3199. <exception cref="T:MailKit.FolderNotOpenException">
  3200. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  3201. </exception>
  3202. <exception cref="T:System.OperationCanceledException">
  3203. The operation was canceled via the cancellation token.
  3204. </exception>
  3205. <exception cref="T:System.IO.IOException">
  3206. An I/O error occurred.
  3207. </exception>
  3208. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  3209. The server's response contained unexpected tokens.
  3210. </exception>
  3211. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  3212. The server replied with a NO or BAD response.
  3213. </exception>
  3214. </member>
  3215. <member name="M:MailKit.Net.Imap.IImapFolder.GetStreams(System.Int32,System.Int32,MailKit.Net.Imap.ImapFetchStreamCallback,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  3216. <summary>
  3217. Get the streams for the specified messages.
  3218. </summary>
  3219. <remarks>
  3220. <para>Gets the streams for the specified messages.</para>
  3221. </remarks>
  3222. <param name="min">The minimum index.</param>
  3223. <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
  3224. <param name="callback"></param>
  3225. <param name="cancellationToken">The cancellation token.</param>
  3226. <param name="progress">The progress reporting mechanism.</param>
  3227. <exception cref="T:System.ArgumentOutOfRangeException">
  3228. <para><paramref name="min"/> is out of range.</para>
  3229. <para>-or-</para>
  3230. <para><paramref name="max"/> is out of range.</para>
  3231. </exception>
  3232. <exception cref="T:System.ArgumentNullException">
  3233. <paramref name="callback"/> is <c>null</c>.
  3234. </exception>
  3235. <exception cref="T:System.ObjectDisposedException">
  3236. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  3237. </exception>
  3238. <exception cref="T:MailKit.ServiceNotConnectedException">
  3239. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  3240. </exception>
  3241. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  3242. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  3243. </exception>
  3244. <exception cref="T:MailKit.FolderNotOpenException">
  3245. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  3246. </exception>
  3247. <exception cref="T:System.OperationCanceledException">
  3248. The operation was canceled via the cancellation token.
  3249. </exception>
  3250. <exception cref="T:System.IO.IOException">
  3251. An I/O error occurred.
  3252. </exception>
  3253. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  3254. The server's response contained unexpected tokens.
  3255. </exception>
  3256. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  3257. The server replied with a NO or BAD response.
  3258. </exception>
  3259. </member>
  3260. <member name="M:MailKit.Net.Imap.IImapFolder.GetStreamsAsync(System.Int32,System.Int32,MailKit.Net.Imap.ImapFetchStreamAsyncCallback,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  3261. <summary>
  3262. Asynchronously get the streams for the specified messages.
  3263. </summary>
  3264. <remarks>
  3265. <para>Asynchronously gets the streams for the specified messages.</para>
  3266. </remarks>
  3267. <returns>An awaitable task.</returns>
  3268. <param name="min">The minimum index.</param>
  3269. <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
  3270. <param name="callback"></param>
  3271. <param name="cancellationToken">The cancellation token.</param>
  3272. <param name="progress">The progress reporting mechanism.</param>
  3273. <exception cref="T:System.ArgumentOutOfRangeException">
  3274. <para><paramref name="min"/> is out of range.</para>
  3275. <para>-or-</para>
  3276. <para><paramref name="max"/> is out of range.</para>
  3277. </exception>
  3278. <exception cref="T:System.ArgumentNullException">
  3279. <paramref name="callback"/> is <c>null</c>.
  3280. </exception>
  3281. <exception cref="T:System.ObjectDisposedException">
  3282. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  3283. </exception>
  3284. <exception cref="T:MailKit.ServiceNotConnectedException">
  3285. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  3286. </exception>
  3287. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  3288. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  3289. </exception>
  3290. <exception cref="T:MailKit.FolderNotOpenException">
  3291. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  3292. </exception>
  3293. <exception cref="T:System.OperationCanceledException">
  3294. The operation was canceled via the cancellation token.
  3295. </exception>
  3296. <exception cref="T:System.IO.IOException">
  3297. An I/O error occurred.
  3298. </exception>
  3299. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  3300. The server's response contained unexpected tokens.
  3301. </exception>
  3302. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  3303. The server replied with a NO or BAD response.
  3304. </exception>
  3305. </member>
  3306. <member name="M:MailKit.Net.Imap.IImapFolder.Search(System.String,System.Threading.CancellationToken)">
  3307. <summary>
  3308. Search the folder for messages matching the specified query.
  3309. </summary>
  3310. <remarks>
  3311. Sends a <c>UID SEARCH</c> command with the specified query passed directly to the IMAP server
  3312. with no interpretation by MailKit. This means that the query may contain any arguments that a
  3313. <c>UID SEARCH</c> command is allowed to have according to the IMAP specifications and any
  3314. extensions that are supported, including <c>RETURN</c> parameters.
  3315. </remarks>
  3316. <returns>An array of matching UIDs.</returns>
  3317. <param name="query">The search query.</param>
  3318. <param name="cancellationToken">The cancellation token.</param>
  3319. <exception cref="T:System.ArgumentNullException">
  3320. <paramref name="query"/> is <c>null</c>.
  3321. </exception>
  3322. <exception cref="T:System.ArgumentException">
  3323. <paramref name="query"/> is an empty string.
  3324. </exception>
  3325. <exception cref="T:System.ObjectDisposedException">
  3326. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  3327. </exception>
  3328. <exception cref="T:MailKit.ServiceNotConnectedException">
  3329. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  3330. </exception>
  3331. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  3332. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  3333. </exception>
  3334. <exception cref="T:MailKit.FolderNotOpenException">
  3335. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  3336. </exception>
  3337. <exception cref="T:System.OperationCanceledException">
  3338. The operation was canceled via the cancellation token.
  3339. </exception>
  3340. <exception cref="T:System.IO.IOException">
  3341. An I/O error occurred.
  3342. </exception>
  3343. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  3344. The server's response contained unexpected tokens.
  3345. </exception>
  3346. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  3347. The server replied with a NO or BAD response.
  3348. </exception>
  3349. </member>
  3350. <member name="M:MailKit.Net.Imap.IImapFolder.SearchAsync(System.String,System.Threading.CancellationToken)">
  3351. <summary>
  3352. Asynchronously search the folder for messages matching the specified query.
  3353. </summary>
  3354. <remarks>
  3355. Sends a <c>UID SEARCH</c> command with the specified query passed directly to the IMAP server
  3356. with no interpretation by MailKit. This means that the query may contain any arguments that a
  3357. <c>UID SEARCH</c> command is allowed to have according to the IMAP specifications and any
  3358. extensions that are supported, including <c>RETURN</c> parameters.
  3359. </remarks>
  3360. <returns>An array of matching UIDs.</returns>
  3361. <param name="query">The search query.</param>
  3362. <param name="cancellationToken">The cancellation token.</param>
  3363. <exception cref="T:System.ArgumentNullException">
  3364. <paramref name="query"/> is <c>null</c>.
  3365. </exception>
  3366. <exception cref="T:System.ArgumentException">
  3367. <paramref name="query"/> is an empty string.
  3368. </exception>
  3369. <exception cref="T:System.ObjectDisposedException">
  3370. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  3371. </exception>
  3372. <exception cref="T:MailKit.ServiceNotConnectedException">
  3373. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  3374. </exception>
  3375. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  3376. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  3377. </exception>
  3378. <exception cref="T:MailKit.FolderNotOpenException">
  3379. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  3380. </exception>
  3381. <exception cref="T:System.OperationCanceledException">
  3382. The operation was canceled via the cancellation token.
  3383. </exception>
  3384. <exception cref="T:System.IO.IOException">
  3385. An I/O error occurred.
  3386. </exception>
  3387. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  3388. The server's response contained unexpected tokens.
  3389. </exception>
  3390. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  3391. The server replied with a NO or BAD response.
  3392. </exception>
  3393. </member>
  3394. <member name="M:MailKit.Net.Imap.IImapFolder.Sort(System.String,System.Threading.CancellationToken)">
  3395. <summary>
  3396. Sort messages matching the specified query.
  3397. </summary>
  3398. <remarks>
  3399. Sends a <c>UID SORT</c> command with the specified query passed directly to the IMAP server
  3400. with no interpretation by MailKit. This means that the query may contain any arguments that a
  3401. <c>UID SORT</c> command is allowed to have according to the IMAP specifications and any
  3402. extensions that are supported, including <c>RETURN</c> parameters.
  3403. </remarks>
  3404. <returns>An array of matching UIDs.</returns>
  3405. <param name="query">The search query.</param>
  3406. <param name="cancellationToken">The cancellation token.</param>
  3407. <exception cref="T:System.ArgumentNullException">
  3408. <paramref name="query"/> is <c>null</c>.
  3409. </exception>
  3410. <exception cref="T:System.ArgumentException">
  3411. <paramref name="query"/> is an empty string.
  3412. </exception>
  3413. <exception cref="T:System.NotSupportedException">
  3414. The IMAP server does not support the SORT extension.
  3415. </exception>
  3416. <exception cref="T:System.ObjectDisposedException">
  3417. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  3418. </exception>
  3419. <exception cref="T:MailKit.ServiceNotConnectedException">
  3420. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  3421. </exception>
  3422. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  3423. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  3424. </exception>
  3425. <exception cref="T:MailKit.FolderNotOpenException">
  3426. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  3427. </exception>
  3428. <exception cref="T:System.OperationCanceledException">
  3429. The operation was canceled via the cancellation token.
  3430. </exception>
  3431. <exception cref="T:System.IO.IOException">
  3432. An I/O error occurred.
  3433. </exception>
  3434. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  3435. The server's response contained unexpected tokens.
  3436. </exception>
  3437. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  3438. The server replied with a NO or BAD response.
  3439. </exception>
  3440. </member>
  3441. <member name="M:MailKit.Net.Imap.IImapFolder.SortAsync(System.String,System.Threading.CancellationToken)">
  3442. <summary>
  3443. Asynchronously sort messages matching the specified query.
  3444. </summary>
  3445. <remarks>
  3446. Sends a <c>UID SORT</c> command with the specified query passed directly to the IMAP server
  3447. with no interpretation by MailKit. This means that the query may contain any arguments that a
  3448. <c>UID SORT</c> command is allowed to have according to the IMAP specifications and any
  3449. extensions that are supported, including <c>RETURN</c> parameters.
  3450. </remarks>
  3451. <returns>An array of matching UIDs.</returns>
  3452. <param name="query">The search query.</param>
  3453. <param name="cancellationToken">The cancellation token.</param>
  3454. <exception cref="T:System.ArgumentNullException">
  3455. <paramref name="query"/> is <c>null</c>.
  3456. </exception>
  3457. <exception cref="T:System.ArgumentException">
  3458. <paramref name="query"/> is an empty string.
  3459. </exception>
  3460. <exception cref="T:System.NotSupportedException">
  3461. The IMAP server does not support the SORT extension.
  3462. </exception>
  3463. <exception cref="T:System.ObjectDisposedException">
  3464. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  3465. </exception>
  3466. <exception cref="T:MailKit.ServiceNotConnectedException">
  3467. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  3468. </exception>
  3469. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  3470. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  3471. </exception>
  3472. <exception cref="T:MailKit.FolderNotOpenException">
  3473. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  3474. </exception>
  3475. <exception cref="T:System.OperationCanceledException">
  3476. The operation was canceled via the cancellation token.
  3477. </exception>
  3478. <exception cref="T:System.IO.IOException">
  3479. An I/O error occurred.
  3480. </exception>
  3481. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  3482. The server's response contained unexpected tokens.
  3483. </exception>
  3484. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  3485. The server replied with a NO or BAD response.
  3486. </exception>
  3487. </member>
  3488. <member name="T:MailKit.Net.Imap.ImapFetchStreamCallback">
  3489. <summary>
  3490. A callback used when fetching message streams.
  3491. </summary>
  3492. <remarks>
  3493. <para>This callback is meant to be used with the various
  3494. <a href="Overload_MailKit_Net_Imap_ImapFolder_GetStreams.htm">GetStreams</a>
  3495. methods.</para>
  3496. <para>Once this callback returns, the stream argument will be disposed, so
  3497. it is important to consume the stream right away and not add it to a queue
  3498. for later processing.</para>
  3499. </remarks>
  3500. <param name="folder">The IMAP folder that the message belongs to.</param>
  3501. <param name="index">The index of the message in the folder.</param>
  3502. <param name="uid">The UID of the message in the folder.</param>
  3503. <param name="stream">The raw message (or part) stream.</param>
  3504. </member>
  3505. <member name="T:MailKit.Net.Imap.ImapFetchStreamAsyncCallback">
  3506. <summary>
  3507. An asynchronous callback used when fetching message streams.
  3508. </summary>
  3509. <remarks>
  3510. <para>This callback is meant to be used with the various
  3511. <a href="Overload_MailKit_Net_Imap_ImapFolder_GetStreamsAsync.htm">GetStreamsAsync</a>
  3512. methods.</para>
  3513. <para>Once this callback returns, the stream argument will be disposed, so
  3514. it is important to consume the stream right away and not add it to a queue
  3515. for later processing.</para>
  3516. </remarks>
  3517. <returns>An awaitable task context.</returns>
  3518. <param name="folder">The IMAP folder that the message belongs to.</param>
  3519. <param name="index">The index of the message in the folder.</param>
  3520. <param name="uid">The UID of the message in the folder.</param>
  3521. <param name="stream">The raw message (or part) stream.</param>
  3522. <param name="cancellationToken">The cancellation token.</param>
  3523. </member>
  3524. <member name="T:MailKit.Net.Imap.ImapCapabilities">
  3525. <summary>
  3526. Capabilities supported by an IMAP server.
  3527. </summary>
  3528. <remarks>
  3529. Capabilities are read as part of the response to the <c>CAPABILITY</c> command that
  3530. is issued during the connection and authentication phases of the
  3531. <see cref="T:MailKit.Net.Imap.ImapClient"/>.
  3532. </remarks>
  3533. <example>
  3534. <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
  3535. </example>
  3536. </member>
  3537. <member name="F:MailKit.Net.Imap.ImapCapabilities.None">
  3538. <summary>
  3539. The server does not support any additional extensions.
  3540. </summary>
  3541. </member>
  3542. <member name="F:MailKit.Net.Imap.ImapCapabilities.IMAP4">
  3543. <summary>
  3544. The server implements the core IMAP4 commands.
  3545. </summary>
  3546. </member>
  3547. <member name="F:MailKit.Net.Imap.ImapCapabilities.IMAP4rev1">
  3548. <summary>
  3549. The server implements the core IMAP4rev1 commands.
  3550. </summary>
  3551. </member>
  3552. <member name="F:MailKit.Net.Imap.ImapCapabilities.IMAP4rev2">
  3553. <summary>
  3554. The server implements the core IMAP4rev2 commands.
  3555. </summary>
  3556. </member>
  3557. <member name="F:MailKit.Net.Imap.ImapCapabilities.Status">
  3558. <summary>
  3559. The server supports the <c>STATUS</c> command.
  3560. </summary>
  3561. </member>
  3562. <member name="F:MailKit.Net.Imap.ImapCapabilities.Acl">
  3563. <summary>
  3564. The server supports the ACL extension defined in <a href="https://tools.ietf.org/html/rfc2086">rfc2086</a>
  3565. and <a href="https://tools.ietf.org/html/rfc4314">rfc4314</a>.
  3566. </summary>
  3567. </member>
  3568. <member name="F:MailKit.Net.Imap.ImapCapabilities.Quota">
  3569. <summary>
  3570. The server supports the <a href="https://tools.ietf.org/html/rfc2087">QUOTA</a> extension.
  3571. </summary>
  3572. </member>
  3573. <member name="F:MailKit.Net.Imap.ImapCapabilities.LiteralPlus">
  3574. <summary>
  3575. The server supports the <a href="https://tools.ietf.org/html/rfc2088">LITERAL+</a> extension.
  3576. </summary>
  3577. </member>
  3578. <member name="F:MailKit.Net.Imap.ImapCapabilities.Idle">
  3579. <summary>
  3580. The server supports the <a href="https://tools.ietf.org/html/rfc2177">IDLE</a> extension.
  3581. </summary>
  3582. </member>
  3583. <member name="F:MailKit.Net.Imap.ImapCapabilities.MailboxReferrals">
  3584. <summary>
  3585. The server supports the <a href="https://tools.ietf.org/html/rfc2193">MAILBOX-REFERRALS</a> extension.
  3586. </summary>
  3587. </member>
  3588. <member name="F:MailKit.Net.Imap.ImapCapabilities.LoginReferrals">
  3589. <summary>
  3590. the server supports the <a href="https://tools.ietf.org/html/rfc2221">LOGIN-REFERRALS</a> extension.
  3591. </summary>
  3592. </member>
  3593. <member name="F:MailKit.Net.Imap.ImapCapabilities.Namespace">
  3594. <summary>
  3595. The server supports the <a href="https://tools.ietf.org/html/rfc2342">NAMESPACE</a> extension.
  3596. </summary>
  3597. </member>
  3598. <member name="F:MailKit.Net.Imap.ImapCapabilities.Id">
  3599. <summary>
  3600. The server supports the <a href="https://tools.ietf.org/html/rfc2971">ID</a> extension.
  3601. </summary>
  3602. </member>
  3603. <member name="F:MailKit.Net.Imap.ImapCapabilities.Children">
  3604. <summary>
  3605. The server supports the <a href="https://tools.ietf.org/html/rfc3348">CHILDREN</a> extension.
  3606. </summary>
  3607. </member>
  3608. <member name="F:MailKit.Net.Imap.ImapCapabilities.LoginDisabled">
  3609. <summary>
  3610. The server supports the <a href="https://tools.ietf.org/html/rfc3501">LOGINDISABLED</a> extension.
  3611. </summary>
  3612. </member>
  3613. <member name="F:MailKit.Net.Imap.ImapCapabilities.StartTLS">
  3614. <summary>
  3615. The server supports the <a href="https://tools.ietf.org/html/rfc3501">STARTTLS</a> extension.
  3616. </summary>
  3617. </member>
  3618. <member name="F:MailKit.Net.Imap.ImapCapabilities.MultiAppend">
  3619. <summary>
  3620. The server supports the <a href="https://tools.ietf.org/html/rfc3502">MULTIAPPEND</a> extension.
  3621. </summary>
  3622. </member>
  3623. <member name="F:MailKit.Net.Imap.ImapCapabilities.Binary">
  3624. <summary>
  3625. The server supports the <a href="https://tools.ietf.org/html/rfc3516">BINARY</a> content extension.
  3626. </summary>
  3627. </member>
  3628. <member name="F:MailKit.Net.Imap.ImapCapabilities.Unselect">
  3629. <summary>
  3630. The server supports the <a href="https://tools.ietf.org/html/rfc3691">UNSELECT</a> extension.
  3631. </summary>
  3632. </member>
  3633. <member name="F:MailKit.Net.Imap.ImapCapabilities.UidPlus">
  3634. <summary>
  3635. The server supports the <a href="https://tools.ietf.org/html/rfc4315">UIDPLUS</a> extension.
  3636. </summary>
  3637. </member>
  3638. <member name="F:MailKit.Net.Imap.ImapCapabilities.Catenate">
  3639. <summary>
  3640. The server supports the <a href="https://tools.ietf.org/html/rfc4469">CATENATE</a> extension.
  3641. </summary>
  3642. </member>
  3643. <member name="F:MailKit.Net.Imap.ImapCapabilities.CondStore">
  3644. <summary>
  3645. The server supports the <a href="https://tools.ietf.org/html/rfc4551">CONDSTORE</a> extension.
  3646. </summary>
  3647. </member>
  3648. <member name="F:MailKit.Net.Imap.ImapCapabilities.ESearch">
  3649. <summary>
  3650. The server supports the <a href="https://tools.ietf.org/html/rfc4731">ESEARCH</a> extension.
  3651. </summary>
  3652. </member>
  3653. <member name="F:MailKit.Net.Imap.ImapCapabilities.SaslIR">
  3654. <summary>
  3655. The server supports the <a href="https://tools.ietf.org/html/rfc4959">SASL-IR</a> extension.
  3656. </summary>
  3657. </member>
  3658. <member name="F:MailKit.Net.Imap.ImapCapabilities.Compress">
  3659. <summary>
  3660. The server supports the <a href="https://tools.ietf.org/html/rfc4978">COMPRESS</a> extension.
  3661. </summary>
  3662. </member>
  3663. <member name="F:MailKit.Net.Imap.ImapCapabilities.Within">
  3664. <summary>
  3665. The server supports the <a href="https://tools.ietf.org/html/rfc5032">WITHIN</a> extension.
  3666. </summary>
  3667. </member>
  3668. <member name="F:MailKit.Net.Imap.ImapCapabilities.Enable">
  3669. <summary>
  3670. The server supports the <a href="https://tools.ietf.org/html/rfc5161">ENABLE</a> extension.
  3671. </summary>
  3672. </member>
  3673. <member name="F:MailKit.Net.Imap.ImapCapabilities.QuickResync">
  3674. <summary>
  3675. The server supports the <a href="https://tools.ietf.org/html/rfc5162">QRESYNC</a> extension.
  3676. </summary>
  3677. </member>
  3678. <member name="F:MailKit.Net.Imap.ImapCapabilities.SearchResults">
  3679. <summary>
  3680. The server supports the <a href="https://tools.ietf.org/html/rfc5182">SEARCHRES</a> extension.
  3681. </summary>
  3682. </member>
  3683. <member name="F:MailKit.Net.Imap.ImapCapabilities.Sort">
  3684. <summary>
  3685. The server supports the <a href="https://tools.ietf.org/html/rfc5256">SORT</a> extension.
  3686. </summary>
  3687. </member>
  3688. <member name="F:MailKit.Net.Imap.ImapCapabilities.Thread">
  3689. <summary>
  3690. The server supports the <a href="https://tools.ietf.org/html/rfc5256">THREAD</a> extension.
  3691. </summary>
  3692. </member>
  3693. <member name="F:MailKit.Net.Imap.ImapCapabilities.Annotate">
  3694. <summary>
  3695. The server supports the <a href="https://tools.ietf.org/html/rfc5257">ANNOTATE</a> extension.
  3696. </summary>
  3697. </member>
  3698. <member name="F:MailKit.Net.Imap.ImapCapabilities.ListExtended">
  3699. <summary>
  3700. The server supports the <a href="https://tools.ietf.org/html/rfc5258">LIST-EXTENDED</a> extension.
  3701. </summary>
  3702. </member>
  3703. <member name="F:MailKit.Net.Imap.ImapCapabilities.Convert">
  3704. <summary>
  3705. The server supports the <a href="https://tools.ietf.org/html/rfc5259">CONVERT</a> extension.
  3706. </summary>
  3707. </member>
  3708. <member name="F:MailKit.Net.Imap.ImapCapabilities.Language">
  3709. <summary>
  3710. The server supports the <a href="https://tools.ietf.org/html/rfc5255">LANGUAGE</a> extension.
  3711. </summary>
  3712. </member>
  3713. <member name="F:MailKit.Net.Imap.ImapCapabilities.I18NLevel">
  3714. <summary>
  3715. The server supports the <a href="https://tools.ietf.org/html/rfc5255">I18NLEVEL</a> extension.
  3716. </summary>
  3717. </member>
  3718. <member name="F:MailKit.Net.Imap.ImapCapabilities.ESort">
  3719. <summary>
  3720. The server supports the <a href="https://tools.ietf.org/html/rfc5267">ESORT</a> extension.
  3721. </summary>
  3722. </member>
  3723. <member name="F:MailKit.Net.Imap.ImapCapabilities.Context">
  3724. <summary>
  3725. The server supports the <a href="https://tools.ietf.org/html/rfc5267">CONTEXT</a> extension.
  3726. </summary>
  3727. </member>
  3728. <member name="F:MailKit.Net.Imap.ImapCapabilities.Metadata">
  3729. <summary>
  3730. The server supports the <a href="https://tools.ietf.org/html/rfc5464">METADATA</a> extension.
  3731. </summary>
  3732. </member>
  3733. <member name="F:MailKit.Net.Imap.ImapCapabilities.MetadataServer">
  3734. <summary>
  3735. The server supports the <a href="https://tools.ietf.org/html/rfc5464">METADATA-SERVER</a> extension.
  3736. </summary>
  3737. </member>
  3738. <member name="F:MailKit.Net.Imap.ImapCapabilities.Notify">
  3739. <summary>
  3740. The server supports the <a href="https://tools.ietf.org/html/rfc5465">NOTIFY</a> extension.
  3741. </summary>
  3742. </member>
  3743. <member name="F:MailKit.Net.Imap.ImapCapabilities.Filters">
  3744. <summary>
  3745. The server supports the <a href="https://tools.ietf.org/html/rfc5466">FILTERS</a> extension.
  3746. </summary>
  3747. </member>
  3748. <member name="F:MailKit.Net.Imap.ImapCapabilities.ListStatus">
  3749. <summary>
  3750. The server supports the <a href="https://tools.ietf.org/html/rfc5819">LIST-STATUS</a> extension.
  3751. </summary>
  3752. </member>
  3753. <member name="F:MailKit.Net.Imap.ImapCapabilities.SortDisplay">
  3754. <summary>
  3755. The server supports the <a href="https://tools.ietf.org/html/rfc5957">SORT=DISPLAY</a> extension.
  3756. </summary>
  3757. </member>
  3758. <member name="F:MailKit.Net.Imap.ImapCapabilities.CreateSpecialUse">
  3759. <summary>
  3760. The server supports the <a href="https://tools.ietf.org/html/rfc6154">CREATE-SPECIAL-USE</a> extension.
  3761. </summary>
  3762. </member>
  3763. <member name="F:MailKit.Net.Imap.ImapCapabilities.SpecialUse">
  3764. <summary>
  3765. The server supports the <a href="https://tools.ietf.org/html/rfc6154">SPECIAL-USE</a> extension.
  3766. </summary>
  3767. </member>
  3768. <member name="F:MailKit.Net.Imap.ImapCapabilities.FuzzySearch">
  3769. <summary>
  3770. The server supports the <a href="https://tools.ietf.org/html/rfc6203">SEARCH=FUZZY</a> extension.
  3771. </summary>
  3772. </member>
  3773. <member name="F:MailKit.Net.Imap.ImapCapabilities.MultiSearch">
  3774. <summary>
  3775. The server supports the <a href="https://tools.ietf.org/html/rfc6237">MULTISEARCH</a> extension.
  3776. </summary>
  3777. </member>
  3778. <member name="F:MailKit.Net.Imap.ImapCapabilities.Move">
  3779. <summary>
  3780. The server supports the <a href="https://tools.ietf.org/html/rfc6851">MOVE</a> extension.
  3781. </summary>
  3782. </member>
  3783. <member name="F:MailKit.Net.Imap.ImapCapabilities.UTF8Accept">
  3784. <summary>
  3785. The server supports the <a href="https://tools.ietf.org/html/rfc6855">UTF8=ACCEPT</a> extension.
  3786. </summary>
  3787. </member>
  3788. <member name="F:MailKit.Net.Imap.ImapCapabilities.UTF8Only">
  3789. <summary>
  3790. The server supports the <a href="https://tools.ietf.org/html/rfc6855">UTF8=ONLY</a> extension.
  3791. </summary>
  3792. </member>
  3793. <member name="F:MailKit.Net.Imap.ImapCapabilities.LiteralMinus">
  3794. <summary>
  3795. The server supports the <a href="https://tools.ietf.org/html/rfc7888">LITERAL-</a> extension.
  3796. </summary>
  3797. </member>
  3798. <member name="F:MailKit.Net.Imap.ImapCapabilities.AppendLimit">
  3799. <summary>
  3800. The server supports the <a href="https://tools.ietf.org/html/rfc7889">APPENDLIMIT</a> extension.
  3801. </summary>
  3802. </member>
  3803. <member name="F:MailKit.Net.Imap.ImapCapabilities.Unauthenticate">
  3804. <summary>
  3805. The server supports the <a href="https://tools.ietf.org/html/rfc8437">UNAUTHENTICATE</a> extension.
  3806. </summary>
  3807. </member>
  3808. <member name="F:MailKit.Net.Imap.ImapCapabilities.StatusSize">
  3809. <summary>
  3810. The server supports the <a href="https://tools.ietf.org/html/rfc8438">STATUS=SIZE</a> extension.
  3811. </summary>
  3812. </member>
  3813. <member name="F:MailKit.Net.Imap.ImapCapabilities.ListMyRights">
  3814. <summary>
  3815. The server supports the <a href="https://tools.ietf.org/html/rfc8440">LIST-MYRIGHTS</a> extension.
  3816. </summary>
  3817. </member>
  3818. <member name="F:MailKit.Net.Imap.ImapCapabilities.ObjectID">
  3819. <summary>
  3820. The server supports the <a href="https://tools.ietf.org/html/rfc8474">OBJECTID</a> extension.
  3821. </summary>
  3822. </member>
  3823. <member name="F:MailKit.Net.Imap.ImapCapabilities.XList">
  3824. <summary>
  3825. The server supports the <a href="https://developers.google.com/gmail/imap_extensions">XLIST</a> extension (GMail).
  3826. </summary>
  3827. </member>
  3828. <member name="F:MailKit.Net.Imap.ImapCapabilities.GMailExt1">
  3829. <summary>
  3830. The server supports the <a href="https://developers.google.com/gmail/imap_extensions">X-GM-EXT1</a> extension (GMail).
  3831. </summary>
  3832. </member>
  3833. <member name="T:MailKit.Net.Imap.ImapContinuationHandler">
  3834. <summary>
  3835. An IMAP continuation handler.
  3836. </summary>
  3837. <remarks>
  3838. All exceptions thrown by the handler are considered fatal and will
  3839. force-disconnect the connection. If a non-fatal error occurs, set
  3840. it on the <see cref="P:MailKit.Net.Imap.ImapCommand.Exception"/> property.
  3841. </remarks>
  3842. </member>
  3843. <member name="T:MailKit.Net.Imap.ImapUntaggedHandler">
  3844. <summary>
  3845. An IMAP untagged response handler.
  3846. </summary>
  3847. <remarks>
  3848. <para>Most IMAP commands return their results in untagged responses.</para>
  3849. </remarks>
  3850. </member>
  3851. <member name="T:MailKit.Net.Imap.ImapCommandStatus">
  3852. <summary>
  3853. IMAP command status.
  3854. </summary>
  3855. </member>
  3856. <member name="T:MailKit.Net.Imap.ImapIdleContext">
  3857. <summary>
  3858. An IMAP IDLE context.
  3859. </summary>
  3860. <remarks>
  3861. <para>An IMAP IDLE command does not work like normal commands. Unlike most commands,
  3862. the IDLE command does not end until the client sends a separate "DONE" command.</para>
  3863. <para>In order to facilitate this, the way this works is that the consumer of MailKit's
  3864. IMAP APIs provides a 'doneToken' which signals to the command-processing loop to
  3865. send the "DONE" command. Since, like every other IMAP command, it is also necessary to
  3866. provide a means of cancelling the IDLE command, it becomes necessary to link the
  3867. 'doneToken' and the 'cancellationToken' together.</para>
  3868. </remarks>
  3869. </member>
  3870. <member name="M:MailKit.Net.Imap.ImapIdleContext.#ctor(MailKit.Net.Imap.ImapEngine,System.Threading.CancellationToken,System.Threading.CancellationToken)">
  3871. <summary>
  3872. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapIdleContext"/> class.
  3873. </summary>
  3874. <remarks>
  3875. Creates a new <see cref="T:MailKit.Net.Imap.ImapIdleContext"/>.
  3876. </remarks>
  3877. <param name="engine">The IMAP engine.</param>
  3878. <param name="doneToken">The done token.</param>
  3879. <param name="cancellationToken">The cancellation token.</param>
  3880. </member>
  3881. <member name="P:MailKit.Net.Imap.ImapIdleContext.Engine">
  3882. <summary>
  3883. Get the engine.
  3884. </summary>
  3885. <remarks>
  3886. Gets the engine.
  3887. </remarks>
  3888. <value>The engine.</value>
  3889. </member>
  3890. <member name="P:MailKit.Net.Imap.ImapIdleContext.CancellationToken">
  3891. <summary>
  3892. Get the cancellation token.
  3893. </summary>
  3894. <remarks>
  3895. Get the cancellation token.
  3896. </remarks>
  3897. <value>The cancellation token.</value>
  3898. </member>
  3899. <member name="P:MailKit.Net.Imap.ImapIdleContext.DoneToken">
  3900. <summary>
  3901. Get the done token.
  3902. </summary>
  3903. <remarks>
  3904. Gets the done token.
  3905. </remarks>
  3906. <value>The done token.</value>
  3907. </member>
  3908. <member name="M:MailKit.Net.Imap.ImapIdleContext.ContinuationHandler(MailKit.Net.Imap.ImapEngine,MailKit.Net.Imap.ImapCommand,System.String,System.Boolean)">
  3909. <summary>
  3910. Callback method to be used as the ImapCommand's ContinuationHandler.
  3911. </summary>
  3912. <remarks>
  3913. Callback method to be used as the ImapCommand's ContinuationHandler.
  3914. </remarks>
  3915. <param name="engine">The ImapEngine.</param>
  3916. <param name="ic">The ImapCommand.</param>
  3917. <param name="text">The text.</param>
  3918. <param name="doAsync"><c>true</c> if the command is being run asynchronously; otherwise, <c>false</c>.</param>
  3919. <returns></returns>
  3920. </member>
  3921. <member name="M:MailKit.Net.Imap.ImapIdleContext.Dispose">
  3922. <summary>
  3923. Releases all resource used by the <see cref="T:MailKit.Net.Imap.ImapIdleContext"/> object.
  3924. </summary>
  3925. <remarks>Call <see cref="M:MailKit.Net.Imap.ImapIdleContext.Dispose"/> when you are finished using the <see cref="T:MailKit.Net.Imap.ImapIdleContext"/>. The
  3926. <see cref="M:MailKit.Net.Imap.ImapIdleContext.Dispose"/> method leaves the <see cref="T:MailKit.Net.Imap.ImapIdleContext"/> in an unusable state. After
  3927. calling <see cref="M:MailKit.Net.Imap.ImapIdleContext.Dispose"/>, you must release all references to the
  3928. <see cref="T:MailKit.Net.Imap.ImapIdleContext"/> so the garbage collector can reclaim the memory that the
  3929. <see cref="T:MailKit.Net.Imap.ImapIdleContext"/> was occupying.</remarks>
  3930. </member>
  3931. <member name="T:MailKit.Net.Imap.ImapLiteral">
  3932. <summary>
  3933. An IMAP literal object.
  3934. </summary>
  3935. <remarks>
  3936. The literal can be a string, byte[], Stream, or a MimeMessage.
  3937. </remarks>
  3938. </member>
  3939. <member name="M:MailKit.Net.Imap.ImapLiteral.#ctor(MimeKit.FormatOptions,MimeKit.MimeMessage,System.Action{System.Int32})">
  3940. <summary>
  3941. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapLiteral"/> class.
  3942. </summary>
  3943. <remarks>
  3944. Creates a new <see cref="T:MailKit.Net.Imap.ImapLiteral"/>.
  3945. </remarks>
  3946. <param name="options">The formatting options.</param>
  3947. <param name="message">The message.</param>
  3948. <param name="action">The progress update action.</param>
  3949. </member>
  3950. <member name="M:MailKit.Net.Imap.ImapLiteral.#ctor(MimeKit.FormatOptions,System.Byte[])">
  3951. <summary>
  3952. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapLiteral"/> class.
  3953. </summary>
  3954. <remarks>
  3955. Creates a new <see cref="T:MailKit.Net.Imap.ImapLiteral"/>.
  3956. </remarks>
  3957. <param name="options">The formatting options.</param>
  3958. <param name="literal">The literal.</param>
  3959. </member>
  3960. <member name="P:MailKit.Net.Imap.ImapLiteral.Length">
  3961. <summary>
  3962. Get the length of the literal, in bytes.
  3963. </summary>
  3964. <remarks>
  3965. Gets the length of the literal, in bytes.
  3966. </remarks>
  3967. <value>The length.</value>
  3968. </member>
  3969. <member name="M:MailKit.Net.Imap.ImapLiteral.WriteToAsync(MailKit.Net.Imap.ImapStream,System.Boolean,System.Threading.CancellationToken)">
  3970. <summary>
  3971. Write the literal to the specified stream.
  3972. </summary>
  3973. <remarks>
  3974. Writes the literal to the specified stream.
  3975. </remarks>
  3976. <param name="stream">The stream.</param>
  3977. <param name="doAsync">Whether the literal should be written asynchronously or not.</param>
  3978. <param name="cancellationToken">The cancellation token.</param>
  3979. </member>
  3980. <member name="T:MailKit.Net.Imap.ImapCommandPart">
  3981. <summary>
  3982. A partial IMAP command.
  3983. </summary>
  3984. <remarks>
  3985. IMAP commands that contain literal strings are broken up into multiple parts
  3986. in case the IMAP server does not support the LITERAL+ extension. These parts
  3987. are then sent individually as we receive "+" responses from the server.
  3988. </remarks>
  3989. </member>
  3990. <member name="T:MailKit.Net.Imap.ImapCommand">
  3991. <summary>
  3992. An IMAP command.
  3993. </summary>
  3994. </member>
  3995. <member name="M:MailKit.Net.Imap.ImapCommand.#ctor(MailKit.Net.Imap.ImapEngine,System.Threading.CancellationToken,MailKit.Net.Imap.ImapFolder,MimeKit.FormatOptions,System.String,System.Object[])">
  3996. <summary>
  3997. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapCommand"/> class.
  3998. </summary>
  3999. <remarks>
  4000. Creates a new <see cref="T:MailKit.Net.Imap.ImapCommand"/>.
  4001. </remarks>
  4002. <param name="engine">The IMAP engine that will be sending the command.</param>
  4003. <param name="cancellationToken">The cancellation token.</param>
  4004. <param name="folder">The IMAP folder that the command operates on.</param>
  4005. <param name="options">The formatting options.</param>
  4006. <param name="format">The command format.</param>
  4007. <param name="args">The command arguments.</param>
  4008. </member>
  4009. <member name="M:MailKit.Net.Imap.ImapCommand.#ctor(MailKit.Net.Imap.ImapEngine,System.Threading.CancellationToken,MailKit.Net.Imap.ImapFolder,System.String,System.Object[])">
  4010. <summary>
  4011. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapCommand"/> class.
  4012. </summary>
  4013. <remarks>
  4014. Creates a new <see cref="T:MailKit.Net.Imap.ImapCommand"/>.
  4015. </remarks>
  4016. <param name="engine">The IMAP engine that will be sending the command.</param>
  4017. <param name="cancellationToken">The cancellation token.</param>
  4018. <param name="folder">The IMAP folder that the command operates on.</param>
  4019. <param name="format">The command format.</param>
  4020. <param name="args">The command arguments.</param>
  4021. </member>
  4022. <member name="M:MailKit.Net.Imap.ImapCommand.RegisterUntaggedHandler(System.String,MailKit.Net.Imap.ImapUntaggedHandler)">
  4023. <summary>
  4024. Registers the untagged handler for the specified atom token.
  4025. </summary>
  4026. <param name="atom">The atom token.</param>
  4027. <param name="handler">The handler.</param>
  4028. <exception cref="T:System.ArgumentNullException">
  4029. <para><paramref name="atom"/> is <c>null</c>.</para>
  4030. <para>-or-</para>
  4031. <para><paramref name="handler"/> is <c>null</c>.</para>
  4032. </exception>
  4033. <exception cref="T:System.InvalidOperationException">
  4034. Untagged handlers must be registered before the command has been queued.
  4035. </exception>
  4036. </member>
  4037. <member name="M:MailKit.Net.Imap.ImapCommand.StepAsync(System.Boolean)">
  4038. <summary>
  4039. Sends the next part of the command to the server.
  4040. </summary>
  4041. <exception cref="T:System.OperationCanceledException">
  4042. The operation was canceled via the cancellation token.
  4043. </exception>
  4044. <exception cref="T:System.IO.IOException">
  4045. An I/O error occurred.
  4046. </exception>
  4047. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  4048. An IMAP protocol error occurred.
  4049. </exception>
  4050. </member>
  4051. <member name="T:MailKit.Net.Imap.ImapCommandException">
  4052. <summary>
  4053. An exception that is thrown when an IMAP command returns NO or BAD.
  4054. </summary>
  4055. <remarks>
  4056. The exception that is thrown when an IMAP command fails. Unlike a <see cref="T:MailKit.Net.Imap.ImapProtocolException"/>,
  4057. a <see cref="T:MailKit.Net.Imap.ImapCommandException"/> does not require the <see cref="T:MailKit.Net.Imap.ImapClient"/> to be reconnected.
  4058. </remarks>
  4059. </member>
  4060. <member name="M:MailKit.Net.Imap.ImapCommandException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  4061. <summary>
  4062. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapCommandException"/> class.
  4063. </summary>
  4064. <remarks>
  4065. Creates a new <see cref="T:MailKit.Net.Imap.ImapCommandException"/> from the serialized data.
  4066. </remarks>
  4067. <param name="info">The serialization info.</param>
  4068. <param name="context">The streaming context.</param>
  4069. <exception cref="T:System.ArgumentNullException">
  4070. <paramref name="info"/> is <c>null</c>.
  4071. </exception>
  4072. </member>
  4073. <member name="M:MailKit.Net.Imap.ImapCommandException.Create(System.String,MailKit.Net.Imap.ImapCommand)">
  4074. <summary>
  4075. Create a new <see cref="T:MailKit.Net.Imap.ImapCommandException"/> based on the specified command name and <see cref="T:MailKit.Net.Imap.ImapCommand"/> state.
  4076. </summary>
  4077. <remarks>
  4078. Create a new <see cref="T:MailKit.Net.Imap.ImapCommandException"/> based on the specified command name and <see cref="T:MailKit.Net.Imap.ImapCommand"/> state.
  4079. </remarks>
  4080. <returns>A new command exception.</returns>
  4081. <param name="command">The command name.</param>
  4082. <param name="ic">The command state.</param>
  4083. </member>
  4084. <member name="M:MailKit.Net.Imap.ImapCommandException.#ctor(MailKit.Net.Imap.ImapCommandResponse,System.String,System.String,System.Exception)">
  4085. <summary>
  4086. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapCommandException"/> class.
  4087. </summary>
  4088. <remarks>
  4089. Creates a new <see cref="T:MailKit.Net.Imap.ImapCommandException"/>.
  4090. </remarks>
  4091. <param name="response">The IMAP command response.</param>
  4092. <param name="message">The error message.</param>
  4093. <param name="responseText">The human-readable response text.</param>
  4094. <param name="innerException">The inner exception.</param>
  4095. </member>
  4096. <member name="M:MailKit.Net.Imap.ImapCommandException.#ctor(MailKit.Net.Imap.ImapCommandResponse,System.String,System.String)">
  4097. <summary>
  4098. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapCommandException"/> class.
  4099. </summary>
  4100. <remarks>
  4101. Creates a new <see cref="T:MailKit.Net.Imap.ImapCommandException"/>.
  4102. </remarks>
  4103. <param name="response">The IMAP command response.</param>
  4104. <param name="responseText">The human-readable response text.</param>
  4105. <param name="message">The error message.</param>
  4106. </member>
  4107. <member name="M:MailKit.Net.Imap.ImapCommandException.#ctor(MailKit.Net.Imap.ImapCommandResponse,System.String)">
  4108. <summary>
  4109. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapCommandException"/> class.
  4110. </summary>
  4111. <remarks>
  4112. Creates a new <see cref="T:MailKit.Net.Imap.ImapCommandException"/>.
  4113. </remarks>
  4114. <param name="response">The IMAP command response.</param>
  4115. <param name="responseText">The human-readable response text.</param>
  4116. </member>
  4117. <member name="P:MailKit.Net.Imap.ImapCommandException.Response">
  4118. <summary>
  4119. Gets the IMAP command response.
  4120. </summary>
  4121. <remarks>
  4122. Gets the IMAP command response.
  4123. </remarks>
  4124. <value>The IMAP command response.</value>
  4125. </member>
  4126. <member name="P:MailKit.Net.Imap.ImapCommandException.ResponseText">
  4127. <summary>
  4128. Gets the human-readable IMAP command response text.
  4129. </summary>
  4130. <remarks>
  4131. Gets the human-readable IMAP command response text.
  4132. </remarks>
  4133. <value>The response text.</value>
  4134. </member>
  4135. <member name="M:MailKit.Net.Imap.ImapCommandException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  4136. <summary>
  4137. When overridden in a derived class, sets the <see cref="T:System.Runtime.Serialization.SerializationInfo"/>
  4138. with information about the exception.
  4139. </summary>
  4140. <remarks>
  4141. Serializes the state of the <see cref="T:MailKit.FolderNotFoundException"/>.
  4142. </remarks>
  4143. <param name="info">The serialization info.</param>
  4144. <param name="context">The streaming context.</param>
  4145. <exception cref="T:System.ArgumentNullException">
  4146. <paramref name="info"/> is <c>null</c>.
  4147. </exception>
  4148. </member>
  4149. <member name="T:MailKit.Net.Imap.ImapCommandResponse">
  4150. <summary>
  4151. An enumeration of possible IMAP command responses.
  4152. </summary>
  4153. <remarks>
  4154. An enumeration of possible IMAP command responses.
  4155. </remarks>
  4156. </member>
  4157. <member name="F:MailKit.Net.Imap.ImapCommandResponse.None">
  4158. <summary>
  4159. No IMAP command response yet.
  4160. </summary>
  4161. </member>
  4162. <member name="F:MailKit.Net.Imap.ImapCommandResponse.Ok">
  4163. <summary>
  4164. The command resulted in an "OK" response.
  4165. </summary>
  4166. </member>
  4167. <member name="F:MailKit.Net.Imap.ImapCommandResponse.No">
  4168. <summary>
  4169. The command resulted in a "NO" response.
  4170. </summary>
  4171. </member>
  4172. <member name="F:MailKit.Net.Imap.ImapCommandResponse.Bad">
  4173. <summary>
  4174. The command resulted in a "BAD" response.
  4175. </summary>
  4176. </member>
  4177. <member name="T:MailKit.Net.Imap.ImapEngineState">
  4178. <summary>
  4179. The state of the <see cref="T:MailKit.Net.Imap.ImapEngine"/>.
  4180. </summary>
  4181. </member>
  4182. <member name="F:MailKit.Net.Imap.ImapEngineState.Disconnected">
  4183. <summary>
  4184. The ImapEngine is in the disconnected state.
  4185. </summary>
  4186. </member>
  4187. <member name="F:MailKit.Net.Imap.ImapEngineState.Connecting">
  4188. <summary>
  4189. The ImapEngine is in the process of connecting.
  4190. </summary>
  4191. </member>
  4192. <member name="F:MailKit.Net.Imap.ImapEngineState.Connected">
  4193. <summary>
  4194. The ImapEngine is connected but not yet authenticated.
  4195. </summary>
  4196. </member>
  4197. <member name="F:MailKit.Net.Imap.ImapEngineState.Authenticated">
  4198. <summary>
  4199. The ImapEngine is in the authenticated state.
  4200. </summary>
  4201. </member>
  4202. <member name="F:MailKit.Net.Imap.ImapEngineState.Selected">
  4203. <summary>
  4204. The ImapEngine is in the selected state.
  4205. </summary>
  4206. </member>
  4207. <member name="F:MailKit.Net.Imap.ImapEngineState.Idle">
  4208. <summary>
  4209. The ImapEngine is in the IDLE state.
  4210. </summary>
  4211. </member>
  4212. <member name="T:MailKit.Net.Imap.ImapEngine">
  4213. <summary>
  4214. An IMAP command engine.
  4215. </summary>
  4216. </member>
  4217. <member name="P:MailKit.Net.Imap.ImapEngine.AuthenticationMechanisms">
  4218. <summary>
  4219. Get the authentication mechanisms supported by the IMAP server.
  4220. </summary>
  4221. <remarks>
  4222. The authentication mechanisms are queried durring the
  4223. <see cref="M:MailKit.Net.Imap.ImapEngine.ConnectAsync(MailKit.Net.Imap.ImapStream,System.Boolean,System.Threading.CancellationToken)"/> method.
  4224. </remarks>
  4225. <value>The authentication mechanisms.</value>
  4226. </member>
  4227. <member name="P:MailKit.Net.Imap.ImapEngine.CompressionAlgorithms">
  4228. <summary>
  4229. Get the compression algorithms supported by the IMAP server.
  4230. </summary>
  4231. <remarks>
  4232. The compression algorithms are populated by the
  4233. <see cref="M:MailKit.Net.Imap.ImapEngine.QueryCapabilitiesAsync(System.Boolean,System.Threading.CancellationToken)"/> method.
  4234. </remarks>
  4235. <value>The compression algorithms.</value>
  4236. </member>
  4237. <member name="P:MailKit.Net.Imap.ImapEngine.ThreadingAlgorithms">
  4238. <summary>
  4239. Get the threading algorithms supported by the IMAP server.
  4240. </summary>
  4241. <remarks>
  4242. The threading algorithms are populated by the
  4243. <see cref="M:MailKit.Net.Imap.ImapEngine.QueryCapabilitiesAsync(System.Boolean,System.Threading.CancellationToken)"/> method.
  4244. </remarks>
  4245. <value>The threading algorithms.</value>
  4246. </member>
  4247. <member name="P:MailKit.Net.Imap.ImapEngine.AppendLimit">
  4248. <summary>
  4249. Gets the append limit supported by the IMAP server.
  4250. </summary>
  4251. <remarks>
  4252. Gets the append limit supported by the IMAP server.
  4253. </remarks>
  4254. <value>The append limit.</value>
  4255. </member>
  4256. <member name="P:MailKit.Net.Imap.ImapEngine.I18NLevel">
  4257. <summary>
  4258. Gets the I18NLEVEL supported by the IMAP server.
  4259. </summary>
  4260. <remarks>
  4261. Gets the I18NLEVEL supported by the IMAP server.
  4262. </remarks>
  4263. <value>The internationalization level.</value>
  4264. </member>
  4265. <member name="P:MailKit.Net.Imap.ImapEngine.Capabilities">
  4266. <summary>
  4267. Get the capabilities supported by the IMAP server.
  4268. </summary>
  4269. <remarks>
  4270. The capabilities will not be known until a successful connection
  4271. has been made via the <see cref="M:MailKit.Net.Imap.ImapEngine.ConnectAsync(MailKit.Net.Imap.ImapStream,System.Boolean,System.Threading.CancellationToken)"/> method.
  4272. </remarks>
  4273. <value>The capabilities.</value>
  4274. </member>
  4275. <member name="P:MailKit.Net.Imap.ImapEngine.IsBusy">
  4276. <summary>
  4277. Indicates whether or not the engine is busy processing commands.
  4278. </summary>
  4279. <remarks>
  4280. Indicates whether or not the engine is busy processing commands.
  4281. </remarks>
  4282. <value><c>true</c> if th e engine is busy processing commands; otherwise, <c>false</c>.</value>
  4283. </member>
  4284. <member name="P:MailKit.Net.Imap.ImapEngine.CapabilitiesVersion">
  4285. <summary>
  4286. Get the capabilities version.
  4287. </summary>
  4288. <remarks>
  4289. Every time the engine receives an untagged CAPABILITIES
  4290. response from the server, it increments this value.
  4291. </remarks>
  4292. <value>The capabilities version.</value>
  4293. </member>
  4294. <member name="P:MailKit.Net.Imap.ImapEngine.ProtocolVersion">
  4295. <summary>
  4296. Get the IMAP protocol version.
  4297. </summary>
  4298. <remarks>
  4299. Gets the IMAP protocol version.
  4300. </remarks>
  4301. <value>The IMAP protocol version.</value>
  4302. </member>
  4303. <member name="P:MailKit.Net.Imap.ImapEngine.Rights">
  4304. <summary>
  4305. Get the rights specified in the capabilities.
  4306. </summary>
  4307. <remarks>
  4308. Gets the rights specified in the capabilities.
  4309. </remarks>
  4310. <value>The rights.</value>
  4311. </member>
  4312. <member name="P:MailKit.Net.Imap.ImapEngine.SupportedCharsets">
  4313. <summary>
  4314. Get the supported charsets.
  4315. </summary>
  4316. <remarks>
  4317. Gets the supported charsets.
  4318. </remarks>
  4319. <value>The supported charsets.</value>
  4320. </member>
  4321. <member name="P:MailKit.Net.Imap.ImapEngine.SupportedContexts">
  4322. <summary>
  4323. Get the supported contexts.
  4324. </summary>
  4325. <remarks>
  4326. Gets the supported contexts.
  4327. </remarks>
  4328. <value>The supported contexts.</value>
  4329. </member>
  4330. <member name="P:MailKit.Net.Imap.ImapEngine.QResyncEnabled">
  4331. <summary>
  4332. Get whether or not the QRESYNC feature has been enabled.
  4333. </summary>
  4334. <remarks>
  4335. Gets whether or not the QRESYNC feature has been enabled.
  4336. </remarks>
  4337. <value><c>true</c> if the QRESYNC feature has been enabled; otherwise, <c>false</c>.</value>
  4338. </member>
  4339. <member name="P:MailKit.Net.Imap.ImapEngine.UTF8Enabled">
  4340. <summary>
  4341. Get whether or not the UTF8=ACCEPT feature has been enabled.
  4342. </summary>
  4343. <remarks>
  4344. Gets whether or not the UTF8=ACCEPT feature has been enabled.
  4345. </remarks>
  4346. <value><c>true</c> if the UTF8=ACCEPT feature has been enabled; otherwise, <c>false</c>.</value>
  4347. </member>
  4348. <member name="P:MailKit.Net.Imap.ImapEngine.Uri">
  4349. <summary>
  4350. Get the URI of the IMAP server.
  4351. </summary>
  4352. <remarks>
  4353. Gets the URI of the IMAP server.
  4354. </remarks>
  4355. <value>The URI of the IMAP server.</value>
  4356. </member>
  4357. <member name="P:MailKit.Net.Imap.ImapEngine.Stream">
  4358. <summary>
  4359. Get the underlying IMAP stream.
  4360. </summary>
  4361. <remarks>
  4362. Gets the underlying IMAP stream.
  4363. </remarks>
  4364. <value>The IMAP stream.</value>
  4365. </member>
  4366. <member name="P:MailKit.Net.Imap.ImapEngine.State">
  4367. <summary>
  4368. Get or sets the state of the engine.
  4369. </summary>
  4370. <remarks>
  4371. Gets or sets the state of the engine.
  4372. </remarks>
  4373. <value>The engine state.</value>
  4374. </member>
  4375. <member name="P:MailKit.Net.Imap.ImapEngine.IsConnected">
  4376. <summary>
  4377. Get whether or not the engine is currently connected to a IMAP server.
  4378. </summary>
  4379. <remarks>
  4380. Gets whether or not the engine is currently connected to a IMAP server.
  4381. </remarks>
  4382. <value><c>true</c> if the engine is connected; otherwise, <c>false</c>.</value>
  4383. </member>
  4384. <member name="P:MailKit.Net.Imap.ImapEngine.PersonalNamespaces">
  4385. <summary>
  4386. Gets the personal folder namespaces.
  4387. </summary>
  4388. <remarks>
  4389. Gets the personal folder namespaces.
  4390. </remarks>
  4391. <value>The personal folder namespaces.</value>
  4392. </member>
  4393. <member name="P:MailKit.Net.Imap.ImapEngine.SharedNamespaces">
  4394. <summary>
  4395. Gets the shared folder namespaces.
  4396. </summary>
  4397. <remarks>
  4398. Gets the shared folder namespaces.
  4399. </remarks>
  4400. <value>The shared folder namespaces.</value>
  4401. </member>
  4402. <member name="P:MailKit.Net.Imap.ImapEngine.OtherNamespaces">
  4403. <summary>
  4404. Gets the other folder namespaces.
  4405. </summary>
  4406. <remarks>
  4407. Gets the other folder namespaces.
  4408. </remarks>
  4409. <value>The other folder namespaces.</value>
  4410. </member>
  4411. <member name="P:MailKit.Net.Imap.ImapEngine.Selected">
  4412. <summary>
  4413. Gets the selected folder.
  4414. </summary>
  4415. <remarks>
  4416. Gets the selected folder.
  4417. </remarks>
  4418. <value>The selected folder.</value>
  4419. </member>
  4420. <member name="P:MailKit.Net.Imap.ImapEngine.IsDisposed">
  4421. <summary>
  4422. Gets a value indicating whether the engine is disposed.
  4423. </summary>
  4424. <remarks>
  4425. Gets a value indicating whether the engine is disposed.
  4426. </remarks>
  4427. <value><c>true</c> if the engine is disposed; otherwise, <c>false</c>.</value>
  4428. </member>
  4429. <member name="P:MailKit.Net.Imap.ImapEngine.NotifySelectedNewExpunge">
  4430. <summary>
  4431. Gets whether the current NOTIFY status prevents using indexes and * for referencing messages.
  4432. </summary>
  4433. <remarks>
  4434. Gets whether the current NOTIFY status prevents using indexes and * for referencing messages. This is the case when the client has asked for MessageNew or MessageExpunge events on the SELECTED mailbox.
  4435. </remarks>
  4436. <value><c>true</c> if the use of indexes and * is prevented; otherwise, <c>false</c>.</value>
  4437. </member>
  4438. <member name="P:MailKit.Net.Imap.ImapEngine.Inbox">
  4439. <summary>
  4440. Gets the Inbox folder.
  4441. </summary>
  4442. <value>The Inbox folder.</value>
  4443. </member>
  4444. <member name="P:MailKit.Net.Imap.ImapEngine.All">
  4445. <summary>
  4446. Gets the special folder containing an aggregate of all messages.
  4447. </summary>
  4448. <value>The folder containing all messages.</value>
  4449. </member>
  4450. <member name="P:MailKit.Net.Imap.ImapEngine.Archive">
  4451. <summary>
  4452. Gets the special archive folder.
  4453. </summary>
  4454. <value>The archive folder.</value>
  4455. </member>
  4456. <member name="P:MailKit.Net.Imap.ImapEngine.Drafts">
  4457. <summary>
  4458. Gets the special folder containing drafts.
  4459. </summary>
  4460. <value>The drafts folder.</value>
  4461. </member>
  4462. <member name="P:MailKit.Net.Imap.ImapEngine.Flagged">
  4463. <summary>
  4464. Gets the special folder containing flagged messages.
  4465. </summary>
  4466. <value>The flagged folder.</value>
  4467. </member>
  4468. <member name="P:MailKit.Net.Imap.ImapEngine.Junk">
  4469. <summary>
  4470. Gets the special folder containing junk messages.
  4471. </summary>
  4472. <value>The junk folder.</value>
  4473. </member>
  4474. <member name="P:MailKit.Net.Imap.ImapEngine.Sent">
  4475. <summary>
  4476. Gets the special folder containing sent messages.
  4477. </summary>
  4478. <value>The sent.</value>
  4479. </member>
  4480. <member name="P:MailKit.Net.Imap.ImapEngine.Trash">
  4481. <summary>
  4482. Gets the folder containing deleted messages.
  4483. </summary>
  4484. <value>The trash folder.</value>
  4485. </member>
  4486. <member name="M:MailKit.Net.Imap.ImapEngine.SetStream(MailKit.Net.Imap.ImapStream)">
  4487. <summary>
  4488. Sets the stream - this is only here to be used by the unit tests.
  4489. </summary>
  4490. <param name="stream">The IMAP stream.</param>
  4491. </member>
  4492. <member name="M:MailKit.Net.Imap.ImapEngine.ConnectAsync(MailKit.Net.Imap.ImapStream,System.Boolean,System.Threading.CancellationToken)">
  4493. <summary>
  4494. Takes posession of the <see cref="T:MailKit.Net.Imap.ImapStream"/> and reads the greeting.
  4495. </summary>
  4496. <param name="stream">The IMAP stream.</param>
  4497. <param name="doAsync">Whether or not asyncrhonois IO methods should be used.</param>
  4498. <param name="cancellationToken">The cancellation token.</param>
  4499. <exception cref="T:System.OperationCanceledException">
  4500. The operation was canceled via the cancellation token.
  4501. </exception>
  4502. <exception cref="T:System.IO.IOException">
  4503. An I/O error occurred.
  4504. </exception>
  4505. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  4506. An IMAP protocol error occurred.
  4507. </exception>
  4508. </member>
  4509. <member name="M:MailKit.Net.Imap.ImapEngine.Disconnect">
  4510. <summary>
  4511. Disconnects the <see cref="T:MailKit.Net.Imap.ImapEngine"/>.
  4512. </summary>
  4513. <remarks>
  4514. Disconnects the <see cref="T:MailKit.Net.Imap.ImapEngine"/>.
  4515. </remarks>
  4516. </member>
  4517. <member name="M:MailKit.Net.Imap.ImapEngine.ReadToken(System.Threading.CancellationToken)">
  4518. <summary>
  4519. Reads the next token.
  4520. </summary>
  4521. <returns>The token.</returns>
  4522. <param name="cancellationToken">The cancellation token.</param>
  4523. <exception cref="T:System.InvalidOperationException">
  4524. The engine is not connected.
  4525. </exception>
  4526. <exception cref="T:System.OperationCanceledException">
  4527. The operation was canceled via the cancellation token.
  4528. </exception>
  4529. <exception cref="T:System.IO.IOException">
  4530. An I/O error occurred.
  4531. </exception>
  4532. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  4533. An IMAP protocol error occurred.
  4534. </exception>
  4535. </member>
  4536. <member name="M:MailKit.Net.Imap.ImapEngine.ParseResponseCodeAsync(System.Boolean,System.Boolean,System.Threading.CancellationToken)">
  4537. <summary>
  4538. Parses the response code.
  4539. </summary>
  4540. <returns>The response code.</returns>
  4541. <param name="isTagged">Whether or not the resp-code is tagged vs untagged.</param>
  4542. <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
  4543. <param name="cancellationToken">The cancellation token.</param>
  4544. </member>
  4545. <member name="M:MailKit.Net.Imap.ImapEngine.ProcessUntaggedResponseAsync(System.Boolean,System.Threading.CancellationToken)">
  4546. <summary>
  4547. Processes an untagged response.
  4548. </summary>
  4549. <returns>The untagged response.</returns>
  4550. <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
  4551. <param name="cancellationToken">The cancellation token.</param>
  4552. </member>
  4553. <member name="M:MailKit.Net.Imap.ImapEngine.IterateAsync(System.Boolean)">
  4554. <summary>
  4555. Iterate the command pipeline.
  4556. </summary>
  4557. </member>
  4558. <member name="M:MailKit.Net.Imap.ImapEngine.RunAsync(MailKit.Net.Imap.ImapCommand,System.Boolean)">
  4559. <summary>
  4560. Wait for the specified command to finish.
  4561. </summary>
  4562. <param name="ic">The IMAP command.</param>
  4563. <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
  4564. <exception cref="T:System.ArgumentNullException">
  4565. <paramref name="ic"/> is <c>null</c>.
  4566. </exception>
  4567. </member>
  4568. <member name="M:MailKit.Net.Imap.ImapEngine.QueueCommand(System.Threading.CancellationToken,MailKit.Net.Imap.ImapFolder,MimeKit.FormatOptions,System.String,System.Object[])">
  4569. <summary>
  4570. Queues the command.
  4571. </summary>
  4572. <returns>The command.</returns>
  4573. <param name="cancellationToken">The cancellation token.</param>
  4574. <param name="folder">The folder that the command operates on.</param>
  4575. <param name="options">The formatting options.</param>
  4576. <param name="format">The command format.</param>
  4577. <param name="args">The command arguments.</param>
  4578. </member>
  4579. <member name="M:MailKit.Net.Imap.ImapEngine.QueueCommand(System.Threading.CancellationToken,MailKit.Net.Imap.ImapFolder,System.String,System.Object[])">
  4580. <summary>
  4581. Queues the command.
  4582. </summary>
  4583. <returns>The command.</returns>
  4584. <param name="cancellationToken">The cancellation token.</param>
  4585. <param name="folder">The folder that the command operates on.</param>
  4586. <param name="format">The command format.</param>
  4587. <param name="args">The command arguments.</param>
  4588. </member>
  4589. <member name="M:MailKit.Net.Imap.ImapEngine.QueueCommand(MailKit.Net.Imap.ImapCommand)">
  4590. <summary>
  4591. Queues the command.
  4592. </summary>
  4593. <param name="ic">The IMAP command.</param>
  4594. </member>
  4595. <member name="M:MailKit.Net.Imap.ImapEngine.QueryCapabilitiesAsync(System.Boolean,System.Threading.CancellationToken)">
  4596. <summary>
  4597. Queries the capabilities.
  4598. </summary>
  4599. <returns>The command result.</returns>
  4600. <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
  4601. <param name="cancellationToken">The cancellation token.</param>
  4602. </member>
  4603. <member name="M:MailKit.Net.Imap.ImapEngine.CacheFolder(MailKit.Net.Imap.ImapFolder)">
  4604. <summary>
  4605. Cache the specified folder.
  4606. </summary>
  4607. <param name="folder">The folder.</param>
  4608. </member>
  4609. <member name="M:MailKit.Net.Imap.ImapEngine.GetCachedFolder(System.String,MailKit.Net.Imap.ImapFolder@)">
  4610. <summary>
  4611. Gets the cached folder.
  4612. </summary>
  4613. <returns><c>true</c> if the folder was retreived from the cache; otherwise, <c>false</c>.</returns>
  4614. <param name="encodedName">The encoded folder name.</param>
  4615. <param name="folder">The cached folder.</param>
  4616. </member>
  4617. <member name="M:MailKit.Net.Imap.ImapEngine.LookupParentFoldersAsync(System.Collections.Generic.IEnumerable{MailKit.Net.Imap.ImapFolder},System.Boolean,System.Threading.CancellationToken)">
  4618. <summary>
  4619. Looks up and sets the <see cref="P:MailKit.MailFolder.ParentFolder"/> property of each of the folders.
  4620. </summary>
  4621. <param name="folders">The IMAP folders.</param>
  4622. <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
  4623. <param name="cancellationToken">The cancellation token.</param>
  4624. </member>
  4625. <member name="M:MailKit.Net.Imap.ImapEngine.QueryNamespacesAsync(System.Boolean,System.Threading.CancellationToken)">
  4626. <summary>
  4627. Queries the namespaces.
  4628. </summary>
  4629. <returns>The command result.</returns>
  4630. <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
  4631. <param name="cancellationToken">The cancellation token.</param>
  4632. </member>
  4633. <member name="M:MailKit.Net.Imap.ImapEngine.AssignSpecialFolder(MailKit.Net.Imap.ImapFolder)">
  4634. <summary>
  4635. Assigns a folder as a special folder.
  4636. </summary>
  4637. <param name="folder">The special folder.</param>
  4638. </member>
  4639. <member name="M:MailKit.Net.Imap.ImapEngine.AssignSpecialFolders(System.Collections.Generic.IList{MailKit.Net.Imap.ImapFolder})">
  4640. <summary>
  4641. Assigns the special folders.
  4642. </summary>
  4643. <param name="list">The list of folders.</param>
  4644. </member>
  4645. <member name="M:MailKit.Net.Imap.ImapEngine.QuerySpecialFoldersAsync(System.Boolean,System.Threading.CancellationToken)">
  4646. <summary>
  4647. Queries the special folders.
  4648. </summary>
  4649. <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
  4650. <param name="cancellationToken">The cancellation token.</param>
  4651. </member>
  4652. <member name="M:MailKit.Net.Imap.ImapEngine.GetQuotaRootFolderAsync(System.String,System.Boolean,System.Threading.CancellationToken)">
  4653. <summary>
  4654. Gets the folder representing the specified quota root.
  4655. </summary>
  4656. <returns>The folder.</returns>
  4657. <param name="quotaRoot">The name of the quota root.</param>
  4658. <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
  4659. <param name="cancellationToken">The cancellation token.</param>
  4660. </member>
  4661. <member name="M:MailKit.Net.Imap.ImapEngine.GetFolderAsync(System.String,System.Boolean,System.Threading.CancellationToken)">
  4662. <summary>
  4663. Gets the folder for the specified path.
  4664. </summary>
  4665. <returns>The folder.</returns>
  4666. <param name="path">The folder path.</param>
  4667. <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
  4668. <param name="cancellationToken">The cancellation token.</param>
  4669. </member>
  4670. <member name="M:MailKit.Net.Imap.ImapEngine.GetFoldersAsync(MailKit.FolderNamespace,MailKit.StatusItems,System.Boolean,System.Boolean,System.Threading.CancellationToken)">
  4671. <summary>
  4672. Get all of the folders within the specified namespace.
  4673. </summary>
  4674. <remarks>
  4675. Gets all of the folders within the specified namespace.
  4676. </remarks>
  4677. <returns>The list of folders.</returns>
  4678. <param name="namespace">The namespace.</param>
  4679. <param name="items">The status items to pre-populate.</param>
  4680. <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
  4681. <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
  4682. <param name="cancellationToken">The cancellation token.</param>
  4683. </member>
  4684. <member name="M:MailKit.Net.Imap.ImapEngine.DecodeMailboxName(System.String)">
  4685. <summary>
  4686. Decodes the name of the mailbox.
  4687. </summary>
  4688. <returns>The mailbox name.</returns>
  4689. <param name="encodedName">The encoded name.</param>
  4690. </member>
  4691. <member name="M:MailKit.Net.Imap.ImapEngine.EncodeMailboxName(System.String)">
  4692. <summary>
  4693. Encodes the name of the mailbox.
  4694. </summary>
  4695. <returns>The mailbox name.</returns>
  4696. <param name="mailboxName">The encoded mailbox name.</param>
  4697. </member>
  4698. <member name="M:MailKit.Net.Imap.ImapEngine.IsValidMailboxName(System.String,System.Char)">
  4699. <summary>
  4700. Determines whether the mailbox name is valid or not.
  4701. </summary>
  4702. <returns><c>true</c> if the mailbox name is valid; otherwise, <c>false</c>.</returns>
  4703. <param name="mailboxName">The mailbox name.</param>
  4704. <param name="delim">The path delimeter.</param>
  4705. </member>
  4706. <member name="E:MailKit.Net.Imap.ImapEngine.Alert">
  4707. <summary>
  4708. Occurs when the engine receives an alert message from the server.
  4709. </summary>
  4710. </member>
  4711. <member name="E:MailKit.Net.Imap.ImapEngine.FolderCreated">
  4712. <summary>
  4713. Occurs when the engine receives a notification that a folder has been created.
  4714. </summary>
  4715. </member>
  4716. <member name="E:MailKit.Net.Imap.ImapEngine.MetadataChanged">
  4717. <summary>
  4718. Occurs when the engine receives a notification that metadata has changed.
  4719. </summary>
  4720. </member>
  4721. <member name="E:MailKit.Net.Imap.ImapEngine.NotificationOverflow">
  4722. <summary>
  4723. Occurs when the engine receives a notification overflow message from the server.
  4724. </summary>
  4725. </member>
  4726. <member name="M:MailKit.Net.Imap.ImapEngine.Dispose">
  4727. <summary>
  4728. Releases all resource used by the <see cref="T:MailKit.Net.Imap.ImapEngine"/> object.
  4729. </summary>
  4730. <remarks>Call <see cref="M:MailKit.Net.Imap.ImapEngine.Dispose"/> when you are finished using the <see cref="T:MailKit.Net.Imap.ImapEngine"/>. The
  4731. <see cref="M:MailKit.Net.Imap.ImapEngine.Dispose"/> method leaves the <see cref="T:MailKit.Net.Imap.ImapEngine"/> in an unusable state. After
  4732. calling <see cref="M:MailKit.Net.Imap.ImapEngine.Dispose"/>, you must release all references to the <see cref="T:MailKit.Net.Imap.ImapEngine"/> so
  4733. the garbage collector can reclaim the memory that the <see cref="T:MailKit.Net.Imap.ImapEngine"/> was occupying.</remarks>
  4734. </member>
  4735. <member name="T:MailKit.Net.Imap.ImapEventGroup">
  4736. <summary>
  4737. An IMAP event group used with the NOTIFY command.
  4738. </summary>
  4739. <remarks>
  4740. An IMAP event group used with the NOTIFY command.
  4741. </remarks>
  4742. </member>
  4743. <member name="M:MailKit.Net.Imap.ImapEventGroup.#ctor(MailKit.Net.Imap.ImapMailboxFilter,System.Collections.Generic.IList{MailKit.Net.Imap.ImapEvent})">
  4744. <summary>
  4745. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapEventGroup"/> class.
  4746. </summary>
  4747. <remarks>
  4748. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapEventGroup"/> class.
  4749. </remarks>
  4750. <param name="mailboxFilter">The mailbox filter.</param>
  4751. <param name="events">The list of IMAP events.</param>
  4752. <exception cref="T:System.ArgumentNullException">
  4753. <para><paramref name="mailboxFilter"/> is <c>null</c>.</para>
  4754. <para>-or-</para>
  4755. <para><paramref name="events"/> is <c>null</c>.</para>
  4756. </exception>
  4757. </member>
  4758. <member name="P:MailKit.Net.Imap.ImapEventGroup.MailboxFilter">
  4759. <summary>
  4760. Get the mailbox filter.
  4761. </summary>
  4762. <remarks>
  4763. Gets the mailbox filter.
  4764. </remarks>
  4765. <value>The mailbox filter.</value>
  4766. </member>
  4767. <member name="P:MailKit.Net.Imap.ImapEventGroup.Events">
  4768. <summary>
  4769. Get the list of IMAP events.
  4770. </summary>
  4771. <remarks>
  4772. Gets the list of IMAP events.
  4773. </remarks>
  4774. <value>The events.</value>
  4775. </member>
  4776. <member name="M:MailKit.Net.Imap.ImapEventGroup.Format(MailKit.Net.Imap.ImapEngine,System.Text.StringBuilder,System.Collections.Generic.IList{System.Object},System.Boolean@)">
  4777. <summary>
  4778. Format the IMAP NOTIFY command for this particular IMAP event group.
  4779. </summary>
  4780. <remarks>
  4781. Formats the IMAP NOTIFY command for this particular IMAP event group.
  4782. </remarks>
  4783. <param name="engine">The IMAP engine.</param>
  4784. <param name="command">The IMAP command builder.</param>
  4785. <param name="args">The IMAP command argument builder.</param>
  4786. <param name="notifySelectedNewExpunge">Gets set to <c>true</c> if the NOTIFY command requests the MessageNew or
  4787. MessageExpunged events for a SELECTED or SELECTED-DELAYED mailbox filter; otherwise it is left unchanged.</param>
  4788. </member>
  4789. <member name="T:MailKit.Net.Imap.ImapMailboxFilter">
  4790. <summary>
  4791. An IMAP mailbox filter for use with the NOTIFY command.
  4792. </summary>
  4793. <remarks>
  4794. An IMAP mailbox filter for use with the NOTIFY command.
  4795. </remarks>
  4796. </member>
  4797. <member name="F:MailKit.Net.Imap.ImapMailboxFilter.Selected">
  4798. <summary>
  4799. An IMAP mailbox filter specifying that the client wants immediate notifications for
  4800. the currently selected folder.
  4801. </summary>
  4802. <remarks>
  4803. The <c>SELECTED</c> mailbox specifier requires the server to send immediate
  4804. notifications for the currently selected mailbox about all specified
  4805. message events.
  4806. </remarks>
  4807. </member>
  4808. <member name="F:MailKit.Net.Imap.ImapMailboxFilter.SelectedDelayed">
  4809. <summary>
  4810. An IMAP mailbox filter specifying the currently selected folder but delays notifications
  4811. until a command has been issued.
  4812. </summary>
  4813. <remarks>
  4814. The <c>SELECTED-DELAYED</c> mailbox specifier requires the server to delay a
  4815. <see cref="F:MailKit.Net.Imap.ImapEvent.MessageExpunge"/> event until the client issues a command that allows
  4816. returning information about expunged messages (see
  4817. <a href="https://tools.ietf.org/html/rfc3501#section-7.4.1">Section 7.4.1 of RFC3501]</a>
  4818. for more details), for example, till a <c>NOOP</c> or an <c>IDLE</c> command has been issued.
  4819. When <c>SELECTED-DELAYED</c> is specified, the server MAY also delay returning other message
  4820. events until the client issues one of the commands specified above, or it MAY return them
  4821. immediately.
  4822. </remarks>
  4823. </member>
  4824. <member name="F:MailKit.Net.Imap.ImapMailboxFilter.Inboxes">
  4825. <summary>
  4826. An IMAP mailbox filter specifying the currently selected folder.
  4827. </summary>
  4828. <remarks>
  4829. <para>The <c>INBOXES</c> mailbox specifier refers to all selectable mailboxes in the user's
  4830. personal namespace(s) to which messages may be delivered by a Message Delivery Agent (MDA).
  4831. </para>
  4832. <para>If the IMAP server cannot easily compute this set, it MUST treat <see cref="F:MailKit.Net.Imap.ImapMailboxFilter.Inboxes"/>
  4833. as equivalent to <see cref="F:MailKit.Net.Imap.ImapMailboxFilter.Personal"/>.</para>
  4834. </remarks>
  4835. </member>
  4836. <member name="F:MailKit.Net.Imap.ImapMailboxFilter.Personal">
  4837. <summary>
  4838. An IMAP mailbox filter specifying all selectable folders within the user's personal namespace.
  4839. </summary>
  4840. <remarks>
  4841. The <c>PERSONAL</c> mailbox specifier refers to all selectable folders within the user's personal namespace.
  4842. </remarks>
  4843. </member>
  4844. <member name="F:MailKit.Net.Imap.ImapMailboxFilter.Subscribed">
  4845. <summary>
  4846. An IMAP mailbox filter that refers to all subscribed folders.
  4847. </summary>
  4848. <remarks>
  4849. <para>The <c>SUBSCRIBED</c> mailbox specifier refers to all folders subscribed to by the user.</para>
  4850. <para>If the subscription list changes, the server MUST reevaluate the list.</para>
  4851. </remarks>
  4852. </member>
  4853. <member name="T:MailKit.Net.Imap.ImapMailboxFilter.Mailboxes">
  4854. <summary>
  4855. An IMAP mailbox filter that specifies a list of folders to receive notifications about.
  4856. </summary>
  4857. <remarks>
  4858. An IMAP mailbox filter that specifies a list of folders to receive notifications about.
  4859. </remarks>
  4860. </member>
  4861. <member name="M:MailKit.Net.Imap.ImapMailboxFilter.Mailboxes.#ctor(System.Collections.Generic.IList{MailKit.IMailFolder})">
  4862. <summary>
  4863. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapMailboxFilter.Mailboxes"/> class.
  4864. </summary>
  4865. <remarks>
  4866. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapMailboxFilter.Mailboxes"/> class.
  4867. </remarks>
  4868. <param name="folders">The list of folders to watch for events.</param>
  4869. <exception cref="T:System.ArgumentNullException">
  4870. <paramref name="folders"/> is <c>null</c>.
  4871. </exception>
  4872. <exception cref="T:System.ArgumentException">
  4873. <para>The list of <paramref name="folders"/> is empty.</para>
  4874. <para>-or-</para>
  4875. <para>The list of <paramref name="folders"/> contains folders that are not of
  4876. type <see cref="T:MailKit.Net.Imap.ImapFolder"/>.</para>
  4877. </exception>
  4878. </member>
  4879. <member name="M:MailKit.Net.Imap.ImapMailboxFilter.Mailboxes.#ctor(MailKit.IMailFolder[])">
  4880. <summary>
  4881. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapMailboxFilter.Mailboxes"/> class.
  4882. </summary>
  4883. <remarks>
  4884. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapMailboxFilter.Mailboxes"/> class.
  4885. </remarks>
  4886. <param name="folders">The list of folders to watch for events.</param>
  4887. <exception cref="T:System.ArgumentNullException">
  4888. <paramref name="folders"/> is <c>null</c>.
  4889. </exception>
  4890. <exception cref="T:System.ArgumentException">
  4891. <para>The list of <paramref name="folders"/> is empty.</para>
  4892. <para>-or-</para>
  4893. <para>The list of <paramref name="folders"/> contains folders that are not of
  4894. type <see cref="T:MailKit.Net.Imap.ImapFolder"/>.</para>
  4895. </exception>
  4896. </member>
  4897. <member name="M:MailKit.Net.Imap.ImapMailboxFilter.Mailboxes.#ctor(System.String,System.Collections.Generic.IList{MailKit.IMailFolder})">
  4898. <summary>
  4899. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapMailboxFilter.Mailboxes"/> class.
  4900. </summary>
  4901. <remarks>
  4902. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapMailboxFilter.Mailboxes"/> class.
  4903. </remarks>
  4904. <param name="name">The name of the mailbox filter.</param>
  4905. <param name="folders">The list of folders to watch for events.</param>
  4906. <exception cref="T:System.ArgumentNullException">
  4907. <paramref name="folders"/> is <c>null</c>.
  4908. </exception>
  4909. <exception cref="T:System.ArgumentException">
  4910. <para>The list of <paramref name="folders"/> is empty.</para>
  4911. <para>-or-</para>
  4912. <para>The list of <paramref name="folders"/> contains folders that are not of
  4913. type <see cref="T:MailKit.Net.Imap.ImapFolder"/>.</para>
  4914. </exception>
  4915. </member>
  4916. <member name="M:MailKit.Net.Imap.ImapMailboxFilter.Mailboxes.Format(MailKit.Net.Imap.ImapEngine,System.Text.StringBuilder,System.Collections.Generic.IList{System.Object})">
  4917. <summary>
  4918. Format the IMAP NOTIFY command for this particular IMAP mailbox filter.
  4919. </summary>
  4920. <remarks>
  4921. Formats the IMAP NOTIFY command for this particular IMAP mailbox filter.
  4922. </remarks>
  4923. <param name="engine">The IMAP engine.</param>
  4924. <param name="command">The IMAP command builder.</param>
  4925. <param name="args">The IMAP command argument builder.</param>
  4926. </member>
  4927. <member name="T:MailKit.Net.Imap.ImapMailboxFilter.Subtree">
  4928. <summary>
  4929. An IMAP mailbox filter that specifies a list of folder subtrees to get notifications about.
  4930. </summary>
  4931. <remarks>
  4932. <para>The client will receive notifications for each specified folder plus all selectable
  4933. folders that are subordinate to any of the specified folders.</para>
  4934. </remarks>
  4935. </member>
  4936. <member name="M:MailKit.Net.Imap.ImapMailboxFilter.Subtree.#ctor(System.Collections.Generic.IList{MailKit.IMailFolder})">
  4937. <summary>
  4938. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapMailboxFilter.Subtree"/> class.
  4939. </summary>
  4940. <remarks>
  4941. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapMailboxFilter.Subtree"/> class.
  4942. </remarks>
  4943. <param name="folders">The list of folders to watch for events.</param>
  4944. <exception cref="T:System.ArgumentNullException">
  4945. <paramref name="folders"/> is <c>null</c>.
  4946. </exception>
  4947. <exception cref="T:System.ArgumentException">
  4948. <para>The list of <paramref name="folders"/> is empty.</para>
  4949. <para>-or-</para>
  4950. <para>The list of <paramref name="folders"/> contains folders that are not of
  4951. type <see cref="T:MailKit.Net.Imap.ImapFolder"/>.</para>
  4952. </exception>
  4953. </member>
  4954. <member name="M:MailKit.Net.Imap.ImapMailboxFilter.Subtree.#ctor(MailKit.IMailFolder[])">
  4955. <summary>
  4956. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapMailboxFilter.Subtree"/> class.
  4957. </summary>
  4958. <remarks>
  4959. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapMailboxFilter.Subtree"/> class.
  4960. </remarks>
  4961. <param name="folders">The list of folders to watch for events.</param>
  4962. <exception cref="T:System.ArgumentNullException">
  4963. <paramref name="folders"/> is <c>null</c>.
  4964. </exception>
  4965. <exception cref="T:System.ArgumentException">
  4966. <para>The list of <paramref name="folders"/> is empty.</para>
  4967. <para>-or-</para>
  4968. <para>The list of <paramref name="folders"/> contains folders that are not of
  4969. type <see cref="T:MailKit.Net.Imap.ImapFolder"/>.</para>
  4970. </exception>
  4971. </member>
  4972. <member name="M:MailKit.Net.Imap.ImapMailboxFilter.#ctor(System.String)">
  4973. <summary>
  4974. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapMailboxFilter"/> class.
  4975. </summary>
  4976. <remarks>
  4977. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapMailboxFilter"/> class.
  4978. </remarks>
  4979. <param name="name">The name of the mailbox filter.</param>
  4980. </member>
  4981. <member name="P:MailKit.Net.Imap.ImapMailboxFilter.Name">
  4982. <summary>
  4983. Get the name of the mailbox filter.
  4984. </summary>
  4985. <remarks>
  4986. Gets the name of the mailbox filter.
  4987. </remarks>
  4988. <value>The name.</value>
  4989. </member>
  4990. <member name="M:MailKit.Net.Imap.ImapMailboxFilter.Format(MailKit.Net.Imap.ImapEngine,System.Text.StringBuilder,System.Collections.Generic.IList{System.Object})">
  4991. <summary>
  4992. Format the IMAP NOTIFY command for this particular IMAP mailbox filter.
  4993. </summary>
  4994. <remarks>
  4995. Formats the IMAP NOTIFY command for this particular IMAP mailbox filter.
  4996. </remarks>
  4997. <param name="engine">The IMAP engine.</param>
  4998. <param name="command">The IMAP command builder.</param>
  4999. <param name="args">The IMAP command argument builder.</param>
  5000. </member>
  5001. <member name="T:MailKit.Net.Imap.ImapEvent">
  5002. <summary>
  5003. An IMAP notification event.
  5004. </summary>
  5005. <remarks>
  5006. An IMAP notification event.
  5007. </remarks>
  5008. </member>
  5009. <member name="F:MailKit.Net.Imap.ImapEvent.MessageExpunge">
  5010. <summary>
  5011. An IMAP event notification for expunged messages.
  5012. </summary>
  5013. <remarks>
  5014. <para>If the expunged message or messages are in the selected mailbox, the server notifies the client
  5015. using <see cref="E:MailKit.IMailFolder.MessageExpunged"/> (or <see cref="E:MailKit.IMailFolder.MessagesVanished"/> if
  5016. the <a href="https://tools.ietf.org/html/rfc5162">QRESYNC</a> extension has been enabled via
  5017. <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/> or
  5018. <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResyncAsync(System.Threading.CancellationToken)"/>).</para>
  5019. <para>If the expunged message or messages are in another mailbox, the <see cref="P:MailKit.IMailFolder.UidNext"/>
  5020. and <see cref="P:MailKit.IMailFolder.Count"/> properties will be updated and the appropriate
  5021. <see cref="E:MailKit.IMailFolder.UidNextChanged"/> and <see cref="E:MailKit.IMailFolder.CountChanged"/> events will be
  5022. emitted for the relevant folder. If the <a href="https://tools.ietf.org/html/rfc5162">QRESYNC</a>
  5023. extension is enabled, the <see cref="P:MailKit.IMailFolder.HighestModSeq"/> property will also be updated and
  5024. the <see cref="E:MailKit.IMailFolder.HighestModSeqChanged"/> event will be emitted.</para>
  5025. <note type="note">if a client requests <see cref="F:MailKit.Net.Imap.ImapEvent.MessageExpunge"/> with the <see cref="F:MailKit.Net.Imap.ImapMailboxFilter.Selected"/>
  5026. mailbox specifier, the meaning of a message index can change at any time, so the client cannot use
  5027. message indexes in commands anymore. The client MUST use API variants that take <see cref="T:MailKit.UniqueId"/> or
  5028. a <see cref="T:System.Collections.Generic.IList`1"/>. The meaning of <c>*</c>* can also change when messages are added or expunged.
  5029. A client wishing to keep using message indexes can either use the <see cref="F:MailKit.Net.Imap.ImapMailboxFilter.SelectedDelayed"/>
  5030. mailbox specifier or can avoid using the <see cref="F:MailKit.Net.Imap.ImapEvent.MessageExpunge"/> event entirely.</note>
  5031. </remarks>
  5032. </member>
  5033. <member name="F:MailKit.Net.Imap.ImapEvent.FlagChange">
  5034. <summary>
  5035. An IMAP event notification for message flag changes.
  5036. </summary>
  5037. <remarks>
  5038. <para>If the <see cref="F:MailKit.Net.Imap.ImapEvent.FlagChange"/> notification arrives for a message located in the currently selected
  5039. folder, then that folder will emit a <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> event as well as a
  5040. <see cref="E:MailKit.IMailFolder.MessageSummaryFetched"/> event with an appropriately populated
  5041. <see cref="T:MailKit.IMessageSummary"/>.</para>
  5042. <para>On the other hand, if the <see cref="F:MailKit.Net.Imap.ImapEvent.FlagChange"/> notification arrives for a message that is not
  5043. located in the currently selected folder, then the events that are emitted will depend on the
  5044. <see cref="T:MailKit.Net.Imap.ImapCapabilities"/> of the IMAP server.</para>
  5045. <para>If the server supports the <see cref="F:MailKit.Net.Imap.ImapCapabilities.CondStore"/> capability (or the
  5046. <see cref="F:MailKit.Net.Imap.ImapCapabilities.QuickResync"/> capability and the client has enabled it via
  5047. <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>), then the
  5048. <see cref="E:MailKit.IMailFolder.HighestModSeqChanged"/> event will be emitted as well as the
  5049. <see cref="E:MailKit.IMailFolder.UidValidityChanged"/> event (if the latter has changed). If the number of
  5050. seen messages has changed, then the <see cref="E:MailKit.IMailFolder.UnreadChanged"/> event may also be emitted.</para>
  5051. <para>If the server does not support either the <see cref="F:MailKit.Net.Imap.ImapCapabilities.CondStore"/> capability nor
  5052. the <see cref="F:MailKit.Net.Imap.ImapCapabilities.QuickResync"/> capability and the client has not enabled the later capability
  5053. via <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>, then the server may choose
  5054. only to notify the client of <see cref="P:MailKit.IMailFolder.UidValidity"/> changes by emitting the
  5055. <see cref="E:MailKit.IMailFolder.UidValidityChanged"/> event.</para>
  5056. </remarks>
  5057. </member>
  5058. <member name="F:MailKit.Net.Imap.ImapEvent.AnnotationChange">
  5059. <summary>
  5060. An IMAP event notification for message annotation changes.
  5061. </summary>
  5062. <remarks>
  5063. <para>If the <see cref="F:MailKit.Net.Imap.ImapEvent.AnnotationChange"/> notification arrives for a message located in the currently selected
  5064. folder, then that folder will emit a <see cref="E:MailKit.IMailFolder.AnnotationsChanged"/> event as well as a
  5065. <see cref="E:MailKit.IMailFolder.MessageSummaryFetched"/> event with an appropriately populated
  5066. <see cref="T:MailKit.IMessageSummary"/>.</para>
  5067. <para>On the other hand, if the <see cref="F:MailKit.Net.Imap.ImapEvent.AnnotationChange"/> notification arrives for a message that is not
  5068. located in the currently selected folder, then the events that are emitted will depend on the
  5069. <see cref="T:MailKit.Net.Imap.ImapCapabilities"/> of the IMAP server.</para>
  5070. <para>If the server supports the <see cref="F:MailKit.Net.Imap.ImapCapabilities.CondStore"/> capability (or the
  5071. <see cref="F:MailKit.Net.Imap.ImapCapabilities.QuickResync"/> capability and the client has enabled it via
  5072. <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>), then the
  5073. <see cref="E:MailKit.IMailFolder.HighestModSeqChanged"/> event will be emitted as well as the
  5074. <see cref="E:MailKit.IMailFolder.UidValidityChanged"/> event (if the latter has changed). If the number of
  5075. seen messages has changed, then the <see cref="E:MailKit.IMailFolder.UnreadChanged"/> event may also be emitted.</para>
  5076. <para>If the server does not support either the <see cref="F:MailKit.Net.Imap.ImapCapabilities.CondStore"/> capability nor
  5077. the <see cref="F:MailKit.Net.Imap.ImapCapabilities.QuickResync"/> capability and the client has not enabled the later capability
  5078. via <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>, then the server may choose
  5079. only to notify the client of <see cref="P:MailKit.IMailFolder.UidValidity"/> changes by emitting the
  5080. <see cref="E:MailKit.IMailFolder.UidValidityChanged"/> event.</para>
  5081. </remarks>
  5082. </member>
  5083. <member name="F:MailKit.Net.Imap.ImapEvent.MailboxName">
  5084. <summary>
  5085. AN IMAP event notification for folders that have been created, deleted, or renamed.
  5086. </summary>
  5087. <remarks>
  5088. <para>These notifications are sent if an affected mailbox name was created, deleted, or renamed.</para>
  5089. <para>As these notifications are received by the client, the apropriate will be emitted:
  5090. <see cref="E:MailKit.MailStore.FolderCreated"/>, <see cref="E:MailKit.IMailFolder.Deleted"/>, or
  5091. <see cref="E:MailKit.IMailFolder.Renamed"/>, respectively.</para>
  5092. <note type="info">If the server supports <see cref="F:MailKit.Net.Imap.ImapCapabilities.Acl"/>, granting or revocation of the
  5093. <see cref="F:MailKit.AccessRight.LookupFolder"/> right to the current user on the affected folder will also be
  5094. considered folder creation or deletion, respectively. If a folder is created or deleted, the folder itself
  5095. and its direct parent (whether it is an existing folder or not) are considered to be affected.</note>
  5096. </remarks>
  5097. </member>
  5098. <member name="F:MailKit.Net.Imap.ImapEvent.SubscriptionChange">
  5099. <summary>
  5100. An IMAP event notification for folders who have had their subscription status changed.
  5101. </summary>
  5102. <remarks>
  5103. <para>This event requests that the server notifies the client of any subscription changes,
  5104. causing the <see cref="E:MailKit.IMailFolder.Subscribed"/> or <see cref="E:MailKit.IMailFolder.Unsubscribed"/>
  5105. events to be emitted accordingly on the affected <see cref="T:MailKit.IMailFolder"/>.</para>
  5106. </remarks>
  5107. </member>
  5108. <member name="F:MailKit.Net.Imap.ImapEvent.MailboxMetadataChange">
  5109. <summary>
  5110. An IMAP event notification for changes to folder metadata.
  5111. </summary>
  5112. <remarks>
  5113. <para>Support for this event type is OPTIONAL unless <see cref="F:MailKit.Net.Imap.ImapCapabilities.Metadata"/> is supported
  5114. by the server, in which case support for this event type is REQUIRED.</para>
  5115. <para>If the server does support this event, then the <see cref="E:MailKit.IMailFolder.MetadataChanged"/> event
  5116. will be emitted whenever metadata changes for any folder included in the <see cref="T:MailKit.Net.Imap.ImapMailboxFilter"/>.</para>
  5117. </remarks>
  5118. </member>
  5119. <member name="F:MailKit.Net.Imap.ImapEvent.ServerMetadataChange">
  5120. <summary>
  5121. An IMAP event notification for changes to server metadata.
  5122. </summary>
  5123. <remarks>
  5124. <para>Support for this event type is OPTIONAL unless <see cref="F:MailKit.Net.Imap.ImapCapabilities.Metadata"/> is supported
  5125. by the server, in which case support for this event type is REQUIRED.</para>
  5126. <para>If the server does support this event, then the <see cref="E:MailKit.IMailStore.MetadataChanged"/> event
  5127. will be emitted whenever metadata changes.</para>
  5128. </remarks>
  5129. </member>
  5130. <member name="M:MailKit.Net.Imap.ImapEvent.#ctor(System.String,System.Boolean)">
  5131. <summary>
  5132. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapEvent"/> class.
  5133. </summary>
  5134. <remarks>
  5135. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapEvent"/> class.
  5136. </remarks>
  5137. <param name="name">The name of the IMAP event.</param>
  5138. <param name="isMessageEvent"><c>true</c> if the event is a message event; otherwise, <c>false</c>.</param>
  5139. </member>
  5140. <member name="P:MailKit.Net.Imap.ImapEvent.IsMessageEvent">
  5141. <summary>
  5142. Get whether or not this <see cref="T:MailKit.Net.Imap.ImapEvent"/> is a message event.
  5143. </summary>
  5144. <remarks>
  5145. Gets whether or not this <see cref="T:MailKit.Net.Imap.ImapEvent"/> is a message event.
  5146. </remarks>
  5147. <value><c>true</c> if is message event; otherwise, <c>false</c>.</value>
  5148. </member>
  5149. <member name="P:MailKit.Net.Imap.ImapEvent.Name">
  5150. <summary>
  5151. Get the name of the IMAP event.
  5152. </summary>
  5153. <remarks>
  5154. Gets the name of the IMAP event.
  5155. </remarks>
  5156. <value>The name of the IMAP event.</value>
  5157. </member>
  5158. <member name="M:MailKit.Net.Imap.ImapEvent.Format(MailKit.Net.Imap.ImapEngine,System.Text.StringBuilder,System.Collections.Generic.IList{System.Object},System.Boolean)">
  5159. <summary>
  5160. Format the IMAP NOTIFY command for this particular IMAP mailbox filter.
  5161. </summary>
  5162. <remarks>
  5163. Formats the IMAP NOTIFY command for this particular IMAP mailbox filter.
  5164. </remarks>
  5165. <param name="engine">The IMAP engine.</param>
  5166. <param name="command">The IMAP command builder.</param>
  5167. <param name="args">The IMAP command argument builder.</param>
  5168. <param name="isSelectedFilter"><c>true</c> if the event is being registered for a
  5169. <see cref="F:MailKit.Net.Imap.ImapMailboxFilter.Selected"/> or <see cref="F:MailKit.Net.Imap.ImapMailboxFilter.SelectedDelayed"/>
  5170. mailbox filter.</param>
  5171. </member>
  5172. <member name="T:MailKit.Net.Imap.ImapEvent.MessageNew">
  5173. <summary>
  5174. An IMAP event notification for new or appended messages.
  5175. </summary>
  5176. <remarks>
  5177. <para>An IMAP event notification for new or appended messages.</para>
  5178. <para>If the new or appended message is in the selected folder, the folder will emit the
  5179. <see cref="E:MailKit.IMailFolder.CountChanged"/> event, followed by a
  5180. <see cref="E:MailKit.IMailFolder.MessageSummaryFetched"/> event containing the information requested by the client.</para>
  5181. <note type="note">These events will not be emitted for any message created by the client on this particular folder
  5182. as a result of, for example, a call to
  5183. <see cref="M:MailKit.IMailFolder.Append(MimeKit.MimeMessage,MailKit.MessageFlags,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>
  5184. or <see cref="M:MailKit.IMailFolder.CopyTo(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.IMailFolder,System.Threading.CancellationToken)"/>.</note>
  5185. </remarks>
  5186. </member>
  5187. <member name="M:MailKit.Net.Imap.ImapEvent.MessageNew.#ctor(MailKit.MessageSummaryItems)">
  5188. <summary>
  5189. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapEvent.MessageNew"/> class.
  5190. </summary>
  5191. <remarks>
  5192. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapEvent.MessageNew"/> class.
  5193. </remarks>
  5194. <param name="items">The message summary items to automatically retrieve for new messages.</param>
  5195. </member>
  5196. <member name="M:MailKit.Net.Imap.ImapEvent.MessageNew.#ctor(MailKit.MessageSummaryItems,System.Collections.Generic.HashSet{MimeKit.HeaderId})">
  5197. <summary>
  5198. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapEvent.MessageNew"/> class.
  5199. </summary>
  5200. <remarks>
  5201. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapEvent.MessageNew"/> class.
  5202. </remarks>
  5203. <param name="items">The message summary items to automatically retrieve for new messages.</param>
  5204. <param name="headers">Additional message headers to retrieve for new messages.</param>
  5205. </member>
  5206. <member name="M:MailKit.Net.Imap.ImapEvent.MessageNew.#ctor(MailKit.MessageSummaryItems,System.Collections.Generic.HashSet{System.String})">
  5207. <summary>
  5208. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapEvent.MessageNew"/> class.
  5209. </summary>
  5210. <remarks>
  5211. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapEvent.MessageNew"/> class.
  5212. </remarks>
  5213. <param name="items">The message summary items to automatically retrieve for new messages.</param>
  5214. <param name="headers">Additional message headers to retrieve for new messages.</param>
  5215. </member>
  5216. <member name="M:MailKit.Net.Imap.ImapEvent.MessageNew.Format(MailKit.Net.Imap.ImapEngine,System.Text.StringBuilder,System.Collections.Generic.IList{System.Object},System.Boolean)">
  5217. <summary>
  5218. Format the IMAP NOTIFY command for this particular IMAP mailbox filter.
  5219. </summary>
  5220. <remarks>
  5221. Formats the IMAP NOTIFY command for this particular IMAP mailbox filter.
  5222. </remarks>
  5223. <param name="engine">The IMAP engine.</param>
  5224. <param name="command">The IMAP command builder.</param>
  5225. <param name="args">The IMAP command argument builder.</param>
  5226. <param name="isSelectedFilter"><c>true</c> if the event is being registered for a
  5227. <see cref="F:MailKit.Net.Imap.ImapMailboxFilter.Selected"/> or <see cref="F:MailKit.Net.Imap.ImapMailboxFilter.SelectedDelayed"/>
  5228. mailbox filter.</param>
  5229. </member>
  5230. <member name="T:MailKit.Net.Imap.ImapFolder">
  5231. <summary>
  5232. An IMAP folder.
  5233. </summary>
  5234. <remarks>
  5235. An IMAP folder.
  5236. </remarks>
  5237. <example>
  5238. <code language="c#" source="Examples\ImapExamples.cs" region="DownloadMessages"/>
  5239. </example>
  5240. <example>
  5241. <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
  5242. </example>
  5243. </member>
  5244. <member name="M:MailKit.Net.Imap.ImapFolder.#ctor(MailKit.Net.Imap.ImapFolderConstructorArgs)">
  5245. <summary>
  5246. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapFolder"/> class.
  5247. </summary>
  5248. <remarks>
  5249. <para>Creates a new <see cref="T:MailKit.Net.Imap.ImapFolder"/>.</para>
  5250. <para>If you subclass <see cref="T:MailKit.Net.Imap.ImapFolder"/>, you will also need to subclass
  5251. <see cref="T:MailKit.Net.Imap.ImapClient"/> and override the
  5252. <see cref="M:MailKit.Net.Imap.ImapClient.CreateImapFolder(MailKit.Net.Imap.ImapFolderConstructorArgs)"/>
  5253. method in order to return a new instance of your ImapFolder subclass.</para>
  5254. </remarks>
  5255. <param name="args">The constructor arguments.</param>
  5256. <exception cref="T:System.ArgumentNullException">
  5257. <paramref name="args"/> is <c>null</c>.
  5258. </exception>
  5259. </member>
  5260. <member name="P:MailKit.Net.Imap.ImapFolder.Engine">
  5261. <summary>
  5262. Get the IMAP command engine.
  5263. </summary>
  5264. <remarks>
  5265. Gets the IMAP command engine.
  5266. </remarks>
  5267. <value>The engine.</value>
  5268. </member>
  5269. <member name="P:MailKit.Net.Imap.ImapFolder.EncodedName">
  5270. <summary>
  5271. Get the encoded name of the folder.
  5272. </summary>
  5273. <remarks>
  5274. Gets the encoded name of the folder.
  5275. </remarks>
  5276. <value>The encoded name.</value>
  5277. </member>
  5278. <member name="P:MailKit.Net.Imap.ImapFolder.SyncRoot">
  5279. <summary>
  5280. Gets an object that can be used to synchronize access to the IMAP server.
  5281. </summary>
  5282. <remarks>
  5283. <para>Gets an object that can be used to synchronize access to the IMAP server.</para>
  5284. <para>When using the non-Async methods from multiple threads, it is important to lock the
  5285. <see cref="P:MailKit.Net.Imap.ImapFolder.SyncRoot"/> object for thread safety when using the synchronous methods.</para>
  5286. </remarks>
  5287. <value>The lock object.</value>
  5288. </member>
  5289. <member name="M:MailKit.Net.Imap.ImapFolder.OnParentFolderRenamed">
  5290. <summary>
  5291. Notifies the folder that a parent folder has been renamed.
  5292. </summary>
  5293. <remarks>
  5294. Updates the <see cref="P:MailKit.MailFolder.FullName"/> property.
  5295. </remarks>
  5296. </member>
  5297. <member name="P:MailKit.Net.Imap.ImapFolder.IsOpen">
  5298. <summary>
  5299. Gets a value indicating whether the folder is currently open.
  5300. </summary>
  5301. <remarks>
  5302. Gets a value indicating whether the folder is currently open.
  5303. </remarks>
  5304. <value><c>true</c> if the folder is currently open; otherwise, <c>false</c>.</value>
  5305. </member>
  5306. <member name="M:MailKit.Net.Imap.ImapFolder.Open(MailKit.FolderAccess,System.UInt32,System.UInt64,System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)">
  5307. <summary>
  5308. Open the folder using the requested folder access.
  5309. </summary>
  5310. <remarks>
  5311. <para>This variant of the <see cref="M:MailKit.Net.Imap.ImapFolder.Open(MailKit.FolderAccess,System.Threading.CancellationToken)"/>
  5312. method is meant for quick resynchronization of the folder. Before calling this method,
  5313. the <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/> method MUST be called.</para>
  5314. <para>You should also make sure to add listeners to the <see cref="E:MailKit.MailFolder.MessagesVanished"/> and
  5315. <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events to get notifications of changes since
  5316. the last time the folder was opened.</para>
  5317. </remarks>
  5318. <returns>The <see cref="T:MailKit.FolderAccess"/> state of the folder.</returns>
  5319. <param name="access">The requested folder access.</param>
  5320. <param name="uidValidity">The last known <see cref="P:MailKit.MailFolder.UidValidity"/> value.</param>
  5321. <param name="highestModSeq">The last known <see cref="P:MailKit.MailFolder.HighestModSeq"/> value.</param>
  5322. <param name="uids">The last known list of unique message identifiers.</param>
  5323. <param name="cancellationToken">The cancellation token.</param>
  5324. <exception cref="T:System.ArgumentOutOfRangeException">
  5325. <paramref name="access"/> is not a valid value.
  5326. </exception>
  5327. <exception cref="T:System.ObjectDisposedException">
  5328. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  5329. </exception>
  5330. <exception cref="T:MailKit.ServiceNotConnectedException">
  5331. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  5332. </exception>
  5333. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  5334. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  5335. </exception>
  5336. <exception cref="T:MailKit.FolderNotFoundException">
  5337. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
  5338. </exception>
  5339. <exception cref="T:System.InvalidOperationException">
  5340. The QRESYNC feature has not been enabled.
  5341. </exception>
  5342. <exception cref="T:System.NotSupportedException">
  5343. The IMAP server does not support the QRESYNC extension.
  5344. </exception>
  5345. <exception cref="T:System.OperationCanceledException">
  5346. The operation was canceled via the cancellation token.
  5347. </exception>
  5348. <exception cref="T:System.IO.IOException">
  5349. An I/O error occurred.
  5350. </exception>
  5351. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  5352. The server's response contained unexpected tokens.
  5353. </exception>
  5354. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  5355. The server replied with a NO or BAD response.
  5356. </exception>
  5357. </member>
  5358. <member name="M:MailKit.Net.Imap.ImapFolder.OpenAsync(MailKit.FolderAccess,System.UInt32,System.UInt64,System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)">
  5359. <summary>
  5360. Asynchronously open the folder using the requested folder access.
  5361. </summary>
  5362. <remarks>
  5363. <para>This variant of the <see cref="M:MailKit.Net.Imap.ImapFolder.Open(MailKit.FolderAccess,System.Threading.CancellationToken)"/>
  5364. method is meant for quick resynchronization of the folder. Before calling this method,
  5365. the <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/> method MUST be called.</para>
  5366. <para>You should also make sure to add listeners to the <see cref="E:MailKit.MailFolder.MessagesVanished"/> and
  5367. <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events to get notifications of changes since
  5368. the last time the folder was opened.</para>
  5369. </remarks>
  5370. <returns>The <see cref="T:MailKit.FolderAccess"/> state of the folder.</returns>
  5371. <param name="access">The requested folder access.</param>
  5372. <param name="uidValidity">The last known <see cref="P:MailKit.MailFolder.UidValidity"/> value.</param>
  5373. <param name="highestModSeq">The last known <see cref="P:MailKit.MailFolder.HighestModSeq"/> value.</param>
  5374. <param name="uids">The last known list of unique message identifiers.</param>
  5375. <param name="cancellationToken">The cancellation token.</param>
  5376. <exception cref="T:System.ArgumentOutOfRangeException">
  5377. <paramref name="access"/> is not a valid value.
  5378. </exception>
  5379. <exception cref="T:System.ObjectDisposedException">
  5380. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  5381. </exception>
  5382. <exception cref="T:MailKit.ServiceNotConnectedException">
  5383. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  5384. </exception>
  5385. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  5386. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  5387. </exception>
  5388. <exception cref="T:MailKit.FolderNotFoundException">
  5389. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
  5390. </exception>
  5391. <exception cref="T:System.InvalidOperationException">
  5392. The QRESYNC feature has not been enabled.
  5393. </exception>
  5394. <exception cref="T:System.NotSupportedException">
  5395. The IMAP server does not support the QRESYNC extension.
  5396. </exception>
  5397. <exception cref="T:System.OperationCanceledException">
  5398. The operation was canceled via the cancellation token.
  5399. </exception>
  5400. <exception cref="T:System.IO.IOException">
  5401. An I/O error occurred.
  5402. </exception>
  5403. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  5404. The server's response contained unexpected tokens.
  5405. </exception>
  5406. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  5407. The server replied with a NO or BAD response.
  5408. </exception>
  5409. </member>
  5410. <member name="M:MailKit.Net.Imap.ImapFolder.Open(MailKit.FolderAccess,System.Threading.CancellationToken)">
  5411. <summary>
  5412. Open the folder using the requested folder access.
  5413. </summary>
  5414. <remarks>
  5415. Opens the folder using the requested folder access.
  5416. </remarks>
  5417. <returns>The <see cref="T:MailKit.FolderAccess"/> state of the folder.</returns>
  5418. <param name="access">The requested folder access.</param>
  5419. <param name="cancellationToken">The cancellation token.</param>
  5420. <exception cref="T:System.ArgumentOutOfRangeException">
  5421. <paramref name="access"/> is not a valid value.
  5422. </exception>
  5423. <exception cref="T:System.ObjectDisposedException">
  5424. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  5425. </exception>
  5426. <exception cref="T:MailKit.ServiceNotConnectedException">
  5427. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  5428. </exception>
  5429. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  5430. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  5431. </exception>
  5432. <exception cref="T:MailKit.FolderNotFoundException">
  5433. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
  5434. </exception>
  5435. <exception cref="T:System.OperationCanceledException">
  5436. The operation was canceled via the cancellation token.
  5437. </exception>
  5438. <exception cref="T:System.IO.IOException">
  5439. An I/O error occurred.
  5440. </exception>
  5441. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  5442. The server's response contained unexpected tokens.
  5443. </exception>
  5444. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  5445. The server replied with a NO or BAD response.
  5446. </exception>
  5447. </member>
  5448. <member name="M:MailKit.Net.Imap.ImapFolder.OpenAsync(MailKit.FolderAccess,System.Threading.CancellationToken)">
  5449. <summary>
  5450. Asynchronously open the folder using the requested folder access.
  5451. </summary>
  5452. <remarks>
  5453. Opens the folder using the requested folder access.
  5454. </remarks>
  5455. <returns>The <see cref="T:MailKit.FolderAccess"/> state of the folder.</returns>
  5456. <param name="access">The requested folder access.</param>
  5457. <param name="cancellationToken">The cancellation token.</param>
  5458. <exception cref="T:System.ArgumentOutOfRangeException">
  5459. <paramref name="access"/> is not a valid value.
  5460. </exception>
  5461. <exception cref="T:System.ObjectDisposedException">
  5462. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  5463. </exception>
  5464. <exception cref="T:MailKit.ServiceNotConnectedException">
  5465. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  5466. </exception>
  5467. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  5468. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  5469. </exception>
  5470. <exception cref="T:MailKit.FolderNotFoundException">
  5471. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
  5472. </exception>
  5473. <exception cref="T:System.OperationCanceledException">
  5474. The operation was canceled via the cancellation token.
  5475. </exception>
  5476. <exception cref="T:System.IO.IOException">
  5477. An I/O error occurred.
  5478. </exception>
  5479. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  5480. The server's response contained unexpected tokens.
  5481. </exception>
  5482. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  5483. The server replied with a NO or BAD response.
  5484. </exception>
  5485. </member>
  5486. <member name="M:MailKit.Net.Imap.ImapFolder.Close(System.Boolean,System.Threading.CancellationToken)">
  5487. <summary>
  5488. Close the folder, optionally expunging the messages marked for deletion.
  5489. </summary>
  5490. <remarks>
  5491. Closes the folder, optionally expunging the messages marked for deletion.
  5492. </remarks>
  5493. <param name="expunge">If set to <c>true</c>, expunge.</param>
  5494. <param name="cancellationToken">The cancellation token.</param>
  5495. <exception cref="T:System.ObjectDisposedException">
  5496. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  5497. </exception>
  5498. <exception cref="T:MailKit.ServiceNotConnectedException">
  5499. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  5500. </exception>
  5501. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  5502. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  5503. </exception>
  5504. <exception cref="T:MailKit.FolderNotOpenException">
  5505. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  5506. </exception>
  5507. <exception cref="T:System.OperationCanceledException">
  5508. The operation was canceled via the cancellation token.
  5509. </exception>
  5510. <exception cref="T:System.IO.IOException">
  5511. An I/O error occurred.
  5512. </exception>
  5513. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  5514. The server's response contained unexpected tokens.
  5515. </exception>
  5516. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  5517. The server replied with a NO or BAD response.
  5518. </exception>
  5519. </member>
  5520. <member name="M:MailKit.Net.Imap.ImapFolder.CloseAsync(System.Boolean,System.Threading.CancellationToken)">
  5521. <summary>
  5522. Asynchronously close the folder, optionally expunging the messages marked for deletion.
  5523. </summary>
  5524. <remarks>
  5525. Closes the folder, optionally expunging the messages marked for deletion.
  5526. </remarks>
  5527. <returns>An asynchronous task context.</returns>
  5528. <param name="expunge">If set to <c>true</c>, expunge.</param>
  5529. <param name="cancellationToken">The cancellation token.</param>
  5530. <exception cref="T:System.ObjectDisposedException">
  5531. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  5532. </exception>
  5533. <exception cref="T:MailKit.ServiceNotConnectedException">
  5534. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  5535. </exception>
  5536. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  5537. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  5538. </exception>
  5539. <exception cref="T:MailKit.FolderNotOpenException">
  5540. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  5541. </exception>
  5542. <exception cref="T:System.OperationCanceledException">
  5543. The operation was canceled via the cancellation token.
  5544. </exception>
  5545. <exception cref="T:System.IO.IOException">
  5546. An I/O error occurred.
  5547. </exception>
  5548. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  5549. The server's response contained unexpected tokens.
  5550. </exception>
  5551. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  5552. The server replied with a NO or BAD response.
  5553. </exception>
  5554. </member>
  5555. <member name="M:MailKit.Net.Imap.ImapFolder.Create(System.String,System.Boolean,System.Threading.CancellationToken)">
  5556. <summary>
  5557. Create a new subfolder with the given name.
  5558. </summary>
  5559. <remarks>
  5560. Creates a new subfolder with the given name.
  5561. </remarks>
  5562. <returns>The created folder.</returns>
  5563. <param name="name">The name of the folder to create.</param>
  5564. <param name="isMessageFolder"><c>true</c> if the folder will be used to contain messages; otherwise <c>false</c>.</param>
  5565. <param name="cancellationToken">The cancellation token.</param>
  5566. <exception cref="T:System.ArgumentNullException">
  5567. <paramref name="name"/> is <c>null</c>.
  5568. </exception>
  5569. <exception cref="T:System.ArgumentException">
  5570. <paramref name="name"/> is empty.
  5571. </exception>
  5572. <exception cref="T:System.ObjectDisposedException">
  5573. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  5574. </exception>
  5575. <exception cref="T:MailKit.ServiceNotConnectedException">
  5576. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  5577. </exception>
  5578. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  5579. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  5580. </exception>
  5581. <exception cref="T:System.InvalidOperationException">
  5582. The <see cref="P:MailKit.MailFolder.DirectorySeparator"/> is nil, and thus child folders cannot be created.
  5583. </exception>
  5584. <exception cref="T:System.OperationCanceledException">
  5585. The operation was canceled via the cancellation token.
  5586. </exception>
  5587. <exception cref="T:System.IO.IOException">
  5588. An I/O error occurred.
  5589. </exception>
  5590. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  5591. The server's response contained unexpected tokens.
  5592. </exception>
  5593. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  5594. The server replied with a NO or BAD response.
  5595. </exception>
  5596. </member>
  5597. <member name="M:MailKit.Net.Imap.ImapFolder.CreateAsync(System.String,System.Boolean,System.Threading.CancellationToken)">
  5598. <summary>
  5599. Asynchronously create a new subfolder with the given name.
  5600. </summary>
  5601. <remarks>
  5602. Creates a new subfolder with the given name.
  5603. </remarks>
  5604. <returns>The created folder.</returns>
  5605. <param name="name">The name of the folder to create.</param>
  5606. <param name="isMessageFolder"><c>true</c> if the folder will be used to contain messages; otherwise <c>false</c>.</param>
  5607. <param name="cancellationToken">The cancellation token.</param>
  5608. <exception cref="T:System.ArgumentNullException">
  5609. <paramref name="name"/> is <c>null</c>.
  5610. </exception>
  5611. <exception cref="T:System.ArgumentException">
  5612. <paramref name="name"/> is empty.
  5613. </exception>
  5614. <exception cref="T:System.ObjectDisposedException">
  5615. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  5616. </exception>
  5617. <exception cref="T:MailKit.ServiceNotConnectedException">
  5618. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  5619. </exception>
  5620. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  5621. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  5622. </exception>
  5623. <exception cref="T:System.InvalidOperationException">
  5624. The <see cref="P:MailKit.MailFolder.DirectorySeparator"/> is nil, and thus child folders cannot be created.
  5625. </exception>
  5626. <exception cref="T:System.OperationCanceledException">
  5627. The operation was canceled via the cancellation token.
  5628. </exception>
  5629. <exception cref="T:System.IO.IOException">
  5630. An I/O error occurred.
  5631. </exception>
  5632. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  5633. The server's response contained unexpected tokens.
  5634. </exception>
  5635. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  5636. The server replied with a NO or BAD response.
  5637. </exception>
  5638. </member>
  5639. <member name="M:MailKit.Net.Imap.ImapFolder.Create(System.String,System.Collections.Generic.IEnumerable{MailKit.SpecialFolder},System.Threading.CancellationToken)">
  5640. <summary>
  5641. Create a new subfolder with the given name.
  5642. </summary>
  5643. <remarks>
  5644. Creates a new subfolder with the given name.
  5645. </remarks>
  5646. <returns>The created folder.</returns>
  5647. <param name="name">The name of the folder to create.</param>
  5648. <param name="specialUses">A list of special uses for the folder being created.</param>
  5649. <param name="cancellationToken">The cancellation token.</param>
  5650. <exception cref="T:System.ArgumentNullException">
  5651. <para><paramref name="name"/> is <c>null</c>.</para>
  5652. <para>-or-</para>
  5653. <para><paramref name="specialUses"/> is <c>null</c>.</para>
  5654. </exception>
  5655. <exception cref="T:System.ArgumentException">
  5656. <paramref name="name"/> is empty.
  5657. </exception>
  5658. <exception cref="T:System.ObjectDisposedException">
  5659. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  5660. </exception>
  5661. <exception cref="T:MailKit.ServiceNotConnectedException">
  5662. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  5663. </exception>
  5664. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  5665. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  5666. </exception>
  5667. <exception cref="T:System.InvalidOperationException">
  5668. The <see cref="P:MailKit.MailFolder.DirectorySeparator"/> is nil, and thus child folders cannot be created.
  5669. </exception>
  5670. <exception cref="T:System.NotSupportedException">
  5671. The IMAP server does not support the CREATE-SPECIAL-USE extension.
  5672. </exception>
  5673. <exception cref="T:System.OperationCanceledException">
  5674. The operation was canceled via the cancellation token.
  5675. </exception>
  5676. <exception cref="T:System.IO.IOException">
  5677. An I/O error occurred.
  5678. </exception>
  5679. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  5680. The server's response contained unexpected tokens.
  5681. </exception>
  5682. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  5683. The server replied with a NO or BAD response.
  5684. </exception>
  5685. </member>
  5686. <member name="M:MailKit.Net.Imap.ImapFolder.CreateAsync(System.String,System.Collections.Generic.IEnumerable{MailKit.SpecialFolder},System.Threading.CancellationToken)">
  5687. <summary>
  5688. Asynchronously create a new subfolder with the given name.
  5689. </summary>
  5690. <remarks>
  5691. Creates a new subfolder with the given name.
  5692. </remarks>
  5693. <returns>The created folder.</returns>
  5694. <param name="name">The name of the folder to create.</param>
  5695. <param name="specialUses">A list of special uses for the folder being created.</param>
  5696. <param name="cancellationToken">The cancellation token.</param>
  5697. <exception cref="T:System.ArgumentNullException">
  5698. <para><paramref name="name"/> is <c>null</c>.</para>
  5699. <para>-or-</para>
  5700. <para><paramref name="specialUses"/> is <c>null</c>.</para>
  5701. </exception>
  5702. <exception cref="T:System.ArgumentException">
  5703. <paramref name="name"/> is empty.
  5704. </exception>
  5705. <exception cref="T:System.ObjectDisposedException">
  5706. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  5707. </exception>
  5708. <exception cref="T:MailKit.ServiceNotConnectedException">
  5709. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  5710. </exception>
  5711. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  5712. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  5713. </exception>
  5714. <exception cref="T:System.InvalidOperationException">
  5715. The <see cref="P:MailKit.MailFolder.DirectorySeparator"/> is nil, and thus child folders cannot be created.
  5716. </exception>
  5717. <exception cref="T:System.NotSupportedException">
  5718. The IMAP server does not support the CREATE-SPECIAL-USE extension.
  5719. </exception>
  5720. <exception cref="T:System.OperationCanceledException">
  5721. The operation was canceled via the cancellation token.
  5722. </exception>
  5723. <exception cref="T:System.IO.IOException">
  5724. An I/O error occurred.
  5725. </exception>
  5726. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  5727. The server's response contained unexpected tokens.
  5728. </exception>
  5729. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  5730. The server replied with a NO or BAD response.
  5731. </exception>
  5732. </member>
  5733. <member name="M:MailKit.Net.Imap.ImapFolder.Rename(MailKit.IMailFolder,System.String,System.Threading.CancellationToken)">
  5734. <summary>
  5735. Rename the folder to exist with a new name under a new parent folder.
  5736. </summary>
  5737. <remarks>
  5738. Renames the folder to exist with a new name under a new parent folder.
  5739. </remarks>
  5740. <param name="parent">The new parent folder.</param>
  5741. <param name="name">The new name of the folder.</param>
  5742. <param name="cancellationToken">The cancellation token.</param>
  5743. <exception cref="T:System.ArgumentNullException">
  5744. <para><paramref name="parent"/> is <c>null</c>.</para>
  5745. <para>-or-</para>
  5746. <para><paramref name="name"/> is <c>null</c>.</para>
  5747. </exception>
  5748. <exception cref="T:System.ArgumentException">
  5749. <para><paramref name="parent"/> does not belong to the <see cref="T:MailKit.Net.Imap.ImapClient"/>.</para>
  5750. <para>-or-</para>
  5751. <para><paramref name="name"/> is not a legal folder name.</para>
  5752. </exception>
  5753. <exception cref="T:System.ObjectDisposedException">
  5754. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  5755. </exception>
  5756. <exception cref="T:MailKit.ServiceNotConnectedException">
  5757. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  5758. </exception>
  5759. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  5760. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  5761. </exception>
  5762. <exception cref="T:MailKit.FolderNotFoundException">
  5763. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
  5764. </exception>
  5765. <exception cref="T:System.InvalidOperationException">
  5766. The folder cannot be renamed (it is either a namespace or the Inbox).
  5767. </exception>
  5768. <exception cref="T:System.OperationCanceledException">
  5769. The operation was canceled via the cancellation token.
  5770. </exception>
  5771. <exception cref="T:System.IO.IOException">
  5772. An I/O error occurred.
  5773. </exception>
  5774. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  5775. The server's response contained unexpected tokens.
  5776. </exception>
  5777. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  5778. The server replied with a NO or BAD response.
  5779. </exception>
  5780. </member>
  5781. <member name="M:MailKit.Net.Imap.ImapFolder.RenameAsync(MailKit.IMailFolder,System.String,System.Threading.CancellationToken)">
  5782. <summary>
  5783. Asynchronously rename the folder to exist with a new name under a new parent folder.
  5784. </summary>
  5785. <remarks>
  5786. Renames the folder to exist with a new name under a new parent folder.
  5787. </remarks>
  5788. <returns>An awaitable task.</returns>
  5789. <param name="parent">The new parent folder.</param>
  5790. <param name="name">The new name of the folder.</param>
  5791. <param name="cancellationToken">The cancellation token.</param>
  5792. <exception cref="T:System.ArgumentNullException">
  5793. <para><paramref name="parent"/> is <c>null</c>.</para>
  5794. <para>-or-</para>
  5795. <para><paramref name="name"/> is <c>null</c>.</para>
  5796. </exception>
  5797. <exception cref="T:System.ArgumentException">
  5798. <para><paramref name="parent"/> does not belong to the <see cref="T:MailKit.Net.Imap.ImapClient"/>.</para>
  5799. <para>-or-</para>
  5800. <para><paramref name="name"/> is not a legal folder name.</para>
  5801. </exception>
  5802. <exception cref="T:System.ObjectDisposedException">
  5803. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  5804. </exception>
  5805. <exception cref="T:MailKit.ServiceNotConnectedException">
  5806. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  5807. </exception>
  5808. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  5809. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  5810. </exception>
  5811. <exception cref="T:MailKit.FolderNotFoundException">
  5812. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
  5813. </exception>
  5814. <exception cref="T:System.InvalidOperationException">
  5815. The folder cannot be renamed (it is either a namespace or the Inbox).
  5816. </exception>
  5817. <exception cref="T:System.OperationCanceledException">
  5818. The operation was canceled via the cancellation token.
  5819. </exception>
  5820. <exception cref="T:System.IO.IOException">
  5821. An I/O error occurred.
  5822. </exception>
  5823. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  5824. The server's response contained unexpected tokens.
  5825. </exception>
  5826. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  5827. The server replied with a NO or BAD response.
  5828. </exception>
  5829. </member>
  5830. <member name="M:MailKit.Net.Imap.ImapFolder.Delete(System.Threading.CancellationToken)">
  5831. <summary>
  5832. Delete the folder on the IMAP server.
  5833. </summary>
  5834. <remarks>
  5835. <para>Deletes the folder on the IMAP server.</para>
  5836. <note type="note">This method will not delete any child folders.</note>
  5837. </remarks>
  5838. <param name="cancellationToken">The cancellation token.</param>
  5839. <exception cref="T:System.ObjectDisposedException">
  5840. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  5841. </exception>
  5842. <exception cref="T:MailKit.ServiceNotConnectedException">
  5843. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  5844. </exception>
  5845. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  5846. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  5847. </exception>
  5848. <exception cref="T:System.InvalidOperationException">
  5849. The folder cannot be deleted (it is either a namespace or the Inbox).
  5850. </exception>
  5851. <exception cref="T:System.OperationCanceledException">
  5852. The operation was canceled via the cancellation token.
  5853. </exception>
  5854. <exception cref="T:System.IO.IOException">
  5855. An I/O error occurred.
  5856. </exception>
  5857. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  5858. The server's response contained unexpected tokens.
  5859. </exception>
  5860. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  5861. The server replied with a NO or BAD response.
  5862. </exception>
  5863. </member>
  5864. <member name="M:MailKit.Net.Imap.ImapFolder.DeleteAsync(System.Threading.CancellationToken)">
  5865. <summary>
  5866. Asynchronously delete the folder on the IMAP server.
  5867. </summary>
  5868. <remarks>
  5869. <para>Deletes the folder on the IMAP server.</para>
  5870. <note type="note">This method will not delete any child folders.</note>
  5871. </remarks>
  5872. <returns>An awaitable task.</returns>
  5873. <param name="cancellationToken">The cancellation token.</param>
  5874. <exception cref="T:System.ObjectDisposedException">
  5875. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  5876. </exception>
  5877. <exception cref="T:MailKit.ServiceNotConnectedException">
  5878. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  5879. </exception>
  5880. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  5881. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  5882. </exception>
  5883. <exception cref="T:System.InvalidOperationException">
  5884. The folder cannot be deleted (it is either a namespace or the Inbox).
  5885. </exception>
  5886. <exception cref="T:System.OperationCanceledException">
  5887. The operation was canceled via the cancellation token.
  5888. </exception>
  5889. <exception cref="T:System.IO.IOException">
  5890. An I/O error occurred.
  5891. </exception>
  5892. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  5893. The server's response contained unexpected tokens.
  5894. </exception>
  5895. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  5896. The server replied with a NO or BAD response.
  5897. </exception>
  5898. </member>
  5899. <member name="M:MailKit.Net.Imap.ImapFolder.Subscribe(System.Threading.CancellationToken)">
  5900. <summary>
  5901. Subscribe the folder.
  5902. </summary>
  5903. <remarks>
  5904. Subscribes the folder.
  5905. </remarks>
  5906. <param name="cancellationToken">The cancellation token.</param>
  5907. <exception cref="T:System.ObjectDisposedException">
  5908. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  5909. </exception>
  5910. <exception cref="T:MailKit.ServiceNotConnectedException">
  5911. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  5912. </exception>
  5913. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  5914. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  5915. </exception>
  5916. <exception cref="T:System.OperationCanceledException">
  5917. The operation was canceled via the cancellation token.
  5918. </exception>
  5919. <exception cref="T:System.IO.IOException">
  5920. An I/O error occurred.
  5921. </exception>
  5922. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  5923. The server's response contained unexpected tokens.
  5924. </exception>
  5925. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  5926. The server replied with a NO or BAD response.
  5927. </exception>
  5928. </member>
  5929. <member name="M:MailKit.Net.Imap.ImapFolder.SubscribeAsync(System.Threading.CancellationToken)">
  5930. <summary>
  5931. Asynchronously subscribe the folder.
  5932. </summary>
  5933. <remarks>
  5934. Subscribes the folder.
  5935. </remarks>
  5936. <returns>An awaitable task.</returns>
  5937. <param name="cancellationToken">The cancellation token.</param>
  5938. <exception cref="T:System.ObjectDisposedException">
  5939. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  5940. </exception>
  5941. <exception cref="T:MailKit.ServiceNotConnectedException">
  5942. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  5943. </exception>
  5944. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  5945. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  5946. </exception>
  5947. <exception cref="T:System.OperationCanceledException">
  5948. The operation was canceled via the cancellation token.
  5949. </exception>
  5950. <exception cref="T:System.IO.IOException">
  5951. An I/O error occurred.
  5952. </exception>
  5953. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  5954. The server's response contained unexpected tokens.
  5955. </exception>
  5956. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  5957. The server replied with a NO or BAD response.
  5958. </exception>
  5959. </member>
  5960. <member name="M:MailKit.Net.Imap.ImapFolder.Unsubscribe(System.Threading.CancellationToken)">
  5961. <summary>
  5962. Unsubscribe the folder.
  5963. </summary>
  5964. <remarks>
  5965. Unsubscribes the folder.
  5966. </remarks>
  5967. <param name="cancellationToken">The cancellation token.</param>
  5968. <exception cref="T:System.ObjectDisposedException">
  5969. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  5970. </exception>
  5971. <exception cref="T:MailKit.ServiceNotConnectedException">
  5972. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  5973. </exception>
  5974. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  5975. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  5976. </exception>
  5977. <exception cref="T:System.OperationCanceledException">
  5978. The operation was canceled via the cancellation token.
  5979. </exception>
  5980. <exception cref="T:System.IO.IOException">
  5981. An I/O error occurred.
  5982. </exception>
  5983. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  5984. The server's response contained unexpected tokens.
  5985. </exception>
  5986. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  5987. The server replied with a NO or BAD response.
  5988. </exception>
  5989. </member>
  5990. <member name="M:MailKit.Net.Imap.ImapFolder.UnsubscribeAsync(System.Threading.CancellationToken)">
  5991. <summary>
  5992. Asynchronously unsubscribe the folder.
  5993. </summary>
  5994. <remarks>
  5995. Unsubscribes the folder.
  5996. </remarks>
  5997. <returns>An awaitable task.</returns>
  5998. <param name="cancellationToken">The cancellation token.</param>
  5999. <exception cref="T:System.ObjectDisposedException">
  6000. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  6001. </exception>
  6002. <exception cref="T:MailKit.ServiceNotConnectedException">
  6003. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  6004. </exception>
  6005. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  6006. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  6007. </exception>
  6008. <exception cref="T:System.OperationCanceledException">
  6009. The operation was canceled via the cancellation token.
  6010. </exception>
  6011. <exception cref="T:System.IO.IOException">
  6012. An I/O error occurred.
  6013. </exception>
  6014. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  6015. The server's response contained unexpected tokens.
  6016. </exception>
  6017. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  6018. The server replied with a NO or BAD response.
  6019. </exception>
  6020. </member>
  6021. <member name="M:MailKit.Net.Imap.ImapFolder.GetSubfolders(MailKit.StatusItems,System.Boolean,System.Threading.CancellationToken)">
  6022. <summary>
  6023. Get the subfolders.
  6024. </summary>
  6025. <remarks>
  6026. Gets the subfolders.
  6027. </remarks>
  6028. <returns>The subfolders.</returns>
  6029. <param name="items">The status items to pre-populate.</param>
  6030. <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
  6031. <param name="cancellationToken">The cancellation token.</param>
  6032. <exception cref="T:System.ObjectDisposedException">
  6033. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  6034. </exception>
  6035. <exception cref="T:MailKit.ServiceNotConnectedException">
  6036. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  6037. </exception>
  6038. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  6039. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  6040. </exception>
  6041. <exception cref="T:System.OperationCanceledException">
  6042. The operation was canceled via the cancellation token.
  6043. </exception>
  6044. <exception cref="T:System.IO.IOException">
  6045. An I/O error occurred.
  6046. </exception>
  6047. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  6048. The server's response contained unexpected tokens.
  6049. </exception>
  6050. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  6051. The server replied with a NO or BAD response.
  6052. </exception>
  6053. </member>
  6054. <member name="M:MailKit.Net.Imap.ImapFolder.GetSubfoldersAsync(MailKit.StatusItems,System.Boolean,System.Threading.CancellationToken)">
  6055. <summary>
  6056. Asynchronously get the subfolders.
  6057. </summary>
  6058. <remarks>
  6059. Gets the subfolders.
  6060. </remarks>
  6061. <returns>The subfolders.</returns>
  6062. <param name="items">The status items to pre-populate.</param>
  6063. <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
  6064. <param name="cancellationToken">The cancellation token.</param>
  6065. <exception cref="T:System.ObjectDisposedException">
  6066. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  6067. </exception>
  6068. <exception cref="T:MailKit.ServiceNotConnectedException">
  6069. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  6070. </exception>
  6071. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  6072. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  6073. </exception>
  6074. <exception cref="T:System.OperationCanceledException">
  6075. The operation was canceled via the cancellation token.
  6076. </exception>
  6077. <exception cref="T:System.IO.IOException">
  6078. An I/O error occurred.
  6079. </exception>
  6080. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  6081. The server's response contained unexpected tokens.
  6082. </exception>
  6083. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  6084. The server replied with a NO or BAD response.
  6085. </exception>
  6086. </member>
  6087. <member name="M:MailKit.Net.Imap.ImapFolder.GetSubfolder(System.String,System.Threading.CancellationToken)">
  6088. <summary>
  6089. Get the specified subfolder.
  6090. </summary>
  6091. <remarks>
  6092. Gets the specified subfolder.
  6093. </remarks>
  6094. <returns>The subfolder.</returns>
  6095. <param name="name">The name of the subfolder.</param>
  6096. <param name="cancellationToken">The cancellation token.</param>
  6097. <exception cref="T:System.ArgumentNullException">
  6098. <paramref name="name"/> is <c>null</c>.
  6099. </exception>
  6100. <exception cref="T:System.ArgumentException">
  6101. <paramref name="name"/> is either an empty string or contains the <see cref="P:MailKit.MailFolder.DirectorySeparator"/>.
  6102. </exception>
  6103. <exception cref="T:System.ObjectDisposedException">
  6104. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  6105. </exception>
  6106. <exception cref="T:MailKit.ServiceNotConnectedException">
  6107. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  6108. </exception>
  6109. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  6110. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  6111. </exception>
  6112. <exception cref="T:System.OperationCanceledException">
  6113. The operation was canceled via the cancellation token.
  6114. </exception>
  6115. <exception cref="T:System.IO.IOException">
  6116. An I/O error occurred.
  6117. </exception>
  6118. <exception cref="T:MailKit.FolderNotFoundException">
  6119. The requested folder could not be found.
  6120. </exception>
  6121. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  6122. The server's response contained unexpected tokens.
  6123. </exception>
  6124. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  6125. The server replied with a NO or BAD response.
  6126. </exception>
  6127. </member>
  6128. <member name="M:MailKit.Net.Imap.ImapFolder.GetSubfolderAsync(System.String,System.Threading.CancellationToken)">
  6129. <summary>
  6130. Asynchronously get the specified subfolder.
  6131. </summary>
  6132. <remarks>
  6133. Gets the specified subfolder.
  6134. </remarks>
  6135. <returns>The subfolder.</returns>
  6136. <param name="name">The name of the subfolder.</param>
  6137. <param name="cancellationToken">The cancellation token.</param>
  6138. <exception cref="T:System.ArgumentNullException">
  6139. <paramref name="name"/> is <c>null</c>.
  6140. </exception>
  6141. <exception cref="T:System.ArgumentException">
  6142. <paramref name="name"/> is either an empty string or contains the <see cref="P:MailKit.MailFolder.DirectorySeparator"/>.
  6143. </exception>
  6144. <exception cref="T:System.ObjectDisposedException">
  6145. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  6146. </exception>
  6147. <exception cref="T:MailKit.ServiceNotConnectedException">
  6148. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  6149. </exception>
  6150. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  6151. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  6152. </exception>
  6153. <exception cref="T:System.OperationCanceledException">
  6154. The operation was canceled via the cancellation token.
  6155. </exception>
  6156. <exception cref="T:System.IO.IOException">
  6157. An I/O error occurred.
  6158. </exception>
  6159. <exception cref="T:MailKit.FolderNotFoundException">
  6160. The requested folder could not be found.
  6161. </exception>
  6162. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  6163. The server's response contained unexpected tokens.
  6164. </exception>
  6165. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  6166. The server replied with a NO or BAD response.
  6167. </exception>
  6168. </member>
  6169. <member name="M:MailKit.Net.Imap.ImapFolder.Check(System.Threading.CancellationToken)">
  6170. <summary>
  6171. Force the server to sync its in-memory state with its disk state.
  6172. </summary>
  6173. <remarks>
  6174. <para>The <c>CHECK</c> command forces the IMAP server to sync its
  6175. in-memory state with its disk state.</para>
  6176. <para>For more information about the <c>CHECK</c> command, see
  6177. <a href="https://tools.ietf.org/html/rfc3501#section-6.4.1">rfc350101</a>.</para>
  6178. </remarks>
  6179. <param name="cancellationToken">The cancellation token.</param>
  6180. <exception cref="T:System.ObjectDisposedException">
  6181. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  6182. </exception>
  6183. <exception cref="T:MailKit.FolderNotOpenException">
  6184. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  6185. </exception>
  6186. <exception cref="T:MailKit.ServiceNotConnectedException">
  6187. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  6188. </exception>
  6189. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  6190. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  6191. </exception>
  6192. <exception cref="T:System.OperationCanceledException">
  6193. The operation was canceled via the cancellation token.
  6194. </exception>
  6195. <exception cref="T:System.IO.IOException">
  6196. An I/O error occurred.
  6197. </exception>
  6198. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  6199. The server's response contained unexpected tokens.
  6200. </exception>
  6201. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  6202. The server replied with a NO or BAD response.
  6203. </exception>
  6204. </member>
  6205. <member name="M:MailKit.Net.Imap.ImapFolder.CheckAsync(System.Threading.CancellationToken)">
  6206. <summary>
  6207. Asynchronously force the server to sync its in-memory state with its disk state.
  6208. </summary>
  6209. <remarks>
  6210. <para>The <c>CHECK</c> command forces the IMAP server to sync its
  6211. in-memory state with its disk state.</para>
  6212. <para>For more information about the <c>CHECK</c> command, see
  6213. <a href="https://tools.ietf.org/html/rfc3501#section-6.4.1">rfc350101</a>.</para>
  6214. </remarks>
  6215. <returns>An awaitable task.</returns>
  6216. <param name="cancellationToken">The cancellation token.</param>
  6217. <exception cref="T:System.ObjectDisposedException">
  6218. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  6219. </exception>
  6220. <exception cref="T:MailKit.FolderNotOpenException">
  6221. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  6222. </exception>
  6223. <exception cref="T:MailKit.ServiceNotConnectedException">
  6224. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  6225. </exception>
  6226. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  6227. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  6228. </exception>
  6229. <exception cref="T:System.OperationCanceledException">
  6230. The operation was canceled via the cancellation token.
  6231. </exception>
  6232. <exception cref="T:System.IO.IOException">
  6233. An I/O error occurred.
  6234. </exception>
  6235. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  6236. The server's response contained unexpected tokens.
  6237. </exception>
  6238. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  6239. The server replied with a NO or BAD response.
  6240. </exception>
  6241. </member>
  6242. <member name="M:MailKit.Net.Imap.ImapFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)">
  6243. <summary>
  6244. Update the values of the specified items.
  6245. </summary>
  6246. <remarks>
  6247. <para>Updates the values of the specified items.</para>
  6248. <para>The <see cref="M:MailKit.Net.Imap.ImapFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/> method
  6249. MUST NOT be used on a folder that is already in the opened state. Instead, other ways
  6250. of getting the desired information should be used.</para>
  6251. <para>For example, a common use for the <see cref="M:MailKit.Net.Imap.ImapFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/>
  6252. method is to get the number of unread messages in the folder. When the folder is open, however, it is
  6253. possible to use the <see cref="M:MailKit.Net.Imap.ImapFolder.Search(MailKit.Search.SearchQuery,System.Threading.CancellationToken)"/>
  6254. method to query for the list of unread messages.</para>
  6255. <para>For more information about the <c>STATUS</c> command, see
  6256. <a href="https://tools.ietf.org/html/rfc3501#section-6.3.10">rfc3501</a>.</para>
  6257. </remarks>
  6258. <param name="items">The items to update.</param>
  6259. <param name="cancellationToken">The cancellation token.</param>
  6260. <exception cref="T:System.ObjectDisposedException">
  6261. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  6262. </exception>
  6263. <exception cref="T:MailKit.ServiceNotConnectedException">
  6264. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  6265. </exception>
  6266. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  6267. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  6268. </exception>
  6269. <exception cref="T:MailKit.FolderNotFoundException">
  6270. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
  6271. </exception>
  6272. <exception cref="T:System.NotSupportedException">
  6273. The IMAP server does not support the STATUS command.
  6274. </exception>
  6275. <exception cref="T:System.OperationCanceledException">
  6276. The operation was canceled via the cancellation token.
  6277. </exception>
  6278. <exception cref="T:System.IO.IOException">
  6279. An I/O error occurred.
  6280. </exception>
  6281. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  6282. The server's response contained unexpected tokens.
  6283. </exception>
  6284. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  6285. The server replied with a NO or BAD response.
  6286. </exception>
  6287. </member>
  6288. <member name="M:MailKit.Net.Imap.ImapFolder.StatusAsync(MailKit.StatusItems,System.Threading.CancellationToken)">
  6289. <summary>
  6290. Asynchronously update the values of the specified items.
  6291. </summary>
  6292. <remarks>
  6293. <para>Updates the values of the specified items.</para>
  6294. <para>The <see cref="M:MailKit.Net.Imap.ImapFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/> method
  6295. MUST NOT be used on a folder that is already in the opened state. Instead, other ways
  6296. of getting the desired information should be used.</para>
  6297. <para>For example, a common use for the <see cref="M:MailKit.Net.Imap.ImapFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/>
  6298. method is to get the number of unread messages in the folder. When the folder is open, however, it is
  6299. possible to use the <see cref="M:MailKit.Net.Imap.ImapFolder.Search(MailKit.Search.SearchQuery,System.Threading.CancellationToken)"/>
  6300. method to query for the list of unread messages.</para>
  6301. <para>For more information about the <c>STATUS</c> command, see
  6302. <a href="https://tools.ietf.org/html/rfc3501#section-6.3.10">rfc3501</a>.</para>
  6303. </remarks>
  6304. <returns>An awaitable task.</returns>
  6305. <param name="items">The items to update.</param>
  6306. <param name="cancellationToken">The cancellation token.</param>
  6307. <exception cref="T:System.ObjectDisposedException">
  6308. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  6309. </exception>
  6310. <exception cref="T:MailKit.ServiceNotConnectedException">
  6311. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  6312. </exception>
  6313. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  6314. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  6315. </exception>
  6316. <exception cref="T:MailKit.FolderNotFoundException">
  6317. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
  6318. </exception>
  6319. <exception cref="T:System.NotSupportedException">
  6320. The IMAP server does not support the STATUS command.
  6321. </exception>
  6322. <exception cref="T:System.OperationCanceledException">
  6323. The operation was canceled via the cancellation token.
  6324. </exception>
  6325. <exception cref="T:System.IO.IOException">
  6326. An I/O error occurred.
  6327. </exception>
  6328. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  6329. The server's response contained unexpected tokens.
  6330. </exception>
  6331. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  6332. The server replied with a NO or BAD response.
  6333. </exception>
  6334. </member>
  6335. <member name="M:MailKit.Net.Imap.ImapFolder.GetAccessControlList(System.Threading.CancellationToken)">
  6336. <summary>
  6337. Get the complete access control list for the folder.
  6338. </summary>
  6339. <remarks>
  6340. Gets the complete access control list for the folder.
  6341. </remarks>
  6342. <returns>The access control list.</returns>
  6343. <param name="cancellationToken">The cancellation token.</param>
  6344. <exception cref="T:System.ObjectDisposedException">
  6345. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  6346. </exception>
  6347. <exception cref="T:MailKit.ServiceNotConnectedException">
  6348. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  6349. </exception>
  6350. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  6351. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  6352. </exception>
  6353. <exception cref="T:System.NotSupportedException">
  6354. The IMAP server does not support the ACL extension.
  6355. </exception>
  6356. <exception cref="T:System.OperationCanceledException">
  6357. The operation was canceled via the cancellation token.
  6358. </exception>
  6359. <exception cref="T:System.IO.IOException">
  6360. An I/O error occurred.
  6361. </exception>
  6362. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  6363. The server's response contained unexpected tokens.
  6364. </exception>
  6365. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  6366. The command failed.
  6367. </exception>
  6368. </member>
  6369. <member name="M:MailKit.Net.Imap.ImapFolder.GetAccessControlListAsync(System.Threading.CancellationToken)">
  6370. <summary>
  6371. Asynchronously get the complete access control list for the folder.
  6372. </summary>
  6373. <remarks>
  6374. Gets the complete access control list for the folder.
  6375. </remarks>
  6376. <returns>The access control list.</returns>
  6377. <param name="cancellationToken">The cancellation token.</param>
  6378. <exception cref="T:System.ObjectDisposedException">
  6379. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  6380. </exception>
  6381. <exception cref="T:MailKit.ServiceNotConnectedException">
  6382. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  6383. </exception>
  6384. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  6385. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  6386. </exception>
  6387. <exception cref="T:System.NotSupportedException">
  6388. The IMAP server does not support the ACL extension.
  6389. </exception>
  6390. <exception cref="T:System.OperationCanceledException">
  6391. The operation was canceled via the cancellation token.
  6392. </exception>
  6393. <exception cref="T:System.IO.IOException">
  6394. An I/O error occurred.
  6395. </exception>
  6396. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  6397. The server's response contained unexpected tokens.
  6398. </exception>
  6399. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  6400. The command failed.
  6401. </exception>
  6402. </member>
  6403. <member name="M:MailKit.Net.Imap.ImapFolder.GetAccessRights(System.String,System.Threading.CancellationToken)">
  6404. <summary>
  6405. Get the access rights for a particular identifier.
  6406. </summary>
  6407. <remarks>
  6408. Gets the access rights for a particular identifier.
  6409. </remarks>
  6410. <returns>The access rights.</returns>
  6411. <param name="name">The identifier name.</param>
  6412. <param name="cancellationToken">The cancellation token.</param>
  6413. <exception cref="T:System.ArgumentNullException">
  6414. <paramref name="name"/> is <c>null</c>.
  6415. </exception>
  6416. <exception cref="T:System.ObjectDisposedException">
  6417. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  6418. </exception>
  6419. <exception cref="T:MailKit.ServiceNotConnectedException">
  6420. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  6421. </exception>
  6422. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  6423. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  6424. </exception>
  6425. <exception cref="T:System.NotSupportedException">
  6426. The IMAP server does not support the ACL extension.
  6427. </exception>
  6428. <exception cref="T:System.OperationCanceledException">
  6429. The operation was canceled via the cancellation token.
  6430. </exception>
  6431. <exception cref="T:System.IO.IOException">
  6432. An I/O error occurred.
  6433. </exception>
  6434. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  6435. The server's response contained unexpected tokens.
  6436. </exception>
  6437. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  6438. The command failed.
  6439. </exception>
  6440. </member>
  6441. <member name="M:MailKit.Net.Imap.ImapFolder.GetAccessRightsAsync(System.String,System.Threading.CancellationToken)">
  6442. <summary>
  6443. Asynchronously get the access rights for a particular identifier.
  6444. </summary>
  6445. <remarks>
  6446. Gets the access rights for a particular identifier.
  6447. </remarks>
  6448. <returns>The access rights.</returns>
  6449. <param name="name">The identifier name.</param>
  6450. <param name="cancellationToken">The cancellation token.</param>
  6451. <exception cref="T:System.ArgumentNullException">
  6452. <paramref name="name"/> is <c>null</c>.
  6453. </exception>
  6454. <exception cref="T:System.ObjectDisposedException">
  6455. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  6456. </exception>
  6457. <exception cref="T:MailKit.ServiceNotConnectedException">
  6458. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  6459. </exception>
  6460. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  6461. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  6462. </exception>
  6463. <exception cref="T:System.NotSupportedException">
  6464. The IMAP server does not support the ACL extension.
  6465. </exception>
  6466. <exception cref="T:System.OperationCanceledException">
  6467. The operation was canceled via the cancellation token.
  6468. </exception>
  6469. <exception cref="T:System.IO.IOException">
  6470. An I/O error occurred.
  6471. </exception>
  6472. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  6473. The server's response contained unexpected tokens.
  6474. </exception>
  6475. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  6476. The command failed.
  6477. </exception>
  6478. </member>
  6479. <member name="M:MailKit.Net.Imap.ImapFolder.GetMyAccessRights(System.Threading.CancellationToken)">
  6480. <summary>
  6481. Get the access rights for the current authenticated user.
  6482. </summary>
  6483. <remarks>
  6484. Gets the access rights for the current authenticated user.
  6485. </remarks>
  6486. <returns>The access rights.</returns>
  6487. <param name="cancellationToken">The cancellation token.</param>
  6488. <exception cref="T:System.ObjectDisposedException">
  6489. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  6490. </exception>
  6491. <exception cref="T:MailKit.ServiceNotConnectedException">
  6492. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  6493. </exception>
  6494. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  6495. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  6496. </exception>
  6497. <exception cref="T:System.NotSupportedException">
  6498. The IMAP server does not support the ACL extension.
  6499. </exception>
  6500. <exception cref="T:System.OperationCanceledException">
  6501. The operation was canceled via the cancellation token.
  6502. </exception>
  6503. <exception cref="T:System.IO.IOException">
  6504. An I/O error occurred.
  6505. </exception>
  6506. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  6507. The server's response contained unexpected tokens.
  6508. </exception>
  6509. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  6510. The command failed.
  6511. </exception>
  6512. </member>
  6513. <member name="M:MailKit.Net.Imap.ImapFolder.GetMyAccessRightsAsync(System.Threading.CancellationToken)">
  6514. <summary>
  6515. Asynchronously get the access rights for the current authenticated user.
  6516. </summary>
  6517. <remarks>
  6518. Gets the access rights for the current authenticated user.
  6519. </remarks>
  6520. <returns>The access rights.</returns>
  6521. <param name="cancellationToken">The cancellation token.</param>
  6522. <exception cref="T:System.ObjectDisposedException">
  6523. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  6524. </exception>
  6525. <exception cref="T:MailKit.ServiceNotConnectedException">
  6526. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  6527. </exception>
  6528. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  6529. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  6530. </exception>
  6531. <exception cref="T:System.NotSupportedException">
  6532. The IMAP server does not support the ACL extension.
  6533. </exception>
  6534. <exception cref="T:System.OperationCanceledException">
  6535. The operation was canceled via the cancellation token.
  6536. </exception>
  6537. <exception cref="T:System.IO.IOException">
  6538. An I/O error occurred.
  6539. </exception>
  6540. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  6541. The server's response contained unexpected tokens.
  6542. </exception>
  6543. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  6544. The command failed.
  6545. </exception>
  6546. </member>
  6547. <member name="M:MailKit.Net.Imap.ImapFolder.AddAccessRights(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
  6548. <summary>
  6549. Add access rights for the specified identity.
  6550. </summary>
  6551. <remarks>
  6552. Adds the given access rights for the specified identity.
  6553. </remarks>
  6554. <param name="name">The identity name.</param>
  6555. <param name="rights">The access rights.</param>
  6556. <param name="cancellationToken">The cancellation token.</param>
  6557. <exception cref="T:System.ArgumentNullException">
  6558. <para><paramref name="name"/> is <c>null</c>.</para>
  6559. <para>-or-</para>
  6560. <para><paramref name="rights"/> is <c>null</c>.</para>
  6561. </exception>
  6562. <exception cref="T:System.ArgumentException">
  6563. No rights were specified.
  6564. </exception>
  6565. <exception cref="T:System.ObjectDisposedException">
  6566. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  6567. </exception>
  6568. <exception cref="T:MailKit.ServiceNotConnectedException">
  6569. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  6570. </exception>
  6571. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  6572. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  6573. </exception>
  6574. <exception cref="T:System.NotSupportedException">
  6575. The IMAP server does not support the ACL extension.
  6576. </exception>
  6577. <exception cref="T:System.OperationCanceledException">
  6578. The operation was canceled via the cancellation token.
  6579. </exception>
  6580. <exception cref="T:System.IO.IOException">
  6581. An I/O error occurred.
  6582. </exception>
  6583. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  6584. The server's response contained unexpected tokens.
  6585. </exception>
  6586. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  6587. The command failed.
  6588. </exception>
  6589. </member>
  6590. <member name="M:MailKit.Net.Imap.ImapFolder.AddAccessRightsAsync(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
  6591. <summary>
  6592. Asynchronously add access rights for the specified identity.
  6593. </summary>
  6594. <remarks>
  6595. Adds the given access rights for the specified identity.
  6596. </remarks>
  6597. <returns>An asynchronous task context.</returns>
  6598. <param name="name">The identity name.</param>
  6599. <param name="rights">The access rights.</param>
  6600. <param name="cancellationToken">The cancellation token.</param>
  6601. <exception cref="T:System.ArgumentNullException">
  6602. <para><paramref name="name"/> is <c>null</c>.</para>
  6603. <para>-or-</para>
  6604. <para><paramref name="rights"/> is <c>null</c>.</para>
  6605. </exception>
  6606. <exception cref="T:System.ArgumentException">
  6607. No rights were specified.
  6608. </exception>
  6609. <exception cref="T:System.ObjectDisposedException">
  6610. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  6611. </exception>
  6612. <exception cref="T:MailKit.ServiceNotConnectedException">
  6613. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  6614. </exception>
  6615. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  6616. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  6617. </exception>
  6618. <exception cref="T:System.NotSupportedException">
  6619. The IMAP server does not support the ACL extension.
  6620. </exception>
  6621. <exception cref="T:System.OperationCanceledException">
  6622. The operation was canceled via the cancellation token.
  6623. </exception>
  6624. <exception cref="T:System.IO.IOException">
  6625. An I/O error occurred.
  6626. </exception>
  6627. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  6628. The server's response contained unexpected tokens.
  6629. </exception>
  6630. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  6631. The command failed.
  6632. </exception>
  6633. </member>
  6634. <member name="M:MailKit.Net.Imap.ImapFolder.RemoveAccessRights(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
  6635. <summary>
  6636. Remove access rights for the specified identity.
  6637. </summary>
  6638. <remarks>
  6639. Removes the given access rights for the specified identity.
  6640. </remarks>
  6641. <param name="name">The identity name.</param>
  6642. <param name="rights">The access rights.</param>
  6643. <param name="cancellationToken">The cancellation token.</param>
  6644. <exception cref="T:System.ArgumentNullException">
  6645. <para><paramref name="name"/> is <c>null</c>.</para>
  6646. <para>-or-</para>
  6647. <para><paramref name="rights"/> is <c>null</c>.</para>
  6648. </exception>
  6649. <exception cref="T:System.ArgumentException">
  6650. No rights were specified.
  6651. </exception>
  6652. <exception cref="T:System.ObjectDisposedException">
  6653. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  6654. </exception>
  6655. <exception cref="T:MailKit.ServiceNotConnectedException">
  6656. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  6657. </exception>
  6658. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  6659. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  6660. </exception>
  6661. <exception cref="T:System.NotSupportedException">
  6662. The IMAP server does not support the ACL extension.
  6663. </exception>
  6664. <exception cref="T:System.OperationCanceledException">
  6665. The operation was canceled via the cancellation token.
  6666. </exception>
  6667. <exception cref="T:System.IO.IOException">
  6668. An I/O error occurred.
  6669. </exception>
  6670. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  6671. The server's response contained unexpected tokens.
  6672. </exception>
  6673. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  6674. The command failed.
  6675. </exception>
  6676. </member>
  6677. <member name="M:MailKit.Net.Imap.ImapFolder.RemoveAccessRightsAsync(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
  6678. <summary>
  6679. Asynchronously remove access rights for the specified identity.
  6680. </summary>
  6681. <remarks>
  6682. Removes the given access rights for the specified identity.
  6683. </remarks>
  6684. <returns>An asynchronous task context.</returns>
  6685. <param name="name">The identity name.</param>
  6686. <param name="rights">The access rights.</param>
  6687. <param name="cancellationToken">The cancellation token.</param>
  6688. <exception cref="T:System.ArgumentNullException">
  6689. <para><paramref name="name"/> is <c>null</c>.</para>
  6690. <para>-or-</para>
  6691. <para><paramref name="rights"/> is <c>null</c>.</para>
  6692. </exception>
  6693. <exception cref="T:System.ArgumentException">
  6694. No rights were specified.
  6695. </exception>
  6696. <exception cref="T:System.ObjectDisposedException">
  6697. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  6698. </exception>
  6699. <exception cref="T:MailKit.ServiceNotConnectedException">
  6700. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  6701. </exception>
  6702. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  6703. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  6704. </exception>
  6705. <exception cref="T:System.NotSupportedException">
  6706. The IMAP server does not support the ACL extension.
  6707. </exception>
  6708. <exception cref="T:System.OperationCanceledException">
  6709. The operation was canceled via the cancellation token.
  6710. </exception>
  6711. <exception cref="T:System.IO.IOException">
  6712. An I/O error occurred.
  6713. </exception>
  6714. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  6715. The server's response contained unexpected tokens.
  6716. </exception>
  6717. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  6718. The command failed.
  6719. </exception>
  6720. </member>
  6721. <member name="M:MailKit.Net.Imap.ImapFolder.SetAccessRights(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
  6722. <summary>
  6723. Set the access rights for the specified identity.
  6724. </summary>
  6725. <remarks>
  6726. Sets the access rights for the specified identity.
  6727. </remarks>
  6728. <param name="name">The identity name.</param>
  6729. <param name="rights">The access rights.</param>
  6730. <param name="cancellationToken">The cancellation token.</param>
  6731. <exception cref="T:System.ArgumentNullException">
  6732. <para><paramref name="name"/> is <c>null</c>.</para>
  6733. <para>-or-</para>
  6734. <para><paramref name="rights"/> is <c>null</c>.</para>
  6735. </exception>
  6736. <exception cref="T:System.ObjectDisposedException">
  6737. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  6738. </exception>
  6739. <exception cref="T:MailKit.ServiceNotConnectedException">
  6740. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  6741. </exception>
  6742. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  6743. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  6744. </exception>
  6745. <exception cref="T:System.NotSupportedException">
  6746. The IMAP server does not support the ACL extension.
  6747. </exception>
  6748. <exception cref="T:System.OperationCanceledException">
  6749. The operation was canceled via the cancellation token.
  6750. </exception>
  6751. <exception cref="T:System.IO.IOException">
  6752. An I/O error occurred.
  6753. </exception>
  6754. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  6755. The server's response contained unexpected tokens.
  6756. </exception>
  6757. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  6758. The command failed.
  6759. </exception>
  6760. </member>
  6761. <member name="M:MailKit.Net.Imap.ImapFolder.SetAccessRightsAsync(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
  6762. <summary>
  6763. Asynchronously get the access rights for the specified identity.
  6764. </summary>
  6765. <remarks>
  6766. Sets the access rights for the specified identity.
  6767. </remarks>
  6768. <returns>An awaitable task.</returns>
  6769. <param name="name">The identity name.</param>
  6770. <param name="rights">The access rights.</param>
  6771. <param name="cancellationToken">The cancellation token.</param>
  6772. <exception cref="T:System.ArgumentNullException">
  6773. <para><paramref name="name"/> is <c>null</c>.</para>
  6774. <para>-or-</para>
  6775. <para><paramref name="rights"/> is <c>null</c>.</para>
  6776. </exception>
  6777. <exception cref="T:System.ObjectDisposedException">
  6778. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  6779. </exception>
  6780. <exception cref="T:MailKit.ServiceNotConnectedException">
  6781. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  6782. </exception>
  6783. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  6784. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  6785. </exception>
  6786. <exception cref="T:System.NotSupportedException">
  6787. The IMAP server does not support the ACL extension.
  6788. </exception>
  6789. <exception cref="T:System.OperationCanceledException">
  6790. The operation was canceled via the cancellation token.
  6791. </exception>
  6792. <exception cref="T:System.IO.IOException">
  6793. An I/O error occurred.
  6794. </exception>
  6795. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  6796. The server's response contained unexpected tokens.
  6797. </exception>
  6798. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  6799. The command failed.
  6800. </exception>
  6801. </member>
  6802. <member name="M:MailKit.Net.Imap.ImapFolder.RemoveAccess(System.String,System.Threading.CancellationToken)">
  6803. <summary>
  6804. Remove all access rights for the given identity.
  6805. </summary>
  6806. <remarks>
  6807. Removes all access rights for the given identity.
  6808. </remarks>
  6809. <param name="name">The identity name.</param>
  6810. <param name="cancellationToken">The cancellation token.</param>
  6811. <exception cref="T:System.ArgumentNullException">
  6812. <paramref name="name"/> is <c>null</c>.
  6813. </exception>
  6814. <exception cref="T:System.ObjectDisposedException">
  6815. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  6816. </exception>
  6817. <exception cref="T:MailKit.ServiceNotConnectedException">
  6818. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  6819. </exception>
  6820. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  6821. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  6822. </exception>
  6823. <exception cref="T:System.NotSupportedException">
  6824. The IMAP server does not support the ACL extension.
  6825. </exception>
  6826. <exception cref="T:System.OperationCanceledException">
  6827. The operation was canceled via the cancellation token.
  6828. </exception>
  6829. <exception cref="T:System.IO.IOException">
  6830. An I/O error occurred.
  6831. </exception>
  6832. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  6833. The server's response contained unexpected tokens.
  6834. </exception>
  6835. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  6836. The command failed.
  6837. </exception>
  6838. </member>
  6839. <member name="M:MailKit.Net.Imap.ImapFolder.RemoveAccessAsync(System.String,System.Threading.CancellationToken)">
  6840. <summary>
  6841. Asynchronously remove all access rights for the given identity.
  6842. </summary>
  6843. <remarks>
  6844. Removes all access rights for the given identity.
  6845. </remarks>
  6846. <returns>An awaitable task.</returns>
  6847. <param name="name">The identity name.</param>
  6848. <param name="cancellationToken">The cancellation token.</param>
  6849. <exception cref="T:System.ArgumentNullException">
  6850. <paramref name="name"/> is <c>null</c>.
  6851. </exception>
  6852. <exception cref="T:System.ObjectDisposedException">
  6853. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  6854. </exception>
  6855. <exception cref="T:MailKit.ServiceNotConnectedException">
  6856. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  6857. </exception>
  6858. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  6859. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  6860. </exception>
  6861. <exception cref="T:System.NotSupportedException">
  6862. The IMAP server does not support the ACL extension.
  6863. </exception>
  6864. <exception cref="T:System.OperationCanceledException">
  6865. The operation was canceled via the cancellation token.
  6866. </exception>
  6867. <exception cref="T:System.IO.IOException">
  6868. An I/O error occurred.
  6869. </exception>
  6870. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  6871. The server's response contained unexpected tokens.
  6872. </exception>
  6873. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  6874. The command failed.
  6875. </exception>
  6876. </member>
  6877. <member name="M:MailKit.Net.Imap.ImapFolder.GetMetadata(MailKit.MetadataTag,System.Threading.CancellationToken)">
  6878. <summary>
  6879. Get the specified metadata.
  6880. </summary>
  6881. <remarks>
  6882. Gets the specified metadata.
  6883. </remarks>
  6884. <returns>The requested metadata value.</returns>
  6885. <param name="tag">The metadata tag.</param>
  6886. <param name="cancellationToken">The cancellation token.</param>
  6887. <exception cref="T:System.ObjectDisposedException">
  6888. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  6889. </exception>
  6890. <exception cref="T:MailKit.ServiceNotConnectedException">
  6891. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  6892. </exception>
  6893. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  6894. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  6895. </exception>
  6896. <exception cref="T:System.NotSupportedException">
  6897. The IMAP server does not support the METADATA extension.
  6898. </exception>
  6899. <exception cref="T:System.OperationCanceledException">
  6900. The operation was canceled via the cancellation token.
  6901. </exception>
  6902. <exception cref="T:System.IO.IOException">
  6903. An I/O error occurred.
  6904. </exception>
  6905. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  6906. The server's response contained unexpected tokens.
  6907. </exception>
  6908. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  6909. The server replied with a NO or BAD response.
  6910. </exception>
  6911. </member>
  6912. <member name="M:MailKit.Net.Imap.ImapFolder.GetMetadataAsync(MailKit.MetadataTag,System.Threading.CancellationToken)">
  6913. <summary>
  6914. Asynchronously get the specified metadata.
  6915. </summary>
  6916. <remarks>
  6917. Gets the specified metadata.
  6918. </remarks>
  6919. <returns>The requested metadata value.</returns>
  6920. <param name="tag">The metadata tag.</param>
  6921. <param name="cancellationToken">The cancellation token.</param>
  6922. <exception cref="T:System.ObjectDisposedException">
  6923. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  6924. </exception>
  6925. <exception cref="T:MailKit.ServiceNotConnectedException">
  6926. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  6927. </exception>
  6928. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  6929. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  6930. </exception>
  6931. <exception cref="T:System.NotSupportedException">
  6932. The IMAP server does not support the METADATA extension.
  6933. </exception>
  6934. <exception cref="T:System.OperationCanceledException">
  6935. The operation was canceled via the cancellation token.
  6936. </exception>
  6937. <exception cref="T:System.IO.IOException">
  6938. An I/O error occurred.
  6939. </exception>
  6940. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  6941. The server's response contained unexpected tokens.
  6942. </exception>
  6943. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  6944. The server replied with a NO or BAD response.
  6945. </exception>
  6946. </member>
  6947. <member name="M:MailKit.Net.Imap.ImapFolder.GetMetadata(MailKit.MetadataOptions,System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
  6948. <summary>
  6949. Get the specified metadata.
  6950. </summary>
  6951. <remarks>
  6952. Gets the specified metadata.
  6953. </remarks>
  6954. <returns>The requested metadata.</returns>
  6955. <param name="options">The metadata options.</param>
  6956. <param name="tags">The metadata tags.</param>
  6957. <param name="cancellationToken">The cancellation token.</param>
  6958. <exception cref="T:System.ArgumentNullException">
  6959. <para><paramref name="options"/> is <c>null</c>.</para>
  6960. <para>-or-</para>
  6961. <para><paramref name="tags"/> is <c>null</c>.</para>
  6962. </exception>
  6963. <exception cref="T:System.ObjectDisposedException">
  6964. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  6965. </exception>
  6966. <exception cref="T:MailKit.ServiceNotConnectedException">
  6967. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  6968. </exception>
  6969. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  6970. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  6971. </exception>
  6972. <exception cref="T:System.NotSupportedException">
  6973. The IMAP server does not support the METADATA extension.
  6974. </exception>
  6975. <exception cref="T:System.OperationCanceledException">
  6976. The operation was canceled via the cancellation token.
  6977. </exception>
  6978. <exception cref="T:System.IO.IOException">
  6979. An I/O error occurred.
  6980. </exception>
  6981. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  6982. The server's response contained unexpected tokens.
  6983. </exception>
  6984. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  6985. The server replied with a NO or BAD response.
  6986. </exception>
  6987. </member>
  6988. <member name="M:MailKit.Net.Imap.ImapFolder.GetMetadataAsync(MailKit.MetadataOptions,System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
  6989. <summary>
  6990. Asynchronously get the specified metadata.
  6991. </summary>
  6992. <remarks>
  6993. Gets the specified metadata.
  6994. </remarks>
  6995. <returns>The requested metadata.</returns>
  6996. <param name="options">The metadata options.</param>
  6997. <param name="tags">The metadata tags.</param>
  6998. <param name="cancellationToken">The cancellation token.</param>
  6999. <exception cref="T:System.ArgumentNullException">
  7000. <para><paramref name="options"/> is <c>null</c>.</para>
  7001. <para>-or-</para>
  7002. <para><paramref name="tags"/> is <c>null</c>.</para>
  7003. </exception>
  7004. <exception cref="T:System.ObjectDisposedException">
  7005. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  7006. </exception>
  7007. <exception cref="T:MailKit.ServiceNotConnectedException">
  7008. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  7009. </exception>
  7010. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  7011. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  7012. </exception>
  7013. <exception cref="T:System.NotSupportedException">
  7014. The IMAP server does not support the METADATA extension.
  7015. </exception>
  7016. <exception cref="T:System.OperationCanceledException">
  7017. The operation was canceled via the cancellation token.
  7018. </exception>
  7019. <exception cref="T:System.IO.IOException">
  7020. An I/O error occurred.
  7021. </exception>
  7022. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  7023. The server's response contained unexpected tokens.
  7024. </exception>
  7025. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  7026. The server replied with a NO or BAD response.
  7027. </exception>
  7028. </member>
  7029. <member name="M:MailKit.Net.Imap.ImapFolder.SetMetadata(MailKit.MetadataCollection,System.Threading.CancellationToken)">
  7030. <summary>
  7031. Set the specified metadata.
  7032. </summary>
  7033. <remarks>
  7034. Sets the specified metadata.
  7035. </remarks>
  7036. <param name="metadata">The metadata.</param>
  7037. <param name="cancellationToken">The cancellation token.</param>
  7038. <exception cref="T:System.ArgumentNullException">
  7039. <paramref name="metadata"/> is <c>null</c>.
  7040. </exception>
  7041. <exception cref="T:System.ObjectDisposedException">
  7042. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  7043. </exception>
  7044. <exception cref="T:MailKit.ServiceNotConnectedException">
  7045. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  7046. </exception>
  7047. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  7048. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  7049. </exception>
  7050. <exception cref="T:System.NotSupportedException">
  7051. The IMAP server does not support the METADATA extension.
  7052. </exception>
  7053. <exception cref="T:System.OperationCanceledException">
  7054. The operation was canceled via the cancellation token.
  7055. </exception>
  7056. <exception cref="T:System.IO.IOException">
  7057. An I/O error occurred.
  7058. </exception>
  7059. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  7060. The server's response contained unexpected tokens.
  7061. </exception>
  7062. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  7063. The server replied with a NO or BAD response.
  7064. </exception>
  7065. </member>
  7066. <member name="M:MailKit.Net.Imap.ImapFolder.SetMetadataAsync(MailKit.MetadataCollection,System.Threading.CancellationToken)">
  7067. <summary>
  7068. Asynchronously set the specified metadata.
  7069. </summary>
  7070. <remarks>
  7071. Sets the specified metadata.
  7072. </remarks>
  7073. <returns>An asynchronous task context.</returns>
  7074. <param name="metadata">The metadata.</param>
  7075. <param name="cancellationToken">The cancellation token.</param>
  7076. <exception cref="T:System.ArgumentNullException">
  7077. <paramref name="metadata"/> is <c>null</c>.
  7078. </exception>
  7079. <exception cref="T:System.ObjectDisposedException">
  7080. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  7081. </exception>
  7082. <exception cref="T:MailKit.ServiceNotConnectedException">
  7083. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  7084. </exception>
  7085. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  7086. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  7087. </exception>
  7088. <exception cref="T:System.NotSupportedException">
  7089. The IMAP server does not support the METADATA extension.
  7090. </exception>
  7091. <exception cref="T:System.OperationCanceledException">
  7092. The operation was canceled via the cancellation token.
  7093. </exception>
  7094. <exception cref="T:System.IO.IOException">
  7095. An I/O error occurred.
  7096. </exception>
  7097. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  7098. The server's response contained unexpected tokens.
  7099. </exception>
  7100. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  7101. The server replied with a NO or BAD response.
  7102. </exception>
  7103. </member>
  7104. <member name="M:MailKit.Net.Imap.ImapFolder.GetQuota(System.Threading.CancellationToken)">
  7105. <summary>
  7106. Get the quota information for the folder.
  7107. </summary>
  7108. <remarks>
  7109. <para>Gets the quota information for the folder.</para>
  7110. <para>To determine if a quotas are supported, check the
  7111. <see cref="P:MailKit.Net.Imap.ImapClient.SupportsQuotas"/> property.</para>
  7112. </remarks>
  7113. <returns>The folder quota.</returns>
  7114. <param name="cancellationToken">The cancellation token.</param>
  7115. <exception cref="T:System.ObjectDisposedException">
  7116. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  7117. </exception>
  7118. <exception cref="T:MailKit.ServiceNotConnectedException">
  7119. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  7120. </exception>
  7121. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  7122. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  7123. </exception>
  7124. <exception cref="T:System.NotSupportedException">
  7125. The IMAP server does not support the QUOTA extension.
  7126. </exception>
  7127. <exception cref="T:System.OperationCanceledException">
  7128. The operation was canceled via the cancellation token.
  7129. </exception>
  7130. <exception cref="T:System.IO.IOException">
  7131. An I/O error occurred.
  7132. </exception>
  7133. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  7134. The server's response contained unexpected tokens.
  7135. </exception>
  7136. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  7137. The server replied with a NO or BAD response.
  7138. </exception>
  7139. </member>
  7140. <member name="M:MailKit.Net.Imap.ImapFolder.GetQuotaAsync(System.Threading.CancellationToken)">
  7141. <summary>
  7142. Asynchronously get the quota information for the folder.
  7143. </summary>
  7144. <remarks>
  7145. <para>Gets the quota information for the folder.</para>
  7146. <para>To determine if a quotas are supported, check the
  7147. <see cref="P:MailKit.Net.Imap.ImapClient.SupportsQuotas"/> property.</para>
  7148. </remarks>
  7149. <returns>The folder quota.</returns>
  7150. <param name="cancellationToken">The cancellation token.</param>
  7151. <exception cref="T:System.ObjectDisposedException">
  7152. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  7153. </exception>
  7154. <exception cref="T:MailKit.ServiceNotConnectedException">
  7155. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  7156. </exception>
  7157. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  7158. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  7159. </exception>
  7160. <exception cref="T:System.NotSupportedException">
  7161. The IMAP server does not support the QUOTA extension.
  7162. </exception>
  7163. <exception cref="T:System.OperationCanceledException">
  7164. The operation was canceled via the cancellation token.
  7165. </exception>
  7166. <exception cref="T:System.IO.IOException">
  7167. An I/O error occurred.
  7168. </exception>
  7169. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  7170. The server's response contained unexpected tokens.
  7171. </exception>
  7172. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  7173. The server replied with a NO or BAD response.
  7174. </exception>
  7175. </member>
  7176. <member name="M:MailKit.Net.Imap.ImapFolder.SetQuota(System.Nullable{System.UInt32},System.Nullable{System.UInt32},System.Threading.CancellationToken)">
  7177. <summary>
  7178. Set the quota limits for the folder.
  7179. </summary>
  7180. <remarks>
  7181. <para>Sets the quota limits for the folder.</para>
  7182. <para>To determine if a quotas are supported, check the
  7183. <see cref="P:MailKit.Net.Imap.ImapClient.SupportsQuotas"/> property.</para>
  7184. </remarks>
  7185. <returns>The folder quota.</returns>
  7186. <param name="messageLimit">If not <c>null</c>, sets the maximum number of messages to allow.</param>
  7187. <param name="storageLimit">If not <c>null</c>, sets the maximum storage size (in kilobytes).</param>
  7188. <param name="cancellationToken">The cancellation token.</param>
  7189. <exception cref="T:System.ObjectDisposedException">
  7190. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  7191. </exception>
  7192. <exception cref="T:MailKit.ServiceNotConnectedException">
  7193. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  7194. </exception>
  7195. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  7196. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  7197. </exception>
  7198. <exception cref="T:System.NotSupportedException">
  7199. The IMAP server does not support the QUOTA extension.
  7200. </exception>
  7201. <exception cref="T:System.OperationCanceledException">
  7202. The operation was canceled via the cancellation token.
  7203. </exception>
  7204. <exception cref="T:System.IO.IOException">
  7205. An I/O error occurred.
  7206. </exception>
  7207. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  7208. The server's response contained unexpected tokens.
  7209. </exception>
  7210. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  7211. The server replied with a NO or BAD response.
  7212. </exception>
  7213. </member>
  7214. <member name="M:MailKit.Net.Imap.ImapFolder.SetQuotaAsync(System.Nullable{System.UInt32},System.Nullable{System.UInt32},System.Threading.CancellationToken)">
  7215. <summary>
  7216. Asynchronously set the quota limits for the folder.
  7217. </summary>
  7218. <remarks>
  7219. <para>Sets the quota limits for the folder.</para>
  7220. <para>To determine if a quotas are supported, check the
  7221. <see cref="P:MailKit.Net.Imap.ImapClient.SupportsQuotas"/> property.</para>
  7222. </remarks>
  7223. <returns>The folder quota.</returns>
  7224. <param name="messageLimit">If not <c>null</c>, sets the maximum number of messages to allow.</param>
  7225. <param name="storageLimit">If not <c>null</c>, sets the maximum storage size (in kilobytes).</param>
  7226. <param name="cancellationToken">The cancellation token.</param>
  7227. <exception cref="T:System.ObjectDisposedException">
  7228. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  7229. </exception>
  7230. <exception cref="T:MailKit.ServiceNotConnectedException">
  7231. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  7232. </exception>
  7233. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  7234. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  7235. </exception>
  7236. <exception cref="T:System.NotSupportedException">
  7237. The IMAP server does not support the QUOTA extension.
  7238. </exception>
  7239. <exception cref="T:System.OperationCanceledException">
  7240. The operation was canceled via the cancellation token.
  7241. </exception>
  7242. <exception cref="T:System.IO.IOException">
  7243. An I/O error occurred.
  7244. </exception>
  7245. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  7246. The server's response contained unexpected tokens.
  7247. </exception>
  7248. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  7249. The server replied with a NO or BAD response.
  7250. </exception>
  7251. </member>
  7252. <member name="M:MailKit.Net.Imap.ImapFolder.Expunge(System.Threading.CancellationToken)">
  7253. <summary>
  7254. Expunge the folder, permanently removing all messages marked for deletion.
  7255. </summary>
  7256. <remarks>
  7257. <para>The <c>EXPUNGE</c> command permanently removes all messages in the folder
  7258. that have the <see cref="F:MailKit.MessageFlags.Deleted"/> flag set.</para>
  7259. <para>For more information about the <c>EXPUNGE</c> command, see
  7260. <a href="https://tools.ietf.org/html/rfc3501#section-6.4.3">rfc3501</a>.</para>
  7261. <note type="note">Normally, a <see cref="E:MailKit.MailFolder.MessageExpunged"/> event will be emitted
  7262. for each message that is expunged. However, if the IMAP server supports the QRESYNC extension
  7263. and it has been enabled via the <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>
  7264. method, then the <see cref="E:MailKit.MailFolder.MessagesVanished"/> event will be emitted rather than
  7265. the <see cref="E:MailKit.MailFolder.MessageExpunged"/> event.</note>
  7266. </remarks>
  7267. <param name="cancellationToken">The cancellation token.</param>
  7268. <exception cref="T:System.ObjectDisposedException">
  7269. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  7270. </exception>
  7271. <exception cref="T:MailKit.FolderNotOpenException">
  7272. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  7273. </exception>
  7274. <exception cref="T:MailKit.ServiceNotConnectedException">
  7275. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  7276. </exception>
  7277. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  7278. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  7279. </exception>
  7280. <exception cref="T:System.OperationCanceledException">
  7281. The operation was canceled via the cancellation token.
  7282. </exception>
  7283. <exception cref="T:System.IO.IOException">
  7284. An I/O error occurred.
  7285. </exception>
  7286. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  7287. The server's response contained unexpected tokens.
  7288. </exception>
  7289. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  7290. The server replied with a NO or BAD response.
  7291. </exception>
  7292. </member>
  7293. <member name="M:MailKit.Net.Imap.ImapFolder.ExpungeAsync(System.Threading.CancellationToken)">
  7294. <summary>
  7295. Asynchronously expunge the folder, permanently removing all messages marked for deletion.
  7296. </summary>
  7297. <remarks>
  7298. <para>The <c>EXPUNGE</c> command permanently removes all messages in the folder
  7299. that have the <see cref="F:MailKit.MessageFlags.Deleted"/> flag set.</para>
  7300. <para>For more information about the <c>EXPUNGE</c> command, see
  7301. <a href="https://tools.ietf.org/html/rfc3501#section-6.4.3">rfc3501</a>.</para>
  7302. <note type="note">Normally, a <see cref="E:MailKit.MailFolder.MessageExpunged"/> event will be emitted
  7303. for each message that is expunged. However, if the IMAP server supports the QRESYNC extension
  7304. and it has been enabled via the <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>
  7305. method, then the <see cref="E:MailKit.MailFolder.MessagesVanished"/> event will be emitted rather than
  7306. the <see cref="E:MailKit.MailFolder.MessageExpunged"/> event.</note>
  7307. </remarks>
  7308. <returns>An asynchronous task context.</returns>
  7309. <param name="cancellationToken">The cancellation token.</param>
  7310. <exception cref="T:System.ObjectDisposedException">
  7311. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  7312. </exception>
  7313. <exception cref="T:MailKit.FolderNotOpenException">
  7314. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  7315. </exception>
  7316. <exception cref="T:MailKit.ServiceNotConnectedException">
  7317. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  7318. </exception>
  7319. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  7320. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  7321. </exception>
  7322. <exception cref="T:System.OperationCanceledException">
  7323. The operation was canceled via the cancellation token.
  7324. </exception>
  7325. <exception cref="T:System.IO.IOException">
  7326. An I/O error occurred.
  7327. </exception>
  7328. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  7329. The server's response contained unexpected tokens.
  7330. </exception>
  7331. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  7332. The server replied with a NO or BAD response.
  7333. </exception>
  7334. </member>
  7335. <member name="M:MailKit.Net.Imap.ImapFolder.Expunge(System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)">
  7336. <summary>
  7337. Expunge the specified uids, permanently removing them from the folder.
  7338. </summary>
  7339. <remarks>
  7340. <para>Expunges the specified uids, permanently removing them from the folder.</para>
  7341. <para>If the IMAP server supports the UIDPLUS extension (check the
  7342. <see cref="P:MailKit.Net.Imap.ImapClient.Capabilities"/> for the <see cref="F:MailKit.Net.Imap.ImapCapabilities.UidPlus"/>
  7343. flag), then this operation is atomic. Otherwise, MailKit implements this operation
  7344. by first searching for the full list of message uids in the folder that are marked for
  7345. deletion, unmarking the set of message uids that are not within the specified list of
  7346. uids to be be expunged, expunging the folder (thus expunging the requested uids), and
  7347. finally restoring the deleted flag on the collection of message uids that were originally
  7348. marked for deletion that were not included in the list of uids provided. For this reason,
  7349. it is advisable for clients that wish to maintain state to implement this themselves when
  7350. the IMAP server does not support the UIDPLUS extension.</para>
  7351. <para>For more information about the <c>UID EXPUNGE</c> command, see
  7352. <a href="https://tools.ietf.org/html/rfc4315#section-2.1">rfc4315</a>.</para>
  7353. <note type="note">Normally, a <see cref="E:MailKit.MailFolder.MessageExpunged"/> event will be emitted
  7354. for each message that is expunged. However, if the IMAP server supports the QRESYNC extension
  7355. and it has been enabled via the <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>
  7356. method, then the <see cref="E:MailKit.MailFolder.MessagesVanished"/> event will be emitted rather than
  7357. the <see cref="E:MailKit.MailFolder.MessageExpunged"/> event.</note>
  7358. </remarks>
  7359. <param name="uids">The message uids.</param>
  7360. <param name="cancellationToken">The cancellation token.</param>
  7361. <exception cref="T:System.ArgumentNullException">
  7362. <paramref name="uids"/> is <c>null</c>.
  7363. </exception>
  7364. <exception cref="T:System.ArgumentException">
  7365. One or more of the <paramref name="uids"/> is invalid.
  7366. </exception>
  7367. <exception cref="T:System.ObjectDisposedException">
  7368. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  7369. </exception>
  7370. <exception cref="T:MailKit.ServiceNotConnectedException">
  7371. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  7372. </exception>
  7373. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  7374. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  7375. </exception>
  7376. <exception cref="T:MailKit.FolderNotOpenException">
  7377. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  7378. </exception>
  7379. <exception cref="T:System.OperationCanceledException">
  7380. The operation was canceled via the cancellation token.
  7381. </exception>
  7382. <exception cref="T:System.IO.IOException">
  7383. An I/O error occurred.
  7384. </exception>
  7385. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  7386. The server's response contained unexpected tokens.
  7387. </exception>
  7388. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  7389. The server replied with a NO or BAD response.
  7390. </exception>
  7391. </member>
  7392. <member name="M:MailKit.Net.Imap.ImapFolder.ExpungeAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)">
  7393. <summary>
  7394. Asynchronously expunge the specified uids, permanently removing them from the folder.
  7395. </summary>
  7396. <remarks>
  7397. <para>Expunges the specified uids, permanently removing them from the folder.</para>
  7398. <para>If the IMAP server supports the UIDPLUS extension (check the
  7399. <see cref="P:MailKit.Net.Imap.ImapClient.Capabilities"/> for the <see cref="F:MailKit.Net.Imap.ImapCapabilities.UidPlus"/>
  7400. flag), then this operation is atomic. Otherwise, MailKit implements this operation
  7401. by first searching for the full list of message uids in the folder that are marked for
  7402. deletion, unmarking the set of message uids that are not within the specified list of
  7403. uids to be be expunged, expunging the folder (thus expunging the requested uids), and
  7404. finally restoring the deleted flag on the collection of message uids that were originally
  7405. marked for deletion that were not included in the list of uids provided. For this reason,
  7406. it is advisable for clients that wish to maintain state to implement this themselves when
  7407. the IMAP server does not support the UIDPLUS extension.</para>
  7408. <para>For more information about the <c>UID EXPUNGE</c> command, see
  7409. <a href="https://tools.ietf.org/html/rfc4315#section-2.1">rfc4315</a>.</para>
  7410. <note type="note">Normally, a <see cref="E:MailKit.MailFolder.MessageExpunged"/> event will be emitted
  7411. for each message that is expunged. However, if the IMAP server supports the QRESYNC extension
  7412. and it has been enabled via the <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>
  7413. method, then the <see cref="E:MailKit.MailFolder.MessagesVanished"/> event will be emitted rather than
  7414. the <see cref="E:MailKit.MailFolder.MessageExpunged"/> event.</note>
  7415. </remarks>
  7416. <returns>An asynchronous task context.</returns>
  7417. <param name="uids">The message uids.</param>
  7418. <param name="cancellationToken">The cancellation token.</param>
  7419. <exception cref="T:System.ArgumentNullException">
  7420. <paramref name="uids"/> is <c>null</c>.
  7421. </exception>
  7422. <exception cref="T:System.ArgumentException">
  7423. One or more of the <paramref name="uids"/> is invalid.
  7424. </exception>
  7425. <exception cref="T:System.ObjectDisposedException">
  7426. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  7427. </exception>
  7428. <exception cref="T:MailKit.ServiceNotConnectedException">
  7429. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  7430. </exception>
  7431. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  7432. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  7433. </exception>
  7434. <exception cref="T:MailKit.FolderNotOpenException">
  7435. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  7436. </exception>
  7437. <exception cref="T:System.OperationCanceledException">
  7438. The operation was canceled via the cancellation token.
  7439. </exception>
  7440. <exception cref="T:System.IO.IOException">
  7441. An I/O error occurred.
  7442. </exception>
  7443. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  7444. The server's response contained unexpected tokens.
  7445. </exception>
  7446. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  7447. The server replied with a NO or BAD response.
  7448. </exception>
  7449. </member>
  7450. <member name="M:MailKit.Net.Imap.ImapFolder.Append(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  7451. <summary>
  7452. Append the specified message to the folder.
  7453. </summary>
  7454. <remarks>
  7455. Appends the specified message to the folder and returns the UniqueId assigned to the message.
  7456. </remarks>
  7457. <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
  7458. <param name="options">The formatting options.</param>
  7459. <param name="message">The message.</param>
  7460. <param name="flags">The message flags.</param>
  7461. <param name="cancellationToken">The cancellation token.</param>
  7462. <param name="progress">The progress reporting mechanism.</param>
  7463. <exception cref="T:System.ArgumentNullException">
  7464. <para><paramref name="options"/> is <c>null</c>.</para>
  7465. <para>-or-</para>
  7466. <para><paramref name="message"/> is <c>null</c>.</para>
  7467. </exception>
  7468. <exception cref="T:System.ObjectDisposedException">
  7469. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  7470. </exception>
  7471. <exception cref="T:MailKit.ServiceNotConnectedException">
  7472. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  7473. </exception>
  7474. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  7475. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  7476. </exception>
  7477. <exception cref="T:System.InvalidOperationException">
  7478. Internationalized formatting was requested but has not been enabled.
  7479. </exception>
  7480. <exception cref="T:MailKit.FolderNotFoundException">
  7481. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
  7482. </exception>
  7483. <exception cref="T:System.OperationCanceledException">
  7484. The operation was canceled via the cancellation token.
  7485. </exception>
  7486. <exception cref="T:System.NotSupportedException">
  7487. Internationalized formatting was requested but is not supported by the server.
  7488. </exception>
  7489. <exception cref="T:System.IO.IOException">
  7490. An I/O error occurred.
  7491. </exception>
  7492. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  7493. The server's response contained unexpected tokens.
  7494. </exception>
  7495. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  7496. The server replied with a NO or BAD response.
  7497. </exception>
  7498. </member>
  7499. <member name="M:MailKit.Net.Imap.ImapFolder.AppendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  7500. <summary>
  7501. Asynchronously append the specified message to the folder.
  7502. </summary>
  7503. <remarks>
  7504. Appends the specified message to the folder and returns the UniqueId assigned to the message.
  7505. </remarks>
  7506. <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
  7507. <param name="options">The formatting options.</param>
  7508. <param name="message">The message.</param>
  7509. <param name="flags">The message flags.</param>
  7510. <param name="cancellationToken">The cancellation token.</param>
  7511. <param name="progress">The progress reporting mechanism.</param>
  7512. <exception cref="T:System.ArgumentNullException">
  7513. <para><paramref name="options"/> is <c>null</c>.</para>
  7514. <para>-or-</para>
  7515. <para><paramref name="message"/> is <c>null</c>.</para>
  7516. </exception>
  7517. <exception cref="T:System.ObjectDisposedException">
  7518. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  7519. </exception>
  7520. <exception cref="T:MailKit.ServiceNotConnectedException">
  7521. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  7522. </exception>
  7523. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  7524. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  7525. </exception>
  7526. <exception cref="T:System.InvalidOperationException">
  7527. Internationalized formatting was requested but has not been enabled.
  7528. </exception>
  7529. <exception cref="T:MailKit.FolderNotFoundException">
  7530. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
  7531. </exception>
  7532. <exception cref="T:System.OperationCanceledException">
  7533. The operation was canceled via the cancellation token.
  7534. </exception>
  7535. <exception cref="T:System.NotSupportedException">
  7536. Internationalized formatting was requested but is not supported by the server.
  7537. </exception>
  7538. <exception cref="T:System.IO.IOException">
  7539. An I/O error occurred.
  7540. </exception>
  7541. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  7542. The server's response contained unexpected tokens.
  7543. </exception>
  7544. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  7545. The server replied with a NO or BAD response.
  7546. </exception>
  7547. </member>
  7548. <member name="M:MailKit.Net.Imap.ImapFolder.Append(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.DateTimeOffset,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  7549. <summary>
  7550. Append the specified message to the folder.
  7551. </summary>
  7552. <remarks>
  7553. Appends the specified message to the folder and returns the UniqueId assigned to the message.
  7554. </remarks>
  7555. <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
  7556. <param name="options">The formatting options.</param>
  7557. <param name="message">The message.</param>
  7558. <param name="flags">The message flags.</param>
  7559. <param name="date">The received date of the message.</param>
  7560. <param name="cancellationToken">The cancellation token.</param>
  7561. <param name="progress">The progress reporting mechanism.</param>
  7562. <exception cref="T:System.ArgumentNullException">
  7563. <para><paramref name="options"/> is <c>null</c>.</para>
  7564. <para>-or-</para>
  7565. <para><paramref name="message"/> is <c>null</c>.</para>
  7566. </exception>
  7567. <exception cref="T:System.ObjectDisposedException">
  7568. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  7569. </exception>
  7570. <exception cref="T:MailKit.ServiceNotConnectedException">
  7571. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  7572. </exception>
  7573. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  7574. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  7575. </exception>
  7576. <exception cref="T:System.InvalidOperationException">
  7577. Internationalized formatting was requested but has not been enabled.
  7578. </exception>
  7579. <exception cref="T:MailKit.FolderNotFoundException">
  7580. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
  7581. </exception>
  7582. <exception cref="T:System.OperationCanceledException">
  7583. The operation was canceled via the cancellation token.
  7584. </exception>
  7585. <exception cref="T:System.NotSupportedException">
  7586. Internationalized formatting was requested but is not supported by the server.
  7587. </exception>
  7588. <exception cref="T:System.IO.IOException">
  7589. An I/O error occurred.
  7590. </exception>
  7591. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  7592. The server's response contained unexpected tokens.
  7593. </exception>
  7594. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  7595. The server replied with a NO or BAD response.
  7596. </exception>
  7597. </member>
  7598. <member name="M:MailKit.Net.Imap.ImapFolder.AppendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.DateTimeOffset,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  7599. <summary>
  7600. Asynchronously append the specified message to the folder.
  7601. </summary>
  7602. <remarks>
  7603. Appends the specified message to the folder and returns the UniqueId assigned to the message.
  7604. </remarks>
  7605. <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
  7606. <param name="options">The formatting options.</param>
  7607. <param name="message">The message.</param>
  7608. <param name="flags">The message flags.</param>
  7609. <param name="date">The received date of the message.</param>
  7610. <param name="cancellationToken">The cancellation token.</param>
  7611. <param name="progress">The progress reporting mechanism.</param>
  7612. <exception cref="T:System.ArgumentNullException">
  7613. <para><paramref name="options"/> is <c>null</c>.</para>
  7614. <para>-or-</para>
  7615. <para><paramref name="message"/> is <c>null</c>.</para>
  7616. </exception>
  7617. <exception cref="T:System.ObjectDisposedException">
  7618. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  7619. </exception>
  7620. <exception cref="T:MailKit.ServiceNotConnectedException">
  7621. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  7622. </exception>
  7623. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  7624. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  7625. </exception>
  7626. <exception cref="T:System.InvalidOperationException">
  7627. Internationalized formatting was requested but has not been enabled.
  7628. </exception>
  7629. <exception cref="T:MailKit.FolderNotFoundException">
  7630. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
  7631. </exception>
  7632. <exception cref="T:System.OperationCanceledException">
  7633. The operation was canceled via the cancellation token.
  7634. </exception>
  7635. <exception cref="T:System.NotSupportedException">
  7636. Internationalized formatting was requested but is not supported by the server.
  7637. </exception>
  7638. <exception cref="T:System.IO.IOException">
  7639. An I/O error occurred.
  7640. </exception>
  7641. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  7642. The server's response contained unexpected tokens.
  7643. </exception>
  7644. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  7645. The server replied with a NO or BAD response.
  7646. </exception>
  7647. </member>
  7648. <member name="M:MailKit.Net.Imap.ImapFolder.Append(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.Nullable{System.DateTimeOffset},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  7649. <summary>
  7650. Append the specified message to the folder.
  7651. </summary>
  7652. <remarks>
  7653. Appends the specified message to the folder and returns the UniqueId assigned to the message.
  7654. </remarks>
  7655. <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
  7656. <param name="options">The formatting options.</param>
  7657. <param name="message">The message.</param>
  7658. <param name="flags">The message flags.</param>
  7659. <param name="date">The received date of the message.</param>
  7660. <param name="annotations">The message annotations.</param>
  7661. <param name="cancellationToken">The cancellation token.</param>
  7662. <param name="progress">The progress reporting mechanism.</param>
  7663. <exception cref="T:System.ArgumentNullException">
  7664. <para><paramref name="options"/> is <c>null</c>.</para>
  7665. <para>-or-</para>
  7666. <para><paramref name="message"/> is <c>null</c>.</para>
  7667. </exception>
  7668. <exception cref="T:System.ObjectDisposedException">
  7669. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  7670. </exception>
  7671. <exception cref="T:MailKit.ServiceNotConnectedException">
  7672. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  7673. </exception>
  7674. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  7675. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  7676. </exception>
  7677. <exception cref="T:System.InvalidOperationException">
  7678. Internationalized formatting was requested but has not been enabled.
  7679. </exception>
  7680. <exception cref="T:MailKit.FolderNotFoundException">
  7681. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
  7682. </exception>
  7683. <exception cref="T:System.OperationCanceledException">
  7684. The operation was canceled via the cancellation token.
  7685. </exception>
  7686. <exception cref="T:System.NotSupportedException">
  7687. Internationalized formatting was requested but is not supported by the server.
  7688. </exception>
  7689. <exception cref="T:System.IO.IOException">
  7690. An I/O error occurred.
  7691. </exception>
  7692. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  7693. The server's response contained unexpected tokens.
  7694. </exception>
  7695. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  7696. The server replied with a NO or BAD response.
  7697. </exception>
  7698. </member>
  7699. <member name="M:MailKit.Net.Imap.ImapFolder.AppendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.Nullable{System.DateTimeOffset},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  7700. <summary>
  7701. Asynchronously append the specified message to the folder.
  7702. </summary>
  7703. <remarks>
  7704. Appends the specified message to the folder and returns the UniqueId assigned to the message.
  7705. </remarks>
  7706. <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
  7707. <param name="options">The formatting options.</param>
  7708. <param name="message">The message.</param>
  7709. <param name="flags">The message flags.</param>
  7710. <param name="date">The received date of the message.</param>
  7711. <param name="annotations">The message annotations.</param>
  7712. <param name="cancellationToken">The cancellation token.</param>
  7713. <param name="progress">The progress reporting mechanism.</param>
  7714. <exception cref="T:System.ArgumentNullException">
  7715. <para><paramref name="options"/> is <c>null</c>.</para>
  7716. <para>-or-</para>
  7717. <para><paramref name="message"/> is <c>null</c>.</para>
  7718. </exception>
  7719. <exception cref="T:System.ObjectDisposedException">
  7720. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  7721. </exception>
  7722. <exception cref="T:MailKit.ServiceNotConnectedException">
  7723. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  7724. </exception>
  7725. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  7726. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  7727. </exception>
  7728. <exception cref="T:System.InvalidOperationException">
  7729. Internationalized formatting was requested but has not been enabled.
  7730. </exception>
  7731. <exception cref="T:MailKit.FolderNotFoundException">
  7732. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
  7733. </exception>
  7734. <exception cref="T:System.OperationCanceledException">
  7735. The operation was canceled via the cancellation token.
  7736. </exception>
  7737. <exception cref="T:System.NotSupportedException">
  7738. Internationalized formatting was requested but is not supported by the server.
  7739. </exception>
  7740. <exception cref="T:System.IO.IOException">
  7741. An I/O error occurred.
  7742. </exception>
  7743. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  7744. The server's response contained unexpected tokens.
  7745. </exception>
  7746. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  7747. The server replied with a NO or BAD response.
  7748. </exception>
  7749. </member>
  7750. <member name="M:MailKit.Net.Imap.ImapFolder.Append(MimeKit.FormatOptions,System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  7751. <summary>
  7752. Append the specified messages to the folder.
  7753. </summary>
  7754. <remarks>
  7755. Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
  7756. </remarks>
  7757. <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
  7758. <param name="options">The formatting options.</param>
  7759. <param name="messages">The list of messages to append to the folder.</param>
  7760. <param name="flags">The message flags to use for each message.</param>
  7761. <param name="cancellationToken">The cancellation token.</param>
  7762. <param name="progress">The progress reporting mechanism.</param>
  7763. <exception cref="T:System.ArgumentNullException">
  7764. <para><paramref name="options"/> is <c>null</c>.</para>
  7765. <para>-or-</para>
  7766. <para><paramref name="messages"/> is <c>null</c>.</para>
  7767. <para>-or-</para>
  7768. <para><paramref name="flags"/> is <c>null</c>.</para>
  7769. </exception>
  7770. <exception cref="T:System.ArgumentException">
  7771. <para>One or more of the <paramref name="messages"/> is null.</para>
  7772. <para>-or-</para>
  7773. <para>The number of messages does not match the number of flags.</para>
  7774. </exception>
  7775. <exception cref="T:System.ObjectDisposedException">
  7776. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  7777. </exception>
  7778. <exception cref="T:MailKit.ServiceNotConnectedException">
  7779. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  7780. </exception>
  7781. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  7782. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  7783. </exception>
  7784. <exception cref="T:System.InvalidOperationException">
  7785. Internationalized formatting was requested but has not been enabled.
  7786. </exception>
  7787. <exception cref="T:MailKit.FolderNotFoundException">
  7788. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
  7789. </exception>
  7790. <exception cref="T:System.OperationCanceledException">
  7791. The operation was canceled via the cancellation token.
  7792. </exception>
  7793. <exception cref="T:System.NotSupportedException">
  7794. Internationalized formatting was requested but is not supported by the server.
  7795. </exception>
  7796. <exception cref="T:System.IO.IOException">
  7797. An I/O error occurred.
  7798. </exception>
  7799. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  7800. The server's response contained unexpected tokens.
  7801. </exception>
  7802. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  7803. The server replied with a NO or BAD response.
  7804. </exception>
  7805. </member>
  7806. <member name="M:MailKit.Net.Imap.ImapFolder.AppendAsync(MimeKit.FormatOptions,System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  7807. <summary>
  7808. Asynchronously append the specified messages to the folder.
  7809. </summary>
  7810. <remarks>
  7811. Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
  7812. </remarks>
  7813. <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
  7814. <param name="options">The formatting options.</param>
  7815. <param name="messages">The list of messages to append to the folder.</param>
  7816. <param name="flags">The message flags to use for each message.</param>
  7817. <param name="cancellationToken">The cancellation token.</param>
  7818. <param name="progress">The progress reporting mechanism.</param>
  7819. <exception cref="T:System.ArgumentNullException">
  7820. <para><paramref name="options"/> is <c>null</c>.</para>
  7821. <para>-or-</para>
  7822. <para><paramref name="messages"/> is <c>null</c>.</para>
  7823. <para>-or-</para>
  7824. <para><paramref name="flags"/> is <c>null</c>.</para>
  7825. </exception>
  7826. <exception cref="T:System.ArgumentException">
  7827. <para>One or more of the <paramref name="messages"/> is null.</para>
  7828. <para>-or-</para>
  7829. <para>The number of messages does not match the number of flags.</para>
  7830. </exception>
  7831. <exception cref="T:System.ObjectDisposedException">
  7832. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  7833. </exception>
  7834. <exception cref="T:MailKit.ServiceNotConnectedException">
  7835. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  7836. </exception>
  7837. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  7838. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  7839. </exception>
  7840. <exception cref="T:System.InvalidOperationException">
  7841. Internationalized formatting was requested but has not been enabled.
  7842. </exception>
  7843. <exception cref="T:MailKit.FolderNotFoundException">
  7844. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
  7845. </exception>
  7846. <exception cref="T:System.OperationCanceledException">
  7847. The operation was canceled via the cancellation token.
  7848. </exception>
  7849. <exception cref="T:System.NotSupportedException">
  7850. Internationalized formatting was requested but is not supported by the server.
  7851. </exception>
  7852. <exception cref="T:System.IO.IOException">
  7853. An I/O error occurred.
  7854. </exception>
  7855. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  7856. The server's response contained unexpected tokens.
  7857. </exception>
  7858. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  7859. The server replied with a NO or BAD response.
  7860. </exception>
  7861. </member>
  7862. <member name="M:MailKit.Net.Imap.ImapFolder.Append(MimeKit.FormatOptions,System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Collections.Generic.IList{System.DateTimeOffset},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  7863. <summary>
  7864. Append the specified messages to the folder.
  7865. </summary>
  7866. <remarks>
  7867. Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
  7868. </remarks>
  7869. <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
  7870. <param name="options">The formatting options.</param>
  7871. <param name="messages">The list of messages to append to the folder.</param>
  7872. <param name="flags">The message flags to use for each of the messages.</param>
  7873. <param name="dates">The received dates to use for each of the messages.</param>
  7874. <param name="cancellationToken">The cancellation token.</param>
  7875. <param name="progress">The progress reporting mechanism.</param>
  7876. <exception cref="T:System.ArgumentNullException">
  7877. <para><paramref name="options"/> is <c>null</c>.</para>
  7878. <para>-or-</para>
  7879. <para><paramref name="messages"/> is <c>null</c>.</para>
  7880. <para>-or-</para>
  7881. <para><paramref name="flags"/> is <c>null</c>.</para>
  7882. <para>-or-</para>
  7883. <para><paramref name="dates"/> is <c>null</c>.</para>
  7884. </exception>
  7885. <exception cref="T:System.ArgumentException">
  7886. <para>One or more of the <paramref name="messages"/> is null.</para>
  7887. <para>-or-</para>
  7888. <para>The number of messages, flags, and dates do not match.</para>
  7889. </exception>
  7890. <exception cref="T:System.ObjectDisposedException">
  7891. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  7892. </exception>
  7893. <exception cref="T:MailKit.ServiceNotConnectedException">
  7894. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  7895. </exception>
  7896. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  7897. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  7898. </exception>
  7899. <exception cref="T:System.InvalidOperationException">
  7900. Internationalized formatting was requested but has not been enabled.
  7901. </exception>
  7902. <exception cref="T:MailKit.FolderNotFoundException">
  7903. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
  7904. </exception>
  7905. <exception cref="T:System.OperationCanceledException">
  7906. The operation was canceled via the cancellation token.
  7907. </exception>
  7908. <exception cref="T:System.NotSupportedException">
  7909. Internationalized formatting was requested but is not supported by the server.
  7910. </exception>
  7911. <exception cref="T:System.IO.IOException">
  7912. An I/O error occurred.
  7913. </exception>
  7914. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  7915. The server's response contained unexpected tokens.
  7916. </exception>
  7917. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  7918. The server replied with a NO or BAD response.
  7919. </exception>
  7920. </member>
  7921. <member name="M:MailKit.Net.Imap.ImapFolder.AppendAsync(MimeKit.FormatOptions,System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Collections.Generic.IList{System.DateTimeOffset},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  7922. <summary>
  7923. Asynchronously append the specified messages to the folder.
  7924. </summary>
  7925. <remarks>
  7926. Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
  7927. </remarks>
  7928. <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
  7929. <param name="options">The formatting options.</param>
  7930. <param name="messages">The list of messages to append to the folder.</param>
  7931. <param name="flags">The message flags to use for each of the messages.</param>
  7932. <param name="dates">The received dates to use for each of the messages.</param>
  7933. <param name="cancellationToken">The cancellation token.</param>
  7934. <param name="progress">The progress reporting mechanism.</param>
  7935. <exception cref="T:System.ArgumentNullException">
  7936. <para><paramref name="options"/> is <c>null</c>.</para>
  7937. <para>-or-</para>
  7938. <para><paramref name="messages"/> is <c>null</c>.</para>
  7939. <para>-or-</para>
  7940. <para><paramref name="flags"/> is <c>null</c>.</para>
  7941. <para>-or-</para>
  7942. <para><paramref name="dates"/> is <c>null</c>.</para>
  7943. </exception>
  7944. <exception cref="T:System.ArgumentException">
  7945. <para>One or more of the <paramref name="messages"/> is null.</para>
  7946. <para>-or-</para>
  7947. <para>The number of messages, flags, and dates do not match.</para>
  7948. </exception>
  7949. <exception cref="T:System.ObjectDisposedException">
  7950. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  7951. </exception>
  7952. <exception cref="T:MailKit.ServiceNotConnectedException">
  7953. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  7954. </exception>
  7955. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  7956. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  7957. </exception>
  7958. <exception cref="T:System.InvalidOperationException">
  7959. Internationalized formatting was requested but has not been enabled.
  7960. </exception>
  7961. <exception cref="T:MailKit.FolderNotFoundException">
  7962. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not exist.
  7963. </exception>
  7964. <exception cref="T:System.OperationCanceledException">
  7965. The operation was canceled via the cancellation token.
  7966. </exception>
  7967. <exception cref="T:System.NotSupportedException">
  7968. Internationalized formatting was requested but is not supported by the server.
  7969. </exception>
  7970. <exception cref="T:System.IO.IOException">
  7971. An I/O error occurred.
  7972. </exception>
  7973. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  7974. The server's response contained unexpected tokens.
  7975. </exception>
  7976. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  7977. The server replied with a NO or BAD response.
  7978. </exception>
  7979. </member>
  7980. <member name="M:MailKit.Net.Imap.ImapFolder.CopyTo(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.IMailFolder,System.Threading.CancellationToken)">
  7981. <summary>
  7982. Copy the specified messages to the destination folder.
  7983. </summary>
  7984. <remarks>
  7985. Copies the specified messages to the destination folder.
  7986. </remarks>
  7987. <returns>The UID mapping of the messages in the destination folder, if available; otherwise an empty mapping.</returns>
  7988. <param name="uids">The UIDs of the messages to copy.</param>
  7989. <param name="destination">The destination folder.</param>
  7990. <param name="cancellationToken">The cancellation token.</param>
  7991. <exception cref="T:System.ArgumentNullException">
  7992. <para><paramref name="uids"/> is <c>null</c>.</para>
  7993. <para>-or-</para>
  7994. <para><paramref name="destination"/> is <c>null</c>.</para>
  7995. </exception>
  7996. <exception cref="T:System.ArgumentException">
  7997. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  7998. <para>-or-</para>
  7999. <para>The destination folder does not belong to the <see cref="T:MailKit.Net.Imap.ImapClient"/>.</para>
  8000. </exception>
  8001. <exception cref="T:System.ObjectDisposedException">
  8002. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  8003. </exception>
  8004. <exception cref="T:MailKit.ServiceNotConnectedException">
  8005. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  8006. </exception>
  8007. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  8008. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  8009. </exception>
  8010. <exception cref="T:MailKit.FolderNotFoundException">
  8011. <paramref name="destination"/> does not exist.
  8012. </exception>
  8013. <exception cref="T:MailKit.FolderNotOpenException">
  8014. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  8015. </exception>
  8016. <exception cref="T:System.NotSupportedException">
  8017. The IMAP server does not support the UIDPLUS extension.
  8018. </exception>
  8019. <exception cref="T:System.OperationCanceledException">
  8020. The operation was canceled via the cancellation token.
  8021. </exception>
  8022. <exception cref="T:System.IO.IOException">
  8023. An I/O error occurred.
  8024. </exception>
  8025. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  8026. The server's response contained unexpected tokens.
  8027. </exception>
  8028. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  8029. The server replied with a NO or BAD response.
  8030. </exception>
  8031. </member>
  8032. <member name="M:MailKit.Net.Imap.ImapFolder.CopyToAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.IMailFolder,System.Threading.CancellationToken)">
  8033. <summary>
  8034. Asynchronously copy the specified messages to the destination folder.
  8035. </summary>
  8036. <remarks>
  8037. Copies the specified messages to the destination folder.
  8038. </remarks>
  8039. <returns>The UID mapping of the messages in the destination folder, if available; otherwise an empty mapping.</returns>
  8040. <param name="uids">The UIDs of the messages to copy.</param>
  8041. <param name="destination">The destination folder.</param>
  8042. <param name="cancellationToken">The cancellation token.</param>
  8043. <exception cref="T:System.ArgumentNullException">
  8044. <para><paramref name="uids"/> is <c>null</c>.</para>
  8045. <para>-or-</para>
  8046. <para><paramref name="destination"/> is <c>null</c>.</para>
  8047. </exception>
  8048. <exception cref="T:System.ArgumentException">
  8049. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  8050. <para>-or-</para>
  8051. <para>The destination folder does not belong to the <see cref="T:MailKit.Net.Imap.ImapClient"/>.</para>
  8052. </exception>
  8053. <exception cref="T:System.ObjectDisposedException">
  8054. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  8055. </exception>
  8056. <exception cref="T:MailKit.ServiceNotConnectedException">
  8057. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  8058. </exception>
  8059. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  8060. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  8061. </exception>
  8062. <exception cref="T:MailKit.FolderNotFoundException">
  8063. <paramref name="destination"/> does not exist.
  8064. </exception>
  8065. <exception cref="T:MailKit.FolderNotOpenException">
  8066. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  8067. </exception>
  8068. <exception cref="T:System.NotSupportedException">
  8069. The IMAP server does not support the UIDPLUS extension.
  8070. </exception>
  8071. <exception cref="T:System.OperationCanceledException">
  8072. The operation was canceled via the cancellation token.
  8073. </exception>
  8074. <exception cref="T:System.IO.IOException">
  8075. An I/O error occurred.
  8076. </exception>
  8077. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  8078. The server's response contained unexpected tokens.
  8079. </exception>
  8080. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  8081. The server replied with a NO or BAD response.
  8082. </exception>
  8083. </member>
  8084. <member name="M:MailKit.Net.Imap.ImapFolder.MoveTo(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.IMailFolder,System.Threading.CancellationToken)">
  8085. <summary>
  8086. Move the specified messages to the destination folder.
  8087. </summary>
  8088. <remarks>
  8089. <para>Moves the specified messages to the destination folder.</para>
  8090. <para>If the IMAP server supports the MOVE extension (check the <see cref="P:MailKit.Net.Imap.ImapClient.Capabilities"/>
  8091. property for the <see cref="F:MailKit.Net.Imap.ImapCapabilities.Move"/> flag), then this operation will be atomic.
  8092. Otherwise, MailKit implements this by first copying the messages to the destination folder, then
  8093. marking them for deletion in the originating folder, and finally expunging them (see
  8094. <see cref="M:MailKit.Net.Imap.ImapFolder.Expunge(System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)"/> for more information about how a
  8095. subset of messages are expunged). Since the server could disconnect at any point between those 3
  8096. (or more) commands, it is advisable for clients to implement their own logic for moving messages when
  8097. the IMAP server does not support the MOVE command in order to better handle spontanious server
  8098. disconnects and other error conditions.</para>
  8099. </remarks>
  8100. <returns>The UID mapping of the messages in the destination folder, if available; otherwise an empty mapping.</returns>
  8101. <param name="uids">The UIDs of the messages to move.</param>
  8102. <param name="destination">The destination folder.</param>
  8103. <param name="cancellationToken">The cancellation token.</param>
  8104. <exception cref="T:System.ArgumentNullException">
  8105. <para><paramref name="uids"/> is <c>null</c>.</para>
  8106. <para>-or-</para>
  8107. <para><paramref name="destination"/> is <c>null</c>.</para>
  8108. </exception>
  8109. <exception cref="T:System.ArgumentException">
  8110. <para><paramref name="uids"/> is empty.</para>
  8111. <para>-or-</para>
  8112. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  8113. <para>-or-</para>
  8114. <para>The destination folder does not belong to the <see cref="T:MailKit.Net.Imap.ImapClient"/>.</para>
  8115. </exception>
  8116. <exception cref="T:System.ObjectDisposedException">
  8117. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  8118. </exception>
  8119. <exception cref="T:MailKit.ServiceNotConnectedException">
  8120. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  8121. </exception>
  8122. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  8123. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  8124. </exception>
  8125. <exception cref="T:MailKit.FolderNotFoundException">
  8126. <paramref name="destination"/> does not exist.
  8127. </exception>
  8128. <exception cref="T:MailKit.FolderNotOpenException">
  8129. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  8130. </exception>
  8131. <exception cref="T:System.OperationCanceledException">
  8132. The operation was canceled via the cancellation token.
  8133. </exception>
  8134. <exception cref="T:System.IO.IOException">
  8135. An I/O error occurred.
  8136. </exception>
  8137. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  8138. The server's response contained unexpected tokens.
  8139. </exception>
  8140. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  8141. The server replied with a NO or BAD response.
  8142. </exception>
  8143. </member>
  8144. <member name="M:MailKit.Net.Imap.ImapFolder.MoveToAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.IMailFolder,System.Threading.CancellationToken)">
  8145. <summary>
  8146. Asynchronously move the specified messages to the destination folder.
  8147. </summary>
  8148. <remarks>
  8149. <para>Moves the specified messages to the destination folder.</para>
  8150. <para>If the IMAP server supports the MOVE extension (check the <see cref="P:MailKit.Net.Imap.ImapClient.Capabilities"/>
  8151. property for the <see cref="F:MailKit.Net.Imap.ImapCapabilities.Move"/> flag), then this operation will be atomic.
  8152. Otherwise, MailKit implements this by first copying the messages to the destination folder, then
  8153. marking them for deletion in the originating folder, and finally expunging them (see
  8154. <see cref="M:MailKit.Net.Imap.ImapFolder.Expunge(System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)"/> for more information about how a
  8155. subset of messages are expunged). Since the server could disconnect at any point between those 3
  8156. (or more) commands, it is advisable for clients to implement their own logic for moving messages when
  8157. the IMAP server does not support the MOVE command in order to better handle spontanious server
  8158. disconnects and other error conditions.</para>
  8159. </remarks>
  8160. <returns>The UID mapping of the messages in the destination folder, if available; otherwise an empty mapping.</returns>
  8161. <param name="uids">The UIDs of the messages to move.</param>
  8162. <param name="destination">The destination folder.</param>
  8163. <param name="cancellationToken">The cancellation token.</param>
  8164. <exception cref="T:System.ArgumentNullException">
  8165. <para><paramref name="uids"/> is <c>null</c>.</para>
  8166. <para>-or-</para>
  8167. <para><paramref name="destination"/> is <c>null</c>.</para>
  8168. </exception>
  8169. <exception cref="T:System.ArgumentException">
  8170. <para><paramref name="uids"/> is empty.</para>
  8171. <para>-or-</para>
  8172. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  8173. <para>-or-</para>
  8174. <para>The destination folder does not belong to the <see cref="T:MailKit.Net.Imap.ImapClient"/>.</para>
  8175. </exception>
  8176. <exception cref="T:System.ObjectDisposedException">
  8177. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  8178. </exception>
  8179. <exception cref="T:MailKit.ServiceNotConnectedException">
  8180. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  8181. </exception>
  8182. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  8183. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  8184. </exception>
  8185. <exception cref="T:MailKit.FolderNotFoundException">
  8186. <paramref name="destination"/> does not exist.
  8187. </exception>
  8188. <exception cref="T:MailKit.FolderNotOpenException">
  8189. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  8190. </exception>
  8191. <exception cref="T:System.OperationCanceledException">
  8192. The operation was canceled via the cancellation token.
  8193. </exception>
  8194. <exception cref="T:System.IO.IOException">
  8195. An I/O error occurred.
  8196. </exception>
  8197. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  8198. The server's response contained unexpected tokens.
  8199. </exception>
  8200. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  8201. The server replied with a NO or BAD response.
  8202. </exception>
  8203. </member>
  8204. <member name="M:MailKit.Net.Imap.ImapFolder.CopyTo(System.Collections.Generic.IList{System.Int32},MailKit.IMailFolder,System.Threading.CancellationToken)">
  8205. <summary>
  8206. Copy the specified messages to the destination folder.
  8207. </summary>
  8208. <remarks>
  8209. Copies the specified messages to the destination folder.
  8210. </remarks>
  8211. <param name="indexes">The indexes of the messages to copy.</param>
  8212. <param name="destination">The destination folder.</param>
  8213. <param name="cancellationToken">The cancellation token.</param>
  8214. <exception cref="T:System.ArgumentNullException">
  8215. <para><paramref name="indexes"/> is <c>null</c>.</para>
  8216. <para>-or-</para>
  8217. <para><paramref name="destination"/> is <c>null</c>.</para>
  8218. </exception>
  8219. <exception cref="T:System.ArgumentException">
  8220. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  8221. <para>-or-</para>
  8222. <para>The destination folder does not belong to the <see cref="T:MailKit.Net.Imap.ImapClient"/>.</para>
  8223. </exception>
  8224. <exception cref="T:System.ObjectDisposedException">
  8225. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  8226. </exception>
  8227. <exception cref="T:MailKit.FolderNotOpenException">
  8228. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  8229. </exception>
  8230. <exception cref="T:MailKit.ServiceNotConnectedException">
  8231. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  8232. </exception>
  8233. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  8234. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  8235. </exception>
  8236. <exception cref="T:MailKit.FolderNotFoundException">
  8237. <paramref name="destination"/> does not exist.
  8238. </exception>
  8239. <exception cref="T:MailKit.FolderNotOpenException">
  8240. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  8241. </exception>
  8242. <exception cref="T:System.OperationCanceledException">
  8243. The operation was canceled via the cancellation token.
  8244. </exception>
  8245. <exception cref="T:System.IO.IOException">
  8246. An I/O error occurred.
  8247. </exception>
  8248. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  8249. The server's response contained unexpected tokens.
  8250. </exception>
  8251. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  8252. The server replied with a NO or BAD response.
  8253. </exception>
  8254. </member>
  8255. <member name="M:MailKit.Net.Imap.ImapFolder.CopyToAsync(System.Collections.Generic.IList{System.Int32},MailKit.IMailFolder,System.Threading.CancellationToken)">
  8256. <summary>
  8257. Asynchronously copy the specified messages to the destination folder.
  8258. </summary>
  8259. <remarks>
  8260. Copies the specified messages to the destination folder.
  8261. </remarks>
  8262. <returns>An awaitable task.</returns>
  8263. <param name="indexes">The indexes of the messages to copy.</param>
  8264. <param name="destination">The destination folder.</param>
  8265. <param name="cancellationToken">The cancellation token.</param>
  8266. <exception cref="T:System.ArgumentNullException">
  8267. <para><paramref name="indexes"/> is <c>null</c>.</para>
  8268. <para>-or-</para>
  8269. <para><paramref name="destination"/> is <c>null</c>.</para>
  8270. </exception>
  8271. <exception cref="T:System.ArgumentException">
  8272. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  8273. <para>-or-</para>
  8274. <para>The destination folder does not belong to the <see cref="T:MailKit.Net.Imap.ImapClient"/>.</para>
  8275. </exception>
  8276. <exception cref="T:System.ObjectDisposedException">
  8277. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  8278. </exception>
  8279. <exception cref="T:MailKit.FolderNotOpenException">
  8280. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  8281. </exception>
  8282. <exception cref="T:MailKit.ServiceNotConnectedException">
  8283. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  8284. </exception>
  8285. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  8286. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  8287. </exception>
  8288. <exception cref="T:MailKit.FolderNotFoundException">
  8289. <paramref name="destination"/> does not exist.
  8290. </exception>
  8291. <exception cref="T:MailKit.FolderNotOpenException">
  8292. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  8293. </exception>
  8294. <exception cref="T:System.OperationCanceledException">
  8295. The operation was canceled via the cancellation token.
  8296. </exception>
  8297. <exception cref="T:System.IO.IOException">
  8298. An I/O error occurred.
  8299. </exception>
  8300. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  8301. The server's response contained unexpected tokens.
  8302. </exception>
  8303. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  8304. The server replied with a NO or BAD response.
  8305. </exception>
  8306. </member>
  8307. <member name="M:MailKit.Net.Imap.ImapFolder.MoveTo(System.Collections.Generic.IList{System.Int32},MailKit.IMailFolder,System.Threading.CancellationToken)">
  8308. <summary>
  8309. Move the specified messages to the destination folder.
  8310. </summary>
  8311. <remarks>
  8312. <para>If the IMAP server supports the MOVE command, then the MOVE command will be used. Otherwise,
  8313. the messages will first be copied to the destination folder and then marked as \Deleted in the
  8314. originating folder. Since the server could disconnect at any point between those 2 operations, it
  8315. may be advisable to implement your own logic for moving messages in this case in order to better
  8316. handle spontanious server disconnects and other error conditions.</para>
  8317. </remarks>
  8318. <param name="indexes">The indexes of the messages to move.</param>
  8319. <param name="destination">The destination folder.</param>
  8320. <param name="cancellationToken">The cancellation token.</param>
  8321. <exception cref="T:System.ArgumentNullException">
  8322. <para><paramref name="indexes"/> is <c>null</c>.</para>
  8323. <para>-or-</para>
  8324. <para><paramref name="destination"/> is <c>null</c>.</para>
  8325. </exception>
  8326. <exception cref="T:System.ArgumentException">
  8327. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  8328. <para>-or-</para>
  8329. <para>The destination folder does not belong to the <see cref="T:MailKit.Net.Imap.ImapClient"/>.</para>
  8330. </exception>
  8331. <exception cref="T:System.ObjectDisposedException">
  8332. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  8333. </exception>
  8334. <exception cref="T:MailKit.ServiceNotConnectedException">
  8335. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  8336. </exception>
  8337. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  8338. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  8339. </exception>
  8340. <exception cref="T:MailKit.FolderNotFoundException">
  8341. <paramref name="destination"/> does not exist.
  8342. </exception>
  8343. <exception cref="T:MailKit.FolderNotOpenException">
  8344. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  8345. </exception>
  8346. <exception cref="T:System.OperationCanceledException">
  8347. The operation was canceled via the cancellation token.
  8348. </exception>
  8349. <exception cref="T:System.IO.IOException">
  8350. An I/O error occurred.
  8351. </exception>
  8352. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  8353. The server's response contained unexpected tokens.
  8354. </exception>
  8355. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  8356. The server replied with a NO or BAD response.
  8357. </exception>
  8358. </member>
  8359. <member name="M:MailKit.Net.Imap.ImapFolder.MoveToAsync(System.Collections.Generic.IList{System.Int32},MailKit.IMailFolder,System.Threading.CancellationToken)">
  8360. <summary>
  8361. Asynchronously move the specified messages to the destination folder.
  8362. </summary>
  8363. <remarks>
  8364. <para>If the IMAP server supports the MOVE command, then the MOVE command will be used. Otherwise,
  8365. the messages will first be copied to the destination folder and then marked as \Deleted in the
  8366. originating folder. Since the server could disconnect at any point between those 2 operations, it
  8367. may be advisable to implement your own logic for moving messages in this case in order to better
  8368. handle spontanious server disconnects and other error conditions.</para>
  8369. </remarks>
  8370. <returns>An awaitable task.</returns>
  8371. <param name="indexes">The indexes of the messages to move.</param>
  8372. <param name="destination">The destination folder.</param>
  8373. <param name="cancellationToken">The cancellation token.</param>
  8374. <exception cref="T:System.ArgumentNullException">
  8375. <para><paramref name="indexes"/> is <c>null</c>.</para>
  8376. <para>-or-</para>
  8377. <para><paramref name="destination"/> is <c>null</c>.</para>
  8378. </exception>
  8379. <exception cref="T:System.ArgumentException">
  8380. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  8381. <para>-or-</para>
  8382. <para>The destination folder does not belong to the <see cref="T:MailKit.Net.Imap.ImapClient"/>.</para>
  8383. </exception>
  8384. <exception cref="T:System.ObjectDisposedException">
  8385. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  8386. </exception>
  8387. <exception cref="T:MailKit.ServiceNotConnectedException">
  8388. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  8389. </exception>
  8390. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  8391. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  8392. </exception>
  8393. <exception cref="T:MailKit.FolderNotFoundException">
  8394. <paramref name="destination"/> does not exist.
  8395. </exception>
  8396. <exception cref="T:MailKit.FolderNotOpenException">
  8397. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  8398. </exception>
  8399. <exception cref="T:System.OperationCanceledException">
  8400. The operation was canceled via the cancellation token.
  8401. </exception>
  8402. <exception cref="T:System.IO.IOException">
  8403. An I/O error occurred.
  8404. </exception>
  8405. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  8406. The server's response contained unexpected tokens.
  8407. </exception>
  8408. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  8409. The server replied with a NO or BAD response.
  8410. </exception>
  8411. </member>
  8412. <member name="M:MailKit.Net.Imap.ImapFolder.GetEnumerator">
  8413. <summary>
  8414. Get an enumerator for the messages in the folder.
  8415. </summary>
  8416. <remarks>
  8417. Gets an enumerator for the messages in the folder.
  8418. </remarks>
  8419. <returns>The enumerator.</returns>
  8420. <exception cref="T:System.ObjectDisposedException">
  8421. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  8422. </exception>
  8423. <exception cref="T:MailKit.ServiceNotConnectedException">
  8424. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  8425. </exception>
  8426. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  8427. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  8428. </exception>
  8429. <exception cref="T:MailKit.FolderNotOpenException">
  8430. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  8431. </exception>
  8432. </member>
  8433. <member name="M:MailKit.Net.Imap.ImapFolder.Store(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
  8434. <summary>
  8435. Store the annotations for the specified messages.
  8436. </summary>
  8437. <remarks>
  8438. Stores the annotations for the specified messages.
  8439. </remarks>
  8440. <param name="uids">The UIDs of the messages.</param>
  8441. <param name="annotations">The annotations to store.</param>
  8442. <param name="cancellationToken">The cancellation token.</param>
  8443. <exception cref="T:System.ArgumentNullException">
  8444. <para><paramref name="uids"/> is <c>null</c>.</para>
  8445. <para>-or-</para>
  8446. <para><paramref name="annotations"/> is <c>null</c>.</para>
  8447. </exception>
  8448. <exception cref="T:System.ArgumentException">
  8449. One or more of the <paramref name="uids"/> is invalid.
  8450. </exception>
  8451. <exception cref="T:System.ObjectDisposedException">
  8452. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  8453. </exception>
  8454. <exception cref="T:MailKit.ServiceNotConnectedException">
  8455. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  8456. </exception>
  8457. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  8458. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  8459. </exception>
  8460. <exception cref="T:MailKit.FolderNotOpenException">
  8461. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  8462. </exception>
  8463. <exception cref="T:System.InvalidOperationException">
  8464. Cannot store annotations without any properties defined.
  8465. </exception>
  8466. <exception cref="T:System.NotSupportedException">
  8467. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support annotations.
  8468. </exception>
  8469. <exception cref="T:System.OperationCanceledException">
  8470. The operation was canceled via the cancellation token.
  8471. </exception>
  8472. <exception cref="T:System.IO.IOException">
  8473. An I/O error occurred.
  8474. </exception>
  8475. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  8476. The server's response contained unexpected tokens.
  8477. </exception>
  8478. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  8479. The server replied with a NO or BAD response.
  8480. </exception>
  8481. </member>
  8482. <member name="M:MailKit.Net.Imap.ImapFolder.StoreAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
  8483. <summary>
  8484. Asynchronously store the annotations for the specified messages.
  8485. </summary>
  8486. <remarks>
  8487. Asynchronously stores the annotations for the specified messages.
  8488. </remarks>
  8489. <returns>An asynchronous task context.</returns>
  8490. <param name="uids">The UIDs of the messages.</param>
  8491. <param name="annotations">The annotations to store.</param>
  8492. <param name="cancellationToken">The cancellation token.</param>
  8493. <exception cref="T:System.ArgumentNullException">
  8494. <para><paramref name="uids"/> is <c>null</c>.</para>
  8495. <para>-or-</para>
  8496. <para><paramref name="annotations"/> is <c>null</c>.</para>
  8497. </exception>
  8498. <exception cref="T:System.ArgumentException">
  8499. One or more of the <paramref name="uids"/> is invalid.
  8500. </exception>
  8501. <exception cref="T:System.ObjectDisposedException">
  8502. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  8503. </exception>
  8504. <exception cref="T:MailKit.ServiceNotConnectedException">
  8505. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  8506. </exception>
  8507. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  8508. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  8509. </exception>
  8510. <exception cref="T:MailKit.FolderNotOpenException">
  8511. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  8512. </exception>
  8513. <exception cref="T:System.InvalidOperationException">
  8514. Cannot store annotations without any properties defined.
  8515. </exception>
  8516. <exception cref="T:System.NotSupportedException">
  8517. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support annotations.
  8518. </exception>
  8519. <exception cref="T:System.OperationCanceledException">
  8520. The operation was canceled via the cancellation token.
  8521. </exception>
  8522. <exception cref="T:System.IO.IOException">
  8523. An I/O error occurred.
  8524. </exception>
  8525. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  8526. The server's response contained unexpected tokens.
  8527. </exception>
  8528. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  8529. The server replied with a NO or BAD response.
  8530. </exception>
  8531. </member>
  8532. <member name="M:MailKit.Net.Imap.ImapFolder.Store(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
  8533. <summary>
  8534. Store the annotations for the specified messages only if their mod-sequence value is less than the specified value.
  8535. </summary>
  8536. <remarks>
  8537. Stores the annotations for the specified messages only if their mod-sequence value is less than the specified value.
  8538. </remarks>
  8539. <returns>The unique IDs of the messages that were not updated.</returns>
  8540. <param name="uids">The UIDs of the messages.</param>
  8541. <param name="modseq">The mod-sequence value.</param>
  8542. <param name="annotations">The annotations to store.</param>
  8543. <param name="cancellationToken">The cancellation token.</param>
  8544. <exception cref="T:System.ArgumentNullException">
  8545. <para><paramref name="uids"/> is <c>null</c>.</para>
  8546. <para>-or-</para>
  8547. <para><paramref name="annotations"/> is <c>null</c>.</para>
  8548. </exception>
  8549. <exception cref="T:System.ArgumentException">
  8550. One or more of the <paramref name="uids"/> is invalid.
  8551. </exception>
  8552. <exception cref="T:System.ObjectDisposedException">
  8553. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  8554. </exception>
  8555. <exception cref="T:MailKit.ServiceNotConnectedException">
  8556. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  8557. </exception>
  8558. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  8559. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  8560. </exception>
  8561. <exception cref="T:MailKit.FolderNotOpenException">
  8562. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  8563. </exception>
  8564. <exception cref="T:System.InvalidOperationException">
  8565. Cannot store annotations without any properties defined.
  8566. </exception>
  8567. <exception cref="T:System.NotSupportedException">
  8568. <para>The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support annotations.</para>
  8569. <para>-or-</para>
  8570. <para>The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.</para>
  8571. </exception>
  8572. <exception cref="T:System.OperationCanceledException">
  8573. The operation was canceled via the cancellation token.
  8574. </exception>
  8575. <exception cref="T:System.IO.IOException">
  8576. An I/O error occurred.
  8577. </exception>
  8578. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  8579. The server's response contained unexpected tokens.
  8580. </exception>
  8581. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  8582. The server replied with a NO or BAD response.
  8583. </exception>
  8584. </member>
  8585. <member name="M:MailKit.Net.Imap.ImapFolder.StoreAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
  8586. <summary>
  8587. Asynchronously store the annotations for the specified messages only if their mod-sequence value is less than the specified value.
  8588. </summary>
  8589. <remarks>
  8590. Asynchronously stores the annotations for the specified messages only if their mod-sequence value is less than the specified value.
  8591. </remarks>
  8592. <returns>The unique IDs of the messages that were not updated.</returns>
  8593. <param name="uids">The UIDs of the messages.</param>
  8594. <param name="modseq">The mod-sequence value.</param>
  8595. <param name="annotations">The annotations to store.</param>
  8596. <param name="cancellationToken">The cancellation token.</param>
  8597. <exception cref="T:System.ArgumentNullException">
  8598. <para><paramref name="uids"/> is <c>null</c>.</para>
  8599. <para>-or-</para>
  8600. <para><paramref name="annotations"/> is <c>null</c>.</para>
  8601. </exception>
  8602. <exception cref="T:System.ArgumentException">
  8603. One or more of the <paramref name="uids"/> is invalid.
  8604. </exception>
  8605. <exception cref="T:System.ObjectDisposedException">
  8606. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  8607. </exception>
  8608. <exception cref="T:MailKit.ServiceNotConnectedException">
  8609. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  8610. </exception>
  8611. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  8612. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  8613. </exception>
  8614. <exception cref="T:MailKit.FolderNotOpenException">
  8615. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  8616. </exception>
  8617. <exception cref="T:System.InvalidOperationException">
  8618. Cannot store annotations without any properties defined.
  8619. </exception>
  8620. <exception cref="T:System.NotSupportedException">
  8621. <para>The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support annotations.</para>
  8622. <para>-or-</para>
  8623. <para>The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.</para>
  8624. </exception>
  8625. <exception cref="T:System.OperationCanceledException">
  8626. The operation was canceled via the cancellation token.
  8627. </exception>
  8628. <exception cref="T:System.IO.IOException">
  8629. An I/O error occurred.
  8630. </exception>
  8631. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  8632. The server's response contained unexpected tokens.
  8633. </exception>
  8634. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  8635. The server replied with a NO or BAD response.
  8636. </exception>
  8637. </member>
  8638. <member name="M:MailKit.Net.Imap.ImapFolder.Store(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
  8639. <summary>
  8640. Store the annotations for the specified messages.
  8641. </summary>
  8642. <remarks>
  8643. Stores the annotations for the specified messages.
  8644. </remarks>
  8645. <param name="indexes">The indexes of the messages.</param>
  8646. <param name="annotations">The annotations to store.</param>
  8647. <param name="cancellationToken">The cancellation token.</param>
  8648. <exception cref="T:System.ArgumentNullException">
  8649. <para><paramref name="indexes"/> is <c>null</c>.</para>
  8650. <para>-or-</para>
  8651. <para><paramref name="annotations"/> is <c>null</c>.</para>
  8652. </exception>
  8653. <exception cref="T:System.ArgumentException">
  8654. One or more of the <paramref name="indexes"/> is invalid.
  8655. </exception>
  8656. <exception cref="T:System.ObjectDisposedException">
  8657. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  8658. </exception>
  8659. <exception cref="T:MailKit.ServiceNotConnectedException">
  8660. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  8661. </exception>
  8662. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  8663. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  8664. </exception>
  8665. <exception cref="T:MailKit.FolderNotOpenException">
  8666. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  8667. </exception>
  8668. <exception cref="T:System.InvalidOperationException">
  8669. Cannot store annotations without any properties defined.
  8670. </exception>
  8671. <exception cref="T:System.NotSupportedException">
  8672. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support annotations.
  8673. </exception>
  8674. <exception cref="T:System.OperationCanceledException">
  8675. The operation was canceled via the cancellation token.
  8676. </exception>
  8677. <exception cref="T:System.IO.IOException">
  8678. An I/O error occurred.
  8679. </exception>
  8680. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  8681. The server's response contained unexpected tokens.
  8682. </exception>
  8683. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  8684. The server replied with a NO or BAD response.
  8685. </exception>
  8686. </member>
  8687. <member name="M:MailKit.Net.Imap.ImapFolder.StoreAsync(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
  8688. <summary>
  8689. Asynchronously store the annotations for the specified messages.
  8690. </summary>
  8691. <remarks>
  8692. Asynchronously stores the annotations for the specified messages.
  8693. </remarks>
  8694. <returns>An asynchronous task context.</returns>
  8695. <param name="indexes">The indexes of the messages.</param>
  8696. <param name="annotations">The annotations to store.</param>
  8697. <param name="cancellationToken">The cancellation token.</param>
  8698. <exception cref="T:System.ArgumentNullException">
  8699. <para><paramref name="indexes"/> is <c>null</c>.</para>
  8700. <para>-or-</para>
  8701. <para><paramref name="annotations"/> is <c>null</c>.</para>
  8702. </exception>
  8703. <exception cref="T:System.ArgumentException">
  8704. One or more of the <paramref name="indexes"/> is invalid.
  8705. </exception>
  8706. <exception cref="T:System.ObjectDisposedException">
  8707. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  8708. </exception>
  8709. <exception cref="T:MailKit.ServiceNotConnectedException">
  8710. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  8711. </exception>
  8712. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  8713. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  8714. </exception>
  8715. <exception cref="T:MailKit.FolderNotOpenException">
  8716. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  8717. </exception>
  8718. <exception cref="T:System.InvalidOperationException">
  8719. Cannot store annotations without any properties defined.
  8720. </exception>
  8721. <exception cref="T:System.NotSupportedException">
  8722. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support annotations.
  8723. </exception>
  8724. <exception cref="T:System.OperationCanceledException">
  8725. The operation was canceled via the cancellation token.
  8726. </exception>
  8727. <exception cref="T:System.IO.IOException">
  8728. An I/O error occurred.
  8729. </exception>
  8730. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  8731. The server's response contained unexpected tokens.
  8732. </exception>
  8733. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  8734. The server replied with a NO or BAD response.
  8735. </exception>
  8736. </member>
  8737. <member name="M:MailKit.Net.Imap.ImapFolder.Store(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
  8738. <summary>
  8739. Store the annotations for the specified messages only if their mod-sequence value is less than the specified value.
  8740. </summary>
  8741. <remarks>
  8742. Stores the annotations for the specified messages only if their mod-sequence value is less than the specified value.
  8743. </remarks>
  8744. <returns>The indexes of the messages that were not updated.</returns>
  8745. <param name="indexes">The indexes of the messages.</param>
  8746. <param name="modseq">The mod-sequence value.</param>
  8747. <param name="annotations">The annotations to store.</param>
  8748. <param name="cancellationToken">The cancellation token.</param>
  8749. <exception cref="T:System.ArgumentNullException">
  8750. <para><paramref name="indexes"/> is <c>null</c>.</para>
  8751. <para>-or-</para>
  8752. <para><paramref name="annotations"/> is <c>null</c>.</para>
  8753. </exception>
  8754. <exception cref="T:System.ArgumentException">
  8755. One or more of the <paramref name="indexes"/> is invalid.
  8756. </exception>
  8757. <exception cref="T:System.ObjectDisposedException">
  8758. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  8759. </exception>
  8760. <exception cref="T:MailKit.ServiceNotConnectedException">
  8761. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  8762. </exception>
  8763. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  8764. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  8765. </exception>
  8766. <exception cref="T:MailKit.FolderNotOpenException">
  8767. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  8768. </exception>
  8769. <exception cref="T:System.InvalidOperationException">
  8770. Cannot store annotations without any properties defined.
  8771. </exception>
  8772. <exception cref="T:System.NotSupportedException">
  8773. <para>The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support annotations.</para>
  8774. <para>-or-</para>
  8775. <para>The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.</para>
  8776. </exception>
  8777. <exception cref="T:System.OperationCanceledException">
  8778. The operation was canceled via the cancellation token.
  8779. </exception>
  8780. <exception cref="T:System.IO.IOException">
  8781. An I/O error occurred.
  8782. </exception>
  8783. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  8784. The server's response contained unexpected tokens.
  8785. </exception>
  8786. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  8787. The server replied with a NO or BAD response.
  8788. </exception>
  8789. </member>
  8790. <member name="M:MailKit.Net.Imap.ImapFolder.StoreAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
  8791. <summary>
  8792. Asynchronously store the annotations for the specified messages only if their mod-sequence value is less than the specified value.
  8793. </summary>
  8794. <remarks>
  8795. Asynchronously stores the annotations for the specified messages only if their mod-sequence value is less than the specified value.s
  8796. </remarks>
  8797. <returns>The indexes of the messages that were not updated.</returns>
  8798. <param name="indexes">The indexes of the messages.</param>
  8799. <param name="modseq">The mod-sequence value.</param>
  8800. <param name="annotations">The annotations to store.</param>
  8801. <param name="cancellationToken">The cancellation token.</param>
  8802. <exception cref="T:System.ArgumentNullException">
  8803. <para><paramref name="indexes"/> is <c>null</c>.</para>
  8804. <para>-or-</para>
  8805. <para><paramref name="annotations"/> is <c>null</c>.</para>
  8806. </exception>
  8807. <exception cref="T:System.ArgumentException">
  8808. One or more of the <paramref name="indexes"/> is invalid.
  8809. </exception>
  8810. <exception cref="T:System.ObjectDisposedException">
  8811. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  8812. </exception>
  8813. <exception cref="T:MailKit.ServiceNotConnectedException">
  8814. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  8815. </exception>
  8816. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  8817. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  8818. </exception>
  8819. <exception cref="T:MailKit.FolderNotOpenException">
  8820. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  8821. </exception>
  8822. <exception cref="T:System.InvalidOperationException">
  8823. Cannot store annotations without any properties defined.
  8824. </exception>
  8825. <exception cref="T:System.NotSupportedException">
  8826. <para>The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support annotations.</para>
  8827. <para>-or-</para>
  8828. <para>The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.</para>
  8829. </exception>
  8830. <exception cref="T:System.OperationCanceledException">
  8831. The operation was canceled via the cancellation token.
  8832. </exception>
  8833. <exception cref="T:System.IO.IOException">
  8834. An I/O error occurred.
  8835. </exception>
  8836. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  8837. The server's response contained unexpected tokens.
  8838. </exception>
  8839. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  8840. The server replied with a NO or BAD response.
  8841. </exception>
  8842. </member>
  8843. <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
  8844. <summary>
  8845. Fetches the message summaries for the specified message UIDs.
  8846. </summary>
  8847. <remarks>
  8848. <para>Fetches the message summaries for the specified message UIDs.</para>
  8849. <para>It should be noted that if another client has modified any message
  8850. in the folder, the IMAP server may choose to return information that was
  8851. not explicitly requested. It is therefore important to be prepared to
  8852. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  8853. messages that were requested as well as summaries for messages that were
  8854. not requested at all.</para>
  8855. </remarks>
  8856. <example>
  8857. <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
  8858. </example>
  8859. <returns>An enumeration of summaries for the requested messages.</returns>
  8860. <param name="uids">The UIDs.</param>
  8861. <param name="items">The message summary items to fetch.</param>
  8862. <param name="cancellationToken">The cancellation token.</param>
  8863. <exception cref="T:System.ArgumentNullException">
  8864. <paramref name="uids"/> is <c>null</c>.
  8865. </exception>
  8866. <exception cref="T:System.ArgumentOutOfRangeException">
  8867. <paramref name="items"/> is empty.
  8868. </exception>
  8869. <exception cref="T:System.ArgumentException">
  8870. One or more of the <paramref name="uids"/> is invalid.
  8871. </exception>
  8872. <exception cref="T:System.ObjectDisposedException">
  8873. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  8874. </exception>
  8875. <exception cref="T:MailKit.FolderNotOpenException">
  8876. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  8877. </exception>
  8878. <exception cref="T:MailKit.ServiceNotConnectedException">
  8879. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  8880. </exception>
  8881. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  8882. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  8883. </exception>
  8884. <exception cref="T:System.OperationCanceledException">
  8885. The operation was canceled via the cancellation token.
  8886. </exception>
  8887. <exception cref="T:System.IO.IOException">
  8888. An I/O error occurred.
  8889. </exception>
  8890. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  8891. The server's response contained unexpected tokens.
  8892. </exception>
  8893. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  8894. The server replied with a NO or BAD response.
  8895. </exception>
  8896. </member>
  8897. <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
  8898. <summary>
  8899. Asynchronously fetches the message summaries for the specified message UIDs.
  8900. </summary>
  8901. <remarks>
  8902. <para>Fetches the message summaries for the specified message UIDs.</para>
  8903. <para>It should be noted that if another client has modified any message
  8904. in the folder, the IMAP server may choose to return information that was
  8905. not explicitly requested. It is therefore important to be prepared to
  8906. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  8907. messages that were requested as well as summaries for messages that were
  8908. not requested at all.</para>
  8909. </remarks>
  8910. <example>
  8911. <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
  8912. </example>
  8913. <returns>An enumeration of summaries for the requested messages.</returns>
  8914. <param name="uids">The UIDs.</param>
  8915. <param name="items">The message summary items to fetch.</param>
  8916. <param name="cancellationToken">The cancellation token.</param>
  8917. <exception cref="T:System.ArgumentNullException">
  8918. <paramref name="uids"/> is <c>null</c>.
  8919. </exception>
  8920. <exception cref="T:System.ArgumentOutOfRangeException">
  8921. <paramref name="items"/> is empty.
  8922. </exception>
  8923. <exception cref="T:System.ArgumentException">
  8924. One or more of the <paramref name="uids"/> is invalid.
  8925. </exception>
  8926. <exception cref="T:System.ObjectDisposedException">
  8927. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  8928. </exception>
  8929. <exception cref="T:MailKit.FolderNotOpenException">
  8930. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  8931. </exception>
  8932. <exception cref="T:MailKit.ServiceNotConnectedException">
  8933. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  8934. </exception>
  8935. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  8936. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  8937. </exception>
  8938. <exception cref="T:System.OperationCanceledException">
  8939. The operation was canceled via the cancellation token.
  8940. </exception>
  8941. <exception cref="T:System.IO.IOException">
  8942. An I/O error occurred.
  8943. </exception>
  8944. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  8945. The server's response contained unexpected tokens.
  8946. </exception>
  8947. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  8948. The server replied with a NO or BAD response.
  8949. </exception>
  8950. </member>
  8951. <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
  8952. <summary>
  8953. Fetches the message summaries for the specified message UIDs.
  8954. </summary>
  8955. <remarks>
  8956. <para>Fetches the message summaries for the specified message UIDs.</para>
  8957. <para>It should be noted that if another client has modified any message
  8958. in the folder, the IMAP server may choose to return information that was
  8959. not explicitly requested. It is therefore important to be prepared to
  8960. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  8961. messages that were requested as well as summaries for messages that were
  8962. not requested at all.</para>
  8963. </remarks>
  8964. <returns>An enumeration of summaries for the requested messages.</returns>
  8965. <param name="uids">The UIDs.</param>
  8966. <param name="items">The message summary items to fetch.</param>
  8967. <param name="headers">The desired header fields.</param>
  8968. <param name="cancellationToken">The cancellation token.</param>
  8969. <exception cref="T:System.ArgumentNullException">
  8970. <para><paramref name="uids"/> is <c>null</c>.</para>
  8971. <para>-or-</para>
  8972. <para><paramref name="headers"/> is <c>null</c>.</para>
  8973. </exception>
  8974. <exception cref="T:System.ArgumentException">
  8975. One or more of the <paramref name="uids"/> is invalid.
  8976. </exception>
  8977. <exception cref="T:System.ObjectDisposedException">
  8978. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  8979. </exception>
  8980. <exception cref="T:MailKit.ServiceNotConnectedException">
  8981. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  8982. </exception>
  8983. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  8984. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  8985. </exception>
  8986. <exception cref="T:MailKit.FolderNotOpenException">
  8987. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  8988. </exception>
  8989. <exception cref="T:System.OperationCanceledException">
  8990. The operation was canceled via the cancellation token.
  8991. </exception>
  8992. <exception cref="T:System.IO.IOException">
  8993. An I/O error occurred.
  8994. </exception>
  8995. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  8996. The server's response contained unexpected tokens.
  8997. </exception>
  8998. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  8999. The server replied with a NO or BAD response.
  9000. </exception>
  9001. </member>
  9002. <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
  9003. <summary>
  9004. Asynchronously fetches the message summaries for the specified message UIDs.
  9005. </summary>
  9006. <remarks>
  9007. <para>Fetches the message summaries for the specified message UIDs.</para>
  9008. <para>It should be noted that if another client has modified any message
  9009. in the folder, the IMAP server may choose to return information that was
  9010. not explicitly requested. It is therefore important to be prepared to
  9011. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  9012. messages that were requested as well as summaries for messages that were
  9013. not requested at all.</para>
  9014. </remarks>
  9015. <returns>An enumeration of summaries for the requested messages.</returns>
  9016. <param name="uids">The UIDs.</param>
  9017. <param name="items">The message summary items to fetch.</param>
  9018. <param name="headers">The desired header fields.</param>
  9019. <param name="cancellationToken">The cancellation token.</param>
  9020. <exception cref="T:System.ArgumentNullException">
  9021. <para><paramref name="uids"/> is <c>null</c>.</para>
  9022. <para>-or-</para>
  9023. <para><paramref name="headers"/> is <c>null</c>.</para>
  9024. </exception>
  9025. <exception cref="T:System.ArgumentException">
  9026. One or more of the <paramref name="uids"/> is invalid.
  9027. </exception>
  9028. <exception cref="T:System.ObjectDisposedException">
  9029. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  9030. </exception>
  9031. <exception cref="T:MailKit.ServiceNotConnectedException">
  9032. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  9033. </exception>
  9034. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  9035. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  9036. </exception>
  9037. <exception cref="T:MailKit.FolderNotOpenException">
  9038. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  9039. </exception>
  9040. <exception cref="T:System.OperationCanceledException">
  9041. The operation was canceled via the cancellation token.
  9042. </exception>
  9043. <exception cref="T:System.IO.IOException">
  9044. An I/O error occurred.
  9045. </exception>
  9046. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  9047. The server's response contained unexpected tokens.
  9048. </exception>
  9049. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  9050. The server replied with a NO or BAD response.
  9051. </exception>
  9052. </member>
  9053. <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
  9054. <summary>
  9055. Fetches the message summaries for the specified message UIDs.
  9056. </summary>
  9057. <remarks>
  9058. <para>Fetches the message summaries for the specified message UIDs.</para>
  9059. <para>It should be noted that if another client has modified any message
  9060. in the folder, the IMAP server may choose to return information that was
  9061. not explicitly requested. It is therefore important to be prepared to
  9062. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  9063. messages that were requested as well as summaries for messages that were
  9064. not requested at all.</para>
  9065. </remarks>
  9066. <returns>An enumeration of summaries for the requested messages.</returns>
  9067. <param name="uids">The UIDs.</param>
  9068. <param name="items">The message summary items to fetch.</param>
  9069. <param name="headers">The desired header fields.</param>
  9070. <param name="cancellationToken">The cancellation token.</param>
  9071. <exception cref="T:System.ArgumentNullException">
  9072. <para><paramref name="uids"/> is <c>null</c>.</para>
  9073. <para>-or-</para>
  9074. <para><paramref name="headers"/> is <c>null</c>.</para>
  9075. </exception>
  9076. <exception cref="T:System.ArgumentException">
  9077. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  9078. <para>-or-</para>
  9079. <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
  9080. </exception>
  9081. <exception cref="T:System.ObjectDisposedException">
  9082. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  9083. </exception>
  9084. <exception cref="T:MailKit.ServiceNotConnectedException">
  9085. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  9086. </exception>
  9087. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  9088. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  9089. </exception>
  9090. <exception cref="T:MailKit.FolderNotOpenException">
  9091. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  9092. </exception>
  9093. <exception cref="T:System.OperationCanceledException">
  9094. The operation was canceled via the cancellation token.
  9095. </exception>
  9096. <exception cref="T:System.IO.IOException">
  9097. An I/O error occurred.
  9098. </exception>
  9099. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  9100. The server's response contained unexpected tokens.
  9101. </exception>
  9102. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  9103. The server replied with a NO or BAD response.
  9104. </exception>
  9105. </member>
  9106. <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
  9107. <summary>
  9108. Asynchronously fetches the message summaries for the specified message UIDs.
  9109. </summary>
  9110. <remarks>
  9111. <para>Fetches the message summaries for the specified message UIDs.</para>
  9112. <para>It should be noted that if another client has modified any message
  9113. in the folder, the IMAP server may choose to return information that was
  9114. not explicitly requested. It is therefore important to be prepared to
  9115. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  9116. messages that were requested as well as summaries for messages that were
  9117. not requested at all.</para>
  9118. </remarks>
  9119. <returns>An enumeration of summaries for the requested messages.</returns>
  9120. <param name="uids">The UIDs.</param>
  9121. <param name="items">The message summary items to fetch.</param>
  9122. <param name="headers">The desired header fields.</param>
  9123. <param name="cancellationToken">The cancellation token.</param>
  9124. <exception cref="T:System.ArgumentNullException">
  9125. <para><paramref name="uids"/> is <c>null</c>.</para>
  9126. <para>-or-</para>
  9127. <para><paramref name="headers"/> is <c>null</c>.</para>
  9128. </exception>
  9129. <exception cref="T:System.ArgumentException">
  9130. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  9131. <para>-or-</para>
  9132. <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
  9133. </exception>
  9134. <exception cref="T:System.ObjectDisposedException">
  9135. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  9136. </exception>
  9137. <exception cref="T:MailKit.ServiceNotConnectedException">
  9138. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  9139. </exception>
  9140. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  9141. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  9142. </exception>
  9143. <exception cref="T:MailKit.FolderNotOpenException">
  9144. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  9145. </exception>
  9146. <exception cref="T:System.OperationCanceledException">
  9147. The operation was canceled via the cancellation token.
  9148. </exception>
  9149. <exception cref="T:System.IO.IOException">
  9150. An I/O error occurred.
  9151. </exception>
  9152. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  9153. The server's response contained unexpected tokens.
  9154. </exception>
  9155. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  9156. The server replied with a NO or BAD response.
  9157. </exception>
  9158. </member>
  9159. <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
  9160. <summary>
  9161. Fetches the message summaries for the specified message UIDs that have a
  9162. higher mod-sequence value than the one specified.
  9163. </summary>
  9164. <remarks>
  9165. <para>Fetches the message summaries for the specified message UIDs that
  9166. have a higher mod-sequence value than the one specified.</para>
  9167. <para>If the IMAP server supports the QRESYNC extension and the application has
  9168. enabled this feature via <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>,
  9169. then this method will emit <see cref="E:MailKit.MailFolder.MessagesVanished"/> events for messages
  9170. that have vanished since the specified mod-sequence value.</para>
  9171. <para>It should be noted that if another client has modified any message
  9172. in the folder, the IMAP server may choose to return information that was
  9173. not explicitly requested. It is therefore important to be prepared to
  9174. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  9175. messages that were requested as well as summaries for messages that were
  9176. not requested at all.</para>
  9177. </remarks>
  9178. <returns>An enumeration of summaries for the requested messages.</returns>
  9179. <param name="uids">The UIDs.</param>
  9180. <param name="modseq">The mod-sequence value.</param>
  9181. <param name="items">The message summary items to fetch.</param>
  9182. <param name="cancellationToken">The cancellation token.</param>
  9183. <exception cref="T:System.ArgumentNullException">
  9184. <paramref name="uids"/> is <c>null</c>.
  9185. </exception>
  9186. <exception cref="T:System.ArgumentOutOfRangeException">
  9187. <paramref name="items"/> is empty.
  9188. </exception>
  9189. <exception cref="T:System.ArgumentException">
  9190. One or more of the <paramref name="uids"/> is invalid.
  9191. </exception>
  9192. <exception cref="T:System.ObjectDisposedException">
  9193. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  9194. </exception>
  9195. <exception cref="T:MailKit.ServiceNotConnectedException">
  9196. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  9197. </exception>
  9198. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  9199. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  9200. </exception>
  9201. <exception cref="T:MailKit.FolderNotOpenException">
  9202. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  9203. </exception>
  9204. <exception cref="T:System.NotSupportedException">
  9205. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
  9206. </exception>
  9207. <exception cref="T:System.OperationCanceledException">
  9208. The operation was canceled via the cancellation token.
  9209. </exception>
  9210. <exception cref="T:System.IO.IOException">
  9211. An I/O error occurred.
  9212. </exception>
  9213. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  9214. The server's response contained unexpected tokens.
  9215. </exception>
  9216. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  9217. The server replied with a NO or BAD response.
  9218. </exception>
  9219. </member>
  9220. <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
  9221. <summary>
  9222. Asynchronously fetches the message summaries for the specified message UIDs that have a
  9223. higher mod-sequence value than the one specified.
  9224. </summary>
  9225. <remarks>
  9226. <para>Fetches the message summaries for the specified message UIDs that
  9227. have a higher mod-sequence value than the one specified.</para>
  9228. <para>If the IMAP server supports the QRESYNC extension and the application has
  9229. enabled this feature via <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>,
  9230. then this method will emit <see cref="E:MailKit.MailFolder.MessagesVanished"/> events for messages
  9231. that have vanished since the specified mod-sequence value.</para>
  9232. <para>It should be noted that if another client has modified any message
  9233. in the folder, the IMAP server may choose to return information that was
  9234. not explicitly requested. It is therefore important to be prepared to
  9235. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  9236. messages that were requested as well as summaries for messages that were
  9237. not requested at all.</para>
  9238. </remarks>
  9239. <returns>An enumeration of summaries for the requested messages.</returns>
  9240. <param name="uids">The UIDs.</param>
  9241. <param name="modseq">The mod-sequence value.</param>
  9242. <param name="items">The message summary items to fetch.</param>
  9243. <param name="cancellationToken">The cancellation token.</param>
  9244. <exception cref="T:System.ArgumentNullException">
  9245. <paramref name="uids"/> is <c>null</c>.
  9246. </exception>
  9247. <exception cref="T:System.ArgumentOutOfRangeException">
  9248. <paramref name="items"/> is empty.
  9249. </exception>
  9250. <exception cref="T:System.ArgumentException">
  9251. One or more of the <paramref name="uids"/> is invalid.
  9252. </exception>
  9253. <exception cref="T:System.ObjectDisposedException">
  9254. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  9255. </exception>
  9256. <exception cref="T:MailKit.ServiceNotConnectedException">
  9257. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  9258. </exception>
  9259. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  9260. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  9261. </exception>
  9262. <exception cref="T:MailKit.FolderNotOpenException">
  9263. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  9264. </exception>
  9265. <exception cref="T:System.NotSupportedException">
  9266. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
  9267. </exception>
  9268. <exception cref="T:System.OperationCanceledException">
  9269. The operation was canceled via the cancellation token.
  9270. </exception>
  9271. <exception cref="T:System.IO.IOException">
  9272. An I/O error occurred.
  9273. </exception>
  9274. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  9275. The server's response contained unexpected tokens.
  9276. </exception>
  9277. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  9278. The server replied with a NO or BAD response.
  9279. </exception>
  9280. </member>
  9281. <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
  9282. <summary>
  9283. Fetches the message summaries for the specified message UIDs that have a
  9284. higher mod-sequence value than the one specified.
  9285. </summary>
  9286. <remarks>
  9287. <para>Fetches the message summaries for the specified message UIDs that
  9288. have a higher mod-sequence value than the one specified.</para>
  9289. <para>If the IMAP server supports the QRESYNC extension and the application has
  9290. enabled this feature via <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>,
  9291. then this method will emit <see cref="E:MailKit.MailFolder.MessagesVanished"/> events for messages
  9292. that have vanished since the specified mod-sequence value.</para>
  9293. <para>It should be noted that if another client has modified any message
  9294. in the folder, the IMAP server may choose to return information that was
  9295. not explicitly requested. It is therefore important to be prepared to
  9296. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  9297. messages that were requested as well as summaries for messages that were
  9298. not requested at all.</para>
  9299. </remarks>
  9300. <returns>An enumeration of summaries for the requested messages.</returns>
  9301. <param name="uids">The UIDs.</param>
  9302. <param name="modseq">The mod-sequence value.</param>
  9303. <param name="items">The message summary items to fetch.</param>
  9304. <param name="headers">The desired header fields.</param>
  9305. <param name="cancellationToken">The cancellation token.</param>
  9306. <exception cref="T:System.ArgumentNullException">
  9307. <para><paramref name="uids"/> is <c>null</c>.</para>
  9308. <para>-or-</para>
  9309. <para><paramref name="headers"/> is <c>null</c>.</para>
  9310. </exception>
  9311. <exception cref="T:System.ArgumentException">
  9312. One or more of the <paramref name="uids"/> is invalid.
  9313. </exception>
  9314. <exception cref="T:System.ObjectDisposedException">
  9315. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  9316. </exception>
  9317. <exception cref="T:MailKit.ServiceNotConnectedException">
  9318. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  9319. </exception>
  9320. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  9321. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  9322. </exception>
  9323. <exception cref="T:MailKit.FolderNotOpenException">
  9324. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  9325. </exception>
  9326. <exception cref="T:System.NotSupportedException">
  9327. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
  9328. </exception>
  9329. <exception cref="T:System.OperationCanceledException">
  9330. The operation was canceled via the cancellation token.
  9331. </exception>
  9332. <exception cref="T:System.IO.IOException">
  9333. An I/O error occurred.
  9334. </exception>
  9335. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  9336. The server's response contained unexpected tokens.
  9337. </exception>
  9338. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  9339. The server replied with a NO or BAD response.
  9340. </exception>
  9341. </member>
  9342. <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
  9343. <summary>
  9344. Asynchronously fetches the message summaries for the specified message UIDs that have a
  9345. higher mod-sequence value than the one specified.
  9346. </summary>
  9347. <remarks>
  9348. <para>Fetches the message summaries for the specified message UIDs that
  9349. have a higher mod-sequence value than the one specified.</para>
  9350. <para>If the IMAP server supports the QRESYNC extension and the application has
  9351. enabled this feature via <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>,
  9352. then this method will emit <see cref="E:MailKit.MailFolder.MessagesVanished"/> events for messages
  9353. that have vanished since the specified mod-sequence value.</para>
  9354. <para>It should be noted that if another client has modified any message
  9355. in the folder, the IMAP server may choose to return information that was
  9356. not explicitly requested. It is therefore important to be prepared to
  9357. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  9358. messages that were requested as well as summaries for messages that were
  9359. not requested at all.</para>
  9360. </remarks>
  9361. <returns>An enumeration of summaries for the requested messages.</returns>
  9362. <param name="uids">The UIDs.</param>
  9363. <param name="modseq">The mod-sequence value.</param>
  9364. <param name="items">The message summary items to fetch.</param>
  9365. <param name="headers">The desired header fields.</param>
  9366. <param name="cancellationToken">The cancellation token.</param>
  9367. <exception cref="T:System.ArgumentNullException">
  9368. <para><paramref name="uids"/> is <c>null</c>.</para>
  9369. <para>-or-</para>
  9370. <para><paramref name="headers"/> is <c>null</c>.</para>
  9371. </exception>
  9372. <exception cref="T:System.ArgumentException">
  9373. One or more of the <paramref name="uids"/> is invalid.
  9374. </exception>
  9375. <exception cref="T:System.ObjectDisposedException">
  9376. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  9377. </exception>
  9378. <exception cref="T:MailKit.ServiceNotConnectedException">
  9379. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  9380. </exception>
  9381. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  9382. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  9383. </exception>
  9384. <exception cref="T:MailKit.FolderNotOpenException">
  9385. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  9386. </exception>
  9387. <exception cref="T:System.NotSupportedException">
  9388. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
  9389. </exception>
  9390. <exception cref="T:System.OperationCanceledException">
  9391. The operation was canceled via the cancellation token.
  9392. </exception>
  9393. <exception cref="T:System.IO.IOException">
  9394. An I/O error occurred.
  9395. </exception>
  9396. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  9397. The server's response contained unexpected tokens.
  9398. </exception>
  9399. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  9400. The server replied with a NO or BAD response.
  9401. </exception>
  9402. </member>
  9403. <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
  9404. <summary>
  9405. Fetches the message summaries for the specified message UIDs that have a
  9406. higher mod-sequence value than the one specified.
  9407. </summary>
  9408. <remarks>
  9409. <para>Fetches the message summaries for the specified message UIDs that
  9410. have a higher mod-sequence value than the one specified.</para>
  9411. <para>If the IMAP server supports the QRESYNC extension and the application has
  9412. enabled this feature via <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>,
  9413. then this method will emit <see cref="E:MailKit.MailFolder.MessagesVanished"/> events for messages
  9414. that have vanished since the specified mod-sequence value.</para>
  9415. <para>It should be noted that if another client has modified any message
  9416. in the folder, the IMAP server may choose to return information that was
  9417. not explicitly requested. It is therefore important to be prepared to
  9418. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  9419. messages that were requested as well as summaries for messages that were
  9420. not requested at all.</para>
  9421. </remarks>
  9422. <returns>An enumeration of summaries for the requested messages.</returns>
  9423. <param name="uids">The UIDs.</param>
  9424. <param name="modseq">The mod-sequence value.</param>
  9425. <param name="items">The message summary items to fetch.</param>
  9426. <param name="headers">The desired header fields.</param>
  9427. <param name="cancellationToken">The cancellation token.</param>
  9428. <exception cref="T:System.ArgumentNullException">
  9429. <para><paramref name="uids"/> is <c>null</c>.</para>
  9430. <para>-or-</para>
  9431. <para><paramref name="headers"/> is <c>null</c>.</para>
  9432. </exception>
  9433. <exception cref="T:System.ArgumentException">
  9434. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  9435. <para>-or-</para>
  9436. <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
  9437. </exception>
  9438. <exception cref="T:System.ObjectDisposedException">
  9439. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  9440. </exception>
  9441. <exception cref="T:MailKit.ServiceNotConnectedException">
  9442. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  9443. </exception>
  9444. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  9445. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  9446. </exception>
  9447. <exception cref="T:MailKit.FolderNotOpenException">
  9448. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  9449. </exception>
  9450. <exception cref="T:System.NotSupportedException">
  9451. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
  9452. </exception>
  9453. <exception cref="T:System.OperationCanceledException">
  9454. The operation was canceled via the cancellation token.
  9455. </exception>
  9456. <exception cref="T:System.IO.IOException">
  9457. An I/O error occurred.
  9458. </exception>
  9459. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  9460. The server's response contained unexpected tokens.
  9461. </exception>
  9462. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  9463. The server replied with a NO or BAD response.
  9464. </exception>
  9465. </member>
  9466. <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
  9467. <summary>
  9468. Asynchronously fetches the message summaries for the specified message UIDs that have a
  9469. higher mod-sequence value than the one specified.
  9470. </summary>
  9471. <remarks>
  9472. <para>Fetches the message summaries for the specified message UIDs that
  9473. have a higher mod-sequence value than the one specified.</para>
  9474. <para>If the IMAP server supports the QRESYNC extension and the application has
  9475. enabled this feature via <see cref="M:MailKit.Net.Imap.ImapClient.EnableQuickResync(System.Threading.CancellationToken)"/>,
  9476. then this method will emit <see cref="E:MailKit.MailFolder.MessagesVanished"/> events for messages
  9477. that have vanished since the specified mod-sequence value.</para>
  9478. <para>It should be noted that if another client has modified any message
  9479. in the folder, the IMAP server may choose to return information that was
  9480. not explicitly requested. It is therefore important to be prepared to
  9481. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  9482. messages that were requested as well as summaries for messages that were
  9483. not requested at all.</para>
  9484. </remarks>
  9485. <returns>An enumeration of summaries for the requested messages.</returns>
  9486. <param name="uids">The UIDs.</param>
  9487. <param name="modseq">The mod-sequence value.</param>
  9488. <param name="items">The message summary items to fetch.</param>
  9489. <param name="headers">The desired header fields.</param>
  9490. <param name="cancellationToken">The cancellation token.</param>
  9491. <exception cref="T:System.ArgumentNullException">
  9492. <para><paramref name="uids"/> is <c>null</c>.</para>
  9493. <para>-or-</para>
  9494. <para><paramref name="headers"/> is <c>null</c>.</para>
  9495. </exception>
  9496. <exception cref="T:System.ArgumentException">
  9497. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  9498. <para>-or-</para>
  9499. <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
  9500. </exception>
  9501. <exception cref="T:System.ObjectDisposedException">
  9502. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  9503. </exception>
  9504. <exception cref="T:MailKit.ServiceNotConnectedException">
  9505. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  9506. </exception>
  9507. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  9508. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  9509. </exception>
  9510. <exception cref="T:MailKit.FolderNotOpenException">
  9511. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  9512. </exception>
  9513. <exception cref="T:System.NotSupportedException">
  9514. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
  9515. </exception>
  9516. <exception cref="T:System.OperationCanceledException">
  9517. The operation was canceled via the cancellation token.
  9518. </exception>
  9519. <exception cref="T:System.IO.IOException">
  9520. An I/O error occurred.
  9521. </exception>
  9522. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  9523. The server's response contained unexpected tokens.
  9524. </exception>
  9525. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  9526. The server replied with a NO or BAD response.
  9527. </exception>
  9528. </member>
  9529. <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
  9530. <summary>
  9531. Fetches the message summaries for the specified message indexes.
  9532. </summary>
  9533. <remarks>
  9534. <para>Fetches the message summaries for the specified message indexes.</para>
  9535. <para>It should be noted that if another client has modified any message
  9536. in the folder, the IMAP server may choose to return information that was
  9537. not explicitly requested. It is therefore important to be prepared to
  9538. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  9539. messages that were requested as well as summaries for messages that were
  9540. not requested at all.</para>
  9541. </remarks>
  9542. <returns>An enumeration of summaries for the requested messages.</returns>
  9543. <param name="indexes">The indexes.</param>
  9544. <param name="items">The message summary items to fetch.</param>
  9545. <param name="cancellationToken">The cancellation token.</param>
  9546. <exception cref="T:System.ArgumentNullException">
  9547. <paramref name="indexes"/> is <c>null</c>.
  9548. </exception>
  9549. <exception cref="T:System.ArgumentOutOfRangeException">
  9550. <paramref name="items"/> is empty.
  9551. </exception>
  9552. <exception cref="T:System.ArgumentException">
  9553. One or more of the <paramref name="indexes"/> is invalid.
  9554. </exception>
  9555. <exception cref="T:System.ObjectDisposedException">
  9556. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  9557. </exception>
  9558. <exception cref="T:MailKit.ServiceNotConnectedException">
  9559. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  9560. </exception>
  9561. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  9562. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  9563. </exception>
  9564. <exception cref="T:MailKit.FolderNotOpenException">
  9565. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  9566. </exception>
  9567. <exception cref="T:System.OperationCanceledException">
  9568. The operation was canceled via the cancellation token.
  9569. </exception>
  9570. <exception cref="T:System.IO.IOException">
  9571. An I/O error occurred.
  9572. </exception>
  9573. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  9574. The server's response contained unexpected tokens.
  9575. </exception>
  9576. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  9577. The server replied with a NO or BAD response.
  9578. </exception>
  9579. </member>
  9580. <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
  9581. <summary>
  9582. Asynchronously fetches the message summaries for the specified message indexes.
  9583. </summary>
  9584. <remarks>
  9585. <para>Fetches the message summaries for the specified message indexes.</para>
  9586. <para>It should be noted that if another client has modified any message
  9587. in the folder, the IMAP server may choose to return information that was
  9588. not explicitly requested. It is therefore important to be prepared to
  9589. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  9590. messages that were requested as well as summaries for messages that were
  9591. not requested at all.</para>
  9592. </remarks>
  9593. <returns>An enumeration of summaries for the requested messages.</returns>
  9594. <param name="indexes">The indexes.</param>
  9595. <param name="items">The message summary items to fetch.</param>
  9596. <param name="cancellationToken">The cancellation token.</param>
  9597. <exception cref="T:System.ArgumentNullException">
  9598. <paramref name="indexes"/> is <c>null</c>.
  9599. </exception>
  9600. <exception cref="T:System.ArgumentOutOfRangeException">
  9601. <paramref name="items"/> is empty.
  9602. </exception>
  9603. <exception cref="T:System.ArgumentException">
  9604. One or more of the <paramref name="indexes"/> is invalid.
  9605. </exception>
  9606. <exception cref="T:System.ObjectDisposedException">
  9607. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  9608. </exception>
  9609. <exception cref="T:MailKit.ServiceNotConnectedException">
  9610. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  9611. </exception>
  9612. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  9613. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  9614. </exception>
  9615. <exception cref="T:MailKit.FolderNotOpenException">
  9616. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  9617. </exception>
  9618. <exception cref="T:System.OperationCanceledException">
  9619. The operation was canceled via the cancellation token.
  9620. </exception>
  9621. <exception cref="T:System.IO.IOException">
  9622. An I/O error occurred.
  9623. </exception>
  9624. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  9625. The server's response contained unexpected tokens.
  9626. </exception>
  9627. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  9628. The server replied with a NO or BAD response.
  9629. </exception>
  9630. </member>
  9631. <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
  9632. <summary>
  9633. Fetches the message summaries for the specified message indexes.
  9634. </summary>
  9635. <remarks>
  9636. <para>Fetches the message summaries for the specified message indexes.</para>
  9637. <para>It should be noted that if another client has modified any message
  9638. in the folder, the IMAP server may choose to return information that was
  9639. not explicitly requested. It is therefore important to be prepared to
  9640. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  9641. messages that were requested as well as summaries for messages that were
  9642. not requested at all.</para>
  9643. </remarks>
  9644. <returns>An enumeration of summaries for the requested messages.</returns>
  9645. <param name="indexes">The indexes.</param>
  9646. <param name="items">The message summary items to fetch.</param>
  9647. <param name="headers">The desired header fields.</param>
  9648. <param name="cancellationToken">The cancellation token.</param>
  9649. <exception cref="T:System.ArgumentNullException">
  9650. <para><paramref name="indexes"/> is <c>null</c>.</para>
  9651. <para>-or-</para>
  9652. <para><paramref name="headers"/> is <c>null</c>.</para>
  9653. </exception>
  9654. <exception cref="T:System.ArgumentException">
  9655. One or more of the <paramref name="indexes"/> is invalid.
  9656. </exception>
  9657. <exception cref="T:System.ObjectDisposedException">
  9658. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  9659. </exception>
  9660. <exception cref="T:MailKit.ServiceNotConnectedException">
  9661. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  9662. </exception>
  9663. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  9664. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  9665. </exception>
  9666. <exception cref="T:MailKit.FolderNotOpenException">
  9667. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  9668. </exception>
  9669. <exception cref="T:System.OperationCanceledException">
  9670. The operation was canceled via the cancellation token.
  9671. </exception>
  9672. <exception cref="T:System.IO.IOException">
  9673. An I/O error occurred.
  9674. </exception>
  9675. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  9676. The server's response contained unexpected tokens.
  9677. </exception>
  9678. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  9679. The server replied with a NO or BAD response.
  9680. </exception>
  9681. </member>
  9682. <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
  9683. <summary>
  9684. Asynchronously fetches the message summaries for the specified message indexes.
  9685. </summary>
  9686. <remarks>
  9687. <para>Fetches the message summaries for the specified message indexes.</para>
  9688. <para>It should be noted that if another client has modified any message
  9689. in the folder, the IMAP server may choose to return information that was
  9690. not explicitly requested. It is therefore important to be prepared to
  9691. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  9692. messages that were requested as well as summaries for messages that were
  9693. not requested at all.</para>
  9694. </remarks>
  9695. <returns>An enumeration of summaries for the requested messages.</returns>
  9696. <param name="indexes">The indexes.</param>
  9697. <param name="items">The message summary items to fetch.</param>
  9698. <param name="headers">The desired header fields.</param>
  9699. <param name="cancellationToken">The cancellation token.</param>
  9700. <exception cref="T:System.ArgumentNullException">
  9701. <para><paramref name="indexes"/> is <c>null</c>.</para>
  9702. <para>-or-</para>
  9703. <para><paramref name="headers"/> is <c>null</c>.</para>
  9704. </exception>
  9705. <exception cref="T:System.ArgumentException">
  9706. One or more of the <paramref name="indexes"/> is invalid.
  9707. </exception>
  9708. <exception cref="T:System.ObjectDisposedException">
  9709. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  9710. </exception>
  9711. <exception cref="T:MailKit.ServiceNotConnectedException">
  9712. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  9713. </exception>
  9714. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  9715. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  9716. </exception>
  9717. <exception cref="T:MailKit.FolderNotOpenException">
  9718. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  9719. </exception>
  9720. <exception cref="T:System.OperationCanceledException">
  9721. The operation was canceled via the cancellation token.
  9722. </exception>
  9723. <exception cref="T:System.IO.IOException">
  9724. An I/O error occurred.
  9725. </exception>
  9726. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  9727. The server's response contained unexpected tokens.
  9728. </exception>
  9729. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  9730. The server replied with a NO or BAD response.
  9731. </exception>
  9732. </member>
  9733. <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
  9734. <summary>
  9735. Fetches the message summaries for the specified message indexes.
  9736. </summary>
  9737. <remarks>
  9738. <para>Fetches the message summaries for the specified message indexes.</para>
  9739. <para>It should be noted that if another client has modified any message
  9740. in the folder, the IMAP server may choose to return information that was
  9741. not explicitly requested. It is therefore important to be prepared to
  9742. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  9743. messages that were requested as well as summaries for messages that were
  9744. not requested at all.</para>
  9745. </remarks>
  9746. <returns>An enumeration of summaries for the requested messages.</returns>
  9747. <param name="indexes">The indexes.</param>
  9748. <param name="items">The message summary items to fetch.</param>
  9749. <param name="headers">The desired header fields.</param>
  9750. <param name="cancellationToken">The cancellation token.</param>
  9751. <exception cref="T:System.ArgumentNullException">
  9752. <para><paramref name="indexes"/> is <c>null</c>.</para>
  9753. <para>-or-</para>
  9754. <para><paramref name="headers"/> is <c>null</c>.</para>
  9755. </exception>
  9756. <exception cref="T:System.ArgumentException">
  9757. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  9758. <para>-or-</para>
  9759. <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
  9760. </exception>
  9761. <exception cref="T:System.ObjectDisposedException">
  9762. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  9763. </exception>
  9764. <exception cref="T:MailKit.ServiceNotConnectedException">
  9765. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  9766. </exception>
  9767. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  9768. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  9769. </exception>
  9770. <exception cref="T:MailKit.FolderNotOpenException">
  9771. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  9772. </exception>
  9773. <exception cref="T:System.OperationCanceledException">
  9774. The operation was canceled via the cancellation token.
  9775. </exception>
  9776. <exception cref="T:System.IO.IOException">
  9777. An I/O error occurred.
  9778. </exception>
  9779. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  9780. The server's response contained unexpected tokens.
  9781. </exception>
  9782. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  9783. The server replied with a NO or BAD response.
  9784. </exception>
  9785. </member>
  9786. <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
  9787. <summary>
  9788. Asynchronously fetches the message summaries for the specified message indexes.
  9789. </summary>
  9790. <remarks>
  9791. <para>Fetches the message summaries for the specified message indexes.</para>
  9792. <para>It should be noted that if another client has modified any message
  9793. in the folder, the IMAP server may choose to return information that was
  9794. not explicitly requested. It is therefore important to be prepared to
  9795. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  9796. messages that were requested as well as summaries for messages that were
  9797. not requested at all.</para>
  9798. </remarks>
  9799. <returns>An enumeration of summaries for the requested messages.</returns>
  9800. <param name="indexes">The indexes.</param>
  9801. <param name="items">The message summary items to fetch.</param>
  9802. <param name="headers">The desired header fields.</param>
  9803. <param name="cancellationToken">The cancellation token.</param>
  9804. <exception cref="T:System.ArgumentNullException">
  9805. <para><paramref name="indexes"/> is <c>null</c>.</para>
  9806. <para>-or-</para>
  9807. <para><paramref name="headers"/> is <c>null</c>.</para>
  9808. </exception>
  9809. <exception cref="T:System.ArgumentException">
  9810. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  9811. <para>-or-</para>
  9812. <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
  9813. </exception>
  9814. <exception cref="T:System.ObjectDisposedException">
  9815. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  9816. </exception>
  9817. <exception cref="T:MailKit.ServiceNotConnectedException">
  9818. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  9819. </exception>
  9820. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  9821. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  9822. </exception>
  9823. <exception cref="T:MailKit.FolderNotOpenException">
  9824. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  9825. </exception>
  9826. <exception cref="T:System.OperationCanceledException">
  9827. The operation was canceled via the cancellation token.
  9828. </exception>
  9829. <exception cref="T:System.IO.IOException">
  9830. An I/O error occurred.
  9831. </exception>
  9832. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  9833. The server's response contained unexpected tokens.
  9834. </exception>
  9835. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  9836. The server replied with a NO or BAD response.
  9837. </exception>
  9838. </member>
  9839. <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
  9840. <summary>
  9841. Fetches the message summaries for the specified message indexes that have a
  9842. higher mod-sequence value than the one specified.
  9843. </summary>
  9844. <remarks>
  9845. <para>Fetches the message summaries for the specified message indexes that
  9846. have a higher mod-sequence value than the one specified.</para>
  9847. <para>It should be noted that if another client has modified any message
  9848. in the folder, the IMAP server may choose to return information that was
  9849. not explicitly requested. It is therefore important to be prepared to
  9850. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  9851. messages that were requested as well as summaries for messages that were
  9852. not requested at all.</para>
  9853. </remarks>
  9854. <returns>An enumeration of summaries for the requested messages.</returns>
  9855. <param name="indexes">The indexes.</param>
  9856. <param name="modseq">The mod-sequence value.</param>
  9857. <param name="items">The message summary items to fetch.</param>
  9858. <param name="cancellationToken">The cancellation token.</param>
  9859. <exception cref="T:System.ArgumentNullException">
  9860. <paramref name="indexes"/> is <c>null</c>.
  9861. </exception>
  9862. <exception cref="T:System.ArgumentOutOfRangeException">
  9863. <paramref name="items"/> is empty.
  9864. </exception>
  9865. <exception cref="T:System.ArgumentException">
  9866. One or more of the <paramref name="indexes"/> is invalid.
  9867. </exception>
  9868. <exception cref="T:System.ObjectDisposedException">
  9869. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  9870. </exception>
  9871. <exception cref="T:MailKit.ServiceNotConnectedException">
  9872. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  9873. </exception>
  9874. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  9875. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  9876. </exception>
  9877. <exception cref="T:MailKit.FolderNotOpenException">
  9878. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  9879. </exception>
  9880. <exception cref="T:System.NotSupportedException">
  9881. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
  9882. </exception>
  9883. <exception cref="T:System.OperationCanceledException">
  9884. The operation was canceled via the cancellation token.
  9885. </exception>
  9886. <exception cref="T:System.IO.IOException">
  9887. An I/O error occurred.
  9888. </exception>
  9889. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  9890. The server's response contained unexpected tokens.
  9891. </exception>
  9892. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  9893. The server replied with a NO or BAD response.
  9894. </exception>
  9895. </member>
  9896. <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
  9897. <summary>
  9898. Asynchronously fetches the message summaries for the specified message indexes that have a
  9899. higher mod-sequence value than the one specified.
  9900. </summary>
  9901. <remarks>
  9902. <para>Fetches the message summaries for the specified message indexes that
  9903. have a higher mod-sequence value than the one specified.</para>
  9904. <para>It should be noted that if another client has modified any message
  9905. in the folder, the IMAP server may choose to return information that was
  9906. not explicitly requested. It is therefore important to be prepared to
  9907. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  9908. messages that were requested as well as summaries for messages that were
  9909. not requested at all.</para>
  9910. </remarks>
  9911. <returns>An enumeration of summaries for the requested messages.</returns>
  9912. <param name="indexes">The indexes.</param>
  9913. <param name="modseq">The mod-sequence value.</param>
  9914. <param name="items">The message summary items to fetch.</param>
  9915. <param name="cancellationToken">The cancellation token.</param>
  9916. <exception cref="T:System.ArgumentNullException">
  9917. <paramref name="indexes"/> is <c>null</c>.
  9918. </exception>
  9919. <exception cref="T:System.ArgumentOutOfRangeException">
  9920. <paramref name="items"/> is empty.
  9921. </exception>
  9922. <exception cref="T:System.ArgumentException">
  9923. One or more of the <paramref name="indexes"/> is invalid.
  9924. </exception>
  9925. <exception cref="T:System.ObjectDisposedException">
  9926. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  9927. </exception>
  9928. <exception cref="T:MailKit.ServiceNotConnectedException">
  9929. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  9930. </exception>
  9931. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  9932. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  9933. </exception>
  9934. <exception cref="T:MailKit.FolderNotOpenException">
  9935. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  9936. </exception>
  9937. <exception cref="T:System.NotSupportedException">
  9938. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
  9939. </exception>
  9940. <exception cref="T:System.OperationCanceledException">
  9941. The operation was canceled via the cancellation token.
  9942. </exception>
  9943. <exception cref="T:System.IO.IOException">
  9944. An I/O error occurred.
  9945. </exception>
  9946. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  9947. The server's response contained unexpected tokens.
  9948. </exception>
  9949. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  9950. The server replied with a NO or BAD response.
  9951. </exception>
  9952. </member>
  9953. <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
  9954. <summary>
  9955. Fetches the message summaries for the specified message indexes that have a
  9956. higher mod-sequence value than the one specified.
  9957. </summary>
  9958. <remarks>
  9959. <para>Fetches the message summaries for the specified message indexes that
  9960. have a higher mod-sequence value than the one specified.</para>
  9961. <para>It should be noted that if another client has modified any message
  9962. in the folder, the IMAP server may choose to return information that was
  9963. not explicitly requested. It is therefore important to be prepared to
  9964. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  9965. messages that were requested as well as summaries for messages that were
  9966. not requested at all.</para>
  9967. </remarks>
  9968. <returns>An enumeration of summaries for the requested messages.</returns>
  9969. <param name="indexes">The indexes.</param>
  9970. <param name="modseq">The mod-sequence value.</param>
  9971. <param name="items">The message summary items to fetch.</param>
  9972. <param name="headers">The desired header fields.</param>
  9973. <param name="cancellationToken">The cancellation token.</param>
  9974. <exception cref="T:System.ArgumentNullException">
  9975. <para><paramref name="indexes"/> is <c>null</c>.</para>
  9976. <para>-or-</para>
  9977. <para><paramref name="headers"/> is <c>null</c>.</para>
  9978. </exception>
  9979. <exception cref="T:System.ArgumentException">
  9980. One or more of the <paramref name="indexes"/> is invalid.
  9981. </exception>
  9982. <exception cref="T:System.ObjectDisposedException">
  9983. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  9984. </exception>
  9985. <exception cref="T:MailKit.ServiceNotConnectedException">
  9986. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  9987. </exception>
  9988. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  9989. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  9990. </exception>
  9991. <exception cref="T:MailKit.FolderNotOpenException">
  9992. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  9993. </exception>
  9994. <exception cref="T:System.NotSupportedException">
  9995. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
  9996. </exception>
  9997. <exception cref="T:System.OperationCanceledException">
  9998. The operation was canceled via the cancellation token.
  9999. </exception>
  10000. <exception cref="T:System.IO.IOException">
  10001. An I/O error occurred.
  10002. </exception>
  10003. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  10004. The server's response contained unexpected tokens.
  10005. </exception>
  10006. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  10007. The server replied with a NO or BAD response.
  10008. </exception>
  10009. </member>
  10010. <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
  10011. <summary>
  10012. Asynchronously fetches the message summaries for the specified message indexes that have a
  10013. higher mod-sequence value than the one specified.
  10014. </summary>
  10015. <remarks>
  10016. <para>Fetches the message summaries for the specified message indexes that
  10017. have a higher mod-sequence value than the one specified.</para>
  10018. <para>It should be noted that if another client has modified any message
  10019. in the folder, the IMAP server may choose to return information that was
  10020. not explicitly requested. It is therefore important to be prepared to
  10021. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  10022. messages that were requested as well as summaries for messages that were
  10023. not requested at all.</para>
  10024. </remarks>
  10025. <returns>An enumeration of summaries for the requested messages.</returns>
  10026. <param name="indexes">The indexes.</param>
  10027. <param name="modseq">The mod-sequence value.</param>
  10028. <param name="items">The message summary items to fetch.</param>
  10029. <param name="headers">The desired header fields.</param>
  10030. <param name="cancellationToken">The cancellation token.</param>
  10031. <exception cref="T:System.ArgumentNullException">
  10032. <para><paramref name="indexes"/> is <c>null</c>.</para>
  10033. <para>-or-</para>
  10034. <para><paramref name="headers"/> is <c>null</c>.</para>
  10035. </exception>
  10036. <exception cref="T:System.ArgumentException">
  10037. One or more of the <paramref name="indexes"/> is invalid.
  10038. </exception>
  10039. <exception cref="T:System.ObjectDisposedException">
  10040. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  10041. </exception>
  10042. <exception cref="T:MailKit.ServiceNotConnectedException">
  10043. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  10044. </exception>
  10045. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  10046. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  10047. </exception>
  10048. <exception cref="T:MailKit.FolderNotOpenException">
  10049. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  10050. </exception>
  10051. <exception cref="T:System.NotSupportedException">
  10052. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
  10053. </exception>
  10054. <exception cref="T:System.OperationCanceledException">
  10055. The operation was canceled via the cancellation token.
  10056. </exception>
  10057. <exception cref="T:System.IO.IOException">
  10058. An I/O error occurred.
  10059. </exception>
  10060. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  10061. The server's response contained unexpected tokens.
  10062. </exception>
  10063. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  10064. The server replied with a NO or BAD response.
  10065. </exception>
  10066. </member>
  10067. <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
  10068. <summary>
  10069. Fetches the message summaries for the specified message indexes that have a
  10070. higher mod-sequence value than the one specified.
  10071. </summary>
  10072. <remarks>
  10073. <para>Fetches the message summaries for the specified message indexes that
  10074. have a higher mod-sequence value than the one specified.</para>
  10075. <para>It should be noted that if another client has modified any message
  10076. in the folder, the IMAP server may choose to return information that was
  10077. not explicitly requested. It is therefore important to be prepared to
  10078. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  10079. messages that were requested as well as summaries for messages that were
  10080. not requested at all.</para>
  10081. </remarks>
  10082. <returns>An enumeration of summaries for the requested messages.</returns>
  10083. <param name="indexes">The indexes.</param>
  10084. <param name="modseq">The mod-sequence value.</param>
  10085. <param name="items">The message summary items to fetch.</param>
  10086. <param name="headers">The desired header fields.</param>
  10087. <param name="cancellationToken">The cancellation token.</param>
  10088. <exception cref="T:System.ArgumentNullException">
  10089. <para><paramref name="indexes"/> is <c>null</c>.</para>
  10090. <para>-or-</para>
  10091. <para><paramref name="headers"/> is <c>null</c>.</para>
  10092. </exception>
  10093. <exception cref="T:System.ArgumentException">
  10094. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  10095. <para>-or-</para>
  10096. <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
  10097. </exception>
  10098. <exception cref="T:System.ObjectDisposedException">
  10099. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  10100. </exception>
  10101. <exception cref="T:MailKit.ServiceNotConnectedException">
  10102. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  10103. </exception>
  10104. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  10105. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  10106. </exception>
  10107. <exception cref="T:MailKit.FolderNotOpenException">
  10108. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  10109. </exception>
  10110. <exception cref="T:System.NotSupportedException">
  10111. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
  10112. </exception>
  10113. <exception cref="T:System.OperationCanceledException">
  10114. The operation was canceled via the cancellation token.
  10115. </exception>
  10116. <exception cref="T:System.IO.IOException">
  10117. An I/O error occurred.
  10118. </exception>
  10119. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  10120. The server's response contained unexpected tokens.
  10121. </exception>
  10122. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  10123. The server replied with a NO or BAD response.
  10124. </exception>
  10125. </member>
  10126. <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
  10127. <summary>
  10128. Asynchronously fetches the message summaries for the specified message indexes that have a
  10129. higher mod-sequence value than the one specified.
  10130. </summary>
  10131. <remarks>
  10132. <para>Fetches the message summaries for the specified message indexes that
  10133. have a higher mod-sequence value than the one specified.</para>
  10134. <para>It should be noted that if another client has modified any message
  10135. in the folder, the IMAP server may choose to return information that was
  10136. not explicitly requested. It is therefore important to be prepared to
  10137. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  10138. messages that were requested as well as summaries for messages that were
  10139. not requested at all.</para>
  10140. </remarks>
  10141. <returns>An enumeration of summaries for the requested messages.</returns>
  10142. <param name="indexes">The indexes.</param>
  10143. <param name="modseq">The mod-sequence value.</param>
  10144. <param name="items">The message summary items to fetch.</param>
  10145. <param name="headers">The desired header fields.</param>
  10146. <param name="cancellationToken">The cancellation token.</param>
  10147. <exception cref="T:System.ArgumentNullException">
  10148. <para><paramref name="indexes"/> is <c>null</c>.</para>
  10149. <para>-or-</para>
  10150. <para><paramref name="headers"/> is <c>null</c>.</para>
  10151. </exception>
  10152. <exception cref="T:System.ArgumentException">
  10153. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  10154. <para>-or-</para>
  10155. <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
  10156. </exception>
  10157. <exception cref="T:System.ObjectDisposedException">
  10158. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  10159. </exception>
  10160. <exception cref="T:MailKit.ServiceNotConnectedException">
  10161. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  10162. </exception>
  10163. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  10164. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  10165. </exception>
  10166. <exception cref="T:MailKit.FolderNotOpenException">
  10167. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  10168. </exception>
  10169. <exception cref="T:System.NotSupportedException">
  10170. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
  10171. </exception>
  10172. <exception cref="T:System.OperationCanceledException">
  10173. The operation was canceled via the cancellation token.
  10174. </exception>
  10175. <exception cref="T:System.IO.IOException">
  10176. An I/O error occurred.
  10177. </exception>
  10178. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  10179. The server's response contained unexpected tokens.
  10180. </exception>
  10181. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  10182. The server replied with a NO or BAD response.
  10183. </exception>
  10184. </member>
  10185. <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
  10186. <summary>
  10187. Fetches the message summaries for the messages between the two indexes, inclusive.
  10188. </summary>
  10189. <remarks>
  10190. <para>Fetches the message summaries for the messages between the two
  10191. indexes, inclusive.</para>
  10192. <para>It should be noted that if another client has modified any message
  10193. in the folder, the IMAP server may choose to return information that was
  10194. not explicitly requested. It is therefore important to be prepared to
  10195. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  10196. messages that were requested as well as summaries for messages that were
  10197. not requested at all.</para>
  10198. </remarks>
  10199. <returns>An enumeration of summaries for the requested messages.</returns>
  10200. <param name="min">The minimum index.</param>
  10201. <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
  10202. <param name="items">The message summary items to fetch.</param>
  10203. <param name="cancellationToken">The cancellation token.</param>
  10204. <exception cref="T:System.ArgumentOutOfRangeException">
  10205. <para><paramref name="min"/> is out of range.</para>
  10206. <para>-or-</para>
  10207. <para><paramref name="max"/> is out of range.</para>
  10208. <para>-or-</para>
  10209. <para><paramref name="items"/> is empty.</para>
  10210. </exception>
  10211. <exception cref="T:System.ObjectDisposedException">
  10212. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  10213. </exception>
  10214. <exception cref="T:MailKit.ServiceNotConnectedException">
  10215. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  10216. </exception>
  10217. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  10218. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  10219. </exception>
  10220. <exception cref="T:MailKit.FolderNotOpenException">
  10221. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  10222. </exception>
  10223. <exception cref="T:System.OperationCanceledException">
  10224. The operation was canceled via the cancellation token.
  10225. </exception>
  10226. <exception cref="T:System.IO.IOException">
  10227. An I/O error occurred.
  10228. </exception>
  10229. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  10230. The server's response contained unexpected tokens.
  10231. </exception>
  10232. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  10233. The server replied with a NO or BAD response.
  10234. </exception>
  10235. </member>
  10236. <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
  10237. <summary>
  10238. Asynchronously fetches the message summaries for the messages between the two indexes, inclusive.
  10239. </summary>
  10240. <remarks>
  10241. <para>Fetches the message summaries for the messages between the two
  10242. indexes, inclusive.</para>
  10243. <para>It should be noted that if another client has modified any message
  10244. in the folder, the IMAP server may choose to return information that was
  10245. not explicitly requested. It is therefore important to be prepared to
  10246. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  10247. messages that were requested as well as summaries for messages that were
  10248. not requested at all.</para>
  10249. </remarks>
  10250. <returns>An enumeration of summaries for the requested messages.</returns>
  10251. <param name="min">The minimum index.</param>
  10252. <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
  10253. <param name="items">The message summary items to fetch.</param>
  10254. <param name="cancellationToken">The cancellation token.</param>
  10255. <exception cref="T:System.ArgumentOutOfRangeException">
  10256. <para><paramref name="min"/> is out of range.</para>
  10257. <para>-or-</para>
  10258. <para><paramref name="max"/> is out of range.</para>
  10259. <para>-or-</para>
  10260. <para><paramref name="items"/> is empty.</para>
  10261. </exception>
  10262. <exception cref="T:System.ObjectDisposedException">
  10263. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  10264. </exception>
  10265. <exception cref="T:MailKit.ServiceNotConnectedException">
  10266. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  10267. </exception>
  10268. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  10269. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  10270. </exception>
  10271. <exception cref="T:MailKit.FolderNotOpenException">
  10272. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  10273. </exception>
  10274. <exception cref="T:System.OperationCanceledException">
  10275. The operation was canceled via the cancellation token.
  10276. </exception>
  10277. <exception cref="T:System.IO.IOException">
  10278. An I/O error occurred.
  10279. </exception>
  10280. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  10281. The server's response contained unexpected tokens.
  10282. </exception>
  10283. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  10284. The server replied with a NO or BAD response.
  10285. </exception>
  10286. </member>
  10287. <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
  10288. <summary>
  10289. Fetches the message summaries for the messages between the two indexes, inclusive.
  10290. </summary>
  10291. <remarks>
  10292. <para>Fetches the message summaries for the messages between the two
  10293. indexes, inclusive.</para>
  10294. <para>It should be noted that if another client has modified any message
  10295. in the folder, the IMAP server may choose to return information that was
  10296. not explicitly requested. It is therefore important to be prepared to
  10297. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  10298. messages that were requested as well as summaries for messages that were
  10299. not requested at all.</para>
  10300. </remarks>
  10301. <returns>An enumeration of summaries for the requested messages.</returns>
  10302. <param name="min">The minimum index.</param>
  10303. <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
  10304. <param name="items">The message summary items to fetch.</param>
  10305. <param name="headers">The desired header fields.</param>
  10306. <param name="cancellationToken">The cancellation token.</param>
  10307. <exception cref="T:System.ArgumentOutOfRangeException">
  10308. <para><paramref name="min"/> is out of range.</para>
  10309. <para>-or-</para>
  10310. <para><paramref name="max"/> is out of range.</para>
  10311. </exception>
  10312. <exception cref="T:System.ArgumentNullException">
  10313. <paramref name="headers"/> is <c>null</c>.
  10314. </exception>
  10315. <exception cref="T:System.ObjectDisposedException">
  10316. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  10317. </exception>
  10318. <exception cref="T:MailKit.ServiceNotConnectedException">
  10319. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  10320. </exception>
  10321. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  10322. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  10323. </exception>
  10324. <exception cref="T:MailKit.FolderNotOpenException">
  10325. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  10326. </exception>
  10327. <exception cref="T:System.OperationCanceledException">
  10328. The operation was canceled via the cancellation token.
  10329. </exception>
  10330. <exception cref="T:System.IO.IOException">
  10331. An I/O error occurred.
  10332. </exception>
  10333. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  10334. The server's response contained unexpected tokens.
  10335. </exception>
  10336. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  10337. The server replied with a NO or BAD response.
  10338. </exception>
  10339. </member>
  10340. <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
  10341. <summary>
  10342. Asynchronously fetches the message summaries for the messages between the two indexes, inclusive.
  10343. </summary>
  10344. <remarks>
  10345. <para>Fetches the message summaries for the messages between the two
  10346. indexes, inclusive.</para>
  10347. <para>It should be noted that if another client has modified any message
  10348. in the folder, the IMAP server may choose to return information that was
  10349. not explicitly requested. It is therefore important to be prepared to
  10350. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  10351. messages that were requested as well as summaries for messages that were
  10352. not requested at all.</para>
  10353. </remarks>
  10354. <returns>An enumeration of summaries for the requested messages.</returns>
  10355. <param name="min">The minimum index.</param>
  10356. <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
  10357. <param name="items">The message summary items to fetch.</param>
  10358. <param name="headers">The desired header fields.</param>
  10359. <param name="cancellationToken">The cancellation token.</param>
  10360. <exception cref="T:System.ArgumentOutOfRangeException">
  10361. <para><paramref name="min"/> is out of range.</para>
  10362. <para>-or-</para>
  10363. <para><paramref name="max"/> is out of range.</para>
  10364. </exception>
  10365. <exception cref="T:System.ArgumentNullException">
  10366. <paramref name="headers"/> is <c>null</c>.
  10367. </exception>
  10368. <exception cref="T:System.ObjectDisposedException">
  10369. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  10370. </exception>
  10371. <exception cref="T:MailKit.ServiceNotConnectedException">
  10372. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  10373. </exception>
  10374. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  10375. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  10376. </exception>
  10377. <exception cref="T:MailKit.FolderNotOpenException">
  10378. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  10379. </exception>
  10380. <exception cref="T:System.OperationCanceledException">
  10381. The operation was canceled via the cancellation token.
  10382. </exception>
  10383. <exception cref="T:System.IO.IOException">
  10384. An I/O error occurred.
  10385. </exception>
  10386. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  10387. The server's response contained unexpected tokens.
  10388. </exception>
  10389. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  10390. The server replied with a NO or BAD response.
  10391. </exception>
  10392. </member>
  10393. <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
  10394. <summary>
  10395. Fetches the message summaries for the messages between the two indexes, inclusive.
  10396. </summary>
  10397. <remarks>
  10398. <para>Fetches the message summaries for the messages between the two
  10399. indexes, inclusive.</para>
  10400. <para>It should be noted that if another client has modified any message
  10401. in the folder, the IMAP server may choose to return information that was
  10402. not explicitly requested. It is therefore important to be prepared to
  10403. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  10404. messages that were requested as well as summaries for messages that were
  10405. not requested at all.</para>
  10406. </remarks>
  10407. <returns>An enumeration of summaries for the requested messages.</returns>
  10408. <param name="min">The minimum index.</param>
  10409. <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
  10410. <param name="items">The message summary items to fetch.</param>
  10411. <param name="headers">The desired header fields.</param>
  10412. <param name="cancellationToken">The cancellation token.</param>
  10413. <exception cref="T:System.ArgumentOutOfRangeException">
  10414. <para><paramref name="min"/> is out of range.</para>
  10415. <para>-or-</para>
  10416. <para><paramref name="max"/> is out of range.</para>
  10417. </exception>
  10418. <exception cref="T:System.ArgumentNullException">
  10419. <paramref name="headers"/> is <c>null</c>.
  10420. </exception>
  10421. <exception cref="T:System.ArgumentException">
  10422. One or more of the specified <paramref name="headers"/> is invalid.
  10423. </exception>
  10424. <exception cref="T:System.ObjectDisposedException">
  10425. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  10426. </exception>
  10427. <exception cref="T:MailKit.ServiceNotConnectedException">
  10428. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  10429. </exception>
  10430. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  10431. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  10432. </exception>
  10433. <exception cref="T:MailKit.FolderNotOpenException">
  10434. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  10435. </exception>
  10436. <exception cref="T:System.OperationCanceledException">
  10437. The operation was canceled via the cancellation token.
  10438. </exception>
  10439. <exception cref="T:System.IO.IOException">
  10440. An I/O error occurred.
  10441. </exception>
  10442. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  10443. The server's response contained unexpected tokens.
  10444. </exception>
  10445. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  10446. The server replied with a NO or BAD response.
  10447. </exception>
  10448. </member>
  10449. <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
  10450. <summary>
  10451. Asynchronously fetches the message summaries for the messages between the two indexes, inclusive.
  10452. </summary>
  10453. <remarks>
  10454. <para>Fetches the message summaries for the messages between the two
  10455. indexes, inclusive.</para>
  10456. <para>It should be noted that if another client has modified any message
  10457. in the folder, the IMAP server may choose to return information that was
  10458. not explicitly requested. It is therefore important to be prepared to
  10459. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  10460. messages that were requested as well as summaries for messages that were
  10461. not requested at all.</para>
  10462. </remarks>
  10463. <returns>An enumeration of summaries for the requested messages.</returns>
  10464. <param name="min">The minimum index.</param>
  10465. <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
  10466. <param name="items">The message summary items to fetch.</param>
  10467. <param name="headers">The desired header fields.</param>
  10468. <param name="cancellationToken">The cancellation token.</param>
  10469. <exception cref="T:System.ArgumentOutOfRangeException">
  10470. <para><paramref name="min"/> is out of range.</para>
  10471. <para>-or-</para>
  10472. <para><paramref name="max"/> is out of range.</para>
  10473. </exception>
  10474. <exception cref="T:System.ArgumentNullException">
  10475. <paramref name="headers"/> is <c>null</c>.
  10476. </exception>
  10477. <exception cref="T:System.ArgumentException">
  10478. One or more of the specified <paramref name="headers"/> is invalid.
  10479. </exception>
  10480. <exception cref="T:System.ObjectDisposedException">
  10481. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  10482. </exception>
  10483. <exception cref="T:MailKit.ServiceNotConnectedException">
  10484. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  10485. </exception>
  10486. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  10487. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  10488. </exception>
  10489. <exception cref="T:MailKit.FolderNotOpenException">
  10490. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  10491. </exception>
  10492. <exception cref="T:System.OperationCanceledException">
  10493. The operation was canceled via the cancellation token.
  10494. </exception>
  10495. <exception cref="T:System.IO.IOException">
  10496. An I/O error occurred.
  10497. </exception>
  10498. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  10499. The server's response contained unexpected tokens.
  10500. </exception>
  10501. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  10502. The server replied with a NO or BAD response.
  10503. </exception>
  10504. </member>
  10505. <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
  10506. <summary>
  10507. Fetches the message summaries for the messages between the two indexes (inclusive)
  10508. that have a higher mod-sequence value than the one specified.
  10509. </summary>
  10510. <remarks>
  10511. <para>Fetches the message summaries for the messages between the two
  10512. indexes (inclusive) that have a higher mod-sequence value than the one
  10513. specified.</para>
  10514. <para>It should be noted that if another client has modified any message
  10515. in the folder, the IMAP server may choose to return information that was
  10516. not explicitly requested. It is therefore important to be prepared to
  10517. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  10518. messages that were requested as well as summaries for messages that were
  10519. not requested at all.</para>
  10520. </remarks>
  10521. <returns>An enumeration of summaries for the requested messages.</returns>
  10522. <param name="min">The minimum index.</param>
  10523. <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
  10524. <param name="modseq">The mod-sequence value.</param>
  10525. <param name="items">The message summary items to fetch.</param>
  10526. <param name="cancellationToken">The cancellation token.</param>
  10527. <exception cref="T:System.ArgumentOutOfRangeException">
  10528. <para><paramref name="min"/> is out of range.</para>
  10529. <para>-or-</para>
  10530. <para><paramref name="max"/> is out of range.</para>
  10531. <para>-or-</para>
  10532. <para><paramref name="items"/> is empty.</para>
  10533. </exception>
  10534. <exception cref="T:System.ObjectDisposedException">
  10535. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  10536. </exception>
  10537. <exception cref="T:MailKit.ServiceNotConnectedException">
  10538. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  10539. </exception>
  10540. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  10541. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  10542. </exception>
  10543. <exception cref="T:MailKit.FolderNotOpenException">
  10544. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  10545. </exception>
  10546. <exception cref="T:System.NotSupportedException">
  10547. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
  10548. </exception>
  10549. <exception cref="T:System.OperationCanceledException">
  10550. The operation was canceled via the cancellation token.
  10551. </exception>
  10552. <exception cref="T:System.IO.IOException">
  10553. An I/O error occurred.
  10554. </exception>
  10555. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  10556. The server's response contained unexpected tokens.
  10557. </exception>
  10558. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  10559. The server replied with a NO or BAD response.
  10560. </exception>
  10561. </member>
  10562. <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
  10563. <summary>
  10564. Asynchronously fetches the message summaries for the messages between the two indexes (inclusive)
  10565. that have a higher mod-sequence value than the one specified.
  10566. </summary>
  10567. <remarks>
  10568. <para>Fetches the message summaries for the messages between the two
  10569. indexes (inclusive) that have a higher mod-sequence value than the one
  10570. specified.</para>
  10571. <para>It should be noted that if another client has modified any message
  10572. in the folder, the IMAP server may choose to return information that was
  10573. not explicitly requested. It is therefore important to be prepared to
  10574. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  10575. messages that were requested as well as summaries for messages that were
  10576. not requested at all.</para>
  10577. </remarks>
  10578. <returns>An enumeration of summaries for the requested messages.</returns>
  10579. <param name="min">The minimum index.</param>
  10580. <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
  10581. <param name="modseq">The mod-sequence value.</param>
  10582. <param name="items">The message summary items to fetch.</param>
  10583. <param name="cancellationToken">The cancellation token.</param>
  10584. <exception cref="T:System.ArgumentOutOfRangeException">
  10585. <para><paramref name="min"/> is out of range.</para>
  10586. <para>-or-</para>
  10587. <para><paramref name="max"/> is out of range.</para>
  10588. <para>-or-</para>
  10589. <para><paramref name="items"/> is empty.</para>
  10590. </exception>
  10591. <exception cref="T:System.ObjectDisposedException">
  10592. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  10593. </exception>
  10594. <exception cref="T:MailKit.ServiceNotConnectedException">
  10595. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  10596. </exception>
  10597. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  10598. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  10599. </exception>
  10600. <exception cref="T:MailKit.FolderNotOpenException">
  10601. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  10602. </exception>
  10603. <exception cref="T:System.NotSupportedException">
  10604. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
  10605. </exception>
  10606. <exception cref="T:System.OperationCanceledException">
  10607. The operation was canceled via the cancellation token.
  10608. </exception>
  10609. <exception cref="T:System.IO.IOException">
  10610. An I/O error occurred.
  10611. </exception>
  10612. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  10613. The server's response contained unexpected tokens.
  10614. </exception>
  10615. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  10616. The server replied with a NO or BAD response.
  10617. </exception>
  10618. </member>
  10619. <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
  10620. <summary>
  10621. Fetches the message summaries for the messages between the two indexes (inclusive)
  10622. that have a higher mod-sequence value than the one specified.
  10623. </summary>
  10624. <remarks>
  10625. <para>Fetches the message summaries for the messages between the two
  10626. indexes (inclusive) that have a higher mod-sequence value than the one
  10627. specified.</para>
  10628. <para>It should be noted that if another client has modified any message
  10629. in the folder, the IMAP server may choose to return information that was
  10630. not explicitly requested. It is therefore important to be prepared to
  10631. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  10632. messages that were requested as well as summaries for messages that were
  10633. not requested at all.</para>
  10634. </remarks>
  10635. <returns>An enumeration of summaries for the requested messages.</returns>
  10636. <param name="min">The minimum index.</param>
  10637. <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
  10638. <param name="modseq">The mod-sequence value.</param>
  10639. <param name="items">The message summary items to fetch.</param>
  10640. <param name="headers">The desired header fields.</param>
  10641. <param name="cancellationToken">The cancellation token.</param>
  10642. <exception cref="T:System.ArgumentOutOfRangeException">
  10643. <para><paramref name="min"/> is out of range.</para>
  10644. <para>-or-</para>
  10645. <para><paramref name="max"/> is out of range.</para>
  10646. </exception>
  10647. <exception cref="T:System.ArgumentNullException">
  10648. <paramref name="headers"/> is <c>null</c>.
  10649. </exception>
  10650. <exception cref="T:System.ObjectDisposedException">
  10651. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  10652. </exception>
  10653. <exception cref="T:MailKit.ServiceNotConnectedException">
  10654. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  10655. </exception>
  10656. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  10657. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  10658. </exception>
  10659. <exception cref="T:MailKit.FolderNotOpenException">
  10660. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  10661. </exception>
  10662. <exception cref="T:System.NotSupportedException">
  10663. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
  10664. </exception>
  10665. <exception cref="T:System.OperationCanceledException">
  10666. The operation was canceled via the cancellation token.
  10667. </exception>
  10668. <exception cref="T:System.IO.IOException">
  10669. An I/O error occurred.
  10670. </exception>
  10671. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  10672. The server's response contained unexpected tokens.
  10673. </exception>
  10674. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  10675. The server replied with a NO or BAD response.
  10676. </exception>
  10677. </member>
  10678. <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
  10679. <summary>
  10680. Asynchronously fetches the message summaries for the messages between the two indexes (inclusive)
  10681. that have a higher mod-sequence value than the one specified.
  10682. </summary>
  10683. <remarks>
  10684. <para>Fetches the message summaries for the messages between the two
  10685. indexes (inclusive) that have a higher mod-sequence value than the one
  10686. specified.</para>
  10687. <para>It should be noted that if another client has modified any message
  10688. in the folder, the IMAP server may choose to return information that was
  10689. not explicitly requested. It is therefore important to be prepared to
  10690. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  10691. messages that were requested as well as summaries for messages that were
  10692. not requested at all.</para>
  10693. </remarks>
  10694. <returns>An enumeration of summaries for the requested messages.</returns>
  10695. <param name="min">The minimum index.</param>
  10696. <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
  10697. <param name="modseq">The mod-sequence value.</param>
  10698. <param name="items">The message summary items to fetch.</param>
  10699. <param name="headers">The desired header fields.</param>
  10700. <param name="cancellationToken">The cancellation token.</param>
  10701. <exception cref="T:System.ArgumentOutOfRangeException">
  10702. <para><paramref name="min"/> is out of range.</para>
  10703. <para>-or-</para>
  10704. <para><paramref name="max"/> is out of range.</para>
  10705. </exception>
  10706. <exception cref="T:System.ArgumentNullException">
  10707. <paramref name="headers"/> is <c>null</c>.
  10708. </exception>
  10709. <exception cref="T:System.ObjectDisposedException">
  10710. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  10711. </exception>
  10712. <exception cref="T:MailKit.ServiceNotConnectedException">
  10713. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  10714. </exception>
  10715. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  10716. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  10717. </exception>
  10718. <exception cref="T:MailKit.FolderNotOpenException">
  10719. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  10720. </exception>
  10721. <exception cref="T:System.NotSupportedException">
  10722. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
  10723. </exception>
  10724. <exception cref="T:System.OperationCanceledException">
  10725. The operation was canceled via the cancellation token.
  10726. </exception>
  10727. <exception cref="T:System.IO.IOException">
  10728. An I/O error occurred.
  10729. </exception>
  10730. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  10731. The server's response contained unexpected tokens.
  10732. </exception>
  10733. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  10734. The server replied with a NO or BAD response.
  10735. </exception>
  10736. </member>
  10737. <member name="M:MailKit.Net.Imap.ImapFolder.Fetch(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
  10738. <summary>
  10739. Fetches the message summaries for the messages between the two indexes (inclusive)
  10740. that have a higher mod-sequence value than the one specified.
  10741. </summary>
  10742. <remarks>
  10743. <para>Fetches the message summaries for the messages between the two
  10744. indexes (inclusive) that have a higher mod-sequence value than the one
  10745. specified.</para>
  10746. <para>It should be noted that if another client has modified any message
  10747. in the folder, the IMAP server may choose to return information that was
  10748. not explicitly requested. It is therefore important to be prepared to
  10749. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  10750. messages that were requested as well as summaries for messages that were
  10751. not requested at all.</para>
  10752. </remarks>
  10753. <returns>An enumeration of summaries for the requested messages.</returns>
  10754. <param name="min">The minimum index.</param>
  10755. <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
  10756. <param name="modseq">The mod-sequence value.</param>
  10757. <param name="items">The message summary items to fetch.</param>
  10758. <param name="headers">The desired header fields.</param>
  10759. <param name="cancellationToken">The cancellation token.</param>
  10760. <exception cref="T:System.ArgumentOutOfRangeException">
  10761. <para><paramref name="min"/> is out of range.</para>
  10762. <para>-or-</para>
  10763. <para><paramref name="max"/> is out of range.</para>
  10764. </exception>
  10765. <exception cref="T:System.ArgumentNullException">
  10766. <paramref name="headers"/> is <c>null</c>.
  10767. </exception>
  10768. <exception cref="T:System.ArgumentException">
  10769. One or more of the specified <paramref name="headers"/> is invalid.
  10770. </exception>
  10771. <exception cref="T:System.ObjectDisposedException">
  10772. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  10773. </exception>
  10774. <exception cref="T:MailKit.ServiceNotConnectedException">
  10775. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  10776. </exception>
  10777. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  10778. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  10779. </exception>
  10780. <exception cref="T:MailKit.FolderNotOpenException">
  10781. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  10782. </exception>
  10783. <exception cref="T:System.NotSupportedException">
  10784. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
  10785. </exception>
  10786. <exception cref="T:System.OperationCanceledException">
  10787. The operation was canceled via the cancellation token.
  10788. </exception>
  10789. <exception cref="T:System.IO.IOException">
  10790. An I/O error occurred.
  10791. </exception>
  10792. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  10793. The server's response contained unexpected tokens.
  10794. </exception>
  10795. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  10796. The server replied with a NO or BAD response.
  10797. </exception>
  10798. </member>
  10799. <member name="M:MailKit.Net.Imap.ImapFolder.FetchAsync(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
  10800. <summary>
  10801. Asynchronously fetches the message summaries for the messages between the two indexes (inclusive)
  10802. that have a higher mod-sequence value than the one specified.
  10803. </summary>
  10804. <remarks>
  10805. <para>Fetches the message summaries for the messages between the two
  10806. indexes (inclusive) that have a higher mod-sequence value than the one
  10807. specified.</para>
  10808. <para>It should be noted that if another client has modified any message
  10809. in the folder, the IMAP server may choose to return information that was
  10810. not explicitly requested. It is therefore important to be prepared to
  10811. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  10812. messages that were requested as well as summaries for messages that were
  10813. not requested at all.</para>
  10814. </remarks>
  10815. <returns>An enumeration of summaries for the requested messages.</returns>
  10816. <param name="min">The minimum index.</param>
  10817. <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
  10818. <param name="modseq">The mod-sequence value.</param>
  10819. <param name="items">The message summary items to fetch.</param>
  10820. <param name="headers">The desired header fields.</param>
  10821. <param name="cancellationToken">The cancellation token.</param>
  10822. <exception cref="T:System.ArgumentOutOfRangeException">
  10823. <para><paramref name="min"/> is out of range.</para>
  10824. <para>-or-</para>
  10825. <para><paramref name="max"/> is out of range.</para>
  10826. </exception>
  10827. <exception cref="T:System.ArgumentNullException">
  10828. <paramref name="headers"/> is <c>null</c>.
  10829. </exception>
  10830. <exception cref="T:System.ArgumentException">
  10831. One or more of the specified <paramref name="headers"/> is invalid.
  10832. </exception>
  10833. <exception cref="T:System.ObjectDisposedException">
  10834. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  10835. </exception>
  10836. <exception cref="T:MailKit.ServiceNotConnectedException">
  10837. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  10838. </exception>
  10839. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  10840. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  10841. </exception>
  10842. <exception cref="T:MailKit.FolderNotOpenException">
  10843. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  10844. </exception>
  10845. <exception cref="T:System.NotSupportedException">
  10846. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
  10847. </exception>
  10848. <exception cref="T:System.OperationCanceledException">
  10849. The operation was canceled via the cancellation token.
  10850. </exception>
  10851. <exception cref="T:System.IO.IOException">
  10852. An I/O error occurred.
  10853. </exception>
  10854. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  10855. The server's response contained unexpected tokens.
  10856. </exception>
  10857. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  10858. The server replied with a NO or BAD response.
  10859. </exception>
  10860. </member>
  10861. <member name="M:MailKit.Net.Imap.ImapFolder.CreateStream(System.Nullable{MailKit.UniqueId},System.String,System.Int32,System.Int32)">
  10862. <summary>
  10863. Create a backing stream for use with the GetMessage, GetBodyPart, and GetStream methods.
  10864. </summary>
  10865. <remarks>
  10866. <para>Allows subclass implementations to override the type of stream
  10867. created for use with the GetMessage, GetBodyPart and GetStream methods.</para>
  10868. <para>This could be useful for subclass implementations that intend to implement
  10869. support for caching and/or for subclass implementations that want to use
  10870. temporary file streams instead of memory-based streams for larger amounts of
  10871. message data.</para>
  10872. <para>Subclasses that implement caching using this API should wait for
  10873. <see cref="M:MailKit.Net.Imap.ImapFolder.CommitStream(System.IO.Stream,MailKit.UniqueId,System.String,System.Int32,System.Int32)"/> before adding the stream to their cache.</para>
  10874. <para>Streams returned by this method SHOULD clean up any allocated resources
  10875. such as deleting temporary files from the file system.</para>
  10876. <note type="note">The <paramref name="uid"/> will not be available for the various
  10877. GetMessage(), GetBodyPart() and GetStream() methods that take a message index rather
  10878. than a <see cref="T:MailKit.UniqueId"/>. It may also not be available if the IMAP server
  10879. response does not specify the <c>UID</c> value prior to sending the <c>literal-string</c>
  10880. token containing the message stream.</note>
  10881. </remarks>
  10882. <seealso cref="M:MailKit.Net.Imap.ImapFolder.CommitStream(System.IO.Stream,MailKit.UniqueId,System.String,System.Int32,System.Int32)"/>
  10883. <returns>The stream.</returns>
  10884. <param name="uid">The unique identifier of the message, if available.</param>
  10885. <param name="section">The section of the message that is being fetched.</param>
  10886. <param name="offset">The starting offset of the message section being fetched.</param>
  10887. <param name="length">The length of the stream being fetched, measured in bytes.</param>
  10888. </member>
  10889. <member name="M:MailKit.Net.Imap.ImapFolder.CommitStream(System.IO.Stream,MailKit.UniqueId,System.String,System.Int32,System.Int32)">
  10890. <summary>
  10891. Commit a stream returned by <see cref="M:MailKit.Net.Imap.ImapFolder.CreateStream(System.Nullable{MailKit.UniqueId},System.String,System.Int32,System.Int32)"/>.
  10892. </summary>
  10893. <remarks>
  10894. <para>Commits a stream returned by <see cref="M:MailKit.Net.Imap.ImapFolder.CreateStream(System.Nullable{MailKit.UniqueId},System.String,System.Int32,System.Int32)"/>.</para>
  10895. <para>This method is called only after both the message data has successfully
  10896. been written to the stream returned by <see cref="M:MailKit.Net.Imap.ImapFolder.CreateStream(System.Nullable{MailKit.UniqueId},System.String,System.Int32,System.Int32)"/> and a
  10897. <see cref="T:MailKit.UniqueId"/> has been obtained for the associated message.</para>
  10898. <para>For subclasses implementing caching, this method should be used for
  10899. committing the stream to their cache.</para>
  10900. <note type="note">Subclass implementations may take advantage of the fact that
  10901. <see cref="M:MailKit.Net.Imap.ImapFolder.CommitStream(System.IO.Stream,MailKit.UniqueId,System.String,System.Int32,System.Int32)"/> allows returning a new <see cref="T:System.IO.Stream"/>
  10902. reference if they move a file on the file system and wish to return a new
  10903. <see cref="T:System.IO.FileStream"/> based on the new path, for example.</note>
  10904. </remarks>
  10905. <seealso cref="M:MailKit.Net.Imap.ImapFolder.CreateStream(System.Nullable{MailKit.UniqueId},System.String,System.Int32,System.Int32)"/>
  10906. <returns>The stream.</returns>
  10907. <param name="stream">The stream.</param>
  10908. <param name="uid">The unique identifier of the message.</param>
  10909. <param name="section">The section of the message that the stream represents.</param>
  10910. <param name="offset">The starting offset of the message section.</param>
  10911. <param name="length">The length of the stream, measured in bytes.</param>
  10912. </member>
  10913. <member name="M:MailKit.Net.Imap.ImapFolder.GetHeaders(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  10914. <summary>
  10915. Get the specified message headers.
  10916. </summary>
  10917. <remarks>
  10918. Gets the specified message headers.
  10919. </remarks>
  10920. <returns>The message headers.</returns>
  10921. <param name="uid">The UID of the message.</param>
  10922. <param name="cancellationToken">The cancellation token.</param>
  10923. <param name="progress">The progress reporting mechanism.</param>
  10924. <exception cref="T:System.ArgumentException">
  10925. <paramref name="uid"/> is invalid.
  10926. </exception>
  10927. <exception cref="T:System.ObjectDisposedException">
  10928. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  10929. </exception>
  10930. <exception cref="T:MailKit.ServiceNotConnectedException">
  10931. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  10932. </exception>
  10933. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  10934. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  10935. </exception>
  10936. <exception cref="T:MailKit.FolderNotOpenException">
  10937. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  10938. </exception>
  10939. <exception cref="T:MailKit.MessageNotFoundException">
  10940. The IMAP server did not return the requested message headers.
  10941. </exception>
  10942. <exception cref="T:System.OperationCanceledException">
  10943. The operation was canceled via the cancellation token.
  10944. </exception>
  10945. <exception cref="T:System.IO.IOException">
  10946. An I/O error occurred.
  10947. </exception>
  10948. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  10949. The server's response contained unexpected tokens.
  10950. </exception>
  10951. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  10952. The server replied with a NO or BAD response.
  10953. </exception>
  10954. </member>
  10955. <member name="M:MailKit.Net.Imap.ImapFolder.GetHeadersAsync(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  10956. <summary>
  10957. Asynchronously get the specified message headers.
  10958. </summary>
  10959. <remarks>
  10960. Gets the specified message headers.
  10961. </remarks>
  10962. <returns>The message headers.</returns>
  10963. <param name="uid">The UID of the message.</param>
  10964. <param name="cancellationToken">The cancellation token.</param>
  10965. <param name="progress">The progress reporting mechanism.</param>
  10966. <exception cref="T:System.ArgumentException">
  10967. <paramref name="uid"/> is invalid.
  10968. </exception>
  10969. <exception cref="T:System.ObjectDisposedException">
  10970. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  10971. </exception>
  10972. <exception cref="T:MailKit.ServiceNotConnectedException">
  10973. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  10974. </exception>
  10975. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  10976. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  10977. </exception>
  10978. <exception cref="T:MailKit.FolderNotOpenException">
  10979. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  10980. </exception>
  10981. <exception cref="T:MailKit.MessageNotFoundException">
  10982. The IMAP server did not return the requested message headers.
  10983. </exception>
  10984. <exception cref="T:System.OperationCanceledException">
  10985. The operation was canceled via the cancellation token.
  10986. </exception>
  10987. <exception cref="T:System.IO.IOException">
  10988. An I/O error occurred.
  10989. </exception>
  10990. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  10991. The server's response contained unexpected tokens.
  10992. </exception>
  10993. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  10994. The server replied with a NO or BAD response.
  10995. </exception>
  10996. </member>
  10997. <member name="M:MailKit.Net.Imap.ImapFolder.GetHeaders(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  10998. <summary>
  10999. Get the specified body part headers.
  11000. </summary>
  11001. <remarks>
  11002. Gets the specified body part headers.
  11003. </remarks>
  11004. <returns>The body part headers.</returns>
  11005. <param name="uid">The UID of the message.</param>
  11006. <param name="partSpecifier">The body part specifier.</param>
  11007. <param name="cancellationToken">The cancellation token.</param>
  11008. <param name="progress">The progress reporting mechanism.</param>
  11009. <exception cref="T:System.ArgumentNullException">
  11010. <paramref name="partSpecifier"/> is <c>null</c>.
  11011. </exception>
  11012. <exception cref="T:System.ArgumentException">
  11013. <paramref name="uid"/> is invalid.
  11014. </exception>
  11015. <exception cref="T:System.ObjectDisposedException">
  11016. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  11017. </exception>
  11018. <exception cref="T:MailKit.ServiceNotConnectedException">
  11019. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  11020. </exception>
  11021. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  11022. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  11023. </exception>
  11024. <exception cref="T:MailKit.FolderNotOpenException">
  11025. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  11026. </exception>
  11027. <exception cref="T:MailKit.MessageNotFoundException">
  11028. The IMAP server did not return the requested body part headers.
  11029. </exception>
  11030. <exception cref="T:System.OperationCanceledException">
  11031. The operation was canceled via the cancellation token.
  11032. </exception>
  11033. <exception cref="T:System.IO.IOException">
  11034. An I/O error occurred.
  11035. </exception>
  11036. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  11037. The server's response contained unexpected tokens.
  11038. </exception>
  11039. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  11040. The server replied with a NO or BAD response.
  11041. </exception>
  11042. </member>
  11043. <member name="M:MailKit.Net.Imap.ImapFolder.GetHeadersAsync(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  11044. <summary>
  11045. Asynchronously get the specified body part headers.
  11046. </summary>
  11047. <remarks>
  11048. Gets the specified body part headers.
  11049. </remarks>
  11050. <returns>The body part headers.</returns>
  11051. <param name="uid">The UID of the message.</param>
  11052. <param name="partSpecifier">The body part specifier.</param>
  11053. <param name="cancellationToken">The cancellation token.</param>
  11054. <param name="progress">The progress reporting mechanism.</param>
  11055. <exception cref="T:System.ArgumentNullException">
  11056. <paramref name="partSpecifier"/> is <c>null</c>.
  11057. </exception>
  11058. <exception cref="T:System.ArgumentException">
  11059. <paramref name="uid"/> is invalid.
  11060. </exception>
  11061. <exception cref="T:System.ObjectDisposedException">
  11062. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  11063. </exception>
  11064. <exception cref="T:MailKit.ServiceNotConnectedException">
  11065. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  11066. </exception>
  11067. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  11068. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  11069. </exception>
  11070. <exception cref="T:MailKit.FolderNotOpenException">
  11071. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  11072. </exception>
  11073. <exception cref="T:MailKit.MessageNotFoundException">
  11074. The IMAP server did not return the requested body part headers.
  11075. </exception>
  11076. <exception cref="T:System.OperationCanceledException">
  11077. The operation was canceled via the cancellation token.
  11078. </exception>
  11079. <exception cref="T:System.IO.IOException">
  11080. An I/O error occurred.
  11081. </exception>
  11082. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  11083. The server's response contained unexpected tokens.
  11084. </exception>
  11085. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  11086. The server replied with a NO or BAD response.
  11087. </exception>
  11088. </member>
  11089. <member name="M:MailKit.Net.Imap.ImapFolder.GetHeaders(MailKit.UniqueId,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  11090. <summary>
  11091. Get the specified body part headers.
  11092. </summary>
  11093. <remarks>
  11094. Gets the specified body part headers.
  11095. </remarks>
  11096. <returns>The body part headers.</returns>
  11097. <param name="uid">The UID of the message.</param>
  11098. <param name="part">The body part.</param>
  11099. <param name="cancellationToken">The cancellation token.</param>
  11100. <param name="progress">The progress reporting mechanism.</param>
  11101. <exception cref="T:System.ArgumentNullException">
  11102. <paramref name="part"/> is <c>null</c>.
  11103. </exception>
  11104. <exception cref="T:System.ArgumentException">
  11105. <paramref name="uid"/> is invalid.
  11106. </exception>
  11107. <exception cref="T:System.ObjectDisposedException">
  11108. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  11109. </exception>
  11110. <exception cref="T:MailKit.ServiceNotConnectedException">
  11111. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  11112. </exception>
  11113. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  11114. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  11115. </exception>
  11116. <exception cref="T:MailKit.FolderNotOpenException">
  11117. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  11118. </exception>
  11119. <exception cref="T:MailKit.MessageNotFoundException">
  11120. The IMAP server did not return the requested body part headers.
  11121. </exception>
  11122. <exception cref="T:System.OperationCanceledException">
  11123. The operation was canceled via the cancellation token.
  11124. </exception>
  11125. <exception cref="T:System.IO.IOException">
  11126. An I/O error occurred.
  11127. </exception>
  11128. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  11129. The server's response contained unexpected tokens.
  11130. </exception>
  11131. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  11132. The server replied with a NO or BAD response.
  11133. </exception>
  11134. </member>
  11135. <member name="M:MailKit.Net.Imap.ImapFolder.GetHeadersAsync(MailKit.UniqueId,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  11136. <summary>
  11137. Asynchronously get the specified body part headers.
  11138. </summary>
  11139. <remarks>
  11140. Gets the specified body part headers.
  11141. </remarks>
  11142. <returns>The body part headers.</returns>
  11143. <param name="uid">The UID of the message.</param>
  11144. <param name="part">The body part.</param>
  11145. <param name="cancellationToken">The cancellation token.</param>
  11146. <param name="progress">The progress reporting mechanism.</param>
  11147. <exception cref="T:System.ArgumentNullException">
  11148. <paramref name="part"/> is <c>null</c>.
  11149. </exception>
  11150. <exception cref="T:System.ArgumentException">
  11151. <paramref name="uid"/> is invalid.
  11152. </exception>
  11153. <exception cref="T:System.ObjectDisposedException">
  11154. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  11155. </exception>
  11156. <exception cref="T:MailKit.ServiceNotConnectedException">
  11157. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  11158. </exception>
  11159. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  11160. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  11161. </exception>
  11162. <exception cref="T:MailKit.FolderNotOpenException">
  11163. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  11164. </exception>
  11165. <exception cref="T:MailKit.MessageNotFoundException">
  11166. The IMAP server did not return the requested body part headers.
  11167. </exception>
  11168. <exception cref="T:System.OperationCanceledException">
  11169. The operation was canceled via the cancellation token.
  11170. </exception>
  11171. <exception cref="T:System.IO.IOException">
  11172. An I/O error occurred.
  11173. </exception>
  11174. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  11175. The server's response contained unexpected tokens.
  11176. </exception>
  11177. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  11178. The server replied with a NO or BAD response.
  11179. </exception>
  11180. </member>
  11181. <member name="M:MailKit.Net.Imap.ImapFolder.GetHeaders(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  11182. <summary>
  11183. Get the specified message headers.
  11184. </summary>
  11185. <remarks>
  11186. Gets the specified message headers.
  11187. </remarks>
  11188. <returns>The message headers.</returns>
  11189. <param name="index">The index of the message.</param>
  11190. <param name="cancellationToken">The cancellation token.</param>
  11191. <param name="progress">The progress reporting mechanism.</param>
  11192. <exception cref="T:System.ArgumentOutOfRangeException">
  11193. <paramref name="index"/> is out of range.
  11194. </exception>
  11195. <exception cref="T:System.ObjectDisposedException">
  11196. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  11197. </exception>
  11198. <exception cref="T:MailKit.ServiceNotConnectedException">
  11199. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  11200. </exception>
  11201. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  11202. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  11203. </exception>
  11204. <exception cref="T:MailKit.FolderNotOpenException">
  11205. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  11206. </exception>
  11207. <exception cref="T:MailKit.MessageNotFoundException">
  11208. The IMAP server did not return the requested message headers.
  11209. </exception>
  11210. <exception cref="T:System.OperationCanceledException">
  11211. The operation was canceled via the cancellation token.
  11212. </exception>
  11213. <exception cref="T:System.IO.IOException">
  11214. An I/O error occurred.
  11215. </exception>
  11216. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  11217. The server's response contained unexpected tokens.
  11218. </exception>
  11219. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  11220. The server replied with a NO or BAD response.
  11221. </exception>
  11222. </member>
  11223. <member name="M:MailKit.Net.Imap.ImapFolder.GetHeadersAsync(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  11224. <summary>
  11225. Asynchronously get the specified message headers.
  11226. </summary>
  11227. <remarks>
  11228. Gets the specified message headers.
  11229. </remarks>
  11230. <returns>The message headers.</returns>
  11231. <param name="index">The index of the message.</param>
  11232. <param name="cancellationToken">The cancellation token.</param>
  11233. <param name="progress">The progress reporting mechanism.</param>
  11234. <exception cref="T:System.ArgumentOutOfRangeException">
  11235. <paramref name="index"/> is out of range.
  11236. </exception>
  11237. <exception cref="T:System.ObjectDisposedException">
  11238. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  11239. </exception>
  11240. <exception cref="T:MailKit.ServiceNotConnectedException">
  11241. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  11242. </exception>
  11243. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  11244. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  11245. </exception>
  11246. <exception cref="T:MailKit.FolderNotOpenException">
  11247. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  11248. </exception>
  11249. <exception cref="T:MailKit.MessageNotFoundException">
  11250. The IMAP server did not return the requested message headers.
  11251. </exception>
  11252. <exception cref="T:System.OperationCanceledException">
  11253. The operation was canceled via the cancellation token.
  11254. </exception>
  11255. <exception cref="T:System.IO.IOException">
  11256. An I/O error occurred.
  11257. </exception>
  11258. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  11259. The server's response contained unexpected tokens.
  11260. </exception>
  11261. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  11262. The server replied with a NO or BAD response.
  11263. </exception>
  11264. </member>
  11265. <member name="M:MailKit.Net.Imap.ImapFolder.GetHeaders(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  11266. <summary>
  11267. Get the specified body part headers.
  11268. </summary>
  11269. <remarks>
  11270. Gets the specified body part headers.
  11271. </remarks>
  11272. <returns>The body part headers.</returns>
  11273. <param name="index">The index of the message.</param>
  11274. <param name="partSpecifier">The body part specifier.</param>
  11275. <param name="cancellationToken">The cancellation token.</param>
  11276. <param name="progress">The progress reporting mechanism.</param>
  11277. <exception cref="T:System.ArgumentOutOfRangeException">
  11278. <paramref name="index"/> is out of range.
  11279. </exception>
  11280. <exception cref="T:System.ArgumentNullException">
  11281. <paramref name="partSpecifier"/> is <c>null</c>.
  11282. </exception>
  11283. <exception cref="T:System.ObjectDisposedException">
  11284. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  11285. </exception>
  11286. <exception cref="T:MailKit.ServiceNotConnectedException">
  11287. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  11288. </exception>
  11289. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  11290. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  11291. </exception>
  11292. <exception cref="T:MailKit.FolderNotOpenException">
  11293. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  11294. </exception>
  11295. <exception cref="T:MailKit.MessageNotFoundException">
  11296. The IMAP server did not return the requested body part headers.
  11297. </exception>
  11298. <exception cref="T:System.OperationCanceledException">
  11299. The operation was canceled via the cancellation token.
  11300. </exception>
  11301. <exception cref="T:System.IO.IOException">
  11302. An I/O error occurred.
  11303. </exception>
  11304. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  11305. The server's response contained unexpected tokens.
  11306. </exception>
  11307. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  11308. The server replied with a NO or BAD response.
  11309. </exception>
  11310. </member>
  11311. <member name="M:MailKit.Net.Imap.ImapFolder.GetHeadersAsync(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  11312. <summary>
  11313. Asynchronously get the specified body part headers.
  11314. </summary>
  11315. <remarks>
  11316. Gets the specified body part headers.
  11317. </remarks>
  11318. <returns>The body part headers.</returns>
  11319. <param name="index">The index of the message.</param>
  11320. <param name="partSpecifier">The body part specifier.</param>
  11321. <param name="cancellationToken">The cancellation token.</param>
  11322. <param name="progress">The progress reporting mechanism.</param>
  11323. <exception cref="T:System.ArgumentOutOfRangeException">
  11324. <paramref name="index"/> is out of range.
  11325. </exception>
  11326. <exception cref="T:System.ArgumentNullException">
  11327. <paramref name="partSpecifier"/> is <c>null</c>.
  11328. </exception>
  11329. <exception cref="T:System.ObjectDisposedException">
  11330. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  11331. </exception>
  11332. <exception cref="T:MailKit.ServiceNotConnectedException">
  11333. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  11334. </exception>
  11335. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  11336. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  11337. </exception>
  11338. <exception cref="T:MailKit.FolderNotOpenException">
  11339. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  11340. </exception>
  11341. <exception cref="T:MailKit.MessageNotFoundException">
  11342. The IMAP server did not return the requested body part headers.
  11343. </exception>
  11344. <exception cref="T:System.OperationCanceledException">
  11345. The operation was canceled via the cancellation token.
  11346. </exception>
  11347. <exception cref="T:System.IO.IOException">
  11348. An I/O error occurred.
  11349. </exception>
  11350. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  11351. The server's response contained unexpected tokens.
  11352. </exception>
  11353. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  11354. The server replied with a NO or BAD response.
  11355. </exception>
  11356. </member>
  11357. <member name="M:MailKit.Net.Imap.ImapFolder.GetHeaders(System.Int32,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  11358. <summary>
  11359. Get the specified body part headers.
  11360. </summary>
  11361. <remarks>
  11362. Gets the specified body part headers.
  11363. </remarks>
  11364. <returns>The body part headers.</returns>
  11365. <param name="index">The index of the message.</param>
  11366. <param name="part">The body part.</param>
  11367. <param name="cancellationToken">The cancellation token.</param>
  11368. <param name="progress">The progress reporting mechanism.</param>
  11369. <exception cref="T:System.ArgumentOutOfRangeException">
  11370. <paramref name="index"/> is out of range.
  11371. </exception>
  11372. <exception cref="T:System.ArgumentNullException">
  11373. <paramref name="part"/> is <c>null</c>.
  11374. </exception>
  11375. <exception cref="T:System.ObjectDisposedException">
  11376. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  11377. </exception>
  11378. <exception cref="T:MailKit.ServiceNotConnectedException">
  11379. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  11380. </exception>
  11381. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  11382. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  11383. </exception>
  11384. <exception cref="T:MailKit.FolderNotOpenException">
  11385. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  11386. </exception>
  11387. <exception cref="T:MailKit.MessageNotFoundException">
  11388. The IMAP server did not return the requested body part headers.
  11389. </exception>
  11390. <exception cref="T:System.OperationCanceledException">
  11391. The operation was canceled via the cancellation token.
  11392. </exception>
  11393. <exception cref="T:System.IO.IOException">
  11394. An I/O error occurred.
  11395. </exception>
  11396. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  11397. The server's response contained unexpected tokens.
  11398. </exception>
  11399. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  11400. The server replied with a NO or BAD response.
  11401. </exception>
  11402. </member>
  11403. <member name="M:MailKit.Net.Imap.ImapFolder.GetHeadersAsync(System.Int32,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  11404. <summary>
  11405. Asynchronously get the specified body part headers.
  11406. </summary>
  11407. <remarks>
  11408. Gets the specified body part headers.
  11409. </remarks>
  11410. <returns>The body part headers.</returns>
  11411. <param name="index">The index of the message.</param>
  11412. <param name="part">The body part.</param>
  11413. <param name="cancellationToken">The cancellation token.</param>
  11414. <param name="progress">The progress reporting mechanism.</param>
  11415. <exception cref="T:System.ArgumentOutOfRangeException">
  11416. <paramref name="index"/> is out of range.
  11417. </exception>
  11418. <exception cref="T:System.ArgumentNullException">
  11419. <paramref name="part"/> is <c>null</c>.
  11420. </exception>
  11421. <exception cref="T:System.ObjectDisposedException">
  11422. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  11423. </exception>
  11424. <exception cref="T:MailKit.ServiceNotConnectedException">
  11425. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  11426. </exception>
  11427. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  11428. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  11429. </exception>
  11430. <exception cref="T:MailKit.FolderNotOpenException">
  11431. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  11432. </exception>
  11433. <exception cref="T:MailKit.MessageNotFoundException">
  11434. The IMAP server did not return the requested body part headers.
  11435. </exception>
  11436. <exception cref="T:System.OperationCanceledException">
  11437. The operation was canceled via the cancellation token.
  11438. </exception>
  11439. <exception cref="T:System.IO.IOException">
  11440. An I/O error occurred.
  11441. </exception>
  11442. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  11443. The server's response contained unexpected tokens.
  11444. </exception>
  11445. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  11446. The server replied with a NO or BAD response.
  11447. </exception>
  11448. </member>
  11449. <member name="M:MailKit.Net.Imap.ImapFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  11450. <summary>
  11451. Get the specified message.
  11452. </summary>
  11453. <remarks>
  11454. Gets the specified message.
  11455. </remarks>
  11456. <returns>The message.</returns>
  11457. <param name="uid">The UID of the message.</param>
  11458. <param name="cancellationToken">The cancellation token.</param>
  11459. <param name="progress">The progress reporting mechanism.</param>
  11460. <exception cref="T:System.ArgumentException">
  11461. <paramref name="uid"/> is invalid.
  11462. </exception>
  11463. <exception cref="T:System.ObjectDisposedException">
  11464. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  11465. </exception>
  11466. <exception cref="T:MailKit.ServiceNotConnectedException">
  11467. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  11468. </exception>
  11469. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  11470. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  11471. </exception>
  11472. <exception cref="T:MailKit.FolderNotOpenException">
  11473. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  11474. </exception>
  11475. <exception cref="T:MailKit.MessageNotFoundException">
  11476. The IMAP server did not return the requested message.
  11477. </exception>
  11478. <exception cref="T:System.OperationCanceledException">
  11479. The operation was canceled via the cancellation token.
  11480. </exception>
  11481. <exception cref="T:System.IO.IOException">
  11482. An I/O error occurred.
  11483. </exception>
  11484. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  11485. The server's response contained unexpected tokens.
  11486. </exception>
  11487. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  11488. The server replied with a NO or BAD response.
  11489. </exception>
  11490. </member>
  11491. <member name="M:MailKit.Net.Imap.ImapFolder.GetMessageAsync(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  11492. <summary>
  11493. Asynchronously get the specified message.
  11494. </summary>
  11495. <remarks>
  11496. Gets the specified message.
  11497. </remarks>
  11498. <returns>The message.</returns>
  11499. <param name="uid">The UID of the message.</param>
  11500. <param name="cancellationToken">The cancellation token.</param>
  11501. <param name="progress">The progress reporting mechanism.</param>
  11502. <exception cref="T:System.ArgumentException">
  11503. <paramref name="uid"/> is invalid.
  11504. </exception>
  11505. <exception cref="T:System.ObjectDisposedException">
  11506. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  11507. </exception>
  11508. <exception cref="T:MailKit.ServiceNotConnectedException">
  11509. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  11510. </exception>
  11511. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  11512. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  11513. </exception>
  11514. <exception cref="T:MailKit.FolderNotOpenException">
  11515. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  11516. </exception>
  11517. <exception cref="T:MailKit.MessageNotFoundException">
  11518. The IMAP server did not return the requested message.
  11519. </exception>
  11520. <exception cref="T:System.OperationCanceledException">
  11521. The operation was canceled via the cancellation token.
  11522. </exception>
  11523. <exception cref="T:System.IO.IOException">
  11524. An I/O error occurred.
  11525. </exception>
  11526. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  11527. The server's response contained unexpected tokens.
  11528. </exception>
  11529. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  11530. The server replied with a NO or BAD response.
  11531. </exception>
  11532. </member>
  11533. <member name="M:MailKit.Net.Imap.ImapFolder.GetMessage(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  11534. <summary>
  11535. Get the specified message.
  11536. </summary>
  11537. <remarks>
  11538. Gets the specified message.
  11539. </remarks>
  11540. <returns>The message.</returns>
  11541. <param name="index">The index of the message.</param>
  11542. <param name="cancellationToken">The cancellation token.</param>
  11543. <param name="progress">The progress reporting mechanism.</param>
  11544. <exception cref="T:System.ArgumentOutOfRangeException">
  11545. <paramref name="index"/> is out of range.
  11546. </exception>
  11547. <exception cref="T:System.ObjectDisposedException">
  11548. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  11549. </exception>
  11550. <exception cref="T:MailKit.ServiceNotConnectedException">
  11551. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  11552. </exception>
  11553. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  11554. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  11555. </exception>
  11556. <exception cref="T:MailKit.FolderNotOpenException">
  11557. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  11558. </exception>
  11559. <exception cref="T:MailKit.MessageNotFoundException">
  11560. The IMAP server did not return the requested message.
  11561. </exception>
  11562. <exception cref="T:System.OperationCanceledException">
  11563. The operation was canceled via the cancellation token.
  11564. </exception>
  11565. <exception cref="T:System.IO.IOException">
  11566. An I/O error occurred.
  11567. </exception>
  11568. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  11569. The server's response contained unexpected tokens.
  11570. </exception>
  11571. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  11572. The server replied with a NO or BAD response.
  11573. </exception>
  11574. </member>
  11575. <member name="M:MailKit.Net.Imap.ImapFolder.GetMessageAsync(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  11576. <summary>
  11577. Asynchronously get the specified message.
  11578. </summary>
  11579. <remarks>
  11580. Gets the specified message.
  11581. </remarks>
  11582. <returns>The message.</returns>
  11583. <param name="index">The index of the message.</param>
  11584. <param name="cancellationToken">The cancellation token.</param>
  11585. <param name="progress">The progress reporting mechanism.</param>
  11586. <exception cref="T:System.ArgumentOutOfRangeException">
  11587. <paramref name="index"/> is out of range.
  11588. </exception>
  11589. <exception cref="T:System.ObjectDisposedException">
  11590. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  11591. </exception>
  11592. <exception cref="T:MailKit.ServiceNotConnectedException">
  11593. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  11594. </exception>
  11595. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  11596. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  11597. </exception>
  11598. <exception cref="T:MailKit.FolderNotOpenException">
  11599. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  11600. </exception>
  11601. <exception cref="T:MailKit.MessageNotFoundException">
  11602. The IMAP server did not return the requested message.
  11603. </exception>
  11604. <exception cref="T:System.OperationCanceledException">
  11605. The operation was canceled via the cancellation token.
  11606. </exception>
  11607. <exception cref="T:System.IO.IOException">
  11608. An I/O error occurred.
  11609. </exception>
  11610. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  11611. The server's response contained unexpected tokens.
  11612. </exception>
  11613. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  11614. The server replied with a NO or BAD response.
  11615. </exception>
  11616. </member>
  11617. <member name="M:MailKit.Net.Imap.ImapFolder.GetBodyPart(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  11618. <summary>
  11619. Get the specified body part.
  11620. </summary>
  11621. <remarks>
  11622. Gets the specified body part.
  11623. </remarks>
  11624. <returns>The body part.</returns>
  11625. <param name="uid">The UID of the message.</param>
  11626. <param name="partSpecifier">The body part specifier.</param>
  11627. <param name="cancellationToken">The cancellation token.</param>
  11628. <param name="progress">The progress reporting mechanism.</param>
  11629. <exception cref="T:System.ArgumentNullException">
  11630. <paramref name="partSpecifier"/> is <c>null</c>.
  11631. </exception>
  11632. <exception cref="T:System.ArgumentException">
  11633. <paramref name="uid"/> is invalid.
  11634. </exception>
  11635. <exception cref="T:System.ObjectDisposedException">
  11636. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  11637. </exception>
  11638. <exception cref="T:MailKit.ServiceNotConnectedException">
  11639. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  11640. </exception>
  11641. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  11642. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  11643. </exception>
  11644. <exception cref="T:MailKit.FolderNotOpenException">
  11645. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  11646. </exception>
  11647. <exception cref="T:MailKit.MessageNotFoundException">
  11648. The IMAP server did not return the requested message body.
  11649. </exception>
  11650. <exception cref="T:System.OperationCanceledException">
  11651. The operation was canceled via the cancellation token.
  11652. </exception>
  11653. <exception cref="T:System.IO.IOException">
  11654. An I/O error occurred.
  11655. </exception>
  11656. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  11657. The server's response contained unexpected tokens.
  11658. </exception>
  11659. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  11660. The server replied with a NO or BAD response.
  11661. </exception>
  11662. </member>
  11663. <member name="M:MailKit.Net.Imap.ImapFolder.GetBodyPartAsync(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  11664. <summary>
  11665. Asynchronously get the specified body part.
  11666. </summary>
  11667. <remarks>
  11668. Gets the specified body part.
  11669. </remarks>
  11670. <returns>The body part.</returns>
  11671. <param name="uid">The UID of the message.</param>
  11672. <param name="partSpecifier">The body part specifier.</param>
  11673. <param name="cancellationToken">The cancellation token.</param>
  11674. <param name="progress">The progress reporting mechanism.</param>
  11675. <exception cref="T:System.ArgumentNullException">
  11676. <paramref name="partSpecifier"/> is <c>null</c>.
  11677. </exception>
  11678. <exception cref="T:System.ArgumentException">
  11679. <paramref name="uid"/> is invalid.
  11680. </exception>
  11681. <exception cref="T:System.ObjectDisposedException">
  11682. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  11683. </exception>
  11684. <exception cref="T:MailKit.ServiceNotConnectedException">
  11685. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  11686. </exception>
  11687. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  11688. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  11689. </exception>
  11690. <exception cref="T:MailKit.FolderNotOpenException">
  11691. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  11692. </exception>
  11693. <exception cref="T:MailKit.MessageNotFoundException">
  11694. The IMAP server did not return the requested message body.
  11695. </exception>
  11696. <exception cref="T:System.OperationCanceledException">
  11697. The operation was canceled via the cancellation token.
  11698. </exception>
  11699. <exception cref="T:System.IO.IOException">
  11700. An I/O error occurred.
  11701. </exception>
  11702. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  11703. The server's response contained unexpected tokens.
  11704. </exception>
  11705. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  11706. The server replied with a NO or BAD response.
  11707. </exception>
  11708. </member>
  11709. <member name="M:MailKit.Net.Imap.ImapFolder.GetBodyPart(MailKit.UniqueId,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  11710. <summary>
  11711. Get the specified body part.
  11712. </summary>
  11713. <remarks>
  11714. Gets the specified body part.
  11715. </remarks>
  11716. <example>
  11717. <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
  11718. </example>
  11719. <returns>The body part.</returns>
  11720. <param name="uid">The UID of the message.</param>
  11721. <param name="part">The body part.</param>
  11722. <param name="cancellationToken">The cancellation token.</param>
  11723. <param name="progress">The progress reporting mechanism.</param>
  11724. <exception cref="T:System.ArgumentNullException">
  11725. <paramref name="part"/> is <c>null</c>.
  11726. </exception>
  11727. <exception cref="T:System.ArgumentException">
  11728. <paramref name="uid"/> is invalid.
  11729. </exception>
  11730. <exception cref="T:System.ObjectDisposedException">
  11731. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  11732. </exception>
  11733. <exception cref="T:MailKit.ServiceNotConnectedException">
  11734. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  11735. </exception>
  11736. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  11737. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  11738. </exception>
  11739. <exception cref="T:MailKit.FolderNotOpenException">
  11740. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  11741. </exception>
  11742. <exception cref="T:MailKit.MessageNotFoundException">
  11743. The IMAP server did not return the requested message body.
  11744. </exception>
  11745. <exception cref="T:System.OperationCanceledException">
  11746. The operation was canceled via the cancellation token.
  11747. </exception>
  11748. <exception cref="T:System.IO.IOException">
  11749. An I/O error occurred.
  11750. </exception>
  11751. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  11752. The server's response contained unexpected tokens.
  11753. </exception>
  11754. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  11755. The server replied with a NO or BAD response.
  11756. </exception>
  11757. </member>
  11758. <member name="M:MailKit.Net.Imap.ImapFolder.GetBodyPartAsync(MailKit.UniqueId,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  11759. <summary>
  11760. Asynchronously get the specified body part.
  11761. </summary>
  11762. <remarks>
  11763. Gets the specified body part.
  11764. </remarks>
  11765. <example>
  11766. <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
  11767. </example>
  11768. <returns>The body part.</returns>
  11769. <param name="uid">The UID of the message.</param>
  11770. <param name="part">The body part.</param>
  11771. <param name="cancellationToken">The cancellation token.</param>
  11772. <param name="progress">The progress reporting mechanism.</param>
  11773. <exception cref="T:System.ArgumentNullException">
  11774. <paramref name="part"/> is <c>null</c>.
  11775. </exception>
  11776. <exception cref="T:System.ArgumentException">
  11777. <paramref name="uid"/> is invalid.
  11778. </exception>
  11779. <exception cref="T:System.ObjectDisposedException">
  11780. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  11781. </exception>
  11782. <exception cref="T:MailKit.ServiceNotConnectedException">
  11783. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  11784. </exception>
  11785. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  11786. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  11787. </exception>
  11788. <exception cref="T:MailKit.FolderNotOpenException">
  11789. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  11790. </exception>
  11791. <exception cref="T:MailKit.MessageNotFoundException">
  11792. The IMAP server did not return the requested message body.
  11793. </exception>
  11794. <exception cref="T:System.OperationCanceledException">
  11795. The operation was canceled via the cancellation token.
  11796. </exception>
  11797. <exception cref="T:System.IO.IOException">
  11798. An I/O error occurred.
  11799. </exception>
  11800. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  11801. The server's response contained unexpected tokens.
  11802. </exception>
  11803. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  11804. The server replied with a NO or BAD response.
  11805. </exception>
  11806. </member>
  11807. <member name="M:MailKit.Net.Imap.ImapFolder.GetBodyPart(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  11808. <summary>
  11809. Get the specified body part.
  11810. </summary>
  11811. <remarks>
  11812. Gets the specified body part.
  11813. </remarks>
  11814. <returns>The body part.</returns>
  11815. <param name="index">The index of the message.</param>
  11816. <param name="partSpecifier">The body part specifier.</param>
  11817. <param name="cancellationToken">The cancellation token.</param>
  11818. <param name="progress">The progress reporting mechanism.</param>
  11819. <exception cref="T:System.ArgumentNullException">
  11820. <paramref name="partSpecifier"/> is <c>null</c>.
  11821. </exception>
  11822. <exception cref="T:System.ArgumentOutOfRangeException">
  11823. <paramref name="index"/> is out of range.
  11824. </exception>
  11825. <exception cref="T:System.ObjectDisposedException">
  11826. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  11827. </exception>
  11828. <exception cref="T:MailKit.ServiceNotConnectedException">
  11829. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  11830. </exception>
  11831. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  11832. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  11833. </exception>
  11834. <exception cref="T:MailKit.FolderNotOpenException">
  11835. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  11836. </exception>
  11837. <exception cref="T:MailKit.MessageNotFoundException">
  11838. The IMAP server did not return the requested message.
  11839. </exception>
  11840. <exception cref="T:System.OperationCanceledException">
  11841. The operation was canceled via the cancellation token.
  11842. </exception>
  11843. <exception cref="T:System.IO.IOException">
  11844. An I/O error occurred.
  11845. </exception>
  11846. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  11847. The server's response contained unexpected tokens.
  11848. </exception>
  11849. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  11850. The server replied with a NO or BAD response.
  11851. </exception>
  11852. </member>
  11853. <member name="M:MailKit.Net.Imap.ImapFolder.GetBodyPartAsync(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  11854. <summary>
  11855. Asynchronously get the specified body part.
  11856. </summary>
  11857. <remarks>
  11858. Gets the specified body part.
  11859. </remarks>
  11860. <returns>The body part.</returns>
  11861. <param name="index">The index of the message.</param>
  11862. <param name="partSpecifier">The body part specifier.</param>
  11863. <param name="cancellationToken">The cancellation token.</param>
  11864. <param name="progress">The progress reporting mechanism.</param>
  11865. <exception cref="T:System.ArgumentNullException">
  11866. <paramref name="partSpecifier"/> is <c>null</c>.
  11867. </exception>
  11868. <exception cref="T:System.ArgumentOutOfRangeException">
  11869. <paramref name="index"/> is out of range.
  11870. </exception>
  11871. <exception cref="T:System.ObjectDisposedException">
  11872. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  11873. </exception>
  11874. <exception cref="T:MailKit.ServiceNotConnectedException">
  11875. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  11876. </exception>
  11877. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  11878. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  11879. </exception>
  11880. <exception cref="T:MailKit.FolderNotOpenException">
  11881. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  11882. </exception>
  11883. <exception cref="T:MailKit.MessageNotFoundException">
  11884. The IMAP server did not return the requested message.
  11885. </exception>
  11886. <exception cref="T:System.OperationCanceledException">
  11887. The operation was canceled via the cancellation token.
  11888. </exception>
  11889. <exception cref="T:System.IO.IOException">
  11890. An I/O error occurred.
  11891. </exception>
  11892. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  11893. The server's response contained unexpected tokens.
  11894. </exception>
  11895. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  11896. The server replied with a NO or BAD response.
  11897. </exception>
  11898. </member>
  11899. <member name="M:MailKit.Net.Imap.ImapFolder.GetBodyPart(System.Int32,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  11900. <summary>
  11901. Get the specified body part.
  11902. </summary>
  11903. <remarks>
  11904. Gets the specified body part.
  11905. </remarks>
  11906. <returns>The body part.</returns>
  11907. <param name="index">The index of the message.</param>
  11908. <param name="part">The body part.</param>
  11909. <param name="cancellationToken">The cancellation token.</param>
  11910. <param name="progress">The progress reporting mechanism.</param>
  11911. <exception cref="T:System.ArgumentNullException">
  11912. <paramref name="part"/> is <c>null</c>.
  11913. </exception>
  11914. <exception cref="T:System.ArgumentOutOfRangeException">
  11915. <paramref name="index"/> is out of range.
  11916. </exception>
  11917. <exception cref="T:System.ObjectDisposedException">
  11918. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  11919. </exception>
  11920. <exception cref="T:MailKit.ServiceNotConnectedException">
  11921. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  11922. </exception>
  11923. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  11924. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  11925. </exception>
  11926. <exception cref="T:MailKit.FolderNotOpenException">
  11927. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  11928. </exception>
  11929. <exception cref="T:MailKit.MessageNotFoundException">
  11930. The IMAP server did not return the requested message.
  11931. </exception>
  11932. <exception cref="T:System.OperationCanceledException">
  11933. The operation was canceled via the cancellation token.
  11934. </exception>
  11935. <exception cref="T:System.IO.IOException">
  11936. An I/O error occurred.
  11937. </exception>
  11938. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  11939. The server's response contained unexpected tokens.
  11940. </exception>
  11941. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  11942. The server replied with a NO or BAD response.
  11943. </exception>
  11944. </member>
  11945. <member name="M:MailKit.Net.Imap.ImapFolder.GetBodyPartAsync(System.Int32,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  11946. <summary>
  11947. Asynchronously get the specified body part.
  11948. </summary>
  11949. <remarks>
  11950. Gets the specified body part.
  11951. </remarks>
  11952. <returns>The body part.</returns>
  11953. <param name="index">The index of the message.</param>
  11954. <param name="part">The body part.</param>
  11955. <param name="cancellationToken">The cancellation token.</param>
  11956. <param name="progress">The progress reporting mechanism.</param>
  11957. <exception cref="T:System.ArgumentNullException">
  11958. <paramref name="part"/> is <c>null</c>.
  11959. </exception>
  11960. <exception cref="T:System.ArgumentOutOfRangeException">
  11961. <paramref name="index"/> is out of range.
  11962. </exception>
  11963. <exception cref="T:System.ObjectDisposedException">
  11964. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  11965. </exception>
  11966. <exception cref="T:MailKit.ServiceNotConnectedException">
  11967. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  11968. </exception>
  11969. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  11970. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  11971. </exception>
  11972. <exception cref="T:MailKit.FolderNotOpenException">
  11973. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  11974. </exception>
  11975. <exception cref="T:MailKit.MessageNotFoundException">
  11976. The IMAP server did not return the requested message.
  11977. </exception>
  11978. <exception cref="T:System.OperationCanceledException">
  11979. The operation was canceled via the cancellation token.
  11980. </exception>
  11981. <exception cref="T:System.IO.IOException">
  11982. An I/O error occurred.
  11983. </exception>
  11984. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  11985. The server's response contained unexpected tokens.
  11986. </exception>
  11987. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  11988. The server replied with a NO or BAD response.
  11989. </exception>
  11990. </member>
  11991. <member name="M:MailKit.Net.Imap.ImapFolder.GetStream(MailKit.UniqueId,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  11992. <summary>
  11993. Get a substream of the specified message.
  11994. </summary>
  11995. <remarks>
  11996. Fetches a substream of the message. If the starting offset is beyond
  11997. the end of the message, an empty stream is returned. If the number of
  11998. bytes desired extends beyond the end of the message, a truncated stream
  11999. will be returned.
  12000. </remarks>
  12001. <returns>The stream.</returns>
  12002. <param name="uid">The UID of the message.</param>
  12003. <param name="offset">The starting offset of the first desired byte.</param>
  12004. <param name="count">The number of bytes desired.</param>
  12005. <param name="cancellationToken">The cancellation token.</param>
  12006. <param name="progress">The progress reporting mechanism.</param>
  12007. <exception cref="T:System.ArgumentException">
  12008. <paramref name="uid"/> is invalid.
  12009. </exception>
  12010. <exception cref="T:System.ArgumentOutOfRangeException">
  12011. <para><paramref name="offset"/> is negative.</para>
  12012. <para>-or-</para>
  12013. <para><paramref name="count"/> is negative.</para>
  12014. </exception>
  12015. <exception cref="T:System.ObjectDisposedException">
  12016. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  12017. </exception>
  12018. <exception cref="T:MailKit.ServiceNotConnectedException">
  12019. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  12020. </exception>
  12021. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  12022. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  12023. </exception>
  12024. <exception cref="T:MailKit.FolderNotOpenException">
  12025. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  12026. </exception>
  12027. <exception cref="T:MailKit.MessageNotFoundException">
  12028. The IMAP server did not return the requested message stream.
  12029. </exception>
  12030. <exception cref="T:System.OperationCanceledException">
  12031. The operation was canceled via the cancellation token.
  12032. </exception>
  12033. <exception cref="T:System.IO.IOException">
  12034. An I/O error occurred.
  12035. </exception>
  12036. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  12037. The server's response contained unexpected tokens.
  12038. </exception>
  12039. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  12040. The server replied with a NO or BAD response.
  12041. </exception>
  12042. </member>
  12043. <member name="M:MailKit.Net.Imap.ImapFolder.GetStreamAsync(MailKit.UniqueId,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  12044. <summary>
  12045. Asynchronously gets a substream of the specified message.
  12046. </summary>
  12047. <remarks>
  12048. Fetches a substream of the message. If the starting offset is beyond
  12049. the end of the message, an empty stream is returned. If the number of
  12050. bytes desired extends beyond the end of the message, a truncated stream
  12051. will be returned.
  12052. </remarks>
  12053. <returns>The stream.</returns>
  12054. <param name="uid">The UID of the message.</param>
  12055. <param name="offset">The starting offset of the first desired byte.</param>
  12056. <param name="count">The number of bytes desired.</param>
  12057. <param name="cancellationToken">The cancellation token.</param>
  12058. <param name="progress">The progress reporting mechanism.</param>
  12059. <exception cref="T:System.ArgumentException">
  12060. <paramref name="uid"/> is invalid.
  12061. </exception>
  12062. <exception cref="T:System.ArgumentOutOfRangeException">
  12063. <para><paramref name="offset"/> is negative.</para>
  12064. <para>-or-</para>
  12065. <para><paramref name="count"/> is negative.</para>
  12066. </exception>
  12067. <exception cref="T:System.ObjectDisposedException">
  12068. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  12069. </exception>
  12070. <exception cref="T:MailKit.ServiceNotConnectedException">
  12071. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  12072. </exception>
  12073. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  12074. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  12075. </exception>
  12076. <exception cref="T:MailKit.FolderNotOpenException">
  12077. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  12078. </exception>
  12079. <exception cref="T:MailKit.MessageNotFoundException">
  12080. The IMAP server did not return the requested message stream.
  12081. </exception>
  12082. <exception cref="T:System.OperationCanceledException">
  12083. The operation was canceled via the cancellation token.
  12084. </exception>
  12085. <exception cref="T:System.IO.IOException">
  12086. An I/O error occurred.
  12087. </exception>
  12088. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  12089. The server's response contained unexpected tokens.
  12090. </exception>
  12091. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  12092. The server replied with a NO or BAD response.
  12093. </exception>
  12094. </member>
  12095. <member name="M:MailKit.Net.Imap.ImapFolder.GetStream(System.Int32,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  12096. <summary>
  12097. Get a substream of the specified message.
  12098. </summary>
  12099. <remarks>
  12100. Fetches a substream of the message. If the starting offset is beyond
  12101. the end of the message, an empty stream is returned. If the number of
  12102. bytes desired extends beyond the end of the message, a truncated stream
  12103. will be returned.
  12104. </remarks>
  12105. <returns>The stream.</returns>
  12106. <param name="index">The index of the message.</param>
  12107. <param name="offset">The starting offset of the first desired byte.</param>
  12108. <param name="count">The number of bytes desired.</param>
  12109. <param name="cancellationToken">The cancellation token.</param>
  12110. <param name="progress">The progress reporting mechanism.</param>
  12111. <exception cref="T:System.ArgumentOutOfRangeException">
  12112. <para><paramref name="index"/> is out of range.</para>
  12113. <para>-or-</para>
  12114. <para><paramref name="offset"/> is negative.</para>
  12115. <para>-or-</para>
  12116. <para><paramref name="count"/> is negative.</para>
  12117. </exception>
  12118. <exception cref="T:System.ObjectDisposedException">
  12119. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  12120. </exception>
  12121. <exception cref="T:MailKit.ServiceNotConnectedException">
  12122. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  12123. </exception>
  12124. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  12125. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  12126. </exception>
  12127. <exception cref="T:MailKit.FolderNotOpenException">
  12128. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  12129. </exception>
  12130. <exception cref="T:MailKit.MessageNotFoundException">
  12131. The IMAP server did not return the requested message stream.
  12132. </exception>
  12133. <exception cref="T:System.OperationCanceledException">
  12134. The operation was canceled via the cancellation token.
  12135. </exception>
  12136. <exception cref="T:System.IO.IOException">
  12137. An I/O error occurred.
  12138. </exception>
  12139. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  12140. The server's response contained unexpected tokens.
  12141. </exception>
  12142. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  12143. The server replied with a NO or BAD response.
  12144. </exception>
  12145. </member>
  12146. <member name="M:MailKit.Net.Imap.ImapFolder.GetStreamAsync(System.Int32,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  12147. <summary>
  12148. Asynchronously gets a substream of the specified message.
  12149. </summary>
  12150. <remarks>
  12151. Fetches a substream of the message. If the starting offset is beyond
  12152. the end of the message, an empty stream is returned. If the number of
  12153. bytes desired extends beyond the end of the message, a truncated stream
  12154. will be returned.
  12155. </remarks>
  12156. <returns>The stream.</returns>
  12157. <param name="index">The index of the message.</param>
  12158. <param name="offset">The starting offset of the first desired byte.</param>
  12159. <param name="count">The number of bytes desired.</param>
  12160. <param name="cancellationToken">The cancellation token.</param>
  12161. <param name="progress">The progress reporting mechanism.</param>
  12162. <exception cref="T:System.ArgumentOutOfRangeException">
  12163. <para><paramref name="index"/> is out of range.</para>
  12164. <para>-or-</para>
  12165. <para><paramref name="offset"/> is negative.</para>
  12166. <para>-or-</para>
  12167. <para><paramref name="count"/> is negative.</para>
  12168. </exception>
  12169. <exception cref="T:System.ObjectDisposedException">
  12170. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  12171. </exception>
  12172. <exception cref="T:MailKit.ServiceNotConnectedException">
  12173. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  12174. </exception>
  12175. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  12176. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  12177. </exception>
  12178. <exception cref="T:MailKit.FolderNotOpenException">
  12179. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  12180. </exception>
  12181. <exception cref="T:MailKit.MessageNotFoundException">
  12182. The IMAP server did not return the requested message stream.
  12183. </exception>
  12184. <exception cref="T:System.OperationCanceledException">
  12185. The operation was canceled via the cancellation token.
  12186. </exception>
  12187. <exception cref="T:System.IO.IOException">
  12188. An I/O error occurred.
  12189. </exception>
  12190. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  12191. The server's response contained unexpected tokens.
  12192. </exception>
  12193. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  12194. The server replied with a NO or BAD response.
  12195. </exception>
  12196. </member>
  12197. <member name="M:MailKit.Net.Imap.ImapFolder.GetStream(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  12198. <summary>
  12199. Get a substream of the specified body part.
  12200. </summary>
  12201. <remarks>
  12202. <para>Gets a substream of the specified message.</para>
  12203. <para>For more information about how to construct the <paramref name="section"/>,
  12204. see Section 6.4.5 of RFC3501.</para>
  12205. </remarks>
  12206. <returns>The stream.</returns>
  12207. <param name="uid">The UID of the message.</param>
  12208. <param name="section">The desired section of the message.</param>
  12209. <param name="cancellationToken">The cancellation token.</param>
  12210. <param name="progress">The progress reporting mechanism.</param>
  12211. <exception cref="T:System.ArgumentException">
  12212. <paramref name="uid"/> is invalid.
  12213. </exception>
  12214. <exception cref="T:System.ArgumentNullException">
  12215. <paramref name="section"/> is <c>null</c>.
  12216. </exception>
  12217. <exception cref="T:System.ObjectDisposedException">
  12218. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  12219. </exception>
  12220. <exception cref="T:MailKit.ServiceNotConnectedException">
  12221. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  12222. </exception>
  12223. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  12224. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  12225. </exception>
  12226. <exception cref="T:MailKit.FolderNotOpenException">
  12227. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  12228. </exception>
  12229. <exception cref="T:MailKit.MessageNotFoundException">
  12230. The IMAP server did not return the requested message stream.
  12231. </exception>
  12232. <exception cref="T:System.OperationCanceledException">
  12233. The operation was canceled via the cancellation token.
  12234. </exception>
  12235. <exception cref="T:System.IO.IOException">
  12236. An I/O error occurred.
  12237. </exception>
  12238. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  12239. The server's response contained unexpected tokens.
  12240. </exception>
  12241. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  12242. The server replied with a NO or BAD response.
  12243. </exception>
  12244. </member>
  12245. <member name="M:MailKit.Net.Imap.ImapFolder.GetStreamAsync(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  12246. <summary>
  12247. Asynchronously gets a substream of the specified body part.
  12248. </summary>
  12249. <remarks>
  12250. <para>Gets a substream of the specified message.</para>
  12251. <para>For more information about how to construct the <paramref name="section"/>,
  12252. see Section 6.4.5 of RFC3501.</para>
  12253. </remarks>
  12254. <returns>The stream.</returns>
  12255. <param name="uid">The UID of the message.</param>
  12256. <param name="section">The desired section of the message.</param>
  12257. <param name="cancellationToken">The cancellation token.</param>
  12258. <param name="progress">The progress reporting mechanism.</param>
  12259. <exception cref="T:System.ArgumentException">
  12260. <paramref name="uid"/> is invalid.
  12261. </exception>
  12262. <exception cref="T:System.ArgumentNullException">
  12263. <paramref name="section"/> is <c>null</c>.
  12264. </exception>
  12265. <exception cref="T:System.ObjectDisposedException">
  12266. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  12267. </exception>
  12268. <exception cref="T:MailKit.ServiceNotConnectedException">
  12269. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  12270. </exception>
  12271. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  12272. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  12273. </exception>
  12274. <exception cref="T:MailKit.FolderNotOpenException">
  12275. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  12276. </exception>
  12277. <exception cref="T:MailKit.MessageNotFoundException">
  12278. The IMAP server did not return the requested message stream.
  12279. </exception>
  12280. <exception cref="T:System.OperationCanceledException">
  12281. The operation was canceled via the cancellation token.
  12282. </exception>
  12283. <exception cref="T:System.IO.IOException">
  12284. An I/O error occurred.
  12285. </exception>
  12286. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  12287. The server's response contained unexpected tokens.
  12288. </exception>
  12289. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  12290. The server replied with a NO or BAD response.
  12291. </exception>
  12292. </member>
  12293. <member name="M:MailKit.Net.Imap.ImapFolder.GetStream(MailKit.UniqueId,System.String,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  12294. <summary>
  12295. Get a substream of the specified message.
  12296. </summary>
  12297. <remarks>
  12298. <para>Gets a substream of the specified message. If the starting offset is beyond
  12299. the end of the specified section of the message, an empty stream is returned. If
  12300. the number of bytes desired extends beyond the end of the section, a truncated
  12301. stream will be returned.</para>
  12302. <para>For more information about how to construct the <paramref name="section"/>,
  12303. see Section 6.4.5 of RFC3501.</para>
  12304. </remarks>
  12305. <returns>The stream.</returns>
  12306. <param name="uid">The UID of the message.</param>
  12307. <param name="section">The desired section of the message.</param>
  12308. <param name="offset">The starting offset of the first desired byte.</param>
  12309. <param name="count">The number of bytes desired.</param>
  12310. <param name="cancellationToken">The cancellation token.</param>
  12311. <param name="progress">The progress reporting mechanism.</param>
  12312. <exception cref="T:System.ArgumentException">
  12313. <paramref name="uid"/> is invalid.
  12314. </exception>
  12315. <exception cref="T:System.ArgumentNullException">
  12316. <paramref name="section"/> is <c>null</c>.
  12317. </exception>
  12318. <exception cref="T:System.ArgumentOutOfRangeException">
  12319. <para><paramref name="offset"/> is negative.</para>
  12320. <para>-or-</para>
  12321. <para><paramref name="count"/> is negative.</para>
  12322. </exception>
  12323. <exception cref="T:System.ObjectDisposedException">
  12324. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  12325. </exception>
  12326. <exception cref="T:MailKit.ServiceNotConnectedException">
  12327. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  12328. </exception>
  12329. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  12330. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  12331. </exception>
  12332. <exception cref="T:MailKit.FolderNotOpenException">
  12333. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  12334. </exception>
  12335. <exception cref="T:MailKit.MessageNotFoundException">
  12336. The IMAP server did not return the requested message stream.
  12337. </exception>
  12338. <exception cref="T:System.OperationCanceledException">
  12339. The operation was canceled via the cancellation token.
  12340. </exception>
  12341. <exception cref="T:System.IO.IOException">
  12342. An I/O error occurred.
  12343. </exception>
  12344. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  12345. The server's response contained unexpected tokens.
  12346. </exception>
  12347. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  12348. The server replied with a NO or BAD response.
  12349. </exception>
  12350. </member>
  12351. <member name="M:MailKit.Net.Imap.ImapFolder.GetStreamAsync(MailKit.UniqueId,System.String,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  12352. <summary>
  12353. Asynchronously gets a substream of the specified message.
  12354. </summary>
  12355. <remarks>
  12356. <para>Gets a substream of the specified message. If the starting offset is beyond
  12357. the end of the specified section of the message, an empty stream is returned. If
  12358. the number of bytes desired extends beyond the end of the section, a truncated
  12359. stream will be returned.</para>
  12360. <para>For more information about how to construct the <paramref name="section"/>,
  12361. see Section 6.4.5 of RFC3501.</para>
  12362. </remarks>
  12363. <returns>The stream.</returns>
  12364. <param name="uid">The UID of the message.</param>
  12365. <param name="section">The desired section of the message.</param>
  12366. <param name="offset">The starting offset of the first desired byte.</param>
  12367. <param name="count">The number of bytes desired.</param>
  12368. <param name="cancellationToken">The cancellation token.</param>
  12369. <param name="progress">The progress reporting mechanism.</param>
  12370. <exception cref="T:System.ArgumentException">
  12371. <paramref name="uid"/> is invalid.
  12372. </exception>
  12373. <exception cref="T:System.ArgumentNullException">
  12374. <paramref name="section"/> is <c>null</c>.
  12375. </exception>
  12376. <exception cref="T:System.ArgumentOutOfRangeException">
  12377. <para><paramref name="offset"/> is negative.</para>
  12378. <para>-or-</para>
  12379. <para><paramref name="count"/> is negative.</para>
  12380. </exception>
  12381. <exception cref="T:System.ObjectDisposedException">
  12382. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  12383. </exception>
  12384. <exception cref="T:MailKit.ServiceNotConnectedException">
  12385. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  12386. </exception>
  12387. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  12388. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  12389. </exception>
  12390. <exception cref="T:MailKit.FolderNotOpenException">
  12391. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  12392. </exception>
  12393. <exception cref="T:MailKit.MessageNotFoundException">
  12394. The IMAP server did not return the requested message stream.
  12395. </exception>
  12396. <exception cref="T:System.OperationCanceledException">
  12397. The operation was canceled via the cancellation token.
  12398. </exception>
  12399. <exception cref="T:System.IO.IOException">
  12400. An I/O error occurred.
  12401. </exception>
  12402. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  12403. The server's response contained unexpected tokens.
  12404. </exception>
  12405. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  12406. The server replied with a NO or BAD response.
  12407. </exception>
  12408. </member>
  12409. <member name="M:MailKit.Net.Imap.ImapFolder.GetStream(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  12410. <summary>
  12411. Get a substream of the specified message.
  12412. </summary>
  12413. <remarks>
  12414. <para>Gets a substream of the specified message.</para>
  12415. <para>For more information about how to construct the <paramref name="section"/>,
  12416. see Section 6.4.5 of RFC3501.</para>
  12417. </remarks>
  12418. <returns>The stream.</returns>
  12419. <param name="index">The index of the message.</param>
  12420. <param name="section">The desired section of the message.</param>
  12421. <param name="cancellationToken">The cancellation token.</param>
  12422. <param name="progress">The progress reporting mechanism.</param>
  12423. <exception cref="T:System.ArgumentNullException">
  12424. <paramref name="section"/> is <c>null</c>.
  12425. </exception>
  12426. <exception cref="T:System.ArgumentOutOfRangeException">
  12427. <paramref name="index"/> is out of range.
  12428. </exception>
  12429. <exception cref="T:System.ObjectDisposedException">
  12430. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  12431. </exception>
  12432. <exception cref="T:MailKit.ServiceNotConnectedException">
  12433. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  12434. </exception>
  12435. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  12436. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  12437. </exception>
  12438. <exception cref="T:MailKit.FolderNotOpenException">
  12439. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  12440. </exception>
  12441. <exception cref="T:MailKit.MessageNotFoundException">
  12442. The IMAP server did not return the requested message stream.
  12443. </exception>
  12444. <exception cref="T:System.OperationCanceledException">
  12445. The operation was canceled via the cancellation token.
  12446. </exception>
  12447. <exception cref="T:System.IO.IOException">
  12448. An I/O error occurred.
  12449. </exception>
  12450. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  12451. The server's response contained unexpected tokens.
  12452. </exception>
  12453. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  12454. The server replied with a NO or BAD response.
  12455. </exception>
  12456. </member>
  12457. <member name="M:MailKit.Net.Imap.ImapFolder.GetStreamAsync(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  12458. <summary>
  12459. Asynchronously gets a substream of the specified message.
  12460. </summary>
  12461. <remarks>
  12462. <para>Gets a substream of the specified message.</para>
  12463. <para>For more information about how to construct the <paramref name="section"/>,
  12464. see Section 6.4.5 of RFC3501.</para>
  12465. </remarks>
  12466. <returns>The stream.</returns>
  12467. <param name="index">The index of the message.</param>
  12468. <param name="section">The desired section of the message.</param>
  12469. <param name="cancellationToken">The cancellation token.</param>
  12470. <param name="progress">The progress reporting mechanism.</param>
  12471. <exception cref="T:System.ArgumentNullException">
  12472. <paramref name="section"/> is <c>null</c>.
  12473. </exception>
  12474. <exception cref="T:System.ArgumentOutOfRangeException">
  12475. <paramref name="index"/> is out of range.
  12476. </exception>
  12477. <exception cref="T:System.ObjectDisposedException">
  12478. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  12479. </exception>
  12480. <exception cref="T:MailKit.ServiceNotConnectedException">
  12481. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  12482. </exception>
  12483. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  12484. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  12485. </exception>
  12486. <exception cref="T:MailKit.FolderNotOpenException">
  12487. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  12488. </exception>
  12489. <exception cref="T:MailKit.MessageNotFoundException">
  12490. The IMAP server did not return the requested message stream.
  12491. </exception>
  12492. <exception cref="T:System.OperationCanceledException">
  12493. The operation was canceled via the cancellation token.
  12494. </exception>
  12495. <exception cref="T:System.IO.IOException">
  12496. An I/O error occurred.
  12497. </exception>
  12498. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  12499. The server's response contained unexpected tokens.
  12500. </exception>
  12501. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  12502. The server replied with a NO or BAD response.
  12503. </exception>
  12504. </member>
  12505. <member name="M:MailKit.Net.Imap.ImapFolder.GetStream(System.Int32,System.String,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  12506. <summary>
  12507. Get a substream of the specified message.
  12508. </summary>
  12509. <remarks>
  12510. <para>Gets a substream of the specified message. If the starting offset is beyond
  12511. the end of the specified section of the message, an empty stream is returned. If
  12512. the number of bytes desired extends beyond the end of the section, a truncated
  12513. stream will be returned.</para>
  12514. <para>For more information about how to construct the <paramref name="section"/>,
  12515. see Section 6.4.5 of RFC3501.</para>
  12516. </remarks>
  12517. <returns>The stream.</returns>
  12518. <param name="index">The index of the message.</param>
  12519. <param name="section">The desired section of the message.</param>
  12520. <param name="offset">The starting offset of the first desired byte.</param>
  12521. <param name="count">The number of bytes desired.</param>
  12522. <param name="cancellationToken">The cancellation token.</param>
  12523. <param name="progress">The progress reporting mechanism.</param>
  12524. <exception cref="T:System.ArgumentNullException">
  12525. <paramref name="section"/> is <c>null</c>.
  12526. </exception>
  12527. <exception cref="T:System.ArgumentOutOfRangeException">
  12528. <para><paramref name="index"/> is out of range.</para>
  12529. <para>-or-</para>
  12530. <para><paramref name="offset"/> is negative.</para>
  12531. <para>-or-</para>
  12532. <para><paramref name="count"/> is negative.</para>
  12533. </exception>
  12534. <exception cref="T:System.ObjectDisposedException">
  12535. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  12536. </exception>
  12537. <exception cref="T:MailKit.ServiceNotConnectedException">
  12538. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  12539. </exception>
  12540. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  12541. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  12542. </exception>
  12543. <exception cref="T:MailKit.FolderNotOpenException">
  12544. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  12545. </exception>
  12546. <exception cref="T:MailKit.MessageNotFoundException">
  12547. The IMAP server did not return the requested message stream.
  12548. </exception>
  12549. <exception cref="T:System.OperationCanceledException">
  12550. The operation was canceled via the cancellation token.
  12551. </exception>
  12552. <exception cref="T:System.IO.IOException">
  12553. An I/O error occurred.
  12554. </exception>
  12555. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  12556. The server's response contained unexpected tokens.
  12557. </exception>
  12558. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  12559. The server replied with a NO or BAD response.
  12560. </exception>
  12561. </member>
  12562. <member name="M:MailKit.Net.Imap.ImapFolder.GetStreamAsync(System.Int32,System.String,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  12563. <summary>
  12564. Asynchronously gets a substream of the specified message.
  12565. </summary>
  12566. <remarks>
  12567. <para>Gets a substream of the specified message. If the starting offset is beyond
  12568. the end of the specified section of the message, an empty stream is returned. If
  12569. the number of bytes desired extends beyond the end of the section, a truncated
  12570. stream will be returned.</para>
  12571. <para>For more information about how to construct the <paramref name="section"/>,
  12572. see Section 6.4.5 of RFC3501.</para>
  12573. </remarks>
  12574. <returns>The stream.</returns>
  12575. <param name="index">The index of the message.</param>
  12576. <param name="section">The desired section of the message.</param>
  12577. <param name="offset">The starting offset of the first desired byte.</param>
  12578. <param name="count">The number of bytes desired.</param>
  12579. <param name="cancellationToken">The cancellation token.</param>
  12580. <param name="progress">The progress reporting mechanism.</param>
  12581. <exception cref="T:System.ArgumentNullException">
  12582. <paramref name="section"/> is <c>null</c>.
  12583. </exception>
  12584. <exception cref="T:System.ArgumentOutOfRangeException">
  12585. <para><paramref name="index"/> is out of range.</para>
  12586. <para>-or-</para>
  12587. <para><paramref name="offset"/> is negative.</para>
  12588. <para>-or-</para>
  12589. <para><paramref name="count"/> is negative.</para>
  12590. </exception>
  12591. <exception cref="T:System.ObjectDisposedException">
  12592. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  12593. </exception>
  12594. <exception cref="T:MailKit.ServiceNotConnectedException">
  12595. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  12596. </exception>
  12597. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  12598. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  12599. </exception>
  12600. <exception cref="T:MailKit.FolderNotOpenException">
  12601. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  12602. </exception>
  12603. <exception cref="T:MailKit.MessageNotFoundException">
  12604. The IMAP server did not return the requested message stream.
  12605. </exception>
  12606. <exception cref="T:System.OperationCanceledException">
  12607. The operation was canceled via the cancellation token.
  12608. </exception>
  12609. <exception cref="T:System.IO.IOException">
  12610. An I/O error occurred.
  12611. </exception>
  12612. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  12613. The server's response contained unexpected tokens.
  12614. </exception>
  12615. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  12616. The server replied with a NO or BAD response.
  12617. </exception>
  12618. </member>
  12619. <member name="M:MailKit.Net.Imap.ImapFolder.GetStreams(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Net.Imap.ImapFetchStreamCallback,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  12620. <summary>
  12621. Get the streams for the specified messages.
  12622. </summary>
  12623. <remarks>
  12624. <para>Gets the streams for the specified messages.</para>
  12625. </remarks>
  12626. <param name="uids">The uids of the messages.</param>
  12627. <param name="callback"></param>
  12628. <param name="cancellationToken">The cancellation token.</param>
  12629. <param name="progress">The progress reporting mechanism.</param>
  12630. <exception cref="T:System.ArgumentNullException">
  12631. <para><paramref name="uids"/> is <c>null</c>.</para>
  12632. <para>-or-</para>
  12633. <para><paramref name="callback"/> is <c>null</c>.</para>
  12634. </exception>
  12635. <exception cref="T:System.ArgumentException">
  12636. One or more of the <paramref name="uids"/> is invalid.
  12637. </exception>
  12638. <exception cref="T:System.ObjectDisposedException">
  12639. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  12640. </exception>
  12641. <exception cref="T:MailKit.ServiceNotConnectedException">
  12642. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  12643. </exception>
  12644. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  12645. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  12646. </exception>
  12647. <exception cref="T:MailKit.FolderNotOpenException">
  12648. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  12649. </exception>
  12650. <exception cref="T:System.OperationCanceledException">
  12651. The operation was canceled via the cancellation token.
  12652. </exception>
  12653. <exception cref="T:System.IO.IOException">
  12654. An I/O error occurred.
  12655. </exception>
  12656. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  12657. The server's response contained unexpected tokens.
  12658. </exception>
  12659. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  12660. The server replied with a NO or BAD response.
  12661. </exception>
  12662. </member>
  12663. <member name="M:MailKit.Net.Imap.ImapFolder.GetStreamsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Net.Imap.ImapFetchStreamAsyncCallback,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  12664. <summary>
  12665. Asynchronously get the streams for the specified messages.
  12666. </summary>
  12667. <remarks>
  12668. <para>Asynchronously gets the streams for the specified messages.</para>
  12669. </remarks>
  12670. <returns>An awaitable task.</returns>
  12671. <param name="uids">The uids of the messages.</param>
  12672. <param name="callback"></param>
  12673. <param name="cancellationToken">The cancellation token.</param>
  12674. <param name="progress">The progress reporting mechanism.</param>
  12675. <exception cref="T:System.ArgumentNullException">
  12676. <para><paramref name="uids"/> is <c>null</c>.</para>
  12677. <para>-or-</para>
  12678. <para><paramref name="callback"/> is <c>null</c>.</para>
  12679. </exception>
  12680. <exception cref="T:System.ArgumentException">
  12681. One or more of the <paramref name="uids"/> is invalid.
  12682. </exception>
  12683. <exception cref="T:System.ObjectDisposedException">
  12684. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  12685. </exception>
  12686. <exception cref="T:MailKit.ServiceNotConnectedException">
  12687. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  12688. </exception>
  12689. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  12690. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  12691. </exception>
  12692. <exception cref="T:MailKit.FolderNotOpenException">
  12693. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  12694. </exception>
  12695. <exception cref="T:System.OperationCanceledException">
  12696. The operation was canceled via the cancellation token.
  12697. </exception>
  12698. <exception cref="T:System.IO.IOException">
  12699. An I/O error occurred.
  12700. </exception>
  12701. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  12702. The server's response contained unexpected tokens.
  12703. </exception>
  12704. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  12705. The server replied with a NO or BAD response.
  12706. </exception>
  12707. </member>
  12708. <member name="M:MailKit.Net.Imap.ImapFolder.GetStreams(System.Collections.Generic.IList{System.Int32},MailKit.Net.Imap.ImapFetchStreamCallback,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  12709. <summary>
  12710. Get the streams for the specified messages.
  12711. </summary>
  12712. <remarks>
  12713. <para>Gets the streams for the specified messages.</para>
  12714. </remarks>
  12715. <param name="indexes">The indexes of the messages.</param>
  12716. <param name="callback"></param>
  12717. <param name="cancellationToken">The cancellation token.</param>
  12718. <param name="progress">The progress reporting mechanism.</param>
  12719. <exception cref="T:System.ArgumentNullException">
  12720. <para><paramref name="indexes"/> is <c>null</c>.</para>
  12721. <para>-or-</para>
  12722. <para><paramref name="callback"/> is <c>null</c>.</para>
  12723. </exception>
  12724. <exception cref="T:System.ArgumentException">
  12725. One or more of the <paramref name="indexes"/> is invalid.
  12726. </exception>
  12727. <exception cref="T:System.ObjectDisposedException">
  12728. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  12729. </exception>
  12730. <exception cref="T:MailKit.ServiceNotConnectedException">
  12731. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  12732. </exception>
  12733. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  12734. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  12735. </exception>
  12736. <exception cref="T:MailKit.FolderNotOpenException">
  12737. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  12738. </exception>
  12739. <exception cref="T:System.OperationCanceledException">
  12740. The operation was canceled via the cancellation token.
  12741. </exception>
  12742. <exception cref="T:System.IO.IOException">
  12743. An I/O error occurred.
  12744. </exception>
  12745. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  12746. The server's response contained unexpected tokens.
  12747. </exception>
  12748. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  12749. The server replied with a NO or BAD response.
  12750. </exception>
  12751. </member>
  12752. <member name="M:MailKit.Net.Imap.ImapFolder.GetStreamsAsync(System.Collections.Generic.IList{System.Int32},MailKit.Net.Imap.ImapFetchStreamAsyncCallback,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  12753. <summary>
  12754. Asynchronously get the streams for the specified messages.
  12755. </summary>
  12756. <remarks>
  12757. <para>Asynchronously gets the streams for the specified messages.</para>
  12758. </remarks>
  12759. <returns>An awaitable task.</returns>
  12760. <param name="indexes">The indexes of the messages.</param>
  12761. <param name="callback"></param>
  12762. <param name="cancellationToken">The cancellation token.</param>
  12763. <param name="progress">The progress reporting mechanism.</param>
  12764. <exception cref="T:System.ArgumentNullException">
  12765. <para><paramref name="indexes"/> is <c>null</c>.</para>
  12766. <para>-or-</para>
  12767. <para><paramref name="callback"/> is <c>null</c>.</para>
  12768. </exception>
  12769. <exception cref="T:System.ArgumentException">
  12770. One or more of the <paramref name="indexes"/> is invalid.
  12771. </exception>
  12772. <exception cref="T:System.ObjectDisposedException">
  12773. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  12774. </exception>
  12775. <exception cref="T:MailKit.ServiceNotConnectedException">
  12776. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  12777. </exception>
  12778. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  12779. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  12780. </exception>
  12781. <exception cref="T:MailKit.FolderNotOpenException">
  12782. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  12783. </exception>
  12784. <exception cref="T:System.OperationCanceledException">
  12785. The operation was canceled via the cancellation token.
  12786. </exception>
  12787. <exception cref="T:System.IO.IOException">
  12788. An I/O error occurred.
  12789. </exception>
  12790. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  12791. The server's response contained unexpected tokens.
  12792. </exception>
  12793. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  12794. The server replied with a NO or BAD response.
  12795. </exception>
  12796. </member>
  12797. <member name="M:MailKit.Net.Imap.ImapFolder.GetStreams(System.Int32,System.Int32,MailKit.Net.Imap.ImapFetchStreamCallback,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  12798. <summary>
  12799. Get the streams for the specified messages.
  12800. </summary>
  12801. <remarks>
  12802. <para>Gets the streams for the specified messages.</para>
  12803. </remarks>
  12804. <param name="min">The minimum index.</param>
  12805. <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
  12806. <param name="callback"></param>
  12807. <param name="cancellationToken">The cancellation token.</param>
  12808. <param name="progress">The progress reporting mechanism.</param>
  12809. <exception cref="T:System.ArgumentOutOfRangeException">
  12810. <para><paramref name="min"/> is out of range.</para>
  12811. <para>-or-</para>
  12812. <para><paramref name="max"/> is out of range.</para>
  12813. </exception>
  12814. <exception cref="T:System.ArgumentNullException">
  12815. <paramref name="callback"/> is <c>null</c>.
  12816. </exception>
  12817. <exception cref="T:System.ObjectDisposedException">
  12818. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  12819. </exception>
  12820. <exception cref="T:MailKit.ServiceNotConnectedException">
  12821. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  12822. </exception>
  12823. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  12824. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  12825. </exception>
  12826. <exception cref="T:MailKit.FolderNotOpenException">
  12827. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  12828. </exception>
  12829. <exception cref="T:System.OperationCanceledException">
  12830. The operation was canceled via the cancellation token.
  12831. </exception>
  12832. <exception cref="T:System.IO.IOException">
  12833. An I/O error occurred.
  12834. </exception>
  12835. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  12836. The server's response contained unexpected tokens.
  12837. </exception>
  12838. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  12839. The server replied with a NO or BAD response.
  12840. </exception>
  12841. </member>
  12842. <member name="M:MailKit.Net.Imap.ImapFolder.GetStreamsAsync(System.Int32,System.Int32,MailKit.Net.Imap.ImapFetchStreamAsyncCallback,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  12843. <summary>
  12844. Asynchronously get the streams for the specified messages.
  12845. </summary>
  12846. <remarks>
  12847. <para>Asynchronously gets the streams for the specified messages.</para>
  12848. </remarks>
  12849. <returns>An awaitable task.</returns>
  12850. <param name="min">The minimum index.</param>
  12851. <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
  12852. <param name="callback"></param>
  12853. <param name="cancellationToken">The cancellation token.</param>
  12854. <param name="progress">The progress reporting mechanism.</param>
  12855. <exception cref="T:System.ArgumentOutOfRangeException">
  12856. <para><paramref name="min"/> is out of range.</para>
  12857. <para>-or-</para>
  12858. <para><paramref name="max"/> is out of range.</para>
  12859. </exception>
  12860. <exception cref="T:System.ArgumentNullException">
  12861. <paramref name="callback"/> is <c>null</c>.
  12862. </exception>
  12863. <exception cref="T:System.ObjectDisposedException">
  12864. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  12865. </exception>
  12866. <exception cref="T:MailKit.ServiceNotConnectedException">
  12867. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  12868. </exception>
  12869. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  12870. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  12871. </exception>
  12872. <exception cref="T:MailKit.FolderNotOpenException">
  12873. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  12874. </exception>
  12875. <exception cref="T:System.OperationCanceledException">
  12876. The operation was canceled via the cancellation token.
  12877. </exception>
  12878. <exception cref="T:System.IO.IOException">
  12879. An I/O error occurred.
  12880. </exception>
  12881. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  12882. The server's response contained unexpected tokens.
  12883. </exception>
  12884. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  12885. The server replied with a NO or BAD response.
  12886. </exception>
  12887. </member>
  12888. <member name="M:MailKit.Net.Imap.ImapFolder.AddFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  12889. <summary>
  12890. Adds a set of flags to the specified messages.
  12891. </summary>
  12892. <remarks>
  12893. Adds a set of flags to the specified messages.
  12894. </remarks>
  12895. <param name="uids">The UIDs of the messages.</param>
  12896. <param name="flags">The message flags to add.</param>
  12897. <param name="keywords">A set of user-defined flags to add.</param>
  12898. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  12899. <param name="cancellationToken">The cancellation token.</param>
  12900. <exception cref="T:System.ArgumentNullException">
  12901. <paramref name="uids"/> is <c>null</c>.
  12902. </exception>
  12903. <exception cref="T:System.ArgumentException">
  12904. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  12905. <para>-or-</para>
  12906. <para>No flags were specified.</para>
  12907. </exception>
  12908. <exception cref="T:System.ObjectDisposedException">
  12909. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  12910. </exception>
  12911. <exception cref="T:MailKit.ServiceNotConnectedException">
  12912. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  12913. </exception>
  12914. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  12915. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  12916. </exception>
  12917. <exception cref="T:MailKit.FolderNotOpenException">
  12918. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  12919. </exception>
  12920. <exception cref="T:System.OperationCanceledException">
  12921. The operation was canceled via the cancellation token.
  12922. </exception>
  12923. <exception cref="T:System.IO.IOException">
  12924. An I/O error occurred.
  12925. </exception>
  12926. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  12927. The server's response contained unexpected tokens.
  12928. </exception>
  12929. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  12930. The server replied with a NO or BAD response.
  12931. </exception>
  12932. </member>
  12933. <member name="M:MailKit.Net.Imap.ImapFolder.AddFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  12934. <summary>
  12935. Asynchronously adds a set of flags to the specified messages.
  12936. </summary>
  12937. <remarks>
  12938. Adds a set of flags to the specified messages.
  12939. </remarks>
  12940. <returns>An asynchronous task context.</returns>
  12941. <param name="uids">The UIDs of the messages.</param>
  12942. <param name="flags">The message flags to add.</param>
  12943. <param name="keywords">A set of user-defined flags to add.</param>
  12944. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  12945. <param name="cancellationToken">The cancellation token.</param>
  12946. <exception cref="T:System.ArgumentNullException">
  12947. <paramref name="uids"/> is <c>null</c>.
  12948. </exception>
  12949. <exception cref="T:System.ArgumentException">
  12950. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  12951. <para>-or-</para>
  12952. <para>No flags were specified.</para>
  12953. </exception>
  12954. <exception cref="T:System.ObjectDisposedException">
  12955. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  12956. </exception>
  12957. <exception cref="T:MailKit.ServiceNotConnectedException">
  12958. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  12959. </exception>
  12960. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  12961. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  12962. </exception>
  12963. <exception cref="T:MailKit.FolderNotOpenException">
  12964. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  12965. </exception>
  12966. <exception cref="T:System.OperationCanceledException">
  12967. The operation was canceled via the cancellation token.
  12968. </exception>
  12969. <exception cref="T:System.IO.IOException">
  12970. An I/O error occurred.
  12971. </exception>
  12972. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  12973. The server's response contained unexpected tokens.
  12974. </exception>
  12975. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  12976. The server replied with a NO or BAD response.
  12977. </exception>
  12978. </member>
  12979. <member name="M:MailKit.Net.Imap.ImapFolder.RemoveFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  12980. <summary>
  12981. Removes a set of flags from the specified messages.
  12982. </summary>
  12983. <remarks>
  12984. Removes a set of flags from the specified messages.
  12985. </remarks>
  12986. <param name="uids">The UIDs of the messages.</param>
  12987. <param name="flags">The message flags to remove.</param>
  12988. <param name="keywords">A set of user-defined flags to remove.</param>
  12989. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  12990. <param name="cancellationToken">The cancellation token.</param>
  12991. <exception cref="T:System.ArgumentNullException">
  12992. <paramref name="uids"/> is <c>null</c>.
  12993. </exception>
  12994. <exception cref="T:System.ArgumentException">
  12995. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  12996. <para>-or-</para>
  12997. <para>No flags were specified.</para>
  12998. </exception>
  12999. <exception cref="T:System.ObjectDisposedException">
  13000. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  13001. </exception>
  13002. <exception cref="T:MailKit.ServiceNotConnectedException">
  13003. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  13004. </exception>
  13005. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  13006. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  13007. </exception>
  13008. <exception cref="T:MailKit.FolderNotOpenException">
  13009. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  13010. </exception>
  13011. <exception cref="T:System.OperationCanceledException">
  13012. The operation was canceled via the cancellation token.
  13013. </exception>
  13014. <exception cref="T:System.IO.IOException">
  13015. An I/O error occurred.
  13016. </exception>
  13017. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  13018. The server's response contained unexpected tokens.
  13019. </exception>
  13020. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  13021. The server replied with a NO or BAD response.
  13022. </exception>
  13023. </member>
  13024. <member name="M:MailKit.Net.Imap.ImapFolder.RemoveFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  13025. <summary>
  13026. Asynchronously removes a set of flags from the specified messages.
  13027. </summary>
  13028. <remarks>
  13029. Removes a set of flags from the specified messages.
  13030. </remarks>
  13031. <returns>An asynchronous task context.</returns>
  13032. <param name="uids">The UIDs of the messages.</param>
  13033. <param name="flags">The message flags to remove.</param>
  13034. <param name="keywords">A set of user-defined flags to remove.</param>
  13035. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  13036. <param name="cancellationToken">The cancellation token.</param>
  13037. <exception cref="T:System.ArgumentNullException">
  13038. <paramref name="uids"/> is <c>null</c>.
  13039. </exception>
  13040. <exception cref="T:System.ArgumentException">
  13041. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  13042. <para>-or-</para>
  13043. <para>No flags were specified.</para>
  13044. </exception>
  13045. <exception cref="T:System.ObjectDisposedException">
  13046. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  13047. </exception>
  13048. <exception cref="T:MailKit.ServiceNotConnectedException">
  13049. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  13050. </exception>
  13051. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  13052. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  13053. </exception>
  13054. <exception cref="T:MailKit.FolderNotOpenException">
  13055. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  13056. </exception>
  13057. <exception cref="T:System.OperationCanceledException">
  13058. The operation was canceled via the cancellation token.
  13059. </exception>
  13060. <exception cref="T:System.IO.IOException">
  13061. An I/O error occurred.
  13062. </exception>
  13063. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  13064. The server's response contained unexpected tokens.
  13065. </exception>
  13066. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  13067. The server replied with a NO or BAD response.
  13068. </exception>
  13069. </member>
  13070. <member name="M:MailKit.Net.Imap.ImapFolder.SetFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  13071. <summary>
  13072. Sets the flags of the specified messages.
  13073. </summary>
  13074. <remarks>
  13075. Sets the flags of the specified messages.
  13076. </remarks>
  13077. <param name="uids">The UIDs of the messages.</param>
  13078. <param name="flags">The message flags to set.</param>
  13079. <param name="keywords">A set of user-defined flags to set.</param>
  13080. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  13081. <param name="cancellationToken">The cancellation token.</param>
  13082. <exception cref="T:System.ArgumentNullException">
  13083. <paramref name="uids"/> is <c>null</c>.
  13084. </exception>
  13085. <exception cref="T:System.ArgumentException">
  13086. One or more of the <paramref name="uids"/> is invalid.
  13087. </exception>
  13088. <exception cref="T:System.ObjectDisposedException">
  13089. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  13090. </exception>
  13091. <exception cref="T:MailKit.ServiceNotConnectedException">
  13092. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  13093. </exception>
  13094. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  13095. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  13096. </exception>
  13097. <exception cref="T:MailKit.FolderNotOpenException">
  13098. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  13099. </exception>
  13100. <exception cref="T:System.OperationCanceledException">
  13101. The operation was canceled via the cancellation token.
  13102. </exception>
  13103. <exception cref="T:System.IO.IOException">
  13104. An I/O error occurred.
  13105. </exception>
  13106. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  13107. The server's response contained unexpected tokens.
  13108. </exception>
  13109. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  13110. The server replied with a NO or BAD response.
  13111. </exception>
  13112. </member>
  13113. <member name="M:MailKit.Net.Imap.ImapFolder.SetFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  13114. <summary>
  13115. Asynchronously sets the flags of the specified messages.
  13116. </summary>
  13117. <remarks>
  13118. Sets the flags of the specified messages.
  13119. </remarks>
  13120. <returns>An asynchronous task context.</returns>
  13121. <param name="uids">The UIDs of the messages.</param>
  13122. <param name="flags">The message flags to set.</param>
  13123. <param name="keywords">A set of user-defined flags to set.</param>
  13124. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  13125. <param name="cancellationToken">The cancellation token.</param>
  13126. <exception cref="T:System.ArgumentNullException">
  13127. <paramref name="uids"/> is <c>null</c>.
  13128. </exception>
  13129. <exception cref="T:System.ArgumentException">
  13130. One or more of the <paramref name="uids"/> is invalid.
  13131. </exception>
  13132. <exception cref="T:System.ObjectDisposedException">
  13133. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  13134. </exception>
  13135. <exception cref="T:MailKit.ServiceNotConnectedException">
  13136. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  13137. </exception>
  13138. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  13139. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  13140. </exception>
  13141. <exception cref="T:MailKit.FolderNotOpenException">
  13142. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  13143. </exception>
  13144. <exception cref="T:System.OperationCanceledException">
  13145. The operation was canceled via the cancellation token.
  13146. </exception>
  13147. <exception cref="T:System.IO.IOException">
  13148. An I/O error occurred.
  13149. </exception>
  13150. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  13151. The server's response contained unexpected tokens.
  13152. </exception>
  13153. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  13154. The server replied with a NO or BAD response.
  13155. </exception>
  13156. </member>
  13157. <member name="M:MailKit.Net.Imap.ImapFolder.AddFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  13158. <summary>
  13159. Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
  13160. </summary>
  13161. <remarks>
  13162. Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
  13163. </remarks>
  13164. <returns>The unique IDs of the messages that were not updated.</returns>
  13165. <param name="uids">The UIDs of the messages.</param>
  13166. <param name="modseq">The mod-sequence value.</param>
  13167. <param name="flags">The message flags to add.</param>
  13168. <param name="keywords">A set of user-defined flags to add.</param>
  13169. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  13170. <param name="cancellationToken">The cancellation token.</param>
  13171. <exception cref="T:System.ArgumentNullException">
  13172. <paramref name="uids"/> is <c>null</c>.
  13173. </exception>
  13174. <exception cref="T:System.ArgumentException">
  13175. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  13176. <para>-or-</para>
  13177. <para>No flags were specified.</para>
  13178. </exception>
  13179. <exception cref="T:System.ObjectDisposedException">
  13180. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  13181. </exception>
  13182. <exception cref="T:MailKit.ServiceNotConnectedException">
  13183. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  13184. </exception>
  13185. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  13186. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  13187. </exception>
  13188. <exception cref="T:MailKit.FolderNotOpenException">
  13189. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  13190. </exception>
  13191. <exception cref="T:System.NotSupportedException">
  13192. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
  13193. </exception>
  13194. <exception cref="T:System.OperationCanceledException">
  13195. The operation was canceled via the cancellation token.
  13196. </exception>
  13197. <exception cref="T:System.IO.IOException">
  13198. An I/O error occurred.
  13199. </exception>
  13200. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  13201. The server's response contained unexpected tokens.
  13202. </exception>
  13203. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  13204. The server replied with a NO or BAD response.
  13205. </exception>
  13206. </member>
  13207. <member name="M:MailKit.Net.Imap.ImapFolder.AddFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  13208. <summary>
  13209. Asynchronously adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
  13210. </summary>
  13211. <remarks>
  13212. Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
  13213. </remarks>
  13214. <returns>The unique IDs of the messages that were not updated.</returns>
  13215. <param name="uids">The UIDs of the messages.</param>
  13216. <param name="modseq">The mod-sequence value.</param>
  13217. <param name="flags">The message flags to add.</param>
  13218. <param name="keywords">A set of user-defined flags to add.</param>
  13219. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  13220. <param name="cancellationToken">The cancellation token.</param>
  13221. <exception cref="T:System.ArgumentNullException">
  13222. <paramref name="uids"/> is <c>null</c>.
  13223. </exception>
  13224. <exception cref="T:System.ArgumentException">
  13225. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  13226. <para>-or-</para>
  13227. <para>No flags were specified.</para>
  13228. </exception>
  13229. <exception cref="T:System.ObjectDisposedException">
  13230. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  13231. </exception>
  13232. <exception cref="T:MailKit.ServiceNotConnectedException">
  13233. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  13234. </exception>
  13235. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  13236. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  13237. </exception>
  13238. <exception cref="T:MailKit.FolderNotOpenException">
  13239. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  13240. </exception>
  13241. <exception cref="T:System.NotSupportedException">
  13242. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
  13243. </exception>
  13244. <exception cref="T:System.OperationCanceledException">
  13245. The operation was canceled via the cancellation token.
  13246. </exception>
  13247. <exception cref="T:System.IO.IOException">
  13248. An I/O error occurred.
  13249. </exception>
  13250. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  13251. The server's response contained unexpected tokens.
  13252. </exception>
  13253. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  13254. The server replied with a NO or BAD response.
  13255. </exception>
  13256. </member>
  13257. <member name="M:MailKit.Net.Imap.ImapFolder.RemoveFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  13258. <summary>
  13259. Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
  13260. </summary>
  13261. <remarks>
  13262. Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
  13263. </remarks>
  13264. <returns>The unique IDs of the messages that were not updated.</returns>
  13265. <param name="uids">The UIDs of the messages.</param>
  13266. <param name="modseq">The mod-sequence value.</param>
  13267. <param name="flags">The message flags to remove.</param>
  13268. <param name="keywords">A set of user-defined flags to remove.</param>
  13269. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  13270. <param name="cancellationToken">The cancellation token.</param>
  13271. <exception cref="T:System.ArgumentNullException">
  13272. <paramref name="uids"/> is <c>null</c>.
  13273. </exception>
  13274. <exception cref="T:System.ArgumentException">
  13275. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  13276. <para>-or-</para>
  13277. <para>No flags were specified.</para>
  13278. </exception>
  13279. <exception cref="T:System.ObjectDisposedException">
  13280. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  13281. </exception>
  13282. <exception cref="T:MailKit.ServiceNotConnectedException">
  13283. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  13284. </exception>
  13285. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  13286. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  13287. </exception>
  13288. <exception cref="T:MailKit.FolderNotOpenException">
  13289. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  13290. </exception>
  13291. <exception cref="T:System.NotSupportedException">
  13292. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
  13293. </exception>
  13294. <exception cref="T:System.OperationCanceledException">
  13295. The operation was canceled via the cancellation token.
  13296. </exception>
  13297. <exception cref="T:System.IO.IOException">
  13298. An I/O error occurred.
  13299. </exception>
  13300. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  13301. The server's response contained unexpected tokens.
  13302. </exception>
  13303. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  13304. The server replied with a NO or BAD response.
  13305. </exception>
  13306. </member>
  13307. <member name="M:MailKit.Net.Imap.ImapFolder.RemoveFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  13308. <summary>
  13309. Asynchronously removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
  13310. </summary>
  13311. <remarks>
  13312. Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
  13313. </remarks>
  13314. <returns>The unique IDs of the messages that were not updated.</returns>
  13315. <param name="uids">The UIDs of the messages.</param>
  13316. <param name="modseq">The mod-sequence value.</param>
  13317. <param name="flags">The message flags to remove.</param>
  13318. <param name="keywords">A set of user-defined flags to remove.</param>
  13319. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  13320. <param name="cancellationToken">The cancellation token.</param>
  13321. <exception cref="T:System.ArgumentNullException">
  13322. <paramref name="uids"/> is <c>null</c>.
  13323. </exception>
  13324. <exception cref="T:System.ArgumentException">
  13325. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  13326. <para>-or-</para>
  13327. <para>No flags were specified.</para>
  13328. </exception>
  13329. <exception cref="T:System.ObjectDisposedException">
  13330. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  13331. </exception>
  13332. <exception cref="T:MailKit.ServiceNotConnectedException">
  13333. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  13334. </exception>
  13335. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  13336. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  13337. </exception>
  13338. <exception cref="T:MailKit.FolderNotOpenException">
  13339. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  13340. </exception>
  13341. <exception cref="T:System.NotSupportedException">
  13342. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
  13343. </exception>
  13344. <exception cref="T:System.OperationCanceledException">
  13345. The operation was canceled via the cancellation token.
  13346. </exception>
  13347. <exception cref="T:System.IO.IOException">
  13348. An I/O error occurred.
  13349. </exception>
  13350. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  13351. The server's response contained unexpected tokens.
  13352. </exception>
  13353. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  13354. The server replied with a NO or BAD response.
  13355. </exception>
  13356. </member>
  13357. <member name="M:MailKit.Net.Imap.ImapFolder.SetFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  13358. <summary>
  13359. Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
  13360. </summary>
  13361. <remarks>
  13362. Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
  13363. </remarks>
  13364. <returns>The unique IDs of the messages that were not updated.</returns>
  13365. <param name="uids">The UIDs of the messages.</param>
  13366. <param name="modseq">The mod-sequence value.</param>
  13367. <param name="flags">The message flags to set.</param>
  13368. <param name="keywords">A set of user-defined flags to set.</param>
  13369. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  13370. <param name="cancellationToken">The cancellation token.</param>
  13371. <exception cref="T:System.ArgumentNullException">
  13372. <paramref name="uids"/> is <c>null</c>.
  13373. </exception>
  13374. <exception cref="T:System.ArgumentException">
  13375. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  13376. </exception>
  13377. <exception cref="T:System.ObjectDisposedException">
  13378. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  13379. </exception>
  13380. <exception cref="T:MailKit.ServiceNotConnectedException">
  13381. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  13382. </exception>
  13383. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  13384. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  13385. </exception>
  13386. <exception cref="T:MailKit.FolderNotOpenException">
  13387. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  13388. </exception>
  13389. <exception cref="T:System.NotSupportedException">
  13390. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
  13391. </exception>
  13392. <exception cref="T:System.OperationCanceledException">
  13393. The operation was canceled via the cancellation token.
  13394. </exception>
  13395. <exception cref="T:System.IO.IOException">
  13396. An I/O error occurred.
  13397. </exception>
  13398. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  13399. The server's response contained unexpected tokens.
  13400. </exception>
  13401. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  13402. The server replied with a NO or BAD response.
  13403. </exception>
  13404. </member>
  13405. <member name="M:MailKit.Net.Imap.ImapFolder.SetFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  13406. <summary>
  13407. Asynchronously sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
  13408. </summary>
  13409. <remarks>
  13410. Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
  13411. </remarks>
  13412. <returns>The unique IDs of the messages that were not updated.</returns>
  13413. <param name="uids">The UIDs of the messages.</param>
  13414. <param name="modseq">The mod-sequence value.</param>
  13415. <param name="flags">The message flags to set.</param>
  13416. <param name="keywords">A set of user-defined flags to set.</param>
  13417. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  13418. <param name="cancellationToken">The cancellation token.</param>
  13419. <exception cref="T:System.ArgumentNullException">
  13420. <paramref name="uids"/> is <c>null</c>.
  13421. </exception>
  13422. <exception cref="T:System.ArgumentException">
  13423. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  13424. </exception>
  13425. <exception cref="T:System.ObjectDisposedException">
  13426. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  13427. </exception>
  13428. <exception cref="T:MailKit.ServiceNotConnectedException">
  13429. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  13430. </exception>
  13431. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  13432. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  13433. </exception>
  13434. <exception cref="T:MailKit.FolderNotOpenException">
  13435. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  13436. </exception>
  13437. <exception cref="T:System.NotSupportedException">
  13438. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
  13439. </exception>
  13440. <exception cref="T:System.OperationCanceledException">
  13441. The operation was canceled via the cancellation token.
  13442. </exception>
  13443. <exception cref="T:System.IO.IOException">
  13444. An I/O error occurred.
  13445. </exception>
  13446. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  13447. The server's response contained unexpected tokens.
  13448. </exception>
  13449. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  13450. The server replied with a NO or BAD response.
  13451. </exception>
  13452. </member>
  13453. <member name="M:MailKit.Net.Imap.ImapFolder.AddFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  13454. <summary>
  13455. Adds a set of flags to the specified messages.
  13456. </summary>
  13457. <remarks>
  13458. Adds a set of flags to the specified messages.
  13459. </remarks>
  13460. <param name="indexes">The indexes of the messages.</param>
  13461. <param name="flags">The message flags to add.</param>
  13462. <param name="keywords">A set of user-defined flags to add.</param>
  13463. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  13464. <param name="cancellationToken">The cancellation token.</param>
  13465. <exception cref="T:System.ArgumentNullException">
  13466. <paramref name="indexes"/> is <c>null</c>.
  13467. </exception>
  13468. <exception cref="T:System.ArgumentException">
  13469. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  13470. <para>-or-</para>
  13471. <para>No flags were specified.</para>
  13472. </exception>
  13473. <exception cref="T:System.ObjectDisposedException">
  13474. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  13475. </exception>
  13476. <exception cref="T:MailKit.ServiceNotConnectedException">
  13477. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  13478. </exception>
  13479. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  13480. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  13481. </exception>
  13482. <exception cref="T:MailKit.FolderNotOpenException">
  13483. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  13484. </exception>
  13485. <exception cref="T:System.OperationCanceledException">
  13486. The operation was canceled via the cancellation token.
  13487. </exception>
  13488. <exception cref="T:System.IO.IOException">
  13489. An I/O error occurred.
  13490. </exception>
  13491. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  13492. The server's response contained unexpected tokens.
  13493. </exception>
  13494. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  13495. The server replied with a NO or BAD response.
  13496. </exception>
  13497. </member>
  13498. <member name="M:MailKit.Net.Imap.ImapFolder.AddFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  13499. <summary>
  13500. Asynchronously adds a set of flags to the specified messages.
  13501. </summary>
  13502. <remarks>
  13503. Adds a set of flags to the specified messages.
  13504. </remarks>
  13505. <returns>An asynchronous task context.</returns>
  13506. <param name="indexes">The indexes of the messages.</param>
  13507. <param name="flags">The message flags to add.</param>
  13508. <param name="keywords">A set of user-defined flags to add.</param>
  13509. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  13510. <param name="cancellationToken">The cancellation token.</param>
  13511. <exception cref="T:System.ArgumentNullException">
  13512. <paramref name="indexes"/> is <c>null</c>.
  13513. </exception>
  13514. <exception cref="T:System.ArgumentException">
  13515. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  13516. <para>-or-</para>
  13517. <para>No flags were specified.</para>
  13518. </exception>
  13519. <exception cref="T:System.ObjectDisposedException">
  13520. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  13521. </exception>
  13522. <exception cref="T:MailKit.ServiceNotConnectedException">
  13523. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  13524. </exception>
  13525. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  13526. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  13527. </exception>
  13528. <exception cref="T:MailKit.FolderNotOpenException">
  13529. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  13530. </exception>
  13531. <exception cref="T:System.OperationCanceledException">
  13532. The operation was canceled via the cancellation token.
  13533. </exception>
  13534. <exception cref="T:System.IO.IOException">
  13535. An I/O error occurred.
  13536. </exception>
  13537. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  13538. The server's response contained unexpected tokens.
  13539. </exception>
  13540. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  13541. The server replied with a NO or BAD response.
  13542. </exception>
  13543. </member>
  13544. <member name="M:MailKit.Net.Imap.ImapFolder.RemoveFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  13545. <summary>
  13546. Removes a set of flags from the specified messages.
  13547. </summary>
  13548. <remarks>
  13549. Removes a set of flags from the specified messages.
  13550. </remarks>
  13551. <param name="indexes">The indexes of the messages.</param>
  13552. <param name="flags">The message flags to remove.</param>
  13553. <param name="keywords">A set of user-defined flags to remove.</param>
  13554. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  13555. <param name="cancellationToken">The cancellation token.</param>
  13556. <exception cref="T:System.ArgumentNullException">
  13557. <paramref name="indexes"/> is <c>null</c>.
  13558. </exception>
  13559. <exception cref="T:System.ArgumentException">
  13560. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  13561. <para>-or-</para>
  13562. <para>No flags were specified.</para>
  13563. </exception>
  13564. <exception cref="T:System.ObjectDisposedException">
  13565. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  13566. </exception>
  13567. <exception cref="T:MailKit.ServiceNotConnectedException">
  13568. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  13569. </exception>
  13570. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  13571. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  13572. </exception>
  13573. <exception cref="T:MailKit.FolderNotOpenException">
  13574. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  13575. </exception>
  13576. <exception cref="T:System.OperationCanceledException">
  13577. The operation was canceled via the cancellation token.
  13578. </exception>
  13579. <exception cref="T:System.IO.IOException">
  13580. An I/O error occurred.
  13581. </exception>
  13582. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  13583. The server's response contained unexpected tokens.
  13584. </exception>
  13585. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  13586. The server replied with a NO or BAD response.
  13587. </exception>
  13588. </member>
  13589. <member name="M:MailKit.Net.Imap.ImapFolder.RemoveFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  13590. <summary>
  13591. Asynchronously removes a set of flags from the specified messages.
  13592. </summary>
  13593. <remarks>
  13594. Removes a set of flags from the specified messages.
  13595. </remarks>
  13596. <returns>An asynchronous task context.</returns>
  13597. <param name="indexes">The indexes of the messages.</param>
  13598. <param name="flags">The message flags to remove.</param>
  13599. <param name="keywords">A set of user-defined flags to remove.</param>
  13600. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  13601. <param name="cancellationToken">The cancellation token.</param>
  13602. <exception cref="T:System.ArgumentNullException">
  13603. <paramref name="indexes"/> is <c>null</c>.
  13604. </exception>
  13605. <exception cref="T:System.ArgumentException">
  13606. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  13607. <para>-or-</para>
  13608. <para>No flags were specified.</para>
  13609. </exception>
  13610. <exception cref="T:System.ObjectDisposedException">
  13611. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  13612. </exception>
  13613. <exception cref="T:MailKit.ServiceNotConnectedException">
  13614. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  13615. </exception>
  13616. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  13617. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  13618. </exception>
  13619. <exception cref="T:MailKit.FolderNotOpenException">
  13620. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  13621. </exception>
  13622. <exception cref="T:System.OperationCanceledException">
  13623. The operation was canceled via the cancellation token.
  13624. </exception>
  13625. <exception cref="T:System.IO.IOException">
  13626. An I/O error occurred.
  13627. </exception>
  13628. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  13629. The server's response contained unexpected tokens.
  13630. </exception>
  13631. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  13632. The server replied with a NO or BAD response.
  13633. </exception>
  13634. </member>
  13635. <member name="M:MailKit.Net.Imap.ImapFolder.SetFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  13636. <summary>
  13637. Sets the flags of the specified messages.
  13638. </summary>
  13639. <remarks>
  13640. Sets the flags of the specified messages.
  13641. </remarks>
  13642. <param name="indexes">The indexes of the messages.</param>
  13643. <param name="flags">The message flags to set.</param>
  13644. <param name="keywords">A set of user-defined flags to set.</param>
  13645. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  13646. <param name="cancellationToken">The cancellation token.</param>
  13647. <exception cref="T:System.ArgumentNullException">
  13648. <paramref name="indexes"/> is <c>null</c>.
  13649. </exception>
  13650. <exception cref="T:System.ArgumentException">
  13651. One or more of the <paramref name="indexes"/> is invalid.
  13652. </exception>
  13653. <exception cref="T:System.ObjectDisposedException">
  13654. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  13655. </exception>
  13656. <exception cref="T:MailKit.ServiceNotConnectedException">
  13657. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  13658. </exception>
  13659. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  13660. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  13661. </exception>
  13662. <exception cref="T:MailKit.FolderNotOpenException">
  13663. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  13664. </exception>
  13665. <exception cref="T:System.OperationCanceledException">
  13666. The operation was canceled via the cancellation token.
  13667. </exception>
  13668. <exception cref="T:System.IO.IOException">
  13669. An I/O error occurred.
  13670. </exception>
  13671. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  13672. The server's response contained unexpected tokens.
  13673. </exception>
  13674. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  13675. The server replied with a NO or BAD response.
  13676. </exception>
  13677. </member>
  13678. <member name="M:MailKit.Net.Imap.ImapFolder.SetFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  13679. <summary>
  13680. Asynchronously sets the flags of the specified messages.
  13681. </summary>
  13682. <remarks>
  13683. Sets the flags of the specified messages.
  13684. </remarks>
  13685. <returns>An asynchronous task context.</returns>
  13686. <param name="indexes">The indexes of the messages.</param>
  13687. <param name="flags">The message flags to set.</param>
  13688. <param name="keywords">A set of user-defined flags to set.</param>
  13689. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  13690. <param name="cancellationToken">The cancellation token.</param>
  13691. <exception cref="T:System.ArgumentNullException">
  13692. <paramref name="indexes"/> is <c>null</c>.
  13693. </exception>
  13694. <exception cref="T:System.ArgumentException">
  13695. One or more of the <paramref name="indexes"/> is invalid.
  13696. </exception>
  13697. <exception cref="T:System.ObjectDisposedException">
  13698. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  13699. </exception>
  13700. <exception cref="T:MailKit.ServiceNotConnectedException">
  13701. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  13702. </exception>
  13703. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  13704. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  13705. </exception>
  13706. <exception cref="T:MailKit.FolderNotOpenException">
  13707. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  13708. </exception>
  13709. <exception cref="T:System.OperationCanceledException">
  13710. The operation was canceled via the cancellation token.
  13711. </exception>
  13712. <exception cref="T:System.IO.IOException">
  13713. An I/O error occurred.
  13714. </exception>
  13715. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  13716. The server's response contained unexpected tokens.
  13717. </exception>
  13718. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  13719. The server replied with a NO or BAD response.
  13720. </exception>
  13721. </member>
  13722. <member name="M:MailKit.Net.Imap.ImapFolder.AddFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  13723. <summary>
  13724. Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
  13725. </summary>
  13726. <remarks>
  13727. Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
  13728. </remarks>
  13729. <returns>The indexes of the messages that were not updated.</returns>
  13730. <param name="indexes">The indexes of the messages.</param>
  13731. <param name="modseq">The mod-sequence value.</param>
  13732. <param name="flags">The message flags to add.</param>
  13733. <param name="keywords">A set of user-defined flags to add.</param>
  13734. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  13735. <param name="cancellationToken">The cancellation token.</param>
  13736. <exception cref="T:System.ArgumentNullException">
  13737. <paramref name="indexes"/> is <c>null</c>.
  13738. </exception>
  13739. <exception cref="T:System.ArgumentException">
  13740. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  13741. <para>-or-</para>
  13742. <para>No flags were specified.</para>
  13743. </exception>
  13744. <exception cref="T:System.ObjectDisposedException">
  13745. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  13746. </exception>
  13747. <exception cref="T:MailKit.ServiceNotConnectedException">
  13748. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  13749. </exception>
  13750. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  13751. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  13752. </exception>
  13753. <exception cref="T:MailKit.FolderNotOpenException">
  13754. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  13755. </exception>
  13756. <exception cref="T:System.NotSupportedException">
  13757. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
  13758. </exception>
  13759. <exception cref="T:System.OperationCanceledException">
  13760. The operation was canceled via the cancellation token.
  13761. </exception>
  13762. <exception cref="T:System.IO.IOException">
  13763. An I/O error occurred.
  13764. </exception>
  13765. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  13766. The server's response contained unexpected tokens.
  13767. </exception>
  13768. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  13769. The server replied with a NO or BAD response.
  13770. </exception>
  13771. </member>
  13772. <member name="M:MailKit.Net.Imap.ImapFolder.AddFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  13773. <summary>
  13774. Asynchronously adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
  13775. </summary>
  13776. <remarks>
  13777. Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
  13778. </remarks>
  13779. <returns>The indexes of the messages that were not updated.</returns>
  13780. <param name="indexes">The indexes of the messages.</param>
  13781. <param name="modseq">The mod-sequence value.</param>
  13782. <param name="flags">The message flags to add.</param>
  13783. <param name="keywords">A set of user-defined flags to add.</param>
  13784. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  13785. <param name="cancellationToken">The cancellation token.</param>
  13786. <exception cref="T:System.ArgumentNullException">
  13787. <paramref name="indexes"/> is <c>null</c>.
  13788. </exception>
  13789. <exception cref="T:System.ArgumentException">
  13790. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  13791. <para>-or-</para>
  13792. <para>No flags were specified.</para>
  13793. </exception>
  13794. <exception cref="T:System.ObjectDisposedException">
  13795. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  13796. </exception>
  13797. <exception cref="T:MailKit.ServiceNotConnectedException">
  13798. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  13799. </exception>
  13800. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  13801. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  13802. </exception>
  13803. <exception cref="T:MailKit.FolderNotOpenException">
  13804. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  13805. </exception>
  13806. <exception cref="T:System.NotSupportedException">
  13807. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
  13808. </exception>
  13809. <exception cref="T:System.OperationCanceledException">
  13810. The operation was canceled via the cancellation token.
  13811. </exception>
  13812. <exception cref="T:System.IO.IOException">
  13813. An I/O error occurred.
  13814. </exception>
  13815. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  13816. The server's response contained unexpected tokens.
  13817. </exception>
  13818. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  13819. The server replied with a NO or BAD response.
  13820. </exception>
  13821. </member>
  13822. <member name="M:MailKit.Net.Imap.ImapFolder.RemoveFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  13823. <summary>
  13824. Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
  13825. </summary>
  13826. <remarks>
  13827. Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
  13828. </remarks>
  13829. <returns>The indexes of the messages that were not updated.</returns>
  13830. <param name="indexes">The indexes of the messages.</param>
  13831. <param name="modseq">The mod-sequence value.</param>
  13832. <param name="flags">The message flags to remove.</param>
  13833. <param name="keywords">A set of user-defined flags to remove.</param>
  13834. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  13835. <param name="cancellationToken">The cancellation token.</param>
  13836. <exception cref="T:System.ArgumentNullException">
  13837. <paramref name="indexes"/> is <c>null</c>.
  13838. </exception>
  13839. <exception cref="T:System.ArgumentException">
  13840. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  13841. <para>-or-</para>
  13842. <para>No flags were specified.</para>
  13843. </exception>
  13844. <exception cref="T:System.ObjectDisposedException">
  13845. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  13846. </exception>
  13847. <exception cref="T:MailKit.ServiceNotConnectedException">
  13848. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  13849. </exception>
  13850. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  13851. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  13852. </exception>
  13853. <exception cref="T:MailKit.FolderNotOpenException">
  13854. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  13855. </exception>
  13856. <exception cref="T:System.NotSupportedException">
  13857. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
  13858. </exception>
  13859. <exception cref="T:System.OperationCanceledException">
  13860. The operation was canceled via the cancellation token.
  13861. </exception>
  13862. <exception cref="T:System.IO.IOException">
  13863. An I/O error occurred.
  13864. </exception>
  13865. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  13866. The server's response contained unexpected tokens.
  13867. </exception>
  13868. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  13869. The server replied with a NO or BAD response.
  13870. </exception>
  13871. </member>
  13872. <member name="M:MailKit.Net.Imap.ImapFolder.RemoveFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  13873. <summary>
  13874. Asynchronously removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
  13875. </summary>
  13876. <remarks>
  13877. Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
  13878. </remarks>
  13879. <returns>The indexes of the messages that were not updated.</returns>
  13880. <param name="indexes">The indexes of the messages.</param>
  13881. <param name="modseq">The mod-sequence value.</param>
  13882. <param name="flags">The message flags to remove.</param>
  13883. <param name="keywords">A set of user-defined flags to remove.</param>
  13884. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  13885. <param name="cancellationToken">The cancellation token.</param>
  13886. <exception cref="T:System.ArgumentNullException">
  13887. <paramref name="indexes"/> is <c>null</c>.
  13888. </exception>
  13889. <exception cref="T:System.ArgumentException">
  13890. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  13891. <para>-or-</para>
  13892. <para>No flags were specified.</para>
  13893. </exception>
  13894. <exception cref="T:System.ObjectDisposedException">
  13895. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  13896. </exception>
  13897. <exception cref="T:MailKit.ServiceNotConnectedException">
  13898. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  13899. </exception>
  13900. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  13901. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  13902. </exception>
  13903. <exception cref="T:MailKit.FolderNotOpenException">
  13904. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  13905. </exception>
  13906. <exception cref="T:System.NotSupportedException">
  13907. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
  13908. </exception>
  13909. <exception cref="T:System.OperationCanceledException">
  13910. The operation was canceled via the cancellation token.
  13911. </exception>
  13912. <exception cref="T:System.IO.IOException">
  13913. An I/O error occurred.
  13914. </exception>
  13915. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  13916. The server's response contained unexpected tokens.
  13917. </exception>
  13918. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  13919. The server replied with a NO or BAD response.
  13920. </exception>
  13921. </member>
  13922. <member name="M:MailKit.Net.Imap.ImapFolder.SetFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  13923. <summary>
  13924. Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
  13925. </summary>
  13926. <remarks>
  13927. Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
  13928. </remarks>
  13929. <returns>The indexes of the messages that were not updated.</returns>
  13930. <param name="indexes">The indexes of the messages.</param>
  13931. <param name="modseq">The mod-sequence value.</param>
  13932. <param name="flags">The message flags to set.</param>
  13933. <param name="keywords">A set of user-defined flags to set.</param>
  13934. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  13935. <param name="cancellationToken">The cancellation token.</param>
  13936. <exception cref="T:System.ArgumentNullException">
  13937. <paramref name="indexes"/> is <c>null</c>.
  13938. </exception>
  13939. <exception cref="T:System.ArgumentException">
  13940. One or more of the <paramref name="indexes"/> is invalid.
  13941. </exception>
  13942. <exception cref="T:System.ObjectDisposedException">
  13943. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  13944. </exception>
  13945. <exception cref="T:MailKit.ServiceNotConnectedException">
  13946. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  13947. </exception>
  13948. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  13949. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  13950. </exception>
  13951. <exception cref="T:MailKit.FolderNotOpenException">
  13952. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  13953. </exception>
  13954. <exception cref="T:System.NotSupportedException">
  13955. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
  13956. </exception>
  13957. <exception cref="T:System.OperationCanceledException">
  13958. The operation was canceled via the cancellation token.
  13959. </exception>
  13960. <exception cref="T:System.IO.IOException">
  13961. An I/O error occurred.
  13962. </exception>
  13963. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  13964. The server's response contained unexpected tokens.
  13965. </exception>
  13966. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  13967. The server replied with a NO or BAD response.
  13968. </exception>
  13969. </member>
  13970. <member name="M:MailKit.Net.Imap.ImapFolder.SetFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  13971. <summary>
  13972. Asynchronously sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
  13973. </summary>
  13974. <remarks>
  13975. Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
  13976. </remarks>
  13977. <returns>The indexes of the messages that were not updated.</returns>
  13978. <param name="indexes">The indexes of the messages.</param>
  13979. <param name="modseq">The mod-sequence value.</param>
  13980. <param name="flags">The message flags to set.</param>
  13981. <param name="keywords">A set of user-defined flags to set.</param>
  13982. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  13983. <param name="cancellationToken">The cancellation token.</param>
  13984. <exception cref="T:System.ArgumentNullException">
  13985. <paramref name="indexes"/> is <c>null</c>.
  13986. </exception>
  13987. <exception cref="T:System.ArgumentException">
  13988. One or more of the <paramref name="indexes"/> is invalid.
  13989. </exception>
  13990. <exception cref="T:System.ObjectDisposedException">
  13991. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  13992. </exception>
  13993. <exception cref="T:MailKit.ServiceNotConnectedException">
  13994. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  13995. </exception>
  13996. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  13997. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  13998. </exception>
  13999. <exception cref="T:MailKit.FolderNotOpenException">
  14000. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  14001. </exception>
  14002. <exception cref="T:System.NotSupportedException">
  14003. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> does not support mod-sequences.
  14004. </exception>
  14005. <exception cref="T:System.OperationCanceledException">
  14006. The operation was canceled via the cancellation token.
  14007. </exception>
  14008. <exception cref="T:System.IO.IOException">
  14009. An I/O error occurred.
  14010. </exception>
  14011. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  14012. The server's response contained unexpected tokens.
  14013. </exception>
  14014. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  14015. The server replied with a NO or BAD response.
  14016. </exception>
  14017. </member>
  14018. <member name="M:MailKit.Net.Imap.ImapFolder.AddLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  14019. <summary>
  14020. Add a set of labels to the specified messages.
  14021. </summary>
  14022. <remarks>
  14023. Adds a set of labels to the specified messages.
  14024. </remarks>
  14025. <param name="uids">The UIDs of the messages.</param>
  14026. <param name="labels">The labels to add.</param>
  14027. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  14028. <param name="cancellationToken">The cancellation token.</param>
  14029. <exception cref="T:System.ArgumentNullException">
  14030. <para><paramref name="uids"/> is <c>null</c>.</para>
  14031. <para>-or-</para>
  14032. <para><paramref name="labels"/> is <c>null</c>.</para>
  14033. </exception>
  14034. <exception cref="T:System.ArgumentException">
  14035. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  14036. <para>-or-</para>
  14037. <para>No labels were specified.</para>
  14038. </exception>
  14039. <exception cref="T:System.ObjectDisposedException">
  14040. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  14041. </exception>
  14042. <exception cref="T:MailKit.ServiceNotConnectedException">
  14043. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  14044. </exception>
  14045. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  14046. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  14047. </exception>
  14048. <exception cref="T:MailKit.FolderNotOpenException">
  14049. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  14050. </exception>
  14051. <exception cref="T:System.OperationCanceledException">
  14052. The operation was canceled via the cancellation token.
  14053. </exception>
  14054. <exception cref="T:System.IO.IOException">
  14055. An I/O error occurred.
  14056. </exception>
  14057. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  14058. The server's response contained unexpected tokens.
  14059. </exception>
  14060. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  14061. The server replied with a NO or BAD response.
  14062. </exception>
  14063. </member>
  14064. <member name="M:MailKit.Net.Imap.ImapFolder.AddLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  14065. <summary>
  14066. Asynchronously add a set of labels to the specified messages.
  14067. </summary>
  14068. <remarks>
  14069. Adds a set of labels to the specified messages.
  14070. </remarks>
  14071. <returns>An asynchronous task context.</returns>
  14072. <param name="uids">The UIDs of the messages.</param>
  14073. <param name="labels">The labels to add.</param>
  14074. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  14075. <param name="cancellationToken">The cancellation token.</param>
  14076. <exception cref="T:System.ArgumentNullException">
  14077. <para><paramref name="uids"/> is <c>null</c>.</para>
  14078. <para>-or-</para>
  14079. <para><paramref name="labels"/> is <c>null</c>.</para>
  14080. </exception>
  14081. <exception cref="T:System.ArgumentException">
  14082. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  14083. <para>-or-</para>
  14084. <para>No labels were specified.</para>
  14085. </exception>
  14086. <exception cref="T:System.ObjectDisposedException">
  14087. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  14088. </exception>
  14089. <exception cref="T:MailKit.ServiceNotConnectedException">
  14090. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  14091. </exception>
  14092. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  14093. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  14094. </exception>
  14095. <exception cref="T:MailKit.FolderNotOpenException">
  14096. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  14097. </exception>
  14098. <exception cref="T:System.OperationCanceledException">
  14099. The operation was canceled via the cancellation token.
  14100. </exception>
  14101. <exception cref="T:System.IO.IOException">
  14102. An I/O error occurred.
  14103. </exception>
  14104. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  14105. The server's response contained unexpected tokens.
  14106. </exception>
  14107. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  14108. The server replied with a NO or BAD response.
  14109. </exception>
  14110. </member>
  14111. <member name="M:MailKit.Net.Imap.ImapFolder.RemoveLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  14112. <summary>
  14113. Remove a set of labels from the specified messages.
  14114. </summary>
  14115. <remarks>
  14116. Removes a set of labels from the specified messages.
  14117. </remarks>
  14118. <param name="uids">The UIDs of the messages.</param>
  14119. <param name="labels">The labels to remove.</param>
  14120. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  14121. <param name="cancellationToken">The cancellation token.</param>
  14122. <exception cref="T:System.ArgumentNullException">
  14123. <para><paramref name="uids"/> is <c>null</c>.</para>
  14124. <para>-or-</para>
  14125. <para><paramref name="labels"/> is <c>null</c>.</para>
  14126. </exception>
  14127. <exception cref="T:System.ArgumentException">
  14128. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  14129. <para>-or-</para>
  14130. <para>No labels were specified.</para>
  14131. </exception>
  14132. <exception cref="T:System.ObjectDisposedException">
  14133. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  14134. </exception>
  14135. <exception cref="T:MailKit.ServiceNotConnectedException">
  14136. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  14137. </exception>
  14138. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  14139. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  14140. </exception>
  14141. <exception cref="T:MailKit.FolderNotOpenException">
  14142. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  14143. </exception>
  14144. <exception cref="T:System.OperationCanceledException">
  14145. The operation was canceled via the cancellation token.
  14146. </exception>
  14147. <exception cref="T:System.IO.IOException">
  14148. An I/O error occurred.
  14149. </exception>
  14150. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  14151. The server's response contained unexpected tokens.
  14152. </exception>
  14153. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  14154. The server replied with a NO or BAD response.
  14155. </exception>
  14156. </member>
  14157. <member name="M:MailKit.Net.Imap.ImapFolder.RemoveLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  14158. <summary>
  14159. Asynchronously remove a set of labels from the specified messages.
  14160. </summary>
  14161. <remarks>
  14162. Removes a set of labels from the specified messages.
  14163. </remarks>
  14164. <returns>An asynchronous task context.</returns>
  14165. <param name="uids">The UIDs of the messages.</param>
  14166. <param name="labels">The labels to remove.</param>
  14167. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  14168. <param name="cancellationToken">The cancellation token.</param>
  14169. <exception cref="T:System.ArgumentNullException">
  14170. <para><paramref name="uids"/> is <c>null</c>.</para>
  14171. <para>-or-</para>
  14172. <para><paramref name="labels"/> is <c>null</c>.</para>
  14173. </exception>
  14174. <exception cref="T:System.ArgumentException">
  14175. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  14176. <para>-or-</para>
  14177. <para>No labels were specified.</para>
  14178. </exception>
  14179. <exception cref="T:System.ObjectDisposedException">
  14180. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  14181. </exception>
  14182. <exception cref="T:MailKit.ServiceNotConnectedException">
  14183. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  14184. </exception>
  14185. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  14186. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  14187. </exception>
  14188. <exception cref="T:MailKit.FolderNotOpenException">
  14189. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  14190. </exception>
  14191. <exception cref="T:System.OperationCanceledException">
  14192. The operation was canceled via the cancellation token.
  14193. </exception>
  14194. <exception cref="T:System.IO.IOException">
  14195. An I/O error occurred.
  14196. </exception>
  14197. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  14198. The server's response contained unexpected tokens.
  14199. </exception>
  14200. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  14201. The server replied with a NO or BAD response.
  14202. </exception>
  14203. </member>
  14204. <member name="M:MailKit.Net.Imap.ImapFolder.SetLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  14205. <summary>
  14206. Set the labels of the specified messages.
  14207. </summary>
  14208. <remarks>
  14209. Sets the labels of the specified messages.
  14210. </remarks>
  14211. <param name="uids">The UIDs of the messages.</param>
  14212. <param name="labels">The labels to set.</param>
  14213. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  14214. <param name="cancellationToken">The cancellation token.</param>
  14215. <exception cref="T:System.ArgumentNullException">
  14216. <para><paramref name="uids"/> is <c>null</c>.</para>
  14217. <para>-or-</para>
  14218. <para><paramref name="labels"/> is <c>null</c>.</para>
  14219. </exception>
  14220. <exception cref="T:System.ArgumentException">
  14221. One or more of the <paramref name="uids"/> is invalid.
  14222. </exception>
  14223. <exception cref="T:System.ObjectDisposedException">
  14224. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  14225. </exception>
  14226. <exception cref="T:MailKit.ServiceNotConnectedException">
  14227. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  14228. </exception>
  14229. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  14230. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  14231. </exception>
  14232. <exception cref="T:MailKit.FolderNotOpenException">
  14233. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  14234. </exception>
  14235. <exception cref="T:System.OperationCanceledException">
  14236. The operation was canceled via the cancellation token.
  14237. </exception>
  14238. <exception cref="T:System.IO.IOException">
  14239. An I/O error occurred.
  14240. </exception>
  14241. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  14242. The server's response contained unexpected tokens.
  14243. </exception>
  14244. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  14245. The server replied with a NO or BAD response.
  14246. </exception>
  14247. </member>
  14248. <member name="M:MailKit.Net.Imap.ImapFolder.SetLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  14249. <summary>
  14250. Asynchronously set the labels of the specified messages.
  14251. </summary>
  14252. <remarks>
  14253. Sets the labels of the specified messages.
  14254. </remarks>
  14255. <returns>An asynchronous task context.</returns>
  14256. <param name="uids">The UIDs of the messages.</param>
  14257. <param name="labels">The labels to set.</param>
  14258. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  14259. <param name="cancellationToken">The cancellation token.</param>
  14260. <exception cref="T:System.ArgumentNullException">
  14261. <para><paramref name="uids"/> is <c>null</c>.</para>
  14262. <para>-or-</para>
  14263. <para><paramref name="labels"/> is <c>null</c>.</para>
  14264. </exception>
  14265. <exception cref="T:System.ArgumentException">
  14266. One or more of the <paramref name="uids"/> is invalid.
  14267. </exception>
  14268. <exception cref="T:System.ObjectDisposedException">
  14269. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  14270. </exception>
  14271. <exception cref="T:MailKit.ServiceNotConnectedException">
  14272. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  14273. </exception>
  14274. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  14275. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  14276. </exception>
  14277. <exception cref="T:MailKit.FolderNotOpenException">
  14278. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  14279. </exception>
  14280. <exception cref="T:System.OperationCanceledException">
  14281. The operation was canceled via the cancellation token.
  14282. </exception>
  14283. <exception cref="T:System.IO.IOException">
  14284. An I/O error occurred.
  14285. </exception>
  14286. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  14287. The server's response contained unexpected tokens.
  14288. </exception>
  14289. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  14290. The server replied with a NO or BAD response.
  14291. </exception>
  14292. </member>
  14293. <member name="M:MailKit.Net.Imap.ImapFolder.AddLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  14294. <summary>
  14295. Add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
  14296. </summary>
  14297. <remarks>
  14298. Adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
  14299. </remarks>
  14300. <returns>The unique IDs of the messages that were not updated.</returns>
  14301. <param name="uids">The UIDs of the messages.</param>
  14302. <param name="modseq">The mod-sequence value.</param>
  14303. <param name="labels">The labels to add.</param>
  14304. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  14305. <param name="cancellationToken">The cancellation token.</param>
  14306. <exception cref="T:System.ArgumentNullException">
  14307. <para><paramref name="uids"/> is <c>null</c>.</para>
  14308. <para>-or-</para>
  14309. <para><paramref name="labels"/> is <c>null</c>.</para>
  14310. </exception>
  14311. <exception cref="T:System.ArgumentException">
  14312. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  14313. <para>-or-</para>
  14314. <para>No labels were specified.</para>
  14315. </exception>
  14316. <exception cref="T:System.ObjectDisposedException">
  14317. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  14318. </exception>
  14319. <exception cref="T:MailKit.ServiceNotConnectedException">
  14320. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  14321. </exception>
  14322. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  14323. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  14324. </exception>
  14325. <exception cref="T:MailKit.FolderNotOpenException">
  14326. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  14327. </exception>
  14328. <exception cref="T:System.OperationCanceledException">
  14329. The operation was canceled via the cancellation token.
  14330. </exception>
  14331. <exception cref="T:System.IO.IOException">
  14332. An I/O error occurred.
  14333. </exception>
  14334. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  14335. The server's response contained unexpected tokens.
  14336. </exception>
  14337. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  14338. The server replied with a NO or BAD response.
  14339. </exception>
  14340. </member>
  14341. <member name="M:MailKit.Net.Imap.ImapFolder.AddLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  14342. <summary>
  14343. Asynchronously add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
  14344. </summary>
  14345. <remarks>
  14346. Adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
  14347. </remarks>
  14348. <returns>The unique IDs of the messages that were not updated.</returns>
  14349. <param name="uids">The UIDs of the messages.</param>
  14350. <param name="modseq">The mod-sequence value.</param>
  14351. <param name="labels">The labels to add.</param>
  14352. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  14353. <param name="cancellationToken">The cancellation token.</param>
  14354. <exception cref="T:System.ArgumentNullException">
  14355. <para><paramref name="uids"/> is <c>null</c>.</para>
  14356. <para>-or-</para>
  14357. <para><paramref name="labels"/> is <c>null</c>.</para>
  14358. </exception>
  14359. <exception cref="T:System.ArgumentException">
  14360. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  14361. <para>-or-</para>
  14362. <para>No labels were specified.</para>
  14363. </exception>
  14364. <exception cref="T:System.ObjectDisposedException">
  14365. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  14366. </exception>
  14367. <exception cref="T:MailKit.ServiceNotConnectedException">
  14368. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  14369. </exception>
  14370. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  14371. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  14372. </exception>
  14373. <exception cref="T:MailKit.FolderNotOpenException">
  14374. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  14375. </exception>
  14376. <exception cref="T:System.OperationCanceledException">
  14377. The operation was canceled via the cancellation token.
  14378. </exception>
  14379. <exception cref="T:System.IO.IOException">
  14380. An I/O error occurred.
  14381. </exception>
  14382. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  14383. The server's response contained unexpected tokens.
  14384. </exception>
  14385. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  14386. The server replied with a NO or BAD response.
  14387. </exception>
  14388. </member>
  14389. <member name="M:MailKit.Net.Imap.ImapFolder.RemoveLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  14390. <summary>
  14391. Remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
  14392. </summary>
  14393. <remarks>
  14394. Removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
  14395. </remarks>
  14396. <returns>The unique IDs of the messages that were not updated.</returns>
  14397. <param name="uids">The UIDs of the messages.</param>
  14398. <param name="modseq">The mod-sequence value.</param>
  14399. <param name="labels">The labels to remove.</param>
  14400. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  14401. <param name="cancellationToken">The cancellation token.</param>
  14402. <exception cref="T:System.ArgumentNullException">
  14403. <para><paramref name="uids"/> is <c>null</c>.</para>
  14404. <para>-or-</para>
  14405. <para><paramref name="labels"/> is <c>null</c>.</para>
  14406. </exception>
  14407. <exception cref="T:System.ArgumentException">
  14408. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  14409. <para>-or-</para>
  14410. <para>No labels were specified.</para>
  14411. </exception>
  14412. <exception cref="T:System.ObjectDisposedException">
  14413. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  14414. </exception>
  14415. <exception cref="T:MailKit.ServiceNotConnectedException">
  14416. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  14417. </exception>
  14418. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  14419. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  14420. </exception>
  14421. <exception cref="T:MailKit.FolderNotOpenException">
  14422. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  14423. </exception>
  14424. <exception cref="T:System.OperationCanceledException">
  14425. The operation was canceled via the cancellation token.
  14426. </exception>
  14427. <exception cref="T:System.IO.IOException">
  14428. An I/O error occurred.
  14429. </exception>
  14430. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  14431. The server's response contained unexpected tokens.
  14432. </exception>
  14433. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  14434. The server replied with a NO or BAD response.
  14435. </exception>
  14436. </member>
  14437. <member name="M:MailKit.Net.Imap.ImapFolder.RemoveLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  14438. <summary>
  14439. Asynchronously remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
  14440. </summary>
  14441. <remarks>
  14442. Removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
  14443. </remarks>
  14444. <returns>The unique IDs of the messages that were not updated.</returns>
  14445. <param name="uids">The UIDs of the messages.</param>
  14446. <param name="modseq">The mod-sequence value.</param>
  14447. <param name="labels">The labels to remove.</param>
  14448. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  14449. <param name="cancellationToken">The cancellation token.</param>
  14450. <exception cref="T:System.ArgumentNullException">
  14451. <para><paramref name="uids"/> is <c>null</c>.</para>
  14452. <para>-or-</para>
  14453. <para><paramref name="labels"/> is <c>null</c>.</para>
  14454. </exception>
  14455. <exception cref="T:System.ArgumentException">
  14456. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  14457. <para>-or-</para>
  14458. <para>No labels were specified.</para>
  14459. </exception>
  14460. <exception cref="T:System.ObjectDisposedException">
  14461. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  14462. </exception>
  14463. <exception cref="T:MailKit.ServiceNotConnectedException">
  14464. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  14465. </exception>
  14466. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  14467. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  14468. </exception>
  14469. <exception cref="T:MailKit.FolderNotOpenException">
  14470. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  14471. </exception>
  14472. <exception cref="T:System.OperationCanceledException">
  14473. The operation was canceled via the cancellation token.
  14474. </exception>
  14475. <exception cref="T:System.IO.IOException">
  14476. An I/O error occurred.
  14477. </exception>
  14478. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  14479. The server's response contained unexpected tokens.
  14480. </exception>
  14481. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  14482. The server replied with a NO or BAD response.
  14483. </exception>
  14484. </member>
  14485. <member name="M:MailKit.Net.Imap.ImapFolder.SetLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  14486. <summary>
  14487. Set the labels of the specified messages only if their mod-sequence value is less than the specified value.
  14488. </summary>
  14489. <remarks>
  14490. Sets the labels of the specified messages only if their mod-sequence value is less than the specified value.
  14491. </remarks>
  14492. <returns>The unique IDs of the messages that were not updated.</returns>
  14493. <param name="uids">The UIDs of the messages.</param>
  14494. <param name="modseq">The mod-sequence value.</param>
  14495. <param name="labels">The labels to set.</param>
  14496. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  14497. <param name="cancellationToken">The cancellation token.</param>
  14498. <exception cref="T:System.ArgumentNullException">
  14499. <para><paramref name="uids"/> is <c>null</c>.</para>
  14500. <para>-or-</para>
  14501. <para><paramref name="labels"/> is <c>null</c>.</para>
  14502. </exception>
  14503. <exception cref="T:System.ArgumentException">
  14504. One or more of the <paramref name="uids"/> is invalid.
  14505. </exception>
  14506. <exception cref="T:System.ObjectDisposedException">
  14507. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  14508. </exception>
  14509. <exception cref="T:MailKit.ServiceNotConnectedException">
  14510. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  14511. </exception>
  14512. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  14513. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  14514. </exception>
  14515. <exception cref="T:MailKit.FolderNotOpenException">
  14516. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  14517. </exception>
  14518. <exception cref="T:System.OperationCanceledException">
  14519. The operation was canceled via the cancellation token.
  14520. </exception>
  14521. <exception cref="T:System.IO.IOException">
  14522. An I/O error occurred.
  14523. </exception>
  14524. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  14525. The server's response contained unexpected tokens.
  14526. </exception>
  14527. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  14528. The server replied with a NO or BAD response.
  14529. </exception>
  14530. </member>
  14531. <member name="M:MailKit.Net.Imap.ImapFolder.SetLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  14532. <summary>
  14533. Asynchronously set the labels of the specified messages only if their mod-sequence value is less than the specified value.
  14534. </summary>
  14535. <remarks>
  14536. Sets the labels of the specified messages only if their mod-sequence value is less than the specified value.
  14537. </remarks>
  14538. <returns>The unique IDs of the messages that were not updated.</returns>
  14539. <param name="uids">The UIDs of the messages.</param>
  14540. <param name="modseq">The mod-sequence value.</param>
  14541. <param name="labels">The labels to set.</param>
  14542. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  14543. <param name="cancellationToken">The cancellation token.</param>
  14544. <exception cref="T:System.ArgumentNullException">
  14545. <para><paramref name="uids"/> is <c>null</c>.</para>
  14546. <para>-or-</para>
  14547. <para><paramref name="labels"/> is <c>null</c>.</para>
  14548. </exception>
  14549. <exception cref="T:System.ArgumentException">
  14550. One or more of the <paramref name="uids"/> is invalid.
  14551. </exception>
  14552. <exception cref="T:System.ObjectDisposedException">
  14553. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  14554. </exception>
  14555. <exception cref="T:MailKit.ServiceNotConnectedException">
  14556. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  14557. </exception>
  14558. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  14559. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  14560. </exception>
  14561. <exception cref="T:MailKit.FolderNotOpenException">
  14562. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  14563. </exception>
  14564. <exception cref="T:System.OperationCanceledException">
  14565. The operation was canceled via the cancellation token.
  14566. </exception>
  14567. <exception cref="T:System.IO.IOException">
  14568. An I/O error occurred.
  14569. </exception>
  14570. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  14571. The server's response contained unexpected tokens.
  14572. </exception>
  14573. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  14574. The server replied with a NO or BAD response.
  14575. </exception>
  14576. </member>
  14577. <member name="M:MailKit.Net.Imap.ImapFolder.AddLabels(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  14578. <summary>
  14579. Add a set of labels to the specified messages.
  14580. </summary>
  14581. <remarks>
  14582. Adds a set of labels to the specified messages.
  14583. </remarks>
  14584. <param name="indexes">The indexes of the messages.</param>
  14585. <param name="labels">The labels to add.</param>
  14586. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  14587. <param name="cancellationToken">The cancellation token.</param>
  14588. <exception cref="T:System.ArgumentNullException">
  14589. <para><paramref name="indexes"/> is <c>null</c>.</para>
  14590. <para>-or-</para>
  14591. <para><paramref name="labels"/> is <c>null</c>.</para>
  14592. </exception>
  14593. <exception cref="T:System.ArgumentException">
  14594. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  14595. <para>-or-</para>
  14596. <para>No labels were specified.</para>
  14597. </exception>
  14598. <exception cref="T:System.ObjectDisposedException">
  14599. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  14600. </exception>
  14601. <exception cref="T:MailKit.ServiceNotConnectedException">
  14602. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  14603. </exception>
  14604. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  14605. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  14606. </exception>
  14607. <exception cref="T:MailKit.FolderNotOpenException">
  14608. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  14609. </exception>
  14610. <exception cref="T:System.OperationCanceledException">
  14611. The operation was canceled via the cancellation token.
  14612. </exception>
  14613. <exception cref="T:System.IO.IOException">
  14614. An I/O error occurred.
  14615. </exception>
  14616. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  14617. The server's response contained unexpected tokens.
  14618. </exception>
  14619. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  14620. The server replied with a NO or BAD response.
  14621. </exception>
  14622. </member>
  14623. <member name="M:MailKit.Net.Imap.ImapFolder.AddLabelsAsync(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  14624. <summary>
  14625. Asynchronously add a set of labels to the specified messages.
  14626. </summary>
  14627. <remarks>
  14628. Adds a set of labels to the specified messages.
  14629. </remarks>
  14630. <returns>An asynchronous task context.</returns>
  14631. <param name="indexes">The indexes of the messages.</param>
  14632. <param name="labels">The labels to add.</param>
  14633. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  14634. <param name="cancellationToken">The cancellation token.</param>
  14635. <exception cref="T:System.ArgumentNullException">
  14636. <para><paramref name="indexes"/> is <c>null</c>.</para>
  14637. <para>-or-</para>
  14638. <para><paramref name="labels"/> is <c>null</c>.</para>
  14639. </exception>
  14640. <exception cref="T:System.ArgumentException">
  14641. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  14642. <para>-or-</para>
  14643. <para>No labels were specified.</para>
  14644. </exception>
  14645. <exception cref="T:System.ObjectDisposedException">
  14646. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  14647. </exception>
  14648. <exception cref="T:MailKit.ServiceNotConnectedException">
  14649. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  14650. </exception>
  14651. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  14652. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  14653. </exception>
  14654. <exception cref="T:MailKit.FolderNotOpenException">
  14655. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  14656. </exception>
  14657. <exception cref="T:System.OperationCanceledException">
  14658. The operation was canceled via the cancellation token.
  14659. </exception>
  14660. <exception cref="T:System.IO.IOException">
  14661. An I/O error occurred.
  14662. </exception>
  14663. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  14664. The server's response contained unexpected tokens.
  14665. </exception>
  14666. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  14667. The server replied with a NO or BAD response.
  14668. </exception>
  14669. </member>
  14670. <member name="M:MailKit.Net.Imap.ImapFolder.RemoveLabels(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  14671. <summary>
  14672. Remove a set of labels from the specified messages.
  14673. </summary>
  14674. <remarks>
  14675. Removes a set of labels from the specified messages.
  14676. </remarks>
  14677. <param name="indexes">The indexes of the messages.</param>
  14678. <param name="labels">The labels to remove.</param>
  14679. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  14680. <param name="cancellationToken">The cancellation token.</param>
  14681. <exception cref="T:System.ArgumentNullException">
  14682. <para><paramref name="indexes"/> is <c>null</c>.</para>
  14683. <para>-or-</para>
  14684. <para><paramref name="labels"/> is <c>null</c>.</para>
  14685. </exception>
  14686. <exception cref="T:System.ArgumentException">
  14687. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  14688. <para>-or-</para>
  14689. <para>No labels were specified.</para>
  14690. </exception>
  14691. <exception cref="T:System.ObjectDisposedException">
  14692. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  14693. </exception>
  14694. <exception cref="T:MailKit.ServiceNotConnectedException">
  14695. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  14696. </exception>
  14697. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  14698. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  14699. </exception>
  14700. <exception cref="T:MailKit.FolderNotOpenException">
  14701. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  14702. </exception>
  14703. <exception cref="T:System.OperationCanceledException">
  14704. The operation was canceled via the cancellation token.
  14705. </exception>
  14706. <exception cref="T:System.IO.IOException">
  14707. An I/O error occurred.
  14708. </exception>
  14709. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  14710. The server's response contained unexpected tokens.
  14711. </exception>
  14712. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  14713. The server replied with a NO or BAD response.
  14714. </exception>
  14715. </member>
  14716. <member name="M:MailKit.Net.Imap.ImapFolder.RemoveLabelsAsync(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  14717. <summary>
  14718. Asynchronously remove a set of labels from the specified messages.
  14719. </summary>
  14720. <remarks>
  14721. Removes a set of labels from the specified messages.
  14722. </remarks>
  14723. <returns>An asynchronous task context.</returns>
  14724. <param name="indexes">The indexes of the messages.</param>
  14725. <param name="labels">The labels to remove.</param>
  14726. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  14727. <param name="cancellationToken">The cancellation token.</param>
  14728. <exception cref="T:System.ArgumentNullException">
  14729. <para><paramref name="indexes"/> is <c>null</c>.</para>
  14730. <para>-or-</para>
  14731. <para><paramref name="labels"/> is <c>null</c>.</para>
  14732. </exception>
  14733. <exception cref="T:System.ArgumentException">
  14734. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  14735. <para>-or-</para>
  14736. <para>No labels were specified.</para>
  14737. </exception>
  14738. <exception cref="T:System.ObjectDisposedException">
  14739. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  14740. </exception>
  14741. <exception cref="T:MailKit.ServiceNotConnectedException">
  14742. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  14743. </exception>
  14744. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  14745. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  14746. </exception>
  14747. <exception cref="T:MailKit.FolderNotOpenException">
  14748. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  14749. </exception>
  14750. <exception cref="T:System.OperationCanceledException">
  14751. The operation was canceled via the cancellation token.
  14752. </exception>
  14753. <exception cref="T:System.IO.IOException">
  14754. An I/O error occurred.
  14755. </exception>
  14756. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  14757. The server's response contained unexpected tokens.
  14758. </exception>
  14759. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  14760. The server replied with a NO or BAD response.
  14761. </exception>
  14762. </member>
  14763. <member name="M:MailKit.Net.Imap.ImapFolder.SetLabels(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  14764. <summary>
  14765. Sets the labels of the specified messages.
  14766. </summary>
  14767. <remarks>
  14768. Sets the labels of the specified messages.
  14769. </remarks>
  14770. <param name="indexes">The indexes of the messages.</param>
  14771. <param name="labels">The labels to set.</param>
  14772. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  14773. <param name="cancellationToken">The cancellation token.</param>
  14774. <exception cref="T:System.ArgumentNullException">
  14775. <para><paramref name="indexes"/> is <c>null</c>.</para>
  14776. <para>-or-</para>
  14777. <para><paramref name="labels"/> is <c>null</c>.</para>
  14778. </exception>
  14779. <exception cref="T:System.ArgumentException">
  14780. One or more of the <paramref name="indexes"/> is invalid.
  14781. </exception>
  14782. <exception cref="T:System.ObjectDisposedException">
  14783. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  14784. </exception>
  14785. <exception cref="T:MailKit.ServiceNotConnectedException">
  14786. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  14787. </exception>
  14788. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  14789. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  14790. </exception>
  14791. <exception cref="T:MailKit.FolderNotOpenException">
  14792. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  14793. </exception>
  14794. <exception cref="T:System.OperationCanceledException">
  14795. The operation was canceled via the cancellation token.
  14796. </exception>
  14797. <exception cref="T:System.IO.IOException">
  14798. An I/O error occurred.
  14799. </exception>
  14800. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  14801. The server's response contained unexpected tokens.
  14802. </exception>
  14803. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  14804. The server replied with a NO or BAD response.
  14805. </exception>
  14806. </member>
  14807. <member name="M:MailKit.Net.Imap.ImapFolder.SetLabelsAsync(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  14808. <summary>
  14809. Asynchronously sets the labels of the specified messages.
  14810. </summary>
  14811. <remarks>
  14812. Sets the labels of the specified messages.
  14813. </remarks>
  14814. <returns>An asynchronous task context.</returns>
  14815. <param name="indexes">The indexes of the messages.</param>
  14816. <param name="labels">The labels to set.</param>
  14817. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  14818. <param name="cancellationToken">The cancellation token.</param>
  14819. <exception cref="T:System.ArgumentNullException">
  14820. <para><paramref name="indexes"/> is <c>null</c>.</para>
  14821. <para>-or-</para>
  14822. <para><paramref name="labels"/> is <c>null</c>.</para>
  14823. </exception>
  14824. <exception cref="T:System.ArgumentException">
  14825. One or more of the <paramref name="indexes"/> is invalid.
  14826. </exception>
  14827. <exception cref="T:System.ObjectDisposedException">
  14828. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  14829. </exception>
  14830. <exception cref="T:MailKit.ServiceNotConnectedException">
  14831. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  14832. </exception>
  14833. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  14834. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  14835. </exception>
  14836. <exception cref="T:MailKit.FolderNotOpenException">
  14837. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  14838. </exception>
  14839. <exception cref="T:System.OperationCanceledException">
  14840. The operation was canceled via the cancellation token.
  14841. </exception>
  14842. <exception cref="T:System.IO.IOException">
  14843. An I/O error occurred.
  14844. </exception>
  14845. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  14846. The server's response contained unexpected tokens.
  14847. </exception>
  14848. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  14849. The server replied with a NO or BAD response.
  14850. </exception>
  14851. </member>
  14852. <member name="M:MailKit.Net.Imap.ImapFolder.AddLabels(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  14853. <summary>
  14854. Add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
  14855. </summary>
  14856. <remarks>
  14857. Adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
  14858. </remarks>
  14859. <returns>The indexes of the messages that were not updated.</returns>
  14860. <param name="indexes">The indexes of the messages.</param>
  14861. <param name="modseq">The mod-sequence value.</param>
  14862. <param name="labels">The labels to add.</param>
  14863. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  14864. <param name="cancellationToken">The cancellation token.</param>
  14865. <exception cref="T:System.ArgumentNullException">
  14866. <para><paramref name="indexes"/> is <c>null</c>.</para>
  14867. <para>-or-</para>
  14868. <para><paramref name="labels"/> is <c>null</c>.</para>
  14869. </exception>
  14870. <exception cref="T:System.ArgumentException">
  14871. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  14872. <para>-or-</para>
  14873. <para>No labels were specified.</para>
  14874. </exception>
  14875. <exception cref="T:System.ObjectDisposedException">
  14876. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  14877. </exception>
  14878. <exception cref="T:MailKit.ServiceNotConnectedException">
  14879. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  14880. </exception>
  14881. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  14882. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  14883. </exception>
  14884. <exception cref="T:MailKit.FolderNotOpenException">
  14885. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  14886. </exception>
  14887. <exception cref="T:System.OperationCanceledException">
  14888. The operation was canceled via the cancellation token.
  14889. </exception>
  14890. <exception cref="T:System.IO.IOException">
  14891. An I/O error occurred.
  14892. </exception>
  14893. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  14894. The server's response contained unexpected tokens.
  14895. </exception>
  14896. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  14897. The server replied with a NO or BAD response.
  14898. </exception>
  14899. </member>
  14900. <member name="M:MailKit.Net.Imap.ImapFolder.AddLabelsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  14901. <summary>
  14902. Asynchronously add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
  14903. </summary>
  14904. <remarks>
  14905. Adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
  14906. </remarks>
  14907. <returns>The indexes of the messages that were not updated.</returns>
  14908. <param name="indexes">The indexes of the messages.</param>
  14909. <param name="modseq">The mod-sequence value.</param>
  14910. <param name="labels">The labels to add.</param>
  14911. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  14912. <param name="cancellationToken">The cancellation token.</param>
  14913. <exception cref="T:System.ArgumentNullException">
  14914. <para><paramref name="indexes"/> is <c>null</c>.</para>
  14915. <para>-or-</para>
  14916. <para><paramref name="labels"/> is <c>null</c>.</para>
  14917. </exception>
  14918. <exception cref="T:System.ArgumentException">
  14919. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  14920. <para>-or-</para>
  14921. <para>No labels were specified.</para>
  14922. </exception>
  14923. <exception cref="T:System.ObjectDisposedException">
  14924. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  14925. </exception>
  14926. <exception cref="T:MailKit.ServiceNotConnectedException">
  14927. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  14928. </exception>
  14929. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  14930. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  14931. </exception>
  14932. <exception cref="T:MailKit.FolderNotOpenException">
  14933. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  14934. </exception>
  14935. <exception cref="T:System.OperationCanceledException">
  14936. The operation was canceled via the cancellation token.
  14937. </exception>
  14938. <exception cref="T:System.IO.IOException">
  14939. An I/O error occurred.
  14940. </exception>
  14941. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  14942. The server's response contained unexpected tokens.
  14943. </exception>
  14944. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  14945. The server replied with a NO or BAD response.
  14946. </exception>
  14947. </member>
  14948. <member name="M:MailKit.Net.Imap.ImapFolder.RemoveLabels(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  14949. <summary>
  14950. Remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
  14951. </summary>
  14952. <remarks>
  14953. Removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
  14954. </remarks>
  14955. <returns>The indexes of the messages that were not updated.</returns>
  14956. <param name="indexes">The indexes of the messages.</param>
  14957. <param name="modseq">The mod-sequence value.</param>
  14958. <param name="labels">The labels to remove.</param>
  14959. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  14960. <param name="cancellationToken">The cancellation token.</param>
  14961. <exception cref="T:System.ArgumentNullException">
  14962. <para><paramref name="indexes"/> is <c>null</c>.</para>
  14963. <para>-or-</para>
  14964. <para><paramref name="labels"/> is <c>null</c>.</para>
  14965. </exception>
  14966. <exception cref="T:System.ArgumentException">
  14967. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  14968. <para>-or-</para>
  14969. <para>No labels were specified.</para>
  14970. </exception>
  14971. <exception cref="T:System.ObjectDisposedException">
  14972. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  14973. </exception>
  14974. <exception cref="T:MailKit.ServiceNotConnectedException">
  14975. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  14976. </exception>
  14977. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  14978. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  14979. </exception>
  14980. <exception cref="T:MailKit.FolderNotOpenException">
  14981. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  14982. </exception>
  14983. <exception cref="T:System.OperationCanceledException">
  14984. The operation was canceled via the cancellation token.
  14985. </exception>
  14986. <exception cref="T:System.IO.IOException">
  14987. An I/O error occurred.
  14988. </exception>
  14989. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  14990. The server's response contained unexpected tokens.
  14991. </exception>
  14992. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  14993. The server replied with a NO or BAD response.
  14994. </exception>
  14995. </member>
  14996. <member name="M:MailKit.Net.Imap.ImapFolder.RemoveLabelsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  14997. <summary>
  14998. Asynchronously remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
  14999. </summary>
  15000. <remarks>
  15001. Removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
  15002. </remarks>
  15003. <returns>The indexes of the messages that were not updated.</returns>
  15004. <param name="indexes">The indexes of the messages.</param>
  15005. <param name="modseq">The mod-sequence value.</param>
  15006. <param name="labels">The labels to remove.</param>
  15007. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  15008. <param name="cancellationToken">The cancellation token.</param>
  15009. <exception cref="T:System.ArgumentNullException">
  15010. <para><paramref name="indexes"/> is <c>null</c>.</para>
  15011. <para>-or-</para>
  15012. <para><paramref name="labels"/> is <c>null</c>.</para>
  15013. </exception>
  15014. <exception cref="T:System.ArgumentException">
  15015. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  15016. <para>-or-</para>
  15017. <para>No labels were specified.</para>
  15018. </exception>
  15019. <exception cref="T:System.ObjectDisposedException">
  15020. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  15021. </exception>
  15022. <exception cref="T:MailKit.ServiceNotConnectedException">
  15023. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  15024. </exception>
  15025. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  15026. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  15027. </exception>
  15028. <exception cref="T:MailKit.FolderNotOpenException">
  15029. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  15030. </exception>
  15031. <exception cref="T:System.OperationCanceledException">
  15032. The operation was canceled via the cancellation token.
  15033. </exception>
  15034. <exception cref="T:System.IO.IOException">
  15035. An I/O error occurred.
  15036. </exception>
  15037. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  15038. The server's response contained unexpected tokens.
  15039. </exception>
  15040. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  15041. The server replied with a NO or BAD response.
  15042. </exception>
  15043. </member>
  15044. <member name="M:MailKit.Net.Imap.ImapFolder.SetLabels(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  15045. <summary>
  15046. Set the labels of the specified messages only if their mod-sequence value is less than the specified value.
  15047. </summary>
  15048. <remarks>
  15049. Sets the labels of the specified messages only if their mod-sequence value is less than the specified value.
  15050. </remarks>
  15051. <returns>The indexes of the messages that were not updated.</returns>
  15052. <param name="indexes">The indexes of the messages.</param>
  15053. <param name="modseq">The mod-sequence value.</param>
  15054. <param name="labels">The labels to set.</param>
  15055. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  15056. <param name="cancellationToken">The cancellation token.</param>
  15057. <exception cref="T:System.ArgumentNullException">
  15058. <para><paramref name="indexes"/> is <c>null</c>.</para>
  15059. <para>-or-</para>
  15060. <para><paramref name="labels"/> is <c>null</c>.</para>
  15061. </exception>
  15062. <exception cref="T:System.ArgumentException">
  15063. One or more of the <paramref name="indexes"/> is invalid.
  15064. </exception>
  15065. <exception cref="T:System.ObjectDisposedException">
  15066. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  15067. </exception>
  15068. <exception cref="T:MailKit.ServiceNotConnectedException">
  15069. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  15070. </exception>
  15071. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  15072. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  15073. </exception>
  15074. <exception cref="T:MailKit.FolderNotOpenException">
  15075. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  15076. </exception>
  15077. <exception cref="T:System.OperationCanceledException">
  15078. The operation was canceled via the cancellation token.
  15079. </exception>
  15080. <exception cref="T:System.IO.IOException">
  15081. An I/O error occurred.
  15082. </exception>
  15083. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  15084. The server's response contained unexpected tokens.
  15085. </exception>
  15086. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  15087. The server replied with a NO or BAD response.
  15088. </exception>
  15089. </member>
  15090. <member name="M:MailKit.Net.Imap.ImapFolder.SetLabelsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  15091. <summary>
  15092. Asynchronously set the labels of the specified messages only if their mod-sequence value is less than the specified value.
  15093. </summary>
  15094. <remarks>
  15095. Sets the labels of the specified messages only if their mod-sequence value is less than the specified value.
  15096. </remarks>
  15097. <returns>The indexes of the messages that were not updated.</returns>
  15098. <param name="indexes">The indexes of the messages.</param>
  15099. <param name="modseq">The mod-sequence value.</param>
  15100. <param name="labels">The labels to set.</param>
  15101. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  15102. <param name="cancellationToken">The cancellation token.</param>
  15103. <exception cref="T:System.ArgumentNullException">
  15104. <para><paramref name="indexes"/> is <c>null</c>.</para>
  15105. <para>-or-</para>
  15106. <para><paramref name="labels"/> is <c>null</c>.</para>
  15107. </exception>
  15108. <exception cref="T:System.ArgumentException">
  15109. One or more of the <paramref name="indexes"/> is invalid.
  15110. </exception>
  15111. <exception cref="T:System.ObjectDisposedException">
  15112. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  15113. </exception>
  15114. <exception cref="T:MailKit.ServiceNotConnectedException">
  15115. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  15116. </exception>
  15117. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  15118. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  15119. </exception>
  15120. <exception cref="T:MailKit.FolderNotOpenException">
  15121. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open in read-write mode.
  15122. </exception>
  15123. <exception cref="T:System.OperationCanceledException">
  15124. The operation was canceled via the cancellation token.
  15125. </exception>
  15126. <exception cref="T:System.IO.IOException">
  15127. An I/O error occurred.
  15128. </exception>
  15129. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  15130. The server's response contained unexpected tokens.
  15131. </exception>
  15132. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  15133. The server replied with a NO or BAD response.
  15134. </exception>
  15135. </member>
  15136. <member name="M:MailKit.Net.Imap.ImapFolder.Search(System.String,System.Threading.CancellationToken)">
  15137. <summary>
  15138. Search the folder for messages matching the specified query.
  15139. </summary>
  15140. <remarks>
  15141. Sends a <c>UID SEARCH</c> command with the specified query passed directly to the IMAP server
  15142. with no interpretation by MailKit. This means that the query may contain any arguments that a
  15143. <c>UID SEARCH</c> command is allowed to have according to the IMAP specifications and any
  15144. extensions that are supported, including <c>RETURN</c> parameters.
  15145. </remarks>
  15146. <returns>An array of matching UIDs.</returns>
  15147. <param name="query">The search query.</param>
  15148. <param name="cancellationToken">The cancellation token.</param>
  15149. <exception cref="T:System.ArgumentNullException">
  15150. <paramref name="query"/> is <c>null</c>.
  15151. </exception>
  15152. <exception cref="T:System.ArgumentException">
  15153. <paramref name="query"/> is an empty string.
  15154. </exception>
  15155. <exception cref="T:System.ObjectDisposedException">
  15156. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  15157. </exception>
  15158. <exception cref="T:MailKit.ServiceNotConnectedException">
  15159. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  15160. </exception>
  15161. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  15162. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  15163. </exception>
  15164. <exception cref="T:MailKit.FolderNotOpenException">
  15165. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  15166. </exception>
  15167. <exception cref="T:System.OperationCanceledException">
  15168. The operation was canceled via the cancellation token.
  15169. </exception>
  15170. <exception cref="T:System.IO.IOException">
  15171. An I/O error occurred.
  15172. </exception>
  15173. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  15174. The server's response contained unexpected tokens.
  15175. </exception>
  15176. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  15177. The server replied with a NO or BAD response.
  15178. </exception>
  15179. </member>
  15180. <member name="M:MailKit.Net.Imap.ImapFolder.SearchAsync(System.String,System.Threading.CancellationToken)">
  15181. <summary>
  15182. Asynchronously search the folder for messages matching the specified query.
  15183. </summary>
  15184. <remarks>
  15185. Sends a <c>UID SEARCH</c> command with the specified query passed directly to the IMAP server
  15186. with no interpretation by MailKit. This means that the query may contain any arguments that a
  15187. <c>UID SEARCH</c> command is allowed to have according to the IMAP specifications and any
  15188. extensions that are supported, including <c>RETURN</c> parameters.
  15189. </remarks>
  15190. <returns>An array of matching UIDs.</returns>
  15191. <param name="query">The search query.</param>
  15192. <param name="cancellationToken">The cancellation token.</param>
  15193. <exception cref="T:System.ArgumentNullException">
  15194. <paramref name="query"/> is <c>null</c>.
  15195. </exception>
  15196. <exception cref="T:System.ArgumentException">
  15197. <paramref name="query"/> is an empty string.
  15198. </exception>
  15199. <exception cref="T:System.ObjectDisposedException">
  15200. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  15201. </exception>
  15202. <exception cref="T:MailKit.ServiceNotConnectedException">
  15203. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  15204. </exception>
  15205. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  15206. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  15207. </exception>
  15208. <exception cref="T:MailKit.FolderNotOpenException">
  15209. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  15210. </exception>
  15211. <exception cref="T:System.OperationCanceledException">
  15212. The operation was canceled via the cancellation token.
  15213. </exception>
  15214. <exception cref="T:System.IO.IOException">
  15215. An I/O error occurred.
  15216. </exception>
  15217. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  15218. The server's response contained unexpected tokens.
  15219. </exception>
  15220. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  15221. The server replied with a NO or BAD response.
  15222. </exception>
  15223. </member>
  15224. <member name="M:MailKit.Net.Imap.ImapFolder.Search(MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
  15225. <summary>
  15226. Search the folder for messages matching the specified query.
  15227. </summary>
  15228. <remarks>
  15229. The returned array of unique identifiers can be used with methods such as
  15230. <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
  15231. </remarks>
  15232. <returns>An array of matching UIDs.</returns>
  15233. <param name="query">The search query.</param>
  15234. <param name="cancellationToken">The cancellation token.</param>
  15235. <exception cref="T:System.ArgumentNullException">
  15236. <paramref name="query"/> is <c>null</c>.
  15237. </exception>
  15238. <exception cref="T:System.NotSupportedException">
  15239. One or more search terms in the <paramref name="query"/> are not supported by the IMAP server.
  15240. </exception>
  15241. <exception cref="T:System.ObjectDisposedException">
  15242. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  15243. </exception>
  15244. <exception cref="T:MailKit.ServiceNotConnectedException">
  15245. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  15246. </exception>
  15247. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  15248. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  15249. </exception>
  15250. <exception cref="T:MailKit.FolderNotOpenException">
  15251. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  15252. </exception>
  15253. <exception cref="T:System.OperationCanceledException">
  15254. The operation was canceled via the cancellation token.
  15255. </exception>
  15256. <exception cref="T:System.IO.IOException">
  15257. An I/O error occurred.
  15258. </exception>
  15259. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  15260. The server's response contained unexpected tokens.
  15261. </exception>
  15262. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  15263. The server replied with a NO or BAD response.
  15264. </exception>
  15265. </member>
  15266. <member name="M:MailKit.Net.Imap.ImapFolder.SearchAsync(MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
  15267. <summary>
  15268. Asynchronously search the folder for messages matching the specified query.
  15269. </summary>
  15270. <remarks>
  15271. The returned array of unique identifiers can be used with methods such as
  15272. <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
  15273. </remarks>
  15274. <returns>An array of matching UIDs.</returns>
  15275. <param name="query">The search query.</param>
  15276. <param name="cancellationToken">The cancellation token.</param>
  15277. <exception cref="T:System.ArgumentNullException">
  15278. <paramref name="query"/> is <c>null</c>.
  15279. </exception>
  15280. <exception cref="T:System.NotSupportedException">
  15281. One or more search terms in the <paramref name="query"/> are not supported by the IMAP server.
  15282. </exception>
  15283. <exception cref="T:System.ObjectDisposedException">
  15284. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  15285. </exception>
  15286. <exception cref="T:MailKit.ServiceNotConnectedException">
  15287. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  15288. </exception>
  15289. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  15290. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  15291. </exception>
  15292. <exception cref="T:MailKit.FolderNotOpenException">
  15293. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  15294. </exception>
  15295. <exception cref="T:System.OperationCanceledException">
  15296. The operation was canceled via the cancellation token.
  15297. </exception>
  15298. <exception cref="T:System.IO.IOException">
  15299. An I/O error occurred.
  15300. </exception>
  15301. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  15302. The server's response contained unexpected tokens.
  15303. </exception>
  15304. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  15305. The server replied with a NO or BAD response.
  15306. </exception>
  15307. </member>
  15308. <member name="M:MailKit.Net.Imap.ImapFolder.Search(MailKit.Search.SearchOptions,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
  15309. <summary>
  15310. Search the folder for messages matching the specified query.
  15311. </summary>
  15312. <remarks>
  15313. Searches the folder for messages matching the specified query,
  15314. returning only the specified search results.
  15315. </remarks>
  15316. <returns>The search results.</returns>
  15317. <param name="options">The search options.</param>
  15318. <param name="query">The search query.</param>
  15319. <param name="cancellationToken">The cancellation token.</param>
  15320. <exception cref="T:System.ArgumentNullException">
  15321. <paramref name="query"/> is <c>null</c>.
  15322. </exception>
  15323. <exception cref="T:System.NotSupportedException">
  15324. <para>One or more search terms in the <paramref name="query"/> are not supported by the IMAP server.</para>
  15325. <para>-or-</para>
  15326. <para>The IMAP server does not support the ESEARCH extension.</para>
  15327. </exception>
  15328. <exception cref="T:System.ObjectDisposedException">
  15329. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  15330. </exception>
  15331. <exception cref="T:MailKit.ServiceNotConnectedException">
  15332. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  15333. </exception>
  15334. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  15335. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  15336. </exception>
  15337. <exception cref="T:MailKit.FolderNotOpenException">
  15338. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  15339. </exception>
  15340. <exception cref="T:System.OperationCanceledException">
  15341. The operation was canceled via the cancellation token.
  15342. </exception>
  15343. <exception cref="T:System.IO.IOException">
  15344. An I/O error occurred.
  15345. </exception>
  15346. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  15347. The server's response contained unexpected tokens.
  15348. </exception>
  15349. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  15350. The server replied with a NO or BAD response.
  15351. </exception>
  15352. </member>
  15353. <member name="M:MailKit.Net.Imap.ImapFolder.SearchAsync(MailKit.Search.SearchOptions,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
  15354. <summary>
  15355. Asynchronously search the folder for messages matching the specified query.
  15356. </summary>
  15357. <remarks>
  15358. Searches the folder for messages matching the specified query,
  15359. returning only the specified search results.
  15360. </remarks>
  15361. <returns>The search results.</returns>
  15362. <param name="options">The search options.</param>
  15363. <param name="query">The search query.</param>
  15364. <param name="cancellationToken">The cancellation token.</param>
  15365. <exception cref="T:System.ArgumentNullException">
  15366. <paramref name="query"/> is <c>null</c>.
  15367. </exception>
  15368. <exception cref="T:System.NotSupportedException">
  15369. <para>One or more search terms in the <paramref name="query"/> are not supported by the IMAP server.</para>
  15370. <para>-or-</para>
  15371. <para>The IMAP server does not support the ESEARCH extension.</para>
  15372. </exception>
  15373. <exception cref="T:System.ObjectDisposedException">
  15374. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  15375. </exception>
  15376. <exception cref="T:MailKit.ServiceNotConnectedException">
  15377. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  15378. </exception>
  15379. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  15380. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  15381. </exception>
  15382. <exception cref="T:MailKit.FolderNotOpenException">
  15383. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  15384. </exception>
  15385. <exception cref="T:System.OperationCanceledException">
  15386. The operation was canceled via the cancellation token.
  15387. </exception>
  15388. <exception cref="T:System.IO.IOException">
  15389. An I/O error occurred.
  15390. </exception>
  15391. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  15392. The server's response contained unexpected tokens.
  15393. </exception>
  15394. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  15395. The server replied with a NO or BAD response.
  15396. </exception>
  15397. </member>
  15398. <member name="M:MailKit.Net.Imap.ImapFolder.Sort(System.String,System.Threading.CancellationToken)">
  15399. <summary>
  15400. Sort messages matching the specified query.
  15401. </summary>
  15402. <remarks>
  15403. Sends a <c>UID SORT</c> command with the specified query passed directly to the IMAP server
  15404. with no interpretation by MailKit. This means that the query may contain any arguments that a
  15405. <c>UID SORT</c> command is allowed to have according to the IMAP specifications and any
  15406. extensions that are supported, including <c>RETURN</c> parameters.
  15407. </remarks>
  15408. <returns>An array of matching UIDs.</returns>
  15409. <param name="query">The search query.</param>
  15410. <param name="cancellationToken">The cancellation token.</param>
  15411. <exception cref="T:System.ArgumentNullException">
  15412. <paramref name="query"/> is <c>null</c>.
  15413. </exception>
  15414. <exception cref="T:System.ArgumentException">
  15415. <paramref name="query"/> is an empty string.
  15416. </exception>
  15417. <exception cref="T:System.NotSupportedException">
  15418. The IMAP server does not support the SORT extension.
  15419. </exception>
  15420. <exception cref="T:System.ObjectDisposedException">
  15421. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  15422. </exception>
  15423. <exception cref="T:MailKit.ServiceNotConnectedException">
  15424. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  15425. </exception>
  15426. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  15427. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  15428. </exception>
  15429. <exception cref="T:MailKit.FolderNotOpenException">
  15430. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  15431. </exception>
  15432. <exception cref="T:System.OperationCanceledException">
  15433. The operation was canceled via the cancellation token.
  15434. </exception>
  15435. <exception cref="T:System.IO.IOException">
  15436. An I/O error occurred.
  15437. </exception>
  15438. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  15439. The server's response contained unexpected tokens.
  15440. </exception>
  15441. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  15442. The server replied with a NO or BAD response.
  15443. </exception>
  15444. </member>
  15445. <member name="M:MailKit.Net.Imap.ImapFolder.SortAsync(System.String,System.Threading.CancellationToken)">
  15446. <summary>
  15447. Asynchronously sort messages matching the specified query.
  15448. </summary>
  15449. <remarks>
  15450. Sends a <c>UID SORT</c> command with the specified query passed directly to the IMAP server
  15451. with no interpretation by MailKit. This means that the query may contain any arguments that a
  15452. <c>UID SORT</c> command is allowed to have according to the IMAP specifications and any
  15453. extensions that are supported, including <c>RETURN</c> parameters.
  15454. </remarks>
  15455. <returns>An array of matching UIDs.</returns>
  15456. <param name="query">The search query.</param>
  15457. <param name="cancellationToken">The cancellation token.</param>
  15458. <exception cref="T:System.ArgumentNullException">
  15459. <paramref name="query"/> is <c>null</c>.
  15460. </exception>
  15461. <exception cref="T:System.ArgumentException">
  15462. <paramref name="query"/> is an empty string.
  15463. </exception>
  15464. <exception cref="T:System.NotSupportedException">
  15465. The IMAP server does not support the SORT extension.
  15466. </exception>
  15467. <exception cref="T:System.ObjectDisposedException">
  15468. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  15469. </exception>
  15470. <exception cref="T:MailKit.ServiceNotConnectedException">
  15471. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  15472. </exception>
  15473. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  15474. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  15475. </exception>
  15476. <exception cref="T:MailKit.FolderNotOpenException">
  15477. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  15478. </exception>
  15479. <exception cref="T:System.OperationCanceledException">
  15480. The operation was canceled via the cancellation token.
  15481. </exception>
  15482. <exception cref="T:System.IO.IOException">
  15483. An I/O error occurred.
  15484. </exception>
  15485. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  15486. The server's response contained unexpected tokens.
  15487. </exception>
  15488. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  15489. The server replied with a NO or BAD response.
  15490. </exception>
  15491. </member>
  15492. <member name="M:MailKit.Net.Imap.ImapFolder.Sort(MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
  15493. <summary>
  15494. Sort messages matching the specified query.
  15495. </summary>
  15496. <remarks>
  15497. The returned array of unique identifiers will be sorted in the preferred order and
  15498. can be used with <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
  15499. </remarks>
  15500. <returns>An array of matching UIDs in the specified sort order.</returns>
  15501. <param name="query">The search query.</param>
  15502. <param name="orderBy">The sort order.</param>
  15503. <param name="cancellationToken">The cancellation token.</param>
  15504. <exception cref="T:System.ArgumentNullException">
  15505. <para><paramref name="query"/> is <c>null</c>.</para>
  15506. <para>-or-</para>
  15507. <para><paramref name="orderBy"/> is <c>null</c>.</para>
  15508. </exception>
  15509. <exception cref="T:System.ArgumentException">
  15510. <paramref name="orderBy"/> is empty.
  15511. </exception>
  15512. <exception cref="T:System.NotSupportedException">
  15513. <para>One or more search terms in the <paramref name="query"/> are not supported by the IMAP server.</para>
  15514. <para>-or-</para>
  15515. <para>The server does not support the SORT extension.</para>
  15516. </exception>
  15517. <exception cref="T:System.ObjectDisposedException">
  15518. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  15519. </exception>
  15520. <exception cref="T:MailKit.ServiceNotConnectedException">
  15521. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  15522. </exception>
  15523. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  15524. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  15525. </exception>
  15526. <exception cref="T:MailKit.FolderNotOpenException">
  15527. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  15528. </exception>
  15529. <exception cref="T:System.OperationCanceledException">
  15530. The operation was canceled via the cancellation token.
  15531. </exception>
  15532. <exception cref="T:System.IO.IOException">
  15533. An I/O error occurred.
  15534. </exception>
  15535. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  15536. The server's response contained unexpected tokens.
  15537. </exception>
  15538. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  15539. The server replied with a NO or BAD response.
  15540. </exception>
  15541. </member>
  15542. <member name="M:MailKit.Net.Imap.ImapFolder.SortAsync(MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
  15543. <summary>
  15544. Asynchronously sort messages matching the specified query.
  15545. </summary>
  15546. <remarks>
  15547. The returned array of unique identifiers will be sorted in the preferred order and
  15548. can be used with <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
  15549. </remarks>
  15550. <returns>An array of matching UIDs in the specified sort order.</returns>
  15551. <param name="query">The search query.</param>
  15552. <param name="orderBy">The sort order.</param>
  15553. <param name="cancellationToken">The cancellation token.</param>
  15554. <exception cref="T:System.ArgumentNullException">
  15555. <para><paramref name="query"/> is <c>null</c>.</para>
  15556. <para>-or-</para>
  15557. <para><paramref name="orderBy"/> is <c>null</c>.</para>
  15558. </exception>
  15559. <exception cref="T:System.ArgumentException">
  15560. <paramref name="orderBy"/> is empty.
  15561. </exception>
  15562. <exception cref="T:System.NotSupportedException">
  15563. <para>One or more search terms in the <paramref name="query"/> are not supported by the IMAP server.</para>
  15564. <para>-or-</para>
  15565. <para>The server does not support the SORT extension.</para>
  15566. </exception>
  15567. <exception cref="T:System.ObjectDisposedException">
  15568. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  15569. </exception>
  15570. <exception cref="T:MailKit.ServiceNotConnectedException">
  15571. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  15572. </exception>
  15573. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  15574. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  15575. </exception>
  15576. <exception cref="T:MailKit.FolderNotOpenException">
  15577. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  15578. </exception>
  15579. <exception cref="T:System.OperationCanceledException">
  15580. The operation was canceled via the cancellation token.
  15581. </exception>
  15582. <exception cref="T:System.IO.IOException">
  15583. An I/O error occurred.
  15584. </exception>
  15585. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  15586. The server's response contained unexpected tokens.
  15587. </exception>
  15588. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  15589. The server replied with a NO or BAD response.
  15590. </exception>
  15591. </member>
  15592. <member name="M:MailKit.Net.Imap.ImapFolder.Sort(MailKit.Search.SearchOptions,MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
  15593. <summary>
  15594. Sort messages matching the specified query.
  15595. </summary>
  15596. <remarks>
  15597. Searches the folder for messages matching the specified query, returning the search results in the specified sort order.
  15598. </remarks>
  15599. <returns>The search results.</returns>
  15600. <param name="options">The search options.</param>
  15601. <param name="query">The search query.</param>
  15602. <param name="orderBy">The sort order.</param>
  15603. <param name="cancellationToken">The cancellation token.</param>
  15604. <exception cref="T:System.ArgumentNullException">
  15605. <para><paramref name="query"/> is <c>null</c>.</para>
  15606. <para>-or-</para>
  15607. <para><paramref name="orderBy"/> is <c>null</c>.</para>
  15608. </exception>
  15609. <exception cref="T:System.ArgumentException">
  15610. <paramref name="orderBy"/> is empty.
  15611. </exception>
  15612. <exception cref="T:System.NotSupportedException">
  15613. <para>One or more search terms in the <paramref name="query"/> are not supported by the IMAP server.</para>
  15614. <para>-or-</para>
  15615. <para>The IMAP server does not support the ESORT extension.</para>
  15616. </exception>
  15617. <exception cref="T:System.ObjectDisposedException">
  15618. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  15619. </exception>
  15620. <exception cref="T:MailKit.ServiceNotConnectedException">
  15621. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  15622. </exception>
  15623. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  15624. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  15625. </exception>
  15626. <exception cref="T:MailKit.FolderNotOpenException">
  15627. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  15628. </exception>
  15629. <exception cref="T:System.OperationCanceledException">
  15630. The operation was canceled via the cancellation token.
  15631. </exception>
  15632. <exception cref="T:System.IO.IOException">
  15633. An I/O error occurred.
  15634. </exception>
  15635. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  15636. The server's response contained unexpected tokens.
  15637. </exception>
  15638. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  15639. The server replied with a NO or BAD response.
  15640. </exception>
  15641. </member>
  15642. <member name="M:MailKit.Net.Imap.ImapFolder.SortAsync(MailKit.Search.SearchOptions,MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
  15643. <summary>
  15644. Asynchronously sort messages matching the specified query.
  15645. </summary>
  15646. <remarks>
  15647. Searches the folder for messages matching the specified query, returning the search results in the specified sort order.
  15648. </remarks>
  15649. <returns>The search results.</returns>
  15650. <param name="options">The search options.</param>
  15651. <param name="query">The search query.</param>
  15652. <param name="orderBy">The sort order.</param>
  15653. <param name="cancellationToken">The cancellation token.</param>
  15654. <exception cref="T:System.ArgumentNullException">
  15655. <para><paramref name="query"/> is <c>null</c>.</para>
  15656. <para>-or-</para>
  15657. <para><paramref name="orderBy"/> is <c>null</c>.</para>
  15658. </exception>
  15659. <exception cref="T:System.ArgumentException">
  15660. <paramref name="orderBy"/> is empty.
  15661. </exception>
  15662. <exception cref="T:System.NotSupportedException">
  15663. <para>One or more search terms in the <paramref name="query"/> are not supported by the IMAP server.</para>
  15664. <para>-or-</para>
  15665. <para>The IMAP server does not support the ESORT extension.</para>
  15666. </exception>
  15667. <exception cref="T:System.ObjectDisposedException">
  15668. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  15669. </exception>
  15670. <exception cref="T:MailKit.ServiceNotConnectedException">
  15671. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  15672. </exception>
  15673. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  15674. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  15675. </exception>
  15676. <exception cref="T:MailKit.FolderNotOpenException">
  15677. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  15678. </exception>
  15679. <exception cref="T:System.OperationCanceledException">
  15680. The operation was canceled via the cancellation token.
  15681. </exception>
  15682. <exception cref="T:System.IO.IOException">
  15683. An I/O error occurred.
  15684. </exception>
  15685. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  15686. The server's response contained unexpected tokens.
  15687. </exception>
  15688. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  15689. The server replied with a NO or BAD response.
  15690. </exception>
  15691. </member>
  15692. <member name="M:MailKit.Net.Imap.ImapFolder.Thread(MailKit.ThreadingAlgorithm,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
  15693. <summary>
  15694. Thread the messages in the folder that match the search query using the specified threading algorithm.
  15695. </summary>
  15696. <remarks>
  15697. The <see cref="P:MailKit.MessageThread.UniqueId"/> can be used with methods such as
  15698. <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
  15699. </remarks>
  15700. <returns>An array of message threads.</returns>
  15701. <param name="algorithm">The threading algorithm to use.</param>
  15702. <param name="query">The search query.</param>
  15703. <param name="cancellationToken">The cancellation token.</param>
  15704. <exception cref="T:System.ArgumentOutOfRangeException">
  15705. <paramref name="algorithm"/> is not supported.
  15706. </exception>
  15707. <exception cref="T:System.ArgumentNullException">
  15708. <paramref name="query"/> is <c>null</c>.
  15709. </exception>
  15710. <exception cref="T:System.NotSupportedException">
  15711. <para>One or more search terms in the <paramref name="query"/> are not supported by the IMAP server.</para>
  15712. <para>-or-</para>
  15713. <para>The server does not support the THREAD extension.</para>
  15714. </exception>
  15715. <exception cref="T:System.ObjectDisposedException">
  15716. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  15717. </exception>
  15718. <exception cref="T:MailKit.ServiceNotConnectedException">
  15719. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  15720. </exception>
  15721. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  15722. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  15723. </exception>
  15724. <exception cref="T:MailKit.FolderNotOpenException">
  15725. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  15726. </exception>
  15727. <exception cref="T:System.OperationCanceledException">
  15728. The operation was canceled via the cancellation token.
  15729. </exception>
  15730. <exception cref="T:System.IO.IOException">
  15731. An I/O error occurred.
  15732. </exception>
  15733. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  15734. The server's response contained unexpected tokens.
  15735. </exception>
  15736. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  15737. The server replied with a NO or BAD response.
  15738. </exception>
  15739. </member>
  15740. <member name="M:MailKit.Net.Imap.ImapFolder.ThreadAsync(MailKit.ThreadingAlgorithm,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
  15741. <summary>
  15742. Asynchronously thread the messages in the folder that match the search query using the specified threading algorithm.
  15743. </summary>
  15744. <remarks>
  15745. The <see cref="P:MailKit.MessageThread.UniqueId"/> can be used with methods such as
  15746. <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
  15747. </remarks>
  15748. <returns>An array of message threads.</returns>
  15749. <param name="algorithm">The threading algorithm to use.</param>
  15750. <param name="query">The search query.</param>
  15751. <param name="cancellationToken">The cancellation token.</param>
  15752. <exception cref="T:System.ArgumentOutOfRangeException">
  15753. <paramref name="algorithm"/> is not supported.
  15754. </exception>
  15755. <exception cref="T:System.ArgumentNullException">
  15756. <paramref name="query"/> is <c>null</c>.
  15757. </exception>
  15758. <exception cref="T:System.NotSupportedException">
  15759. <para>One or more search terms in the <paramref name="query"/> are not supported by the IMAP server.</para>
  15760. <para>-or-</para>
  15761. <para>The server does not support the THREAD extension.</para>
  15762. </exception>
  15763. <exception cref="T:System.ObjectDisposedException">
  15764. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  15765. </exception>
  15766. <exception cref="T:MailKit.ServiceNotConnectedException">
  15767. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  15768. </exception>
  15769. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  15770. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  15771. </exception>
  15772. <exception cref="T:MailKit.FolderNotOpenException">
  15773. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  15774. </exception>
  15775. <exception cref="T:System.OperationCanceledException">
  15776. The operation was canceled via the cancellation token.
  15777. </exception>
  15778. <exception cref="T:System.IO.IOException">
  15779. An I/O error occurred.
  15780. </exception>
  15781. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  15782. The server's response contained unexpected tokens.
  15783. </exception>
  15784. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  15785. The server replied with a NO or BAD response.
  15786. </exception>
  15787. </member>
  15788. <member name="M:MailKit.Net.Imap.ImapFolder.Thread(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.ThreadingAlgorithm,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
  15789. <summary>
  15790. Thread the messages in the folder that match the search query using the specified threading algorithm.
  15791. </summary>
  15792. <remarks>
  15793. The <see cref="P:MailKit.MessageThread.UniqueId"/> can be used with methods such as
  15794. <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
  15795. </remarks>
  15796. <returns>An array of message threads.</returns>
  15797. <param name="uids">The subset of UIDs</param>
  15798. <param name="algorithm">The threading algorithm to use.</param>
  15799. <param name="query">The search query.</param>
  15800. <param name="cancellationToken">The cancellation token.</param>
  15801. <exception cref="T:System.ArgumentOutOfRangeException">
  15802. <paramref name="algorithm"/> is not supported.
  15803. </exception>
  15804. <exception cref="T:System.ArgumentNullException">
  15805. <para><paramref name="uids"/> is <c>null</c>.</para>
  15806. <para>-or-</para>
  15807. <para><paramref name="query"/> is <c>null</c>.</para>
  15808. </exception>
  15809. <exception cref="T:System.ArgumentException">
  15810. <para><paramref name="uids"/> is empty.</para>
  15811. <para>-or-</para>
  15812. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  15813. </exception>
  15814. <exception cref="T:System.NotSupportedException">
  15815. <para>One or more search terms in the <paramref name="query"/> are not supported by the IMAP server.</para>
  15816. <para>-or-</para>
  15817. <para>The server does not support the THREAD extension.</para>
  15818. </exception>
  15819. <exception cref="T:System.ObjectDisposedException">
  15820. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  15821. </exception>
  15822. <exception cref="T:MailKit.ServiceNotConnectedException">
  15823. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  15824. </exception>
  15825. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  15826. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  15827. </exception>
  15828. <exception cref="T:MailKit.FolderNotOpenException">
  15829. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  15830. </exception>
  15831. <exception cref="T:System.OperationCanceledException">
  15832. The operation was canceled via the cancellation token.
  15833. </exception>
  15834. <exception cref="T:System.IO.IOException">
  15835. An I/O error occurred.
  15836. </exception>
  15837. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  15838. The server's response contained unexpected tokens.
  15839. </exception>
  15840. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  15841. The server replied with a NO or BAD response.
  15842. </exception>
  15843. </member>
  15844. <member name="M:MailKit.Net.Imap.ImapFolder.ThreadAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.ThreadingAlgorithm,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
  15845. <summary>
  15846. Asynchronously thread the messages in the folder that match the search query using the specified threading algorithm.
  15847. </summary>
  15848. <remarks>
  15849. The <see cref="P:MailKit.MessageThread.UniqueId"/> can be used with methods such as
  15850. <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
  15851. </remarks>
  15852. <returns>An array of message threads.</returns>
  15853. <param name="uids">The subset of UIDs</param>
  15854. <param name="algorithm">The threading algorithm to use.</param>
  15855. <param name="query">The search query.</param>
  15856. <param name="cancellationToken">The cancellation token.</param>
  15857. <exception cref="T:System.ArgumentOutOfRangeException">
  15858. <paramref name="algorithm"/> is not supported.
  15859. </exception>
  15860. <exception cref="T:System.ArgumentNullException">
  15861. <para><paramref name="uids"/> is <c>null</c>.</para>
  15862. <para>-or-</para>
  15863. <para><paramref name="query"/> is <c>null</c>.</para>
  15864. </exception>
  15865. <exception cref="T:System.ArgumentException">
  15866. <para><paramref name="uids"/> is empty.</para>
  15867. <para>-or-</para>
  15868. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  15869. </exception>
  15870. <exception cref="T:System.NotSupportedException">
  15871. <para>One or more search terms in the <paramref name="query"/> are not supported by the IMAP server.</para>
  15872. <para>-or-</para>
  15873. <para>The server does not support the THREAD extension.</para>
  15874. </exception>
  15875. <exception cref="T:System.ObjectDisposedException">
  15876. The <see cref="T:MailKit.Net.Imap.ImapClient"/> has been disposed.
  15877. </exception>
  15878. <exception cref="T:MailKit.ServiceNotConnectedException">
  15879. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not connected.
  15880. </exception>
  15881. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  15882. The <see cref="T:MailKit.Net.Imap.ImapClient"/> is not authenticated.
  15883. </exception>
  15884. <exception cref="T:MailKit.FolderNotOpenException">
  15885. The <see cref="T:MailKit.Net.Imap.ImapFolder"/> is not currently open.
  15886. </exception>
  15887. <exception cref="T:System.OperationCanceledException">
  15888. The operation was canceled via the cancellation token.
  15889. </exception>
  15890. <exception cref="T:System.IO.IOException">
  15891. An I/O error occurred.
  15892. </exception>
  15893. <exception cref="T:MailKit.Net.Imap.ImapProtocolException">
  15894. The server's response contained unexpected tokens.
  15895. </exception>
  15896. <exception cref="T:MailKit.Net.Imap.ImapCommandException">
  15897. The server replied with a NO or BAD response.
  15898. </exception>
  15899. </member>
  15900. <member name="T:MailKit.Net.Imap.ImapFolderConstructorArgs">
  15901. <summary>
  15902. Constructor arguments for <see cref="T:MailKit.Net.Imap.ImapFolder"/>.
  15903. </summary>
  15904. <remarks>
  15905. Constructor arguments for <see cref="T:MailKit.Net.Imap.ImapFolder"/>.
  15906. </remarks>
  15907. </member>
  15908. <member name="M:MailKit.Net.Imap.ImapFolderConstructorArgs.#ctor(MailKit.Net.Imap.ImapEngine,System.String,MailKit.FolderAttributes,System.Char)">
  15909. <summary>
  15910. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapFolderConstructorArgs"/> class.
  15911. </summary>
  15912. <param name="engine">The IMAP command engine.</param>
  15913. <param name="encodedName">The encoded name.</param>
  15914. <param name="attributes">The attributes.</param>
  15915. <param name="delim">The directory separator.</param>
  15916. </member>
  15917. <member name="P:MailKit.Net.Imap.ImapFolderConstructorArgs.Attributes">
  15918. <summary>
  15919. Get the folder attributes.
  15920. </summary>
  15921. <remarks>
  15922. Gets the folder attributes.
  15923. </remarks>
  15924. <value>The folder attributes.</value>
  15925. </member>
  15926. <member name="P:MailKit.Net.Imap.ImapFolderConstructorArgs.DirectorySeparator">
  15927. <summary>
  15928. Get the directory separator.
  15929. </summary>
  15930. <remarks>
  15931. Gets the directory separator.
  15932. </remarks>
  15933. <value>The directory separator.</value>
  15934. </member>
  15935. <member name="P:MailKit.Net.Imap.ImapFolderConstructorArgs.FullName">
  15936. <summary>
  15937. Get the full name of the folder.
  15938. </summary>
  15939. <remarks>
  15940. This is the equivalent of the full path of a file on a file system.
  15941. </remarks>
  15942. <value>The full name of the folder.</value>
  15943. </member>
  15944. <member name="P:MailKit.Net.Imap.ImapFolderConstructorArgs.Name">
  15945. <summary>
  15946. Get the name of the folder.
  15947. </summary>
  15948. <remarks>
  15949. This is the equivalent of the file name of a file on the file system.
  15950. </remarks>
  15951. <value>The name of the folder.</value>
  15952. </member>
  15953. <member name="T:MailKit.Net.Imap.ImapImplementation">
  15954. <summary>
  15955. The details of an IMAP client or server implementation.
  15956. </summary>
  15957. <remarks>
  15958. Allows an IMAP client and server to share their implementation details
  15959. with each other for the purposes of debugging.
  15960. </remarks>
  15961. <example>
  15962. <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
  15963. </example>
  15964. </member>
  15965. <member name="M:MailKit.Net.Imap.ImapImplementation.#ctor">
  15966. <summary>
  15967. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapImplementation"/> class.
  15968. </summary>
  15969. <remarks>
  15970. Creates a new <see cref="T:MailKit.Net.Imap.ImapImplementation"/>.
  15971. </remarks>
  15972. <example>
  15973. <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
  15974. </example>
  15975. </member>
  15976. <member name="P:MailKit.Net.Imap.ImapImplementation.Properties">
  15977. <summary>
  15978. Get the identification properties.
  15979. </summary>
  15980. <remarks>
  15981. Gets the dictionary of raw identification properties.
  15982. </remarks>
  15983. <example>
  15984. <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
  15985. </example>
  15986. <value>The properties.</value>
  15987. </member>
  15988. <member name="P:MailKit.Net.Imap.ImapImplementation.Name">
  15989. <summary>
  15990. Get or set the name of the program.
  15991. </summary>
  15992. <remarks>
  15993. Gets or sets the name of the program.
  15994. </remarks>
  15995. <example>
  15996. <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
  15997. </example>
  15998. <value>The program name.</value>
  15999. </member>
  16000. <member name="P:MailKit.Net.Imap.ImapImplementation.Version">
  16001. <summary>
  16002. Get or set the version of the program.
  16003. </summary>
  16004. <remarks>
  16005. Gets or sets the version of the program.
  16006. </remarks>
  16007. <example>
  16008. <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
  16009. </example>
  16010. <value>The program version.</value>
  16011. </member>
  16012. <member name="P:MailKit.Net.Imap.ImapImplementation.OS">
  16013. <summary>
  16014. Get or set the name of the operating system.
  16015. </summary>
  16016. <remarks>
  16017. Gets or sets the name of the operating system.
  16018. </remarks>
  16019. <value>The name of the operation system.</value>
  16020. </member>
  16021. <member name="P:MailKit.Net.Imap.ImapImplementation.OSVersion">
  16022. <summary>
  16023. Get or set the version of the operating system.
  16024. </summary>
  16025. <remarks>
  16026. Gets or sets the version of the operating system.
  16027. </remarks>
  16028. <value>The version of the operation system.</value>
  16029. </member>
  16030. <member name="P:MailKit.Net.Imap.ImapImplementation.Vendor">
  16031. <summary>
  16032. Get or set the name of the vendor.
  16033. </summary>
  16034. <remarks>
  16035. Gets or sets the name of the vendor.
  16036. </remarks>
  16037. <value>The name of the vendor.</value>
  16038. </member>
  16039. <member name="P:MailKit.Net.Imap.ImapImplementation.SupportUrl">
  16040. <summary>
  16041. Get or set the support URL.
  16042. </summary>
  16043. <remarks>
  16044. Gets or sets the support URL.
  16045. </remarks>
  16046. <value>The support URL.</value>
  16047. </member>
  16048. <member name="P:MailKit.Net.Imap.ImapImplementation.Address">
  16049. <summary>
  16050. Get or set the postal address of the vendor.
  16051. </summary>
  16052. <remarks>
  16053. Gets or sets the postal address of the vendor.
  16054. </remarks>
  16055. <value>The postal address.</value>
  16056. </member>
  16057. <member name="P:MailKit.Net.Imap.ImapImplementation.ReleaseDate">
  16058. <summary>
  16059. Get or set the release date of the program.
  16060. </summary>
  16061. <remarks>
  16062. Gets or sets the release date of the program.
  16063. </remarks>
  16064. <value>The release date.</value>
  16065. </member>
  16066. <member name="P:MailKit.Net.Imap.ImapImplementation.Command">
  16067. <summary>
  16068. Get or set the command used to start the program.
  16069. </summary>
  16070. <remarks>
  16071. Gets or sets the command used to start the program.
  16072. </remarks>
  16073. <value>The command used to start the program.</value>
  16074. </member>
  16075. <member name="P:MailKit.Net.Imap.ImapImplementation.Arguments">
  16076. <summary>
  16077. Get or set the command-line arguments used to start the program.
  16078. </summary>
  16079. <remarks>
  16080. Gets or sets the command-line arguments used to start the program.
  16081. </remarks>
  16082. <value>The command-line arguments used to start the program.</value>
  16083. </member>
  16084. <member name="P:MailKit.Net.Imap.ImapImplementation.Environment">
  16085. <summary>
  16086. Get or set the environment variables available to the program.
  16087. </summary>
  16088. <remarks>
  16089. Get or set the environment variables available to the program.
  16090. </remarks>
  16091. <value>The environment variables.</value>
  16092. </member>
  16093. <member name="T:MailKit.Net.Imap.ImapProtocolException">
  16094. <summary>
  16095. An IMAP protocol exception.
  16096. </summary>
  16097. <remarks>
  16098. The exception that is thrown when there is an error communicating with an IMAP server. An
  16099. <see cref="T:MailKit.Net.Imap.ImapProtocolException"/> is typically fatal and requires the <see cref="T:MailKit.Net.Imap.ImapClient"/>
  16100. to be reconnected.
  16101. </remarks>
  16102. </member>
  16103. <member name="M:MailKit.Net.Imap.ImapProtocolException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  16104. <summary>
  16105. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapProtocolException"/> class.
  16106. </summary>
  16107. <remarks>
  16108. Creates a new <see cref="T:MailKit.Net.Imap.ImapProtocolException"/> from the serialized data.
  16109. </remarks>
  16110. <param name="info">The serialization info.</param>
  16111. <param name="context">The streaming context.</param>
  16112. <exception cref="T:System.ArgumentNullException">
  16113. <paramref name="info"/> is <c>null</c>.
  16114. </exception>
  16115. </member>
  16116. <member name="M:MailKit.Net.Imap.ImapProtocolException.#ctor(System.String,System.Exception)">
  16117. <summary>
  16118. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapProtocolException"/> class.
  16119. </summary>
  16120. <remarks>
  16121. Creates a new <see cref="T:MailKit.Net.Imap.ImapProtocolException"/>.
  16122. </remarks>
  16123. <param name="message">The error message.</param>
  16124. <param name="innerException">An inner exception.</param>
  16125. </member>
  16126. <member name="M:MailKit.Net.Imap.ImapProtocolException.#ctor(System.String)">
  16127. <summary>
  16128. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapProtocolException"/> class.
  16129. </summary>
  16130. <remarks>
  16131. Creates a new <see cref="T:MailKit.Net.Imap.ImapProtocolException"/>.
  16132. </remarks>
  16133. <param name="message">The error message.</param>
  16134. </member>
  16135. <member name="M:MailKit.Net.Imap.ImapProtocolException.#ctor">
  16136. <summary>
  16137. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapProtocolException"/> class.
  16138. </summary>
  16139. <remarks>
  16140. Creates a new <see cref="T:MailKit.Net.Imap.ImapProtocolException"/>.
  16141. </remarks>
  16142. </member>
  16143. <member name="P:MailKit.Net.Imap.ImapProtocolException.UnexpectedToken">
  16144. <summary>
  16145. Gets or sets whether or not this exception was thrown due to an unexpected token.
  16146. </summary>
  16147. <remarks>
  16148. Gets or sets whether or not this exception was thrown due to an unexpected token.
  16149. </remarks>
  16150. <value><c>true</c> if an unexpected token was encountered; otherwise, <c>false</c>.</value>
  16151. </member>
  16152. <member name="T:MailKit.Net.Imap.ImapStreamMode">
  16153. <summary>
  16154. An enumeration of the possible IMAP streaming modes.
  16155. </summary>
  16156. <remarks>
  16157. Normal operation is done in the <see cref="F:MailKit.Net.Imap.ImapStreamMode.Token"/> mode,
  16158. but when reading literal string data, the
  16159. <see cref="F:MailKit.Net.Imap.ImapStreamMode.Literal"/> mode should be used.
  16160. </remarks>
  16161. </member>
  16162. <member name="F:MailKit.Net.Imap.ImapStreamMode.Token">
  16163. <summary>
  16164. Reads 1 token at a time.
  16165. </summary>
  16166. </member>
  16167. <member name="F:MailKit.Net.Imap.ImapStreamMode.Literal">
  16168. <summary>
  16169. Reads literal string data.
  16170. </summary>
  16171. </member>
  16172. <member name="M:MailKit.Net.Imap.ImapStream.#ctor(System.IO.Stream,MailKit.IProtocolLogger)">
  16173. <summary>
  16174. Initializes a new instance of the <see cref="T:MailKit.Net.Imap.ImapStream"/> class.
  16175. </summary>
  16176. <remarks>
  16177. Creates a new <see cref="T:MailKit.Net.Imap.ImapStream"/>.
  16178. </remarks>
  16179. <param name="source">The underlying network stream.</param>
  16180. <param name="protocolLogger">The protocol logger.</param>
  16181. </member>
  16182. <member name="P:MailKit.Net.Imap.ImapStream.Stream">
  16183. <summary>
  16184. Get or sets the underlying network stream.
  16185. </summary>
  16186. <remarks>
  16187. Gets or sets the underlying network stream.
  16188. </remarks>
  16189. <value>The underlying network stream.</value>
  16190. </member>
  16191. <member name="P:MailKit.Net.Imap.ImapStream.Mode">
  16192. <summary>
  16193. Get or sets the mode used for reading.
  16194. </summary>
  16195. <remarks>
  16196. Gets or sets the mode used for reading.
  16197. </remarks>
  16198. <value>The mode.</value>
  16199. </member>
  16200. <member name="P:MailKit.Net.Imap.ImapStream.LiteralLength">
  16201. <summary>
  16202. Get the length of the literal.
  16203. </summary>
  16204. <remarks>
  16205. Gets the length of the literal.
  16206. </remarks>
  16207. <value>The length of the literal.</value>
  16208. </member>
  16209. <member name="P:MailKit.Net.Imap.ImapStream.IsConnected">
  16210. <summary>
  16211. Get whether or not the stream is connected.
  16212. </summary>
  16213. <remarks>
  16214. Gets whether or not the stream is connected.
  16215. </remarks>
  16216. <value><c>true</c> if the stream is connected; otherwise, <c>false</c>.</value>
  16217. </member>
  16218. <member name="P:MailKit.Net.Imap.ImapStream.CanRead">
  16219. <summary>
  16220. Get whether the stream supports reading.
  16221. </summary>
  16222. <remarks>
  16223. Gets whether the stream supports reading.
  16224. </remarks>
  16225. <value><c>true</c> if the stream supports reading; otherwise, <c>false</c>.</value>
  16226. </member>
  16227. <member name="P:MailKit.Net.Imap.ImapStream.CanWrite">
  16228. <summary>
  16229. Get whether the stream supports writing.
  16230. </summary>
  16231. <remarks>
  16232. Gets whether the stream supports writing.
  16233. </remarks>
  16234. <value><c>true</c> if the stream supports writing; otherwise, <c>false</c>.</value>
  16235. </member>
  16236. <member name="P:MailKit.Net.Imap.ImapStream.CanSeek">
  16237. <summary>
  16238. Get whether the stream supports seeking.
  16239. </summary>
  16240. <remarks>
  16241. Gets whether the stream supports seeking.
  16242. </remarks>
  16243. <value><c>true</c> if the stream supports seeking; otherwise, <c>false</c>.</value>
  16244. </member>
  16245. <member name="P:MailKit.Net.Imap.ImapStream.CanTimeout">
  16246. <summary>
  16247. Get whether the stream supports I/O timeouts.
  16248. </summary>
  16249. <remarks>
  16250. Gets whether the stream supports I/O timeouts.
  16251. </remarks>
  16252. <value><c>true</c> if the stream supports I/O timeouts; otherwise, <c>false</c>.</value>
  16253. </member>
  16254. <member name="P:MailKit.Net.Imap.ImapStream.ReadTimeout">
  16255. <summary>
  16256. Get or set a value, in milliseconds, that determines how long the stream will attempt to read before timing out.
  16257. </summary>
  16258. <remarks>
  16259. Gets or sets a value, in milliseconds, that determines how long the stream will attempt to read before timing out.
  16260. </remarks>
  16261. <returns>A value, in milliseconds, that determines how long the stream will attempt to read before timing out.</returns>
  16262. <value>The read timeout.</value>
  16263. </member>
  16264. <member name="P:MailKit.Net.Imap.ImapStream.WriteTimeout">
  16265. <summary>
  16266. Get or set a value, in milliseconds, that determines how long the stream will attempt to write before timing out.
  16267. </summary>
  16268. <remarks>
  16269. Gets or sets a value, in milliseconds, that determines how long the stream will attempt to write before timing out.
  16270. </remarks>
  16271. <returns>A value, in milliseconds, that determines how long the stream will attempt to write before timing out.</returns>
  16272. <value>The write timeout.</value>
  16273. </member>
  16274. <member name="P:MailKit.Net.Imap.ImapStream.Position">
  16275. <summary>
  16276. Get or set the position within the current stream.
  16277. </summary>
  16278. <remarks>
  16279. Gets or sets the position within the current stream.
  16280. </remarks>
  16281. <returns>The current position within the stream.</returns>
  16282. <value>The position of the stream.</value>
  16283. <exception cref="T:System.IO.IOException">
  16284. An I/O error occurred.
  16285. </exception>
  16286. <exception cref="T:System.NotSupportedException">
  16287. The stream does not support seeking.
  16288. </exception>
  16289. <exception cref="T:System.ObjectDisposedException">
  16290. The stream has been disposed.
  16291. </exception>
  16292. </member>
  16293. <member name="P:MailKit.Net.Imap.ImapStream.Length">
  16294. <summary>
  16295. Get the length of the stream, in bytes.
  16296. </summary>
  16297. <remarks>
  16298. Gets the length of the stream, in bytes.
  16299. </remarks>
  16300. <returns>A long value representing the length of the stream in bytes.</returns>
  16301. <value>The length of the stream.</value>
  16302. <exception cref="T:System.NotSupportedException">
  16303. The stream does not support seeking.
  16304. </exception>
  16305. <exception cref="T:System.ObjectDisposedException">
  16306. The stream has been disposed.
  16307. </exception>
  16308. </member>
  16309. <member name="M:MailKit.Net.Imap.ImapStream.Read(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  16310. <summary>
  16311. Reads a sequence of bytes from the stream and advances the position
  16312. within the stream by the number of bytes read.
  16313. </summary>
  16314. <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many
  16315. bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
  16316. <param name="buffer">The buffer.</param>
  16317. <param name="offset">The buffer offset.</param>
  16318. <param name="count">The number of bytes to read.</param>
  16319. <param name="cancellationToken">The cancellation token.</param>
  16320. <exception cref="T:System.ArgumentNullException">
  16321. <paramref name="buffer"/> is <c>null</c>.
  16322. </exception>
  16323. <exception cref="T:System.ArgumentOutOfRangeException">
  16324. <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
  16325. <para>-or-</para>
  16326. <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
  16327. at the specified <paramref name="offset"/>.</para>
  16328. </exception>
  16329. <exception cref="T:System.ObjectDisposedException">
  16330. The stream has been disposed.
  16331. </exception>
  16332. <exception cref="T:System.InvalidOperationException">
  16333. The stream is in token mode (see <see cref="F:MailKit.Net.Imap.ImapStreamMode.Token"/>).
  16334. </exception>
  16335. <exception cref="T:System.OperationCanceledException">
  16336. The operation was canceled via the cancellation token.
  16337. </exception>
  16338. <exception cref="T:System.IO.IOException">
  16339. An I/O error occurred.
  16340. </exception>
  16341. </member>
  16342. <member name="M:MailKit.Net.Imap.ImapStream.Read(System.Byte[],System.Int32,System.Int32)">
  16343. <summary>
  16344. Reads a sequence of bytes from the stream and advances the position
  16345. within the stream by the number of bytes read.
  16346. </summary>
  16347. <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many
  16348. bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
  16349. <param name="buffer">The buffer.</param>
  16350. <param name="offset">The buffer offset.</param>
  16351. <param name="count">The number of bytes to read.</param>
  16352. <exception cref="T:System.ArgumentNullException">
  16353. <paramref name="buffer"/> is <c>null</c>.
  16354. </exception>
  16355. <exception cref="T:System.ArgumentOutOfRangeException">
  16356. <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
  16357. <para>-or-</para>
  16358. <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
  16359. at the specified <paramref name="offset"/>.</para>
  16360. </exception>
  16361. <exception cref="T:System.ObjectDisposedException">
  16362. The stream has been disposed.
  16363. </exception>
  16364. <exception cref="T:System.InvalidOperationException">
  16365. The stream is in token mode (see <see cref="F:MailKit.Net.Imap.ImapStreamMode.Token"/>).
  16366. </exception>
  16367. <exception cref="T:System.IO.IOException">
  16368. An I/O error occurred.
  16369. </exception>
  16370. </member>
  16371. <member name="M:MailKit.Net.Imap.ImapStream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  16372. <summary>
  16373. Reads a sequence of bytes from the stream and advances the position
  16374. within the stream by the number of bytes read.
  16375. </summary>
  16376. <remarks>
  16377. Reads a sequence of bytes from the stream and advances the position
  16378. within the stream by the number of bytes read.
  16379. </remarks>
  16380. <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many
  16381. bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
  16382. <param name="buffer">The buffer.</param>
  16383. <param name="offset">The buffer offset.</param>
  16384. <param name="count">The number of bytes to read.</param>
  16385. <param name="cancellationToken">The cancellation token.</param>
  16386. <exception cref="T:System.ArgumentNullException">
  16387. <paramref name="buffer"/> is <c>null</c>.
  16388. </exception>
  16389. <exception cref="T:System.ArgumentOutOfRangeException">
  16390. <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
  16391. <para>-or-</para>
  16392. <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
  16393. at the specified <paramref name="offset"/>.</para>
  16394. </exception>
  16395. <exception cref="T:System.ObjectDisposedException">
  16396. The stream has been disposed.
  16397. </exception>
  16398. <exception cref="T:System.OperationCanceledException">
  16399. The operation was canceled via the cancellation token.
  16400. </exception>
  16401. <exception cref="T:System.IO.IOException">
  16402. An I/O error occurred.
  16403. </exception>
  16404. </member>
  16405. <member name="M:MailKit.Net.Imap.ImapStream.ReadToken(System.Threading.CancellationToken)">
  16406. <summary>
  16407. Reads the next available token from the stream.
  16408. </summary>
  16409. <returns>The token.</returns>
  16410. <param name="cancellationToken">The cancellation token.</param>
  16411. <exception cref="T:System.ObjectDisposedException">
  16412. The stream has been disposed.
  16413. </exception>
  16414. <exception cref="T:System.OperationCanceledException">
  16415. The operation was canceled via the cancellation token.
  16416. </exception>
  16417. <exception cref="T:System.IO.IOException">
  16418. An I/O error occurred.
  16419. </exception>
  16420. </member>
  16421. <member name="M:MailKit.Net.Imap.ImapStream.ReadTokenAsync(System.Threading.CancellationToken)">
  16422. <summary>
  16423. Asynchronously reads the next available token from the stream.
  16424. </summary>
  16425. <returns>The token.</returns>
  16426. <param name="cancellationToken">The cancellation token.</param>
  16427. <exception cref="T:System.ObjectDisposedException">
  16428. The stream has been disposed.
  16429. </exception>
  16430. <exception cref="T:System.OperationCanceledException">
  16431. The operation was canceled via the cancellation token.
  16432. </exception>
  16433. <exception cref="T:System.IO.IOException">
  16434. An I/O error occurred.
  16435. </exception>
  16436. </member>
  16437. <member name="M:MailKit.Net.Imap.ImapStream.UngetToken(MailKit.Net.Imap.ImapToken)">
  16438. <summary>
  16439. Ungets a token.
  16440. </summary>
  16441. <param name="token">The token.</param>
  16442. </member>
  16443. <member name="M:MailKit.Net.Imap.ImapStream.ReadLine(System.IO.Stream,System.Threading.CancellationToken)">
  16444. <summary>
  16445. Reads a single line of input from the stream.
  16446. </summary>
  16447. <remarks>
  16448. This method should be called in a loop until it returns <c>true</c>.
  16449. </remarks>
  16450. <returns><c>true</c>, if reading the line is complete, <c>false</c> otherwise.</returns>
  16451. <param name="ostream">The output stream to write the line data into.</param>
  16452. <param name="cancellationToken">The cancellation token.</param>
  16453. <exception cref="T:System.ObjectDisposedException">
  16454. The stream has been disposed.
  16455. </exception>
  16456. <exception cref="T:System.OperationCanceledException">
  16457. The operation was canceled via the cancellation token.
  16458. </exception>
  16459. <exception cref="T:System.IO.IOException">
  16460. An I/O error occurred.
  16461. </exception>
  16462. </member>
  16463. <member name="M:MailKit.Net.Imap.ImapStream.ReadLineAsync(System.IO.Stream,System.Threading.CancellationToken)">
  16464. <summary>
  16465. Asynchronously reads a single line of input from the stream.
  16466. </summary>
  16467. <remarks>
  16468. This method should be called in a loop until it returns <c>true</c>.
  16469. </remarks>
  16470. <returns><c>true</c>, if reading the line is complete, <c>false</c> otherwise.</returns>
  16471. <param name="ostream">The output stream to write the line data into.</param>
  16472. <param name="cancellationToken">The cancellation token.</param>
  16473. <exception cref="T:System.ObjectDisposedException">
  16474. The stream has been disposed.
  16475. </exception>
  16476. <exception cref="T:System.OperationCanceledException">
  16477. The operation was canceled via the cancellation token.
  16478. </exception>
  16479. <exception cref="T:System.IO.IOException">
  16480. An I/O error occurred.
  16481. </exception>
  16482. </member>
  16483. <member name="M:MailKit.Net.Imap.ImapStream.Write(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  16484. <summary>
  16485. Writes a sequence of bytes to the stream and advances the current
  16486. position within this stream by the number of bytes written.
  16487. </summary>
  16488. <remarks>
  16489. Writes a sequence of bytes to the stream and advances the current
  16490. position within this stream by the number of bytes written.
  16491. </remarks>
  16492. <param name='buffer'>The buffer to write.</param>
  16493. <param name='offset'>The offset of the first byte to write.</param>
  16494. <param name='count'>The number of bytes to write.</param>
  16495. <param name="cancellationToken">The cancellation token.</param>
  16496. <exception cref="T:System.ArgumentNullException">
  16497. <paramref name="buffer"/> is <c>null</c>.
  16498. </exception>
  16499. <exception cref="T:System.ArgumentOutOfRangeException">
  16500. <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
  16501. <para>-or-</para>
  16502. <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
  16503. at the specified <paramref name="offset"/>.</para>
  16504. </exception>
  16505. <exception cref="T:System.ObjectDisposedException">
  16506. The stream has been disposed.
  16507. </exception>
  16508. <exception cref="T:System.NotSupportedException">
  16509. The stream does not support writing.
  16510. </exception>
  16511. <exception cref="T:System.OperationCanceledException">
  16512. The operation was canceled via the cancellation token.
  16513. </exception>
  16514. <exception cref="T:System.IO.IOException">
  16515. An I/O error occurred.
  16516. </exception>
  16517. </member>
  16518. <member name="M:MailKit.Net.Imap.ImapStream.Write(System.Byte[],System.Int32,System.Int32)">
  16519. <summary>
  16520. Writes a sequence of bytes to the stream and advances the current
  16521. position within this stream by the number of bytes written.
  16522. </summary>
  16523. <remarks>
  16524. Writes a sequence of bytes to the stream and advances the current
  16525. position within this stream by the number of bytes written.
  16526. </remarks>
  16527. <param name='buffer'>The buffer to write.</param>
  16528. <param name='offset'>The offset of the first byte to write.</param>
  16529. <param name='count'>The number of bytes to write.</param>
  16530. <exception cref="T:System.ArgumentNullException">
  16531. <paramref name="buffer"/> is <c>null</c>.
  16532. </exception>
  16533. <exception cref="T:System.ArgumentOutOfRangeException">
  16534. <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
  16535. <para>-or-</para>
  16536. <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
  16537. at the specified <paramref name="offset"/>.</para>
  16538. </exception>
  16539. <exception cref="T:System.ObjectDisposedException">
  16540. The stream has been disposed.
  16541. </exception>
  16542. <exception cref="T:System.NotSupportedException">
  16543. The stream does not support writing.
  16544. </exception>
  16545. <exception cref="T:System.IO.IOException">
  16546. An I/O error occurred.
  16547. </exception>
  16548. </member>
  16549. <member name="M:MailKit.Net.Imap.ImapStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  16550. <summary>
  16551. Writes a sequence of bytes to the stream and advances the current
  16552. position within this stream by the number of bytes written.
  16553. </summary>
  16554. <remarks>
  16555. Writes a sequence of bytes to the stream and advances the current
  16556. position within this stream by the number of bytes written.
  16557. </remarks>
  16558. <returns>A task that represents the asynchronous write operation.</returns>
  16559. <param name='buffer'>The buffer to write.</param>
  16560. <param name='offset'>The offset of the first byte to write.</param>
  16561. <param name='count'>The number of bytes to write.</param>
  16562. <param name="cancellationToken">The cancellation token.</param>
  16563. <exception cref="T:System.ArgumentNullException">
  16564. <paramref name="buffer"/> is <c>null</c>.
  16565. </exception>
  16566. <exception cref="T:System.ArgumentOutOfRangeException">
  16567. <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
  16568. <para>-or-</para>
  16569. <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
  16570. at the specified <paramref name="offset"/>.</para>
  16571. </exception>
  16572. <exception cref="T:System.ObjectDisposedException">
  16573. The stream has been disposed.
  16574. </exception>
  16575. <exception cref="T:System.NotSupportedException">
  16576. The stream does not support writing.
  16577. </exception>
  16578. <exception cref="T:System.OperationCanceledException">
  16579. The operation was canceled via the cancellation token.
  16580. </exception>
  16581. <exception cref="T:System.IO.IOException">
  16582. An I/O error occurred.
  16583. </exception>
  16584. </member>
  16585. <member name="M:MailKit.Net.Imap.ImapStream.Flush(System.Threading.CancellationToken)">
  16586. <summary>
  16587. Clears all output buffers for this stream and causes any buffered data to be written
  16588. to the underlying device.
  16589. </summary>
  16590. <remarks>
  16591. Clears all output buffers for this stream and causes any buffered data to be written
  16592. to the underlying device.
  16593. </remarks>
  16594. <param name="cancellationToken">The cancellation token.</param>
  16595. <exception cref="T:System.ObjectDisposedException">
  16596. The stream has been disposed.
  16597. </exception>
  16598. <exception cref="T:System.NotSupportedException">
  16599. The stream does not support writing.
  16600. </exception>
  16601. <exception cref="T:System.OperationCanceledException">
  16602. The operation was canceled via the cancellation token.
  16603. </exception>
  16604. <exception cref="T:System.IO.IOException">
  16605. An I/O error occurred.
  16606. </exception>
  16607. </member>
  16608. <member name="M:MailKit.Net.Imap.ImapStream.Flush">
  16609. <summary>
  16610. Clears all output buffers for this stream and causes any buffered data to be written
  16611. to the underlying device.
  16612. </summary>
  16613. <remarks>
  16614. Clears all output buffers for this stream and causes any buffered data to be written
  16615. to the underlying device.
  16616. </remarks>
  16617. <exception cref="T:System.ObjectDisposedException">
  16618. The stream has been disposed.
  16619. </exception>
  16620. <exception cref="T:System.NotSupportedException">
  16621. The stream does not support writing.
  16622. </exception>
  16623. <exception cref="T:System.IO.IOException">
  16624. An I/O error occurred.
  16625. </exception>
  16626. </member>
  16627. <member name="M:MailKit.Net.Imap.ImapStream.FlushAsync(System.Threading.CancellationToken)">
  16628. <summary>
  16629. Clears all buffers for this stream and causes any buffered data to be written
  16630. to the underlying device.
  16631. </summary>
  16632. <remarks>
  16633. Clears all buffers for this stream and causes any buffered data to be written
  16634. to the underlying device.
  16635. </remarks>
  16636. <returns>A task that represents the asynchronous flush operation.</returns>
  16637. <param name="cancellationToken">The cancellation token.</param>
  16638. <exception cref="T:System.ObjectDisposedException">
  16639. The stream has been disposed.
  16640. </exception>
  16641. <exception cref="T:System.NotSupportedException">
  16642. The stream does not support writing.
  16643. </exception>
  16644. <exception cref="T:System.OperationCanceledException">
  16645. The operation was canceled via the cancellation token.
  16646. </exception>
  16647. <exception cref="T:System.IO.IOException">
  16648. An I/O error occurred.
  16649. </exception>
  16650. </member>
  16651. <member name="M:MailKit.Net.Imap.ImapStream.Seek(System.Int64,System.IO.SeekOrigin)">
  16652. <summary>
  16653. Sets the position within the current stream.
  16654. </summary>
  16655. <remarks>
  16656. It is not possible to seek within a <see cref="T:MailKit.Net.Imap.ImapStream"/>.
  16657. </remarks>
  16658. <returns>The new position within the stream.</returns>
  16659. <param name="offset">The offset into the stream relative to the <paramref name="origin"/>.</param>
  16660. <param name="origin">The origin to seek from.</param>
  16661. <exception cref="T:System.NotSupportedException">
  16662. The stream does not support seeking.
  16663. </exception>
  16664. </member>
  16665. <member name="M:MailKit.Net.Imap.ImapStream.SetLength(System.Int64)">
  16666. <summary>
  16667. Sets the length of the stream.
  16668. </summary>
  16669. <remarks>
  16670. It is not possible to set the length of a <see cref="T:MailKit.Net.Imap.ImapStream"/>.
  16671. </remarks>
  16672. <param name="value">The desired length of the stream in bytes.</param>
  16673. <exception cref="T:System.NotSupportedException">
  16674. The stream does not support setting the length.
  16675. </exception>
  16676. </member>
  16677. <member name="M:MailKit.Net.Imap.ImapStream.Dispose(System.Boolean)">
  16678. <summary>
  16679. Releases the unmanaged resources used by the <see cref="T:MailKit.Net.Imap.ImapStream"/> and
  16680. optionally releases the managed resources.
  16681. </summary>
  16682. <remarks>
  16683. Releases the unmanaged resources used by the <see cref="T:MailKit.Net.Imap.ImapStream"/> and
  16684. optionally releases the managed resources.
  16685. </remarks>
  16686. <param name="disposing"><c>true</c> to release both managed and unmanaged resources;
  16687. <c>false</c> to release only the unmanaged resources.</param>
  16688. </member>
  16689. <member name="T:MailKit.Net.Imap.ImapUtils">
  16690. <summary>
  16691. IMAP utility functions.
  16692. </summary>
  16693. </member>
  16694. <member name="M:MailKit.Net.Imap.ImapUtils.FormatInternalDate(System.DateTimeOffset)">
  16695. <summary>
  16696. Formats a date in a format suitable for use with the APPEND command.
  16697. </summary>
  16698. <returns>The formatted date string.</returns>
  16699. <param name="date">The date.</param>
  16700. </member>
  16701. <member name="M:MailKit.Net.Imap.ImapUtils.ParseInternalDate(System.String)">
  16702. <summary>
  16703. Parses the internal date string.
  16704. </summary>
  16705. <returns>The date.</returns>
  16706. <param name="text">The text to parse.</param>
  16707. </member>
  16708. <member name="M:MailKit.Net.Imap.ImapUtils.FormatAnnotations(System.Text.StringBuilder,System.Collections.Generic.IList{MailKit.Annotation},System.Collections.Generic.List{System.Object},System.Boolean)">
  16709. <summary>
  16710. Formats a list of annotations for a STORE or APPEND command.
  16711. </summary>
  16712. <param name="command">The command builder.</param>
  16713. <param name="annotations">The annotations.</param>
  16714. <param name="args">the argument list.</param>
  16715. <param name="throwOnError">Throw an exception if there are any annotations without properties.</param>
  16716. </member>
  16717. <member name="M:MailKit.Net.Imap.ImapUtils.FormatIndexSet(System.Collections.Generic.IList{System.Int32})">
  16718. <summary>
  16719. Formats the array of indexes as a string suitable for use with IMAP commands.
  16720. </summary>
  16721. <returns>The index set.</returns>
  16722. <param name="indexes">The indexes.</param>
  16723. <exception cref="T:System.ArgumentNullException">
  16724. <paramref name="indexes"/> is <c>null</c>.
  16725. </exception>
  16726. <exception cref="T:System.ArgumentOutOfRangeException">
  16727. One or more of the indexes has a negative value.
  16728. </exception>
  16729. </member>
  16730. <member name="M:MailKit.Net.Imap.ImapUtils.ParseImplementationAsync(MailKit.Net.Imap.ImapEngine,MailKit.Net.Imap.ImapCommand,System.Int32,System.Boolean)">
  16731. <summary>
  16732. Parses an untagged ID response.
  16733. </summary>
  16734. <param name="engine">The IMAP engine.</param>
  16735. <param name="ic">The IMAP command.</param>
  16736. <param name="index">The index.</param>
  16737. <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
  16738. </member>
  16739. <member name="M:MailKit.Net.Imap.ImapUtils.CanonicalizeMailboxName(System.String,System.Char)">
  16740. <summary>
  16741. Canonicalize the name of the mailbox.
  16742. </summary>
  16743. <remarks>
  16744. Canonicalizes the name of the mailbox by replacing various
  16745. capitalizations of "INBOX" with the literal "INBOX" string.
  16746. </remarks>
  16747. <returns>The mailbox name.</returns>
  16748. <param name="mailboxName">The encoded mailbox name.</param>
  16749. <param name="directorySeparator">The directory separator.</param>
  16750. </member>
  16751. <member name="M:MailKit.Net.Imap.ImapUtils.IsInbox(System.String)">
  16752. <summary>
  16753. Determines whether the specified mailbox is the Inbox.
  16754. </summary>
  16755. <returns><c>true</c> if the specified mailbox name is the Inbox; otherwise, <c>false</c>.</returns>
  16756. <param name="mailboxName">The mailbox name.</param>
  16757. </member>
  16758. <member name="M:MailKit.Net.Imap.ImapUtils.ParseFolderListAsync(MailKit.Net.Imap.ImapEngine,System.Collections.Generic.List{MailKit.Net.Imap.ImapFolder},System.Boolean,System.Boolean,System.Boolean,System.Threading.CancellationToken)">
  16759. <summary>
  16760. Parses an untagged LIST or LSUB response.
  16761. </summary>
  16762. <param name="engine">The IMAP engine.</param>
  16763. <param name="list">The list of folders to be populated.</param>
  16764. <param name="isLsub"><c>true</c> if it is an LSUB response; otherwise, <c>false</c>.</param>
  16765. <param name="returnsSubscribed"><c>true</c> if the LIST response is expected to return \Subscribed flags; otherwise, <c>false</c>.</param>
  16766. <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
  16767. <param name="cancellationToken">The cancellation token.</param>
  16768. </member>
  16769. <member name="M:MailKit.Net.Imap.ImapUtils.ParseFolderListAsync(MailKit.Net.Imap.ImapEngine,MailKit.Net.Imap.ImapCommand,System.Int32,System.Boolean)">
  16770. <summary>
  16771. Parses an untagged LIST or LSUB response.
  16772. </summary>
  16773. <param name="engine">The IMAP engine.</param>
  16774. <param name="ic">The IMAP command.</param>
  16775. <param name="index">The index.</param>
  16776. <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
  16777. </member>
  16778. <member name="M:MailKit.Net.Imap.ImapUtils.ParseMetadataAsync(MailKit.Net.Imap.ImapEngine,MailKit.MetadataCollection,System.Boolean,System.Threading.CancellationToken)">
  16779. <summary>
  16780. Parses an untagged METADATA response.
  16781. </summary>
  16782. <returns>The encoded name of the folder that the metadata belongs to.</returns>
  16783. <param name="engine">The IMAP engine.</param>
  16784. <param name="metadata">The metadata collection to be populated.</param>
  16785. <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
  16786. <param name="cancellationToken">The cancellation token.</param>
  16787. </member>
  16788. <member name="M:MailKit.Net.Imap.ImapUtils.ParseMetadataAsync(MailKit.Net.Imap.ImapEngine,MailKit.Net.Imap.ImapCommand,System.Int32,System.Boolean)">
  16789. <summary>
  16790. Parses an untagged METADATA response.
  16791. </summary>
  16792. <param name="engine">The IMAP engine.</param>
  16793. <param name="ic">The IMAP command.</param>
  16794. <param name="index">The index.</param>
  16795. <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
  16796. </member>
  16797. <member name="M:MailKit.Net.Imap.ImapUtils.ParseEnvelopeAsync(MailKit.Net.Imap.ImapEngine,System.Boolean,System.Threading.CancellationToken)">
  16798. <summary>
  16799. Parses the ENVELOPE parenthesized list.
  16800. </summary>
  16801. <returns>The envelope.</returns>
  16802. <param name="engine">The IMAP engine.</param>
  16803. <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
  16804. <param name="cancellationToken">The cancellation token.</param>
  16805. </member>
  16806. <member name="M:MailKit.Net.Imap.ImapUtils.FormatFlagsList(MailKit.MessageFlags,System.Int32)">
  16807. <summary>
  16808. Formats a flags list suitable for use with the APPEND command.
  16809. </summary>
  16810. <returns>The flags list string.</returns>
  16811. <param name="flags">The message flags.</param>
  16812. <param name="numUserFlags">The number of user-defined flags.</param>
  16813. </member>
  16814. <member name="M:MailKit.Net.Imap.ImapUtils.ParseFlagsListAsync(MailKit.Net.Imap.ImapEngine,System.String,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  16815. <summary>
  16816. Parses the flags list.
  16817. </summary>
  16818. <returns>The message flags.</returns>
  16819. <param name="engine">The IMAP engine.</param>
  16820. <param name="name">The name of the flags being parsed.</param>
  16821. <param name="keywords">A hash set of user-defined message flags that will be populated if non-null.</param>
  16822. <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
  16823. <param name="cancellationToken">The cancellation token.</param>
  16824. </member>
  16825. <member name="M:MailKit.Net.Imap.ImapUtils.ParseAnnotationsAsync(MailKit.Net.Imap.ImapEngine,System.Boolean,System.Threading.CancellationToken)">
  16826. <summary>
  16827. Parses the ANNOTATION list.
  16828. </summary>
  16829. <returns>The list of annotations.</returns>
  16830. <param name="engine">The IMAP engine.</param>
  16831. <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
  16832. <param name="cancellationToken">The cancellation token.</param>
  16833. </member>
  16834. <member name="M:MailKit.Net.Imap.ImapUtils.ParseLabelsListAsync(MailKit.Net.Imap.ImapEngine,System.Boolean,System.Threading.CancellationToken)">
  16835. <summary>
  16836. Parses the X-GM-LABELS list.
  16837. </summary>
  16838. <returns>The message labels.</returns>
  16839. <param name="engine">The IMAP engine.</param>
  16840. <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
  16841. <param name="cancellationToken">The cancellation token.</param>
  16842. </member>
  16843. <member name="M:MailKit.Net.Imap.ImapUtils.ParseThreadsAsync(MailKit.Net.Imap.ImapEngine,System.UInt32,System.Boolean,System.Threading.CancellationToken)">
  16844. <summary>
  16845. Parses the threads.
  16846. </summary>
  16847. <returns>The threads.</returns>
  16848. <param name="engine">The IMAP engine.</param>
  16849. <param name="uidValidity">The UIDVALIDITY of the folder.</param>
  16850. <param name="doAsync">Whether or not asynchronous IO methods should be used.</param>
  16851. <param name="cancellationToken">The cancellation token.</param>
  16852. </member>
  16853. <member name="T:MailKit.Net.Pop3.Pop3Client">
  16854. <summary>
  16855. A POP3 client that can be used to retrieve messages from a server.
  16856. </summary>
  16857. <remarks>
  16858. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> class supports both the "pop" and "pops" protocols. The "pop" protocol
  16859. makes a clear-text connection to the POP3 server and does not use SSL or TLS unless the POP3 server
  16860. supports the <a href="https://tools.ietf.org/html/rfc2595">STLS</a> extension. The "pops" protocol,
  16861. however, connects to the POP3 server using an SSL-wrapped connection.
  16862. </remarks>
  16863. <example>
  16864. <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadMessages"/>
  16865. </example>
  16866. </member>
  16867. <member name="M:MailKit.Net.Pop3.Pop3Client.AuthenticateAsync(MailKit.Security.SaslMechanism,System.Threading.CancellationToken)">
  16868. <summary>
  16869. Asynchronously authenticate using the specified SASL mechanism.
  16870. </summary>
  16871. <remarks>
  16872. <para>Authenticates using the specified SASL mechanism.</para>
  16873. <para>For a list of available SASL authentication mechanisms supported by the server,
  16874. check the <see cref="P:MailKit.Net.Pop3.Pop3Client.AuthenticationMechanisms"/> property after the service has been
  16875. connected.</para>
  16876. </remarks>
  16877. <returns>An asynchronous task context.</returns>
  16878. <param name="mechanism">The SASL mechanism.</param>
  16879. <param name="cancellationToken">The cancellation token.</param>
  16880. <exception cref="T:System.ArgumentNullException">
  16881. <paramref name="mechanism"/> is <c>null</c>.
  16882. </exception>
  16883. <exception cref="T:System.ObjectDisposedException">
  16884. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  16885. </exception>
  16886. <exception cref="T:MailKit.ServiceNotConnectedException">
  16887. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  16888. </exception>
  16889. <exception cref="T:System.InvalidOperationException">
  16890. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is already authenticated.
  16891. </exception>
  16892. <exception cref="T:System.OperationCanceledException">
  16893. The operation was canceled via the cancellation token.
  16894. </exception>
  16895. <exception cref="T:MailKit.Security.AuthenticationException">
  16896. Authentication using the supplied credentials has failed.
  16897. </exception>
  16898. <exception cref="T:MailKit.Security.SaslException">
  16899. A SASL authentication error occurred.
  16900. </exception>
  16901. <exception cref="T:System.IO.IOException">
  16902. An I/O error occurred.
  16903. </exception>
  16904. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  16905. A POP3 command failed.
  16906. </exception>
  16907. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  16908. An POP3 protocol error occurred.
  16909. </exception>
  16910. </member>
  16911. <member name="M:MailKit.Net.Pop3.Pop3Client.AuthenticateAsync(System.Text.Encoding,System.Net.ICredentials,System.Threading.CancellationToken)">
  16912. <summary>
  16913. Asynchronously authenticates using the supplied credentials.
  16914. </summary>
  16915. <remarks>
  16916. <para>If the POP3 server supports the APOP authentication mechanism,
  16917. then APOP is used.</para>
  16918. <para>If the APOP authentication mechanism is not supported and the
  16919. server supports one or more SASL authentication mechanisms, then
  16920. the SASL mechanisms that both the client and server support are tried
  16921. in order of greatest security to weakest security. Once a SASL
  16922. authentication mechanism is found that both client and server support,
  16923. the credentials are used to authenticate.</para>
  16924. <para>If the server does not support SASL or if no common SASL mechanisms
  16925. can be found, then the <c>USER</c> and <c>PASS</c> commands are used as a
  16926. fallback.</para>
  16927. <note type="tip"><para>To prevent the usage of certain authentication mechanisms,
  16928. simply remove them from the <see cref="P:MailKit.Net.Pop3.Pop3Client.AuthenticationMechanisms"/> hash set
  16929. before calling this method.</para>
  16930. <para>In the case of the APOP authentication mechanism, remove it from the
  16931. <see cref="P:MailKit.Net.Pop3.Pop3Client.Capabilities"/> property instead.</para></note>
  16932. </remarks>
  16933. <returns>An asynchronous task context.</returns>
  16934. <param name="encoding">The text encoding to use for the user's credentials.</param>
  16935. <param name="credentials">The user's credentials.</param>
  16936. <param name="cancellationToken">The cancellation token.</param>
  16937. <exception cref="T:System.ArgumentNullException">
  16938. <para><paramref name="encoding"/> is <c>null</c>.</para>
  16939. <para>-or-</para>
  16940. <para><paramref name="credentials"/> is <c>null</c>.</para>
  16941. </exception>
  16942. <exception cref="T:System.ObjectDisposedException">
  16943. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  16944. </exception>
  16945. <exception cref="T:MailKit.ServiceNotConnectedException">
  16946. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  16947. </exception>
  16948. <exception cref="T:System.InvalidOperationException">
  16949. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is already authenticated.
  16950. </exception>
  16951. <exception cref="T:System.OperationCanceledException">
  16952. The operation was canceled via the cancellation token.
  16953. </exception>
  16954. <exception cref="T:MailKit.Security.AuthenticationException">
  16955. Authentication using the supplied credentials has failed.
  16956. </exception>
  16957. <exception cref="T:MailKit.Security.SaslException">
  16958. A SASL authentication error occurred.
  16959. </exception>
  16960. <exception cref="T:System.IO.IOException">
  16961. An I/O error occurred.
  16962. </exception>
  16963. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  16964. A POP3 command failed.
  16965. </exception>
  16966. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  16967. An POP3 protocol error occurred.
  16968. </exception>
  16969. </member>
  16970. <member name="M:MailKit.Net.Pop3.Pop3Client.ConnectAsync(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
  16971. <summary>
  16972. Asynchronously establish a connection to the specified POP3 or POP3/S server.
  16973. </summary>
  16974. <remarks>
  16975. <para>Establishes a connection to the specified POP3 or POP3/S server.</para>
  16976. <para>If the <paramref name="port"/> has a value of <c>0</c>, then the
  16977. <paramref name="options"/> parameter is used to determine the default port to
  16978. connect to. The default port used with <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>
  16979. is <c>995</c>. All other values will use a default port of <c>110</c>.</para>
  16980. <para>If the <paramref name="options"/> has a value of
  16981. <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
  16982. to determine the default security options. If the <paramref name="port"/> has a value
  16983. of <c>995</c>, then the default options used will be
  16984. <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
  16985. <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
  16986. <para>Once a connection is established, properties such as
  16987. <see cref="P:MailKit.Net.Pop3.Pop3Client.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Pop3.Pop3Client.Capabilities"/> will be
  16988. populated.</para>
  16989. </remarks>
  16990. <example>
  16991. <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadMessages"/>
  16992. </example>
  16993. <returns>An asynchronous task context.</returns>
  16994. <param name="host">The host name to connect to.</param>
  16995. <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
  16996. <param name="options">The secure socket options to when connecting.</param>
  16997. <param name="cancellationToken">The cancellation token.</param>
  16998. <exception cref="T:System.ArgumentNullException">
  16999. <paramref name="host"/> is <c>null</c>.
  17000. </exception>
  17001. <exception cref="T:System.ArgumentOutOfRangeException">
  17002. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  17003. </exception>
  17004. <exception cref="T:System.ArgumentException">
  17005. The <paramref name="host"/> is a zero-length string.
  17006. </exception>
  17007. <exception cref="T:System.ObjectDisposedException">
  17008. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  17009. </exception>
  17010. <exception cref="T:System.InvalidOperationException">
  17011. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is already connected.
  17012. </exception>
  17013. <exception cref="T:System.OperationCanceledException">
  17014. The operation was canceled via the cancellation token.
  17015. </exception>
  17016. <exception cref="T:System.NotSupportedException">
  17017. <paramref name="options"/> was set to
  17018. <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
  17019. and the POP3 server does not support the STLS extension.
  17020. </exception>
  17021. <exception cref="T:System.Net.Sockets.SocketException">
  17022. A socket error occurred trying to connect to the remote host.
  17023. </exception>
  17024. <exception cref="T:MailKit.Security.SslHandshakeException">
  17025. An error occurred during the SSL/TLS negotiations.
  17026. </exception>
  17027. <exception cref="T:System.IO.IOException">
  17028. An I/O error occurred.
  17029. </exception>
  17030. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  17031. A POP3 command failed.
  17032. </exception>
  17033. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  17034. A POP3 protocol error occurred.
  17035. </exception>
  17036. </member>
  17037. <member name="M:MailKit.Net.Pop3.Pop3Client.ConnectAsync(System.Net.Sockets.Socket,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
  17038. <summary>
  17039. Asynchronously establish a connection to the specified POP3 or POP3/S server using the provided socket.
  17040. </summary>
  17041. <remarks>
  17042. <para>Establishes a connection to the specified POP3 or POP3/S server using
  17043. the provided socket.</para>
  17044. <para>If the <paramref name="options"/> has a value of
  17045. <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
  17046. to determine the default security options. If the <paramref name="port"/> has a value
  17047. of <c>995</c>, then the default options used will be
  17048. <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
  17049. <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
  17050. <para>Once a connection is established, properties such as
  17051. <see cref="P:MailKit.Net.Pop3.Pop3Client.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Pop3.Pop3Client.Capabilities"/> will be
  17052. populated.</para>
  17053. <note type="info">With the exception of using the <paramref name="port"/> to determine the
  17054. default <see cref="T:MailKit.Security.SecureSocketOptions"/> to use when the <paramref name="options"/> value
  17055. is <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, the <paramref name="host"/> and
  17056. <paramref name="port"/> parameters are only used for logging purposes.</note>
  17057. </remarks>
  17058. <returns>An asynchronous task context.</returns>
  17059. <param name="socket">The socket to use for the connection.</param>
  17060. <param name="host">The host name to connect to.</param>
  17061. <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
  17062. <param name="options">The secure socket options to when connecting.</param>
  17063. <param name="cancellationToken">The cancellation token.</param>
  17064. <exception cref="T:System.ArgumentNullException">
  17065. <para><paramref name="socket"/> is <c>null</c>.</para>
  17066. <para>-or-</para>
  17067. <para><paramref name="host"/> is <c>null</c>.</para>
  17068. </exception>
  17069. <exception cref="T:System.ArgumentOutOfRangeException">
  17070. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  17071. </exception>
  17072. <exception cref="T:System.ArgumentException">
  17073. <para><paramref name="socket"/> is not connected.</para>
  17074. <para>-or-</para>
  17075. <para>The <paramref name="host"/> is a zero-length string.</para>
  17076. </exception>
  17077. <exception cref="T:System.ObjectDisposedException">
  17078. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  17079. </exception>
  17080. <exception cref="T:System.InvalidOperationException">
  17081. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is already connected.
  17082. </exception>
  17083. <exception cref="T:System.NotSupportedException">
  17084. <paramref name="options"/> was set to
  17085. <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
  17086. and the POP3 server does not support the STLS extension.
  17087. </exception>
  17088. <exception cref="T:System.OperationCanceledException">
  17089. The operation was canceled via the cancellation token.
  17090. </exception>
  17091. <exception cref="T:MailKit.Security.SslHandshakeException">
  17092. An error occurred during the SSL/TLS negotiations.
  17093. </exception>
  17094. <exception cref="T:System.IO.IOException">
  17095. An I/O error occurred.
  17096. </exception>
  17097. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  17098. A POP3 command failed.
  17099. </exception>
  17100. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  17101. A POP3 protocol error occurred.
  17102. </exception>
  17103. </member>
  17104. <member name="M:MailKit.Net.Pop3.Pop3Client.ConnectAsync(System.IO.Stream,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
  17105. <summary>
  17106. Asynchronously establish a connection to the specified POP3 or POP3/S server using the provided stream.
  17107. </summary>
  17108. <remarks>
  17109. <para>Establishes a connection to the specified POP3 or POP3/S server using
  17110. the provided stream.</para>
  17111. <para>If the <paramref name="options"/> has a value of
  17112. <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
  17113. to determine the default security options. If the <paramref name="port"/> has a value
  17114. of <c>995</c>, then the default options used will be
  17115. <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
  17116. <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
  17117. <para>Once a connection is established, properties such as
  17118. <see cref="P:MailKit.Net.Pop3.Pop3Client.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Pop3.Pop3Client.Capabilities"/> will be
  17119. populated.</para>
  17120. <note type="info">With the exception of using the <paramref name="port"/> to determine the
  17121. default <see cref="T:MailKit.Security.SecureSocketOptions"/> to use when the <paramref name="options"/> value
  17122. is <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, the <paramref name="host"/> and
  17123. <paramref name="port"/> parameters are only used for logging purposes.</note>
  17124. </remarks>
  17125. <returns>An asynchronous task context.</returns>
  17126. <param name="stream">The socket to use for the connection.</param>
  17127. <param name="host">The host name to connect to.</param>
  17128. <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
  17129. <param name="options">The secure socket options to when connecting.</param>
  17130. <param name="cancellationToken">The cancellation token.</param>
  17131. <exception cref="T:System.ArgumentNullException">
  17132. <para><paramref name="stream"/> is <c>null</c>.</para>
  17133. <para>-or-</para>
  17134. <para><paramref name="host"/> is <c>null</c>.</para>
  17135. </exception>
  17136. <exception cref="T:System.ArgumentOutOfRangeException">
  17137. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  17138. </exception>
  17139. <exception cref="T:System.ArgumentException">
  17140. The <paramref name="host"/> is a zero-length string.
  17141. </exception>
  17142. <exception cref="T:System.ObjectDisposedException">
  17143. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  17144. </exception>
  17145. <exception cref="T:System.InvalidOperationException">
  17146. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is already connected.
  17147. </exception>
  17148. <exception cref="T:System.NotSupportedException">
  17149. <paramref name="options"/> was set to
  17150. <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
  17151. and the POP3 server does not support the STLS extension.
  17152. </exception>
  17153. <exception cref="T:System.OperationCanceledException">
  17154. The operation was canceled via the cancellation token.
  17155. </exception>
  17156. <exception cref="T:MailKit.Security.SslHandshakeException">
  17157. An error occurred during the SSL/TLS negotiations.
  17158. </exception>
  17159. <exception cref="T:System.IO.IOException">
  17160. An I/O error occurred.
  17161. </exception>
  17162. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  17163. A POP3 command failed.
  17164. </exception>
  17165. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  17166. A POP3 protocol error occurred.
  17167. </exception>
  17168. </member>
  17169. <member name="M:MailKit.Net.Pop3.Pop3Client.DisconnectAsync(System.Boolean,System.Threading.CancellationToken)">
  17170. <summary>
  17171. Asynchronously disconnect the service.
  17172. </summary>
  17173. <remarks>
  17174. If <paramref name="quit"/> is <c>true</c>, a <c>QUIT</c> command will be issued in order to disconnect cleanly.
  17175. </remarks>
  17176. <example>
  17177. <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadMessages"/>
  17178. </example>
  17179. <returns>An asynchronous task context.</returns>
  17180. <param name="quit">If set to <c>true</c>, a <c>QUIT</c> command will be issued in order to disconnect cleanly.</param>
  17181. <param name="cancellationToken">The cancellation token.</param>
  17182. <exception cref="T:System.ObjectDisposedException">
  17183. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  17184. </exception>
  17185. </member>
  17186. <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageCountAsync(System.Threading.CancellationToken)">
  17187. <summary>
  17188. Asynchronously get the message count.
  17189. </summary>
  17190. <remarks>
  17191. Asynchronously gets the message count.
  17192. </remarks>
  17193. <returns>The message count.</returns>
  17194. <param name="cancellationToken">The cancellation token.</param>
  17195. <exception cref="T:System.ObjectDisposedException">
  17196. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  17197. </exception>
  17198. <exception cref="T:MailKit.ServiceNotConnectedException">
  17199. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  17200. </exception>
  17201. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  17202. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  17203. </exception>
  17204. <exception cref="T:System.OperationCanceledException">
  17205. The operation was canceled via the cancellation token.
  17206. </exception>
  17207. <exception cref="T:System.IO.IOException">
  17208. An I/O error occurred.
  17209. </exception>
  17210. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  17211. The POP3 command failed.
  17212. </exception>
  17213. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  17214. A POP3 protocol error occurred.
  17215. </exception>
  17216. </member>
  17217. <member name="M:MailKit.Net.Pop3.Pop3Client.NoOpAsync(System.Threading.CancellationToken)">
  17218. <summary>
  17219. Ping the POP3 server to keep the connection alive.
  17220. </summary>
  17221. <remarks>Mail servers, if left idle for too long, will automatically drop the connection.</remarks>
  17222. <returns>An asynchronous task context.</returns>
  17223. <param name="cancellationToken">The cancellation token.</param>
  17224. <exception cref="T:System.ObjectDisposedException">
  17225. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  17226. </exception>
  17227. <exception cref="T:MailKit.ServiceNotConnectedException">
  17228. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  17229. </exception>
  17230. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  17231. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  17232. </exception>
  17233. <exception cref="T:System.OperationCanceledException">
  17234. The operation was canceled via the cancellation token.
  17235. </exception>
  17236. <exception cref="T:System.IO.IOException">
  17237. An I/O error occurred.
  17238. </exception>
  17239. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  17240. The POP3 command failed.
  17241. </exception>
  17242. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  17243. A POP3 protocol error occurred.
  17244. </exception>
  17245. </member>
  17246. <member name="M:MailKit.Net.Pop3.Pop3Client.EnableUTF8Async(System.Threading.CancellationToken)">
  17247. <summary>
  17248. Asynchronously enable UTF8 mode.
  17249. </summary>
  17250. <remarks>
  17251. The POP3 UTF8 extension allows the client to retrieve messages in the UTF-8 encoding and
  17252. may also allow the user to authenticate using a UTF-8 encoded username or password.
  17253. </remarks>
  17254. <returns>An asynchronous task context.</returns>
  17255. <param name="cancellationToken">The cancellation token.</param>
  17256. <exception cref="T:System.ObjectDisposedException">
  17257. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  17258. </exception>
  17259. <exception cref="T:MailKit.ServiceNotConnectedException">
  17260. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  17261. </exception>
  17262. <exception cref="T:System.InvalidOperationException">
  17263. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has already been authenticated.
  17264. </exception>
  17265. <exception cref="T:System.OperationCanceledException">
  17266. The operation was canceled via the cancellation token.
  17267. </exception>
  17268. <exception cref="T:System.NotSupportedException">
  17269. The POP3 server does not support the UTF8 extension.
  17270. </exception>
  17271. <exception cref="T:System.IO.IOException">
  17272. An I/O error occurred.
  17273. </exception>
  17274. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  17275. The POP3 command failed.
  17276. </exception>
  17277. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  17278. A POP3 protocol error occurred.
  17279. </exception>
  17280. </member>
  17281. <member name="M:MailKit.Net.Pop3.Pop3Client.GetLanguagesAsync(System.Threading.CancellationToken)">
  17282. <summary>
  17283. Asynchronously get the list of languages supported by the POP3 server.
  17284. </summary>
  17285. <remarks>
  17286. If the POP3 server supports the LANG extension, it is possible to
  17287. query the list of languages supported by the POP3 server that can
  17288. be used for error messages.
  17289. </remarks>
  17290. <returns>The supported languages.</returns>
  17291. <param name="cancellationToken">The cancellation token.</param>
  17292. <exception cref="T:System.ObjectDisposedException">
  17293. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  17294. </exception>
  17295. <exception cref="T:MailKit.ServiceNotConnectedException">
  17296. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  17297. </exception>
  17298. <exception cref="T:System.OperationCanceledException">
  17299. The operation was canceled via the cancellation token.
  17300. </exception>
  17301. <exception cref="T:System.NotSupportedException">
  17302. The POP3 server does not support the LANG extension.
  17303. </exception>
  17304. <exception cref="T:System.IO.IOException">
  17305. An I/O error occurred.
  17306. </exception>
  17307. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  17308. The POP3 command failed.
  17309. </exception>
  17310. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  17311. A POP3 protocol error occurred.
  17312. </exception>
  17313. </member>
  17314. <member name="M:MailKit.Net.Pop3.Pop3Client.SetLanguageAsync(System.String,System.Threading.CancellationToken)">
  17315. <summary>
  17316. Asynchronously set the language used by the POP3 server for error messages.
  17317. </summary>
  17318. <remarks>
  17319. If the POP3 server supports the LANG extension, it is possible to
  17320. set the language used by the POP3 server for error messages.
  17321. </remarks>
  17322. <returns>An asynchronous task context.</returns>
  17323. <param name="lang">The language code.</param>
  17324. <param name="cancellationToken">The cancellation token.</param>
  17325. <exception cref="T:System.ArgumentNullException">
  17326. <paramref name="lang"/> is <c>null</c>.
  17327. </exception>
  17328. <exception cref="T:System.ArgumentException">
  17329. <paramref name="lang"/> is empty.
  17330. </exception>
  17331. <exception cref="T:System.ObjectDisposedException">
  17332. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  17333. </exception>
  17334. <exception cref="T:MailKit.ServiceNotConnectedException">
  17335. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  17336. </exception>
  17337. <exception cref="T:System.OperationCanceledException">
  17338. The operation was canceled via the cancellation token.
  17339. </exception>
  17340. <exception cref="T:System.NotSupportedException">
  17341. The POP3 server does not support the LANG extension.
  17342. </exception>
  17343. <exception cref="T:System.IO.IOException">
  17344. An I/O error occurred.
  17345. </exception>
  17346. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  17347. The POP3 command failed.
  17348. </exception>
  17349. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  17350. A POP3 protocol error occurred.
  17351. </exception>
  17352. </member>
  17353. <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageUidAsync(System.Int32,System.Threading.CancellationToken)">
  17354. <summary>
  17355. Asynchronously get the UID of the message at the specified index.
  17356. </summary>
  17357. <remarks>
  17358. <para>Gets the UID of the message at the specified index.</para>
  17359. <note type="warning">Not all servers support UIDs, so you should first check the
  17360. <see cref="P:MailKit.Net.Pop3.Pop3Client.Capabilities"/> property for the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.UIDL"/> flag or
  17361. the <see cref="P:MailKit.Net.Pop3.Pop3Client.SupportsUids"/> convenience property.</note>
  17362. </remarks>
  17363. <returns>The message UID.</returns>
  17364. <param name="index">The message index.</param>
  17365. <param name="cancellationToken">The cancellation token.</param>
  17366. <exception cref="T:System.ArgumentOutOfRangeException">
  17367. <paramref name="index"/> is not a valid message index.
  17368. </exception>
  17369. <exception cref="T:System.ObjectDisposedException">
  17370. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  17371. </exception>
  17372. <exception cref="T:MailKit.ServiceNotConnectedException">
  17373. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  17374. </exception>
  17375. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  17376. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  17377. </exception>
  17378. <exception cref="T:System.NotSupportedException">
  17379. The POP3 server does not support the UIDL extension.
  17380. </exception>
  17381. <exception cref="T:System.OperationCanceledException">
  17382. The operation was canceled via the cancellation token.
  17383. </exception>
  17384. <exception cref="T:System.IO.IOException">
  17385. An I/O error occurred.
  17386. </exception>
  17387. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  17388. The POP3 command failed.
  17389. </exception>
  17390. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  17391. A POP3 protocol error occurred.
  17392. </exception>
  17393. </member>
  17394. <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageUidsAsync(System.Threading.CancellationToken)">
  17395. <summary>
  17396. Asynchronously get the full list of available message UIDs.
  17397. </summary>
  17398. <remarks>
  17399. <para>Gets the full list of available message UIDs.</para>
  17400. <note type="warning">Not all servers support UIDs, so you should first check the
  17401. <see cref="P:MailKit.Net.Pop3.Pop3Client.Capabilities"/> property for the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.UIDL"/> flag or
  17402. the <see cref="P:MailKit.Net.Pop3.Pop3Client.SupportsUids"/> convenience property.</note>
  17403. </remarks>
  17404. <example>
  17405. <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadNewMessages"/>
  17406. </example>
  17407. <returns>The message uids.</returns>
  17408. <param name="cancellationToken">The cancellation token.</param>
  17409. <exception cref="T:System.ObjectDisposedException">
  17410. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  17411. </exception>
  17412. <exception cref="T:MailKit.ServiceNotConnectedException">
  17413. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  17414. </exception>
  17415. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  17416. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  17417. </exception>
  17418. <exception cref="T:System.NotSupportedException">
  17419. The POP3 server does not support the UIDL extension.
  17420. </exception>
  17421. <exception cref="T:System.OperationCanceledException">
  17422. The operation was canceled via the cancellation token.
  17423. </exception>
  17424. <exception cref="T:System.IO.IOException">
  17425. An I/O error occurred.
  17426. </exception>
  17427. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  17428. The POP3 command failed.
  17429. </exception>
  17430. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  17431. A POP3 protocol error occurred.
  17432. </exception>
  17433. </member>
  17434. <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageSizeAsync(System.Int32,System.Threading.CancellationToken)">
  17435. <summary>
  17436. Asynchronously get the size of the specified message, in bytes.
  17437. </summary>
  17438. <remarks>
  17439. Gets the size of the specified message, in bytes.
  17440. </remarks>
  17441. <returns>The message size, in bytes.</returns>
  17442. <param name="index">The index of the message.</param>
  17443. <param name="cancellationToken">The cancellation token.</param>
  17444. <exception cref="T:System.ArgumentOutOfRangeException">
  17445. <paramref name="index"/> is not a valid message index.
  17446. </exception>
  17447. <exception cref="T:System.ObjectDisposedException">
  17448. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  17449. </exception>
  17450. <exception cref="T:MailKit.ServiceNotConnectedException">
  17451. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  17452. </exception>
  17453. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  17454. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  17455. </exception>
  17456. <exception cref="T:System.OperationCanceledException">
  17457. The operation was canceled via the cancellation token.
  17458. </exception>
  17459. <exception cref="T:System.IO.IOException">
  17460. An I/O error occurred.
  17461. </exception>
  17462. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  17463. The POP3 command failed.
  17464. </exception>
  17465. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  17466. A POP3 protocol error occurred.
  17467. </exception>
  17468. </member>
  17469. <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageSizesAsync(System.Threading.CancellationToken)">
  17470. <summary>
  17471. Asynchronously get the sizes for all available messages, in bytes.
  17472. </summary>
  17473. <remarks>
  17474. Gets the sizes for all available messages, in bytes.
  17475. </remarks>
  17476. <returns>The message sizes, in bytes.</returns>
  17477. <param name="cancellationToken">The cancellation token.</param>
  17478. <exception cref="T:System.ObjectDisposedException">
  17479. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  17480. </exception>
  17481. <exception cref="T:MailKit.ServiceNotConnectedException">
  17482. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  17483. </exception>
  17484. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  17485. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  17486. </exception>
  17487. <exception cref="T:System.OperationCanceledException">
  17488. The operation was canceled via the cancellation token.
  17489. </exception>
  17490. <exception cref="T:System.IO.IOException">
  17491. An I/O error occurred.
  17492. </exception>
  17493. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  17494. The POP3 command failed.
  17495. </exception>
  17496. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  17497. A POP3 protocol error occurred.
  17498. </exception>
  17499. </member>
  17500. <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageHeadersAsync(System.Int32,System.Threading.CancellationToken)">
  17501. <summary>
  17502. Asynchronously get the headers for the message at the specified index.
  17503. </summary>
  17504. <remarks>
  17505. Gets the headers for the message at the specified index.
  17506. </remarks>
  17507. <returns>The message headers.</returns>
  17508. <param name="index">The index of the message.</param>
  17509. <param name="cancellationToken">The cancellation token.</param>
  17510. <exception cref="T:System.ArgumentOutOfRangeException">
  17511. <paramref name="index"/> is not a valid message index.
  17512. </exception>
  17513. <exception cref="T:System.ObjectDisposedException">
  17514. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  17515. </exception>
  17516. <exception cref="T:MailKit.ServiceNotConnectedException">
  17517. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  17518. </exception>
  17519. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  17520. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  17521. </exception>
  17522. <exception cref="T:System.OperationCanceledException">
  17523. The operation was canceled via the cancellation token.
  17524. </exception>
  17525. <exception cref="T:System.IO.IOException">
  17526. An I/O error occurred.
  17527. </exception>
  17528. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  17529. The POP3 command failed.
  17530. </exception>
  17531. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  17532. A POP3 protocol error occurred.
  17533. </exception>
  17534. </member>
  17535. <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageHeadersAsync(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken)">
  17536. <summary>
  17537. Asynchronously get the headers for the messages at the specified indexes.
  17538. </summary>
  17539. <remarks>
  17540. <para>Gets the headers for the messages at the specified indexes.</para>
  17541. <para>When the POP3 server supports the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Pipelining"/>
  17542. extension, this method will likely be more efficient than using
  17543. <see cref="M:MailKit.Net.Pop3.Pop3Client.GetMessageHeaders(System.Int32,System.Threading.CancellationToken)"/> for each message because
  17544. it will batch the commands to reduce latency.</para>
  17545. </remarks>
  17546. <returns>The headers for the specified messages.</returns>
  17547. <param name="indexes">The indexes of the messages.</param>
  17548. <param name="cancellationToken">The cancellation token.</param>
  17549. <exception cref="T:System.ArgumentNullException">
  17550. <paramref name="indexes"/> is <c>null</c>.
  17551. </exception>
  17552. <exception cref="T:System.ArgumentException">
  17553. One or more of the <paramref name="indexes"/> are invalid.
  17554. </exception>
  17555. <exception cref="T:System.ObjectDisposedException">
  17556. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  17557. </exception>
  17558. <exception cref="T:MailKit.ServiceNotConnectedException">
  17559. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  17560. </exception>
  17561. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  17562. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  17563. </exception>
  17564. <exception cref="T:System.NotSupportedException">
  17565. The POP3 server does not support the UIDL extension.
  17566. </exception>
  17567. <exception cref="T:System.OperationCanceledException">
  17568. The operation was canceled via the cancellation token.
  17569. </exception>
  17570. <exception cref="T:System.IO.IOException">
  17571. An I/O error occurred.
  17572. </exception>
  17573. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  17574. The POP3 command failed.
  17575. </exception>
  17576. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  17577. A POP3 protocol error occurred.
  17578. </exception>
  17579. </member>
  17580. <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageHeadersAsync(System.Int32,System.Int32,System.Threading.CancellationToken)">
  17581. <summary>
  17582. Asynchronously get the headers of the messages within the specified range.
  17583. </summary>
  17584. <remarks>
  17585. <para>Gets the headers of the messages within the specified range.</para>
  17586. <para>When the POP3 server supports the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Pipelining"/>
  17587. extension, this method will likely be more efficient than using
  17588. <see cref="M:MailKit.Net.Pop3.Pop3Client.GetMessageHeaders(System.Int32,System.Threading.CancellationToken)"/> for each message because
  17589. it will batch the commands to reduce latency.</para>
  17590. </remarks>
  17591. <returns>The headers of the messages within the specified range.</returns>
  17592. <param name="startIndex">The index of the first message to get.</param>
  17593. <param name="count">The number of messages to get.</param>
  17594. <param name="cancellationToken">The cancellation token.</param>
  17595. <exception cref="T:System.ArgumentOutOfRangeException">
  17596. <paramref name="startIndex"/> and <paramref name="count"/> do not specify
  17597. a valid range of messages.
  17598. </exception>
  17599. <exception cref="T:System.ObjectDisposedException">
  17600. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  17601. </exception>
  17602. <exception cref="T:MailKit.ServiceNotConnectedException">
  17603. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  17604. </exception>
  17605. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  17606. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  17607. </exception>
  17608. <exception cref="T:System.NotSupportedException">
  17609. The POP3 server does not support the UIDL extension.
  17610. </exception>
  17611. <exception cref="T:System.OperationCanceledException">
  17612. The operation was canceled via the cancellation token.
  17613. </exception>
  17614. <exception cref="T:System.IO.IOException">
  17615. An I/O error occurred.
  17616. </exception>
  17617. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  17618. The POP3 command failed.
  17619. </exception>
  17620. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  17621. A POP3 protocol error occurred.
  17622. </exception>
  17623. </member>
  17624. <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageAsync(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  17625. <summary>
  17626. Asynchronously get the message at the specified index.
  17627. </summary>
  17628. <remarks>
  17629. Gets the message at the specified index.
  17630. </remarks>
  17631. <example>
  17632. <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadMessages"/>
  17633. </example>
  17634. <returns>The message.</returns>
  17635. <param name="index">The index of the message.</param>
  17636. <param name="cancellationToken">The cancellation token.</param>
  17637. <param name="progress">The progress reporting mechanism.</param>
  17638. <exception cref="T:System.ArgumentOutOfRangeException">
  17639. <paramref name="index"/> is not a valid message index.
  17640. </exception>
  17641. <exception cref="T:System.ObjectDisposedException">
  17642. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  17643. </exception>
  17644. <exception cref="T:MailKit.ServiceNotConnectedException">
  17645. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  17646. </exception>
  17647. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  17648. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  17649. </exception>
  17650. <exception cref="T:System.OperationCanceledException">
  17651. The operation was canceled via the cancellation token.
  17652. </exception>
  17653. <exception cref="T:System.IO.IOException">
  17654. An I/O error occurred.
  17655. </exception>
  17656. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  17657. The POP3 command failed.
  17658. </exception>
  17659. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  17660. A POP3 protocol error occurred.
  17661. </exception>
  17662. </member>
  17663. <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessagesAsync(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  17664. <summary>
  17665. Asynchronously get the messages at the specified indexes.
  17666. </summary>
  17667. <remarks>
  17668. <para>Gets the messages at the specified indexes.</para>
  17669. <para>When the POP3 server supports the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Pipelining"/>
  17670. extension, this method will likely be more efficient than using
  17671. <see cref="M:MailKit.Net.Pop3.Pop3Client.GetMessage(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)"/> for each message
  17672. because it will batch the commands to reduce latency.</para>
  17673. </remarks>
  17674. <returns>The messages.</returns>
  17675. <param name="indexes">The indexes of the messages.</param>
  17676. <param name="cancellationToken">The cancellation token.</param>
  17677. <param name="progress">The progress reporting mechanism.</param>
  17678. <exception cref="T:System.ArgumentNullException">
  17679. <paramref name="indexes"/> is <c>null</c>.
  17680. </exception>
  17681. <exception cref="T:System.ArgumentException">
  17682. One or more of the <paramref name="indexes"/> are invalid.
  17683. </exception>
  17684. <exception cref="T:System.ObjectDisposedException">
  17685. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  17686. </exception>
  17687. <exception cref="T:MailKit.ServiceNotConnectedException">
  17688. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  17689. </exception>
  17690. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  17691. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  17692. </exception>
  17693. <exception cref="T:System.NotSupportedException">
  17694. The POP3 server does not support the UIDL extension.
  17695. </exception>
  17696. <exception cref="T:System.OperationCanceledException">
  17697. The operation was canceled via the cancellation token.
  17698. </exception>
  17699. <exception cref="T:System.IO.IOException">
  17700. An I/O error occurred.
  17701. </exception>
  17702. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  17703. The POP3 command failed.
  17704. </exception>
  17705. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  17706. A POP3 protocol error occurred.
  17707. </exception>
  17708. </member>
  17709. <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessagesAsync(System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  17710. <summary>
  17711. Asynchronously get the messages within the specified range.
  17712. </summary>
  17713. <remarks>
  17714. <para>Gets the messages within the specified range.</para>
  17715. <para>When the POP3 server supports the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Pipelining"/>
  17716. extension, this method will likely be more efficient than using
  17717. <see cref="M:MailKit.Net.Pop3.Pop3Client.GetMessage(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)"/> for each message
  17718. because it will batch the commands to reduce latency.</para>
  17719. </remarks>
  17720. <example>
  17721. <code language="c#" source="Examples\Pop3Examples.cs" region="BatchDownloadMessages"/>
  17722. </example>
  17723. <returns>The messages.</returns>
  17724. <param name="startIndex">The index of the first message to get.</param>
  17725. <param name="count">The number of messages to get.</param>
  17726. <param name="cancellationToken">The cancellation token.</param>
  17727. <param name="progress">The progress reporting mechanism.</param>
  17728. <exception cref="T:System.ArgumentOutOfRangeException">
  17729. <paramref name="startIndex"/> and <paramref name="count"/> do not specify
  17730. a valid range of messages.
  17731. </exception>
  17732. <exception cref="T:System.ObjectDisposedException">
  17733. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  17734. </exception>
  17735. <exception cref="T:MailKit.ServiceNotConnectedException">
  17736. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  17737. </exception>
  17738. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  17739. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  17740. </exception>
  17741. <exception cref="T:System.NotSupportedException">
  17742. The POP3 server does not support the UIDL extension.
  17743. </exception>
  17744. <exception cref="T:System.OperationCanceledException">
  17745. The operation was canceled via the cancellation token.
  17746. </exception>
  17747. <exception cref="T:System.IO.IOException">
  17748. An I/O error occurred.
  17749. </exception>
  17750. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  17751. The POP3 command failed.
  17752. </exception>
  17753. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  17754. A POP3 protocol error occurred.
  17755. </exception>
  17756. </member>
  17757. <member name="M:MailKit.Net.Pop3.Pop3Client.GetStreamAsync(System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  17758. <summary>
  17759. Asynchronously get the message or header stream at the specified index.
  17760. </summary>
  17761. <remarks>
  17762. Gets the message or header stream at the specified index.
  17763. </remarks>
  17764. <returns>The message or header stream.</returns>
  17765. <param name="index">The index of the message.</param>
  17766. <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
  17767. <param name="cancellationToken">The cancellation token.</param>
  17768. <param name="progress">The progress reporting mechanism.</param>
  17769. <exception cref="T:System.ArgumentOutOfRangeException">
  17770. <paramref name="index"/> is not a valid message index.
  17771. </exception>
  17772. <exception cref="T:System.ObjectDisposedException">
  17773. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  17774. </exception>
  17775. <exception cref="T:MailKit.ServiceNotConnectedException">
  17776. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  17777. </exception>
  17778. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  17779. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  17780. </exception>
  17781. <exception cref="T:System.OperationCanceledException">
  17782. The operation was canceled via the cancellation token.
  17783. </exception>
  17784. <exception cref="T:System.IO.IOException">
  17785. An I/O error occurred.
  17786. </exception>
  17787. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  17788. The POP3 command failed.
  17789. </exception>
  17790. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  17791. A POP3 protocol error occurred.
  17792. </exception>
  17793. </member>
  17794. <member name="M:MailKit.Net.Pop3.Pop3Client.GetStreamsAsync(System.Collections.Generic.IList{System.Int32},System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  17795. <summary>
  17796. Asynchronously get the message or header streams at the specified indexes.
  17797. </summary>
  17798. <remarks>
  17799. <para>Get the message or header streams at the specified indexes.</para>
  17800. <para>If the POP3 server supports the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Pipelining"/>
  17801. extension, this method will likely be more efficient than using
  17802. <see cref="M:MailKit.Net.Pop3.Pop3Client.GetStream(System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)"/> for each message
  17803. because it will batch the commands to reduce latency.</para>
  17804. </remarks>
  17805. <returns>The message or header streams.</returns>
  17806. <param name="indexes">The indexes of the messages.</param>
  17807. <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
  17808. <param name="cancellationToken">The cancellation token.</param>
  17809. <param name="progress">The progress reporting mechanism.</param>
  17810. <exception cref="T:System.ArgumentNullException">
  17811. <paramref name="indexes"/> is <c>null</c>.
  17812. </exception>
  17813. <exception cref="T:System.ArgumentException">
  17814. One or more of the <paramref name="indexes"/> are invalid.
  17815. </exception>
  17816. <exception cref="T:System.ObjectDisposedException">
  17817. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  17818. </exception>
  17819. <exception cref="T:MailKit.ServiceNotConnectedException">
  17820. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  17821. </exception>
  17822. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  17823. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  17824. </exception>
  17825. <exception cref="T:System.NotSupportedException">
  17826. The POP3 server does not support the UIDL extension.
  17827. </exception>
  17828. <exception cref="T:System.OperationCanceledException">
  17829. The operation was canceled via the cancellation token.
  17830. </exception>
  17831. <exception cref="T:System.IO.IOException">
  17832. An I/O error occurred.
  17833. </exception>
  17834. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  17835. The POP3 command failed.
  17836. </exception>
  17837. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  17838. A POP3 protocol error occurred.
  17839. </exception>
  17840. </member>
  17841. <member name="M:MailKit.Net.Pop3.Pop3Client.GetStreamsAsync(System.Int32,System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  17842. <summary>
  17843. Asynchronously get the message or header streams within the specified range.
  17844. </summary>
  17845. <remarks>
  17846. <para>Gets the message or header streams within the specified range.</para>
  17847. <para>If the POP3 server supports the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Pipelining"/>
  17848. extension, this method will likely be more efficient than using
  17849. <see cref="M:MailKit.Net.Pop3.Pop3Client.GetStream(System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)"/> for each message
  17850. because it will batch the commands to reduce latency.</para>
  17851. </remarks>
  17852. <returns>The message or header streams.</returns>
  17853. <param name="startIndex">The index of the first stream to get.</param>
  17854. <param name="count">The number of streams to get.</param>
  17855. <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
  17856. <param name="cancellationToken">The cancellation token.</param>
  17857. <param name="progress">The progress reporting mechanism.</param>
  17858. <exception cref="T:System.ArgumentOutOfRangeException">
  17859. <paramref name="startIndex"/> and <paramref name="count"/> do not specify
  17860. a valid range of messages.
  17861. </exception>
  17862. <exception cref="T:System.ObjectDisposedException">
  17863. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  17864. </exception>
  17865. <exception cref="T:MailKit.ServiceNotConnectedException">
  17866. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  17867. </exception>
  17868. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  17869. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  17870. </exception>
  17871. <exception cref="T:System.NotSupportedException">
  17872. The POP3 server does not support the UIDL extension.
  17873. </exception>
  17874. <exception cref="T:System.OperationCanceledException">
  17875. The operation was canceled via the cancellation token.
  17876. </exception>
  17877. <exception cref="T:System.IO.IOException">
  17878. An I/O error occurred.
  17879. </exception>
  17880. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  17881. The POP3 command failed.
  17882. </exception>
  17883. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  17884. A POP3 protocol error occurred.
  17885. </exception>
  17886. </member>
  17887. <member name="M:MailKit.Net.Pop3.Pop3Client.DeleteMessageAsync(System.Int32,System.Threading.CancellationToken)">
  17888. <summary>
  17889. Asynchronously mark the specified message for deletion.
  17890. </summary>
  17891. <remarks>
  17892. Messages marked for deletion are not actually deleted until the session
  17893. is cleanly disconnected
  17894. (see <see cref="M:MailKit.Net.Pop3.Pop3Client.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
  17895. </remarks>
  17896. <example>
  17897. <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadMessages"/>
  17898. </example>
  17899. <returns>An asynchronous task context.</returns>
  17900. <param name="index">The index of the message.</param>
  17901. <param name="cancellationToken">The cancellation token.</param>
  17902. <exception cref="T:System.ArgumentOutOfRangeException">
  17903. <paramref name="index"/> is not a valid message index.
  17904. </exception>
  17905. <exception cref="T:System.ObjectDisposedException">
  17906. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  17907. </exception>
  17908. <exception cref="T:MailKit.ServiceNotConnectedException">
  17909. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  17910. </exception>
  17911. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  17912. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  17913. </exception>
  17914. <exception cref="T:System.OperationCanceledException">
  17915. The operation was canceled via the cancellation token.
  17916. </exception>
  17917. <exception cref="T:System.IO.IOException">
  17918. An I/O error occurred.
  17919. </exception>
  17920. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  17921. The POP3 command failed.
  17922. </exception>
  17923. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  17924. A POP3 protocol error occurred.
  17925. </exception>
  17926. </member>
  17927. <member name="M:MailKit.Net.Pop3.Pop3Client.DeleteMessagesAsync(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken)">
  17928. <summary>
  17929. Asynchronously mark the specified messages for deletion.
  17930. </summary>
  17931. <remarks>
  17932. Messages marked for deletion are not actually deleted until the session
  17933. is cleanly disconnected
  17934. (see <see cref="M:MailKit.Net.Pop3.Pop3Client.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
  17935. </remarks>
  17936. <returns>An asynchronous task context.</returns>
  17937. <param name="indexes">The indexes of the messages.</param>
  17938. <param name="cancellationToken">The cancellation token.</param>
  17939. <exception cref="T:System.ArgumentNullException">
  17940. <paramref name="indexes"/> is <c>null</c>.
  17941. </exception>
  17942. <exception cref="T:System.ArgumentException">
  17943. One or more of the <paramref name="indexes"/> are invalid.
  17944. </exception>
  17945. <exception cref="T:System.ObjectDisposedException">
  17946. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  17947. </exception>
  17948. <exception cref="T:MailKit.ServiceNotConnectedException">
  17949. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  17950. </exception>
  17951. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  17952. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  17953. </exception>
  17954. <exception cref="T:System.OperationCanceledException">
  17955. The operation was canceled via the cancellation token.
  17956. </exception>
  17957. <exception cref="T:System.IO.IOException">
  17958. An I/O error occurred.
  17959. </exception>
  17960. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  17961. The POP3 command failed.
  17962. </exception>
  17963. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  17964. A POP3 protocol error occurred.
  17965. </exception>
  17966. </member>
  17967. <member name="M:MailKit.Net.Pop3.Pop3Client.DeleteMessagesAsync(System.Int32,System.Int32,System.Threading.CancellationToken)">
  17968. <summary>
  17969. Asynchronously mark the specified range of messages for deletion.
  17970. </summary>
  17971. <remarks>
  17972. Messages marked for deletion are not actually deleted until the session
  17973. is cleanly disconnected
  17974. (see <see cref="M:MailKit.Net.Pop3.Pop3Client.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
  17975. </remarks>
  17976. <example>
  17977. <code language="c#" source="Examples\Pop3Examples.cs" region="BatchDownloadMessages"/>
  17978. </example>
  17979. <returns>An asynchronous task context.</returns>
  17980. <param name="startIndex">The index of the first message to mark for deletion.</param>
  17981. <param name="count">The number of messages to mark for deletion.</param>
  17982. <param name="cancellationToken">The cancellation token.</param>
  17983. <exception cref="T:System.ArgumentOutOfRangeException">
  17984. <paramref name="startIndex"/> and <paramref name="count"/> do not specify
  17985. a valid range of messages.
  17986. </exception>
  17987. <exception cref="T:System.ObjectDisposedException">
  17988. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  17989. </exception>
  17990. <exception cref="T:MailKit.ServiceNotConnectedException">
  17991. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  17992. </exception>
  17993. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  17994. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  17995. </exception>
  17996. <exception cref="T:System.OperationCanceledException">
  17997. The operation was canceled via the cancellation token.
  17998. </exception>
  17999. <exception cref="T:System.IO.IOException">
  18000. An I/O error occurred.
  18001. </exception>
  18002. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  18003. The POP3 command failed.
  18004. </exception>
  18005. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  18006. A POP3 protocol error occurred.
  18007. </exception>
  18008. </member>
  18009. <member name="M:MailKit.Net.Pop3.Pop3Client.DeleteAllMessagesAsync(System.Threading.CancellationToken)">
  18010. <summary>
  18011. Asynchronously mark all messages for deletion.
  18012. </summary>
  18013. <remarks>
  18014. Messages marked for deletion are not actually deleted until the session
  18015. is cleanly disconnected
  18016. (see <see cref="M:MailKit.Net.Pop3.Pop3Client.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
  18017. </remarks>
  18018. <returns>An asynchronous task context.</returns>
  18019. <param name="cancellationToken">The cancellation token.</param>
  18020. <exception cref="T:System.ObjectDisposedException">
  18021. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  18022. </exception>
  18023. <exception cref="T:MailKit.ServiceNotConnectedException">
  18024. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  18025. </exception>
  18026. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  18027. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  18028. </exception>
  18029. <exception cref="T:System.OperationCanceledException">
  18030. The operation was canceled via the cancellation token.
  18031. </exception>
  18032. <exception cref="T:System.IO.IOException">
  18033. An I/O error occurred.
  18034. </exception>
  18035. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  18036. The POP3 command failed.
  18037. </exception>
  18038. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  18039. A POP3 protocol error occurred.
  18040. </exception>
  18041. </member>
  18042. <member name="M:MailKit.Net.Pop3.Pop3Client.ResetAsync(System.Threading.CancellationToken)">
  18043. <summary>
  18044. Asynchronously reset the state of all messages marked for deletion.
  18045. </summary>
  18046. <remarks>
  18047. Messages marked for deletion are not actually deleted until the session
  18048. is cleanly disconnected
  18049. (see <see cref="M:MailKit.Net.Pop3.Pop3Client.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
  18050. </remarks>
  18051. <returns>An awaitable task.</returns>
  18052. <param name="cancellationToken">The cancellation token.</param>
  18053. <exception cref="T:System.ObjectDisposedException">
  18054. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  18055. </exception>
  18056. <exception cref="T:MailKit.ServiceNotConnectedException">
  18057. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  18058. </exception>
  18059. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  18060. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  18061. </exception>
  18062. <exception cref="T:System.OperationCanceledException">
  18063. The operation was canceled via the cancellation token.
  18064. </exception>
  18065. <exception cref="T:System.IO.IOException">
  18066. An I/O error occurred.
  18067. </exception>
  18068. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  18069. The POP3 command failed.
  18070. </exception>
  18071. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  18072. A POP3 protocol error occurred.
  18073. </exception>
  18074. </member>
  18075. <member name="M:MailKit.Net.Pop3.Pop3Client.#ctor(MailKit.IProtocolLogger)">
  18076. <summary>
  18077. Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3Client"/> class.
  18078. </summary>
  18079. <remarks>
  18080. Before you can retrieve messages with the <see cref="T:MailKit.Net.Pop3.Pop3Client"/>, you must first call
  18081. one of the <a href="Overload_MailKit_Net_Pop3_Pop3Client_Connect.htm">Connect</a> methods
  18082. and authenticate using one of the
  18083. <a href="Overload_MailKit_Net_Pop3_Pop3Client_Authenticate.htm">Authenticate</a> methods.
  18084. </remarks>
  18085. <example>
  18086. <code language="c#" source="Examples\Pop3Examples.cs" region="ProtocolLogger"/>
  18087. </example>
  18088. <param name="protocolLogger">The protocol logger.</param>
  18089. <exception cref="T:System.ArgumentNullException">
  18090. <paramref name="protocolLogger"/> is <c>null</c>.
  18091. </exception>
  18092. </member>
  18093. <member name="M:MailKit.Net.Pop3.Pop3Client.#ctor">
  18094. <summary>
  18095. Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3Client"/> class.
  18096. </summary>
  18097. <remarks>
  18098. Before you can retrieve messages with the <see cref="T:MailKit.Net.Pop3.Pop3Client"/>, you must first call
  18099. one of the <a href="Overload_MailKit_Net_Pop3_Pop3Client_Connect.htm">Connect</a> methods
  18100. and authenticate using one of the
  18101. <a href="Overload_MailKit_Net_Pop3_Pop3Client_Authenticate.htm">Authenticate</a> methods.
  18102. </remarks>
  18103. </member>
  18104. <member name="P:MailKit.Net.Pop3.Pop3Client.SyncRoot">
  18105. <summary>
  18106. Gets an object that can be used to synchronize access to the POP3 server.
  18107. </summary>
  18108. <remarks>
  18109. <para>Gets an object that can be used to synchronize access to the POP3 server.</para>
  18110. <para>When using the non-Async methods from multiple threads, it is important to lock the
  18111. <see cref="P:MailKit.Net.Pop3.Pop3Client.SyncRoot"/> object for thread safety when using the synchronous methods.</para>
  18112. </remarks>
  18113. <value>The lock object.</value>
  18114. </member>
  18115. <member name="P:MailKit.Net.Pop3.Pop3Client.Protocol">
  18116. <summary>
  18117. Gets the protocol supported by the message service.
  18118. </summary>
  18119. <remarks>
  18120. Gets the protocol supported by the message service.
  18121. </remarks>
  18122. <value>The protocol.</value>
  18123. </member>
  18124. <member name="P:MailKit.Net.Pop3.Pop3Client.Capabilities">
  18125. <summary>
  18126. Gets the capabilities supported by the POP3 server.
  18127. </summary>
  18128. <remarks>
  18129. The capabilities will not be known until a successful connection has been made
  18130. and may change once the client is authenticated.
  18131. </remarks>
  18132. <example>
  18133. <code language="c#" source="Examples\Pop3Examples.cs" region="Capabilities"/>
  18134. </example>
  18135. <value>The capabilities.</value>
  18136. <exception cref="T:System.ArgumentException">
  18137. Capabilities cannot be enabled, they may only be disabled.
  18138. </exception>
  18139. </member>
  18140. <member name="P:MailKit.Net.Pop3.Pop3Client.ExpirePolicy">
  18141. <summary>
  18142. Gets the expiration policy.
  18143. </summary>
  18144. <remarks>
  18145. <para>If the server supports the EXPIRE capability (<see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Expire"/>), the value
  18146. of the <see cref="P:MailKit.Net.Pop3.Pop3Client.ExpirePolicy"/> property will reflect the value advertized by the server.</para>
  18147. <para>A value of <c>-1</c> indicates that messages will never expire.</para>
  18148. <para>A value of <c>0</c> indicates that messages that have been retrieved during the current session
  18149. will be purged immediately after the connection is closed via the <c>QUIT</c> command.</para>
  18150. <para>Values larger than <c>0</c> indicate the minimum number of days that the server will retain
  18151. messages which have been retrieved.</para>
  18152. </remarks>
  18153. <example>
  18154. <code language="c#" source="Examples\Pop3Examples.cs" region="Capabilities"/>
  18155. </example>
  18156. <value>The expiration policy.</value>
  18157. </member>
  18158. <member name="P:MailKit.Net.Pop3.Pop3Client.Implementation">
  18159. <summary>
  18160. Gets the implementation details of the server.
  18161. </summary>
  18162. <remarks>
  18163. If the server advertizes its implementation details, this value will be set to a string containing the
  18164. information details provided by the server.
  18165. </remarks>
  18166. <value>The implementation details.</value>
  18167. </member>
  18168. <member name="P:MailKit.Net.Pop3.Pop3Client.LoginDelay">
  18169. <summary>
  18170. Gets the minimum delay, in milliseconds, between logins.
  18171. </summary>
  18172. <remarks>
  18173. If the server supports the LOGIN-DELAY capability (<see cref="F:MailKit.Net.Pop3.Pop3Capabilities.LoginDelay"/>), this value
  18174. will be set to the minimum number of milliseconds that the client must wait between logins.
  18175. </remarks>
  18176. <example>
  18177. <code language="c#" source="Examples\Pop3Examples.cs" region="Capabilities"/>
  18178. </example>
  18179. <value>The login delay.</value>
  18180. </member>
  18181. <member name="P:MailKit.Net.Pop3.Pop3Client.AuthenticationMechanisms">
  18182. <summary>
  18183. Gets the authentication mechanisms supported by the POP3 server.
  18184. </summary>
  18185. <remarks>
  18186. <para>The authentication mechanisms are queried as part of the
  18187. connection process.</para>
  18188. <para>Servers that do not support the SASL capability will typically
  18189. support either the <c>APOP</c> authentication mechanism
  18190. (<see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Apop"/>) or the ability to login using the
  18191. <c>USER</c> and <c>PASS</c> commands (<see cref="F:MailKit.Net.Pop3.Pop3Capabilities.User"/>).
  18192. </para>
  18193. <note type="tip"><para>To prevent the usage of certain authentication mechanisms,
  18194. simply remove them from the <see cref="P:MailKit.Net.Pop3.Pop3Client.AuthenticationMechanisms"/> hash set
  18195. before authenticating.</para>
  18196. <para>In the case of the APOP authentication mechanism, remove it from the
  18197. <see cref="P:MailKit.Net.Pop3.Pop3Client.Capabilities"/> property instead.</para></note>
  18198. </remarks>
  18199. <example>
  18200. <code language="c#" source="Examples\Pop3Examples.cs" region="Capabilities"/>
  18201. </example>
  18202. <value>The authentication mechanisms.</value>
  18203. </member>
  18204. <member name="P:MailKit.Net.Pop3.Pop3Client.Timeout">
  18205. <summary>
  18206. Gets or sets the timeout for network streaming operations, in milliseconds.
  18207. </summary>
  18208. <remarks>
  18209. Gets or sets the underlying socket stream's <see cref="P:System.IO.Stream.ReadTimeout"/>
  18210. and <see cref="P:System.IO.Stream.WriteTimeout"/> values.
  18211. </remarks>
  18212. <value>The timeout in milliseconds.</value>
  18213. </member>
  18214. <member name="P:MailKit.Net.Pop3.Pop3Client.IsConnected">
  18215. <summary>
  18216. Gets whether or not the client is currently connected to an POP3 server.
  18217. </summary>
  18218. <remarks>
  18219. <para>The <see cref="P:MailKit.Net.Pop3.Pop3Client.IsConnected"/> state is set to <c>true</c> immediately after
  18220. one of the <a href="Overload_MailKit_Net_Pop3_Pop3Client_Connect.htm">Connect</a>
  18221. methods succeeds and is not set back to <c>false</c> until either the client
  18222. is disconnected via <see cref="M:MailKit.Net.Pop3.Pop3Client.Disconnect(System.Boolean,System.Threading.CancellationToken)"/> or until a
  18223. <see cref="T:MailKit.Net.Pop3.Pop3ProtocolException"/> is thrown while attempting to read or write to
  18224. the underlying network socket.</para>
  18225. <para>When an <see cref="T:MailKit.Net.Pop3.Pop3ProtocolException"/> is caught, the connection state of the
  18226. <see cref="T:MailKit.Net.Pop3.Pop3Client"/> should be checked before continuing.</para>
  18227. </remarks>
  18228. <example>
  18229. <code language="c#" source="Examples\Pop3Examples.cs" region="ExceptionHandling"/>
  18230. </example>
  18231. <value><c>true</c> if the client is connected; otherwise, <c>false</c>.</value>
  18232. </member>
  18233. <member name="P:MailKit.Net.Pop3.Pop3Client.IsSecure">
  18234. <summary>
  18235. Get whether or not the connection is secure (typically via SSL or TLS).
  18236. </summary>
  18237. <remarks>
  18238. Gets whether or not the connection is secure (typically via SSL or TLS).
  18239. </remarks>
  18240. <value><c>true</c> if the connection is secure; otherwise, <c>false</c>.</value>
  18241. </member>
  18242. <member name="P:MailKit.Net.Pop3.Pop3Client.IsAuthenticated">
  18243. <summary>
  18244. Get whether or not the client is currently authenticated with the POP3 server.
  18245. </summary>
  18246. <remarks>
  18247. <para>Gets whether or not the client is currently authenticated with the POP3 server.</para>
  18248. <para>To authenticate with the POP3 server, use one of the
  18249. <a href="Overload_MailKit_Net_Pop3_Pop3Client_Authenticate.htm">Authenticate</a> methods.</para>
  18250. </remarks>
  18251. <value><c>true</c> if the client is connected; otherwise, <c>false</c>.</value>
  18252. </member>
  18253. <member name="M:MailKit.Net.Pop3.Pop3Client.Authenticate(MailKit.Security.SaslMechanism,System.Threading.CancellationToken)">
  18254. <summary>
  18255. Authenticate using the specified SASL mechanism.
  18256. </summary>
  18257. <remarks>
  18258. <para>Authenticates using the specified SASL mechanism.</para>
  18259. <para>For a list of available SASL authentication mechanisms supported by the server,
  18260. check the <see cref="P:MailKit.Net.Pop3.Pop3Client.AuthenticationMechanisms"/> property after the service has been
  18261. connected.</para>
  18262. </remarks>
  18263. <param name="mechanism">The SASL mechanism.</param>
  18264. <param name="cancellationToken">The cancellation token.</param>
  18265. <exception cref="T:System.ArgumentNullException">
  18266. <paramref name="mechanism"/> is <c>null</c>.
  18267. </exception>
  18268. <exception cref="T:System.ObjectDisposedException">
  18269. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  18270. </exception>
  18271. <exception cref="T:MailKit.ServiceNotConnectedException">
  18272. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  18273. </exception>
  18274. <exception cref="T:System.InvalidOperationException">
  18275. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is already authenticated.
  18276. </exception>
  18277. <exception cref="T:System.OperationCanceledException">
  18278. The operation was canceled via the cancellation token.
  18279. </exception>
  18280. <exception cref="T:MailKit.Security.AuthenticationException">
  18281. Authentication using the supplied credentials has failed.
  18282. </exception>
  18283. <exception cref="T:MailKit.Security.SaslException">
  18284. A SASL authentication error occurred.
  18285. </exception>
  18286. <exception cref="T:System.IO.IOException">
  18287. An I/O error occurred.
  18288. </exception>
  18289. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  18290. A POP3 command failed.
  18291. </exception>
  18292. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  18293. An POP3 protocol error occurred.
  18294. </exception>
  18295. </member>
  18296. <member name="M:MailKit.Net.Pop3.Pop3Client.Authenticate(System.Text.Encoding,System.Net.ICredentials,System.Threading.CancellationToken)">
  18297. <summary>
  18298. Authenticate using the supplied credentials.
  18299. </summary>
  18300. <remarks>
  18301. <para>If the POP3 server supports the APOP authentication mechanism,
  18302. then APOP is used.</para>
  18303. <para>If the APOP authentication mechanism is not supported and the
  18304. server supports one or more SASL authentication mechanisms, then
  18305. the SASL mechanisms that both the client and server support are tried
  18306. in order of greatest security to weakest security. Once a SASL
  18307. authentication mechanism is found that both client and server support,
  18308. the credentials are used to authenticate.</para>
  18309. <para>If the server does not support SASL or if no common SASL mechanisms
  18310. can be found, then the <c>USER</c> and <c>PASS</c> commands are used as a
  18311. fallback.</para>
  18312. <note type="tip"><para>To prevent the usage of certain authentication mechanisms,
  18313. simply remove them from the <see cref="P:MailKit.Net.Pop3.Pop3Client.AuthenticationMechanisms"/> hash set
  18314. before calling this method.</para>
  18315. <para>In the case of the APOP authentication mechanism, remove it from the
  18316. <see cref="P:MailKit.Net.Pop3.Pop3Client.Capabilities"/> property instead.</para></note>
  18317. </remarks>
  18318. <param name="encoding">The text encoding to use for the user's credentials.</param>
  18319. <param name="credentials">The user's credentials.</param>
  18320. <param name="cancellationToken">The cancellation token.</param>
  18321. <exception cref="T:System.ArgumentNullException">
  18322. <para><paramref name="encoding"/> is <c>null</c>.</para>
  18323. <para>-or-</para>
  18324. <para><paramref name="credentials"/> is <c>null</c>.</para>
  18325. </exception>
  18326. <exception cref="T:System.ObjectDisposedException">
  18327. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  18328. </exception>
  18329. <exception cref="T:MailKit.ServiceNotConnectedException">
  18330. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  18331. </exception>
  18332. <exception cref="T:System.InvalidOperationException">
  18333. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is already authenticated.
  18334. </exception>
  18335. <exception cref="T:System.OperationCanceledException">
  18336. The operation was canceled via the cancellation token.
  18337. </exception>
  18338. <exception cref="T:MailKit.Security.AuthenticationException">
  18339. Authentication using the supplied credentials has failed.
  18340. </exception>
  18341. <exception cref="T:MailKit.Security.SaslException">
  18342. A SASL authentication error occurred.
  18343. </exception>
  18344. <exception cref="T:System.IO.IOException">
  18345. An I/O error occurred.
  18346. </exception>
  18347. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  18348. A POP3 command failed.
  18349. </exception>
  18350. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  18351. An POP3 protocol error occurred.
  18352. </exception>
  18353. </member>
  18354. <member name="M:MailKit.Net.Pop3.Pop3Client.Connect(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
  18355. <summary>
  18356. Establish a connection to the specified POP3 or POP3/S server.
  18357. </summary>
  18358. <remarks>
  18359. <para>Establishes a connection to the specified POP3 or POP3/S server.</para>
  18360. <para>If the <paramref name="port"/> has a value of <c>0</c>, then the
  18361. <paramref name="options"/> parameter is used to determine the default port to
  18362. connect to. The default port used with <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>
  18363. is <c>995</c>. All other values will use a default port of <c>110</c>.</para>
  18364. <para>If the <paramref name="options"/> has a value of
  18365. <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
  18366. to determine the default security options. If the <paramref name="port"/> has a value
  18367. of <c>995</c>, then the default options used will be
  18368. <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
  18369. <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
  18370. <para>Once a connection is established, properties such as
  18371. <see cref="P:MailKit.Net.Pop3.Pop3Client.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Pop3.Pop3Client.Capabilities"/> will be
  18372. populated.</para>
  18373. </remarks>
  18374. <example>
  18375. <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadMessages"/>
  18376. </example>
  18377. <param name="host">The host name to connect to.</param>
  18378. <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
  18379. <param name="options">The secure socket options to when connecting.</param>
  18380. <param name="cancellationToken">The cancellation token.</param>
  18381. <exception cref="T:System.ArgumentNullException">
  18382. <paramref name="host"/> is <c>null</c>.
  18383. </exception>
  18384. <exception cref="T:System.ArgumentOutOfRangeException">
  18385. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  18386. </exception>
  18387. <exception cref="T:System.ArgumentException">
  18388. The <paramref name="host"/> is a zero-length string.
  18389. </exception>
  18390. <exception cref="T:System.ObjectDisposedException">
  18391. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  18392. </exception>
  18393. <exception cref="T:System.InvalidOperationException">
  18394. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is already connected.
  18395. </exception>
  18396. <exception cref="T:System.OperationCanceledException">
  18397. The operation was canceled via the cancellation token.
  18398. </exception>
  18399. <exception cref="T:System.NotSupportedException">
  18400. <paramref name="options"/> was set to
  18401. <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
  18402. and the POP3 server does not support the STLS extension.
  18403. </exception>
  18404. <exception cref="T:System.Net.Sockets.SocketException">
  18405. A socket error occurred trying to connect to the remote host.
  18406. </exception>
  18407. <exception cref="T:MailKit.Security.SslHandshakeException">
  18408. An error occurred during the SSL/TLS negotiations.
  18409. </exception>
  18410. <exception cref="T:System.IO.IOException">
  18411. An I/O error occurred.
  18412. </exception>
  18413. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  18414. A POP3 command failed.
  18415. </exception>
  18416. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  18417. A POP3 protocol error occurred.
  18418. </exception>
  18419. </member>
  18420. <member name="M:MailKit.Net.Pop3.Pop3Client.Connect(System.Net.Sockets.Socket,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
  18421. <summary>
  18422. Establish a connection to the specified POP3 or POP3/S server using the provided socket.
  18423. </summary>
  18424. <remarks>
  18425. <para>Establishes a connection to the specified POP3 or POP3/S server using
  18426. the provided socket.</para>
  18427. <para>If the <paramref name="options"/> has a value of
  18428. <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
  18429. to determine the default security options. If the <paramref name="port"/> has a value
  18430. of <c>995</c>, then the default options used will be
  18431. <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
  18432. <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
  18433. <para>Once a connection is established, properties such as
  18434. <see cref="P:MailKit.Net.Pop3.Pop3Client.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Pop3.Pop3Client.Capabilities"/> will be
  18435. populated.</para>
  18436. <note type="info">With the exception of using the <paramref name="port"/> to determine the
  18437. default <see cref="T:MailKit.Security.SecureSocketOptions"/> to use when the <paramref name="options"/> value
  18438. is <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, the <paramref name="host"/> and
  18439. <paramref name="port"/> parameters are only used for logging purposes.</note>
  18440. </remarks>
  18441. <param name="socket">The socket to use for the connection.</param>
  18442. <param name="host">The host name to connect to.</param>
  18443. <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
  18444. <param name="options">The secure socket options to when connecting.</param>
  18445. <param name="cancellationToken">The cancellation token.</param>
  18446. <exception cref="T:System.ArgumentNullException">
  18447. <para><paramref name="socket"/> is <c>null</c>.</para>
  18448. <para>-or-</para>
  18449. <para><paramref name="host"/> is <c>null</c>.</para>
  18450. </exception>
  18451. <exception cref="T:System.ArgumentOutOfRangeException">
  18452. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  18453. </exception>
  18454. <exception cref="T:System.ArgumentException">
  18455. <para><paramref name="socket"/> is not connected.</para>
  18456. <para>-or-</para>
  18457. <para>The <paramref name="host"/> is a zero-length string.</para>
  18458. </exception>
  18459. <exception cref="T:System.ObjectDisposedException">
  18460. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  18461. </exception>
  18462. <exception cref="T:System.InvalidOperationException">
  18463. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is already connected.
  18464. </exception>
  18465. <exception cref="T:System.NotSupportedException">
  18466. <paramref name="options"/> was set to
  18467. <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
  18468. and the POP3 server does not support the STLS extension.
  18469. </exception>
  18470. <exception cref="T:System.OperationCanceledException">
  18471. The operation was canceled via the cancellation token.
  18472. </exception>
  18473. <exception cref="T:MailKit.Security.SslHandshakeException">
  18474. An error occurred during the SSL/TLS negotiations.
  18475. </exception>
  18476. <exception cref="T:System.IO.IOException">
  18477. An I/O error occurred.
  18478. </exception>
  18479. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  18480. A POP3 command failed.
  18481. </exception>
  18482. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  18483. A POP3 protocol error occurred.
  18484. </exception>
  18485. </member>
  18486. <member name="M:MailKit.Net.Pop3.Pop3Client.Connect(System.IO.Stream,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
  18487. <summary>
  18488. Establish a connection to the specified POP3 or POP3/S server using the provided stream.
  18489. </summary>
  18490. <remarks>
  18491. <para>Establishes a connection to the specified POP3 or POP3/S server using
  18492. the provided stream.</para>
  18493. <para>If the <paramref name="options"/> has a value of
  18494. <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
  18495. to determine the default security options. If the <paramref name="port"/> has a value
  18496. of <c>995</c>, then the default options used will be
  18497. <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
  18498. <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
  18499. <para>Once a connection is established, properties such as
  18500. <see cref="P:MailKit.Net.Pop3.Pop3Client.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Pop3.Pop3Client.Capabilities"/> will be
  18501. populated.</para>
  18502. <note type="info">With the exception of using the <paramref name="port"/> to determine the
  18503. default <see cref="T:MailKit.Security.SecureSocketOptions"/> to use when the <paramref name="options"/> value
  18504. is <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, the <paramref name="host"/> and
  18505. <paramref name="port"/> parameters are only used for logging purposes.</note>
  18506. </remarks>
  18507. <param name="stream">The stream to use for the connection.</param>
  18508. <param name="host">The host name to connect to.</param>
  18509. <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
  18510. <param name="options">The secure socket options to when connecting.</param>
  18511. <param name="cancellationToken">The cancellation token.</param>
  18512. <exception cref="T:System.ArgumentNullException">
  18513. <para><paramref name="stream"/> is <c>null</c>.</para>
  18514. <para>-or-</para>
  18515. <para><paramref name="host"/> is <c>null</c>.</para>
  18516. </exception>
  18517. <exception cref="T:System.ArgumentOutOfRangeException">
  18518. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  18519. </exception>
  18520. <exception cref="T:System.ArgumentException">
  18521. The <paramref name="host"/> is a zero-length string.
  18522. </exception>
  18523. <exception cref="T:System.ObjectDisposedException">
  18524. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  18525. </exception>
  18526. <exception cref="T:System.InvalidOperationException">
  18527. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is already connected.
  18528. </exception>
  18529. <exception cref="T:System.NotSupportedException">
  18530. <paramref name="options"/> was set to
  18531. <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
  18532. and the POP3 server does not support the STLS extension.
  18533. </exception>
  18534. <exception cref="T:System.OperationCanceledException">
  18535. The operation was canceled via the cancellation token.
  18536. </exception>
  18537. <exception cref="T:MailKit.Security.SslHandshakeException">
  18538. An error occurred during the SSL/TLS negotiations.
  18539. </exception>
  18540. <exception cref="T:System.IO.IOException">
  18541. An I/O error occurred.
  18542. </exception>
  18543. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  18544. A POP3 command failed.
  18545. </exception>
  18546. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  18547. A POP3 protocol error occurred.
  18548. </exception>
  18549. </member>
  18550. <member name="M:MailKit.Net.Pop3.Pop3Client.Disconnect(System.Boolean,System.Threading.CancellationToken)">
  18551. <summary>
  18552. Disconnect the service.
  18553. </summary>
  18554. <remarks>
  18555. If <paramref name="quit"/> is <c>true</c>, a <c>QUIT</c> command will be issued in order to disconnect cleanly.
  18556. </remarks>
  18557. <example>
  18558. <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadMessages"/>
  18559. </example>
  18560. <param name="quit">If set to <c>true</c>, a <c>QUIT</c> command will be issued in order to disconnect cleanly.</param>
  18561. <param name="cancellationToken">The cancellation token.</param>
  18562. <exception cref="T:System.ObjectDisposedException">
  18563. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  18564. </exception>
  18565. </member>
  18566. <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageCount(System.Threading.CancellationToken)">
  18567. <summary>
  18568. Get the message count.
  18569. </summary>
  18570. <remarks>
  18571. Gets the message count.
  18572. </remarks>
  18573. <returns>The message count.</returns>
  18574. <param name="cancellationToken">The cancellation token.</param>
  18575. <exception cref="T:System.ObjectDisposedException">
  18576. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  18577. </exception>
  18578. <exception cref="T:MailKit.ServiceNotConnectedException">
  18579. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  18580. </exception>
  18581. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  18582. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  18583. </exception>
  18584. <exception cref="T:System.OperationCanceledException">
  18585. The operation was canceled via the cancellation token.
  18586. </exception>
  18587. <exception cref="T:System.IO.IOException">
  18588. An I/O error occurred.
  18589. </exception>
  18590. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  18591. The POP3 command failed.
  18592. </exception>
  18593. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  18594. A POP3 protocol error occurred.
  18595. </exception>
  18596. </member>
  18597. <member name="M:MailKit.Net.Pop3.Pop3Client.NoOp(System.Threading.CancellationToken)">
  18598. <summary>
  18599. Ping the POP3 server to keep the connection alive.
  18600. </summary>
  18601. <remarks>Mail servers, if left idle for too long, will automatically drop the connection.</remarks>
  18602. <param name="cancellationToken">The cancellation token.</param>
  18603. <exception cref="T:System.ObjectDisposedException">
  18604. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  18605. </exception>
  18606. <exception cref="T:MailKit.ServiceNotConnectedException">
  18607. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  18608. </exception>
  18609. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  18610. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  18611. </exception>
  18612. <exception cref="T:System.OperationCanceledException">
  18613. The operation was canceled via the cancellation token.
  18614. </exception>
  18615. <exception cref="T:System.IO.IOException">
  18616. An I/O error occurred.
  18617. </exception>
  18618. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  18619. The POP3 command failed.
  18620. </exception>
  18621. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  18622. A POP3 protocol error occurred.
  18623. </exception>
  18624. </member>
  18625. <member name="M:MailKit.Net.Pop3.Pop3Client.EnableUTF8(System.Threading.CancellationToken)">
  18626. <summary>
  18627. Enable UTF8 mode.
  18628. </summary>
  18629. <remarks>
  18630. The POP3 UTF8 extension allows the client to retrieve messages in the UTF-8 encoding and
  18631. may also allow the user to authenticate using a UTF-8 encoded username or password.
  18632. </remarks>
  18633. <param name="cancellationToken">The cancellation token.</param>
  18634. <exception cref="T:System.ObjectDisposedException">
  18635. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  18636. </exception>
  18637. <exception cref="T:MailKit.ServiceNotConnectedException">
  18638. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  18639. </exception>
  18640. <exception cref="T:System.InvalidOperationException">
  18641. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has already been authenticated.
  18642. </exception>
  18643. <exception cref="T:System.OperationCanceledException">
  18644. The operation was canceled via the cancellation token.
  18645. </exception>
  18646. <exception cref="T:System.NotSupportedException">
  18647. The POP3 server does not support the UTF8 extension.
  18648. </exception>
  18649. <exception cref="T:System.IO.IOException">
  18650. An I/O error occurred.
  18651. </exception>
  18652. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  18653. The POP3 command failed.
  18654. </exception>
  18655. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  18656. A POP3 protocol error occurred.
  18657. </exception>
  18658. </member>
  18659. <member name="M:MailKit.Net.Pop3.Pop3Client.GetLanguages(System.Threading.CancellationToken)">
  18660. <summary>
  18661. Get the list of languages supported by the POP3 server.
  18662. </summary>
  18663. <remarks>
  18664. If the POP3 server supports the LANG extension, it is possible to
  18665. query the list of languages supported by the POP3 server that can
  18666. be used for error messages.
  18667. </remarks>
  18668. <returns>The supported languages.</returns>
  18669. <param name="cancellationToken">The cancellation token.</param>
  18670. <exception cref="T:System.ObjectDisposedException">
  18671. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  18672. </exception>
  18673. <exception cref="T:MailKit.ServiceNotConnectedException">
  18674. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  18675. </exception>
  18676. <exception cref="T:System.OperationCanceledException">
  18677. The operation was canceled via the cancellation token.
  18678. </exception>
  18679. <exception cref="T:System.NotSupportedException">
  18680. The POP3 server does not support the LANG extension.
  18681. </exception>
  18682. <exception cref="T:System.IO.IOException">
  18683. An I/O error occurred.
  18684. </exception>
  18685. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  18686. The POP3 command failed.
  18687. </exception>
  18688. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  18689. A POP3 protocol error occurred.
  18690. </exception>
  18691. </member>
  18692. <member name="M:MailKit.Net.Pop3.Pop3Client.SetLanguage(System.String,System.Threading.CancellationToken)">
  18693. <summary>
  18694. Set the language used by the POP3 server for error messages.
  18695. </summary>
  18696. <remarks>
  18697. If the POP3 server supports the LANG extension, it is possible to
  18698. set the language used by the POP3 server for error messages.
  18699. </remarks>
  18700. <param name="lang">The language code.</param>
  18701. <param name="cancellationToken">The cancellation token.</param>
  18702. <exception cref="T:System.ArgumentNullException">
  18703. <paramref name="lang"/> is <c>null</c>.
  18704. </exception>
  18705. <exception cref="T:System.ArgumentException">
  18706. <paramref name="lang"/> is empty.
  18707. </exception>
  18708. <exception cref="T:System.ObjectDisposedException">
  18709. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  18710. </exception>
  18711. <exception cref="T:MailKit.ServiceNotConnectedException">
  18712. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  18713. </exception>
  18714. <exception cref="T:System.OperationCanceledException">
  18715. The operation was canceled via the cancellation token.
  18716. </exception>
  18717. <exception cref="T:System.NotSupportedException">
  18718. The POP3 server does not support the LANG extension.
  18719. </exception>
  18720. <exception cref="T:System.IO.IOException">
  18721. An I/O error occurred.
  18722. </exception>
  18723. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  18724. The POP3 command failed.
  18725. </exception>
  18726. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  18727. A POP3 protocol error occurred.
  18728. </exception>
  18729. </member>
  18730. <member name="P:MailKit.Net.Pop3.Pop3Client.Count">
  18731. <summary>
  18732. Get the number of messages available in the message spool.
  18733. </summary>
  18734. <remarks>
  18735. <para>Gets the number of messages available on the POP3 server.</para>
  18736. <para>Once authenticated, the <see cref="P:MailKit.Net.Pop3.Pop3Client.Count"/> property will be set
  18737. to the number of available messages on the POP3 server.</para>
  18738. </remarks>
  18739. <example>
  18740. <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadMessages"/>
  18741. </example>
  18742. <value>The message count.</value>
  18743. <exception cref="T:System.ObjectDisposedException">
  18744. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  18745. </exception>
  18746. <exception cref="T:MailKit.ServiceNotConnectedException">
  18747. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  18748. </exception>
  18749. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  18750. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  18751. </exception>
  18752. </member>
  18753. <member name="P:MailKit.Net.Pop3.Pop3Client.SupportsUids">
  18754. <summary>
  18755. Gets whether or not the <see cref="T:MailKit.Net.Pop3.Pop3Client"/> supports referencing messages by UIDs.
  18756. </summary>
  18757. <remarks>
  18758. <para>Not all servers support referencing messages by UID, so this property should
  18759. be checked before using <see cref="M:MailKit.Net.Pop3.Pop3Client.GetMessageUid(System.Int32,System.Threading.CancellationToken)"/>
  18760. and <see cref="M:MailKit.Net.Pop3.Pop3Client.GetMessageUids(System.Threading.CancellationToken)"/>.</para>
  18761. <para>If the server does not support UIDs, then all methods that take UID arguments
  18762. along with <see cref="M:MailKit.Net.Pop3.Pop3Client.GetMessageUid(System.Int32,System.Threading.CancellationToken)"/> and
  18763. <see cref="M:MailKit.Net.Pop3.Pop3Client.GetMessageUids(System.Threading.CancellationToken)"/> will fail.</para>
  18764. </remarks>
  18765. <value><c>true</c> if supports UIDs; otherwise, <c>false</c>.</value>
  18766. <exception cref="T:System.ObjectDisposedException">
  18767. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  18768. </exception>
  18769. <exception cref="T:MailKit.ServiceNotConnectedException">
  18770. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  18771. </exception>
  18772. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  18773. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  18774. </exception>
  18775. </member>
  18776. <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageUid(System.Int32,System.Threading.CancellationToken)">
  18777. <summary>
  18778. Get the UID of the message at the specified index.
  18779. </summary>
  18780. <remarks>
  18781. <para>Gets the UID of the message at the specified index.</para>
  18782. <note type="warning">Not all servers support UIDs, so you should first check the
  18783. <see cref="P:MailKit.Net.Pop3.Pop3Client.Capabilities"/> property for the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.UIDL"/> flag or
  18784. the <see cref="P:MailKit.Net.Pop3.Pop3Client.SupportsUids"/> convenience property.</note>
  18785. </remarks>
  18786. <returns>The message UID.</returns>
  18787. <param name="index">The message index.</param>
  18788. <param name="cancellationToken">The cancellation token.</param>
  18789. <exception cref="T:System.ArgumentOutOfRangeException">
  18790. <paramref name="index"/> is not a valid message index.
  18791. </exception>
  18792. <exception cref="T:System.ObjectDisposedException">
  18793. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  18794. </exception>
  18795. <exception cref="T:MailKit.ServiceNotConnectedException">
  18796. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  18797. </exception>
  18798. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  18799. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  18800. </exception>
  18801. <exception cref="T:System.NotSupportedException">
  18802. The POP3 server does not support the UIDL extension.
  18803. </exception>
  18804. <exception cref="T:System.OperationCanceledException">
  18805. The operation was canceled via the cancellation token.
  18806. </exception>
  18807. <exception cref="T:System.IO.IOException">
  18808. An I/O error occurred.
  18809. </exception>
  18810. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  18811. The POP3 command failed.
  18812. </exception>
  18813. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  18814. A POP3 protocol error occurred.
  18815. </exception>
  18816. </member>
  18817. <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageUids(System.Threading.CancellationToken)">
  18818. <summary>
  18819. Get the full list of available message UIDs.
  18820. </summary>
  18821. <remarks>
  18822. <para>Gets the full list of available message UIDs.</para>
  18823. <note type="warning">Not all servers support UIDs, so you should first check the
  18824. <see cref="P:MailKit.Net.Pop3.Pop3Client.Capabilities"/> property for the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.UIDL"/> flag or
  18825. the <see cref="P:MailKit.Net.Pop3.Pop3Client.SupportsUids"/> convenience property.</note>
  18826. </remarks>
  18827. <example>
  18828. <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadNewMessages"/>
  18829. </example>
  18830. <returns>The message uids.</returns>
  18831. <param name="cancellationToken">The cancellation token.</param>
  18832. <exception cref="T:System.ObjectDisposedException">
  18833. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  18834. </exception>
  18835. <exception cref="T:MailKit.ServiceNotConnectedException">
  18836. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  18837. </exception>
  18838. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  18839. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  18840. </exception>
  18841. <exception cref="T:System.NotSupportedException">
  18842. The POP3 server does not support the UIDL extension.
  18843. </exception>
  18844. <exception cref="T:System.OperationCanceledException">
  18845. The operation was canceled via the cancellation token.
  18846. </exception>
  18847. <exception cref="T:System.IO.IOException">
  18848. An I/O error occurred.
  18849. </exception>
  18850. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  18851. The POP3 command failed.
  18852. </exception>
  18853. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  18854. A POP3 protocol error occurred.
  18855. </exception>
  18856. </member>
  18857. <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageSize(System.Int32,System.Threading.CancellationToken)">
  18858. <summary>
  18859. Get the size of the specified message, in bytes.
  18860. </summary>
  18861. <remarks>
  18862. Gets the size of the specified message, in bytes.
  18863. </remarks>
  18864. <returns>The message size, in bytes.</returns>
  18865. <param name="index">The index of the message.</param>
  18866. <param name="cancellationToken">The cancellation token.</param>
  18867. <exception cref="T:System.ArgumentOutOfRangeException">
  18868. <paramref name="index"/> is not a valid message index.
  18869. </exception>
  18870. <exception cref="T:System.ObjectDisposedException">
  18871. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  18872. </exception>
  18873. <exception cref="T:MailKit.ServiceNotConnectedException">
  18874. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  18875. </exception>
  18876. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  18877. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  18878. </exception>
  18879. <exception cref="T:System.OperationCanceledException">
  18880. The operation was canceled via the cancellation token.
  18881. </exception>
  18882. <exception cref="T:System.IO.IOException">
  18883. An I/O error occurred.
  18884. </exception>
  18885. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  18886. The POP3 command failed.
  18887. </exception>
  18888. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  18889. A POP3 protocol error occurred.
  18890. </exception>
  18891. </member>
  18892. <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageSizes(System.Threading.CancellationToken)">
  18893. <summary>
  18894. Get the sizes for all available messages, in bytes.
  18895. </summary>
  18896. <remarks>
  18897. Gets the sizes for all available messages, in bytes.
  18898. </remarks>
  18899. <returns>The message sizes, in bytes.</returns>
  18900. <param name="cancellationToken">The cancellation token.</param>
  18901. <exception cref="T:System.ObjectDisposedException">
  18902. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  18903. </exception>
  18904. <exception cref="T:MailKit.ServiceNotConnectedException">
  18905. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  18906. </exception>
  18907. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  18908. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  18909. </exception>
  18910. <exception cref="T:System.OperationCanceledException">
  18911. The operation was canceled via the cancellation token.
  18912. </exception>
  18913. <exception cref="T:System.IO.IOException">
  18914. An I/O error occurred.
  18915. </exception>
  18916. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  18917. The POP3 command failed.
  18918. </exception>
  18919. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  18920. A POP3 protocol error occurred.
  18921. </exception>
  18922. </member>
  18923. <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageHeaders(System.Int32,System.Threading.CancellationToken)">
  18924. <summary>
  18925. Get the headers for the message at the specified index.
  18926. </summary>
  18927. <remarks>
  18928. Gets the headers for the message at the specified index.
  18929. </remarks>
  18930. <returns>The message headers.</returns>
  18931. <param name="index">The index of the message.</param>
  18932. <param name="cancellationToken">The cancellation token.</param>
  18933. <exception cref="T:System.ArgumentOutOfRangeException">
  18934. <paramref name="index"/> is not a valid message index.
  18935. </exception>
  18936. <exception cref="T:System.ObjectDisposedException">
  18937. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  18938. </exception>
  18939. <exception cref="T:MailKit.ServiceNotConnectedException">
  18940. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  18941. </exception>
  18942. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  18943. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  18944. </exception>
  18945. <exception cref="T:System.OperationCanceledException">
  18946. The operation was canceled via the cancellation token.
  18947. </exception>
  18948. <exception cref="T:System.IO.IOException">
  18949. An I/O error occurred.
  18950. </exception>
  18951. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  18952. The POP3 command failed.
  18953. </exception>
  18954. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  18955. A POP3 protocol error occurred.
  18956. </exception>
  18957. </member>
  18958. <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageHeaders(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken)">
  18959. <summary>
  18960. Get the headers for the messages at the specified indexes.
  18961. </summary>
  18962. <remarks>
  18963. <para>Gets the headers for the messages at the specified indexes.</para>
  18964. <para>When the POP3 server supports the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Pipelining"/>
  18965. extension, this method will likely be more efficient than using
  18966. <see cref="M:MailKit.Net.Pop3.Pop3Client.GetMessageHeaders(System.Int32,System.Threading.CancellationToken)"/> for each message because
  18967. it will batch the commands to reduce latency.</para>
  18968. </remarks>
  18969. <returns>The headers for the specified messages.</returns>
  18970. <param name="indexes">The indexes of the messages.</param>
  18971. <param name="cancellationToken">The cancellation token.</param>
  18972. <exception cref="T:System.ArgumentNullException">
  18973. <paramref name="indexes"/> is <c>null</c>.
  18974. </exception>
  18975. <exception cref="T:System.ArgumentException">
  18976. One or more of the <paramref name="indexes"/> are invalid.
  18977. </exception>
  18978. <exception cref="T:System.ObjectDisposedException">
  18979. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  18980. </exception>
  18981. <exception cref="T:MailKit.ServiceNotConnectedException">
  18982. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  18983. </exception>
  18984. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  18985. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  18986. </exception>
  18987. <exception cref="T:System.NotSupportedException">
  18988. The POP3 server does not support the UIDL extension.
  18989. </exception>
  18990. <exception cref="T:System.OperationCanceledException">
  18991. The operation was canceled via the cancellation token.
  18992. </exception>
  18993. <exception cref="T:System.IO.IOException">
  18994. An I/O error occurred.
  18995. </exception>
  18996. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  18997. The POP3 command failed.
  18998. </exception>
  18999. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  19000. A POP3 protocol error occurred.
  19001. </exception>
  19002. </member>
  19003. <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessageHeaders(System.Int32,System.Int32,System.Threading.CancellationToken)">
  19004. <summary>
  19005. Get the headers of the messages within the specified range.
  19006. </summary>
  19007. <remarks>
  19008. <para>Gets the headers of the messages within the specified range.</para>
  19009. <para>When the POP3 server supports the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Pipelining"/>
  19010. extension, this method will likely be more efficient than using
  19011. <see cref="M:MailKit.Net.Pop3.Pop3Client.GetMessageHeaders(System.Int32,System.Threading.CancellationToken)"/> for each message because
  19012. it will batch the commands to reduce latency.</para>
  19013. </remarks>
  19014. <returns>The headers of the messages within the specified range.</returns>
  19015. <param name="startIndex">The index of the first message to get.</param>
  19016. <param name="count">The number of messages to get.</param>
  19017. <param name="cancellationToken">The cancellation token.</param>
  19018. <exception cref="T:System.ArgumentOutOfRangeException">
  19019. <paramref name="startIndex"/> and <paramref name="count"/> do not specify
  19020. a valid range of messages.
  19021. </exception>
  19022. <exception cref="T:System.ObjectDisposedException">
  19023. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  19024. </exception>
  19025. <exception cref="T:MailKit.ServiceNotConnectedException">
  19026. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  19027. </exception>
  19028. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  19029. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  19030. </exception>
  19031. <exception cref="T:System.NotSupportedException">
  19032. The POP3 server does not support the UIDL extension.
  19033. </exception>
  19034. <exception cref="T:System.OperationCanceledException">
  19035. The operation was canceled via the cancellation token.
  19036. </exception>
  19037. <exception cref="T:System.IO.IOException">
  19038. An I/O error occurred.
  19039. </exception>
  19040. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  19041. The POP3 command failed.
  19042. </exception>
  19043. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  19044. A POP3 protocol error occurred.
  19045. </exception>
  19046. </member>
  19047. <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessage(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  19048. <summary>
  19049. Get the message at the specified index.
  19050. </summary>
  19051. <remarks>
  19052. Gets the message at the specified index.
  19053. </remarks>
  19054. <example>
  19055. <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadMessages"/>
  19056. </example>
  19057. <returns>The message.</returns>
  19058. <param name="index">The index of the message.</param>
  19059. <param name="cancellationToken">The cancellation token.</param>
  19060. <param name="progress">The progress reporting mechanism.</param>
  19061. <exception cref="T:System.ArgumentOutOfRangeException">
  19062. <paramref name="index"/> is not a valid message index.
  19063. </exception>
  19064. <exception cref="T:System.ObjectDisposedException">
  19065. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  19066. </exception>
  19067. <exception cref="T:MailKit.ServiceNotConnectedException">
  19068. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  19069. </exception>
  19070. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  19071. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  19072. </exception>
  19073. <exception cref="T:System.OperationCanceledException">
  19074. The operation was canceled via the cancellation token.
  19075. </exception>
  19076. <exception cref="T:System.IO.IOException">
  19077. An I/O error occurred.
  19078. </exception>
  19079. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  19080. The POP3 command failed.
  19081. </exception>
  19082. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  19083. A POP3 protocol error occurred.
  19084. </exception>
  19085. </member>
  19086. <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessages(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  19087. <summary>
  19088. Get the messages at the specified indexes.
  19089. </summary>
  19090. <remarks>
  19091. <para>Gets the messages at the specified indexes.</para>
  19092. <para>When the POP3 server supports the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Pipelining"/>
  19093. extension, this method will likely be more efficient than using
  19094. <see cref="M:MailKit.Net.Pop3.Pop3Client.GetMessage(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)"/> for each message
  19095. because it will batch the commands to reduce latency.</para>
  19096. </remarks>
  19097. <returns>The messages.</returns>
  19098. <param name="indexes">The indexes of the messages.</param>
  19099. <param name="cancellationToken">The cancellation token.</param>
  19100. <param name="progress">The progress reporting mechanism.</param>
  19101. <exception cref="T:System.ArgumentNullException">
  19102. <paramref name="indexes"/> is <c>null</c>.
  19103. </exception>
  19104. <exception cref="T:System.ArgumentException">
  19105. One or more of the <paramref name="indexes"/> are invalid.
  19106. </exception>
  19107. <exception cref="T:System.ObjectDisposedException">
  19108. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  19109. </exception>
  19110. <exception cref="T:MailKit.ServiceNotConnectedException">
  19111. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  19112. </exception>
  19113. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  19114. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  19115. </exception>
  19116. <exception cref="T:System.NotSupportedException">
  19117. The POP3 server does not support the UIDL extension.
  19118. </exception>
  19119. <exception cref="T:System.OperationCanceledException">
  19120. The operation was canceled via the cancellation token.
  19121. </exception>
  19122. <exception cref="T:System.IO.IOException">
  19123. An I/O error occurred.
  19124. </exception>
  19125. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  19126. The POP3 command failed.
  19127. </exception>
  19128. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  19129. A POP3 protocol error occurred.
  19130. </exception>
  19131. </member>
  19132. <member name="M:MailKit.Net.Pop3.Pop3Client.GetMessages(System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  19133. <summary>
  19134. Get the messages within the specified range.
  19135. </summary>
  19136. <remarks>
  19137. <para>Gets the messages within the specified range.</para>
  19138. <para>When the POP3 server supports the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Pipelining"/>
  19139. extension, this method will likely be more efficient than using
  19140. <see cref="M:MailKit.Net.Pop3.Pop3Client.GetMessage(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)"/> for each message
  19141. because it will batch the commands to reduce latency.</para>
  19142. </remarks>
  19143. <example>
  19144. <code language="c#" source="Examples\Pop3Examples.cs" region="BatchDownloadMessages"/>
  19145. </example>
  19146. <returns>The messages.</returns>
  19147. <param name="startIndex">The index of the first message to get.</param>
  19148. <param name="count">The number of messages to get.</param>
  19149. <param name="cancellationToken">The cancellation token.</param>
  19150. <param name="progress">The progress reporting mechanism.</param>
  19151. <exception cref="T:System.ArgumentOutOfRangeException">
  19152. <paramref name="startIndex"/> and <paramref name="count"/> do not specify
  19153. a valid range of messages.
  19154. </exception>
  19155. <exception cref="T:System.ObjectDisposedException">
  19156. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  19157. </exception>
  19158. <exception cref="T:MailKit.ServiceNotConnectedException">
  19159. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  19160. </exception>
  19161. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  19162. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  19163. </exception>
  19164. <exception cref="T:System.NotSupportedException">
  19165. The POP3 server does not support the UIDL extension.
  19166. </exception>
  19167. <exception cref="T:System.OperationCanceledException">
  19168. The operation was canceled via the cancellation token.
  19169. </exception>
  19170. <exception cref="T:System.IO.IOException">
  19171. An I/O error occurred.
  19172. </exception>
  19173. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  19174. The POP3 command failed.
  19175. </exception>
  19176. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  19177. A POP3 protocol error occurred.
  19178. </exception>
  19179. </member>
  19180. <member name="M:MailKit.Net.Pop3.Pop3Client.GetStream(System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  19181. <summary>
  19182. Get the message or header stream at the specified index.
  19183. </summary>
  19184. <remarks>
  19185. Gets the message or header stream at the specified index.
  19186. </remarks>
  19187. <returns>The message or header stream.</returns>
  19188. <param name="index">The index of the message.</param>
  19189. <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
  19190. <param name="cancellationToken">The cancellation token.</param>
  19191. <param name="progress">The progress reporting mechanism.</param>
  19192. <exception cref="T:System.ArgumentOutOfRangeException">
  19193. <paramref name="index"/> is not a valid message index.
  19194. </exception>
  19195. <exception cref="T:System.ObjectDisposedException">
  19196. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  19197. </exception>
  19198. <exception cref="T:MailKit.ServiceNotConnectedException">
  19199. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  19200. </exception>
  19201. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  19202. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  19203. </exception>
  19204. <exception cref="T:System.OperationCanceledException">
  19205. The operation was canceled via the cancellation token.
  19206. </exception>
  19207. <exception cref="T:System.IO.IOException">
  19208. An I/O error occurred.
  19209. </exception>
  19210. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  19211. The POP3 command failed.
  19212. </exception>
  19213. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  19214. A POP3 protocol error occurred.
  19215. </exception>
  19216. </member>
  19217. <member name="M:MailKit.Net.Pop3.Pop3Client.GetStreams(System.Collections.Generic.IList{System.Int32},System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  19218. <summary>
  19219. Get the message or header streams at the specified indexes.
  19220. </summary>
  19221. <remarks>
  19222. <para>Get the message or header streams at the specified indexes.</para>
  19223. <para>If the POP3 server supports the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Pipelining"/>
  19224. extension, this method will likely be more efficient than using
  19225. <see cref="M:MailKit.Net.Pop3.Pop3Client.GetStream(System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)"/> for each message
  19226. because it will batch the commands to reduce latency.</para>
  19227. </remarks>
  19228. <returns>The message or header streams.</returns>
  19229. <param name="indexes">The indexes of the messages.</param>
  19230. <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
  19231. <param name="cancellationToken">The cancellation token.</param>
  19232. <param name="progress">The progress reporting mechanism.</param>
  19233. <exception cref="T:System.ArgumentNullException">
  19234. <paramref name="indexes"/> is <c>null</c>.
  19235. </exception>
  19236. <exception cref="T:System.ArgumentException">
  19237. One or more of the <paramref name="indexes"/> are invalid.
  19238. </exception>
  19239. <exception cref="T:System.ObjectDisposedException">
  19240. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  19241. </exception>
  19242. <exception cref="T:MailKit.ServiceNotConnectedException">
  19243. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  19244. </exception>
  19245. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  19246. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  19247. </exception>
  19248. <exception cref="T:System.NotSupportedException">
  19249. The POP3 server does not support the UIDL extension.
  19250. </exception>
  19251. <exception cref="T:System.OperationCanceledException">
  19252. The operation was canceled via the cancellation token.
  19253. </exception>
  19254. <exception cref="T:System.IO.IOException">
  19255. An I/O error occurred.
  19256. </exception>
  19257. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  19258. The POP3 command failed.
  19259. </exception>
  19260. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  19261. A POP3 protocol error occurred.
  19262. </exception>
  19263. </member>
  19264. <member name="M:MailKit.Net.Pop3.Pop3Client.GetStreams(System.Int32,System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  19265. <summary>
  19266. Get the message or header streams within the specified range.
  19267. </summary>
  19268. <remarks>
  19269. <para>Gets the message or header streams within the specified range.</para>
  19270. <para>If the POP3 server supports the <see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Pipelining"/>
  19271. extension, this method will likely be more efficient than using
  19272. <see cref="M:MailKit.Net.Pop3.Pop3Client.GetStream(System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)"/> for each message
  19273. because it will batch the commands to reduce latency.</para>
  19274. </remarks>
  19275. <returns>The message or header streams.</returns>
  19276. <param name="startIndex">The index of the first stream to get.</param>
  19277. <param name="count">The number of streams to get.</param>
  19278. <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
  19279. <param name="cancellationToken">The cancellation token.</param>
  19280. <param name="progress">The progress reporting mechanism.</param>
  19281. <exception cref="T:System.ArgumentOutOfRangeException">
  19282. <paramref name="startIndex"/> and <paramref name="count"/> do not specify
  19283. a valid range of messages.
  19284. </exception>
  19285. <exception cref="T:System.ObjectDisposedException">
  19286. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  19287. </exception>
  19288. <exception cref="T:MailKit.ServiceNotConnectedException">
  19289. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  19290. </exception>
  19291. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  19292. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  19293. </exception>
  19294. <exception cref="T:System.NotSupportedException">
  19295. The POP3 server does not support the UIDL extension.
  19296. </exception>
  19297. <exception cref="T:System.OperationCanceledException">
  19298. The operation was canceled via the cancellation token.
  19299. </exception>
  19300. <exception cref="T:System.IO.IOException">
  19301. An I/O error occurred.
  19302. </exception>
  19303. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  19304. The POP3 command failed.
  19305. </exception>
  19306. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  19307. A POP3 protocol error occurred.
  19308. </exception>
  19309. </member>
  19310. <member name="M:MailKit.Net.Pop3.Pop3Client.DeleteMessage(System.Int32,System.Threading.CancellationToken)">
  19311. <summary>
  19312. Mark the specified message for deletion.
  19313. </summary>
  19314. <remarks>
  19315. Messages marked for deletion are not actually deleted until the session
  19316. is cleanly disconnected
  19317. (see <see cref="M:MailKit.Net.Pop3.Pop3Client.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
  19318. </remarks>
  19319. <example>
  19320. <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadMessages"/>
  19321. </example>
  19322. <param name="index">The index of the message.</param>
  19323. <param name="cancellationToken">The cancellation token.</param>
  19324. <exception cref="T:System.ArgumentOutOfRangeException">
  19325. <paramref name="index"/> is not a valid message index.
  19326. </exception>
  19327. <exception cref="T:System.ObjectDisposedException">
  19328. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  19329. </exception>
  19330. <exception cref="T:MailKit.ServiceNotConnectedException">
  19331. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  19332. </exception>
  19333. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  19334. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  19335. </exception>
  19336. <exception cref="T:System.OperationCanceledException">
  19337. The operation was canceled via the cancellation token.
  19338. </exception>
  19339. <exception cref="T:System.IO.IOException">
  19340. An I/O error occurred.
  19341. </exception>
  19342. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  19343. The POP3 command failed.
  19344. </exception>
  19345. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  19346. A POP3 protocol error occurred.
  19347. </exception>
  19348. </member>
  19349. <member name="M:MailKit.Net.Pop3.Pop3Client.DeleteMessages(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken)">
  19350. <summary>
  19351. Mark the specified messages for deletion.
  19352. </summary>
  19353. <remarks>
  19354. Messages marked for deletion are not actually deleted until the session
  19355. is cleanly disconnected
  19356. (see <see cref="M:MailKit.Net.Pop3.Pop3Client.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
  19357. </remarks>
  19358. <param name="indexes">The indexes of the messages.</param>
  19359. <param name="cancellationToken">The cancellation token.</param>
  19360. <exception cref="T:System.ArgumentNullException">
  19361. <paramref name="indexes"/> is <c>null</c>.
  19362. </exception>
  19363. <exception cref="T:System.ArgumentException">
  19364. One or more of the <paramref name="indexes"/> are invalid.
  19365. </exception>
  19366. <exception cref="T:System.ObjectDisposedException">
  19367. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  19368. </exception>
  19369. <exception cref="T:MailKit.ServiceNotConnectedException">
  19370. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  19371. </exception>
  19372. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  19373. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  19374. </exception>
  19375. <exception cref="T:System.OperationCanceledException">
  19376. The operation was canceled via the cancellation token.
  19377. </exception>
  19378. <exception cref="T:System.IO.IOException">
  19379. An I/O error occurred.
  19380. </exception>
  19381. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  19382. The POP3 command failed.
  19383. </exception>
  19384. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  19385. A POP3 protocol error occurred.
  19386. </exception>
  19387. </member>
  19388. <member name="M:MailKit.Net.Pop3.Pop3Client.DeleteMessages(System.Int32,System.Int32,System.Threading.CancellationToken)">
  19389. <summary>
  19390. Mark the specified range of messages for deletion.
  19391. </summary>
  19392. <remarks>
  19393. Messages marked for deletion are not actually deleted until the session
  19394. is cleanly disconnected
  19395. (see <see cref="M:MailKit.Net.Pop3.Pop3Client.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
  19396. </remarks>
  19397. <example>
  19398. <code language="c#" source="Examples\Pop3Examples.cs" region="BatchDownloadMessages"/>
  19399. </example>
  19400. <param name="startIndex">The index of the first message to mark for deletion.</param>
  19401. <param name="count">The number of messages to mark for deletion.</param>
  19402. <param name="cancellationToken">The cancellation token.</param>
  19403. <exception cref="T:System.ArgumentOutOfRangeException">
  19404. <paramref name="startIndex"/> and <paramref name="count"/> do not specify
  19405. a valid range of messages.
  19406. </exception>
  19407. <exception cref="T:System.ObjectDisposedException">
  19408. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  19409. </exception>
  19410. <exception cref="T:MailKit.ServiceNotConnectedException">
  19411. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  19412. </exception>
  19413. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  19414. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  19415. </exception>
  19416. <exception cref="T:System.OperationCanceledException">
  19417. The operation was canceled via the cancellation token.
  19418. </exception>
  19419. <exception cref="T:System.IO.IOException">
  19420. An I/O error occurred.
  19421. </exception>
  19422. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  19423. The POP3 command failed.
  19424. </exception>
  19425. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  19426. A POP3 protocol error occurred.
  19427. </exception>
  19428. </member>
  19429. <member name="M:MailKit.Net.Pop3.Pop3Client.DeleteAllMessages(System.Threading.CancellationToken)">
  19430. <summary>
  19431. Mark all messages for deletion.
  19432. </summary>
  19433. <remarks>
  19434. Messages marked for deletion are not actually deleted until the session
  19435. is cleanly disconnected
  19436. (see <see cref="M:MailKit.Net.Pop3.Pop3Client.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
  19437. </remarks>
  19438. <param name="cancellationToken">The cancellation token.</param>
  19439. <exception cref="T:System.ObjectDisposedException">
  19440. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  19441. </exception>
  19442. <exception cref="T:MailKit.ServiceNotConnectedException">
  19443. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  19444. </exception>
  19445. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  19446. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  19447. </exception>
  19448. <exception cref="T:System.OperationCanceledException">
  19449. The operation was canceled via the cancellation token.
  19450. </exception>
  19451. <exception cref="T:System.IO.IOException">
  19452. An I/O error occurred.
  19453. </exception>
  19454. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  19455. The POP3 command failed.
  19456. </exception>
  19457. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  19458. A POP3 protocol error occurred.
  19459. </exception>
  19460. </member>
  19461. <member name="M:MailKit.Net.Pop3.Pop3Client.Reset(System.Threading.CancellationToken)">
  19462. <summary>
  19463. Reset the state of all messages marked for deletion.
  19464. </summary>
  19465. <remarks>
  19466. Messages marked for deletion are not actually deleted until the session
  19467. is cleanly disconnected
  19468. (see <see cref="M:MailKit.Net.Pop3.Pop3Client.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
  19469. </remarks>
  19470. <param name="cancellationToken">The cancellation token.</param>
  19471. <exception cref="T:System.ObjectDisposedException">
  19472. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  19473. </exception>
  19474. <exception cref="T:MailKit.ServiceNotConnectedException">
  19475. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  19476. </exception>
  19477. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  19478. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  19479. </exception>
  19480. <exception cref="T:System.OperationCanceledException">
  19481. The operation was canceled via the cancellation token.
  19482. </exception>
  19483. <exception cref="T:System.IO.IOException">
  19484. An I/O error occurred.
  19485. </exception>
  19486. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  19487. The POP3 command failed.
  19488. </exception>
  19489. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  19490. A POP3 protocol error occurred.
  19491. </exception>
  19492. </member>
  19493. <member name="M:MailKit.Net.Pop3.Pop3Client.GetEnumerator">
  19494. <summary>
  19495. Get an enumerator for the messages in the folder.
  19496. </summary>
  19497. <remarks>
  19498. Gets an enumerator for the messages in the folder.
  19499. </remarks>
  19500. <returns>The enumerator.</returns>
  19501. <exception cref="T:System.ObjectDisposedException">
  19502. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  19503. </exception>
  19504. <exception cref="T:MailKit.ServiceNotConnectedException">
  19505. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  19506. </exception>
  19507. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  19508. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not authenticated.
  19509. </exception>
  19510. <exception cref="T:System.OperationCanceledException">
  19511. The operation was canceled via the cancellation token.
  19512. </exception>
  19513. <exception cref="T:System.IO.IOException">
  19514. An I/O error occurred.
  19515. </exception>
  19516. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  19517. A POP3 command failed.
  19518. </exception>
  19519. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  19520. A POP3 protocol error occurred.
  19521. </exception>
  19522. </member>
  19523. <member name="M:MailKit.Net.Pop3.Pop3Client.Dispose(System.Boolean)">
  19524. <summary>
  19525. Releases the unmanaged resources used by the <see cref="T:MailKit.Net.Pop3.Pop3Client"/> and
  19526. optionally releases the managed resources.
  19527. </summary>
  19528. <remarks>
  19529. Releases the unmanaged resources used by the <see cref="T:MailKit.Net.Pop3.Pop3Client"/> and
  19530. optionally releases the managed resources.
  19531. </remarks>
  19532. <param name="disposing"><c>true</c> to release both managed and unmanaged resources;
  19533. <c>false</c> to release only the unmanaged resources.</param>
  19534. </member>
  19535. <member name="T:MailKit.Net.Pop3.IPop3Client">
  19536. <summary>
  19537. An interface for a POP3 client.
  19538. </summary>
  19539. <remarks>
  19540. Implemented by <see cref="T:MailKit.Net.Pop3.Pop3Client"/>.
  19541. </remarks>
  19542. </member>
  19543. <member name="P:MailKit.Net.Pop3.IPop3Client.Capabilities">
  19544. <summary>
  19545. Gets the capabilities supported by the POP3 server.
  19546. </summary>
  19547. <remarks>
  19548. The capabilities will not be known until a successful connection has been made
  19549. and may change once the client is authenticated.
  19550. </remarks>
  19551. <example>
  19552. <code language="c#" source="Examples\Pop3Examples.cs" region="Capabilities"/>
  19553. </example>
  19554. <value>The capabilities.</value>
  19555. <exception cref="T:System.ArgumentException">
  19556. Capabilities cannot be enabled, they may only be disabled.
  19557. </exception>
  19558. </member>
  19559. <member name="P:MailKit.Net.Pop3.IPop3Client.ExpirePolicy">
  19560. <summary>
  19561. Gets the expiration policy.
  19562. </summary>
  19563. <remarks>
  19564. <para>If the server supports the EXPIRE capability (<see cref="F:MailKit.Net.Pop3.Pop3Capabilities.Expire"/>), the value
  19565. of the <see cref="P:MailKit.Net.Pop3.IPop3Client.ExpirePolicy"/> property will reflect the value advertized by the server.</para>
  19566. <para>A value of <c>-1</c> indicates that messages will never expire.</para>
  19567. <para>A value of <c>0</c> indicates that messages that have been retrieved during the current session
  19568. will be purged immediately after the connection is closed via the <c>QUIT</c> command.</para>
  19569. <para>Values larger than <c>0</c> indicate the minimum number of days that the server will retain
  19570. messages which have been retrieved.</para>
  19571. </remarks>
  19572. <example>
  19573. <code language="c#" source="Examples\Pop3Examples.cs" region="Capabilities"/>
  19574. </example>
  19575. <value>The expiration policy.</value>
  19576. </member>
  19577. <member name="P:MailKit.Net.Pop3.IPop3Client.Implementation">
  19578. <summary>
  19579. Gets the implementation details of the server.
  19580. </summary>
  19581. <remarks>
  19582. If the server advertizes its implementation details, this value will be set to a string containing the
  19583. information details provided by the server.
  19584. </remarks>
  19585. <value>The implementation details.</value>
  19586. </member>
  19587. <member name="P:MailKit.Net.Pop3.IPop3Client.LoginDelay">
  19588. <summary>
  19589. Gets the minimum delay, in milliseconds, between logins.
  19590. </summary>
  19591. <remarks>
  19592. If the server supports the LOGIN-DELAY capability (<see cref="F:MailKit.Net.Pop3.Pop3Capabilities.LoginDelay"/>), this value
  19593. will be set to the minimum number of milliseconds that the client must wait between logins.
  19594. </remarks>
  19595. <example>
  19596. <code language="c#" source="Examples\Pop3Examples.cs" region="Capabilities"/>
  19597. </example>
  19598. <value>The login delay.</value>
  19599. </member>
  19600. <member name="M:MailKit.Net.Pop3.IPop3Client.EnableUTF8(System.Threading.CancellationToken)">
  19601. <summary>
  19602. Enable UTF8 mode.
  19603. </summary>
  19604. <remarks>
  19605. The POP3 UTF8 extension allows the client to retrieve messages in the UTF-8 encoding and
  19606. may also allow the user to authenticate using a UTF-8 encoded username or password.
  19607. </remarks>
  19608. <param name="cancellationToken">The cancellation token.</param>
  19609. <exception cref="T:System.ObjectDisposedException">
  19610. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  19611. </exception>
  19612. <exception cref="T:MailKit.ServiceNotConnectedException">
  19613. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  19614. </exception>
  19615. <exception cref="T:System.InvalidOperationException">
  19616. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has already been authenticated.
  19617. </exception>
  19618. <exception cref="T:System.OperationCanceledException">
  19619. The operation was canceled via the cancellation token.
  19620. </exception>
  19621. <exception cref="T:System.NotSupportedException">
  19622. The POP3 server does not support the UTF8 extension.
  19623. </exception>
  19624. <exception cref="T:System.IO.IOException">
  19625. An I/O error occurred.
  19626. </exception>
  19627. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  19628. The POP3 command failed.
  19629. </exception>
  19630. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  19631. A POP3 protocol error occurred.
  19632. </exception>
  19633. </member>
  19634. <member name="M:MailKit.Net.Pop3.IPop3Client.EnableUTF8Async(System.Threading.CancellationToken)">
  19635. <summary>
  19636. Asynchronously enable UTF8 mode.
  19637. </summary>
  19638. <remarks>
  19639. The POP3 UTF8 extension allows the client to retrieve messages in the UTF-8 encoding and
  19640. may also allow the user to authenticate using a UTF-8 encoded username or password.
  19641. </remarks>
  19642. <returns>An asynchronous task context.</returns>
  19643. <param name="cancellationToken">The cancellation token.</param>
  19644. <exception cref="T:System.ObjectDisposedException">
  19645. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  19646. </exception>
  19647. <exception cref="T:MailKit.ServiceNotConnectedException">
  19648. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  19649. </exception>
  19650. <exception cref="T:System.InvalidOperationException">
  19651. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has already been authenticated.
  19652. </exception>
  19653. <exception cref="T:System.OperationCanceledException">
  19654. The operation was canceled via the cancellation token.
  19655. </exception>
  19656. <exception cref="T:System.NotSupportedException">
  19657. The POP3 server does not support the UTF8 extension.
  19658. </exception>
  19659. <exception cref="T:System.IO.IOException">
  19660. An I/O error occurred.
  19661. </exception>
  19662. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  19663. The POP3 command failed.
  19664. </exception>
  19665. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  19666. A POP3 protocol error occurred.
  19667. </exception>
  19668. </member>
  19669. <member name="M:MailKit.Net.Pop3.IPop3Client.GetLanguages(System.Threading.CancellationToken)">
  19670. <summary>
  19671. Get the list of languages supported by the POP3 server.
  19672. </summary>
  19673. <remarks>
  19674. If the POP3 server supports the LANG extension, it is possible to
  19675. query the list of languages supported by the POP3 server that can
  19676. be used for error messages.
  19677. </remarks>
  19678. <returns>The supported languages.</returns>
  19679. <param name="cancellationToken">The cancellation token.</param>
  19680. <exception cref="T:System.ObjectDisposedException">
  19681. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  19682. </exception>
  19683. <exception cref="T:MailKit.ServiceNotConnectedException">
  19684. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  19685. </exception>
  19686. <exception cref="T:System.OperationCanceledException">
  19687. The operation was canceled via the cancellation token.
  19688. </exception>
  19689. <exception cref="T:System.NotSupportedException">
  19690. The POP3 server does not support the LANG extension.
  19691. </exception>
  19692. <exception cref="T:System.IO.IOException">
  19693. An I/O error occurred.
  19694. </exception>
  19695. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  19696. The POP3 command failed.
  19697. </exception>
  19698. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  19699. A POP3 protocol error occurred.
  19700. </exception>
  19701. </member>
  19702. <member name="M:MailKit.Net.Pop3.IPop3Client.GetLanguagesAsync(System.Threading.CancellationToken)">
  19703. <summary>
  19704. Asynchronously get the list of languages supported by the POP3 server.
  19705. </summary>
  19706. <remarks>
  19707. If the POP3 server supports the LANG extension, it is possible to
  19708. query the list of languages supported by the POP3 server that can
  19709. be used for error messages.
  19710. </remarks>
  19711. <returns>The supported languages.</returns>
  19712. <param name="cancellationToken">The cancellation token.</param>
  19713. <exception cref="T:System.ObjectDisposedException">
  19714. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  19715. </exception>
  19716. <exception cref="T:MailKit.ServiceNotConnectedException">
  19717. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  19718. </exception>
  19719. <exception cref="T:System.OperationCanceledException">
  19720. The operation was canceled via the cancellation token.
  19721. </exception>
  19722. <exception cref="T:System.NotSupportedException">
  19723. The POP3 server does not support the LANG extension.
  19724. </exception>
  19725. <exception cref="T:System.IO.IOException">
  19726. An I/O error occurred.
  19727. </exception>
  19728. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  19729. The POP3 command failed.
  19730. </exception>
  19731. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  19732. A POP3 protocol error occurred.
  19733. </exception>
  19734. </member>
  19735. <member name="M:MailKit.Net.Pop3.IPop3Client.SetLanguage(System.String,System.Threading.CancellationToken)">
  19736. <summary>
  19737. Set the language used by the POP3 server for error messages.
  19738. </summary>
  19739. <remarks>
  19740. If the POP3 server supports the LANG extension, it is possible to
  19741. set the language used by the POP3 server for error messages.
  19742. </remarks>
  19743. <param name="lang">The language code.</param>
  19744. <param name="cancellationToken">The cancellation token.</param>
  19745. <exception cref="T:System.ArgumentNullException">
  19746. <paramref name="lang"/> is <c>null</c>.
  19747. </exception>
  19748. <exception cref="T:System.ArgumentException">
  19749. <paramref name="lang"/> is empty.
  19750. </exception>
  19751. <exception cref="T:System.ObjectDisposedException">
  19752. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  19753. </exception>
  19754. <exception cref="T:MailKit.ServiceNotConnectedException">
  19755. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  19756. </exception>
  19757. <exception cref="T:System.OperationCanceledException">
  19758. The operation was canceled via the cancellation token.
  19759. </exception>
  19760. <exception cref="T:System.NotSupportedException">
  19761. The POP3 server does not support the LANG extension.
  19762. </exception>
  19763. <exception cref="T:System.IO.IOException">
  19764. An I/O error occurred.
  19765. </exception>
  19766. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  19767. The POP3 command failed.
  19768. </exception>
  19769. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  19770. A POP3 protocol error occurred.
  19771. </exception>
  19772. </member>
  19773. <member name="M:MailKit.Net.Pop3.IPop3Client.SetLanguageAsync(System.String,System.Threading.CancellationToken)">
  19774. <summary>
  19775. Asynchronously set the language used by the POP3 server for error messages.
  19776. </summary>
  19777. <remarks>
  19778. If the POP3 server supports the LANG extension, it is possible to
  19779. set the language used by the POP3 server for error messages.
  19780. </remarks>
  19781. <returns>An asynchronous task context.</returns>
  19782. <param name="lang">The language code.</param>
  19783. <param name="cancellationToken">The cancellation token.</param>
  19784. <exception cref="T:System.ArgumentNullException">
  19785. <paramref name="lang"/> is <c>null</c>.
  19786. </exception>
  19787. <exception cref="T:System.ArgumentException">
  19788. <paramref name="lang"/> is empty.
  19789. </exception>
  19790. <exception cref="T:System.ObjectDisposedException">
  19791. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> has been disposed.
  19792. </exception>
  19793. <exception cref="T:MailKit.ServiceNotConnectedException">
  19794. The <see cref="T:MailKit.Net.Pop3.Pop3Client"/> is not connected.
  19795. </exception>
  19796. <exception cref="T:System.OperationCanceledException">
  19797. The operation was canceled via the cancellation token.
  19798. </exception>
  19799. <exception cref="T:System.NotSupportedException">
  19800. The POP3 server does not support the LANG extension.
  19801. </exception>
  19802. <exception cref="T:System.IO.IOException">
  19803. An I/O error occurred.
  19804. </exception>
  19805. <exception cref="T:MailKit.Net.Pop3.Pop3CommandException">
  19806. The POP3 command failed.
  19807. </exception>
  19808. <exception cref="T:MailKit.Net.Pop3.Pop3ProtocolException">
  19809. A POP3 protocol error occurred.
  19810. </exception>
  19811. </member>
  19812. <member name="T:MailKit.Net.Pop3.Pop3Capabilities">
  19813. <summary>
  19814. Capabilities supported by a POP3 server.
  19815. </summary>
  19816. <remarks>
  19817. Capabilities are read as part of the response to the <c>CAPA</c> command that
  19818. is issued during the connection and authentication phases of the
  19819. <see cref="T:MailKit.Net.Pop3.Pop3Client"/>.
  19820. </remarks>
  19821. <example>
  19822. <code language="c#" source="Examples\Pop3Examples.cs" region="Capabilities"/>
  19823. </example>
  19824. </member>
  19825. <member name="F:MailKit.Net.Pop3.Pop3Capabilities.None">
  19826. <summary>
  19827. The server does not support any additional extensions.
  19828. </summary>
  19829. </member>
  19830. <member name="F:MailKit.Net.Pop3.Pop3Capabilities.Apop">
  19831. <summary>
  19832. The server supports <a href="https://tools.ietf.org/html/rfc1939#page-15">APOP</a>
  19833. authentication.
  19834. </summary>
  19835. </member>
  19836. <member name="F:MailKit.Net.Pop3.Pop3Capabilities.Expire">
  19837. <summary>
  19838. The server supports the <a href="https://tools.ietf.org/html/rfc2449">EXPIRE</a> extension
  19839. and defines the expiration policy for messages (see <see cref="P:MailKit.Net.Pop3.Pop3Client.ExpirePolicy"/>).
  19840. </summary>
  19841. </member>
  19842. <member name="F:MailKit.Net.Pop3.Pop3Capabilities.LoginDelay">
  19843. <summary>
  19844. The server supports the <a href="https://tools.ietf.org/html/rfc2449">LOGIN-DELAY</a> extension,
  19845. allowing the server to specify to the client a minimum number of seconds between login attempts
  19846. (see <see cref="P:MailKit.Net.Pop3.Pop3Client.LoginDelay"/>).
  19847. </summary>
  19848. </member>
  19849. <member name="F:MailKit.Net.Pop3.Pop3Capabilities.Pipelining">
  19850. <summary>
  19851. The server supports the <a href="https://tools.ietf.org/html/rfc2449">PIPELINING</a> extension,
  19852. allowing the client to batch multiple requests to the server at at time.
  19853. </summary>
  19854. </member>
  19855. <member name="F:MailKit.Net.Pop3.Pop3Capabilities.ResponseCodes">
  19856. <summary>
  19857. The server supports the <a href="https://tools.ietf.org/html/rfc2449">RESP-CODES</a> extension,
  19858. allowing the server to provide clients with extended information in error responses.
  19859. </summary>
  19860. </member>
  19861. <member name="F:MailKit.Net.Pop3.Pop3Capabilities.Sasl">
  19862. <summary>
  19863. The server supports the <a href="https://tools.ietf.org/html/rfc2449">SASL</a> authentication
  19864. extension, allowing the client to authenticate using the advertized authentication mechanisms
  19865. (see <see cref="P:MailKit.Net.Pop3.Pop3Client.AuthenticationMechanisms"/>).
  19866. </summary>
  19867. </member>
  19868. <member name="F:MailKit.Net.Pop3.Pop3Capabilities.StartTLS">
  19869. <summary>
  19870. The server supports the <a href="https://tools.ietf.org/html/rfc2595">STLS</a> extension,
  19871. allowing clients to switch to an encrypted SSL/TLS connection after connecting.
  19872. </summary>
  19873. </member>
  19874. <member name="F:MailKit.Net.Pop3.Pop3Capabilities.Top">
  19875. <summary>
  19876. The server supports the <a href="https://tools.ietf.org/html/rfc1939#page-11">TOP</a> command,
  19877. allowing clients to fetch the headers plus an arbitrary number of lines.
  19878. </summary>
  19879. </member>
  19880. <member name="F:MailKit.Net.Pop3.Pop3Capabilities.UIDL">
  19881. <summary>
  19882. The server supports the <a href="https://tools.ietf.org/html/rfc1939#page-12">UIDL</a> command,
  19883. allowing the client to refer to messages via a UID as opposed to a sequence ID.
  19884. </summary>
  19885. </member>
  19886. <member name="F:MailKit.Net.Pop3.Pop3Capabilities.User">
  19887. <summary>
  19888. The server supports the <a href="https://tools.ietf.org/html/rfc1939#page-13">USER</a>
  19889. authentication command, allowing the client to authenticate via a plain-text username
  19890. and password command (not recommended unless no other authentication mechanisms exist).
  19891. </summary>
  19892. </member>
  19893. <member name="F:MailKit.Net.Pop3.Pop3Capabilities.UTF8">
  19894. <summary>
  19895. The server supports the <a href="https://tools.ietf.org/html/rfc6856">UTF8</a> extension,
  19896. allowing clients to retrieve messages in the UTF-8 encoding.
  19897. </summary>
  19898. </member>
  19899. <member name="F:MailKit.Net.Pop3.Pop3Capabilities.UTF8User">
  19900. <summary>
  19901. The server supports the <a href="https://tools.ietf.org/html/rfc6856">UTF8=USER</a> extension,
  19902. allowing clients to authenticate using UTF-8 encoded usernames and passwords.
  19903. </summary>
  19904. </member>
  19905. <member name="F:MailKit.Net.Pop3.Pop3Capabilities.Lang">
  19906. <summary>
  19907. The server supports the <a href="https://tools.ietf.org/html/rfc6856">LANG</a> extension,
  19908. allowing clients to specify which language the server should use for error strings.
  19909. </summary>
  19910. </member>
  19911. <member name="T:MailKit.Net.Pop3.Pop3CommandHandler">
  19912. <summary>
  19913. POP3 command handler.
  19914. </summary>
  19915. <remarks>
  19916. All exceptions thrown by the handler are considered fatal and will
  19917. force-disconnect the connection. If a non-fatal error occurs, set
  19918. it on the <see cref="P:MailKit.Net.Pop3.Pop3Command.Exception"/> property.
  19919. </remarks>
  19920. </member>
  19921. <member name="T:MailKit.Net.Pop3.Pop3CommandException">
  19922. <summary>
  19923. A POP3 command exception.
  19924. </summary>
  19925. <remarks>
  19926. The exception that is thrown when a POP3 command fails. Unlike a <see cref="T:MailKit.Net.Pop3.Pop3ProtocolException"/>,
  19927. a <see cref="T:MailKit.Net.Pop3.Pop3CommandException"/> does not require the <see cref="T:MailKit.Net.Pop3.Pop3Client"/> to be reconnected.
  19928. </remarks>
  19929. <example>
  19930. <code language="c#" source="Examples\Pop3Examples.cs" region="ExceptionHandling"/>
  19931. </example>
  19932. </member>
  19933. <member name="M:MailKit.Net.Pop3.Pop3CommandException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  19934. <summary>
  19935. Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3CommandException"/> class.
  19936. </summary>
  19937. <remarks>
  19938. Creates a new <see cref="T:MailKit.Net.Pop3.Pop3CommandException"/> from the serialized data.
  19939. </remarks>
  19940. <param name="info">The serialization info.</param>
  19941. <param name="context">The streaming context.</param>
  19942. <exception cref="T:System.ArgumentNullException">
  19943. <paramref name="info"/> is <c>null</c>.
  19944. </exception>
  19945. </member>
  19946. <member name="M:MailKit.Net.Pop3.Pop3CommandException.#ctor(System.String,System.Exception)">
  19947. <summary>
  19948. Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3CommandException"/> class.
  19949. </summary>
  19950. <remarks>
  19951. Creates a new <see cref="T:MailKit.Net.Pop3.Pop3CommandException"/>.
  19952. </remarks>
  19953. <param name="message">The error message.</param>
  19954. <param name="innerException">An inner exception.</param>
  19955. </member>
  19956. <member name="M:MailKit.Net.Pop3.Pop3CommandException.#ctor(System.String,System.String,System.Exception)">
  19957. <summary>
  19958. Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3CommandException"/> class.
  19959. </summary>
  19960. <remarks>
  19961. Creates a new <see cref="T:MailKit.Net.Pop3.Pop3CommandException"/>.
  19962. </remarks>
  19963. <param name="message">The error message.</param>
  19964. <param name="statusText">The response status text.</param>
  19965. <param name="innerException">An inner exception.</param>
  19966. <exception cref="T:System.ArgumentNullException">
  19967. <paramref name="statusText"/> is <c>null</c>.
  19968. </exception>
  19969. </member>
  19970. <member name="M:MailKit.Net.Pop3.Pop3CommandException.#ctor(System.String)">
  19971. <summary>
  19972. Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3CommandException"/> class.
  19973. </summary>
  19974. <remarks>
  19975. Creates a new <see cref="T:MailKit.Net.Pop3.Pop3CommandException"/>.
  19976. </remarks>
  19977. <param name="message">The error message.</param>
  19978. </member>
  19979. <member name="M:MailKit.Net.Pop3.Pop3CommandException.#ctor(System.String,System.String)">
  19980. <summary>
  19981. Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3CommandException"/> class.
  19982. </summary>
  19983. <remarks>
  19984. Creates a new <see cref="T:MailKit.Net.Pop3.Pop3CommandException"/>.
  19985. </remarks>
  19986. <param name="message">The error message.</param>
  19987. <param name="statusText">The response status text.</param>
  19988. <exception cref="T:System.ArgumentNullException">
  19989. <paramref name="statusText"/> is <c>null</c>.
  19990. </exception>
  19991. </member>
  19992. <member name="M:MailKit.Net.Pop3.Pop3CommandException.#ctor">
  19993. <summary>
  19994. Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3CommandException"/> class.
  19995. </summary>
  19996. <remarks>
  19997. Creates a new <see cref="T:MailKit.Net.Pop3.Pop3CommandException"/>.
  19998. </remarks>
  19999. </member>
  20000. <member name="P:MailKit.Net.Pop3.Pop3CommandException.StatusText">
  20001. <summary>
  20002. Get the response status text.
  20003. </summary>
  20004. <remarks>
  20005. Gets the response status text.
  20006. </remarks>
  20007. <example>
  20008. <code language="c#" source="Examples\Pop3Examples.cs" region="ExceptionHandling"/>
  20009. </example>
  20010. <value>The response status text.</value>
  20011. </member>
  20012. <member name="M:MailKit.Net.Pop3.Pop3CommandException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  20013. <summary>
  20014. When overridden in a derived class, sets the <see cref="T:System.Runtime.Serialization.SerializationInfo"/>
  20015. with information about the exception.
  20016. </summary>
  20017. <remarks>
  20018. Serializes the state of the <see cref="T:MailKit.FolderNotFoundException"/>.
  20019. </remarks>
  20020. <param name="info">The serialization info.</param>
  20021. <param name="context">The streaming context.</param>
  20022. <exception cref="T:System.ArgumentNullException">
  20023. <paramref name="info"/> is <c>null</c>.
  20024. </exception>
  20025. </member>
  20026. <member name="T:MailKit.Net.Pop3.Pop3EngineState">
  20027. <summary>
  20028. The state of the <see cref="T:MailKit.Net.Pop3.Pop3Engine"/>.
  20029. </summary>
  20030. </member>
  20031. <member name="F:MailKit.Net.Pop3.Pop3EngineState.Disconnected">
  20032. <summary>
  20033. The Pop3Engine is in the disconnected state.
  20034. </summary>
  20035. </member>
  20036. <member name="F:MailKit.Net.Pop3.Pop3EngineState.Connected">
  20037. <summary>
  20038. The Pop3Engine is in the connected state.
  20039. </summary>
  20040. </member>
  20041. <member name="F:MailKit.Net.Pop3.Pop3EngineState.Transaction">
  20042. <summary>
  20043. The Pop3Engine is in the transaction state, indicating that it is
  20044. authenticated and may retrieve messages from the server.
  20045. </summary>
  20046. </member>
  20047. <member name="T:MailKit.Net.Pop3.Pop3Engine">
  20048. <summary>
  20049. A POP3 command engine.
  20050. </summary>
  20051. </member>
  20052. <member name="M:MailKit.Net.Pop3.Pop3Engine.#ctor">
  20053. <summary>
  20054. Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3Engine"/> class.
  20055. </summary>
  20056. </member>
  20057. <member name="P:MailKit.Net.Pop3.Pop3Engine.Uri">
  20058. <summary>
  20059. Gets the URI of the POP3 server.
  20060. </summary>
  20061. <remarks>
  20062. Gets the URI of the POP3 server.
  20063. </remarks>
  20064. <value>The URI of the POP3 server.</value>
  20065. </member>
  20066. <member name="P:MailKit.Net.Pop3.Pop3Engine.AuthenticationMechanisms">
  20067. <summary>
  20068. Gets the authentication mechanisms supported by the POP3 server.
  20069. </summary>
  20070. <remarks>
  20071. The authentication mechanisms are queried durring the
  20072. <see cref="M:MailKit.Net.Pop3.Pop3Engine.ConnectAsync(MailKit.Net.Pop3.Pop3Stream,System.Threading.CancellationToken)"/> method.
  20073. </remarks>
  20074. <value>The authentication mechanisms.</value>
  20075. </member>
  20076. <member name="P:MailKit.Net.Pop3.Pop3Engine.Capabilities">
  20077. <summary>
  20078. Gets the capabilities supported by the POP3 server.
  20079. </summary>
  20080. <remarks>
  20081. The capabilities will not be known until a successful connection
  20082. has been made via the <see cref="M:MailKit.Net.Pop3.Pop3Engine.ConnectAsync(MailKit.Net.Pop3.Pop3Stream,System.Threading.CancellationToken)"/> method.
  20083. </remarks>
  20084. <value>The capabilities.</value>
  20085. </member>
  20086. <member name="P:MailKit.Net.Pop3.Pop3Engine.Stream">
  20087. <summary>
  20088. Gets the underlying POP3 stream.
  20089. </summary>
  20090. <remarks>
  20091. Gets the underlying POP3 stream.
  20092. </remarks>
  20093. <value>The pop3 stream.</value>
  20094. </member>
  20095. <member name="P:MailKit.Net.Pop3.Pop3Engine.State">
  20096. <summary>
  20097. Gets or sets the state of the engine.
  20098. </summary>
  20099. <remarks>
  20100. Gets or sets the state of the engine.
  20101. </remarks>
  20102. <value>The engine state.</value>
  20103. </member>
  20104. <member name="P:MailKit.Net.Pop3.Pop3Engine.IsConnected">
  20105. <summary>
  20106. Gets whether or not the engine is currently connected to a POP3 server.
  20107. </summary>
  20108. <remarks>
  20109. Gets whether or not the engine is currently connected to a POP3 server.
  20110. </remarks>
  20111. <value><c>true</c> if the engine is connected; otherwise, <c>false</c>.</value>
  20112. </member>
  20113. <member name="P:MailKit.Net.Pop3.Pop3Engine.ApopToken">
  20114. <summary>
  20115. Gets the APOP authentication token.
  20116. </summary>
  20117. <remarks>
  20118. Gets the APOP authentication token.
  20119. </remarks>
  20120. <value>The APOP authentication token.</value>
  20121. </member>
  20122. <member name="P:MailKit.Net.Pop3.Pop3Engine.ExpirePolicy">
  20123. <summary>
  20124. Gets the EXPIRE extension policy value.
  20125. </summary>
  20126. <remarks>
  20127. Gets the EXPIRE extension policy value.
  20128. </remarks>
  20129. <value>The EXPIRE policy.</value>
  20130. </member>
  20131. <member name="P:MailKit.Net.Pop3.Pop3Engine.Implementation">
  20132. <summary>
  20133. Gets the implementation details of the server.
  20134. </summary>
  20135. <remarks>
  20136. Gets the implementation details of the server.
  20137. </remarks>
  20138. <value>The implementation details.</value>
  20139. </member>
  20140. <member name="P:MailKit.Net.Pop3.Pop3Engine.LoginDelay">
  20141. <summary>
  20142. Gets the login delay.
  20143. </summary>
  20144. <remarks>
  20145. Gets the login delay.
  20146. </remarks>
  20147. <value>The login delay.</value>
  20148. </member>
  20149. <member name="M:MailKit.Net.Pop3.Pop3Engine.Connect(MailKit.Net.Pop3.Pop3Stream,System.Threading.CancellationToken)">
  20150. <summary>
  20151. Takes posession of the <see cref="T:MailKit.Net.Pop3.Pop3Stream"/> and reads the greeting.
  20152. </summary>
  20153. <remarks>
  20154. Takes posession of the <see cref="T:MailKit.Net.Pop3.Pop3Stream"/> and reads the greeting.
  20155. </remarks>
  20156. <param name="pop3">The pop3 stream.</param>
  20157. <param name="cancellationToken">The cancellation token</param>
  20158. </member>
  20159. <member name="M:MailKit.Net.Pop3.Pop3Engine.ConnectAsync(MailKit.Net.Pop3.Pop3Stream,System.Threading.CancellationToken)">
  20160. <summary>
  20161. Takes posession of the <see cref="T:MailKit.Net.Pop3.Pop3Stream"/> and reads the greeting.
  20162. </summary>
  20163. <remarks>
  20164. Takes posession of the <see cref="T:MailKit.Net.Pop3.Pop3Stream"/> and reads the greeting.
  20165. </remarks>
  20166. <param name="pop3">The pop3 stream.</param>
  20167. <param name="cancellationToken">The cancellation token</param>
  20168. </member>
  20169. <member name="M:MailKit.Net.Pop3.Pop3Engine.Disconnect">
  20170. <summary>
  20171. Disconnects the <see cref="T:MailKit.Net.Pop3.Pop3Engine"/>.
  20172. </summary>
  20173. <remarks>
  20174. Disconnects the <see cref="T:MailKit.Net.Pop3.Pop3Engine"/>.
  20175. </remarks>
  20176. </member>
  20177. <member name="M:MailKit.Net.Pop3.Pop3Engine.ReadLine(System.Threading.CancellationToken)">
  20178. <summary>
  20179. Reads a single line from the <see cref="T:MailKit.Net.Pop3.Pop3Stream"/>.
  20180. </summary>
  20181. <returns>The line.</returns>
  20182. <param name="cancellationToken">The cancellation token.</param>
  20183. <exception cref="T:System.InvalidOperationException">
  20184. The engine is not connected.
  20185. </exception>
  20186. <exception cref="T:System.OperationCanceledException">
  20187. The operation was canceled via the cancellation token.
  20188. </exception>
  20189. <exception cref="T:System.IO.IOException">
  20190. An I/O error occurred.
  20191. </exception>
  20192. </member>
  20193. <member name="M:MailKit.Net.Pop3.Pop3Engine.ReadLineAsync(System.Threading.CancellationToken)">
  20194. <summary>
  20195. Reads a single line from the <see cref="T:MailKit.Net.Pop3.Pop3Stream"/>.
  20196. </summary>
  20197. <returns>The line.</returns>
  20198. <param name="cancellationToken">The cancellation token.</param>
  20199. <exception cref="T:System.InvalidOperationException">
  20200. The engine is not connected.
  20201. </exception>
  20202. <exception cref="T:System.OperationCanceledException">
  20203. The operation was canceled via the cancellation token.
  20204. </exception>
  20205. <exception cref="T:System.IO.IOException">
  20206. An I/O error occurred.
  20207. </exception>
  20208. </member>
  20209. <member name="M:MailKit.Net.Pop3.Pop3Engine.Iterate">
  20210. <summary>
  20211. Iterate the command pipeline.
  20212. </summary>
  20213. <returns>The ID of the command that just completed.</returns>
  20214. </member>
  20215. <member name="M:MailKit.Net.Pop3.Pop3Engine.IterateAsync">
  20216. <summary>
  20217. Iterate the command pipeline.
  20218. </summary>
  20219. <returns>The ID of the command that just completed.</returns>
  20220. </member>
  20221. <member name="T:MailKit.Net.Pop3.Pop3Language">
  20222. <summary>
  20223. A POP3 language.
  20224. </summary>
  20225. <remarks>
  20226. A POP3 language.
  20227. </remarks>
  20228. </member>
  20229. <member name="M:MailKit.Net.Pop3.Pop3Language.#ctor(System.String,System.String)">
  20230. <summary>
  20231. Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3Language"/> class.
  20232. </summary>
  20233. <remarks>
  20234. Creates a new <see cref="T:MailKit.Net.Pop3.Pop3Language"/>.
  20235. </remarks>
  20236. </member>
  20237. <member name="P:MailKit.Net.Pop3.Pop3Language.Language">
  20238. <summary>
  20239. Get the language code.
  20240. </summary>
  20241. <remarks>
  20242. Gets the language code. This is the value that should be given to
  20243. <see cref="M:MailKit.Net.Pop3.Pop3Client.SetLanguage(System.String,System.Threading.CancellationToken)"/>.
  20244. </remarks>
  20245. <value>The language.</value>
  20246. </member>
  20247. <member name="P:MailKit.Net.Pop3.Pop3Language.Description">
  20248. <summary>
  20249. Get the description.
  20250. </summary>
  20251. <remarks>
  20252. Gets the description.
  20253. </remarks>
  20254. <value>The description.</value>
  20255. </member>
  20256. <member name="T:MailKit.Net.Pop3.Pop3ProtocolException">
  20257. <summary>
  20258. A POP3 protocol exception.
  20259. </summary>
  20260. <remarks>
  20261. The exception that is thrown when there is an error communicating with a POP3 server. A
  20262. <see cref="T:MailKit.Net.Pop3.Pop3ProtocolException"/> is typically fatal and requires the <see cref="T:MailKit.Net.Pop3.Pop3Client"/>
  20263. to be reconnected.
  20264. </remarks>
  20265. <example>
  20266. <code language="c#" source="Examples\Pop3Examples.cs" region="ExceptionHandling"/>
  20267. </example>
  20268. </member>
  20269. <member name="M:MailKit.Net.Pop3.Pop3ProtocolException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  20270. <summary>
  20271. Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3ProtocolException"/> class.
  20272. </summary>
  20273. <remarks>
  20274. Creates a new <see cref="T:MailKit.Net.Pop3.Pop3ProtocolException"/> from the serialized data.
  20275. </remarks>
  20276. <param name="info">The serialization info.</param>
  20277. <param name="context">The streaming context.</param>
  20278. <exception cref="T:System.ArgumentNullException">
  20279. <paramref name="info"/> is <c>null</c>.
  20280. </exception>
  20281. </member>
  20282. <member name="M:MailKit.Net.Pop3.Pop3ProtocolException.#ctor(System.String,System.Exception)">
  20283. <summary>
  20284. Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3ProtocolException"/> class.
  20285. </summary>
  20286. <remarks>
  20287. Creates a new <see cref="T:MailKit.Net.Pop3.Pop3ProtocolException"/>.
  20288. </remarks>
  20289. <param name="message">The error message.</param>
  20290. <param name="innerException">An inner exception.</param>
  20291. </member>
  20292. <member name="M:MailKit.Net.Pop3.Pop3ProtocolException.#ctor(System.String)">
  20293. <summary>
  20294. Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3ProtocolException"/> class.
  20295. </summary>
  20296. <remarks>
  20297. Creates a new <see cref="T:MailKit.Net.Pop3.Pop3ProtocolException"/>.
  20298. </remarks>
  20299. <param name="message">The error message.</param>
  20300. </member>
  20301. <member name="M:MailKit.Net.Pop3.Pop3ProtocolException.#ctor">
  20302. <summary>
  20303. Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3ProtocolException"/> class.
  20304. </summary>
  20305. <remarks>
  20306. Creates a new <see cref="T:MailKit.Net.Pop3.Pop3ProtocolException"/>.
  20307. </remarks>
  20308. </member>
  20309. <member name="T:MailKit.Net.Pop3.Pop3StreamMode">
  20310. <summary>
  20311. An enumeration of the possible POP3 streaming modes.
  20312. </summary>
  20313. <remarks>
  20314. Normal operation is done in the <see cref="F:MailKit.Net.Pop3.Pop3StreamMode.Line"/> mode,
  20315. but when retrieving messages (via RETR) or headers (via TOP), the
  20316. <see cref="F:MailKit.Net.Pop3.Pop3StreamMode.Data"/> mode should be used.
  20317. </remarks>
  20318. </member>
  20319. <member name="F:MailKit.Net.Pop3.Pop3StreamMode.Line">
  20320. <summary>
  20321. Reads 1 line at a time.
  20322. </summary>
  20323. </member>
  20324. <member name="F:MailKit.Net.Pop3.Pop3StreamMode.Data">
  20325. <summary>
  20326. Reads data in chunks, ignoring line state.
  20327. </summary>
  20328. </member>
  20329. <member name="T:MailKit.Net.Pop3.Pop3Stream">
  20330. <summary>
  20331. A stream for communicating with a POP3 server.
  20332. </summary>
  20333. <remarks>
  20334. A stream capable of reading data line-by-line (<see cref="F:MailKit.Net.Pop3.Pop3StreamMode.Line"/>)
  20335. or by raw byte streams (<see cref="F:MailKit.Net.Pop3.Pop3StreamMode.Data"/>).
  20336. </remarks>
  20337. </member>
  20338. <member name="M:MailKit.Net.Pop3.Pop3Stream.#ctor(System.IO.Stream,MailKit.IProtocolLogger)">
  20339. <summary>
  20340. Initializes a new instance of the <see cref="T:MailKit.Net.Pop3.Pop3Stream"/> class.
  20341. </summary>
  20342. <remarks>
  20343. Creates a new <see cref="T:MailKit.Net.Pop3.Pop3Stream"/>.
  20344. </remarks>
  20345. <param name="source">The underlying network stream.</param>
  20346. <param name="protocolLogger">The protocol logger.</param>
  20347. </member>
  20348. <member name="P:MailKit.Net.Pop3.Pop3Stream.Stream">
  20349. <summary>
  20350. Get or sets the underlying network stream.
  20351. </summary>
  20352. <remarks>
  20353. Gets or sets the underlying network stream.
  20354. </remarks>
  20355. <value>The underlying network stream.</value>
  20356. </member>
  20357. <member name="P:MailKit.Net.Pop3.Pop3Stream.Mode">
  20358. <summary>
  20359. Gets or sets the mode used for reading.
  20360. </summary>
  20361. <value>The mode.</value>
  20362. </member>
  20363. <member name="P:MailKit.Net.Pop3.Pop3Stream.IsConnected">
  20364. <summary>
  20365. Get whether or not the stream is connected.
  20366. </summary>
  20367. <remarks>
  20368. Gets whether or not the stream is connected.
  20369. </remarks>
  20370. <value><c>true</c> if the stream is connected; otherwise, <c>false</c>.</value>
  20371. </member>
  20372. <member name="P:MailKit.Net.Pop3.Pop3Stream.IsEndOfData">
  20373. <summary>
  20374. Get whether or not the end of the raw data has been reached in <see cref="F:MailKit.Net.Pop3.Pop3StreamMode.Data"/> mode.
  20375. </summary>
  20376. <remarks>
  20377. When reading the resonse to a command such as RETR, the end of the data is marked by line matching ".\r\n".
  20378. </remarks>
  20379. <value><c>true</c> if the end of the data has been reached; otherwise, <c>false</c>.</value>
  20380. </member>
  20381. <member name="P:MailKit.Net.Pop3.Pop3Stream.CanRead">
  20382. <summary>
  20383. Get whether the stream supports reading.
  20384. </summary>
  20385. <remarks>
  20386. Gets whether the stream supports reading.
  20387. </remarks>
  20388. <value><c>true</c> if the stream supports reading; otherwise, <c>false</c>.</value>
  20389. </member>
  20390. <member name="P:MailKit.Net.Pop3.Pop3Stream.CanWrite">
  20391. <summary>
  20392. Get whether the stream supports writing.
  20393. </summary>
  20394. <remarks>
  20395. Gets whether the stream supports writing.
  20396. </remarks>
  20397. <value><c>true</c> if the stream supports writing; otherwise, <c>false</c>.</value>
  20398. </member>
  20399. <member name="P:MailKit.Net.Pop3.Pop3Stream.CanSeek">
  20400. <summary>
  20401. Get whether the stream supports seeking.
  20402. </summary>
  20403. <remarks>
  20404. Gets whether the stream supports seeking.
  20405. </remarks>
  20406. <value><c>true</c> if the stream supports seeking; otherwise, <c>false</c>.</value>
  20407. </member>
  20408. <member name="P:MailKit.Net.Pop3.Pop3Stream.CanTimeout">
  20409. <summary>
  20410. Get whether the stream supports I/O timeouts.
  20411. </summary>
  20412. <remarks>
  20413. Gets whether the stream supports I/O timeouts.
  20414. </remarks>
  20415. <value><c>true</c> if the stream supports I/O timeouts; otherwise, <c>false</c>.</value>
  20416. </member>
  20417. <member name="P:MailKit.Net.Pop3.Pop3Stream.ReadTimeout">
  20418. <summary>
  20419. Get or set a value, in milliseconds, that determines how long the stream will attempt to read before timing out.
  20420. </summary>
  20421. <remarks>
  20422. Gets or sets a value, in milliseconds, that determines how long the stream will attempt to read before timing out.
  20423. </remarks>
  20424. <returns>A value, in milliseconds, that determines how long the stream will attempt to read before timing out.</returns>
  20425. <value>The read timeout.</value>
  20426. </member>
  20427. <member name="P:MailKit.Net.Pop3.Pop3Stream.WriteTimeout">
  20428. <summary>
  20429. Get or set a value, in milliseconds, that determines how long the stream will attempt to write before timing out.
  20430. </summary>
  20431. <remarks>
  20432. Gets or sets a value, in milliseconds, that determines how long the stream will attempt to write before timing out.
  20433. </remarks>
  20434. <returns>A value, in milliseconds, that determines how long the stream will attempt to write before timing out.</returns>
  20435. <value>The write timeout.</value>
  20436. </member>
  20437. <member name="P:MailKit.Net.Pop3.Pop3Stream.Position">
  20438. <summary>
  20439. Get or set the position within the current stream.
  20440. </summary>
  20441. <remarks>
  20442. Gets or sets the position within the current stream.
  20443. </remarks>
  20444. <returns>The current position within the stream.</returns>
  20445. <value>The position of the stream.</value>
  20446. <exception cref="T:System.IO.IOException">
  20447. An I/O error occurred.
  20448. </exception>
  20449. <exception cref="T:System.NotSupportedException">
  20450. The stream does not support seeking.
  20451. </exception>
  20452. <exception cref="T:System.ObjectDisposedException">
  20453. The stream has been disposed.
  20454. </exception>
  20455. </member>
  20456. <member name="P:MailKit.Net.Pop3.Pop3Stream.Length">
  20457. <summary>
  20458. Get the length of the stream, in bytes.
  20459. </summary>
  20460. <remarks>
  20461. Gets the length of the stream, in bytes.
  20462. </remarks>
  20463. <returns>A long value representing the length of the stream in bytes.</returns>
  20464. <value>The length of the stream.</value>
  20465. <exception cref="T:System.NotSupportedException">
  20466. The stream does not support seeking.
  20467. </exception>
  20468. <exception cref="T:System.ObjectDisposedException">
  20469. The stream has been disposed.
  20470. </exception>
  20471. </member>
  20472. <member name="M:MailKit.Net.Pop3.Pop3Stream.Read(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  20473. <summary>
  20474. Reads a sequence of bytes from the stream and advances the position
  20475. within the stream by the number of bytes read.
  20476. </summary>
  20477. <remarks>
  20478. Reads a sequence of bytes from the stream and advances the position
  20479. within the stream by the number of bytes read.
  20480. </remarks>
  20481. <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many
  20482. bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
  20483. <param name="buffer">The buffer.</param>
  20484. <param name="offset">The buffer offset.</param>
  20485. <param name="count">The number of bytes to read.</param>
  20486. <param name="cancellationToken">The cancellation token.</param>
  20487. <exception cref="T:System.ArgumentNullException">
  20488. <paramref name="buffer"/> is <c>null</c>.
  20489. </exception>
  20490. <exception cref="T:System.ArgumentOutOfRangeException">
  20491. <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
  20492. <para>-or-</para>
  20493. <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
  20494. at the specified <paramref name="offset"/>.</para>
  20495. </exception>
  20496. <exception cref="T:System.ObjectDisposedException">
  20497. The stream has been disposed.
  20498. </exception>
  20499. <exception cref="T:System.InvalidOperationException">
  20500. The stream is in line mode (see <see cref="F:MailKit.Net.Pop3.Pop3StreamMode.Line"/>).
  20501. </exception>
  20502. <exception cref="T:System.OperationCanceledException">
  20503. The operation was canceled via the cancellation token.
  20504. </exception>
  20505. <exception cref="T:System.IO.IOException">
  20506. An I/O error occurred.
  20507. </exception>
  20508. </member>
  20509. <member name="M:MailKit.Net.Pop3.Pop3Stream.Read(System.Byte[],System.Int32,System.Int32)">
  20510. <summary>
  20511. Reads a sequence of bytes from the stream and advances the position
  20512. within the stream by the number of bytes read.
  20513. </summary>
  20514. <remarks>
  20515. Reads a sequence of bytes from the stream and advances the position
  20516. within the stream by the number of bytes read.
  20517. </remarks>
  20518. <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many
  20519. bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
  20520. <param name="buffer">The buffer.</param>
  20521. <param name="offset">The buffer offset.</param>
  20522. <param name="count">The number of bytes to read.</param>
  20523. <exception cref="T:System.ArgumentNullException">
  20524. <paramref name="buffer"/> is <c>null</c>.
  20525. </exception>
  20526. <exception cref="T:System.ArgumentOutOfRangeException">
  20527. <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
  20528. <para>-or-</para>
  20529. <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
  20530. at the specified <paramref name="offset"/>.</para>
  20531. </exception>
  20532. <exception cref="T:System.ObjectDisposedException">
  20533. The stream has been disposed.
  20534. </exception>
  20535. <exception cref="T:System.InvalidOperationException">
  20536. The stream is in line mode (see <see cref="F:MailKit.Net.Pop3.Pop3StreamMode.Line"/>).
  20537. </exception>
  20538. <exception cref="T:System.IO.IOException">
  20539. An I/O error occurred.
  20540. </exception>
  20541. </member>
  20542. <member name="M:MailKit.Net.Pop3.Pop3Stream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  20543. <summary>
  20544. Reads a sequence of bytes from the stream and advances the position
  20545. within the stream by the number of bytes read.
  20546. </summary>
  20547. <remarks>
  20548. Reads a sequence of bytes from the stream and advances the position
  20549. within the stream by the number of bytes read.
  20550. </remarks>
  20551. <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many
  20552. bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
  20553. <param name="buffer">The buffer.</param>
  20554. <param name="offset">The buffer offset.</param>
  20555. <param name="count">The number of bytes to read.</param>
  20556. <param name="cancellationToken">The cancellation token.</param>
  20557. <exception cref="T:System.ArgumentNullException">
  20558. <paramref name="buffer"/> is <c>null</c>.
  20559. </exception>
  20560. <exception cref="T:System.ArgumentOutOfRangeException">
  20561. <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
  20562. <para>-or-</para>
  20563. <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
  20564. at the specified <paramref name="offset"/>.</para>
  20565. </exception>
  20566. <exception cref="T:System.ObjectDisposedException">
  20567. The stream has been disposed.
  20568. </exception>
  20569. <exception cref="T:System.InvalidOperationException">
  20570. The stream is in line mode (see <see cref="F:MailKit.Net.Pop3.Pop3StreamMode.Line"/>).
  20571. </exception>
  20572. <exception cref="T:System.OperationCanceledException">
  20573. The operation was canceled via the cancellation token.
  20574. </exception>
  20575. <exception cref="T:System.IO.IOException">
  20576. An I/O error occurred.
  20577. </exception>
  20578. </member>
  20579. <member name="M:MailKit.Net.Pop3.Pop3Stream.ReadLine(System.IO.Stream,System.Threading.CancellationToken)">
  20580. <summary>
  20581. Reads a single line of input from the stream.
  20582. </summary>
  20583. <remarks>
  20584. This method should be called in a loop until it returns <c>true</c>.
  20585. </remarks>
  20586. <returns><c>true</c>, if reading the line is complete, <c>false</c> otherwise.</returns>
  20587. <param name="ostream">The output stream to write the line data into.</param>
  20588. <param name="cancellationToken">The cancellation token.</param>
  20589. <exception cref="T:System.ObjectDisposedException">
  20590. The stream has been disposed.
  20591. </exception>
  20592. <exception cref="T:System.OperationCanceledException">
  20593. The operation was canceled via the cancellation token.
  20594. </exception>
  20595. <exception cref="T:System.IO.IOException">
  20596. An I/O error occurred.
  20597. </exception>
  20598. </member>
  20599. <member name="M:MailKit.Net.Pop3.Pop3Stream.ReadLineAsync(System.IO.Stream,System.Threading.CancellationToken)">
  20600. <summary>
  20601. Asynchronously reads a single line of input from the stream.
  20602. </summary>
  20603. <remarks>
  20604. This method should be called in a loop until it returns <c>true</c>.
  20605. </remarks>
  20606. <returns><c>true</c>, if reading the line is complete, <c>false</c> otherwise.</returns>
  20607. <param name="ostream">The output stream to write the line data into.</param>
  20608. <param name="cancellationToken">The cancellation token.</param>
  20609. <exception cref="T:System.ObjectDisposedException">
  20610. The stream has been disposed.
  20611. </exception>
  20612. <exception cref="T:System.OperationCanceledException">
  20613. The operation was canceled via the cancellation token.
  20614. </exception>
  20615. <exception cref="T:System.IO.IOException">
  20616. An I/O error occurred.
  20617. </exception>
  20618. </member>
  20619. <member name="M:MailKit.Net.Pop3.Pop3Stream.Write(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  20620. <summary>
  20621. Writes a sequence of bytes to the stream and advances the current
  20622. position within this stream by the number of bytes written.
  20623. </summary>
  20624. <remarks>
  20625. Writes a sequence of bytes to the stream and advances the current
  20626. position within this stream by the number of bytes written.
  20627. </remarks>
  20628. <param name='buffer'>The buffer to write.</param>
  20629. <param name='offset'>The offset of the first byte to write.</param>
  20630. <param name='count'>The number of bytes to write.</param>
  20631. <param name="cancellationToken">The cancellation token.</param>
  20632. <exception cref="T:System.ArgumentNullException">
  20633. <paramref name="buffer"/> is <c>null</c>.
  20634. </exception>
  20635. <exception cref="T:System.ArgumentOutOfRangeException">
  20636. <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
  20637. <para>-or-</para>
  20638. <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
  20639. at the specified <paramref name="offset"/>.</para>
  20640. </exception>
  20641. <exception cref="T:System.ObjectDisposedException">
  20642. The stream has been disposed.
  20643. </exception>
  20644. <exception cref="T:System.NotSupportedException">
  20645. The stream does not support writing.
  20646. </exception>
  20647. <exception cref="T:System.OperationCanceledException">
  20648. The operation was canceled via the cancellation token.
  20649. </exception>
  20650. <exception cref="T:System.IO.IOException">
  20651. An I/O error occurred.
  20652. </exception>
  20653. </member>
  20654. <member name="M:MailKit.Net.Pop3.Pop3Stream.Write(System.Byte[],System.Int32,System.Int32)">
  20655. <summary>
  20656. Writes a sequence of bytes to the stream and advances the current
  20657. position within this stream by the number of bytes written.
  20658. </summary>
  20659. <remarks>
  20660. Writes a sequence of bytes to the stream and advances the current
  20661. position within this stream by the number of bytes written.
  20662. </remarks>
  20663. <param name='buffer'>The buffer to write.</param>
  20664. <param name='offset'>The offset of the first byte to write.</param>
  20665. <param name='count'>The number of bytes to write.</param>
  20666. <exception cref="T:System.ArgumentNullException">
  20667. <paramref name="buffer"/> is <c>null</c>.
  20668. </exception>
  20669. <exception cref="T:System.ArgumentOutOfRangeException">
  20670. <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
  20671. <para>-or-</para>
  20672. <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
  20673. at the specified <paramref name="offset"/>.</para>
  20674. </exception>
  20675. <exception cref="T:System.ObjectDisposedException">
  20676. The stream has been disposed.
  20677. </exception>
  20678. <exception cref="T:System.NotSupportedException">
  20679. The stream does not support writing.
  20680. </exception>
  20681. <exception cref="T:System.IO.IOException">
  20682. An I/O error occurred.
  20683. </exception>
  20684. </member>
  20685. <member name="M:MailKit.Net.Pop3.Pop3Stream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  20686. <summary>
  20687. Writes a sequence of bytes to the stream and advances the current
  20688. position within this stream by the number of bytes written.
  20689. </summary>
  20690. <remarks>
  20691. Writes a sequence of bytes to the stream and advances the current
  20692. position within this stream by the number of bytes written.
  20693. </remarks>
  20694. <returns>A task that represents the asynchronous write operation.</returns>
  20695. <param name='buffer'>The buffer to write.</param>
  20696. <param name='offset'>The offset of the first byte to write.</param>
  20697. <param name='count'>The number of bytes to write.</param>
  20698. <param name="cancellationToken">The cancellation token.</param>
  20699. <exception cref="T:System.ArgumentNullException">
  20700. <paramref name="buffer"/> is <c>null</c>.
  20701. </exception>
  20702. <exception cref="T:System.ArgumentOutOfRangeException">
  20703. <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
  20704. <para>-or-</para>
  20705. <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
  20706. at the specified <paramref name="offset"/>.</para>
  20707. </exception>
  20708. <exception cref="T:System.ObjectDisposedException">
  20709. The stream has been disposed.
  20710. </exception>
  20711. <exception cref="T:System.NotSupportedException">
  20712. The stream does not support writing.
  20713. </exception>
  20714. <exception cref="T:System.OperationCanceledException">
  20715. The operation was canceled via the cancellation token.
  20716. </exception>
  20717. <exception cref="T:System.IO.IOException">
  20718. An I/O error occurred.
  20719. </exception>
  20720. </member>
  20721. <member name="M:MailKit.Net.Pop3.Pop3Stream.Flush(System.Threading.CancellationToken)">
  20722. <summary>
  20723. Clears all buffers for this stream and causes any buffered data to be written
  20724. to the underlying device.
  20725. </summary>
  20726. <remarks>
  20727. Clears all buffers for this stream and causes any buffered data to be written
  20728. to the underlying device.
  20729. </remarks>
  20730. <param name="cancellationToken">The cancellation token.</param>
  20731. <exception cref="T:System.ObjectDisposedException">
  20732. The stream has been disposed.
  20733. </exception>
  20734. <exception cref="T:System.NotSupportedException">
  20735. The stream does not support writing.
  20736. </exception>
  20737. <exception cref="T:System.OperationCanceledException">
  20738. The operation was canceled via the cancellation token.
  20739. </exception>
  20740. <exception cref="T:System.IO.IOException">
  20741. An I/O error occurred.
  20742. </exception>
  20743. </member>
  20744. <member name="M:MailKit.Net.Pop3.Pop3Stream.Flush">
  20745. <summary>
  20746. Clears all buffers for this stream and causes any buffered data to be written
  20747. to the underlying device.
  20748. </summary>
  20749. <remarks>
  20750. Clears all buffers for this stream and causes any buffered data to be written
  20751. to the underlying device.
  20752. </remarks>
  20753. <exception cref="T:System.ObjectDisposedException">
  20754. The stream has been disposed.
  20755. </exception>
  20756. <exception cref="T:System.NotSupportedException">
  20757. The stream does not support writing.
  20758. </exception>
  20759. <exception cref="T:System.IO.IOException">
  20760. An I/O error occurred.
  20761. </exception>
  20762. </member>
  20763. <member name="M:MailKit.Net.Pop3.Pop3Stream.FlushAsync(System.Threading.CancellationToken)">
  20764. <summary>
  20765. Clears all buffers for this stream and causes any buffered data to be written
  20766. to the underlying device.
  20767. </summary>
  20768. <remarks>
  20769. Clears all buffers for this stream and causes any buffered data to be written
  20770. to the underlying device.
  20771. </remarks>
  20772. <returns>A task that represents the asynchronous flush operation.</returns>
  20773. <param name="cancellationToken">The cancellation token.</param>
  20774. <exception cref="T:System.ObjectDisposedException">
  20775. The stream has been disposed.
  20776. </exception>
  20777. <exception cref="T:System.NotSupportedException">
  20778. The stream does not support writing.
  20779. </exception>
  20780. <exception cref="T:System.OperationCanceledException">
  20781. The operation was canceled via the cancellation token.
  20782. </exception>
  20783. <exception cref="T:System.IO.IOException">
  20784. An I/O error occurred.
  20785. </exception>
  20786. </member>
  20787. <member name="M:MailKit.Net.Pop3.Pop3Stream.Seek(System.Int64,System.IO.SeekOrigin)">
  20788. <summary>
  20789. Sets the position within the current stream.
  20790. </summary>
  20791. <returns>The new position within the stream.</returns>
  20792. <param name="offset">The offset into the stream relative to the <paramref name="origin"/>.</param>
  20793. <param name="origin">The origin to seek from.</param>
  20794. <exception cref="T:System.NotSupportedException">
  20795. The stream does not support seeking.
  20796. </exception>
  20797. </member>
  20798. <member name="M:MailKit.Net.Pop3.Pop3Stream.SetLength(System.Int64)">
  20799. <summary>
  20800. Sets the length of the stream.
  20801. </summary>
  20802. <param name="value">The desired length of the stream in bytes.</param>
  20803. <exception cref="T:System.NotSupportedException">
  20804. The stream does not support setting the length.
  20805. </exception>
  20806. </member>
  20807. <member name="M:MailKit.Net.Pop3.Pop3Stream.Dispose(System.Boolean)">
  20808. <summary>
  20809. Releases the unmanaged resources used by the <see cref="T:MailKit.Net.Pop3.Pop3Stream"/> and
  20810. optionally releases the managed resources.
  20811. </summary>
  20812. <param name="disposing"><c>true</c> to release both managed and unmanaged resources;
  20813. <c>false</c> to release only the unmanaged resources.</param>
  20814. </member>
  20815. <member name="T:MailKit.Net.Proxy.HttpProxyClient">
  20816. <summary>
  20817. An HTTP proxy client.
  20818. </summary>
  20819. <remarkas>
  20820. An HTTP proxy client.
  20821. </remarkas>
  20822. </member>
  20823. <member name="M:MailKit.Net.Proxy.HttpProxyClient.#ctor(System.String,System.Int32)">
  20824. <summary>
  20825. Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.HttpProxyClient"/> class.
  20826. </summary>
  20827. <remarks>
  20828. Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.HttpProxyClient"/> class.
  20829. </remarks>
  20830. <param name="host">The host name of the proxy server.</param>
  20831. <param name="port">The proxy server port.</param>
  20832. <exception cref="T:System.ArgumentNullException">
  20833. <paramref name="host"/> is <c>null</c>.
  20834. </exception>
  20835. <exception cref="T:System.ArgumentOutOfRangeException">
  20836. <paramref name="port"/> is not between <c>1</c> and <c>65535</c>.
  20837. </exception>
  20838. <exception cref="T:System.ArgumentException">
  20839. <para>The <paramref name="host"/> is a zero-length string.</para>
  20840. <para>-or-</para>
  20841. <para>The length of <paramref name="host"/> is greater than 255 characters.</para>
  20842. </exception>
  20843. </member>
  20844. <member name="M:MailKit.Net.Proxy.HttpProxyClient.#ctor(System.String,System.Int32,System.Net.NetworkCredential)">
  20845. <summary>
  20846. Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.HttpProxyClient"/> class.
  20847. </summary>
  20848. <remarks>
  20849. Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.HttpProxyClient"/> class.
  20850. </remarks>
  20851. <param name="host">The host name of the proxy server.</param>
  20852. <param name="port">The proxy server port.</param>
  20853. <param name="credentials">The credentials to use to authenticate with the proxy server.</param>
  20854. <exception cref="T:System.ArgumentNullException">
  20855. <para><paramref name="host"/> is <c>null</c>.</para>
  20856. <para>-or-</para>
  20857. <para><paramref name="credentials"/>is <c>null</c>.</para>
  20858. </exception>
  20859. <exception cref="T:System.ArgumentOutOfRangeException">
  20860. <paramref name="port"/> is not between <c>1</c> and <c>65535</c>.
  20861. </exception>
  20862. <exception cref="T:System.ArgumentException">
  20863. <para>The <paramref name="host"/> is a zero-length string.</para>
  20864. <para>-or-</para>
  20865. <para>The length of <paramref name="host"/> is greater than 255 characters.</para>
  20866. </exception>
  20867. </member>
  20868. <member name="M:MailKit.Net.Proxy.HttpProxyClient.Connect(System.String,System.Int32,System.Threading.CancellationToken)">
  20869. <summary>
  20870. Connect to the target host.
  20871. </summary>
  20872. <remarks>
  20873. Connects to the target host and port through the proxy server.
  20874. </remarks>
  20875. <returns>The connected socket.</returns>
  20876. <param name="host">The host name of the proxy server.</param>
  20877. <param name="port">The proxy server port.</param>
  20878. <param name="cancellationToken">The cancellation token.</param>
  20879. <exception cref="T:System.ArgumentNullException">
  20880. <paramref name="host"/> is <c>null</c>.
  20881. </exception>
  20882. <exception cref="T:System.ArgumentOutOfRangeException">
  20883. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  20884. </exception>
  20885. <exception cref="T:System.ArgumentException">
  20886. The <paramref name="host"/> is a zero-length string.
  20887. </exception>
  20888. <exception cref="T:System.OperationCanceledException">
  20889. The operation was canceled via the cancellation token.
  20890. </exception>
  20891. <exception cref="T:System.Net.Sockets.SocketException">
  20892. A socket error occurred trying to connect to the remote host.
  20893. </exception>
  20894. <exception cref="T:System.IO.IOException">
  20895. An I/O error occurred.
  20896. </exception>
  20897. </member>
  20898. <member name="M:MailKit.Net.Proxy.HttpProxyClient.ConnectAsync(System.String,System.Int32,System.Threading.CancellationToken)">
  20899. <summary>
  20900. Asynchronously connect to the target host.
  20901. </summary>
  20902. <remarks>
  20903. Asynchronously connects to the target host and port through the proxy server.
  20904. </remarks>
  20905. <returns>The connected socket.</returns>
  20906. <param name="host">The host name of the proxy server.</param>
  20907. <param name="port">The proxy server port.</param>
  20908. <param name="cancellationToken">The cancellation token.</param>
  20909. <exception cref="T:System.ArgumentNullException">
  20910. <paramref name="host"/> is <c>null</c>.
  20911. </exception>
  20912. <exception cref="T:System.ArgumentOutOfRangeException">
  20913. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  20914. </exception>
  20915. <exception cref="T:System.ArgumentException">
  20916. The <paramref name="host"/> is a zero-length string.
  20917. </exception>
  20918. <exception cref="T:System.OperationCanceledException">
  20919. The operation was canceled via the cancellation token.
  20920. </exception>
  20921. <exception cref="T:System.Net.Sockets.SocketException">
  20922. A socket error occurred trying to connect to the remote host.
  20923. </exception>
  20924. <exception cref="T:System.IO.IOException">
  20925. An I/O error occurred.
  20926. </exception>
  20927. </member>
  20928. <member name="T:MailKit.Net.Proxy.IProxyClient">
  20929. <summary>
  20930. An interface for connecting to services via a proxy.
  20931. </summary>
  20932. <remarks>
  20933. Implemented by <see cref="T:MailKit.Net.Smtp.SmtpClient"/>
  20934. and <see cref="T:MailKit.Net.Pop3.Pop3Client"/>.
  20935. </remarks>
  20936. </member>
  20937. <member name="P:MailKit.Net.Proxy.IProxyClient.ProxyCredentials">
  20938. <summary>
  20939. Gets the proxy credentials.
  20940. </summary>
  20941. <remarks>
  20942. Gets the credentials to use when authenticating with the proxy server.
  20943. </remarks>
  20944. <value>The proxy credentials.</value>
  20945. </member>
  20946. <member name="P:MailKit.Net.Proxy.IProxyClient.ProxyHost">
  20947. <summary>
  20948. Get the proxy host.
  20949. </summary>
  20950. <remarks>
  20951. Gets the host name of the proxy server.
  20952. </remarks>
  20953. <value>The host name of the proxy server.</value>
  20954. </member>
  20955. <member name="P:MailKit.Net.Proxy.IProxyClient.ProxyPort">
  20956. <summary>
  20957. Get the proxy port.
  20958. </summary>
  20959. <remarks>
  20960. Gets the port to use when connecting to the proxy server.
  20961. </remarks>
  20962. <value>The proxy port.</value>
  20963. </member>
  20964. <member name="P:MailKit.Net.Proxy.IProxyClient.LocalEndPoint">
  20965. <summary>
  20966. Get or set the local IP end point to use when connecting to a remote host.
  20967. </summary>
  20968. <remarks>
  20969. Gets or sets the local IP end point to use when connecting to a remote host.
  20970. </remarks>
  20971. <value>The local IP end point or <c>null</c> to use the default end point.</value>
  20972. </member>
  20973. <member name="M:MailKit.Net.Proxy.IProxyClient.Connect(System.String,System.Int32,System.Threading.CancellationToken)">
  20974. <summary>
  20975. Connect to the target host.
  20976. </summary>
  20977. <remarks>
  20978. Connects to the target host and port through the proxy server.
  20979. </remarks>
  20980. <returns>The connected socket.</returns>
  20981. <param name="host">The host name of the proxy server.</param>
  20982. <param name="port">The proxy server port.</param>
  20983. <param name="cancellationToken">The cancellation token.</param>
  20984. <exception cref="T:System.ArgumentNullException">
  20985. <paramref name="host"/> is <c>null</c>.
  20986. </exception>
  20987. <exception cref="T:System.ArgumentOutOfRangeException">
  20988. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  20989. </exception>
  20990. <exception cref="T:System.ArgumentException">
  20991. The <paramref name="host"/> is a zero-length string.
  20992. </exception>
  20993. <exception cref="T:System.OperationCanceledException">
  20994. The operation was canceled via the cancellation token.
  20995. </exception>
  20996. <exception cref="T:System.Net.Sockets.SocketException">
  20997. A socket error occurred trying to connect to the remote host.
  20998. </exception>
  20999. <exception cref="T:System.IO.IOException">
  21000. An I/O error occurred.
  21001. </exception>
  21002. </member>
  21003. <member name="M:MailKit.Net.Proxy.IProxyClient.ConnectAsync(System.String,System.Int32,System.Threading.CancellationToken)">
  21004. <summary>
  21005. Asynchronously connect to the target host.
  21006. </summary>
  21007. <remarks>
  21008. Asynchronously connects to the target host and port through the proxy server.
  21009. </remarks>
  21010. <returns>The connected socket.</returns>
  21011. <param name="host">The host name of the proxy server.</param>
  21012. <param name="port">The proxy server port.</param>
  21013. <param name="cancellationToken">The cancellation token.</param>
  21014. <exception cref="T:System.ArgumentNullException">
  21015. <paramref name="host"/> is <c>null</c>.
  21016. </exception>
  21017. <exception cref="T:System.ArgumentOutOfRangeException">
  21018. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  21019. </exception>
  21020. <exception cref="T:System.ArgumentException">
  21021. The <paramref name="host"/> is a zero-length string.
  21022. </exception>
  21023. <exception cref="T:System.OperationCanceledException">
  21024. The operation was canceled via the cancellation token.
  21025. </exception>
  21026. <exception cref="T:System.Net.Sockets.SocketException">
  21027. A socket error occurred trying to connect to the remote host.
  21028. </exception>
  21029. <exception cref="T:System.IO.IOException">
  21030. An I/O error occurred.
  21031. </exception>
  21032. </member>
  21033. <member name="M:MailKit.Net.Proxy.IProxyClient.Connect(System.String,System.Int32,System.Int32,System.Threading.CancellationToken)">
  21034. <summary>
  21035. Connect to the target host.
  21036. </summary>
  21037. <remarks>
  21038. Connects to the target host and port through the proxy server.
  21039. </remarks>
  21040. <returns>The connected socket.</returns>
  21041. <param name="host">The host name of the proxy server.</param>
  21042. <param name="port">The proxy server port.</param>
  21043. <param name="timeout">The timeout, in milliseconds.</param>
  21044. <param name="cancellationToken">The cancellation token.</param>
  21045. <exception cref="T:System.ArgumentNullException">
  21046. <paramref name="host"/> is <c>null</c>.
  21047. </exception>
  21048. <exception cref="T:System.ArgumentOutOfRangeException">
  21049. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  21050. </exception>
  21051. <exception cref="T:System.ArgumentException">
  21052. The <paramref name="host"/> is a zero-length string.
  21053. </exception>
  21054. <exception cref="T:System.OperationCanceledException">
  21055. The operation was canceled via the cancellation token.
  21056. </exception>
  21057. <exception cref="T:System.TimeoutException">
  21058. The operation timed out.
  21059. </exception>
  21060. <exception cref="T:System.Net.Sockets.SocketException">
  21061. A socket error occurred trying to connect to the remote host.
  21062. </exception>
  21063. <exception cref="T:System.IO.IOException">
  21064. An I/O error occurred.
  21065. </exception>
  21066. </member>
  21067. <member name="M:MailKit.Net.Proxy.IProxyClient.ConnectAsync(System.String,System.Int32,System.Int32,System.Threading.CancellationToken)">
  21068. <summary>
  21069. Asynchronously connect to the target host.
  21070. </summary>
  21071. <remarks>
  21072. Asynchronously connects to the target host and port through the proxy server.
  21073. </remarks>
  21074. <returns>The connected socket.</returns>
  21075. <param name="host">The host name of the proxy server.</param>
  21076. <param name="port">The proxy server port.</param>
  21077. <param name="timeout">The timeout, in milliseconds.</param>
  21078. <param name="cancellationToken">The cancellation token.</param>
  21079. <exception cref="T:System.ArgumentNullException">
  21080. <paramref name="host"/> is <c>null</c>.
  21081. </exception>
  21082. <exception cref="T:System.ArgumentOutOfRangeException">
  21083. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  21084. </exception>
  21085. <exception cref="T:System.ArgumentException">
  21086. The <paramref name="host"/> is a zero-length string.
  21087. </exception>
  21088. <exception cref="T:System.OperationCanceledException">
  21089. The operation was canceled via the cancellation token.
  21090. </exception>
  21091. <exception cref="T:System.TimeoutException">
  21092. The operation timed out.
  21093. </exception>
  21094. <exception cref="T:System.Net.Sockets.SocketException">
  21095. A socket error occurred trying to connect to the remote host.
  21096. </exception>
  21097. <exception cref="T:System.IO.IOException">
  21098. An I/O error occurred.
  21099. </exception>
  21100. </member>
  21101. <member name="T:MailKit.Net.Proxy.ProxyClient">
  21102. <summary>
  21103. An abstract proxy client base class.
  21104. </summary>
  21105. <remarks>
  21106. A proxy client can be used to connect to a service through a firewall that
  21107. would otherwise be blocked.
  21108. </remarks>
  21109. </member>
  21110. <member name="M:MailKit.Net.Proxy.ProxyClient.#ctor(System.String,System.Int32)">
  21111. <summary>
  21112. Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.ProxyClient"/> class.
  21113. </summary>
  21114. <remarks>
  21115. Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.ProxyClient"/> class.
  21116. </remarks>
  21117. <param name="host">The host name of the proxy server.</param>
  21118. <param name="port">The proxy server port.</param>
  21119. <exception cref="T:System.ArgumentNullException">
  21120. <paramref name="host"/> is <c>null</c>.
  21121. </exception>
  21122. <exception cref="T:System.ArgumentOutOfRangeException">
  21123. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  21124. </exception>
  21125. <exception cref="T:System.ArgumentException">
  21126. <para>The <paramref name="host"/> is a zero-length string.</para>
  21127. <para>-or-</para>
  21128. <para>The length of <paramref name="host"/> is greater than 255 characters.</para>
  21129. </exception>
  21130. </member>
  21131. <member name="M:MailKit.Net.Proxy.ProxyClient.#ctor(System.String,System.Int32,System.Net.NetworkCredential)">
  21132. <summary>
  21133. Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.ProxyClient"/> class.
  21134. </summary>
  21135. <remarks>
  21136. Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.ProxyClient"/> class.
  21137. </remarks>
  21138. <param name="host">The host name of the proxy server.</param>
  21139. <param name="port">The proxy server port.</param>
  21140. <param name="credentials">The credentials to use to authenticate with the proxy server.</param>
  21141. <exception cref="T:System.ArgumentNullException">
  21142. <para><paramref name="host"/> is <c>null</c>.</para>
  21143. <para>-or-</para>
  21144. <para><paramref name="credentials"/>is <c>null</c>.</para>
  21145. </exception>
  21146. <exception cref="T:System.ArgumentOutOfRangeException">
  21147. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  21148. </exception>
  21149. <exception cref="T:System.ArgumentException">
  21150. <para>The <paramref name="host"/> is a zero-length string.</para>
  21151. <para>-or-</para>
  21152. <para>The length of <paramref name="host"/> is greater than 255 characters.</para>
  21153. </exception>
  21154. </member>
  21155. <member name="P:MailKit.Net.Proxy.ProxyClient.ProxyCredentials">
  21156. <summary>
  21157. Gets the proxy credentials.
  21158. </summary>
  21159. <remarks>
  21160. Gets the credentials to use when authenticating with the proxy server.
  21161. </remarks>
  21162. <value>The proxy credentials.</value>
  21163. </member>
  21164. <member name="P:MailKit.Net.Proxy.ProxyClient.ProxyHost">
  21165. <summary>
  21166. Get the proxy host.
  21167. </summary>
  21168. <remarks>
  21169. Gets the host name of the proxy server.
  21170. </remarks>
  21171. <value>The host name of the proxy server.</value>
  21172. </member>
  21173. <member name="P:MailKit.Net.Proxy.ProxyClient.ProxyPort">
  21174. <summary>
  21175. Get the proxy port.
  21176. </summary>
  21177. <remarks>
  21178. Gets the port to use when connecting to the proxy server.
  21179. </remarks>
  21180. <value>The proxy port.</value>
  21181. </member>
  21182. <member name="P:MailKit.Net.Proxy.ProxyClient.LocalEndPoint">
  21183. <summary>
  21184. Get or set the local IP end point to use when connecting to a remote host.
  21185. </summary>
  21186. <remarks>
  21187. Gets or sets the local IP end point to use when connecting to a remote host.
  21188. </remarks>
  21189. <value>The local IP end point or <c>null</c> to use the default end point.</value>
  21190. </member>
  21191. <member name="M:MailKit.Net.Proxy.ProxyClient.Connect(System.String,System.Int32,System.Threading.CancellationToken)">
  21192. <summary>
  21193. Connect to the target host.
  21194. </summary>
  21195. <remarks>
  21196. Connects to the target host and port through the proxy server.
  21197. </remarks>
  21198. <returns>The connected socket.</returns>
  21199. <param name="host">The host name of the proxy server.</param>
  21200. <param name="port">The proxy server port.</param>
  21201. <param name="cancellationToken">The cancellation token.</param>
  21202. <exception cref="T:System.ArgumentNullException">
  21203. <paramref name="host"/> is <c>null</c>.
  21204. </exception>
  21205. <exception cref="T:System.ArgumentOutOfRangeException">
  21206. <paramref name="port"/> is not between <c>1</c> and <c>65535</c>.
  21207. </exception>
  21208. <exception cref="T:System.ArgumentException">
  21209. The <paramref name="host"/> is a zero-length string.
  21210. </exception>
  21211. <exception cref="T:System.OperationCanceledException">
  21212. The operation was canceled via the cancellation token.
  21213. </exception>
  21214. <exception cref="T:System.Net.Sockets.SocketException">
  21215. A socket error occurred trying to connect to the remote host.
  21216. </exception>
  21217. <exception cref="T:System.IO.IOException">
  21218. An I/O error occurred.
  21219. </exception>
  21220. </member>
  21221. <member name="M:MailKit.Net.Proxy.ProxyClient.ConnectAsync(System.String,System.Int32,System.Threading.CancellationToken)">
  21222. <summary>
  21223. Asynchronously connect to the target host.
  21224. </summary>
  21225. <remarks>
  21226. Asynchronously connects to the target host and port through the proxy server.
  21227. </remarks>
  21228. <returns>The connected socket.</returns>
  21229. <param name="host">The host name of the proxy server.</param>
  21230. <param name="port">The proxy server port.</param>
  21231. <param name="cancellationToken">The cancellation token.</param>
  21232. <exception cref="T:System.ArgumentNullException">
  21233. <paramref name="host"/> is <c>null</c>.
  21234. </exception>
  21235. <exception cref="T:System.ArgumentOutOfRangeException">
  21236. <paramref name="port"/> is not between <c>1</c> and <c>65535</c>.
  21237. </exception>
  21238. <exception cref="T:System.ArgumentException">
  21239. The <paramref name="host"/> is a zero-length string.
  21240. </exception>
  21241. <exception cref="T:System.OperationCanceledException">
  21242. The operation was canceled via the cancellation token.
  21243. </exception>
  21244. <exception cref="T:System.Net.Sockets.SocketException">
  21245. A socket error occurred trying to connect to the remote host.
  21246. </exception>
  21247. <exception cref="T:System.IO.IOException">
  21248. An I/O error occurred.
  21249. </exception>
  21250. </member>
  21251. <member name="M:MailKit.Net.Proxy.ProxyClient.Connect(System.String,System.Int32,System.Int32,System.Threading.CancellationToken)">
  21252. <summary>
  21253. Connect to the target host.
  21254. </summary>
  21255. <remarks>
  21256. Connects to the target host and port through the proxy server.
  21257. </remarks>
  21258. <returns>The connected socket.</returns>
  21259. <param name="host">The host name of the proxy server.</param>
  21260. <param name="port">The proxy server port.</param>
  21261. <param name="timeout">The timeout, in milliseconds.</param>
  21262. <param name="cancellationToken">The cancellation token.</param>
  21263. <exception cref="T:System.ArgumentNullException">
  21264. <paramref name="host"/> is <c>null</c>.
  21265. </exception>
  21266. <exception cref="T:System.ArgumentOutOfRangeException">
  21267. <para><paramref name="port"/> is not between <c>1</c> and <c>65535</c>.</para>
  21268. <para>-or-</para>
  21269. <para><paramref name="timeout"/> is less than <c>-1</c>.</para>
  21270. </exception>
  21271. <exception cref="T:System.ArgumentException">
  21272. The <paramref name="host"/> is a zero-length string.
  21273. </exception>
  21274. <exception cref="T:System.OperationCanceledException">
  21275. The operation was canceled via the cancellation token.
  21276. </exception>
  21277. <exception cref="T:System.TimeoutException">
  21278. The operation timed out.
  21279. </exception>
  21280. <exception cref="T:System.Net.Sockets.SocketException">
  21281. A socket error occurred trying to connect to the remote host.
  21282. </exception>
  21283. <exception cref="T:System.IO.IOException">
  21284. An I/O error occurred.
  21285. </exception>
  21286. </member>
  21287. <member name="M:MailKit.Net.Proxy.ProxyClient.ConnectAsync(System.String,System.Int32,System.Int32,System.Threading.CancellationToken)">
  21288. <summary>
  21289. Asynchronously connect to the target host.
  21290. </summary>
  21291. <remarks>
  21292. Asynchronously connects to the target host and port through the proxy server.
  21293. </remarks>
  21294. <returns>The connected socket.</returns>
  21295. <param name="host">The host name of the proxy server.</param>
  21296. <param name="port">The proxy server port.</param>
  21297. <param name="timeout">The timeout, in milliseconds.</param>
  21298. <param name="cancellationToken">The cancellation token.</param>
  21299. <exception cref="T:System.ArgumentNullException">
  21300. <paramref name="host"/> is <c>null</c>.
  21301. </exception>
  21302. <exception cref="T:System.ArgumentOutOfRangeException">
  21303. <para><paramref name="port"/> is not between <c>1</c> and <c>65535</c>.</para>
  21304. <para>-or-</para>
  21305. <para><paramref name="timeout"/> is less than <c>-1</c>.</para>
  21306. </exception>
  21307. <exception cref="T:System.ArgumentException">
  21308. The <paramref name="host"/> is a zero-length string.
  21309. </exception>
  21310. <exception cref="T:System.OperationCanceledException">
  21311. The operation was canceled via the cancellation token.
  21312. </exception>
  21313. <exception cref="T:System.TimeoutException">
  21314. The operation timed out.
  21315. </exception>
  21316. <exception cref="T:System.Net.Sockets.SocketException">
  21317. A socket error occurred trying to connect to the remote host.
  21318. </exception>
  21319. <exception cref="T:System.IO.IOException">
  21320. An I/O error occurred.
  21321. </exception>
  21322. </member>
  21323. <member name="T:MailKit.Net.Proxy.ProxyProtocolException">
  21324. <summary>
  21325. A proxy protocol exception.
  21326. </summary>
  21327. <remarks>
  21328. The exception that is thrown when there is an error communicating with a proxy server.
  21329. </remarks>
  21330. </member>
  21331. <member name="M:MailKit.Net.Proxy.ProxyProtocolException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  21332. <summary>
  21333. Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.ProxyProtocolException"/> class.
  21334. </summary>
  21335. <remarks>
  21336. Creates a new <see cref="T:MailKit.Net.Proxy.ProxyProtocolException"/> from the serialized data.
  21337. </remarks>
  21338. <param name="info">The serialization info.</param>
  21339. <param name="context">The streaming context.</param>
  21340. <exception cref="T:System.ArgumentNullException">
  21341. <paramref name="info"/> is <c>null</c>.
  21342. </exception>
  21343. </member>
  21344. <member name="M:MailKit.Net.Proxy.ProxyProtocolException.#ctor(System.String,System.Exception)">
  21345. <summary>
  21346. Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.ProxyProtocolException"/> class.
  21347. </summary>
  21348. <remarks>
  21349. Creates a new <see cref="T:MailKit.Net.Proxy.ProxyProtocolException"/>.
  21350. </remarks>
  21351. <param name="message">The error message.</param>
  21352. <param name="innerException">An inner exception.</param>
  21353. </member>
  21354. <member name="M:MailKit.Net.Proxy.ProxyProtocolException.#ctor(System.String)">
  21355. <summary>
  21356. Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.ProxyProtocolException"/> class.
  21357. </summary>
  21358. <remarks>
  21359. Creates a new <see cref="T:MailKit.Net.Proxy.ProxyProtocolException"/>.
  21360. </remarks>
  21361. <param name="message">The error message.</param>
  21362. </member>
  21363. <member name="M:MailKit.Net.Proxy.ProxyProtocolException.#ctor">
  21364. <summary>
  21365. Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.ProxyProtocolException"/> class.
  21366. </summary>
  21367. <remarks>
  21368. Creates a new <see cref="T:MailKit.Net.Proxy.ProxyProtocolException"/>.
  21369. </remarks>
  21370. </member>
  21371. <member name="T:MailKit.Net.Proxy.Socks4aClient">
  21372. <summary>
  21373. A SOCKS4a proxy client.
  21374. </summary>
  21375. <remarkas>
  21376. A SOCKS4a proxy client.
  21377. </remarkas>
  21378. </member>
  21379. <member name="M:MailKit.Net.Proxy.Socks4aClient.#ctor(System.String,System.Int32)">
  21380. <summary>
  21381. Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.Socks4aClient"/> class.
  21382. </summary>
  21383. <remarks>
  21384. Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.Socks4aClient"/> class.
  21385. </remarks>
  21386. <param name="host">The host name of the proxy server.</param>
  21387. <param name="port">The proxy server port.</param>
  21388. <exception cref="T:System.ArgumentNullException">
  21389. <paramref name="host"/> is <c>null</c>.
  21390. </exception>
  21391. <exception cref="T:System.ArgumentOutOfRangeException">
  21392. <paramref name="port"/> is not between <c>1</c> and <c>65535</c>.
  21393. </exception>
  21394. <exception cref="T:System.ArgumentException">
  21395. <para>The <paramref name="host"/> is a zero-length string.</para>
  21396. <para>-or-</para>
  21397. <para>The length of <paramref name="host"/> is greater than 255 characters.</para>
  21398. </exception>
  21399. </member>
  21400. <member name="M:MailKit.Net.Proxy.Socks4aClient.#ctor(System.String,System.Int32,System.Net.NetworkCredential)">
  21401. <summary>
  21402. Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.Socks4Client"/> class.
  21403. </summary>
  21404. <remarks>
  21405. Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.Socks4Client"/> class.
  21406. </remarks>
  21407. <param name="host">The host name of the proxy server.</param>
  21408. <param name="port">The proxy server port.</param>
  21409. <param name="credentials">The credentials to use to authenticate with the proxy server.</param>
  21410. <exception cref="T:System.ArgumentNullException">
  21411. <para><paramref name="host"/> is <c>null</c>.</para>
  21412. <para>-or-</para>
  21413. <para><paramref name="credentials"/>is <c>null</c>.</para>
  21414. </exception>
  21415. <exception cref="T:System.ArgumentOutOfRangeException">
  21416. <paramref name="port"/> is not between <c>1</c> and <c>65535</c>.
  21417. </exception>
  21418. <exception cref="T:System.ArgumentException">
  21419. The <paramref name="host"/> is a zero-length string.
  21420. </exception>
  21421. </member>
  21422. <member name="T:MailKit.Net.Proxy.Socks4Client">
  21423. <summary>
  21424. A SOCKS4 proxy client.
  21425. </summary>
  21426. <remarkas>
  21427. A SOCKS4 proxy client.
  21428. </remarkas>
  21429. </member>
  21430. <member name="M:MailKit.Net.Proxy.Socks4Client.#ctor(System.String,System.Int32)">
  21431. <summary>
  21432. Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.Socks4Client"/> class.
  21433. </summary>
  21434. <remarks>
  21435. Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.Socks4Client"/> class.
  21436. </remarks>
  21437. <param name="host">The host name of the proxy server.</param>
  21438. <param name="port">The proxy server port.</param>
  21439. <exception cref="T:System.ArgumentNullException">
  21440. <paramref name="host"/> is <c>null</c>.
  21441. </exception>
  21442. <exception cref="T:System.ArgumentOutOfRangeException">
  21443. <paramref name="port"/> is not between <c>1</c> and <c>65535</c>.
  21444. </exception>
  21445. <exception cref="T:System.ArgumentException">
  21446. <para>The <paramref name="host"/> is a zero-length string.</para>
  21447. <para>-or-</para>
  21448. <para>The length of <paramref name="host"/> is greater than 255 characters.</para>
  21449. </exception>
  21450. </member>
  21451. <member name="M:MailKit.Net.Proxy.Socks4Client.#ctor(System.String,System.Int32,System.Net.NetworkCredential)">
  21452. <summary>
  21453. Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.Socks4Client"/> class.
  21454. </summary>
  21455. <remarks>
  21456. Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.Socks4Client"/> class.
  21457. </remarks>
  21458. <param name="host">The host name of the proxy server.</param>
  21459. <param name="port">The proxy server port.</param>
  21460. <param name="credentials">The credentials to use to authenticate with the proxy server.</param>
  21461. <exception cref="T:System.ArgumentNullException">
  21462. <para><paramref name="host"/> is <c>null</c>.</para>
  21463. <para>-or-</para>
  21464. <para><paramref name="credentials"/>is <c>null</c>.</para>
  21465. </exception>
  21466. <exception cref="T:System.ArgumentOutOfRangeException">
  21467. <paramref name="port"/> is not between <c>1</c> and <c>65535</c>.
  21468. </exception>
  21469. <exception cref="T:System.ArgumentException">
  21470. The <paramref name="host"/> is a zero-length string.
  21471. </exception>
  21472. </member>
  21473. <member name="P:MailKit.Net.Proxy.Socks4Client.IsSocks4a">
  21474. <summary>
  21475. Get or set whether this <see cref="T:MailKit.Net.Proxy.Socks4Client"/> is a Socks4a client.
  21476. </summary>
  21477. <remarks>
  21478. Gets or sets whether this <see cref="T:MailKit.Net.Proxy.Socks4Client"/> is a Socks4a client.
  21479. </remarks>
  21480. <value><c>true</c> if is is a Socks4a client; otherwise, <c>false</c>.</value>
  21481. </member>
  21482. <member name="M:MailKit.Net.Proxy.Socks4Client.Connect(System.String,System.Int32,System.Threading.CancellationToken)">
  21483. <summary>
  21484. Connect to the target host.
  21485. </summary>
  21486. <remarks>
  21487. Connects to the target host and port through the proxy server.
  21488. </remarks>
  21489. <returns>The connected socket.</returns>
  21490. <param name="host">The host name of the proxy server.</param>
  21491. <param name="port">The proxy server port.</param>
  21492. <param name="cancellationToken">The cancellation token.</param>
  21493. <exception cref="T:System.ArgumentNullException">
  21494. <paramref name="host"/> is <c>null</c>.
  21495. </exception>
  21496. <exception cref="T:System.ArgumentOutOfRangeException">
  21497. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  21498. </exception>
  21499. <exception cref="T:System.ArgumentException">
  21500. The <paramref name="host"/> is a zero-length string.
  21501. </exception>
  21502. <exception cref="T:System.OperationCanceledException">
  21503. The operation was canceled via the cancellation token.
  21504. </exception>
  21505. <exception cref="T:System.Net.Sockets.SocketException">
  21506. A socket error occurred trying to connect to the remote host.
  21507. </exception>
  21508. <exception cref="T:System.IO.IOException">
  21509. An I/O error occurred.
  21510. </exception>
  21511. </member>
  21512. <member name="M:MailKit.Net.Proxy.Socks4Client.ConnectAsync(System.String,System.Int32,System.Threading.CancellationToken)">
  21513. <summary>
  21514. Asynchronously connect to the target host.
  21515. </summary>
  21516. <remarks>
  21517. Asynchronously connects to the target host and port through the proxy server.
  21518. </remarks>
  21519. <returns>The connected socket.</returns>
  21520. <param name="host">The host name of the proxy server.</param>
  21521. <param name="port">The proxy server port.</param>
  21522. <param name="cancellationToken">The cancellation token.</param>
  21523. <exception cref="T:System.ArgumentNullException">
  21524. <paramref name="host"/> is <c>null</c>.
  21525. </exception>
  21526. <exception cref="T:System.ArgumentOutOfRangeException">
  21527. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  21528. </exception>
  21529. <exception cref="T:System.ArgumentException">
  21530. The <paramref name="host"/> is a zero-length string.
  21531. </exception>
  21532. <exception cref="T:System.OperationCanceledException">
  21533. The operation was canceled via the cancellation token.
  21534. </exception>
  21535. <exception cref="T:System.Net.Sockets.SocketException">
  21536. A socket error occurred trying to connect to the remote host.
  21537. </exception>
  21538. <exception cref="T:System.IO.IOException">
  21539. An I/O error occurred.
  21540. </exception>
  21541. </member>
  21542. <member name="T:MailKit.Net.Proxy.Socks5Client">
  21543. <summary>
  21544. A SOCKS5 proxy client.
  21545. </summary>
  21546. <remarkas>
  21547. A SOCKS5 proxy client.
  21548. </remarkas>
  21549. </member>
  21550. <member name="M:MailKit.Net.Proxy.Socks5Client.#ctor(System.String,System.Int32)">
  21551. <summary>
  21552. Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.Socks5Client"/> class.
  21553. </summary>
  21554. <remarks>
  21555. Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.Socks5Client"/> class.
  21556. </remarks>
  21557. <param name="host">The host name of the proxy server.</param>
  21558. <param name="port">The proxy server port.</param>
  21559. <exception cref="T:System.ArgumentNullException">
  21560. <paramref name="host"/> is <c>null</c>.
  21561. </exception>
  21562. <exception cref="T:System.ArgumentOutOfRangeException">
  21563. <paramref name="port"/> is not between <c>1</c> and <c>65535</c>.
  21564. </exception>
  21565. <exception cref="T:System.ArgumentException">
  21566. <para>The <paramref name="host"/> is a zero-length string.</para>
  21567. <para>-or-</para>
  21568. <para>The length of <paramref name="host"/> is greater than 255 characters.</para>
  21569. </exception>
  21570. </member>
  21571. <member name="M:MailKit.Net.Proxy.Socks5Client.#ctor(System.String,System.Int32,System.Net.NetworkCredential)">
  21572. <summary>
  21573. Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.Socks5Client"/> class.
  21574. </summary>
  21575. <remarks>
  21576. Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.Socks5Client"/> class.
  21577. </remarks>
  21578. <param name="host">The host name of the proxy server.</param>
  21579. <param name="port">The proxy server port.</param>
  21580. <param name="credentials">The credentials to use to authenticate with the proxy server.</param>
  21581. <exception cref="T:System.ArgumentNullException">
  21582. <para><paramref name="host"/> is <c>null</c>.</para>
  21583. <para>-or-</para>
  21584. <para><paramref name="credentials"/>is <c>null</c>.</para>
  21585. </exception>
  21586. <exception cref="T:System.ArgumentOutOfRangeException">
  21587. <paramref name="port"/> is not between <c>1</c> and <c>65535</c>.
  21588. </exception>
  21589. <exception cref="T:System.ArgumentException">
  21590. <para>The <paramref name="host"/> is a zero-length string.</para>
  21591. <para>-or-</para>
  21592. <para>The length of <paramref name="host"/> is greater than 255 characters.</para>
  21593. </exception>
  21594. </member>
  21595. <member name="M:MailKit.Net.Proxy.Socks5Client.Connect(System.String,System.Int32,System.Threading.CancellationToken)">
  21596. <summary>
  21597. Connect to the target host.
  21598. </summary>
  21599. <remarks>
  21600. Connects to the target host and port through the proxy server.
  21601. </remarks>
  21602. <returns>The connected socket.</returns>
  21603. <param name="host">The host name of the proxy server.</param>
  21604. <param name="port">The proxy server port.</param>
  21605. <param name="cancellationToken">The cancellation token.</param>
  21606. <exception cref="T:System.ArgumentNullException">
  21607. <paramref name="host"/> is <c>null</c>.
  21608. </exception>
  21609. <exception cref="T:System.ArgumentOutOfRangeException">
  21610. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  21611. </exception>
  21612. <exception cref="T:System.ArgumentException">
  21613. The <paramref name="host"/> is a zero-length string.
  21614. </exception>
  21615. <exception cref="T:System.OperationCanceledException">
  21616. The operation was canceled via the cancellation token.
  21617. </exception>
  21618. <exception cref="T:System.Net.Sockets.SocketException">
  21619. A socket error occurred trying to connect to the remote host.
  21620. </exception>
  21621. <exception cref="T:System.IO.IOException">
  21622. An I/O error occurred.
  21623. </exception>
  21624. </member>
  21625. <member name="M:MailKit.Net.Proxy.Socks5Client.ConnectAsync(System.String,System.Int32,System.Threading.CancellationToken)">
  21626. <summary>
  21627. Asynchronously connect to the target host.
  21628. </summary>
  21629. <remarks>
  21630. Asynchronously connects to the target host and port through the proxy server.
  21631. </remarks>
  21632. <returns>The connected socket.</returns>
  21633. <param name="host">The host name of the proxy server.</param>
  21634. <param name="port">The proxy server port.</param>
  21635. <param name="cancellationToken">The cancellation token.</param>
  21636. <exception cref="T:System.ArgumentNullException">
  21637. <paramref name="host"/> is <c>null</c>.
  21638. </exception>
  21639. <exception cref="T:System.ArgumentOutOfRangeException">
  21640. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  21641. </exception>
  21642. <exception cref="T:System.ArgumentException">
  21643. The <paramref name="host"/> is a zero-length string.
  21644. </exception>
  21645. <exception cref="T:System.OperationCanceledException">
  21646. The operation was canceled via the cancellation token.
  21647. </exception>
  21648. <exception cref="T:System.Net.Sockets.SocketException">
  21649. A socket error occurred trying to connect to the remote host.
  21650. </exception>
  21651. <exception cref="T:System.IO.IOException">
  21652. An I/O error occurred.
  21653. </exception>
  21654. </member>
  21655. <member name="T:MailKit.Net.Proxy.SocksClient">
  21656. <summary>
  21657. An abstract SOCKS proxy client.
  21658. </summary>
  21659. <remarks>
  21660. An abstract SOCKS proxy client.
  21661. </remarks>
  21662. </member>
  21663. <member name="M:MailKit.Net.Proxy.SocksClient.#ctor(System.Int32,System.String,System.Int32)">
  21664. <summary>
  21665. Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.SocksClient"/> class.
  21666. </summary>
  21667. <remarks>
  21668. Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.SocksClient"/> class.
  21669. </remarks>
  21670. <param name="version">The SOCKS protocol version.</param>
  21671. <param name="host">The host name of the proxy server.</param>
  21672. <param name="port">The proxy server port.</param>
  21673. <exception cref="T:System.ArgumentNullException">
  21674. <paramref name="host"/> is <c>null</c>.
  21675. </exception>
  21676. <exception cref="T:System.ArgumentOutOfRangeException">
  21677. <paramref name="port"/> is not between <c>1</c> and <c>65535</c>.
  21678. </exception>
  21679. <exception cref="T:System.ArgumentException">
  21680. The <paramref name="host"/> is a zero-length string.
  21681. </exception>
  21682. </member>
  21683. <member name="M:MailKit.Net.Proxy.SocksClient.#ctor(System.Int32,System.String,System.Int32,System.Net.NetworkCredential)">
  21684. <summary>
  21685. Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.SocksClient"/> class.
  21686. </summary>
  21687. <remarks>
  21688. Initializes a new instance of the <see cref="T:MailKit.Net.Proxy.SocksClient"/> class.
  21689. </remarks>
  21690. <param name="version">The SOCKS protocol version.</param>
  21691. <param name="host">The host name of the proxy server.</param>
  21692. <param name="port">The proxy server port.</param>
  21693. <param name="credentials">The credentials to use to authenticate with the proxy server.</param>
  21694. <exception cref="T:System.ArgumentNullException">
  21695. <para><paramref name="host"/> is <c>null</c>.</para>
  21696. <para>-or-</para>
  21697. <para><paramref name="credentials"/>is <c>null</c>.</para>
  21698. </exception>
  21699. <exception cref="T:System.ArgumentOutOfRangeException">
  21700. <paramref name="port"/> is not between <c>1</c> and <c>65535</c>.
  21701. </exception>
  21702. <exception cref="T:System.ArgumentException">
  21703. The <paramref name="host"/> is a zero-length string.
  21704. </exception>
  21705. </member>
  21706. <member name="P:MailKit.Net.Proxy.SocksClient.SocksVersion">
  21707. <summary>
  21708. Get the SOCKS protocol version.
  21709. </summary>
  21710. <remarks>
  21711. Gets the SOCKS protocol version.
  21712. </remarks>
  21713. <value>The SOCKS protocol version.</value>
  21714. </member>
  21715. <member name="T:MailKit.Net.Smtp.SmtpClient">
  21716. <summary>
  21717. An SMTP client that can be used to send email messages.
  21718. </summary>
  21719. <remarks>
  21720. <para>The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> class supports both the "smtp" and "smtps" protocols. The "smtp"
  21721. protocol makes a clear-text connection to the SMTP server and does not use SSL or TLS unless the SMTP
  21722. server supports the <a href="https://tools.ietf.org/html/rfc3207">STARTTLS</a> extension. The "smtps"
  21723. protocol, however, connects to the SMTP server using an SSL-wrapped connection.</para>
  21724. <para>The connection established by any of the
  21725. <a href="Overload_MailKit_Net_Smtp_SmtpClient_Connect.htm">Connect</a> methods may be re-used if an
  21726. application wishes to send multiple messages to the same SMTP server. Since connecting and authenticating
  21727. can be expensive operations, re-using a connection can significantly improve performance when sending a
  21728. large number of messages to the same SMTP server over a short period of time.</para>
  21729. </remarks>
  21730. <example>
  21731. <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessages" />
  21732. </example>
  21733. </member>
  21734. <member name="M:MailKit.Net.Smtp.SmtpClient.SendCommandAsync(System.String,System.Threading.CancellationToken)">
  21735. <summary>
  21736. Asynchronously send a custom command to the SMTP server.
  21737. </summary>
  21738. <remarks>
  21739. <para>Asynchronously sends a custom command to the SMTP server.</para>
  21740. <note type="note">The command string should not include the terminating <c>\r\n</c> sequence.</note>
  21741. </remarks>
  21742. <returns>The command response.</returns>
  21743. <param name="command">The command.</param>
  21744. <param name="cancellationToken">The cancellation token.</param>
  21745. <exception cref="T:System.ArgumentNullException">
  21746. <paramref name="command"/> is <c>null</c>.
  21747. </exception>
  21748. <exception cref="T:System.ObjectDisposedException">
  21749. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
  21750. </exception>
  21751. <exception cref="T:MailKit.ServiceNotConnectedException">
  21752. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
  21753. </exception>
  21754. <exception cref="T:System.OperationCanceledException">
  21755. The operation has been canceled.
  21756. </exception>
  21757. <exception cref="T:System.IO.IOException">
  21758. An I/O error occurred.
  21759. </exception>
  21760. <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
  21761. The SMTP command failed.
  21762. </exception>
  21763. <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
  21764. An SMTP protocol exception occurred.
  21765. </exception>
  21766. </member>
  21767. <member name="M:MailKit.Net.Smtp.SmtpClient.AuthenticateAsync(MailKit.Security.SaslMechanism,System.Threading.CancellationToken)">
  21768. <summary>
  21769. Asynchronously authenticate using the specified SASL mechanism.
  21770. </summary>
  21771. <remarks>
  21772. <para>Authenticates using the specified SASL mechanism.</para>
  21773. <para>For a list of available SASL authentication mechanisms supported by the server,
  21774. check the <see cref="P:MailKit.Net.Smtp.SmtpClient.AuthenticationMechanisms"/> property after the service has been
  21775. connected.</para>
  21776. </remarks>
  21777. <returns>An asynchronous task context.</returns>
  21778. <param name="mechanism">The SASL mechanism.</param>
  21779. <param name="cancellationToken">The cancellation token.</param>
  21780. <exception cref="T:System.ArgumentNullException">
  21781. <paramref name="mechanism"/> is <c>null</c>.
  21782. </exception>
  21783. <exception cref="T:MailKit.ServiceNotConnectedException">
  21784. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
  21785. </exception>
  21786. <exception cref="T:System.InvalidOperationException">
  21787. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is already authenticated.
  21788. </exception>
  21789. <exception cref="T:System.NotSupportedException">
  21790. The SMTP server does not support authentication.
  21791. </exception>
  21792. <exception cref="T:System.OperationCanceledException">
  21793. The operation was canceled via the cancellation token.
  21794. </exception>
  21795. <exception cref="T:MailKit.Security.AuthenticationException">
  21796. Authentication using the supplied credentials has failed.
  21797. </exception>
  21798. <exception cref="T:MailKit.Security.SaslException">
  21799. A SASL authentication error occurred.
  21800. </exception>
  21801. <exception cref="T:System.IO.IOException">
  21802. An I/O error occurred.
  21803. </exception>
  21804. <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
  21805. The SMTP command failed.
  21806. </exception>
  21807. <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
  21808. An SMTP protocol error occurred.
  21809. </exception>
  21810. </member>
  21811. <member name="M:MailKit.Net.Smtp.SmtpClient.AuthenticateAsync(System.Text.Encoding,System.Net.ICredentials,System.Threading.CancellationToken)">
  21812. <summary>
  21813. Asynchronously authenticate using the supplied credentials.
  21814. </summary>
  21815. <remarks>
  21816. <para>If the SMTP server supports authentication, then the SASL mechanisms
  21817. that both the client and server support are tried in order of greatest
  21818. security to weakest security. Once a SASL authentication mechanism is
  21819. found that both client and server support, the credentials are used to
  21820. authenticate.</para>
  21821. <para>If, on the other hand, authentication is not supported by the SMTP
  21822. server, then this method will throw <see cref="T:System.NotSupportedException"/>.
  21823. The <see cref="P:MailKit.Net.Smtp.SmtpClient.Capabilities"/> property can be checked for the
  21824. <see cref="F:MailKit.Net.Smtp.SmtpCapabilities.Authentication"/> flag to make sure the
  21825. SMTP server supports authentication before calling this method.</para>
  21826. <note type="tip"> To prevent the usage of certain authentication mechanisms,
  21827. simply remove them from the <see cref="P:MailKit.Net.Smtp.SmtpClient.AuthenticationMechanisms"/> hash set
  21828. before calling this method.</note>
  21829. </remarks>
  21830. <returns>An asynchronous task context.</returns>
  21831. <param name="encoding">The text encoding to use for the user's credentials.</param>
  21832. <param name="credentials">The user's credentials.</param>
  21833. <param name="cancellationToken">The cancellation token.</param>
  21834. <exception cref="T:System.ArgumentNullException">
  21835. <para><paramref name="encoding"/> is <c>null</c>.</para>
  21836. <para>-or-</para>
  21837. <para><paramref name="credentials"/> is <c>null</c>.</para>
  21838. </exception>
  21839. <exception cref="T:MailKit.ServiceNotConnectedException">
  21840. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
  21841. </exception>
  21842. <exception cref="T:System.InvalidOperationException">
  21843. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is already authenticated.
  21844. </exception>
  21845. <exception cref="T:System.NotSupportedException">
  21846. The SMTP server does not support authentication.
  21847. </exception>
  21848. <exception cref="T:System.OperationCanceledException">
  21849. The operation was canceled via the cancellation token.
  21850. </exception>
  21851. <exception cref="T:MailKit.Security.AuthenticationException">
  21852. Authentication using the supplied credentials has failed.
  21853. </exception>
  21854. <exception cref="T:MailKit.Security.SaslException">
  21855. A SASL authentication error occurred.
  21856. </exception>
  21857. <exception cref="T:System.IO.IOException">
  21858. An I/O error occurred.
  21859. </exception>
  21860. <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
  21861. The SMTP command failed.
  21862. </exception>
  21863. <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
  21864. An SMTP protocol error occurred.
  21865. </exception>
  21866. </member>
  21867. <member name="M:MailKit.Net.Smtp.SmtpClient.ConnectAsync(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
  21868. <summary>
  21869. Asynchronously establish a connection to the specified SMTP or SMTP/S server.
  21870. </summary>
  21871. <remarks>
  21872. <para>Establishes a connection to the specified SMTP or SMTP/S server.</para>
  21873. <para>If the <paramref name="port"/> has a value of <c>0</c>, then the
  21874. <paramref name="options"/> parameter is used to determine the default port to
  21875. connect to. The default port used with <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>
  21876. is <c>465</c>. All other values will use a default port of <c>25</c>.</para>
  21877. <para>If the <paramref name="options"/> has a value of
  21878. <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
  21879. to determine the default security options. If the <paramref name="port"/> has a value
  21880. of <c>465</c>, then the default options used will be
  21881. <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
  21882. <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
  21883. <para>Once a connection is established, properties such as
  21884. <see cref="P:MailKit.Net.Smtp.SmtpClient.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Smtp.SmtpClient.Capabilities"/> will be
  21885. populated.</para>
  21886. <note type="note">The connection established by any of the
  21887. <a href="Overload_MailKit_Net_Smtp_SmtpClient_ConnectAsync.htm">Connect</a>
  21888. methods may be re-used if an application wishes to send multiple messages
  21889. to the same SMTP server. Since connecting and authenticating can be expensive
  21890. operations, re-using a connection can significantly improve performance when
  21891. sending a large number of messages to the same SMTP server over a short
  21892. period of time.</note>
  21893. </remarks>
  21894. <example>
  21895. <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessage"/>
  21896. </example>
  21897. <returns>An asynchronous task context.</returns>
  21898. <param name="host">The host name to connect to.</param>
  21899. <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
  21900. <param name="options">The secure socket options to when connecting.</param>
  21901. <param name="cancellationToken">The cancellation token.</param>
  21902. <exception cref="T:System.ArgumentNullException">
  21903. <paramref name="host"/> is <c>null</c>.
  21904. </exception>
  21905. <exception cref="T:System.ArgumentOutOfRangeException">
  21906. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  21907. </exception>
  21908. <exception cref="T:System.ArgumentException">
  21909. The <paramref name="host"/> is a zero-length string.
  21910. </exception>
  21911. <exception cref="T:System.ObjectDisposedException">
  21912. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
  21913. </exception>
  21914. <exception cref="T:System.InvalidOperationException">
  21915. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is already connected.
  21916. </exception>
  21917. <exception cref="T:System.NotSupportedException">
  21918. <paramref name="options"/> was set to
  21919. <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
  21920. and the SMTP server does not support the STARTTLS extension.
  21921. </exception>
  21922. <exception cref="T:System.OperationCanceledException">
  21923. The operation was canceled.
  21924. </exception>
  21925. <exception cref="T:System.Net.Sockets.SocketException">
  21926. A socket error occurred trying to connect to the remote host.
  21927. </exception>
  21928. <exception cref="T:MailKit.Security.SslHandshakeException">
  21929. An error occurred during the SSL/TLS negotiations.
  21930. </exception>
  21931. <exception cref="T:System.IO.IOException">
  21932. An I/O error occurred.
  21933. </exception>
  21934. <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
  21935. An SMTP command failed.
  21936. </exception>
  21937. <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
  21938. An SMTP protocol error occurred.
  21939. </exception>
  21940. </member>
  21941. <member name="M:MailKit.Net.Smtp.SmtpClient.ConnectAsync(System.Net.Sockets.Socket,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
  21942. <summary>
  21943. Asynchronously establish a connection to the specified SMTP or SMTP/S server using the provided socket.
  21944. </summary>
  21945. <remarks>
  21946. <para>Establishes a connection to the specified SMTP or SMTP/S server using the provided socket.</para>
  21947. <para>If the <paramref name="options"/> has a value of
  21948. <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
  21949. to determine the default security options. If the <paramref name="port"/> has a value
  21950. of <c>465</c>, then the default options used will be
  21951. <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
  21952. <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
  21953. <para>Once a connection is established, properties such as
  21954. <see cref="P:MailKit.Net.Smtp.SmtpClient.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Smtp.SmtpClient.Capabilities"/> will be
  21955. populated.</para>
  21956. <note type="info">With the exception of using the <paramref name="port"/> to determine the
  21957. default <see cref="T:MailKit.Security.SecureSocketOptions"/> to use when the <paramref name="options"/> value
  21958. is <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, the <paramref name="host"/> and
  21959. <paramref name="port"/> parameters are only used for logging purposes.</note>
  21960. </remarks>
  21961. <returns>An asynchronous task context.</returns>
  21962. <param name="socket">The socket to use for the connection.</param>
  21963. <param name="host">The host name to connect to.</param>
  21964. <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
  21965. <param name="options">The secure socket options to when connecting.</param>
  21966. <param name="cancellationToken">The cancellation token.</param>
  21967. <exception cref="T:System.ArgumentNullException">
  21968. <para><paramref name="socket"/> is <c>null</c>.</para>
  21969. <para>-or-</para>
  21970. <para><paramref name="host"/> is <c>null</c>.</para>
  21971. </exception>
  21972. <exception cref="T:System.ArgumentOutOfRangeException">
  21973. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  21974. </exception>
  21975. <exception cref="T:System.ArgumentException">
  21976. <para><paramref name="socket"/> is not connected.</para>
  21977. <para>-or-</para>
  21978. <para>The <paramref name="host"/> is a zero-length string.</para>
  21979. </exception>
  21980. <exception cref="T:System.ObjectDisposedException">
  21981. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
  21982. </exception>
  21983. <exception cref="T:System.InvalidOperationException">
  21984. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is already connected.
  21985. </exception>
  21986. <exception cref="T:System.NotSupportedException">
  21987. <paramref name="options"/> was set to
  21988. <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
  21989. and the SMTP server does not support the STARTTLS extension.
  21990. </exception>
  21991. <exception cref="T:System.OperationCanceledException">
  21992. The operation was canceled.
  21993. </exception>
  21994. <exception cref="T:MailKit.Security.SslHandshakeException">
  21995. An error occurred during the SSL/TLS negotiations.
  21996. </exception>
  21997. <exception cref="T:System.IO.IOException">
  21998. An I/O error occurred.
  21999. </exception>
  22000. <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
  22001. An SMTP command failed.
  22002. </exception>
  22003. <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
  22004. An SMTP protocol error occurred.
  22005. </exception>
  22006. </member>
  22007. <member name="M:MailKit.Net.Smtp.SmtpClient.ConnectAsync(System.IO.Stream,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
  22008. <summary>
  22009. Asynchronously establish a connection to the specified SMTP or SMTP/S server using the provided socket.
  22010. </summary>
  22011. <remarks>
  22012. <para>Establishes a connection to the specified SMTP or SMTP/S server using the provided socket.</para>
  22013. <para>If the <paramref name="options"/> has a value of
  22014. <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
  22015. to determine the default security options. If the <paramref name="port"/> has a value
  22016. of <c>465</c>, then the default options used will be
  22017. <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
  22018. <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
  22019. <para>Once a connection is established, properties such as
  22020. <see cref="P:MailKit.Net.Smtp.SmtpClient.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Smtp.SmtpClient.Capabilities"/> will be
  22021. populated.</para>
  22022. <note type="info">With the exception of using the <paramref name="port"/> to determine the
  22023. default <see cref="T:MailKit.Security.SecureSocketOptions"/> to use when the <paramref name="options"/> value
  22024. is <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, the <paramref name="host"/> and
  22025. <paramref name="port"/> parameters are only used for logging purposes.</note>
  22026. </remarks>
  22027. <returns>An asynchronous task context.</returns>
  22028. <param name="stream">The stream to use for the connection.</param>
  22029. <param name="host">The host name to connect to.</param>
  22030. <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
  22031. <param name="options">The secure socket options to when connecting.</param>
  22032. <param name="cancellationToken">The cancellation token.</param>
  22033. <exception cref="T:System.ArgumentNullException">
  22034. <para><paramref name="stream"/> is <c>null</c>.</para>
  22035. <para>-or-</para>
  22036. <para><paramref name="host"/> is <c>null</c>.</para>
  22037. </exception>
  22038. <exception cref="T:System.ArgumentOutOfRangeException">
  22039. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  22040. </exception>
  22041. <exception cref="T:System.ArgumentException">
  22042. The <paramref name="host"/> is a zero-length string.
  22043. </exception>
  22044. <exception cref="T:System.ObjectDisposedException">
  22045. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
  22046. </exception>
  22047. <exception cref="T:System.InvalidOperationException">
  22048. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is already connected.
  22049. </exception>
  22050. <exception cref="T:System.NotSupportedException">
  22051. <paramref name="options"/> was set to
  22052. <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
  22053. and the SMTP server does not support the STARTTLS extension.
  22054. </exception>
  22055. <exception cref="T:System.OperationCanceledException">
  22056. The operation was canceled.
  22057. </exception>
  22058. <exception cref="T:MailKit.Security.SslHandshakeException">
  22059. An error occurred during the SSL/TLS negotiations.
  22060. </exception>
  22061. <exception cref="T:System.IO.IOException">
  22062. An I/O error occurred.
  22063. </exception>
  22064. <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
  22065. An SMTP command failed.
  22066. </exception>
  22067. <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
  22068. An SMTP protocol error occurred.
  22069. </exception>
  22070. </member>
  22071. <member name="M:MailKit.Net.Smtp.SmtpClient.DisconnectAsync(System.Boolean,System.Threading.CancellationToken)">
  22072. <summary>
  22073. Asynchronously disconnect the service.
  22074. </summary>
  22075. <remarks>
  22076. If <paramref name="quit"/> is <c>true</c>, a <c>QUIT</c> command will be issued in order to disconnect cleanly.
  22077. </remarks>
  22078. <example>
  22079. <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessage"/>
  22080. </example>
  22081. <returns>An asynchronous task context.</returns>
  22082. <param name="quit">If set to <c>true</c>, a <c>QUIT</c> command will be issued in order to disconnect cleanly.</param>
  22083. <param name="cancellationToken">The cancellation token.</param>
  22084. <exception cref="T:System.ObjectDisposedException">
  22085. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
  22086. </exception>
  22087. </member>
  22088. <member name="M:MailKit.Net.Smtp.SmtpClient.NoOpAsync(System.Threading.CancellationToken)">
  22089. <summary>
  22090. Asynchronously ping the SMTP server to keep the connection alive.
  22091. </summary>
  22092. <remarks>Mail servers, if left idle for too long, will automatically drop the connection.</remarks>
  22093. <returns>An asynchronous task context.</returns>
  22094. <param name="cancellationToken">The cancellation token.</param>
  22095. <exception cref="T:System.ObjectDisposedException">
  22096. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
  22097. </exception>
  22098. <exception cref="T:MailKit.ServiceNotConnectedException">
  22099. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
  22100. </exception>
  22101. <exception cref="T:System.OperationCanceledException">
  22102. The operation was canceled.
  22103. </exception>
  22104. <exception cref="T:System.IO.IOException">
  22105. An I/O error occurred.
  22106. </exception>
  22107. <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
  22108. The SMTP command failed.
  22109. </exception>
  22110. <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
  22111. An SMTP protocol error occurred.
  22112. </exception>
  22113. </member>
  22114. <member name="M:MailKit.Net.Smtp.SmtpClient.SendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  22115. <summary>
  22116. Asynchronously send the specified message.
  22117. </summary>
  22118. <remarks>
  22119. <para>Sends the specified message.</para>
  22120. <para>The sender address is determined by checking the following
  22121. message headers (in order of precedence): Resent-Sender,
  22122. Resent-From, Sender, and From.</para>
  22123. <para>If either the Resent-Sender or Resent-From addresses are present,
  22124. the recipients are collected from the Resent-To, Resent-Cc, and
  22125. Resent-Bcc headers, otherwise the To, Cc, and Bcc headers are used.</para>
  22126. </remarks>
  22127. <example>
  22128. <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessageWithOptions"/>
  22129. </example>
  22130. <returns>An asynchronous task context.</returns>
  22131. <param name="options">The formatting options.</param>
  22132. <param name="message">The message.</param>
  22133. <param name="cancellationToken">The cancellation token.</param>
  22134. <param name="progress">The progress reporting mechanism.</param>
  22135. <exception cref="T:System.ArgumentNullException">
  22136. <para><paramref name="options"/> is <c>null</c>.</para>
  22137. <para>-or-</para>
  22138. <para><paramref name="message"/> is <c>null</c>.</para>
  22139. </exception>
  22140. <exception cref="T:System.ObjectDisposedException">
  22141. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
  22142. </exception>
  22143. <exception cref="T:MailKit.ServiceNotConnectedException">
  22144. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
  22145. </exception>
  22146. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  22147. Authentication is required before sending a message.
  22148. </exception>
  22149. <exception cref="T:System.InvalidOperationException">
  22150. <para>A sender has not been specified.</para>
  22151. <para>-or-</para>
  22152. <para>No recipients have been specified.</para>
  22153. </exception>
  22154. <exception cref="T:System.NotSupportedException">
  22155. Internationalized formatting was requested but is not supported by the server.
  22156. </exception>
  22157. <exception cref="T:System.OperationCanceledException">
  22158. The operation has been canceled.
  22159. </exception>
  22160. <exception cref="T:System.IO.IOException">
  22161. An I/O error occurred.
  22162. </exception>
  22163. <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
  22164. The SMTP command failed.
  22165. </exception>
  22166. <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
  22167. An SMTP protocol exception occurred.
  22168. </exception>
  22169. </member>
  22170. <member name="M:MailKit.Net.Smtp.SmtpClient.SendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,MimeKit.MailboxAddress,System.Collections.Generic.IEnumerable{MimeKit.MailboxAddress},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  22171. <summary>
  22172. Asynchronously send the specified message using the supplied sender and recipients.
  22173. </summary>
  22174. <remarks>
  22175. Sends the message by uploading it to an SMTP server using the supplied sender and recipients.
  22176. </remarks>
  22177. <returns>An asynchronous task context.</returns>
  22178. <param name="options">The formatting options.</param>
  22179. <param name="message">The message.</param>
  22180. <param name="sender">The mailbox address to use for sending the message.</param>
  22181. <param name="recipients">The mailbox addresses that should receive the message.</param>
  22182. <param name="cancellationToken">The cancellation token.</param>
  22183. <param name="progress">The progress reporting mechanism.</param>
  22184. <exception cref="T:System.ArgumentNullException">
  22185. <para><paramref name="options"/> is <c>null</c>.</para>
  22186. <para>-or-</para>
  22187. <para><paramref name="message"/> is <c>null</c>.</para>
  22188. <para>-or-</para>
  22189. <para><paramref name="sender"/> is <c>null</c>.</para>
  22190. <para>-or-</para>
  22191. <para><paramref name="recipients"/> is <c>null</c>.</para>
  22192. </exception>
  22193. <exception cref="T:System.ObjectDisposedException">
  22194. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
  22195. </exception>
  22196. <exception cref="T:MailKit.ServiceNotConnectedException">
  22197. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
  22198. </exception>
  22199. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  22200. Authentication is required before sending a message.
  22201. </exception>
  22202. <exception cref="T:System.InvalidOperationException">
  22203. <para>A sender has not been specified.</para>
  22204. <para>-or-</para>
  22205. <para>No recipients have been specified.</para>
  22206. </exception>
  22207. <exception cref="T:System.NotSupportedException">
  22208. Internationalized formatting was requested but is not supported by the server.
  22209. </exception>
  22210. <exception cref="T:System.OperationCanceledException">
  22211. The operation has been canceled.
  22212. </exception>
  22213. <exception cref="T:System.IO.IOException">
  22214. An I/O error occurred.
  22215. </exception>
  22216. <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
  22217. The SMTP command failed.
  22218. </exception>
  22219. <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
  22220. An SMTP protocol exception occurred.
  22221. </exception>
  22222. </member>
  22223. <member name="M:MailKit.Net.Smtp.SmtpClient.ExpandAsync(System.String,System.Threading.CancellationToken)">
  22224. <summary>
  22225. Asynchronously expand a mailing address alias.
  22226. </summary>
  22227. <remarks>
  22228. Expands a mailing address alias.
  22229. </remarks>
  22230. <returns>The expanded list of mailbox addresses.</returns>
  22231. <param name="alias">The mailing address alias.</param>
  22232. <param name="cancellationToken">The cancellation token.</param>
  22233. <exception cref="T:System.ArgumentNullException">
  22234. <paramref name="alias"/> is <c>null</c>.
  22235. </exception>
  22236. <exception cref="T:System.ArgumentException">
  22237. <paramref name="alias"/> is an empty string.
  22238. </exception>
  22239. <exception cref="T:System.ObjectDisposedException">
  22240. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
  22241. </exception>
  22242. <exception cref="T:MailKit.ServiceNotConnectedException">
  22243. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
  22244. </exception>
  22245. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  22246. Authentication is required before verifying the existence of an address.
  22247. </exception>
  22248. <exception cref="T:System.OperationCanceledException">
  22249. The operation has been canceled.
  22250. </exception>
  22251. <exception cref="T:System.IO.IOException">
  22252. An I/O error occurred.
  22253. </exception>
  22254. <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
  22255. The SMTP command failed.
  22256. </exception>
  22257. <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
  22258. An SMTP protocol exception occurred.
  22259. </exception>
  22260. </member>
  22261. <member name="M:MailKit.Net.Smtp.SmtpClient.VerifyAsync(System.String,System.Threading.CancellationToken)">
  22262. <summary>
  22263. Asynchronously verify the existence of a mailbox address.
  22264. </summary>
  22265. <remarks>
  22266. Verifies the existence a mailbox address with the SMTP server, returning the expanded
  22267. mailbox address if it exists.
  22268. </remarks>
  22269. <returns>The expanded mailbox address.</returns>
  22270. <param name="address">The mailbox address.</param>
  22271. <param name="cancellationToken">The cancellation token.</param>
  22272. <exception cref="T:System.ArgumentNullException">
  22273. <paramref name="address"/> is <c>null</c>.
  22274. </exception>
  22275. <exception cref="T:System.ArgumentException">
  22276. <paramref name="address"/> is an empty string.
  22277. </exception>
  22278. <exception cref="T:System.ObjectDisposedException">
  22279. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
  22280. </exception>
  22281. <exception cref="T:MailKit.ServiceNotConnectedException">
  22282. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
  22283. </exception>
  22284. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  22285. Authentication is required before verifying the existence of an address.
  22286. </exception>
  22287. <exception cref="T:System.OperationCanceledException">
  22288. The operation has been canceled.
  22289. </exception>
  22290. <exception cref="T:System.IO.IOException">
  22291. An I/O error occurred.
  22292. </exception>
  22293. <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
  22294. The SMTP command failed.
  22295. </exception>
  22296. <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
  22297. An SMTP protocol exception occurred.
  22298. </exception>
  22299. </member>
  22300. <member name="M:MailKit.Net.Smtp.SmtpClient.#ctor">
  22301. <summary>
  22302. Initializes a new instance of the <see cref="T:MailKit.Net.Smtp.SmtpClient"/> class.
  22303. </summary>
  22304. <remarks>
  22305. Before you can send messages with the <see cref="T:MailKit.Net.Smtp.SmtpClient"/>, you must first call one of
  22306. the <a href="Overload_MailKit_Net_Smtp_SmtpClient_Connect.htm">Connect</a> methods.
  22307. Depending on whether the SMTP server requires authenticating or not, you may also need to
  22308. authenticate using one of the
  22309. <a href="Overload_MailKit_Net_Smtp_SmtpClient_Authenticate.htm">Authenticate</a> methods.
  22310. </remarks>
  22311. <example>
  22312. <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessages" />
  22313. </example>
  22314. </member>
  22315. <member name="M:MailKit.Net.Smtp.SmtpClient.#ctor(MailKit.IProtocolLogger)">
  22316. <summary>
  22317. Initializes a new instance of the <see cref="T:MailKit.Net.Smtp.SmtpClient"/> class.
  22318. </summary>
  22319. <remarks>
  22320. Before you can send messages with the <see cref="T:MailKit.Net.Smtp.SmtpClient"/>, you must first call one of
  22321. the <a href="Overload_MailKit_Net_Smtp_SmtpClient_Connect.htm">Connect</a> methods.
  22322. Depending on whether the SMTP server requires authenticating or not, you may also need to
  22323. authenticate using one of the
  22324. <a href="Overload_MailKit_Net_Smtp_SmtpClient_Authenticate.htm">Authenticate</a> methods.
  22325. </remarks>
  22326. <param name="protocolLogger">The protocol logger.</param>
  22327. <exception cref="T:System.ArgumentNullException">
  22328. <paramref name="protocolLogger"/> is <c>null</c>.
  22329. </exception>
  22330. <example>
  22331. <code language="c#" source="Examples\SmtpExamples.cs" region="ProtocolLogger"/>
  22332. </example>
  22333. </member>
  22334. <member name="P:MailKit.Net.Smtp.SmtpClient.Stream">
  22335. <summary>
  22336. Get the underlying SMTP stream.
  22337. </summary>
  22338. <remarks>
  22339. Gets the underlying SMTP stream.
  22340. </remarks>
  22341. <value>The SMTP stream.</value>
  22342. </member>
  22343. <member name="P:MailKit.Net.Smtp.SmtpClient.SyncRoot">
  22344. <summary>
  22345. Gets an object that can be used to synchronize access to the SMTP server.
  22346. </summary>
  22347. <remarks>
  22348. <para>Gets an object that can be used to synchronize access to the SMTP server between multiple threads.</para>
  22349. <para>When using <see cref="T:MailKit.Net.Smtp.SmtpClient"/> methods from multiple threads, it is important to lock the
  22350. <see cref="P:MailKit.Net.Smtp.SmtpClient.SyncRoot"/> object for thread safety.</para>
  22351. </remarks>
  22352. <value>The lock object.</value>
  22353. </member>
  22354. <member name="P:MailKit.Net.Smtp.SmtpClient.Protocol">
  22355. <summary>
  22356. Get the protocol supported by the message service.
  22357. </summary>
  22358. <remarks>
  22359. Gets the protocol supported by the message service.
  22360. </remarks>
  22361. <value>The protocol.</value>
  22362. </member>
  22363. <member name="P:MailKit.Net.Smtp.SmtpClient.Capabilities">
  22364. <summary>
  22365. Get the capabilities supported by the SMTP server.
  22366. </summary>
  22367. <remarks>
  22368. The capabilities will not be known until a successful connection has been made
  22369. and may change once the client is authenticated.
  22370. </remarks>
  22371. <example>
  22372. <code language="c#" source="Examples\SmtpExamples.cs" region="Capabilities"/>
  22373. </example>
  22374. <value>The capabilities.</value>
  22375. <exception cref="T:System.ArgumentException">
  22376. Capabilities cannot be enabled, they may only be disabled.
  22377. </exception>
  22378. </member>
  22379. <member name="P:MailKit.Net.Smtp.SmtpClient.LocalDomain">
  22380. <summary>
  22381. Get or set the local domain.
  22382. </summary>
  22383. <remarks>
  22384. The local domain is used in the HELO or EHLO commands sent to
  22385. the SMTP server. If left unset, the local IP address will be
  22386. used instead.
  22387. </remarks>
  22388. <value>The local domain.</value>
  22389. </member>
  22390. <member name="P:MailKit.Net.Smtp.SmtpClient.PreferSendAsBinaryData">
  22391. <summary>
  22392. Get whether or not the BDAT command is preferred over the DATA command.
  22393. </summary>
  22394. <remarks>
  22395. <para>Gets whether or not the <c>BDAT</c> command is preferred over the standard <c>DATA</c>
  22396. command.</para>
  22397. <para>The <c>BDAT</c> command is normally only used when the message being sent contains binary data
  22398. (e.g. one mor more MIME parts contains a <c>Content-Transfer-Encoding: binary</c> header). This
  22399. option provides a way to override this behavior, forcing the <see cref="T:MailKit.Net.Smtp.SmtpClient"/> to send
  22400. messages using the <c>BDAT</c> command instead of the <c>DATA</c> command even when it is not
  22401. necessary to do so.</para>
  22402. </remarks>
  22403. <value><c>true</c> if the <c>BDAT</c> command is preferred over the <c>DATA</c> command; otherwise, <c>false</c>.</value>
  22404. </member>
  22405. <member name="P:MailKit.Net.Smtp.SmtpClient.MaxSize">
  22406. <summary>
  22407. Get the maximum message size supported by the server.
  22408. </summary>
  22409. <remarks>
  22410. <para>The maximum message size will not be known until a successful connection has
  22411. been made and may change once the client is authenticated.</para>
  22412. <note type="note">This value is only relevant if the <see cref="P:MailKit.Net.Smtp.SmtpClient.Capabilities"/> includes
  22413. the <see cref="F:MailKit.Net.Smtp.SmtpCapabilities.Size"/> flag.</note>
  22414. </remarks>
  22415. <example>
  22416. <code language="c#" source="Examples\SmtpExamples.cs" region="Capabilities"/>
  22417. </example>
  22418. <value>The maximum message size supported by the server.</value>
  22419. </member>
  22420. <member name="P:MailKit.Net.Smtp.SmtpClient.AuthenticationMechanisms">
  22421. <summary>
  22422. Get the authentication mechanisms supported by the SMTP server.
  22423. </summary>
  22424. <remarks>
  22425. <para>The authentication mechanisms are queried as part of the connection
  22426. process.</para>
  22427. <note type="tip">To prevent the usage of certain authentication mechanisms,
  22428. simply remove them from the <see cref="P:MailKit.Net.Smtp.SmtpClient.AuthenticationMechanisms"/> hash set
  22429. before authenticating.</note>
  22430. </remarks>
  22431. <example>
  22432. <code language="c#" source="Examples\SmtpExamples.cs" region="Capabilities"/>
  22433. </example>
  22434. <value>The authentication mechanisms.</value>
  22435. </member>
  22436. <member name="P:MailKit.Net.Smtp.SmtpClient.Timeout">
  22437. <summary>
  22438. Get or set the timeout for network streaming operations, in milliseconds.
  22439. </summary>
  22440. <remarks>
  22441. Gets or sets the underlying socket stream's <see cref="P:System.IO.Stream.ReadTimeout"/>
  22442. and <see cref="P:System.IO.Stream.WriteTimeout"/> values.
  22443. </remarks>
  22444. <value>The timeout in milliseconds.</value>
  22445. </member>
  22446. <member name="P:MailKit.Net.Smtp.SmtpClient.IsConnected">
  22447. <summary>
  22448. Get whether or not the client is currently connected to an SMTP server.
  22449. </summary>
  22450. <remarks>
  22451. <para>The <see cref="P:MailKit.Net.Smtp.SmtpClient.IsConnected"/> state is set to <c>true</c> immediately after
  22452. one of the <a href="Overload_MailKit_Net_Smtp_SmtpClient_Connect.htm">Connect</a>
  22453. methods succeeds and is not set back to <c>false</c> until either the client
  22454. is disconnected via <see cref="M:MailKit.Net.Smtp.SmtpClient.Disconnect(System.Boolean,System.Threading.CancellationToken)"/> or until an
  22455. <see cref="T:MailKit.Net.Smtp.SmtpProtocolException"/> is thrown while attempting to read or write to
  22456. the underlying network socket.</para>
  22457. <para>When an <see cref="T:MailKit.Net.Smtp.SmtpProtocolException"/> is caught, the connection state of the
  22458. <see cref="T:MailKit.Net.Smtp.SmtpClient"/> should be checked before continuing.</para>
  22459. </remarks>
  22460. <example>
  22461. <code language="c#" source="Examples\SmtpExamples.cs" region="ExceptionHandling"/>
  22462. </example>
  22463. <value><c>true</c> if the client is connected; otherwise, <c>false</c>.</value>
  22464. </member>
  22465. <member name="P:MailKit.Net.Smtp.SmtpClient.IsSecure">
  22466. <summary>
  22467. Get whether or not the connection is secure (typically via SSL or TLS).
  22468. </summary>
  22469. <remarks>
  22470. Gets whether or not the connection is secure (typically via SSL or TLS).
  22471. </remarks>
  22472. <value><c>true</c> if the connection is secure; otherwise, <c>false</c>.</value>
  22473. </member>
  22474. <member name="P:MailKit.Net.Smtp.SmtpClient.IsAuthenticated">
  22475. <summary>
  22476. Get whether or not the client is currently authenticated with the SMTP server.
  22477. </summary>
  22478. <remarks>
  22479. <para>Gets whether or not the client is currently authenticated with the SMTP server.</para>
  22480. <para>To authenticate with the SMTP server, use one of the
  22481. <a href="Overload_MailKit_Net_Smtp_SmtpClient_Authenticate.htm">Authenticate</a>
  22482. methods.</para>
  22483. </remarks>
  22484. <value><c>true</c> if the client is connected; otherwise, <c>false</c>.</value>
  22485. </member>
  22486. <member name="M:MailKit.Net.Smtp.SmtpClient.OnNoRecipientsAccepted(MimeKit.MimeMessage)">
  22487. <summary>
  22488. Invoked only when no recipients were accepted by the SMTP server.
  22489. </summary>
  22490. <remarks>
  22491. If <see cref="M:MailKit.Net.Smtp.SmtpClient.OnRecipientNotAccepted(MimeKit.MimeMessage,MimeKit.MailboxAddress,MailKit.Net.Smtp.SmtpResponse)"/> is overridden to not throw
  22492. an exception, this method should be overridden to throw an appropriate
  22493. exception instead.
  22494. </remarks>
  22495. <param name="message">The message being sent.</param>
  22496. </member>
  22497. <member name="M:MailKit.Net.Smtp.SmtpClient.SendCommand(System.String,System.Threading.CancellationToken)">
  22498. <summary>
  22499. Send a custom command to the SMTP server.
  22500. </summary>
  22501. <remarks>
  22502. <para>Sends a custom command to the SMTP server.</para>
  22503. <note type="note">The command string should not include the terminating <c>\r\n</c> sequence.</note>
  22504. </remarks>
  22505. <returns>The command response.</returns>
  22506. <param name="command">The command.</param>
  22507. <param name="cancellationToken">The cancellation token.</param>
  22508. <exception cref="T:System.ArgumentNullException">
  22509. <paramref name="command"/> is <c>null</c>.
  22510. </exception>
  22511. <exception cref="T:System.ObjectDisposedException">
  22512. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
  22513. </exception>
  22514. <exception cref="T:MailKit.ServiceNotConnectedException">
  22515. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
  22516. </exception>
  22517. <exception cref="T:System.OperationCanceledException">
  22518. The operation has been canceled.
  22519. </exception>
  22520. <exception cref="T:System.IO.IOException">
  22521. An I/O error occurred.
  22522. </exception>
  22523. <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
  22524. The SMTP command failed.
  22525. </exception>
  22526. <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
  22527. An SMTP protocol exception occurred.
  22528. </exception>
  22529. </member>
  22530. <member name="M:MailKit.Net.Smtp.SmtpClient.Authenticate(MailKit.Security.SaslMechanism,System.Threading.CancellationToken)">
  22531. <summary>
  22532. Authenticate using the specified SASL mechanism.
  22533. </summary>
  22534. <remarks>
  22535. <para>Authenticates using the specified SASL mechanism.</para>
  22536. <para>For a list of available SASL authentication mechanisms supported by the server,
  22537. check the <see cref="P:MailKit.Net.Smtp.SmtpClient.AuthenticationMechanisms"/> property after the service has been
  22538. connected.</para>
  22539. </remarks>
  22540. <param name="mechanism">The SASL mechanism.</param>
  22541. <param name="cancellationToken">The cancellation token.</param>
  22542. <exception cref="T:System.ArgumentNullException">
  22543. <paramref name="mechanism"/> is <c>null</c>.
  22544. </exception>
  22545. <exception cref="T:MailKit.ServiceNotConnectedException">
  22546. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
  22547. </exception>
  22548. <exception cref="T:System.InvalidOperationException">
  22549. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is already authenticated.
  22550. </exception>
  22551. <exception cref="T:System.NotSupportedException">
  22552. The SMTP server does not support authentication.
  22553. </exception>
  22554. <exception cref="T:System.OperationCanceledException">
  22555. The operation was canceled via the cancellation token.
  22556. </exception>
  22557. <exception cref="T:MailKit.Security.AuthenticationException">
  22558. Authentication using the supplied credentials has failed.
  22559. </exception>
  22560. <exception cref="T:MailKit.Security.SaslException">
  22561. A SASL authentication error occurred.
  22562. </exception>
  22563. <exception cref="T:System.IO.IOException">
  22564. An I/O error occurred.
  22565. </exception>
  22566. <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
  22567. The SMTP command failed.
  22568. </exception>
  22569. <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
  22570. An SMTP protocol error occurred.
  22571. </exception>
  22572. </member>
  22573. <member name="M:MailKit.Net.Smtp.SmtpClient.Authenticate(System.Text.Encoding,System.Net.ICredentials,System.Threading.CancellationToken)">
  22574. <summary>
  22575. Authenticate using the supplied credentials.
  22576. </summary>
  22577. <remarks>
  22578. <para>If the SMTP server supports authentication, then the SASL mechanisms
  22579. that both the client and server support are tried in order of greatest
  22580. security to weakest security. Once a SASL authentication mechanism is
  22581. found that both client and server support, the credentials are used to
  22582. authenticate.</para>
  22583. <para>If, on the other hand, authentication is not supported by the SMTP
  22584. server, then this method will throw <see cref="T:System.NotSupportedException"/>.
  22585. The <see cref="P:MailKit.Net.Smtp.SmtpClient.Capabilities"/> property can be checked for the
  22586. <see cref="F:MailKit.Net.Smtp.SmtpCapabilities.Authentication"/> flag to make sure the
  22587. SMTP server supports authentication before calling this method.</para>
  22588. <note type="tip"> To prevent the usage of certain authentication mechanisms,
  22589. simply remove them from the <see cref="P:MailKit.Net.Smtp.SmtpClient.AuthenticationMechanisms"/> hash set
  22590. before calling this method.</note>
  22591. </remarks>
  22592. <param name="encoding">The text encoding to use for the user's credentials.</param>
  22593. <param name="credentials">The user's credentials.</param>
  22594. <param name="cancellationToken">The cancellation token.</param>
  22595. <exception cref="T:System.ArgumentNullException">
  22596. <para><paramref name="encoding"/> is <c>null</c>.</para>
  22597. <para>-or-</para>
  22598. <para><paramref name="credentials"/> is <c>null</c>.</para>
  22599. </exception>
  22600. <exception cref="T:MailKit.ServiceNotConnectedException">
  22601. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
  22602. </exception>
  22603. <exception cref="T:System.InvalidOperationException">
  22604. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is already authenticated.
  22605. </exception>
  22606. <exception cref="T:System.NotSupportedException">
  22607. The SMTP server does not support authentication.
  22608. </exception>
  22609. <exception cref="T:System.OperationCanceledException">
  22610. The operation was canceled via the cancellation token.
  22611. </exception>
  22612. <exception cref="T:MailKit.Security.AuthenticationException">
  22613. Authentication using the supplied credentials has failed.
  22614. </exception>
  22615. <exception cref="T:MailKit.Security.SaslException">
  22616. A SASL authentication error occurred.
  22617. </exception>
  22618. <exception cref="T:System.IO.IOException">
  22619. An I/O error occurred.
  22620. </exception>
  22621. <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
  22622. The SMTP command failed.
  22623. </exception>
  22624. <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
  22625. An SMTP protocol error occurred.
  22626. </exception>
  22627. </member>
  22628. <member name="M:MailKit.Net.Smtp.SmtpClient.Connect(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
  22629. <summary>
  22630. Establish a connection to the specified SMTP or SMTP/S server.
  22631. </summary>
  22632. <remarks>
  22633. <para>Establishes a connection to the specified SMTP or SMTP/S server.</para>
  22634. <para>If the <paramref name="port"/> has a value of <c>0</c>, then the
  22635. <paramref name="options"/> parameter is used to determine the default port to
  22636. connect to. The default port used with <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>
  22637. is <c>465</c>. All other values will use a default port of <c>25</c>.</para>
  22638. <para>If the <paramref name="options"/> has a value of
  22639. <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
  22640. to determine the default security options. If the <paramref name="port"/> has a value
  22641. of <c>465</c>, then the default options used will be
  22642. <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
  22643. <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
  22644. <para>Once a connection is established, properties such as
  22645. <see cref="P:MailKit.Net.Smtp.SmtpClient.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Smtp.SmtpClient.Capabilities"/> will be
  22646. populated.</para>
  22647. <note type="note">The connection established by any of the
  22648. <a href="Overload_MailKit_Net_Smtp_SmtpClient_Connect.htm">Connect</a>
  22649. methods may be re-used if an application wishes to send multiple messages
  22650. to the same SMTP server. Since connecting and authenticating can be expensive
  22651. operations, re-using a connection can significantly improve performance when
  22652. sending a large number of messages to the same SMTP server over a short
  22653. period of time.</note>
  22654. </remarks>
  22655. <example>
  22656. <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessage"/>
  22657. </example>
  22658. <param name="host">The host name to connect to.</param>
  22659. <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
  22660. <param name="options">The secure socket options to when connecting.</param>
  22661. <param name="cancellationToken">The cancellation token.</param>
  22662. <exception cref="T:System.ArgumentNullException">
  22663. <paramref name="host"/> is <c>null</c>.
  22664. </exception>
  22665. <exception cref="T:System.ArgumentOutOfRangeException">
  22666. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  22667. </exception>
  22668. <exception cref="T:System.ArgumentException">
  22669. The <paramref name="host"/> is a zero-length string.
  22670. </exception>
  22671. <exception cref="T:System.ObjectDisposedException">
  22672. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
  22673. </exception>
  22674. <exception cref="T:System.InvalidOperationException">
  22675. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is already connected.
  22676. </exception>
  22677. <exception cref="T:System.NotSupportedException">
  22678. <paramref name="options"/> was set to
  22679. <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
  22680. and the SMTP server does not support the STARTTLS extension.
  22681. </exception>
  22682. <exception cref="T:System.OperationCanceledException">
  22683. The operation was canceled.
  22684. </exception>
  22685. <exception cref="T:System.Net.Sockets.SocketException">
  22686. A socket error occurred trying to connect to the remote host.
  22687. </exception>
  22688. <exception cref="T:MailKit.Security.SslHandshakeException">
  22689. An error occurred during the SSL/TLS negotiations.
  22690. </exception>
  22691. <exception cref="T:System.IO.IOException">
  22692. An I/O error occurred.
  22693. </exception>
  22694. <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
  22695. An SMTP command failed.
  22696. </exception>
  22697. <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
  22698. An SMTP protocol error occurred.
  22699. </exception>
  22700. </member>
  22701. <member name="M:MailKit.Net.Smtp.SmtpClient.Connect(System.Net.Sockets.Socket,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
  22702. <summary>
  22703. Establish a connection to the specified SMTP or SMTP/S server using the provided socket.
  22704. </summary>
  22705. <remarks>
  22706. <para>Establishes a connection to the specified SMTP or SMTP/S server using the provided socket.</para>
  22707. <para>If the <paramref name="options"/> has a value of
  22708. <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
  22709. to determine the default security options. If the <paramref name="port"/> has a value
  22710. of <c>465</c>, then the default options used will be
  22711. <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
  22712. <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
  22713. <para>Once a connection is established, properties such as
  22714. <see cref="P:MailKit.Net.Smtp.SmtpClient.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Smtp.SmtpClient.Capabilities"/> will be
  22715. populated.</para>
  22716. <note type="info">With the exception of using the <paramref name="port"/> to determine the
  22717. default <see cref="T:MailKit.Security.SecureSocketOptions"/> to use when the <paramref name="options"/> value
  22718. is <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, the <paramref name="host"/> and
  22719. <paramref name="port"/> parameters are only used for logging purposes.</note>
  22720. </remarks>
  22721. <param name="socket">The socket to use for the connection.</param>
  22722. <param name="host">The host name to connect to.</param>
  22723. <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
  22724. <param name="options">The secure socket options to when connecting.</param>
  22725. <param name="cancellationToken">The cancellation token.</param>
  22726. <exception cref="T:System.ArgumentNullException">
  22727. <para><paramref name="socket"/> is <c>null</c>.</para>
  22728. <para>-or-</para>
  22729. <para><paramref name="host"/> is <c>null</c>.</para>
  22730. </exception>
  22731. <exception cref="T:System.ArgumentOutOfRangeException">
  22732. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  22733. </exception>
  22734. <exception cref="T:System.ArgumentException">
  22735. <para><paramref name="socket"/> is not connected.</para>
  22736. <para>-or-</para>
  22737. <para>The <paramref name="host"/> is a zero-length string.</para>
  22738. </exception>
  22739. <exception cref="T:System.ObjectDisposedException">
  22740. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
  22741. </exception>
  22742. <exception cref="T:System.InvalidOperationException">
  22743. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is already connected.
  22744. </exception>
  22745. <exception cref="T:System.NotSupportedException">
  22746. <paramref name="options"/> was set to
  22747. <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
  22748. and the SMTP server does not support the STARTTLS extension.
  22749. </exception>
  22750. <exception cref="T:System.OperationCanceledException">
  22751. The operation was canceled.
  22752. </exception>
  22753. <exception cref="T:MailKit.Security.SslHandshakeException">
  22754. An error occurred during the SSL/TLS negotiations.
  22755. </exception>
  22756. <exception cref="T:System.IO.IOException">
  22757. An I/O error occurred.
  22758. </exception>
  22759. <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
  22760. An SMTP command failed.
  22761. </exception>
  22762. <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
  22763. An SMTP protocol error occurred.
  22764. </exception>
  22765. </member>
  22766. <member name="M:MailKit.Net.Smtp.SmtpClient.Connect(System.IO.Stream,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
  22767. <summary>
  22768. Establish a connection to the specified SMTP or SMTP/S server using the provided stream.
  22769. </summary>
  22770. <remarks>
  22771. <para>Establishes a connection to the specified SMTP or SMTP/S server using the provided stream.</para>
  22772. <para>If the <paramref name="options"/> has a value of
  22773. <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, then the <paramref name="port"/> is used
  22774. to determine the default security options. If the <paramref name="port"/> has a value
  22775. of <c>465</c>, then the default options used will be
  22776. <see cref="F:MailKit.Security.SecureSocketOptions.SslOnConnect"/>. All other values will use
  22777. <see cref="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable"/>.</para>
  22778. <para>Once a connection is established, properties such as
  22779. <see cref="P:MailKit.Net.Smtp.SmtpClient.AuthenticationMechanisms"/> and <see cref="P:MailKit.Net.Smtp.SmtpClient.Capabilities"/> will be
  22780. populated.</para>
  22781. <note type="info">With the exception of using the <paramref name="port"/> to determine the
  22782. default <see cref="T:MailKit.Security.SecureSocketOptions"/> to use when the <paramref name="options"/> value
  22783. is <see cref="F:MailKit.Security.SecureSocketOptions.Auto"/>, the <paramref name="host"/> and
  22784. <paramref name="port"/> parameters are only used for logging purposes.</note>
  22785. </remarks>
  22786. <param name="stream">The stream to use for the connection.</param>
  22787. <param name="host">The host name to connect to.</param>
  22788. <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
  22789. <param name="options">The secure socket options to when connecting.</param>
  22790. <param name="cancellationToken">The cancellation token.</param>
  22791. <exception cref="T:System.ArgumentNullException">
  22792. <para><paramref name="stream"/> is <c>null</c>.</para>
  22793. <para>-or-</para>
  22794. <para><paramref name="host"/> is <c>null</c>.</para>
  22795. </exception>
  22796. <exception cref="T:System.ArgumentOutOfRangeException">
  22797. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  22798. </exception>
  22799. <exception cref="T:System.ArgumentException">
  22800. The <paramref name="host"/> is a zero-length string.
  22801. </exception>
  22802. <exception cref="T:System.ObjectDisposedException">
  22803. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
  22804. </exception>
  22805. <exception cref="T:System.InvalidOperationException">
  22806. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is already connected.
  22807. </exception>
  22808. <exception cref="T:System.NotSupportedException">
  22809. <paramref name="options"/> was set to
  22810. <see cref="F:MailKit.Security.SecureSocketOptions.StartTls"/>
  22811. and the SMTP server does not support the STARTTLS extension.
  22812. </exception>
  22813. <exception cref="T:System.OperationCanceledException">
  22814. The operation was canceled.
  22815. </exception>
  22816. <exception cref="T:MailKit.Security.SslHandshakeException">
  22817. An error occurred during the SSL/TLS negotiations.
  22818. </exception>
  22819. <exception cref="T:System.IO.IOException">
  22820. An I/O error occurred.
  22821. </exception>
  22822. <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
  22823. An SMTP command failed.
  22824. </exception>
  22825. <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
  22826. An SMTP protocol error occurred.
  22827. </exception>
  22828. </member>
  22829. <member name="M:MailKit.Net.Smtp.SmtpClient.Disconnect(System.Boolean,System.Threading.CancellationToken)">
  22830. <summary>
  22831. Disconnect the service.
  22832. </summary>
  22833. <remarks>
  22834. If <paramref name="quit"/> is <c>true</c>, a <c>QUIT</c> command will be issued in order to disconnect cleanly.
  22835. </remarks>
  22836. <example>
  22837. <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessage"/>
  22838. </example>
  22839. <param name="quit">If set to <c>true</c>, a <c>QUIT</c> command will be issued in order to disconnect cleanly.</param>
  22840. <param name="cancellationToken">The cancellation token.</param>
  22841. <exception cref="T:System.ObjectDisposedException">
  22842. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
  22843. </exception>
  22844. </member>
  22845. <member name="M:MailKit.Net.Smtp.SmtpClient.NoOp(System.Threading.CancellationToken)">
  22846. <summary>
  22847. Ping the SMTP server to keep the connection alive.
  22848. </summary>
  22849. <remarks>Mail servers, if left idle for too long, will automatically drop the connection.</remarks>
  22850. <param name="cancellationToken">The cancellation token.</param>
  22851. <exception cref="T:System.ObjectDisposedException">
  22852. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
  22853. </exception>
  22854. <exception cref="T:MailKit.ServiceNotConnectedException">
  22855. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
  22856. </exception>
  22857. <exception cref="T:System.OperationCanceledException">
  22858. The operation was canceled.
  22859. </exception>
  22860. <exception cref="T:System.IO.IOException">
  22861. An I/O error occurred.
  22862. </exception>
  22863. <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
  22864. The SMTP command failed.
  22865. </exception>
  22866. <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
  22867. An SMTP protocol error occurred.
  22868. </exception>
  22869. </member>
  22870. <member name="M:MailKit.Net.Smtp.SmtpClient.OnSenderAccepted(MimeKit.MimeMessage,MimeKit.MailboxAddress,MailKit.Net.Smtp.SmtpResponse)">
  22871. <summary>
  22872. Invoked when the sender is accepted by the SMTP server.
  22873. </summary>
  22874. <remarks>
  22875. The default implementation does nothing.
  22876. </remarks>
  22877. <param name="message">The message being sent.</param>
  22878. <param name="mailbox">The mailbox used in the <c>MAIL FROM</c> command.</param>
  22879. <param name="response">The response to the <c>MAIL FROM</c> command.</param>
  22880. </member>
  22881. <member name="M:MailKit.Net.Smtp.SmtpClient.OnSenderNotAccepted(MimeKit.MimeMessage,MimeKit.MailboxAddress,MailKit.Net.Smtp.SmtpResponse)">
  22882. <summary>
  22883. Invoked when a recipient is not accepted by the SMTP server.
  22884. </summary>
  22885. <remarks>
  22886. The default implementation throws an appropriate <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/>.
  22887. </remarks>
  22888. <param name="message">The message being sent.</param>
  22889. <param name="mailbox">The mailbox used in the <c>MAIL FROM</c> command.</param>
  22890. <param name="response">The response to the <c>MAIL FROM</c> command.</param>
  22891. </member>
  22892. <member name="M:MailKit.Net.Smtp.SmtpClient.GetEnvelopeId(MimeKit.MimeMessage)">
  22893. <summary>
  22894. Get the envelope identifier to be used with delivery status notifications.
  22895. </summary>
  22896. <remarks>
  22897. <para>The envelope identifier, if non-empty, is useful in determining which message a delivery
  22898. status notification was issued for.</para>
  22899. <para>The envelope identifier should be unique and may be up to 100 characters in length, but
  22900. must consist only of printable ASCII characters and no white space.</para>
  22901. <para>For more information, see
  22902. <a href="https://tools.ietf.org/html/rfc3461#section-4.4">rfc3461, section 4.4</a>.</para>
  22903. </remarks>
  22904. <example>
  22905. <code language="c#" source="Examples\SmtpExamples.cs" region="DeliveryStatusNotification"/>
  22906. </example>
  22907. <returns>The envelope identifier.</returns>
  22908. <param name="message">The message.</param>
  22909. </member>
  22910. <member name="P:MailKit.Net.Smtp.SmtpClient.DeliveryStatusNotificationType">
  22911. <summary>
  22912. Get or set how much of the message to include in any failed delivery status notifications.
  22913. </summary>
  22914. <remarks>
  22915. Gets or sets how much of the message to include in any failed delivery status notifications.
  22916. </remarks>
  22917. <value>A value indicating how much of the message to include in a failure delivery status notification.</value>
  22918. </member>
  22919. <member name="M:MailKit.Net.Smtp.SmtpClient.OnRecipientAccepted(MimeKit.MimeMessage,MimeKit.MailboxAddress,MailKit.Net.Smtp.SmtpResponse)">
  22920. <summary>
  22921. Invoked when a recipient is accepted by the SMTP server.
  22922. </summary>
  22923. <remarks>
  22924. The default implementation does nothing.
  22925. </remarks>
  22926. <param name="message">The message being sent.</param>
  22927. <param name="mailbox">The mailbox used in the <c>RCPT TO</c> command.</param>
  22928. <param name="response">The response to the <c>RCPT TO</c> command.</param>
  22929. </member>
  22930. <member name="M:MailKit.Net.Smtp.SmtpClient.OnRecipientNotAccepted(MimeKit.MimeMessage,MimeKit.MailboxAddress,MailKit.Net.Smtp.SmtpResponse)">
  22931. <summary>
  22932. Invoked when a recipient is not accepted by the SMTP server.
  22933. </summary>
  22934. <remarks>
  22935. The default implementation throws an appropriate <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/>.
  22936. </remarks>
  22937. <param name="message">The message being sent.</param>
  22938. <param name="mailbox">The mailbox used in the <c>RCPT TO</c> command.</param>
  22939. <param name="response">The response to the <c>RCPT TO</c> command.</param>
  22940. </member>
  22941. <member name="M:MailKit.Net.Smtp.SmtpClient.GetDeliveryStatusNotifications(MimeKit.MimeMessage,MimeKit.MailboxAddress)">
  22942. <summary>
  22943. Get the types of delivery status notification desired for the specified recipient mailbox.
  22944. </summary>
  22945. <remarks>
  22946. Gets the types of delivery status notification desired for the specified recipient mailbox.
  22947. </remarks>
  22948. <example>
  22949. <code language="c#" source="Examples\SmtpExamples.cs" region="DeliveryStatusNotification"/>
  22950. </example>
  22951. <returns>The desired delivery status notification type.</returns>
  22952. <param name="message">The message being sent.</param>
  22953. <param name="mailbox">The mailbox.</param>
  22954. </member>
  22955. <member name="M:MailKit.Net.Smtp.SmtpClient.Prepare(MimeKit.FormatOptions,MimeKit.MimeMessage,MimeKit.EncodingConstraint,System.Int32)">
  22956. <summary>
  22957. Prepare the message for transport with the specified constraints.
  22958. </summary>
  22959. <remarks>
  22960. <para>Prepares the message for transport with the specified constraints.</para>
  22961. <para>Typically, this involves calling <see cref="M:MimeKit.MimeMessage.Prepare(MimeKit.EncodingConstraint,System.Int32)"/> on
  22962. the message with the provided constraints.</para>
  22963. </remarks>
  22964. <param name="options">The format options.</param>
  22965. <param name="message">The message.</param>
  22966. <param name="constraint">The encoding constraint.</param>
  22967. <param name="maxLineLength">The max line length supported by the server.</param>
  22968. </member>
  22969. <member name="M:MailKit.Net.Smtp.SmtpClient.GetSize(MimeKit.FormatOptions,MimeKit.MimeMessage,System.Threading.CancellationToken)">
  22970. <summary>
  22971. Get the size of the message.
  22972. </summary>
  22973. <remarks>
  22974. <para>Calculates the size of the message in bytes.</para>
  22975. <para>This method is called by <a href="Overload_MailKit_MailTransport_Send.htm">Send</a>
  22976. methods in the following conditions:</para>
  22977. <list type="bullet">
  22978. <item>The SMTP server supports the <c>SIZE=</c> parameter in the <c>MAIL FROM</c> command.</item>
  22979. <item>The <see cref="T:MailKit.ITransferProgress"/> parameter is non-null.</item>
  22980. <item>The SMTP server supports the <c>CHUNKING</c> extension.</item>
  22981. </list>
  22982. </remarks>
  22983. <returns>The size of the message, in bytes.</returns>
  22984. <param name="options">The formatting options.</param>
  22985. <param name="message">The message.</param>
  22986. <param name="cancellationToken">The cancellation token.</param>
  22987. </member>
  22988. <member name="M:MailKit.Net.Smtp.SmtpClient.GetSizeAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,System.Threading.CancellationToken)">
  22989. <summary>
  22990. Asynchronously get the size of the message.
  22991. </summary>
  22992. <remarks>
  22993. <para>Asynchronously calculates the size of the message in bytes.</para>
  22994. <para>This method is called by <a href="Overload_MailKit_MailTransport_SendAsync.htm">SendAsync</a>
  22995. methods in the following conditions:</para>
  22996. <list type="bullet">
  22997. <item>The SMTP server supports the <c>SIZE=</c> parameter in the <c>MAIL FROM</c> command.</item>
  22998. <item>The <see cref="T:MailKit.ITransferProgress"/> parameter is non-null.</item>
  22999. <item>The SMTP server supports the <c>CHUNKING</c> extension.</item>
  23000. </list>
  23001. </remarks>
  23002. <returns>The size of the message, in bytes.</returns>
  23003. <param name="options">The formatting options.</param>
  23004. <param name="message">The message.</param>
  23005. <param name="cancellationToken">The cancellation token.</param>
  23006. </member>
  23007. <member name="M:MailKit.Net.Smtp.SmtpClient.Send(MimeKit.FormatOptions,MimeKit.MimeMessage,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  23008. <summary>
  23009. Send the specified message.
  23010. </summary>
  23011. <remarks>
  23012. <para>Sends the specified message.</para>
  23013. <para>The sender address is determined by checking the following
  23014. message headers (in order of precedence): Resent-Sender,
  23015. Resent-From, Sender, and From.</para>
  23016. <para>If either the Resent-Sender or Resent-From addresses are present,
  23017. the recipients are collected from the Resent-To, Resent-Cc, and
  23018. Resent-Bcc headers, otherwise the To, Cc, and Bcc headers are used.</para>
  23019. </remarks>
  23020. <example>
  23021. <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessageWithOptions"/>
  23022. </example>
  23023. <param name="options">The formatting options.</param>
  23024. <param name="message">The message.</param>
  23025. <param name="cancellationToken">The cancellation token.</param>
  23026. <param name="progress">The progress reporting mechanism.</param>
  23027. <exception cref="T:System.ArgumentNullException">
  23028. <para><paramref name="options"/> is <c>null</c>.</para>
  23029. <para>-or-</para>
  23030. <para><paramref name="message"/> is <c>null</c>.</para>
  23031. </exception>
  23032. <exception cref="T:System.ObjectDisposedException">
  23033. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
  23034. </exception>
  23035. <exception cref="T:MailKit.ServiceNotConnectedException">
  23036. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
  23037. </exception>
  23038. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  23039. Authentication is required before sending a message.
  23040. </exception>
  23041. <exception cref="T:System.InvalidOperationException">
  23042. <para>A sender has not been specified.</para>
  23043. <para>-or-</para>
  23044. <para>No recipients have been specified.</para>
  23045. </exception>
  23046. <exception cref="T:System.NotSupportedException">
  23047. Internationalized formatting was requested but is not supported by the server.
  23048. </exception>
  23049. <exception cref="T:System.OperationCanceledException">
  23050. The operation has been canceled.
  23051. </exception>
  23052. <exception cref="T:System.IO.IOException">
  23053. An I/O error occurred.
  23054. </exception>
  23055. <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
  23056. The SMTP command failed.
  23057. </exception>
  23058. <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
  23059. An SMTP protocol exception occurred.
  23060. </exception>
  23061. </member>
  23062. <member name="M:MailKit.Net.Smtp.SmtpClient.Send(MimeKit.FormatOptions,MimeKit.MimeMessage,MimeKit.MailboxAddress,System.Collections.Generic.IEnumerable{MimeKit.MailboxAddress},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  23063. <summary>
  23064. Send the specified message using the supplied sender and recipients.
  23065. </summary>
  23066. <remarks>
  23067. Sends the message by uploading it to an SMTP server using the supplied sender and recipients.
  23068. </remarks>
  23069. <param name="options">The formatting options.</param>
  23070. <param name="message">The message.</param>
  23071. <param name="sender">The mailbox address to use for sending the message.</param>
  23072. <param name="recipients">The mailbox addresses that should receive the message.</param>
  23073. <param name="cancellationToken">The cancellation token.</param>
  23074. <param name="progress">The progress reporting mechanism.</param>
  23075. <exception cref="T:System.ArgumentNullException">
  23076. <para><paramref name="options"/> is <c>null</c>.</para>
  23077. <para>-or-</para>
  23078. <para><paramref name="message"/> is <c>null</c>.</para>
  23079. <para>-or-</para>
  23080. <para><paramref name="sender"/> is <c>null</c>.</para>
  23081. <para>-or-</para>
  23082. <para><paramref name="recipients"/> is <c>null</c>.</para>
  23083. </exception>
  23084. <exception cref="T:System.ObjectDisposedException">
  23085. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
  23086. </exception>
  23087. <exception cref="T:MailKit.ServiceNotConnectedException">
  23088. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
  23089. </exception>
  23090. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  23091. Authentication is required before sending a message.
  23092. </exception>
  23093. <exception cref="T:System.InvalidOperationException">
  23094. <para>A sender has not been specified.</para>
  23095. <para>-or-</para>
  23096. <para>No recipients have been specified.</para>
  23097. </exception>
  23098. <exception cref="T:System.NotSupportedException">
  23099. Internationalized formatting was requested but is not supported by the server.
  23100. </exception>
  23101. <exception cref="T:System.OperationCanceledException">
  23102. The operation has been canceled.
  23103. </exception>
  23104. <exception cref="T:System.IO.IOException">
  23105. An I/O error occurred.
  23106. </exception>
  23107. <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
  23108. The SMTP command failed.
  23109. </exception>
  23110. <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
  23111. An SMTP protocol exception occurred.
  23112. </exception>
  23113. </member>
  23114. <member name="M:MailKit.Net.Smtp.SmtpClient.Expand(System.String,System.Threading.CancellationToken)">
  23115. <summary>
  23116. Expand a mailing address alias.
  23117. </summary>
  23118. <remarks>
  23119. Expands a mailing address alias.
  23120. </remarks>
  23121. <returns>The expanded list of mailbox addresses.</returns>
  23122. <param name="alias">The mailing address alias.</param>
  23123. <param name="cancellationToken">The cancellation token.</param>
  23124. <exception cref="T:System.ArgumentNullException">
  23125. <paramref name="alias"/> is <c>null</c>.
  23126. </exception>
  23127. <exception cref="T:System.ArgumentException">
  23128. <paramref name="alias"/> is an empty string.
  23129. </exception>
  23130. <exception cref="T:System.ObjectDisposedException">
  23131. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
  23132. </exception>
  23133. <exception cref="T:MailKit.ServiceNotConnectedException">
  23134. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
  23135. </exception>
  23136. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  23137. Authentication is required before verifying the existence of an address.
  23138. </exception>
  23139. <exception cref="T:System.OperationCanceledException">
  23140. The operation has been canceled.
  23141. </exception>
  23142. <exception cref="T:System.IO.IOException">
  23143. An I/O error occurred.
  23144. </exception>
  23145. <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
  23146. The SMTP command failed.
  23147. </exception>
  23148. <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
  23149. An SMTP protocol exception occurred.
  23150. </exception>
  23151. </member>
  23152. <member name="M:MailKit.Net.Smtp.SmtpClient.Verify(System.String,System.Threading.CancellationToken)">
  23153. <summary>
  23154. Verify the existence of a mailbox address.
  23155. </summary>
  23156. <remarks>
  23157. Verifies the existence a mailbox address with the SMTP server, returning the expanded
  23158. mailbox address if it exists.
  23159. </remarks>
  23160. <returns>The expanded mailbox address.</returns>
  23161. <param name="address">The mailbox address.</param>
  23162. <param name="cancellationToken">The cancellation token.</param>
  23163. <exception cref="T:System.ArgumentNullException">
  23164. <paramref name="address"/> is <c>null</c>.
  23165. </exception>
  23166. <exception cref="T:System.ArgumentException">
  23167. <paramref name="address"/> is an empty string.
  23168. </exception>
  23169. <exception cref="T:System.ObjectDisposedException">
  23170. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
  23171. </exception>
  23172. <exception cref="T:MailKit.ServiceNotConnectedException">
  23173. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
  23174. </exception>
  23175. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  23176. Authentication is required before verifying the existence of an address.
  23177. </exception>
  23178. <exception cref="T:System.OperationCanceledException">
  23179. The operation has been canceled.
  23180. </exception>
  23181. <exception cref="T:System.IO.IOException">
  23182. An I/O error occurred.
  23183. </exception>
  23184. <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
  23185. The SMTP command failed.
  23186. </exception>
  23187. <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
  23188. An SMTP protocol exception occurred.
  23189. </exception>
  23190. </member>
  23191. <member name="M:MailKit.Net.Smtp.SmtpClient.Dispose(System.Boolean)">
  23192. <summary>
  23193. Releases the unmanaged resources used by the <see cref="T:MailKit.Net.Smtp.SmtpClient"/> and
  23194. optionally releases the managed resources.
  23195. </summary>
  23196. <remarks>
  23197. Releases the unmanaged resources used by the <see cref="T:MailKit.Net.Smtp.SmtpClient"/> and
  23198. optionally releases the managed resources.
  23199. </remarks>
  23200. <param name="disposing"><c>true</c> to release both managed and unmanaged resources;
  23201. <c>false</c> to release only the unmanaged resources.</param>
  23202. </member>
  23203. <member name="T:MailKit.Net.Smtp.ISmtpClient">
  23204. <summary>
  23205. An interface for an SMTP client.
  23206. </summary>
  23207. <remarks>
  23208. Implemented by <see cref="T:MailKit.Net.Smtp.SmtpClient"/>.
  23209. </remarks>
  23210. </member>
  23211. <member name="P:MailKit.Net.Smtp.ISmtpClient.Capabilities">
  23212. <summary>
  23213. Get the capabilities supported by the SMTP server.
  23214. </summary>
  23215. <remarks>
  23216. The capabilities will not be known until a successful connection has been made
  23217. and may change once the client is authenticated.
  23218. </remarks>
  23219. <example>
  23220. <code language="c#" source="Examples\SmtpExamples.cs" region="Capabilities"/>
  23221. </example>
  23222. <value>The capabilities.</value>
  23223. <exception cref="T:System.ArgumentException">
  23224. Capabilities cannot be enabled, they may only be disabled.
  23225. </exception>
  23226. </member>
  23227. <member name="P:MailKit.Net.Smtp.ISmtpClient.LocalDomain">
  23228. <summary>
  23229. Get or set the local domain.
  23230. </summary>
  23231. <remarks>
  23232. The local domain is used in the HELO or EHLO commands sent to
  23233. the SMTP server. If left unset, the local IP address will be
  23234. used instead.
  23235. </remarks>
  23236. <value>The local domain.</value>
  23237. </member>
  23238. <member name="P:MailKit.Net.Smtp.ISmtpClient.MaxSize">
  23239. <summary>
  23240. Get the maximum message size supported by the server.
  23241. </summary>
  23242. <remarks>
  23243. <para>The maximum message size will not be known until a successful connection has
  23244. been made and may change once the client is authenticated.</para>
  23245. <note type="note">This value is only relevant if the <see cref="P:MailKit.Net.Smtp.ISmtpClient.Capabilities"/> includes
  23246. the <see cref="F:MailKit.Net.Smtp.SmtpCapabilities.Size"/> flag.</note>
  23247. </remarks>
  23248. <example>
  23249. <code language="c#" source="Examples\SmtpExamples.cs" region="Capabilities"/>
  23250. </example>
  23251. <value>The maximum message size supported by the server.</value>
  23252. </member>
  23253. <member name="P:MailKit.Net.Smtp.ISmtpClient.DeliveryStatusNotificationType">
  23254. <summary>
  23255. Get or set how much of the message to include in any failed delivery status notifications.
  23256. </summary>
  23257. <remarks>
  23258. Gets or sets how much of the message to include in any failed delivery status notifications.
  23259. </remarks>
  23260. <value>A value indicating how much of the message to include in a failure delivery status notification.</value>
  23261. </member>
  23262. <member name="M:MailKit.Net.Smtp.ISmtpClient.Expand(System.String,System.Threading.CancellationToken)">
  23263. <summary>
  23264. Expand a mailing address alias.
  23265. </summary>
  23266. <remarks>
  23267. Expands a mailing address alias.
  23268. </remarks>
  23269. <returns>The expanded list of mailbox addresses.</returns>
  23270. <param name="alias">The mailing address alias.</param>
  23271. <param name="cancellationToken">The cancellation token.</param>
  23272. <exception cref="T:System.ArgumentNullException">
  23273. <paramref name="alias"/> is <c>null</c>.
  23274. </exception>
  23275. <exception cref="T:System.ArgumentException">
  23276. <paramref name="alias"/> is an empty string.
  23277. </exception>
  23278. <exception cref="T:System.ObjectDisposedException">
  23279. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
  23280. </exception>
  23281. <exception cref="T:MailKit.ServiceNotConnectedException">
  23282. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
  23283. </exception>
  23284. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  23285. Authentication is required before verifying the existence of an address.
  23286. </exception>
  23287. <exception cref="T:System.OperationCanceledException">
  23288. The operation has been canceled.
  23289. </exception>
  23290. <exception cref="T:System.IO.IOException">
  23291. An I/O error occurred.
  23292. </exception>
  23293. <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
  23294. The SMTP command failed.
  23295. </exception>
  23296. <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
  23297. An SMTP protocol exception occurred.
  23298. </exception>
  23299. </member>
  23300. <member name="M:MailKit.Net.Smtp.ISmtpClient.ExpandAsync(System.String,System.Threading.CancellationToken)">
  23301. <summary>
  23302. Asynchronously expand a mailing address alias.
  23303. </summary>
  23304. <remarks>
  23305. Expands a mailing address alias.
  23306. </remarks>
  23307. <returns>The expanded list of mailbox addresses.</returns>
  23308. <param name="alias">The mailing address alias.</param>
  23309. <param name="cancellationToken">The cancellation token.</param>
  23310. <exception cref="T:System.ArgumentNullException">
  23311. <paramref name="alias"/> is <c>null</c>.
  23312. </exception>
  23313. <exception cref="T:System.ArgumentException">
  23314. <paramref name="alias"/> is an empty string.
  23315. </exception>
  23316. <exception cref="T:System.ObjectDisposedException">
  23317. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
  23318. </exception>
  23319. <exception cref="T:MailKit.ServiceNotConnectedException">
  23320. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
  23321. </exception>
  23322. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  23323. Authentication is required before verifying the existence of an address.
  23324. </exception>
  23325. <exception cref="T:System.OperationCanceledException">
  23326. The operation has been canceled.
  23327. </exception>
  23328. <exception cref="T:System.IO.IOException">
  23329. An I/O error occurred.
  23330. </exception>
  23331. <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
  23332. The SMTP command failed.
  23333. </exception>
  23334. <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
  23335. An SMTP protocol exception occurred.
  23336. </exception>
  23337. </member>
  23338. <member name="M:MailKit.Net.Smtp.ISmtpClient.Verify(System.String,System.Threading.CancellationToken)">
  23339. <summary>
  23340. Verify the existence of a mailbox address.
  23341. </summary>
  23342. <remarks>
  23343. Verifies the existence a mailbox address with the SMTP server, returning the expanded
  23344. mailbox address if it exists.
  23345. </remarks>
  23346. <returns>The expanded mailbox address.</returns>
  23347. <param name="address">The mailbox address.</param>
  23348. <param name="cancellationToken">The cancellation token.</param>
  23349. <exception cref="T:System.ArgumentNullException">
  23350. <paramref name="address"/> is <c>null</c>.
  23351. </exception>
  23352. <exception cref="T:System.ArgumentException">
  23353. <paramref name="address"/> is an empty string.
  23354. </exception>
  23355. <exception cref="T:System.ObjectDisposedException">
  23356. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
  23357. </exception>
  23358. <exception cref="T:MailKit.ServiceNotConnectedException">
  23359. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
  23360. </exception>
  23361. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  23362. Authentication is required before verifying the existence of an address.
  23363. </exception>
  23364. <exception cref="T:System.OperationCanceledException">
  23365. The operation has been canceled.
  23366. </exception>
  23367. <exception cref="T:System.IO.IOException">
  23368. An I/O error occurred.
  23369. </exception>
  23370. <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
  23371. The SMTP command failed.
  23372. </exception>
  23373. <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
  23374. An SMTP protocol exception occurred.
  23375. </exception>
  23376. </member>
  23377. <member name="M:MailKit.Net.Smtp.ISmtpClient.VerifyAsync(System.String,System.Threading.CancellationToken)">
  23378. <summary>
  23379. Asynchronously verify the existence of a mailbox address.
  23380. </summary>
  23381. <remarks>
  23382. Verifies the existence a mailbox address with the SMTP server, returning the expanded
  23383. mailbox address if it exists.
  23384. </remarks>
  23385. <returns>The expanded mailbox address.</returns>
  23386. <param name="address">The mailbox address.</param>
  23387. <param name="cancellationToken">The cancellation token.</param>
  23388. <exception cref="T:System.ArgumentNullException">
  23389. <paramref name="address"/> is <c>null</c>.
  23390. </exception>
  23391. <exception cref="T:System.ArgumentException">
  23392. <paramref name="address"/> is an empty string.
  23393. </exception>
  23394. <exception cref="T:System.ObjectDisposedException">
  23395. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> has been disposed.
  23396. </exception>
  23397. <exception cref="T:MailKit.ServiceNotConnectedException">
  23398. The <see cref="T:MailKit.Net.Smtp.SmtpClient"/> is not connected.
  23399. </exception>
  23400. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  23401. Authentication is required before verifying the existence of an address.
  23402. </exception>
  23403. <exception cref="T:System.OperationCanceledException">
  23404. The operation has been canceled.
  23405. </exception>
  23406. <exception cref="T:System.IO.IOException">
  23407. An I/O error occurred.
  23408. </exception>
  23409. <exception cref="T:MailKit.Net.Smtp.SmtpCommandException">
  23410. The SMTP command failed.
  23411. </exception>
  23412. <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
  23413. An SMTP protocol exception occurred.
  23414. </exception>
  23415. </member>
  23416. <member name="T:MailKit.Net.Smtp.SmtpCapabilities">
  23417. <summary>
  23418. Capabilities supported by an SMTP server.
  23419. </summary>
  23420. <remarks>
  23421. Capabilities are read as part of the response to the EHLO command that
  23422. is issued during the connection phase of the <see cref="T:MailKit.Net.Smtp.SmtpClient"/>.
  23423. </remarks>
  23424. <example>
  23425. <code language="c#" source="Examples\SmtpExamples.cs" region="Capabilities"/>
  23426. </example>
  23427. </member>
  23428. <member name="F:MailKit.Net.Smtp.SmtpCapabilities.None">
  23429. <summary>
  23430. The server does not support any additional extensions.
  23431. </summary>
  23432. </member>
  23433. <member name="F:MailKit.Net.Smtp.SmtpCapabilities.Size">
  23434. <summary>
  23435. The server supports the <a href="https://tools.ietf.org/html/rfc1870">SIZE</a> extension
  23436. and may have a maximum message size limitation (see <see cref="P:MailKit.Net.Smtp.SmtpClient.MaxSize"/>).
  23437. </summary>
  23438. </member>
  23439. <member name="F:MailKit.Net.Smtp.SmtpCapabilities.Dsn">
  23440. <summary>
  23441. The server supports the <a href="https://tools.ietf.org/html/rfc1891">DSN</a> extension,
  23442. allowing clients to specify which (if any) recipients they would like to receive delivery
  23443. notifications for.
  23444. </summary>
  23445. </member>
  23446. <member name="F:MailKit.Net.Smtp.SmtpCapabilities.EnhancedStatusCodes">
  23447. <summary>
  23448. The server supports the <a href="https://tools.ietf.org/html/rfc2034">ENHANCEDSTATUSCODES</a>
  23449. extension.
  23450. </summary>
  23451. </member>
  23452. <member name="F:MailKit.Net.Smtp.SmtpCapabilities.Authentication">
  23453. <summary>
  23454. The server supports the <a href="https://tools.ietf.org/html/rfc2554">AUTH</a> extension,
  23455. allowing clients to authenticate via supported SASL mechanisms.
  23456. </summary>
  23457. </member>
  23458. <member name="F:MailKit.Net.Smtp.SmtpCapabilities.EightBitMime">
  23459. <summary>
  23460. The server supports the <a href="https://tools.ietf.org/html/rfc2821">8BITMIME</a> extension,
  23461. allowing clients to send messages using the "8bit" Content-Transfer-Encoding.
  23462. </summary>
  23463. </member>
  23464. <member name="F:MailKit.Net.Smtp.SmtpCapabilities.Pipelining">
  23465. <summary>
  23466. The server supports the <a href="https://tools.ietf.org/html/rfc2920">PIPELINING</a> extension,
  23467. allowing clients to send multiple commands at once in order to reduce round-trip latency.
  23468. </summary>
  23469. </member>
  23470. <member name="F:MailKit.Net.Smtp.SmtpCapabilities.BinaryMime">
  23471. <summary>
  23472. The server supports the <a href="https://tools.ietf.org/html/rfc3030">BINARYMIME</a> extension.
  23473. </summary>
  23474. </member>
  23475. <member name="F:MailKit.Net.Smtp.SmtpCapabilities.Chunking">
  23476. <summary>
  23477. The server supports the <a href="https://tools.ietf.org/html/rfc3030">CHUNKING</a> extension,
  23478. allowing clients to upload messages in chunks.
  23479. </summary>
  23480. </member>
  23481. <member name="F:MailKit.Net.Smtp.SmtpCapabilities.StartTLS">
  23482. <summary>
  23483. The server supports the <a href="https://tools.ietf.org/html/rfc3207">STARTTLS</a> extension,
  23484. allowing clients to switch to an encrypted SSL/TLS connection after connecting.
  23485. </summary>
  23486. </member>
  23487. <member name="F:MailKit.Net.Smtp.SmtpCapabilities.UTF8">
  23488. <summary>
  23489. The server supports the <a href="https://tools.ietf.org/html/rfc6531">SMTPUTF8</a> extension.
  23490. </summary>
  23491. </member>
  23492. <member name="T:MailKit.Net.Smtp.SmtpErrorCode">
  23493. <summary>
  23494. An enumeration of the possible error codes that may be reported by a <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/>.
  23495. </summary>
  23496. <remarks>
  23497. An enumeration of the possible error codes that may be reported by a <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/>.
  23498. </remarks>
  23499. <example>
  23500. <code language="c#" source="Examples\SmtpExamples.cs" region="ExceptionHandling"/>
  23501. </example>
  23502. </member>
  23503. <member name="F:MailKit.Net.Smtp.SmtpErrorCode.MessageNotAccepted">
  23504. <summary>
  23505. The message was not accepted for delivery. This may happen if
  23506. the server runs out of available disk space.
  23507. </summary>
  23508. </member>
  23509. <member name="F:MailKit.Net.Smtp.SmtpErrorCode.SenderNotAccepted">
  23510. <summary>
  23511. The sender's mailbox address was not accepted. Check the
  23512. <see cref="P:MailKit.Net.Smtp.SmtpCommandException.Mailbox"/> property for the
  23513. mailbox used as the sender's mailbox address.
  23514. </summary>
  23515. </member>
  23516. <member name="F:MailKit.Net.Smtp.SmtpErrorCode.RecipientNotAccepted">
  23517. <summary>
  23518. A recipient's mailbox address was not accepted. Check the
  23519. <see cref="P:MailKit.Net.Smtp.SmtpCommandException.Mailbox"/> property for the
  23520. particular recipient mailbox that was not acccepted.
  23521. </summary>
  23522. </member>
  23523. <member name="F:MailKit.Net.Smtp.SmtpErrorCode.UnexpectedStatusCode">
  23524. <summary>
  23525. An unexpected status code was returned by the server.
  23526. For more details, the <see cref="P:System.Exception.Message"/>
  23527. property may provide some additional hints.
  23528. </summary>
  23529. </member>
  23530. <member name="T:MailKit.Net.Smtp.SmtpCommandException">
  23531. <summary>
  23532. An SMTP protocol exception.
  23533. </summary>
  23534. <remarks>
  23535. The exception that is thrown when an SMTP command fails. Unlike a <see cref="T:MailKit.Net.Smtp.SmtpProtocolException"/>,
  23536. a <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/> does not require the <see cref="T:MailKit.Net.Smtp.SmtpClient"/> to be reconnected.
  23537. </remarks>
  23538. <example>
  23539. <code language="c#" source="Examples\SmtpExamples.cs" region="ExceptionHandling"/>
  23540. </example>
  23541. </member>
  23542. <member name="M:MailKit.Net.Smtp.SmtpCommandException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  23543. <summary>
  23544. Initializes a new instance of the <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/> class.
  23545. </summary>
  23546. <remarks>
  23547. Creates a new <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/> from the serialized data.
  23548. </remarks>
  23549. <param name="info">The serialization info.</param>
  23550. <param name="context">The streaming context.</param>
  23551. <exception cref="T:System.ArgumentNullException">
  23552. <paramref name="info"/> is <c>null</c>.
  23553. </exception>
  23554. </member>
  23555. <member name="M:MailKit.Net.Smtp.SmtpCommandException.#ctor(MailKit.Net.Smtp.SmtpErrorCode,MailKit.Net.Smtp.SmtpStatusCode,MimeKit.MailboxAddress,System.String,System.Exception)">
  23556. <summary>
  23557. Initializes a new instance of the <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/> class.
  23558. </summary>
  23559. <remarks>
  23560. Creates a new <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/>.
  23561. </remarks>
  23562. <param name="code">The error code.</param>
  23563. <param name="status">The status code.</param>
  23564. <param name="mailbox">The rejected mailbox.</param>
  23565. <param name="message">The error message.</param>
  23566. <param name="innerException">The inner exception.</param>
  23567. </member>
  23568. <member name="M:MailKit.Net.Smtp.SmtpCommandException.#ctor(MailKit.Net.Smtp.SmtpErrorCode,MailKit.Net.Smtp.SmtpStatusCode,MimeKit.MailboxAddress,System.String)">
  23569. <summary>
  23570. Initializes a new instance of the <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/> class.
  23571. </summary>
  23572. <remarks>
  23573. Creates a new <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/>.
  23574. </remarks>
  23575. <param name="code">The error code.</param>
  23576. <param name="status">The status code.</param>
  23577. <param name="mailbox">The rejected mailbox.</param>
  23578. <param name="message">The error message.</param>
  23579. </member>
  23580. <member name="M:MailKit.Net.Smtp.SmtpCommandException.#ctor(MailKit.Net.Smtp.SmtpErrorCode,MailKit.Net.Smtp.SmtpStatusCode,System.String,System.Exception)">
  23581. <summary>
  23582. Initializes a new instance of the <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/> class.
  23583. </summary>
  23584. <remarks>
  23585. Creates a new <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/>.
  23586. </remarks>
  23587. <param name="code">The error code.</param>
  23588. <param name="status">The status code.</param>>
  23589. <param name="message">The error message.</param>
  23590. <param name="innerException">The inner exception.</param>
  23591. </member>
  23592. <member name="M:MailKit.Net.Smtp.SmtpCommandException.#ctor(MailKit.Net.Smtp.SmtpErrorCode,MailKit.Net.Smtp.SmtpStatusCode,System.String)">
  23593. <summary>
  23594. Initializes a new instance of the <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/> class.
  23595. </summary>
  23596. <remarks>
  23597. Creates a new <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/>.
  23598. </remarks>
  23599. <param name="code">The error code.</param>
  23600. <param name="status">The status code.</param>>
  23601. <param name="message">The error message.</param>
  23602. </member>
  23603. <member name="M:MailKit.Net.Smtp.SmtpCommandException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  23604. <summary>
  23605. When overridden in a derived class, sets the <see cref="T:System.Runtime.Serialization.SerializationInfo"/>
  23606. with information about the exception.
  23607. </summary>
  23608. <remarks>
  23609. Serializes the state of the <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/>.
  23610. </remarks>
  23611. <param name="info">The serialization info.</param>
  23612. <param name="context">The streaming context.</param>
  23613. <exception cref="T:System.ArgumentNullException">
  23614. <paramref name="info"/> is <c>null</c>.
  23615. </exception>
  23616. </member>
  23617. <member name="P:MailKit.Net.Smtp.SmtpCommandException.ErrorCode">
  23618. <summary>
  23619. Gets the error code which may provide additional information.
  23620. </summary>
  23621. <remarks>
  23622. The error code can be used to programatically deal with the
  23623. exception without necessarily needing to display the raw
  23624. exception message to the user.
  23625. </remarks>
  23626. <example>
  23627. <code language="c#" source="Examples\SmtpExamples.cs" region="ExceptionHandling"/>
  23628. </example>
  23629. <value>The status code.</value>
  23630. </member>
  23631. <member name="P:MailKit.Net.Smtp.SmtpCommandException.Mailbox">
  23632. <summary>
  23633. Gets the mailbox that the error occurred on.
  23634. </summary>
  23635. <remarks>
  23636. This property will only be available when the <see cref="P:MailKit.Net.Smtp.SmtpCommandException.ErrorCode"/>
  23637. value is either <see cref="F:MailKit.Net.Smtp.SmtpErrorCode.SenderNotAccepted"/> or
  23638. <see cref="F:MailKit.Net.Smtp.SmtpErrorCode.RecipientNotAccepted"/> and may be used
  23639. to help the user decide how to proceed.
  23640. </remarks>
  23641. <example>
  23642. <code language="c#" source="Examples\SmtpExamples.cs" region="ExceptionHandling"/>
  23643. </example>
  23644. <value>The mailbox.</value>
  23645. </member>
  23646. <member name="P:MailKit.Net.Smtp.SmtpCommandException.StatusCode">
  23647. <summary>
  23648. Gets the status code returned by the SMTP server.
  23649. </summary>
  23650. <remarks>
  23651. The raw SMTP status code that resulted in the <see cref="T:MailKit.Net.Smtp.SmtpCommandException"/>
  23652. being thrown.
  23653. </remarks>
  23654. <example>
  23655. <code language="c#" source="Examples\SmtpExamples.cs" region="ExceptionHandling"/>
  23656. </example>
  23657. <value>The status code.</value>
  23658. </member>
  23659. <member name="T:MailKit.Net.Smtp.SmtpDataFilter">
  23660. <summary>
  23661. An SMTP filter designed to format a message stream for the DATA command.
  23662. </summary>
  23663. <remarks>
  23664. A special stream filter that escapes lines beginning with a '.' as needed when
  23665. sending a message via the SMTP protocol or when saving a message to an IIS
  23666. message pickup directory.
  23667. </remarks>
  23668. <example>
  23669. <code language="c#" source="Examples\SmtpExamples.cs" region="SaveToPickupDirectory" />
  23670. </example>
  23671. </member>
  23672. <member name="M:MailKit.Net.Smtp.SmtpDataFilter.#ctor">
  23673. <summary>
  23674. Initializes a new instance of the <see cref="T:MailKit.Net.Smtp.SmtpDataFilter"/> class.
  23675. </summary>
  23676. <remarks>
  23677. Creates a new <see cref="T:MailKit.Net.Smtp.SmtpDataFilter"/>.
  23678. </remarks>
  23679. <example>
  23680. <code language="c#" source="Examples\SmtpExamples.cs" region="SaveToPickupDirectory" />
  23681. </example>
  23682. </member>
  23683. <member name="M:MailKit.Net.Smtp.SmtpDataFilter.Filter(System.Byte[],System.Int32,System.Int32,System.Int32@,System.Int32@,System.Boolean)">
  23684. <summary>
  23685. Filter the specified input.
  23686. </summary>
  23687. <remarks>
  23688. Filters the specified input buffer starting at the given index,
  23689. spanning across the specified number of bytes.
  23690. </remarks>
  23691. <returns>The filtered output.</returns>
  23692. <param name="input">The input buffer.</param>
  23693. <param name="startIndex">The starting index of the input buffer.</param>
  23694. <param name="length">The length of the input buffer, starting at <paramref name="startIndex"/>.</param>
  23695. <param name="outputIndex">The output index.</param>
  23696. <param name="outputLength">The output length.</param>
  23697. <param name="flush">If set to <c>true</c>, all internally buffered data should be flushed to the output buffer.</param>
  23698. </member>
  23699. <member name="M:MailKit.Net.Smtp.SmtpDataFilter.Reset">
  23700. <summary>
  23701. Reset the filter.
  23702. </summary>
  23703. <remarks>
  23704. Resets the filter.
  23705. </remarks>
  23706. </member>
  23707. <member name="T:MailKit.Net.Smtp.SmtpProtocolException">
  23708. <summary>
  23709. An SMTP protocol exception.
  23710. </summary>
  23711. <remarks>
  23712. The exception that is thrown when there is an error communicating with an SMTP server. An
  23713. <see cref="T:MailKit.Net.Smtp.SmtpProtocolException"/> is typically fatal and requires the <see cref="T:MailKit.Net.Smtp.SmtpClient"/>
  23714. to be reconnected.
  23715. </remarks>
  23716. <example>
  23717. <code language="c#" source="Examples\SmtpExamples.cs" region="ExceptionHandling"/>
  23718. </example>
  23719. </member>
  23720. <member name="M:MailKit.Net.Smtp.SmtpProtocolException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  23721. <summary>
  23722. Initializes a new instance of the <see cref="T:MailKit.Net.Smtp.SmtpProtocolException"/> class.
  23723. </summary>
  23724. <remarks>
  23725. Creates a new <see cref="T:MailKit.Net.Smtp.SmtpProtocolException"/> from the serialized data.
  23726. </remarks>
  23727. <param name="info">The serialization info.</param>
  23728. <param name="context">The streaming context.</param>
  23729. <exception cref="T:System.ArgumentNullException">
  23730. <paramref name="info"/> is <c>null</c>.
  23731. </exception>
  23732. </member>
  23733. <member name="M:MailKit.Net.Smtp.SmtpProtocolException.#ctor(System.String,System.Exception)">
  23734. <summary>
  23735. Initializes a new instance of the <see cref="T:MailKit.Net.Smtp.SmtpProtocolException"/> class.
  23736. </summary>
  23737. <remarks>
  23738. Creates a new <see cref="T:MailKit.Net.Smtp.SmtpProtocolException"/>.
  23739. </remarks>
  23740. <param name="message">The error message.</param>
  23741. <param name="innerException">The inner exception.</param>
  23742. </member>
  23743. <member name="M:MailKit.Net.Smtp.SmtpProtocolException.#ctor(System.String)">
  23744. <summary>
  23745. Initializes a new instance of the <see cref="T:MailKit.Net.Smtp.SmtpProtocolException"/> class.
  23746. </summary>
  23747. <remarks>
  23748. Creates a new <see cref="T:MailKit.Net.Smtp.SmtpProtocolException"/>.
  23749. </remarks>
  23750. <param name="message">The error message.</param>
  23751. </member>
  23752. <member name="M:MailKit.Net.Smtp.SmtpProtocolException.#ctor">
  23753. <summary>
  23754. Initializes a new instance of the <see cref="T:MailKit.Net.Smtp.SmtpProtocolException"/> class.
  23755. </summary>
  23756. <remarks>
  23757. Creates a new <see cref="T:MailKit.Net.Smtp.SmtpProtocolException"/>.
  23758. </remarks>
  23759. </member>
  23760. <member name="T:MailKit.Net.Smtp.SmtpResponse">
  23761. <summary>
  23762. An SMTP command response.
  23763. </summary>
  23764. <remarks>
  23765. An SMTP command response.
  23766. </remarks>
  23767. </member>
  23768. <member name="P:MailKit.Net.Smtp.SmtpResponse.StatusCode">
  23769. <summary>
  23770. Get the status code.
  23771. </summary>
  23772. <remarks>
  23773. Gets the status code.
  23774. </remarks>
  23775. <value>The status code.</value>
  23776. </member>
  23777. <member name="P:MailKit.Net.Smtp.SmtpResponse.Response">
  23778. <summary>
  23779. Get the response text.
  23780. </summary>
  23781. <remarks>
  23782. Gets the response text.
  23783. </remarks>
  23784. <value>The response text.</value>
  23785. </member>
  23786. <member name="M:MailKit.Net.Smtp.SmtpResponse.#ctor(MailKit.Net.Smtp.SmtpStatusCode,System.String)">
  23787. <summary>
  23788. Initializes a new instance of the <see cref="T:MailKit.Net.Smtp.SmtpResponse"/> class.
  23789. </summary>
  23790. <remarks>
  23791. Creates a new <see cref="T:MailKit.Net.Smtp.SmtpResponse"/>.
  23792. </remarks>
  23793. <param name="code">The status code.</param>
  23794. <param name="response">The response text.</param>
  23795. </member>
  23796. <member name="T:MailKit.Net.Smtp.SmtpStatusCode">
  23797. <summary>
  23798. An enumeration of possible SMTP status codes.
  23799. </summary>
  23800. <remarks>
  23801. An enumeration of possible SMTP status codes.
  23802. </remarks>
  23803. </member>
  23804. <member name="F:MailKit.Net.Smtp.SmtpStatusCode.SystemStatus">
  23805. <summary>
  23806. The "system status" status code.
  23807. </summary>
  23808. </member>
  23809. <member name="F:MailKit.Net.Smtp.SmtpStatusCode.HelpMessage">
  23810. <summary>
  23811. The "help" status code.
  23812. </summary>
  23813. </member>
  23814. <member name="F:MailKit.Net.Smtp.SmtpStatusCode.ServiceReady">
  23815. <summary>
  23816. The "service ready" status code.
  23817. </summary>
  23818. </member>
  23819. <member name="F:MailKit.Net.Smtp.SmtpStatusCode.ServiceClosingTransmissionChannel">
  23820. <summary>
  23821. The "service closing transmission channel" status code.
  23822. </summary>
  23823. </member>
  23824. <member name="F:MailKit.Net.Smtp.SmtpStatusCode.AuthenticationSuccessful">
  23825. <summary>
  23826. The "authentication successful" status code.
  23827. </summary>
  23828. </member>
  23829. <member name="F:MailKit.Net.Smtp.SmtpStatusCode.Ok">
  23830. <summary>
  23831. The general purpose "OK" status code.
  23832. </summary>
  23833. </member>
  23834. <member name="F:MailKit.Net.Smtp.SmtpStatusCode.UserNotLocalWillForward">
  23835. <summary>
  23836. The "User not local; will forward" status code.
  23837. </summary>
  23838. </member>
  23839. <member name="F:MailKit.Net.Smtp.SmtpStatusCode.CannotVerifyUserWillAttemptDelivery">
  23840. <summary>
  23841. The "cannot verify user; will attempt delivery" status code.
  23842. </summary>
  23843. </member>
  23844. <member name="F:MailKit.Net.Smtp.SmtpStatusCode.AuthenticationChallenge">
  23845. <summary>
  23846. The "authentication challenge" status code.
  23847. </summary>
  23848. </member>
  23849. <member name="F:MailKit.Net.Smtp.SmtpStatusCode.StartMailInput">
  23850. <summary>
  23851. The "start mail input" status code.
  23852. </summary>
  23853. </member>
  23854. <member name="F:MailKit.Net.Smtp.SmtpStatusCode.ServiceNotAvailable">
  23855. <summary>
  23856. The "service not available" status code.
  23857. </summary>
  23858. </member>
  23859. <member name="F:MailKit.Net.Smtp.SmtpStatusCode.PasswordTransitionNeeded">
  23860. <summary>
  23861. The "password transition needed" status code.
  23862. </summary>
  23863. </member>
  23864. <member name="F:MailKit.Net.Smtp.SmtpStatusCode.MailboxBusy">
  23865. <summary>
  23866. The "mailbox busy" status code.
  23867. </summary>
  23868. </member>
  23869. <member name="F:MailKit.Net.Smtp.SmtpStatusCode.ErrorInProcessing">
  23870. <summary>
  23871. The "error in processing" status code.
  23872. </summary>
  23873. </member>
  23874. <member name="F:MailKit.Net.Smtp.SmtpStatusCode.InsufficientStorage">
  23875. <summary>
  23876. The "insufficient storage" status code.
  23877. </summary>
  23878. </member>
  23879. <member name="F:MailKit.Net.Smtp.SmtpStatusCode.TemporaryAuthenticationFailure">
  23880. <summary>
  23881. The "temporary authentication failure" status code.
  23882. </summary>
  23883. </member>
  23884. <member name="F:MailKit.Net.Smtp.SmtpStatusCode.CommandUnrecognized">
  23885. <summary>
  23886. The "command unrecognized" status code.
  23887. </summary>
  23888. </member>
  23889. <member name="F:MailKit.Net.Smtp.SmtpStatusCode.SyntaxError">
  23890. <summary>
  23891. The "syntax error" status code.
  23892. </summary>
  23893. </member>
  23894. <member name="F:MailKit.Net.Smtp.SmtpStatusCode.CommandNotImplemented">
  23895. <summary>
  23896. The "command not implemented" status code.
  23897. </summary>
  23898. </member>
  23899. <member name="F:MailKit.Net.Smtp.SmtpStatusCode.BadCommandSequence">
  23900. <summary>
  23901. The "bad command sequence" status code.
  23902. </summary>
  23903. </member>
  23904. <member name="F:MailKit.Net.Smtp.SmtpStatusCode.CommandParameterNotImplemented">
  23905. <summary>
  23906. The "command parameter not implemented" status code.
  23907. </summary>
  23908. </member>
  23909. <member name="F:MailKit.Net.Smtp.SmtpStatusCode.AuthenticationRequired">
  23910. <summary>
  23911. The "authentication required" status code.
  23912. </summary>
  23913. </member>
  23914. <member name="F:MailKit.Net.Smtp.SmtpStatusCode.AuthenticationMechanismTooWeak">
  23915. <summary>
  23916. The "authentication mechanism too weak" status code.
  23917. </summary>
  23918. </member>
  23919. <member name="F:MailKit.Net.Smtp.SmtpStatusCode.AuthenticationInvalidCredentials">
  23920. <summary>
  23921. The "authentication invalid credentials" status code.
  23922. </summary>
  23923. </member>
  23924. <member name="F:MailKit.Net.Smtp.SmtpStatusCode.EncryptionRequiredForAuthenticationMechanism">
  23925. <summary>
  23926. The "encryption required for authentication mechanism" status code.
  23927. </summary>
  23928. </member>
  23929. <member name="F:MailKit.Net.Smtp.SmtpStatusCode.MailboxUnavailable">
  23930. <summary>
  23931. The "mailbox unavailable" status code.
  23932. </summary>
  23933. </member>
  23934. <member name="F:MailKit.Net.Smtp.SmtpStatusCode.UserNotLocalTryAlternatePath">
  23935. <summary>
  23936. The "user not local try alternate path" status code.
  23937. </summary>
  23938. </member>
  23939. <member name="F:MailKit.Net.Smtp.SmtpStatusCode.ExceededStorageAllocation">
  23940. <summary>
  23941. The "exceeded storage allocation" status code.
  23942. </summary>
  23943. </member>
  23944. <member name="F:MailKit.Net.Smtp.SmtpStatusCode.MailboxNameNotAllowed">
  23945. <summary>
  23946. The "mailbox name not allowed" status code.
  23947. </summary>
  23948. </member>
  23949. <member name="F:MailKit.Net.Smtp.SmtpStatusCode.TransactionFailed">
  23950. <summary>
  23951. The "transaction failed" status code.
  23952. </summary>
  23953. </member>
  23954. <member name="F:MailKit.Net.Smtp.SmtpStatusCode.MailFromOrRcptToParametersNotRecognizedOrNotImplemented">
  23955. <summary>
  23956. The "mail from/rcpt to parameters not recognized or not implemented" status code.
  23957. </summary>
  23958. </member>
  23959. <member name="T:MailKit.Net.Smtp.SmtpStream">
  23960. <summary>
  23961. A stream for communicating with an SMTP server.
  23962. </summary>
  23963. <remarks>
  23964. A stream capable of reading SMTP server responses.
  23965. </remarks>
  23966. </member>
  23967. <member name="M:MailKit.Net.Smtp.SmtpStream.#ctor(System.IO.Stream,MailKit.IProtocolLogger)">
  23968. <summary>
  23969. Initializes a new instance of the <see cref="T:MailKit.Net.Smtp.SmtpStream"/> class.
  23970. </summary>
  23971. <remarks>
  23972. Creates a new <see cref="T:MailKit.Net.Smtp.SmtpStream"/>.
  23973. </remarks>
  23974. <param name="source">The underlying network stream.</param>
  23975. <param name="protocolLogger">The protocol logger.</param>
  23976. </member>
  23977. <member name="P:MailKit.Net.Smtp.SmtpStream.Stream">
  23978. <summary>
  23979. Get or sets the underlying network stream.
  23980. </summary>
  23981. <remarks>
  23982. Gets or sets the underlying network stream.
  23983. </remarks>
  23984. <value>The underlying network stream.</value>
  23985. </member>
  23986. <member name="P:MailKit.Net.Smtp.SmtpStream.IsConnected">
  23987. <summary>
  23988. Get whether or not the stream is connected.
  23989. </summary>
  23990. <remarks>
  23991. Gets whether or not the stream is connected.
  23992. </remarks>
  23993. <value><c>true</c> if the stream is connected; otherwise, <c>false</c>.</value>
  23994. </member>
  23995. <member name="P:MailKit.Net.Smtp.SmtpStream.CanRead">
  23996. <summary>
  23997. Get whether the stream supports reading.
  23998. </summary>
  23999. <remarks>
  24000. Gets whether the stream supports reading.
  24001. </remarks>
  24002. <value><c>true</c> if the stream supports reading; otherwise, <c>false</c>.</value>
  24003. </member>
  24004. <member name="P:MailKit.Net.Smtp.SmtpStream.CanWrite">
  24005. <summary>
  24006. Get whether the stream supports writing.
  24007. </summary>
  24008. <remarks>
  24009. Gets whether the stream supports writing.
  24010. </remarks>
  24011. <value><c>true</c> if the stream supports writing; otherwise, <c>false</c>.</value>
  24012. </member>
  24013. <member name="P:MailKit.Net.Smtp.SmtpStream.CanSeek">
  24014. <summary>
  24015. Get whether the stream supports seeking.
  24016. </summary>
  24017. <remarks>
  24018. Gets whether the stream supports seeking.
  24019. </remarks>
  24020. <value><c>true</c> if the stream supports seeking; otherwise, <c>false</c>.</value>
  24021. </member>
  24022. <member name="P:MailKit.Net.Smtp.SmtpStream.CanTimeout">
  24023. <summary>
  24024. Get whether the stream supports I/O timeouts.
  24025. </summary>
  24026. <remarks>
  24027. Gets whether the stream supports I/O timeouts.
  24028. </remarks>
  24029. <value><c>true</c> if the stream supports I/O timeouts; otherwise, <c>false</c>.</value>
  24030. </member>
  24031. <member name="P:MailKit.Net.Smtp.SmtpStream.ReadTimeout">
  24032. <summary>
  24033. Get or set a value, in milliseconds, that determines how long the stream will attempt to read before timing out.
  24034. </summary>
  24035. <remarks>
  24036. Gets or sets a value, in milliseconds, that determines how long the stream will attempt to read before timing out.
  24037. </remarks>
  24038. <returns>A value, in milliseconds, that determines how long the stream will attempt to read before timing out.</returns>
  24039. <value>The read timeout.</value>
  24040. </member>
  24041. <member name="P:MailKit.Net.Smtp.SmtpStream.WriteTimeout">
  24042. <summary>
  24043. Get or set a value, in milliseconds, that determines how long the stream will attempt to write before timing out.
  24044. </summary>
  24045. <remarks>
  24046. Gets or sets a value, in milliseconds, that determines how long the stream will attempt to write before timing out.
  24047. </remarks>
  24048. <returns>A value, in milliseconds, that determines how long the stream will attempt to write before timing out.</returns>
  24049. <value>The write timeout.</value>
  24050. </member>
  24051. <member name="P:MailKit.Net.Smtp.SmtpStream.Position">
  24052. <summary>
  24053. Get or set the position within the current stream.
  24054. </summary>
  24055. <remarks>
  24056. Gets or sets the position within the current stream.
  24057. </remarks>
  24058. <returns>The current position within the stream.</returns>
  24059. <value>The position of the stream.</value>
  24060. <exception cref="T:System.IO.IOException">
  24061. An I/O error occurred.
  24062. </exception>
  24063. <exception cref="T:System.NotSupportedException">
  24064. The stream does not support seeking.
  24065. </exception>
  24066. <exception cref="T:System.ObjectDisposedException">
  24067. The stream has been disposed.
  24068. </exception>
  24069. </member>
  24070. <member name="P:MailKit.Net.Smtp.SmtpStream.Length">
  24071. <summary>
  24072. Get the length of the stream, in bytes.
  24073. </summary>
  24074. <remarks>
  24075. Gets the length of the stream, in bytes.
  24076. </remarks>
  24077. <returns>A long value representing the length of the stream in bytes.</returns>
  24078. <value>The length of the stream.</value>
  24079. <exception cref="T:System.NotSupportedException">
  24080. The stream does not support seeking.
  24081. </exception>
  24082. <exception cref="T:System.ObjectDisposedException">
  24083. The stream has been disposed.
  24084. </exception>
  24085. </member>
  24086. <member name="M:MailKit.Net.Smtp.SmtpStream.Read(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  24087. <summary>
  24088. Reads a sequence of bytes from the stream and advances the position
  24089. within the stream by the number of bytes read.
  24090. </summary>
  24091. <remarks>
  24092. Reads a sequence of bytes from the stream and advances the position
  24093. within the stream by the number of bytes read.
  24094. </remarks>
  24095. <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many
  24096. bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
  24097. <param name="buffer">The buffer.</param>
  24098. <param name="offset">The buffer offset.</param>
  24099. <param name="count">The number of bytes to read.</param>
  24100. <param name="cancellationToken">The cancellation token.</param>
  24101. <exception cref="T:System.ArgumentNullException">
  24102. <paramref name="buffer"/> is <c>null</c>.
  24103. </exception>
  24104. <exception cref="T:System.ArgumentOutOfRangeException">
  24105. <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
  24106. <para>-or-</para>
  24107. <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
  24108. at the specified <paramref name="offset"/>.</para>
  24109. </exception>
  24110. <exception cref="T:System.ObjectDisposedException">
  24111. The stream has been disposed.
  24112. </exception>
  24113. <exception cref="T:System.OperationCanceledException">
  24114. The operation was canceled via the cancellation token.
  24115. </exception>
  24116. <exception cref="T:System.IO.IOException">
  24117. An I/O error occurred.
  24118. </exception>
  24119. </member>
  24120. <member name="M:MailKit.Net.Smtp.SmtpStream.Read(System.Byte[],System.Int32,System.Int32)">
  24121. <summary>
  24122. Reads a sequence of bytes from the stream and advances the position
  24123. within the stream by the number of bytes read.
  24124. </summary>
  24125. <remarks>
  24126. Reads a sequence of bytes from the stream and advances the position
  24127. within the stream by the number of bytes read.
  24128. </remarks>
  24129. <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many
  24130. bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
  24131. <param name="buffer">The buffer.</param>
  24132. <param name="offset">The buffer offset.</param>
  24133. <param name="count">The number of bytes to read.</param>
  24134. <exception cref="T:System.ArgumentNullException">
  24135. <paramref name="buffer"/> is <c>null</c>.
  24136. </exception>
  24137. <exception cref="T:System.ArgumentOutOfRangeException">
  24138. <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
  24139. <para>-or-</para>
  24140. <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
  24141. at the specified <paramref name="offset"/>.</para>
  24142. </exception>
  24143. <exception cref="T:System.ObjectDisposedException">
  24144. The stream has been disposed.
  24145. </exception>
  24146. <exception cref="T:System.IO.IOException">
  24147. An I/O error occurred.
  24148. </exception>
  24149. </member>
  24150. <member name="M:MailKit.Net.Smtp.SmtpStream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  24151. <summary>
  24152. Asynchronously reads a sequence of bytes from the stream and advances the position
  24153. within the stream by the number of bytes read.
  24154. </summary>
  24155. <remarks>
  24156. Reads a sequence of bytes from the stream and advances the position
  24157. within the stream by the number of bytes read.
  24158. </remarks>
  24159. <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many
  24160. bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
  24161. <param name="buffer">The buffer.</param>
  24162. <param name="offset">The buffer offset.</param>
  24163. <param name="count">The number of bytes to read.</param>
  24164. <param name="cancellationToken">The cancellation token.</param>
  24165. <exception cref="T:System.ArgumentNullException">
  24166. <paramref name="buffer"/> is <c>null</c>.
  24167. </exception>
  24168. <exception cref="T:System.ArgumentOutOfRangeException">
  24169. <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
  24170. <para>-or-</para>
  24171. <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
  24172. at the specified <paramref name="offset"/>.</para>
  24173. </exception>
  24174. <exception cref="T:System.ObjectDisposedException">
  24175. The stream has been disposed.
  24176. </exception>
  24177. <exception cref="T:System.OperationCanceledException">
  24178. The operation was canceled via the cancellation token.
  24179. </exception>
  24180. <exception cref="T:System.IO.IOException">
  24181. An I/O error occurred.
  24182. </exception>
  24183. </member>
  24184. <member name="M:MailKit.Net.Smtp.SmtpStream.ReadResponse(System.Threading.CancellationToken)">
  24185. <summary>
  24186. Read an SMTP server response.
  24187. </summary>
  24188. <remarks>
  24189. Reads a full command response from the SMTP server.
  24190. </remarks>
  24191. <returns>The response.</returns>
  24192. <param name="cancellationToken">The cancellation token.</param>
  24193. <exception cref="T:System.ObjectDisposedException">
  24194. The stream has been disposed.
  24195. </exception>
  24196. <exception cref="T:System.OperationCanceledException">
  24197. The operation was canceled via the cancellation token.
  24198. </exception>
  24199. <exception cref="T:System.IO.IOException">
  24200. An I/O error occurred.
  24201. </exception>
  24202. <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
  24203. An SMTP protocol error occurred.
  24204. </exception>
  24205. </member>
  24206. <member name="M:MailKit.Net.Smtp.SmtpStream.ReadResponseAsync(System.Threading.CancellationToken)">
  24207. <summary>
  24208. Asynchronously read an SMTP server response.
  24209. </summary>
  24210. <remarks>
  24211. Reads a full command response from the SMTP server.
  24212. </remarks>
  24213. <returns>The response.</returns>
  24214. <param name="cancellationToken">The cancellation token.</param>
  24215. <exception cref="T:System.ObjectDisposedException">
  24216. The stream has been disposed.
  24217. </exception>
  24218. <exception cref="T:System.OperationCanceledException">
  24219. The operation was canceled via the cancellation token.
  24220. </exception>
  24221. <exception cref="T:System.IO.IOException">
  24222. An I/O error occurred.
  24223. </exception>
  24224. <exception cref="T:MailKit.Net.Smtp.SmtpProtocolException">
  24225. An SMTP protocol error occurred.
  24226. </exception>
  24227. </member>
  24228. <member name="M:MailKit.Net.Smtp.SmtpStream.Write(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  24229. <summary>
  24230. Writes a sequence of bytes to the stream and advances the current
  24231. position within this stream by the number of bytes written.
  24232. </summary>
  24233. <remarks>
  24234. Writes a sequence of bytes to the stream and advances the current
  24235. position within this stream by the number of bytes written.
  24236. </remarks>
  24237. <param name='buffer'>The buffer to write.</param>
  24238. <param name='offset'>The offset of the first byte to write.</param>
  24239. <param name='count'>The number of bytes to write.</param>
  24240. <param name="cancellationToken">The cancellation token.</param>
  24241. <exception cref="T:System.ArgumentNullException">
  24242. <paramref name="buffer"/> is <c>null</c>.
  24243. </exception>
  24244. <exception cref="T:System.ArgumentOutOfRangeException">
  24245. <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
  24246. <para>-or-</para>
  24247. <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
  24248. at the specified <paramref name="offset"/>.</para>
  24249. </exception>
  24250. <exception cref="T:System.ObjectDisposedException">
  24251. The stream has been disposed.
  24252. </exception>
  24253. <exception cref="T:System.NotSupportedException">
  24254. The stream does not support writing.
  24255. </exception>
  24256. <exception cref="T:System.OperationCanceledException">
  24257. The operation was canceled via the cancellation token.
  24258. </exception>
  24259. <exception cref="T:System.IO.IOException">
  24260. An I/O error occurred.
  24261. </exception>
  24262. </member>
  24263. <member name="M:MailKit.Net.Smtp.SmtpStream.Write(System.Byte[],System.Int32,System.Int32)">
  24264. <summary>
  24265. Writes a sequence of bytes to the stream and advances the current
  24266. position within this stream by the number of bytes written.
  24267. </summary>
  24268. <remarks>
  24269. Writes a sequence of bytes to the stream and advances the current
  24270. position within this stream by the number of bytes written.
  24271. </remarks>
  24272. <param name='buffer'>The buffer to write.</param>
  24273. <param name='offset'>The offset of the first byte to write.</param>
  24274. <param name='count'>The number of bytes to write.</param>
  24275. <exception cref="T:System.ArgumentNullException">
  24276. <paramref name="buffer"/> is <c>null</c>.
  24277. </exception>
  24278. <exception cref="T:System.ArgumentOutOfRangeException">
  24279. <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
  24280. <para>-or-</para>
  24281. <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
  24282. at the specified <paramref name="offset"/>.</para>
  24283. </exception>
  24284. <exception cref="T:System.ObjectDisposedException">
  24285. The stream has been disposed.
  24286. </exception>
  24287. <exception cref="T:System.NotSupportedException">
  24288. The stream does not support writing.
  24289. </exception>
  24290. <exception cref="T:System.IO.IOException">
  24291. An I/O error occurred.
  24292. </exception>
  24293. </member>
  24294. <member name="M:MailKit.Net.Smtp.SmtpStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  24295. <summary>
  24296. Asynchronously writes a sequence of bytes to the stream and advances the current
  24297. position within this stream by the number of bytes written.
  24298. </summary>
  24299. <remarks>
  24300. Writes a sequence of bytes to the stream and advances the current
  24301. position within this stream by the number of bytes written.
  24302. </remarks>
  24303. <returns>A task that represents the asynchronous write operation.</returns>
  24304. <param name='buffer'>The buffer to write.</param>
  24305. <param name='offset'>The offset of the first byte to write.</param>
  24306. <param name='count'>The number of bytes to write.</param>
  24307. <param name="cancellationToken">The cancellation token.</param>
  24308. <exception cref="T:System.ArgumentNullException">
  24309. <paramref name="buffer"/> is <c>null</c>.
  24310. </exception>
  24311. <exception cref="T:System.ArgumentOutOfRangeException">
  24312. <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
  24313. <para>-or-</para>
  24314. <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
  24315. at the specified <paramref name="offset"/>.</para>
  24316. </exception>
  24317. <exception cref="T:System.ObjectDisposedException">
  24318. The stream has been disposed.
  24319. </exception>
  24320. <exception cref="T:System.NotSupportedException">
  24321. The stream does not support writing.
  24322. </exception>
  24323. <exception cref="T:System.OperationCanceledException">
  24324. The operation was canceled via the cancellation token.
  24325. </exception>
  24326. <exception cref="T:System.IO.IOException">
  24327. An I/O error occurred.
  24328. </exception>
  24329. </member>
  24330. <member name="M:MailKit.Net.Smtp.SmtpStream.Flush(System.Threading.CancellationToken)">
  24331. <summary>
  24332. Clears all buffers for this stream and causes any buffered data to be written
  24333. to the underlying device.
  24334. </summary>
  24335. <remarks>
  24336. Clears all buffers for this stream and causes any buffered data to be written
  24337. to the underlying device.
  24338. </remarks>
  24339. <param name="cancellationToken">The cancellation token.</param>
  24340. <exception cref="T:System.ObjectDisposedException">
  24341. The stream has been disposed.
  24342. </exception>
  24343. <exception cref="T:System.NotSupportedException">
  24344. The stream does not support writing.
  24345. </exception>
  24346. <exception cref="T:System.OperationCanceledException">
  24347. The operation was canceled via the cancellation token.
  24348. </exception>
  24349. <exception cref="T:System.IO.IOException">
  24350. An I/O error occurred.
  24351. </exception>
  24352. </member>
  24353. <member name="M:MailKit.Net.Smtp.SmtpStream.Flush">
  24354. <summary>
  24355. Clears all buffers for this stream and causes any buffered data to be written
  24356. to the underlying device.
  24357. </summary>
  24358. <remarks>
  24359. Clears all buffers for this stream and causes any buffered data to be written
  24360. to the underlying device.
  24361. </remarks>
  24362. <exception cref="T:System.ObjectDisposedException">
  24363. The stream has been disposed.
  24364. </exception>
  24365. <exception cref="T:System.NotSupportedException">
  24366. The stream does not support writing.
  24367. </exception>
  24368. <exception cref="T:System.IO.IOException">
  24369. An I/O error occurred.
  24370. </exception>
  24371. </member>
  24372. <member name="M:MailKit.Net.Smtp.SmtpStream.FlushAsync(System.Threading.CancellationToken)">
  24373. <summary>
  24374. Asynchronously clears all buffers for this stream and causes any buffered data to be written
  24375. to the underlying device.
  24376. </summary>
  24377. <remarks>
  24378. Clears all buffers for this stream and causes any buffered data to be written
  24379. to the underlying device.
  24380. </remarks>
  24381. <returns>A task that represents the asynchronous flush operation.</returns>
  24382. <param name="cancellationToken">The cancellation token.</param>
  24383. <exception cref="T:System.ObjectDisposedException">
  24384. The stream has been disposed.
  24385. </exception>
  24386. <exception cref="T:System.NotSupportedException">
  24387. The stream does not support writing.
  24388. </exception>
  24389. <exception cref="T:System.OperationCanceledException">
  24390. The operation was canceled via the cancellation token.
  24391. </exception>
  24392. <exception cref="T:System.IO.IOException">
  24393. An I/O error occurred.
  24394. </exception>
  24395. </member>
  24396. <member name="M:MailKit.Net.Smtp.SmtpStream.Seek(System.Int64,System.IO.SeekOrigin)">
  24397. <summary>
  24398. Sets the position within the current stream.
  24399. </summary>
  24400. <returns>The new position within the stream.</returns>
  24401. <param name="offset">The offset into the stream relative to the <paramref name="origin"/>.</param>
  24402. <param name="origin">The origin to seek from.</param>
  24403. <exception cref="T:System.NotSupportedException">
  24404. The stream does not support seeking.
  24405. </exception>
  24406. </member>
  24407. <member name="M:MailKit.Net.Smtp.SmtpStream.SetLength(System.Int64)">
  24408. <summary>
  24409. Sets the length of the stream.
  24410. </summary>
  24411. <param name="value">The desired length of the stream in bytes.</param>
  24412. <exception cref="T:System.NotSupportedException">
  24413. The stream does not support setting the length.
  24414. </exception>
  24415. </member>
  24416. <member name="M:MailKit.Net.Smtp.SmtpStream.Dispose(System.Boolean)">
  24417. <summary>
  24418. Releases the unmanaged resources used by the <see cref="T:MailKit.Net.Smtp.SmtpStream"/> and
  24419. optionally releases the managed resources.
  24420. </summary>
  24421. <remarks>
  24422. Releases the unmanaged resources used by the <see cref="T:MailKit.Net.Smtp.SmtpStream"/> and
  24423. optionally releases the managed resources.
  24424. </remarks>
  24425. <param name="disposing"><c>true</c> to release both managed and unmanaged resources;
  24426. <c>false</c> to release only the unmanaged resources.</param>
  24427. </member>
  24428. <member name="T:MailKit.Net.Smtp.DeliveryStatusNotificationType">
  24429. <summary>
  24430. Delivery status notification type.
  24431. </summary>
  24432. <remarks>
  24433. The delivery status notification type specifies whether or not
  24434. the full message should be included in any failed DSN issued for
  24435. a message transmission as opposed to just the headers.
  24436. </remarks>
  24437. </member>
  24438. <member name="F:MailKit.Net.Smtp.DeliveryStatusNotificationType.Unspecified">
  24439. <summary>
  24440. The return type is unspecified, allowing the server to choose.
  24441. </summary>
  24442. </member>
  24443. <member name="F:MailKit.Net.Smtp.DeliveryStatusNotificationType.Full">
  24444. <summary>
  24445. The full message should be included in any failed delivery status notification issued by the server.
  24446. </summary>
  24447. </member>
  24448. <member name="F:MailKit.Net.Smtp.DeliveryStatusNotificationType.HeadersOnly">
  24449. <summary>
  24450. Only the headers should be included in any failed delivery status notification issued by the server.
  24451. </summary>
  24452. </member>
  24453. <member name="T:MailKit.Search.AnnotationSearchQuery">
  24454. <summary>
  24455. An annotation-based search query.
  24456. </summary>
  24457. <remarks>
  24458. An annotation-based search query.
  24459. </remarks>
  24460. </member>
  24461. <member name="M:MailKit.Search.AnnotationSearchQuery.#ctor(MailKit.AnnotationEntry,MailKit.AnnotationAttribute,System.String)">
  24462. <summary>
  24463. Initializes a new instance of the <see cref="T:MailKit.Search.AnnotationSearchQuery"/> class.
  24464. </summary>
  24465. <remarks>
  24466. Creates a new annotation-based search query.
  24467. </remarks>
  24468. <param name="entry">The annotation entry.</param>
  24469. <param name="attribute">The annotation attribute.</param>
  24470. <param name="value">The annotation attribute value.</param>
  24471. <exception cref="T:System.ArgumentNullException">
  24472. <para><paramref name="entry"/> is <c>null</c>.</para>
  24473. <para>-or-</para>
  24474. <para><paramref name="attribute"/> is <c>null</c>.</para>
  24475. </exception>
  24476. <exception cref="T:System.ArgumentException">
  24477. <paramref name="attribute"/> is not a valid attribute for searching.
  24478. </exception>
  24479. </member>
  24480. <member name="P:MailKit.Search.AnnotationSearchQuery.Entry">
  24481. <summary>
  24482. Get the annotation entry.
  24483. </summary>
  24484. <remarks>
  24485. Gets the annotation entry.
  24486. </remarks>
  24487. <value>The annotation entry.</value>
  24488. </member>
  24489. <member name="P:MailKit.Search.AnnotationSearchQuery.Attribute">
  24490. <summary>
  24491. Get the annotation attribute.
  24492. </summary>
  24493. <remarks>
  24494. Gets the annotation attribute.
  24495. </remarks>
  24496. <value>The annotation attribute.</value>
  24497. </member>
  24498. <member name="P:MailKit.Search.AnnotationSearchQuery.Value">
  24499. <summary>
  24500. Get the annotation attribute value.
  24501. </summary>
  24502. <remarks>
  24503. Gets the annotation attribute value.
  24504. </remarks>
  24505. <value>The annotation attribute value.</value>
  24506. </member>
  24507. <member name="T:MailKit.Search.BinarySearchQuery">
  24508. <summary>
  24509. A binary search query such as an AND or OR expression.
  24510. </summary>
  24511. <remarks>
  24512. A binary search query such as an AND or OR expression.
  24513. </remarks>
  24514. </member>
  24515. <member name="M:MailKit.Search.BinarySearchQuery.#ctor(MailKit.Search.SearchTerm,MailKit.Search.SearchQuery,MailKit.Search.SearchQuery)">
  24516. <summary>
  24517. Initializes a new instance of the <see cref="T:MailKit.Search.BinarySearchQuery"/> class.
  24518. </summary>
  24519. <remarks>
  24520. Creates a new binary search query.
  24521. </remarks>
  24522. <param name="term">THe search term.</param>
  24523. <param name="left">The left expression.</param>
  24524. <param name="right">The right expression.</param>
  24525. <exception cref="T:System.ArgumentNullException">
  24526. <para><paramref name="left"/> is <c>null</c>.</para>
  24527. <para>-or-</para>
  24528. <para><paramref name="right"/> is <c>null</c>.</para>
  24529. </exception>
  24530. </member>
  24531. <member name="P:MailKit.Search.BinarySearchQuery.Left">
  24532. <summary>
  24533. Gets the left operand of the expression.
  24534. </summary>
  24535. <remarks>
  24536. Gets the left operand of the expression.
  24537. </remarks>
  24538. <value>The left operand.</value>
  24539. </member>
  24540. <member name="P:MailKit.Search.BinarySearchQuery.Right">
  24541. <summary>
  24542. Gets the right operand of the expression.
  24543. </summary>
  24544. <remarks>
  24545. Gets the right operand of the expression.
  24546. </remarks>
  24547. <value>The right operand.</value>
  24548. </member>
  24549. <member name="T:MailKit.Search.DateSearchQuery">
  24550. <summary>
  24551. A date-based search query.
  24552. </summary>
  24553. <remarks>
  24554. A date-based search query.
  24555. </remarks>
  24556. </member>
  24557. <member name="M:MailKit.Search.DateSearchQuery.#ctor(MailKit.Search.SearchTerm,System.DateTime)">
  24558. <summary>
  24559. Initializes a new instance of the <see cref="T:MailKit.Search.DateSearchQuery"/> class.
  24560. </summary>
  24561. <remarks>
  24562. Creates a new date-based search query.
  24563. </remarks>
  24564. <param name="term">The search term.</param>
  24565. <param name="date">The date.</param>
  24566. </member>
  24567. <member name="P:MailKit.Search.DateSearchQuery.Date">
  24568. <summary>
  24569. Gets the date value of the search query.
  24570. </summary>
  24571. <remarks>
  24572. Gets the date value of the search query.
  24573. </remarks>
  24574. <value>The date.</value>
  24575. </member>
  24576. <member name="T:MailKit.Search.FilterSearchQuery">
  24577. <summary>
  24578. A filter-based search query.
  24579. </summary>
  24580. <remarks>
  24581. A filter-based search query.
  24582. </remarks>
  24583. </member>
  24584. <member name="M:MailKit.Search.FilterSearchQuery.#ctor(System.String)">
  24585. <summary>
  24586. Initializes a new instance of the <see cref="T:MailKit.Search.FilterSearchQuery"/> class.
  24587. </summary>
  24588. <remarks>
  24589. A search query that references a predefined filter.
  24590. </remarks>
  24591. <param name="name">The name of the filter.</param>
  24592. <exception cref="T:System.ArgumentNullException">
  24593. <paramref name="name"/> is <c>null</c>.
  24594. </exception>
  24595. <exception cref="T:System.ArgumentException">
  24596. <paramref name="name"/> is empty.
  24597. </exception>
  24598. </member>
  24599. <member name="M:MailKit.Search.FilterSearchQuery.#ctor(MailKit.MetadataTag)">
  24600. <summary>
  24601. Initializes a new instance of the <see cref="T:MailKit.Search.FilterSearchQuery"/> class.
  24602. </summary>
  24603. <remarks>
  24604. A search query that references a predefined filter.
  24605. </remarks>
  24606. <param name="filter">The metadata tag representing the filter.</param>
  24607. <exception cref="T:System.ArgumentException">
  24608. <paramref name="filter"/> does not reference a valid filter.
  24609. </exception>
  24610. </member>
  24611. <member name="P:MailKit.Search.FilterSearchQuery.Name">
  24612. <summary>
  24613. Get the name of the filter.
  24614. </summary>
  24615. <remarks>
  24616. Gets the name of the filter.
  24617. </remarks>
  24618. <value>The name of the filter.</value>
  24619. </member>
  24620. <member name="T:MailKit.Search.HeaderSearchQuery">
  24621. <summary>
  24622. A header-based search query.
  24623. </summary>
  24624. <remarks>
  24625. A header-based search query.
  24626. </remarks>
  24627. </member>
  24628. <member name="M:MailKit.Search.HeaderSearchQuery.#ctor(System.String,System.String)">
  24629. <summary>
  24630. Initializes a new instance of the <see cref="T:MailKit.Search.HeaderSearchQuery"/> class.
  24631. </summary>
  24632. <remarks>
  24633. Creates a new header search query.
  24634. </remarks>
  24635. <param name="field">The header field name.</param>
  24636. <param name="value">The value to match against.</param>
  24637. <exception cref="T:System.ArgumentNullException">
  24638. <para><paramref name="field"/> is <c>null</c>.</para>
  24639. <para>-or-</para>
  24640. <para><paramref name="value"/> is <c>null</c>.</para>
  24641. </exception>
  24642. <exception cref="T:System.ArgumentException">
  24643. <paramref name="field"/> is empty.
  24644. </exception>
  24645. </member>
  24646. <member name="P:MailKit.Search.HeaderSearchQuery.Field">
  24647. <summary>
  24648. Gets the header field name.
  24649. </summary>
  24650. <remarks>
  24651. Gets the header field name.
  24652. </remarks>
  24653. <value>The header field.</value>
  24654. </member>
  24655. <member name="P:MailKit.Search.HeaderSearchQuery.Value">
  24656. <summary>
  24657. Gets the value to match against.
  24658. </summary>
  24659. <remarks>
  24660. Gets the value to match against.
  24661. </remarks>
  24662. <value>The value.</value>
  24663. </member>
  24664. <member name="T:MailKit.Search.NumericSearchQuery">
  24665. <summary>
  24666. A numeric search query.
  24667. </summary>
  24668. <remarks>
  24669. A numeric search query.
  24670. </remarks>
  24671. </member>
  24672. <member name="M:MailKit.Search.NumericSearchQuery.#ctor(MailKit.Search.SearchTerm,System.UInt64)">
  24673. <summary>
  24674. Initializes a new instance of the <see cref="T:MailKit.Search.NumericSearchQuery"/> class.
  24675. </summary>
  24676. <remarks>
  24677. Creates a new numeric search query.
  24678. </remarks>
  24679. <param name="term">The search term.</param>
  24680. <param name="value">The numeric value.</param>
  24681. </member>
  24682. <member name="P:MailKit.Search.NumericSearchQuery.Value">
  24683. <summary>
  24684. Gets the numeric value to match against.
  24685. </summary>
  24686. <remarks>
  24687. Gets the numeric value to match against.
  24688. </remarks>
  24689. <value>The numeric value.</value>
  24690. </member>
  24691. <member name="T:MailKit.Search.OrderBy">
  24692. <summary>
  24693. Specifies a sort order for search results.
  24694. </summary>
  24695. <remarks>
  24696. You can combine multiple <see cref="T:MailKit.Search.OrderBy"/> rules to specify the sort
  24697. order that <see cref="M:MailKit.IMailFolder.Sort(MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)"/>
  24698. should return the results in.
  24699. </remarks>
  24700. </member>
  24701. <member name="M:MailKit.Search.OrderBy.#ctor(MailKit.Search.OrderByType,MailKit.Search.SortOrder)">
  24702. <summary>
  24703. Initializes a new instance of the <see cref="T:MailKit.Search.OrderBy"/> class.
  24704. </summary>
  24705. <param name="type">The field to sort by.</param>
  24706. <param name="order">The sort order.</param>
  24707. <exception cref="T:System.ArgumentOutOfRangeException">
  24708. <paramref name="order"/> cannot be <see cref="F:MailKit.Search.SortOrder.None"/>.
  24709. </exception>
  24710. </member>
  24711. <member name="P:MailKit.Search.OrderBy.Type">
  24712. <summary>
  24713. Gets the field used for sorting.
  24714. </summary>
  24715. <remarks>
  24716. Gets the field used for sorting.
  24717. </remarks>
  24718. <value>The field used for sorting.</value>
  24719. </member>
  24720. <member name="P:MailKit.Search.OrderBy.Order">
  24721. <summary>
  24722. Gets the sort order.
  24723. </summary>
  24724. <remarks>
  24725. Gets the sort order.
  24726. </remarks>
  24727. <value>The sort order.</value>
  24728. </member>
  24729. <member name="F:MailKit.Search.OrderBy.Arrival">
  24730. <summary>
  24731. Sort results by arrival date in ascending order.
  24732. </summary>
  24733. <remarks>
  24734. Sort results by arrival date in ascending order.
  24735. </remarks>
  24736. </member>
  24737. <member name="F:MailKit.Search.OrderBy.ReverseArrival">
  24738. <summary>
  24739. Sort results by arrival date in desending order.
  24740. </summary>
  24741. <remarks>
  24742. Sort results by arrival date in desending order.
  24743. </remarks>
  24744. </member>
  24745. <member name="F:MailKit.Search.OrderBy.Cc">
  24746. <summary>
  24747. Sort results by the first email address in the Cc header in ascending order.
  24748. </summary>
  24749. <remarks>
  24750. Sort results by the first email address in the Cc header in ascending order.
  24751. </remarks>
  24752. </member>
  24753. <member name="F:MailKit.Search.OrderBy.ReverseCc">
  24754. <summary>
  24755. Sort results by the first email address in the Cc header in descending order.
  24756. </summary>
  24757. <remarks>
  24758. Sort results by the first email address in the Cc header in descending order.
  24759. </remarks>
  24760. </member>
  24761. <member name="F:MailKit.Search.OrderBy.Date">
  24762. <summary>
  24763. Sort results by the sent date in ascending order.
  24764. </summary>
  24765. <remarks>
  24766. Sort results by the sent date in ascending order.
  24767. </remarks>
  24768. </member>
  24769. <member name="F:MailKit.Search.OrderBy.ReverseDate">
  24770. <summary>
  24771. Sort results by the sent date in descending order.
  24772. </summary>
  24773. <remarks>
  24774. Sort results by the sent date in descending order.
  24775. </remarks>
  24776. </member>
  24777. <member name="F:MailKit.Search.OrderBy.From">
  24778. <summary>
  24779. Sort results by the first email address in the From header in ascending order.
  24780. </summary>
  24781. <remarks>
  24782. Sort results by the first email address in the From header in ascending order.
  24783. </remarks>
  24784. </member>
  24785. <member name="F:MailKit.Search.OrderBy.ReverseFrom">
  24786. <summary>
  24787. Sort results by the first email address in the From header in descending order.
  24788. </summary>
  24789. <remarks>
  24790. Sort results by the first email address in the From header in descending order.
  24791. </remarks>
  24792. </member>
  24793. <member name="F:MailKit.Search.OrderBy.DisplayFrom">
  24794. <summary>
  24795. Sort results by the first display name in the From header in ascending order.
  24796. </summary>
  24797. <remarks>
  24798. Sort results by the first display name in the From header in ascending order.
  24799. </remarks>
  24800. </member>
  24801. <member name="F:MailKit.Search.OrderBy.ReverseDisplayFrom">
  24802. <summary>
  24803. Sort results by the first display name in the From header in descending order.
  24804. </summary>
  24805. <remarks>
  24806. Sort results by the first display name in the From header in descending order.
  24807. </remarks>
  24808. </member>
  24809. <member name="F:MailKit.Search.OrderBy.Size">
  24810. <summary>
  24811. Sort results by the message size in ascending order.
  24812. </summary>
  24813. <remarks>
  24814. Sort results by the message size in ascending order.
  24815. </remarks>
  24816. </member>
  24817. <member name="F:MailKit.Search.OrderBy.ReverseSize">
  24818. <summary>
  24819. Sort results by the message size in descending order.
  24820. </summary>
  24821. <remarks>
  24822. Sort results by the message size in descending order.
  24823. </remarks>
  24824. </member>
  24825. <member name="F:MailKit.Search.OrderBy.Subject">
  24826. <summary>
  24827. Sort results by the Subject header in ascending order.
  24828. </summary>
  24829. <remarks>
  24830. Sort results by the Subject header in ascending order.
  24831. </remarks>
  24832. </member>
  24833. <member name="F:MailKit.Search.OrderBy.ReverseSubject">
  24834. <summary>
  24835. Sort results by the Subject header in descending order.
  24836. </summary>
  24837. <remarks>
  24838. Sort results by the Subject header in descending order.
  24839. </remarks>
  24840. </member>
  24841. <member name="F:MailKit.Search.OrderBy.To">
  24842. <summary>
  24843. Sort results by the first email address in the To header in ascending order.
  24844. </summary>
  24845. <remarks>
  24846. Sort results by the first email address in the To header in ascending order.
  24847. </remarks>
  24848. </member>
  24849. <member name="F:MailKit.Search.OrderBy.ReverseTo">
  24850. <summary>
  24851. Sort results by the first email address in the To header in descending order.
  24852. </summary>
  24853. <remarks>
  24854. Sort results by the first email address in the To header in descending order.
  24855. </remarks>
  24856. </member>
  24857. <member name="F:MailKit.Search.OrderBy.DisplayTo">
  24858. <summary>
  24859. Sort results by the first display name in the To header in ascending order.
  24860. </summary>
  24861. <remarks>
  24862. Sort results by the first display name in the To header in ascending order.
  24863. </remarks>
  24864. </member>
  24865. <member name="F:MailKit.Search.OrderBy.ReverseDisplayTo">
  24866. <summary>
  24867. Sort results by the first display name in the To header in descending order.
  24868. </summary>
  24869. <remarks>
  24870. Sort results by the first display name in the To header in descending order.
  24871. </remarks>
  24872. </member>
  24873. <member name="T:MailKit.Search.OrderByAnnotation">
  24874. <summary>
  24875. Specifies an annotation-based sort order for search results.
  24876. </summary>
  24877. <remarks>
  24878. You can combine multiple <see cref="T:MailKit.Search.OrderBy"/> rules to specify the sort
  24879. order that <see cref="M:MailKit.IMailFolder.Sort(MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)"/>
  24880. should return the results in.
  24881. </remarks>
  24882. </member>
  24883. <member name="M:MailKit.Search.OrderByAnnotation.#ctor(MailKit.AnnotationEntry,MailKit.AnnotationAttribute,MailKit.Search.SortOrder)">
  24884. <summary>
  24885. Initializes a new instance of the <see cref="T:MailKit.Search.OrderByAnnotation"/> class.
  24886. </summary>
  24887. <param name="entry">The annotation entry to sort by.</param>
  24888. <param name="attribute">The annotation attribute to use for sorting.</param>
  24889. <param name="order">The sort order.</param>
  24890. <exception cref="T:System.ArgumentNullException">
  24891. <para><paramref name="entry"/> is <c>null</c>.</para>
  24892. <para>-or-</para>
  24893. <para><paramref name="attribute"/>is <c>null</c>.</para>
  24894. </exception>
  24895. <exception cref="T:System.ArgumentException">
  24896. <paramref name="attribute"/> is not a valid attribute for sorting.
  24897. </exception>
  24898. </member>
  24899. <member name="P:MailKit.Search.OrderByAnnotation.Entry">
  24900. <summary>
  24901. Get the annotation entry.
  24902. </summary>
  24903. <remarks>
  24904. Gets the annotation entry.
  24905. </remarks>
  24906. <value>The annotation entry.</value>
  24907. </member>
  24908. <member name="P:MailKit.Search.OrderByAnnotation.Attribute">
  24909. <summary>
  24910. Get the annotation attribute.
  24911. </summary>
  24912. <remarks>
  24913. Gets the annotation attribute.
  24914. </remarks>
  24915. <value>The annotation attribute.</value>
  24916. </member>
  24917. <member name="T:MailKit.Search.OrderByType">
  24918. <summary>
  24919. The field to sort by.
  24920. </summary>
  24921. <remarks>
  24922. The field to sort by.
  24923. </remarks>
  24924. </member>
  24925. <member name="F:MailKit.Search.OrderByType.Annotation">
  24926. <summary>
  24927. Sort by an annotation value.
  24928. </summary>
  24929. </member>
  24930. <member name="F:MailKit.Search.OrderByType.Arrival">
  24931. <summary>
  24932. Sort by the arrival date.
  24933. </summary>
  24934. </member>
  24935. <member name="F:MailKit.Search.OrderByType.Cc">
  24936. <summary>
  24937. Sort by the Cc header.
  24938. </summary>
  24939. </member>
  24940. <member name="F:MailKit.Search.OrderByType.Date">
  24941. <summary>
  24942. Sort by the Date header.
  24943. </summary>
  24944. </member>
  24945. <member name="F:MailKit.Search.OrderByType.DisplayFrom">
  24946. <summary>
  24947. Sort by the Display Name of the From header.
  24948. </summary>
  24949. </member>
  24950. <member name="F:MailKit.Search.OrderByType.DisplayTo">
  24951. <summary>
  24952. Sort by the Display Name of the To header.
  24953. </summary>
  24954. </member>
  24955. <member name="F:MailKit.Search.OrderByType.From">
  24956. <summary>
  24957. Sort by the From header.
  24958. </summary>
  24959. </member>
  24960. <member name="F:MailKit.Search.OrderByType.ModSeq">
  24961. <summary>
  24962. Sort by the mod-sequence.
  24963. </summary>
  24964. </member>
  24965. <member name="F:MailKit.Search.OrderByType.Size">
  24966. <summary>
  24967. Sort by the message size.
  24968. </summary>
  24969. </member>
  24970. <member name="F:MailKit.Search.OrderByType.Subject">
  24971. <summary>
  24972. Sort by the message subject.
  24973. </summary>
  24974. </member>
  24975. <member name="F:MailKit.Search.OrderByType.To">
  24976. <summary>
  24977. Sort by the To header.
  24978. </summary>
  24979. </member>
  24980. <member name="T:MailKit.Search.SearchOptions">
  24981. <summary>
  24982. Advanced search options.
  24983. </summary>
  24984. <remarks>
  24985. Advanced search options.
  24986. </remarks>
  24987. </member>
  24988. <member name="F:MailKit.Search.SearchOptions.None">
  24989. <summary>
  24990. No options specified.
  24991. </summary>
  24992. </member>
  24993. <member name="F:MailKit.Search.SearchOptions.All">
  24994. <summary>
  24995. Returns all of the matching unique identifiers.
  24996. </summary>
  24997. </member>
  24998. <member name="F:MailKit.Search.SearchOptions.Count">
  24999. <summary>
  25000. Returns the number of messages that match the search query.
  25001. </summary>
  25002. </member>
  25003. <member name="F:MailKit.Search.SearchOptions.Min">
  25004. <summary>
  25005. Returns the minimum unique identifier of the messages that match the search query.
  25006. </summary>
  25007. </member>
  25008. <member name="F:MailKit.Search.SearchOptions.Max">
  25009. <summary>
  25010. Returns the maximum unique identifier of the messages that match the search query.
  25011. </summary>
  25012. </member>
  25013. <member name="F:MailKit.Search.SearchOptions.Relevancy">
  25014. <summary>
  25015. Returns the relevancy scores of the messages that match the query. Can only be used
  25016. when using FUZZY search.
  25017. </summary>
  25018. </member>
  25019. <member name="T:MailKit.Search.SearchQuery">
  25020. <summary>
  25021. A specialized query for searching messages in a <see cref="T:MailKit.IMailFolder"/>.
  25022. </summary>
  25023. <remarks>
  25024. A specialized query for searching messages in a <see cref="T:MailKit.IMailFolder"/>.
  25025. </remarks>
  25026. </member>
  25027. <member name="M:MailKit.Search.SearchQuery.#ctor">
  25028. <summary>
  25029. Initializes a new instance of the <see cref="T:MailKit.Search.SearchQuery"/> class.
  25030. </summary>
  25031. <remarks>
  25032. Creates a new <see cref="T:MailKit.Search.SearchQuery"/> that matches all messages.
  25033. </remarks>
  25034. </member>
  25035. <member name="M:MailKit.Search.SearchQuery.#ctor(MailKit.Search.SearchTerm)">
  25036. <summary>
  25037. Initializes a new instance of the <see cref="T:MailKit.Search.SearchQuery"/> class.
  25038. </summary>
  25039. <remarks>
  25040. Creates a new <see cref="T:MailKit.Search.SearchQuery"/> with the specified search term.
  25041. </remarks>
  25042. <param name="term">The search term.</param>
  25043. </member>
  25044. <member name="P:MailKit.Search.SearchQuery.Term">
  25045. <summary>
  25046. Get the search term used by the search query.
  25047. </summary>
  25048. <remarks>
  25049. Gets the search term used by the search query.
  25050. </remarks>
  25051. <value>The term.</value>
  25052. </member>
  25053. <member name="F:MailKit.Search.SearchQuery.All">
  25054. <summary>
  25055. Match all messages in the folder.
  25056. </summary>
  25057. <remarks>
  25058. Matches all messages in the folder.
  25059. </remarks>
  25060. </member>
  25061. <member name="M:MailKit.Search.SearchQuery.And(MailKit.Search.SearchQuery,MailKit.Search.SearchQuery)">
  25062. <summary>
  25063. Create a conditional AND operation.
  25064. </summary>
  25065. <remarks>
  25066. A conditional AND operation only evaluates the second operand if the first operand evaluates to true.
  25067. </remarks>
  25068. <returns>A <see cref="T:MailKit.Search.BinarySearchQuery"/> representing the conditional AND operation.</returns>
  25069. <param name="left">The first operand.</param>
  25070. <param name="right">The second operand.</param>
  25071. <exception cref="T:System.ArgumentNullException">
  25072. <para><paramref name="left"/> is <c>null</c>.</para>
  25073. <para>-or-</para>
  25074. <para><paramref name="right"/> is <c>null</c>.</para>
  25075. </exception>
  25076. </member>
  25077. <member name="M:MailKit.Search.SearchQuery.And(MailKit.Search.SearchQuery)">
  25078. <summary>
  25079. Create a conditional AND operation.
  25080. </summary>
  25081. <remarks>
  25082. A conditional AND operation only evaluates the second operand if the first operand evaluates to true.
  25083. </remarks>
  25084. <returns>A <see cref="T:MailKit.Search.BinarySearchQuery"/> representing the conditional AND operation.</returns>
  25085. <param name="expr">An additional query to execute.</param>
  25086. <exception cref="T:System.ArgumentNullException">
  25087. <paramref name="expr"/> is <c>null</c>.
  25088. </exception>
  25089. </member>
  25090. <member name="M:MailKit.Search.SearchQuery.AnnotationsContain(MailKit.AnnotationEntry,MailKit.AnnotationAttribute,System.String)">
  25091. <summary>
  25092. Match messages with the specified annotation.
  25093. </summary>
  25094. <remarks>
  25095. <para>Matches messages with the specified annotation.</para>
  25096. <note type="warning">This feature is not supported by all IMAP servers.</note>
  25097. </remarks>
  25098. <param name="entry">The annotation entry.</param>
  25099. <param name="attribute">The annotation attribute.</param>
  25100. <param name="value">The annotation attribute value.</param>
  25101. <returns>A <see cref="T:MailKit.Search.AnnotationSearchQuery"/>.</returns>
  25102. <exception cref="T:System.ArgumentNullException">
  25103. <para><paramref name="entry"/> is <c>null</c>.</para>
  25104. <para>-or-</para>
  25105. <para><paramref name="attribute"/> is <c>null</c>.</para>
  25106. </exception>
  25107. <exception cref="T:System.ArgumentException">
  25108. <paramref name="attribute"/> is not a valid attribute for searching.
  25109. </exception>
  25110. </member>
  25111. <member name="F:MailKit.Search.SearchQuery.Answered">
  25112. <summary>
  25113. Match messages with the <see cref="F:MailKit.MessageFlags.Answered"/> flag set.
  25114. </summary>
  25115. <remarks>
  25116. Matches messages with the <see cref="F:MailKit.MessageFlags.Answered"/> flag set.
  25117. </remarks>
  25118. </member>
  25119. <member name="M:MailKit.Search.SearchQuery.BccContains(System.String)">
  25120. <summary>
  25121. Match messages where the Bcc header contains the specified text.
  25122. </summary>
  25123. <remarks>
  25124. Matches messages where the Bcc header contains the specified text.
  25125. </remarks>
  25126. <returns>A <see cref="T:MailKit.Search.TextSearchQuery"/>.</returns>
  25127. <param name="text">The text to match against.</param>
  25128. <exception cref="T:System.ArgumentNullException">
  25129. <paramref name="text"/> is <c>null</c>.
  25130. </exception>
  25131. <exception cref="T:System.ArgumentException">
  25132. <paramref name="text"/> is empty.
  25133. </exception>
  25134. </member>
  25135. <member name="M:MailKit.Search.SearchQuery.BodyContains(System.String)">
  25136. <summary>
  25137. Match messages where the message body contains the specified text.
  25138. </summary>
  25139. <remarks>
  25140. Matches messages where the message body contains the specified text.
  25141. </remarks>
  25142. <returns>A <see cref="T:MailKit.Search.TextSearchQuery"/>.</returns>
  25143. <param name="text">The text to match against.</param>
  25144. <exception cref="T:System.ArgumentNullException">
  25145. <paramref name="text"/> is <c>null</c>.
  25146. </exception>
  25147. <exception cref="T:System.ArgumentException">
  25148. <paramref name="text"/> is empty.
  25149. </exception>
  25150. </member>
  25151. <member name="M:MailKit.Search.SearchQuery.CcContains(System.String)">
  25152. <summary>
  25153. Match messages where the Cc header contains the specified text.
  25154. </summary>
  25155. <remarks>
  25156. Matches messages where the Cc header contains the specified text.
  25157. </remarks>
  25158. <returns>A <see cref="T:MailKit.Search.TextSearchQuery"/>.</returns>
  25159. <param name="text">The text to match against.</param>
  25160. <exception cref="T:System.ArgumentNullException">
  25161. <paramref name="text"/> is <c>null</c>.
  25162. </exception>
  25163. <exception cref="T:System.ArgumentException">
  25164. <paramref name="text"/> is empty.
  25165. </exception>
  25166. </member>
  25167. <member name="M:MailKit.Search.SearchQuery.ChangedSince(System.UInt64)">
  25168. <summary>
  25169. Match messages that have mod-sequence values greater than or equal to the specified mod-sequence value.
  25170. </summary>
  25171. <remarks>
  25172. Matches messages that have mod-sequence values greater than or equal to the specified mod-sequence value.
  25173. </remarks>
  25174. <returns>A <see cref="T:MailKit.Search.SearchQuery"/>.</returns>
  25175. <param name="modseq">The mod-sequence value.</param>
  25176. </member>
  25177. <member name="F:MailKit.Search.SearchQuery.Deleted">
  25178. <summary>
  25179. Match messages with the <see cref="F:MailKit.MessageFlags.Deleted"/> flag set.
  25180. </summary>
  25181. <remarks>
  25182. Matches messages with the <see cref="F:MailKit.MessageFlags.Deleted"/> flag set.
  25183. </remarks>
  25184. </member>
  25185. <member name="M:MailKit.Search.SearchQuery.DeliveredAfter(System.DateTime)">
  25186. <summary>
  25187. Match messages that were delivered after the specified date.
  25188. </summary>
  25189. <remarks>
  25190. <para>Matches messages that were delivered after the specified date.</para>
  25191. <para>The resolution of this search query does not include the time.</para>
  25192. </remarks>
  25193. <returns>A <see cref="T:MailKit.Search.DateSearchQuery"/>.</returns>
  25194. <param name="date">The date.</param>
  25195. </member>
  25196. <member name="M:MailKit.Search.SearchQuery.DeliveredBefore(System.DateTime)">
  25197. <summary>
  25198. Match messages that were delivered before the specified date.
  25199. </summary>
  25200. <remarks>
  25201. <para>Matches messages that were delivered before the specified date.</para>
  25202. <para>The resolution of this search query does not include the time.</para>
  25203. </remarks>
  25204. <returns>A <see cref="T:MailKit.Search.DateSearchQuery"/>.</returns>
  25205. <param name="date">The date.</param>
  25206. </member>
  25207. <member name="M:MailKit.Search.SearchQuery.DeliveredOn(System.DateTime)">
  25208. <summary>
  25209. Match messages that were delivered on the specified date.
  25210. </summary>
  25211. <remarks>
  25212. <para>Matches messages that were delivered on the specified date.</para>
  25213. <para>The resolution of this search query does not include the time.</para>
  25214. </remarks>
  25215. <returns>A <see cref="T:MailKit.Search.DateSearchQuery"/>.</returns>
  25216. <param name="date">The date.</param>
  25217. </member>
  25218. <member name="M:MailKit.Search.SearchQuery.DoesNotHaveCustomFlag(System.String)">
  25219. <summary>
  25220. Match messages that do not have the specified custom flag set.
  25221. </summary>
  25222. <remarks>
  25223. Matches messages that do not have the specified custom flag set.
  25224. </remarks>
  25225. <returns>A <see cref="T:MailKit.Search.TextSearchQuery"/>.</returns>
  25226. <param name="flag">The custom flag.</param>
  25227. <exception cref="T:System.ArgumentNullException">
  25228. <paramref name="flag"/> is <c>null</c>.
  25229. </exception>
  25230. <exception cref="T:System.ArgumentException">
  25231. <paramref name="flag"/> is empty.
  25232. </exception>
  25233. </member>
  25234. <member name="M:MailKit.Search.SearchQuery.DoesNotHaveCustomFlags(System.Collections.Generic.IEnumerable{System.String})">
  25235. <summary>
  25236. Match messages that do not have any of the specified custom flags set.
  25237. </summary>
  25238. <remarks>
  25239. Matches messages that do not have any of the specified custom flags set.
  25240. </remarks>
  25241. <returns>A <see cref="T:MailKit.Search.SearchQuery"/>.</returns>
  25242. <param name="flags">The custom flags.</param>
  25243. <exception cref="T:System.ArgumentNullException">
  25244. <paramref name="flags"/> is <c>null</c>.
  25245. </exception>
  25246. <exception cref="T:System.ArgumentException">
  25247. <para>One or more of the <paramref name="flags"/> is <c>null</c> or empty.</para>
  25248. <para>-or-</para>
  25249. <para>No custom flags were given.</para>
  25250. </exception>
  25251. </member>
  25252. <member name="M:MailKit.Search.SearchQuery.DoesNotHaveFlags(MailKit.MessageFlags)">
  25253. <summary>
  25254. Match messages that do not have any of the specified flags set.
  25255. </summary>
  25256. <remarks>
  25257. Matches messages that do not have any of the specified flags set.
  25258. </remarks>
  25259. <returns>A <see cref="T:MailKit.Search.SearchQuery"/>.</returns>
  25260. <param name="flags">The message flags.</param>
  25261. <exception cref="T:System.ArgumentException">
  25262. <paramref name="flags"/> does not specify any valid message flags.
  25263. </exception>
  25264. </member>
  25265. <member name="F:MailKit.Search.SearchQuery.Draft">
  25266. <summary>
  25267. Match messages with the <see cref="F:MailKit.MessageFlags.Draft"/> flag set.
  25268. </summary>
  25269. <remarks>
  25270. Matches messages with the <see cref="F:MailKit.MessageFlags.Draft"/> flag set.
  25271. </remarks>
  25272. </member>
  25273. <member name="M:MailKit.Search.SearchQuery.Filter(System.String)">
  25274. <summary>
  25275. Match messages using a saved search filter.
  25276. </summary>
  25277. <remarks>
  25278. Matches messages using a saved search filter.
  25279. </remarks>
  25280. <returns>A <see cref="T:MailKit.Search.FilterSearchQuery"/>.</returns>
  25281. <param name="name">The name of the saved search.</param>
  25282. </member>
  25283. <member name="M:MailKit.Search.SearchQuery.Filter(MailKit.MetadataTag)">
  25284. <summary>
  25285. Match messages using a saved search filter.
  25286. </summary>
  25287. <remarks>
  25288. Matches messages using a saved search filter.
  25289. </remarks>
  25290. <returns>A <see cref="T:MailKit.Search.FilterSearchQuery"/>.</returns>
  25291. <param name="filter">The name of the saved search.</param>
  25292. </member>
  25293. <member name="F:MailKit.Search.SearchQuery.Flagged">
  25294. <summary>
  25295. Match messages with the <see cref="F:MailKit.MessageFlags.Flagged"/> flag set.
  25296. </summary>
  25297. <remarks>
  25298. Matches messages with the <see cref="F:MailKit.MessageFlags.Flagged"/> flag set.
  25299. </remarks>
  25300. </member>
  25301. <member name="M:MailKit.Search.SearchQuery.FromContains(System.String)">
  25302. <summary>
  25303. Match messages where the From header contains the specified text.
  25304. </summary>
  25305. <remarks>
  25306. Matches messages where the From header contains the specified text.
  25307. </remarks>
  25308. <returns>A <see cref="T:MailKit.Search.TextSearchQuery"/>.</returns>
  25309. <param name="text">The text to match against.</param>
  25310. <exception cref="T:System.ArgumentNullException">
  25311. <paramref name="text"/> is <c>null</c>.
  25312. </exception>
  25313. <exception cref="T:System.ArgumentException">
  25314. <paramref name="text"/> is empty.
  25315. </exception>
  25316. </member>
  25317. <member name="M:MailKit.Search.SearchQuery.Fuzzy(MailKit.Search.SearchQuery)">
  25318. <summary>
  25319. Apply a fuzzy matching algorithm to the specified expression.
  25320. </summary>
  25321. <remarks>
  25322. <para>Applies a fuzzy matching algorithm to the specified expression.</para>
  25323. <note type="warning">This feature is not supported by all IMAP servers.</note>
  25324. </remarks>
  25325. <returns>A <see cref="T:MailKit.Search.UnarySearchQuery"/>.</returns>
  25326. <param name="expr">The expression</param>
  25327. <exception cref="T:System.ArgumentNullException">
  25328. <paramref name="expr"/> is <c>null</c>.
  25329. </exception>
  25330. </member>
  25331. <member name="M:MailKit.Search.SearchQuery.HasCustomFlag(System.String)">
  25332. <summary>
  25333. Match messages that have the specified custom flag set.
  25334. </summary>
  25335. <remarks>
  25336. Matches messages that have the specified custom flag set.
  25337. </remarks>
  25338. <returns>A <see cref="T:MailKit.Search.TextSearchQuery"/>.</returns>
  25339. <param name="flag">The custom flag.</param>
  25340. <exception cref="T:System.ArgumentNullException">
  25341. <paramref name="flag"/> is <c>null</c>.
  25342. </exception>
  25343. <exception cref="T:System.ArgumentException">
  25344. <paramref name="flag"/> is empty.
  25345. </exception>
  25346. </member>
  25347. <member name="M:MailKit.Search.SearchQuery.HasCustomFlags(System.Collections.Generic.IEnumerable{System.String})">
  25348. <summary>
  25349. Match messages that have the specified custom flags set.
  25350. </summary>
  25351. <remarks>
  25352. Matches messages that have the specified custom flags set.
  25353. </remarks>
  25354. <returns>A <see cref="T:MailKit.Search.SearchQuery"/>.</returns>
  25355. <param name="flags">The custom flags.</param>
  25356. <exception cref="T:System.ArgumentNullException">
  25357. <paramref name="flags"/> is <c>null</c>.
  25358. </exception>
  25359. <exception cref="T:System.ArgumentException">
  25360. <para>One or more of the <paramref name="flags"/> is <c>null</c> or empty.</para>
  25361. <para>-or-</para>
  25362. <para>No custom flags were given.</para>
  25363. </exception>
  25364. </member>
  25365. <member name="M:MailKit.Search.SearchQuery.HasFlags(MailKit.MessageFlags)">
  25366. <summary>
  25367. Match messages that have the specified flags set.
  25368. </summary>
  25369. <remarks>
  25370. Matches messages that have the specified flags set.
  25371. </remarks>
  25372. <returns>A <see cref="T:MailKit.Search.SearchQuery"/>.</returns>
  25373. <param name="flags">The message flags.</param>
  25374. <exception cref="T:System.ArgumentException">
  25375. <paramref name="flags"/> does not specify any valid message flags.
  25376. </exception>
  25377. </member>
  25378. <member name="M:MailKit.Search.SearchQuery.NotFlags(MailKit.MessageFlags)">
  25379. <summary>
  25380. Match messages that do not have any of the specified flags set.
  25381. </summary>
  25382. <remarks>
  25383. Matches messages that do not have any of the specified flags set.
  25384. </remarks>
  25385. <returns>A <see cref="T:MailKit.Search.SearchQuery"/>.</returns>
  25386. <param name="flags">The message flags.</param>
  25387. <exception cref="T:System.ArgumentException">
  25388. <paramref name="flags"/> does not specify any valid message flags.
  25389. </exception>
  25390. </member>
  25391. <member name="M:MailKit.Search.SearchQuery.HasKeyword(System.String)">
  25392. <summary>
  25393. Match messages that have the specified keyword set.
  25394. </summary>
  25395. <remarks>
  25396. <para>Matches messages that have the specified keyword set.</para>
  25397. <note type="info">A keyword is a user-defined message flag.</note>
  25398. </remarks>
  25399. <returns>A <see cref="T:MailKit.Search.TextSearchQuery"/>.</returns>
  25400. <param name="keyword">The keyword.</param>
  25401. <exception cref="T:System.ArgumentNullException">
  25402. <paramref name="keyword"/> is <c>null</c>.
  25403. </exception>
  25404. <exception cref="T:System.ArgumentException">
  25405. <paramref name="keyword"/> is empty.
  25406. </exception>
  25407. </member>
  25408. <member name="M:MailKit.Search.SearchQuery.HasKeywords(System.Collections.Generic.IEnumerable{System.String})">
  25409. <summary>
  25410. Match messages that have all of the specified keywords set.
  25411. </summary>
  25412. <remarks>
  25413. <para>Matches messages that have all of the specified keywords set.</para>
  25414. <note type="info">A keyword is a user-defined message flag.</note>
  25415. </remarks>
  25416. <returns>A <see cref="T:MailKit.Search.SearchQuery"/>.</returns>
  25417. <param name="keywords">The keywords.</param>
  25418. <exception cref="T:System.ArgumentNullException">
  25419. <paramref name="keywords"/> is <c>null</c>.
  25420. </exception>
  25421. <exception cref="T:System.ArgumentException">
  25422. <para>One or more of the <paramref name="keywords"/> is <c>null</c> or empty.</para>
  25423. <para>-or-</para>
  25424. <para>No keywords were given.</para>
  25425. </exception>
  25426. </member>
  25427. <member name="M:MailKit.Search.SearchQuery.NotKeyword(System.String)">
  25428. <summary>
  25429. Match messages that do not have the specified keyword set.
  25430. </summary>
  25431. <remarks>
  25432. <para>Matches messages that do not have the specified keyword set.</para>
  25433. <note type="info">A keyword is a user-defined message flag.</note>
  25434. </remarks>
  25435. <returns>A <see cref="T:MailKit.Search.TextSearchQuery"/>.</returns>
  25436. <param name="keyword">The keyword.</param>
  25437. <exception cref="T:System.ArgumentNullException">
  25438. <paramref name="keyword"/> is <c>null</c>.
  25439. </exception>
  25440. <exception cref="T:System.ArgumentException">
  25441. <paramref name="keyword"/> is empty.
  25442. </exception>
  25443. </member>
  25444. <member name="M:MailKit.Search.SearchQuery.NotKeywords(System.Collections.Generic.IEnumerable{System.String})">
  25445. <summary>
  25446. Match messages that do not have any of the specified keywords set.
  25447. </summary>
  25448. <remarks>
  25449. <para>Matches messages that do not have any of the specified keywords set.</para>
  25450. <note type="info">A keyword is a user-defined message flag.</note>
  25451. </remarks>
  25452. <returns>A <see cref="T:MailKit.Search.SearchQuery"/>.</returns>
  25453. <param name="keywords">The keywords.</param>
  25454. <exception cref="T:System.ArgumentNullException">
  25455. <paramref name="keywords"/> is <c>null</c>.
  25456. </exception>
  25457. <exception cref="T:System.ArgumentException">
  25458. <para>One or more of the <paramref name="keywords"/> is <c>null</c> or empty.</para>
  25459. <para>-or-</para>
  25460. <para>No keywords were given.</para>
  25461. </exception>
  25462. </member>
  25463. <member name="M:MailKit.Search.SearchQuery.HeaderContains(System.String,System.String)">
  25464. <summary>
  25465. Match messages where the specified header contains the specified text.
  25466. </summary>
  25467. <remarks>
  25468. Matches messages where the specified header contains the specified text.
  25469. </remarks>
  25470. <returns>A <see cref="T:MailKit.Search.HeaderSearchQuery"/>.</returns>
  25471. <param name="field">The header field to match against.</param>
  25472. <param name="text">The text to match against.</param>
  25473. <exception cref="T:System.ArgumentNullException">
  25474. <para><paramref name="field"/> is <c>null</c>.</para>
  25475. <para>-or-</para>
  25476. <para><paramref name="text"/> is <c>null</c>.</para>
  25477. </exception>
  25478. <exception cref="T:System.ArgumentException">
  25479. <paramref name="field"/> is empty.
  25480. </exception>
  25481. </member>
  25482. <member name="M:MailKit.Search.SearchQuery.LargerThan(System.Int32)">
  25483. <summary>
  25484. Match messages that are larger than the specified number of octets.
  25485. </summary>
  25486. <remarks>
  25487. Matches messages that are larger than the specified number of octets.
  25488. </remarks>
  25489. <returns>A <see cref="T:MailKit.Search.NumericSearchQuery"/>.</returns>
  25490. <param name="octets">The number of octets.</param>
  25491. <exception cref="T:System.ArgumentOutOfRangeException">
  25492. <paramref name="octets"/> is a negative value.
  25493. </exception>
  25494. </member>
  25495. <member name="M:MailKit.Search.SearchQuery.MessageContains(System.String)">
  25496. <summary>
  25497. Match messages where the raw message contains the specified text.
  25498. </summary>
  25499. <remarks>
  25500. Matches messages where the raw message contains the specified text.
  25501. </remarks>
  25502. <returns>A <see cref="T:MailKit.Search.TextSearchQuery"/>.</returns>
  25503. <param name="text">The text to match against.</param>
  25504. <exception cref="T:System.ArgumentNullException">
  25505. <paramref name="text"/> is <c>null</c>.
  25506. </exception>
  25507. <exception cref="T:System.ArgumentException">
  25508. <paramref name="text"/> is empty.
  25509. </exception>
  25510. </member>
  25511. <member name="F:MailKit.Search.SearchQuery.New">
  25512. <summary>
  25513. Match messages with the <see cref="F:MailKit.MessageFlags.Recent"/> flag set but not the <see cref="F:MailKit.MessageFlags.Seen"/>.
  25514. </summary>
  25515. <remarks>
  25516. Matches messages with the <see cref="F:MailKit.MessageFlags.Recent"/> flag set but not the <see cref="F:MailKit.MessageFlags.Seen"/>.
  25517. </remarks>
  25518. </member>
  25519. <member name="M:MailKit.Search.SearchQuery.Not(MailKit.Search.SearchQuery)">
  25520. <summary>
  25521. Create a logical negation of the specified expression.
  25522. </summary>
  25523. <remarks>
  25524. Creates a logical negation of the specified expression.
  25525. </remarks>
  25526. <returns>A <see cref="T:MailKit.Search.UnarySearchQuery"/>.</returns>
  25527. <param name="expr">The expression</param>
  25528. <exception cref="T:System.ArgumentNullException">
  25529. <paramref name="expr"/> is <c>null</c>.
  25530. </exception>
  25531. </member>
  25532. <member name="F:MailKit.Search.SearchQuery.NotAnswered">
  25533. <summary>
  25534. Match messages that do not have the <see cref="F:MailKit.MessageFlags.Answered"/> flag set.
  25535. </summary>
  25536. <remarks>
  25537. Matches messages that do not have the <see cref="F:MailKit.MessageFlags.Answered"/> flag set.
  25538. </remarks>
  25539. </member>
  25540. <member name="F:MailKit.Search.SearchQuery.NotDeleted">
  25541. <summary>
  25542. Match messages that do not have the <see cref="F:MailKit.MessageFlags.Deleted"/> flag set.
  25543. </summary>
  25544. <remarks>
  25545. Matches messages that do not have the <see cref="F:MailKit.MessageFlags.Deleted"/> flag set.
  25546. </remarks>
  25547. </member>
  25548. <member name="F:MailKit.Search.SearchQuery.NotDraft">
  25549. <summary>
  25550. Match messages that do not have the <see cref="F:MailKit.MessageFlags.Draft"/> flag set.
  25551. </summary>
  25552. <remarks>
  25553. Matches messages that do not have the <see cref="F:MailKit.MessageFlags.Draft"/> flag set.
  25554. </remarks>
  25555. </member>
  25556. <member name="F:MailKit.Search.SearchQuery.NotFlagged">
  25557. <summary>
  25558. Match messages that do not have the <see cref="F:MailKit.MessageFlags.Flagged"/> flag set.
  25559. </summary>
  25560. <remarks>
  25561. Matches messages that do not have the <see cref="F:MailKit.MessageFlags.Flagged"/> flag set.
  25562. </remarks>
  25563. </member>
  25564. <member name="F:MailKit.Search.SearchQuery.NotRecent">
  25565. <summary>
  25566. Match messages that do not have the <see cref="F:MailKit.MessageFlags.Recent"/> flag set.
  25567. </summary>
  25568. <remarks>
  25569. Matches messages that do not have the <see cref="F:MailKit.MessageFlags.Recent"/> flag set.
  25570. </remarks>
  25571. </member>
  25572. <member name="F:MailKit.Search.SearchQuery.NotSeen">
  25573. <summary>
  25574. Match messages that do not have the <see cref="F:MailKit.MessageFlags.Seen"/> flag set.
  25575. </summary>
  25576. <remarks>
  25577. Matches messages that do not have the <see cref="F:MailKit.MessageFlags.Seen"/> flag set.
  25578. </remarks>
  25579. </member>
  25580. <member name="F:MailKit.Search.SearchQuery.Old">
  25581. <summary>
  25582. Match messages that do not have the <see cref="F:MailKit.MessageFlags.Recent"/> flag set.
  25583. </summary>
  25584. <remarks>
  25585. Matches messages that do not have the <see cref="F:MailKit.MessageFlags.Recent"/> flag set.
  25586. </remarks>
  25587. </member>
  25588. <member name="M:MailKit.Search.SearchQuery.OlderThan(System.Int32)">
  25589. <summary>
  25590. Match messages older than the specified number of seconds.
  25591. </summary>
  25592. <remarks>
  25593. Matches messages older than the specified number of seconds.
  25594. </remarks>
  25595. <returns>A <see cref="T:MailKit.Search.NumericSearchQuery"/>.</returns>
  25596. <param name="seconds">The number of seconds.</param>
  25597. <exception cref="T:System.ArgumentOutOfRangeException">
  25598. The number of seconds cannot be less than <c>1</c>.
  25599. </exception>
  25600. </member>
  25601. <member name="M:MailKit.Search.SearchQuery.Or(MailKit.Search.SearchQuery,MailKit.Search.SearchQuery)">
  25602. <summary>
  25603. Create a conditional OR operation.
  25604. </summary>
  25605. <remarks>
  25606. A conditional OR operation only evaluates the second operand if the first operand evaluates to false.
  25607. </remarks>
  25608. <returns>A <see cref="T:MailKit.Search.BinarySearchQuery"/> representing the conditional OR operation.</returns>
  25609. <param name="left">The first operand.</param>
  25610. <param name="right">The second operand.</param>
  25611. <exception cref="T:System.ArgumentNullException">
  25612. <para><paramref name="left"/> is <c>null</c>.</para>
  25613. <para>-or-</para>
  25614. <para><paramref name="right"/> is <c>null</c>.</para>
  25615. </exception>
  25616. </member>
  25617. <member name="M:MailKit.Search.SearchQuery.Or(MailKit.Search.SearchQuery)">
  25618. <summary>
  25619. Create a conditional OR operation.
  25620. </summary>
  25621. <remarks>
  25622. A conditional OR operation only evaluates the second operand if the first operand evaluates to true.
  25623. </remarks>
  25624. <returns>A <see cref="T:MailKit.Search.BinarySearchQuery"/> representing the conditional AND operation.</returns>
  25625. <param name="expr">An additional query to execute.</param>
  25626. <exception cref="T:System.ArgumentNullException">
  25627. <paramref name="expr"/> is <c>null</c>.
  25628. </exception>
  25629. </member>
  25630. <member name="F:MailKit.Search.SearchQuery.Recent">
  25631. <summary>
  25632. Match messages with the <see cref="F:MailKit.MessageFlags.Recent"/> flag set.
  25633. </summary>
  25634. <remarks>
  25635. Matches messages with the <see cref="F:MailKit.MessageFlags.Recent"/> flag set.
  25636. </remarks>
  25637. </member>
  25638. <member name="F:MailKit.Search.SearchQuery.Seen">
  25639. <summary>
  25640. Match messages with the <see cref="F:MailKit.MessageFlags.Seen"/> flag set.
  25641. </summary>
  25642. <remarks>
  25643. Matches messages with the <see cref="F:MailKit.MessageFlags.Seen"/> flag set.
  25644. </remarks>
  25645. </member>
  25646. <member name="M:MailKit.Search.SearchQuery.SentAfter(System.DateTime)">
  25647. <summary>
  25648. Match messages that were sent on or after the specified date.
  25649. </summary>
  25650. <remarks>
  25651. <para>Matches messages that were sent on or after the specified date.</para>
  25652. <para>The resolution of this search query does not include the time.</para>
  25653. </remarks>
  25654. <returns>A <see cref="T:MailKit.Search.DateSearchQuery"/>.</returns>
  25655. <param name="date">The date.</param>
  25656. </member>
  25657. <member name="M:MailKit.Search.SearchQuery.SentBefore(System.DateTime)">
  25658. <summary>
  25659. Match messages that were sent before the specified date.
  25660. </summary>
  25661. <remarks>
  25662. <para>Matches messages that were sent before the specified date.</para>
  25663. <note type="note">The resolution of this search query does not include the time.</note>
  25664. </remarks>
  25665. <returns>A <see cref="T:MailKit.Search.DateSearchQuery"/>.</returns>
  25666. <param name="date">The date.</param>
  25667. </member>
  25668. <member name="M:MailKit.Search.SearchQuery.SentOn(System.DateTime)">
  25669. <summary>
  25670. Match messages that were sent on the specified date.
  25671. </summary>
  25672. <remarks>
  25673. <para>Matches messages that were sent on the specified date.</para>
  25674. <note type="note">The resolution of this search query does not include the time.</note>
  25675. </remarks>
  25676. <returns>A <see cref="T:MailKit.Search.DateSearchQuery"/>.</returns>
  25677. <param name="date">The date.</param>
  25678. </member>
  25679. <member name="M:MailKit.Search.SearchQuery.SentSince(System.DateTime)">
  25680. <summary>
  25681. Match messages that were sent since the specified date.
  25682. </summary>
  25683. <remarks>
  25684. <para>Matches messages that were sent since the specified date.</para>
  25685. <note type="note">The resolution of this search query does not include the time.</note>
  25686. </remarks>
  25687. <returns>A <see cref="T:MailKit.Search.DateSearchQuery"/>.</returns>
  25688. <param name="date">The date.</param>
  25689. </member>
  25690. <member name="M:MailKit.Search.SearchQuery.SmallerThan(System.Int32)">
  25691. <summary>
  25692. Match messages that are smaller than the specified number of octets.
  25693. </summary>
  25694. <remarks>
  25695. Matches messages that are smaller than the specified number of octets.
  25696. </remarks>
  25697. <returns>A <see cref="T:MailKit.Search.NumericSearchQuery"/>.</returns>
  25698. <param name="octets">The number of octets.</param>
  25699. <exception cref="T:System.ArgumentOutOfRangeException">
  25700. <paramref name="octets"/> is a negative value.
  25701. </exception>
  25702. </member>
  25703. <member name="M:MailKit.Search.SearchQuery.SubjectContains(System.String)">
  25704. <summary>
  25705. Match messages where the Subject header contains the specified text.
  25706. </summary>
  25707. <remarks>
  25708. Matches messages where the Subject header contains the specified text.
  25709. </remarks>
  25710. <returns>A <see cref="T:MailKit.Search.TextSearchQuery"/>.</returns>
  25711. <param name="text">The text to match against.</param>
  25712. <exception cref="T:System.ArgumentNullException">
  25713. <paramref name="text"/> is <c>null</c>.
  25714. </exception>
  25715. <exception cref="T:System.ArgumentException">
  25716. <paramref name="text"/> is empty.
  25717. </exception>
  25718. </member>
  25719. <member name="M:MailKit.Search.SearchQuery.ToContains(System.String)">
  25720. <summary>
  25721. Match messages where the To header contains the specified text.
  25722. </summary>
  25723. <remarks>
  25724. Matches messages where the To header contains the specified text.
  25725. </remarks>
  25726. <returns>A <see cref="T:MailKit.Search.TextSearchQuery"/>.</returns>
  25727. <param name="text">The text to match against.</param>
  25728. <exception cref="T:System.ArgumentNullException">
  25729. <paramref name="text"/> is <c>null</c>.
  25730. </exception>
  25731. <exception cref="T:System.ArgumentException">
  25732. <paramref name="text"/> is empty.
  25733. </exception>
  25734. </member>
  25735. <member name="M:MailKit.Search.SearchQuery.Uids(System.Collections.Generic.IList{MailKit.UniqueId})">
  25736. <summary>
  25737. Limit the search query to messages with the specified unique identifiers.
  25738. </summary>
  25739. <remarks>
  25740. Limits the search query to messages with the specified unique identifiers.
  25741. </remarks>
  25742. <returns>A <see cref="T:MailKit.Search.UidSearchQuery"/>.</returns>
  25743. <param name="uids">The unique identifiers.</param>
  25744. <exception cref="T:System.ArgumentNullException">
  25745. <paramref name="uids"/> is <c>null</c>.
  25746. </exception>
  25747. <exception cref="T:System.ArgumentException">
  25748. <paramref name="uids"/> is empty.
  25749. </exception>
  25750. </member>
  25751. <member name="M:MailKit.Search.SearchQuery.YoungerThan(System.Int32)">
  25752. <summary>
  25753. Match messages younger than the specified number of seconds.
  25754. </summary>
  25755. <remarks>
  25756. Matches messages younger than the specified number of seconds.
  25757. </remarks>
  25758. <returns>A <see cref="T:MailKit.Search.NumericSearchQuery"/>.</returns>
  25759. <param name="seconds">The number of seconds.</param>
  25760. <exception cref="T:System.ArgumentOutOfRangeException">
  25761. The number of seconds cannot be less than <c>1</c>.
  25762. </exception>
  25763. </member>
  25764. <member name="M:MailKit.Search.SearchQuery.GMailMessageId(System.UInt64)">
  25765. <summary>
  25766. Match messages that have the specified GMail message identifier.
  25767. </summary>
  25768. <remarks>
  25769. This search term can only be used with GMail.
  25770. </remarks>
  25771. <returns>A <see cref="T:MailKit.Search.NumericSearchQuery"/>.</returns>
  25772. <param name="id">The GMail message identifier.</param>
  25773. </member>
  25774. <member name="M:MailKit.Search.SearchQuery.GMailThreadId(System.UInt64)">
  25775. <summary>
  25776. Match messages belonging to the specified GMail thread.
  25777. </summary>
  25778. <remarks>
  25779. This search term can only be used with GMail.
  25780. </remarks>
  25781. <returns>A <see cref="T:MailKit.Search.NumericSearchQuery"/>.</returns>
  25782. <param name="thread">The GMail thread.</param>
  25783. </member>
  25784. <member name="M:MailKit.Search.SearchQuery.HasGMailLabel(System.String)">
  25785. <summary>
  25786. Match messages that have the specified GMail label.
  25787. </summary>
  25788. <remarks>
  25789. This search term can only be used with GMail.
  25790. </remarks>
  25791. <returns>A <see cref="T:MailKit.Search.TextSearchQuery"/>.</returns>
  25792. <param name="label">The GMail label.</param>
  25793. <exception cref="T:System.ArgumentNullException">
  25794. <paramref name="label"/> is <c>null</c>.
  25795. </exception>
  25796. <exception cref="T:System.ArgumentException">
  25797. <paramref name="label"/> is empty.
  25798. </exception>
  25799. </member>
  25800. <member name="M:MailKit.Search.SearchQuery.GMailRawSearch(System.String)">
  25801. <summary>
  25802. Match messages using the GMail search expression.
  25803. </summary>
  25804. <remarks>
  25805. This search term can only be used with GMail.
  25806. </remarks>
  25807. <returns>A <see cref="T:MailKit.Search.TextSearchQuery"/>.</returns>
  25808. <param name="expression">The raw GMail search text.</param>
  25809. <exception cref="T:System.ArgumentNullException">
  25810. <paramref name="expression"/> is <c>null</c>.
  25811. </exception>
  25812. <exception cref="T:System.ArgumentException">
  25813. <paramref name="expression"/> is empty.
  25814. </exception>
  25815. </member>
  25816. <member name="T:MailKit.Search.SearchResults">
  25817. <summary>
  25818. The results of a search.
  25819. </summary>
  25820. <remarks>
  25821. The results of a search.
  25822. </remarks>
  25823. </member>
  25824. <member name="M:MailKit.Search.SearchResults.#ctor(MailKit.Search.SortOrder)">
  25825. <summary>
  25826. Initializes a new instance of the <see cref="T:MailKit.Search.SearchResults"/> class.
  25827. </summary>
  25828. <remarks>
  25829. Creates a new <see cref="T:MailKit.Search.SearchResults"/>.
  25830. </remarks>
  25831. <param name="order">The sort-order to use for the unique identifiers.</param>
  25832. </member>
  25833. <member name="P:MailKit.Search.SearchResults.UniqueIds">
  25834. <summary>
  25835. Get or set the unique identifiers of the messages that matched the search query.
  25836. </summary>
  25837. <remarks>
  25838. Gets or sets the unique identifiers of the messages that matched the search query.
  25839. </remarks>
  25840. <value>The unique identifiers.</value>
  25841. </member>
  25842. <member name="P:MailKit.Search.SearchResults.Count">
  25843. <summary>
  25844. Get or set the number of messages that matched the search query.
  25845. </summary>
  25846. <remarks>
  25847. Gets or sets the number of messages that matched the search query.
  25848. </remarks>
  25849. <value>The count.</value>
  25850. </member>
  25851. <member name="P:MailKit.Search.SearchResults.Min">
  25852. <summary>
  25853. Get or set the minimum unique identifier that matched the search query.
  25854. </summary>
  25855. <remarks>
  25856. Gets or sets the minimum unique identifier that matched the search query.
  25857. </remarks>
  25858. <value>The minimum unique identifier.</value>
  25859. </member>
  25860. <member name="P:MailKit.Search.SearchResults.Max">
  25861. <summary>
  25862. Get or set the maximum unique identifier that matched the search query.
  25863. </summary>
  25864. <remarks>
  25865. Gets or sets the maximum unique identifier that matched the search query.
  25866. </remarks>
  25867. <value>The maximum unique identifier.</value>
  25868. </member>
  25869. <member name="P:MailKit.Search.SearchResults.ModSeq">
  25870. <summary>
  25871. Gets or sets the mod-sequence identifier of the messages that matched the search query.
  25872. </summary>
  25873. <remarks>
  25874. Gets or sets the mod-sequence identifier of the messages that matched the search query.
  25875. </remarks>
  25876. <value>The mod-sequence identifier.</value>
  25877. </member>
  25878. <member name="P:MailKit.Search.SearchResults.Relevancy">
  25879. <summary>
  25880. Gets or sets the relevancy scores of the messages that matched the search query.
  25881. </summary>
  25882. <remarks>
  25883. Gets or sets the relevancy scores of the messages that matched the search query.
  25884. </remarks>
  25885. <value>The relevancy scores.</value>
  25886. </member>
  25887. <member name="T:MailKit.Search.SearchTerm">
  25888. <summary>
  25889. A search term.
  25890. </summary>
  25891. <remarks>
  25892. The search term as used by <see cref="T:MailKit.Search.SearchQuery"/>.
  25893. </remarks>
  25894. </member>
  25895. <member name="F:MailKit.Search.SearchTerm.All">
  25896. <summary>
  25897. A search term that matches all messages.
  25898. </summary>
  25899. </member>
  25900. <member name="F:MailKit.Search.SearchTerm.And">
  25901. <summary>
  25902. A search term that logically combines 2 or more other
  25903. search expressions such that messages must match both
  25904. expressions.
  25905. </summary>
  25906. </member>
  25907. <member name="F:MailKit.Search.SearchTerm.Annotation">
  25908. <summary>
  25909. A search term that matches messages that have the specified annotation.
  25910. </summary>
  25911. </member>
  25912. <member name="F:MailKit.Search.SearchTerm.Answered">
  25913. <summary>
  25914. A search term that matches answered messages.
  25915. </summary>
  25916. </member>
  25917. <member name="F:MailKit.Search.SearchTerm.BccContains">
  25918. <summary>
  25919. A search term that matches messages that contain a specified
  25920. string within the <c>Bcc</c> header.
  25921. </summary>
  25922. </member>
  25923. <member name="F:MailKit.Search.SearchTerm.BodyContains">
  25924. <summary>
  25925. A search term that matches messages that contain a specified
  25926. string within the body of the message.
  25927. </summary>
  25928. </member>
  25929. <member name="F:MailKit.Search.SearchTerm.CcContains">
  25930. <summary>
  25931. A search term that matches messages that contain a specified
  25932. string within the <c>Cc</c> header.
  25933. </summary>
  25934. </member>
  25935. <member name="F:MailKit.Search.SearchTerm.Deleted">
  25936. <summary>
  25937. A search term that matches deleted messages.
  25938. </summary>
  25939. </member>
  25940. <member name="F:MailKit.Search.SearchTerm.DeliveredAfter">
  25941. <summary>
  25942. A search term that matches messages delivered after a specified date.
  25943. </summary>
  25944. </member>
  25945. <member name="F:MailKit.Search.SearchTerm.DeliveredBefore">
  25946. <summary>
  25947. A search term that matches messages delivered before a specified date.
  25948. </summary>
  25949. </member>
  25950. <member name="F:MailKit.Search.SearchTerm.DeliveredOn">
  25951. <summary>
  25952. A search term that matches messages delivered on a specified date.
  25953. </summary>
  25954. </member>
  25955. <member name="F:MailKit.Search.SearchTerm.Draft">
  25956. <summary>
  25957. A search term that matches draft messages.
  25958. </summary>
  25959. </member>
  25960. <member name="F:MailKit.Search.SearchTerm.Filter">
  25961. <summary>
  25962. A search term that makes use of a predefined filter.
  25963. </summary>
  25964. </member>
  25965. <member name="F:MailKit.Search.SearchTerm.Flagged">
  25966. <summary>
  25967. A search term that matches flagged messages.
  25968. </summary>
  25969. </member>
  25970. <member name="F:MailKit.Search.SearchTerm.FromContains">
  25971. <summary>
  25972. A search term that matches messages that contain a specified
  25973. string within the <c>From</c> header.
  25974. </summary>
  25975. </member>
  25976. <member name="F:MailKit.Search.SearchTerm.Fuzzy">
  25977. <summary>
  25978. A search term that modifies another search expression to allow
  25979. fuzzy matching.
  25980. </summary>
  25981. </member>
  25982. <member name="F:MailKit.Search.SearchTerm.HeaderContains">
  25983. <summary>
  25984. A search term that matches messages that contain a specified
  25985. string within a particular header.
  25986. </summary>
  25987. </member>
  25988. <member name="F:MailKit.Search.SearchTerm.Keyword">
  25989. <summary>
  25990. A search term that matches messages that contain a specified
  25991. keyword.
  25992. </summary>
  25993. </member>
  25994. <member name="F:MailKit.Search.SearchTerm.LargerThan">
  25995. <summary>
  25996. A search term that matches messages that are larger than a
  25997. specified number of bytes.
  25998. </summary>
  25999. </member>
  26000. <member name="F:MailKit.Search.SearchTerm.MessageContains">
  26001. <summary>
  26002. A search term that matches messages that contain a specified
  26003. string anywhere within the message.
  26004. </summary>
  26005. </member>
  26006. <member name="F:MailKit.Search.SearchTerm.ModSeq">
  26007. <summary>
  26008. A search term that matches messages that have the specified
  26009. modification sequence value.
  26010. </summary>
  26011. </member>
  26012. <member name="F:MailKit.Search.SearchTerm.New">
  26013. <summary>
  26014. A search term that matches new messages.
  26015. </summary>
  26016. </member>
  26017. <member name="F:MailKit.Search.SearchTerm.Not">
  26018. <summary>
  26019. A search term that modifies another search expression such that
  26020. messages must match the logical inverse of the expression.
  26021. </summary>
  26022. </member>
  26023. <member name="F:MailKit.Search.SearchTerm.NotAnswered">
  26024. <summary>
  26025. A search term that matches messages that have not been answered.
  26026. </summary>
  26027. </member>
  26028. <member name="F:MailKit.Search.SearchTerm.NotDeleted">
  26029. <summary>
  26030. A search term that matches messages that have not been deleted.
  26031. </summary>
  26032. </member>
  26033. <member name="F:MailKit.Search.SearchTerm.NotDraft">
  26034. <summary>
  26035. A search term that matches messages that are not drafts.
  26036. </summary>
  26037. </member>
  26038. <member name="F:MailKit.Search.SearchTerm.NotFlagged">
  26039. <summary>
  26040. A search term that matches messages that have not been flagged.
  26041. </summary>
  26042. </member>
  26043. <member name="F:MailKit.Search.SearchTerm.NotKeyword">
  26044. <summary>
  26045. A search term that matches messages that do not contain a specified
  26046. keyword.
  26047. </summary>
  26048. </member>
  26049. <member name="F:MailKit.Search.SearchTerm.NotRecent">
  26050. <summary>
  26051. A search term that matches messages that are not recent.
  26052. </summary>
  26053. </member>
  26054. <member name="F:MailKit.Search.SearchTerm.NotSeen">
  26055. <summary>
  26056. A search term that matches messages that have not been seen.
  26057. </summary>
  26058. </member>
  26059. <member name="F:MailKit.Search.SearchTerm.Older">
  26060. <summary>
  26061. A search term that matches messages that are older than a specified date.
  26062. </summary>
  26063. </member>
  26064. <member name="F:MailKit.Search.SearchTerm.Or">
  26065. <summary>
  26066. A search term that logically combines 2 or more other
  26067. search expressions such that messages only need to match
  26068. one of the expressions.
  26069. </summary>
  26070. </member>
  26071. <member name="F:MailKit.Search.SearchTerm.Recent">
  26072. <summary>
  26073. A search term that matches messages that are recent.
  26074. </summary>
  26075. </member>
  26076. <member name="F:MailKit.Search.SearchTerm.Seen">
  26077. <summary>
  26078. A search term that matches messages that have been seen.
  26079. </summary>
  26080. </member>
  26081. <member name="F:MailKit.Search.SearchTerm.SentBefore">
  26082. <summary>
  26083. A search term that matches messages that were sent before a specified date.
  26084. </summary>
  26085. </member>
  26086. <member name="F:MailKit.Search.SearchTerm.SentOn">
  26087. <summary>
  26088. A search term that matches messages that were sent on a specified date.
  26089. </summary>
  26090. </member>
  26091. <member name="F:MailKit.Search.SearchTerm.SentSince">
  26092. <summary>
  26093. A search term that matches messages that were sent since a specified date.
  26094. </summary>
  26095. </member>
  26096. <member name="F:MailKit.Search.SearchTerm.SmallerThan">
  26097. <summary>
  26098. A search term that matches messages that are smaller than a
  26099. specified number of bytes.
  26100. </summary>
  26101. </member>
  26102. <member name="F:MailKit.Search.SearchTerm.SubjectContains">
  26103. <summary>
  26104. A search term that matches messages that contain a specified
  26105. string within the <c>Subject</c> header.
  26106. </summary>
  26107. </member>
  26108. <member name="F:MailKit.Search.SearchTerm.ToContains">
  26109. <summary>
  26110. A search term that matches messages that contain a specified
  26111. string within the <c>To</c> header.
  26112. </summary>
  26113. </member>
  26114. <member name="F:MailKit.Search.SearchTerm.Uid">
  26115. <summary>
  26116. A search term that matches messages included within a specified
  26117. set of unique identifiers.
  26118. </summary>
  26119. </member>
  26120. <member name="F:MailKit.Search.SearchTerm.Younger">
  26121. <summary>
  26122. A search term that matches messages that are younger than a specified date.
  26123. </summary>
  26124. </member>
  26125. <member name="F:MailKit.Search.SearchTerm.GMailMessageId">
  26126. <summary>
  26127. A search term that matches messages with a specified GMail message identifier.
  26128. </summary>
  26129. </member>
  26130. <member name="F:MailKit.Search.SearchTerm.GMailThreadId">
  26131. <summary>
  26132. A search term that matches messages with a specified GMail thread (conversation)
  26133. identifier.
  26134. </summary>
  26135. </member>
  26136. <member name="F:MailKit.Search.SearchTerm.GMailLabels">
  26137. <summary>
  26138. A search term that matches messages with the specified GMail labels.
  26139. </summary>
  26140. </member>
  26141. <member name="F:MailKit.Search.SearchTerm.GMailRaw">
  26142. <summary>
  26143. A search term that uses the GMail search syntax.
  26144. </summary>
  26145. </member>
  26146. <member name="T:MailKit.Search.SortOrder">
  26147. <summary>
  26148. An enumeration of sort orders.
  26149. </summary>
  26150. <remarks>
  26151. An enumeration of sort orders.
  26152. </remarks>
  26153. </member>
  26154. <member name="F:MailKit.Search.SortOrder.None">
  26155. <summary>
  26156. No sorting order.
  26157. </summary>
  26158. </member>
  26159. <member name="F:MailKit.Search.SortOrder.Ascending">
  26160. <summary>
  26161. Sort in ascending order.
  26162. </summary>
  26163. </member>
  26164. <member name="F:MailKit.Search.SortOrder.Descending">
  26165. <summary>
  26166. Sort in descending order.
  26167. </summary>
  26168. </member>
  26169. <member name="T:MailKit.Search.TextSearchQuery">
  26170. <summary>
  26171. A text-based search query.
  26172. </summary>
  26173. <remarks>
  26174. A text-based search query.
  26175. </remarks>
  26176. </member>
  26177. <member name="M:MailKit.Search.TextSearchQuery.#ctor(MailKit.Search.SearchTerm,System.String)">
  26178. <summary>
  26179. Initializes a new instance of the <see cref="T:MailKit.Search.TextSearchQuery"/> class.
  26180. </summary>
  26181. <remarks>
  26182. Creates a new text-based search query.
  26183. </remarks>
  26184. <param name="term">The search term.</param>
  26185. <param name="text">The text to match against.</param>
  26186. <exception cref="T:System.ArgumentNullException">
  26187. <paramref name="text"/> is <c>null</c>.
  26188. </exception>
  26189. <exception cref="T:System.ArgumentException">
  26190. <paramref name="text"/> is empty.
  26191. </exception>
  26192. </member>
  26193. <member name="P:MailKit.Search.TextSearchQuery.Text">
  26194. <summary>
  26195. Gets the text to match against.
  26196. </summary>
  26197. <remarks>
  26198. Gets the text to match against.
  26199. </remarks>
  26200. <value>The text.</value>
  26201. </member>
  26202. <member name="T:MailKit.Search.UidSearchQuery">
  26203. <summary>
  26204. A unique identifier-based search query.
  26205. </summary>
  26206. <remarks>
  26207. A unique identifier-based search query.
  26208. </remarks>
  26209. </member>
  26210. <member name="M:MailKit.Search.UidSearchQuery.#ctor(System.Collections.Generic.IList{MailKit.UniqueId})">
  26211. <summary>
  26212. Initializes a new instance of the <see cref="T:MailKit.Search.UidSearchQuery"/> class.
  26213. </summary>
  26214. <remarks>
  26215. Creates a new unique identifier-based search query.
  26216. </remarks>
  26217. <param name="uids">The unique identifiers to match against.</param>
  26218. <exception cref="T:System.ArgumentNullException">
  26219. <paramref name="uids"/> is <c>null</c>.
  26220. </exception>
  26221. <exception cref="T:System.ArgumentException">
  26222. <paramref name="uids"/> is empty.
  26223. </exception>
  26224. </member>
  26225. <member name="M:MailKit.Search.UidSearchQuery.#ctor(MailKit.UniqueId)">
  26226. <summary>
  26227. Initializes a new instance of the <see cref="T:MailKit.Search.UidSearchQuery"/> class.
  26228. </summary>
  26229. <remarks>
  26230. Creates a new unique identifier-based search query.
  26231. </remarks>
  26232. <param name="uid">The unique identifier to match against.</param>
  26233. <exception cref="T:System.ArgumentException">
  26234. <paramref name="uid"/> is an invalid unique identifier.
  26235. </exception>
  26236. </member>
  26237. <member name="P:MailKit.Search.UidSearchQuery.Uids">
  26238. <summary>
  26239. Gets the unique identifiers to match against.
  26240. </summary>
  26241. <remarks>
  26242. Gets the unique identifiers to match against.
  26243. </remarks>
  26244. <value>The unique identifiers.</value>
  26245. </member>
  26246. <member name="T:MailKit.Search.UnarySearchQuery">
  26247. <summary>
  26248. A unary search query such as a NOT expression.
  26249. </summary>
  26250. <remarks>
  26251. A unary search query such as a NOT expression.
  26252. </remarks>
  26253. </member>
  26254. <member name="M:MailKit.Search.UnarySearchQuery.#ctor(MailKit.Search.SearchTerm,MailKit.Search.SearchQuery)">
  26255. <summary>
  26256. Initializes a new instance of the <see cref="T:MailKit.Search.UnarySearchQuery"/> class.
  26257. </summary>
  26258. <remarks>
  26259. Creates a new unary search query.
  26260. </remarks>
  26261. <param name="term">The search term.</param>
  26262. <param name="operand">The operand.</param>
  26263. <exception cref="T:System.ArgumentNullException">
  26264. <paramref name="operand"/> is <c>null</c>.
  26265. </exception>
  26266. </member>
  26267. <member name="P:MailKit.Search.UnarySearchQuery.Operand">
  26268. <summary>
  26269. Gets the inner operand.
  26270. </summary>
  26271. <remarks>
  26272. Gets the inner operand.
  26273. </remarks>
  26274. <value>The operand.</value>
  26275. </member>
  26276. <member name="T:MailKit.Security.Ntlm.NtlmFlags">
  26277. <summary>
  26278. The NTLM message header flags.
  26279. </summary>
  26280. <remarks>
  26281. More details here: http://davenport.sourceforge.net/ntlm.html#theNtlmMessageHeaderLayout
  26282. and at https://msdn.microsoft.com/en-us/library/cc236650.aspx
  26283. </remarks>
  26284. </member>
  26285. <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateUnicode">
  26286. <summary>
  26287. Indicates that Unicode strings are supported for use in security buffer data.
  26288. </summary>
  26289. </member>
  26290. <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateOem">
  26291. <summary>
  26292. Indicates that OEM strings are supported for use in security buffer data.
  26293. </summary>
  26294. </member>
  26295. <member name="F:MailKit.Security.Ntlm.NtlmFlags.RequestTarget">
  26296. <summary>
  26297. Requests that the server's authentication realm be included in the Type 2 message.
  26298. </summary>
  26299. </member>
  26300. <member name="F:MailKit.Security.Ntlm.NtlmFlags.R10">
  26301. <summary>
  26302. This flag's usage has not been identified.
  26303. </summary>
  26304. </member>
  26305. <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateSign">
  26306. <summary>
  26307. Specifies that authenticated communication between the client and server should carry a digital signature (message integrity).
  26308. </summary>
  26309. </member>
  26310. <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateSeal">
  26311. <summary>
  26312. Specifies that authenticated communication between the client and server should be encrypted (message confidentiality).
  26313. </summary>
  26314. </member>
  26315. <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateDatagramStyle">
  26316. <summary>
  26317. Indicates that datagram authentication is being used.
  26318. </summary>
  26319. </member>
  26320. <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateLanManagerKey">
  26321. <summary>
  26322. Indicates that the Lan Manager Session Key should be used for signing
  26323. and sealing authenticated communications.
  26324. </summary>
  26325. </member>
  26326. <member name="F:MailKit.Security.Ntlm.NtlmFlags.R9">
  26327. <summary>
  26328. This flag is unused and MUST be zero. (r8)
  26329. </summary>
  26330. </member>
  26331. <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateNtlm">
  26332. <summary>
  26333. Indicates that NTLM authentication is being used.
  26334. </summary>
  26335. </member>
  26336. <member name="F:MailKit.Security.Ntlm.NtlmFlags.R8">
  26337. <summary>
  26338. This flag is unused and MUST be zero. (r8)
  26339. </summary>
  26340. </member>
  26341. <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateAnonymous">
  26342. <summary>
  26343. Sent by the client in the Type 3 message to indicate that an anonymous
  26344. context has been established. This also affects the response fields.
  26345. </summary>
  26346. </member>
  26347. <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateDomainSupplied">
  26348. <summary>
  26349. Sent by the client in the Type 1 message to indicate that the name of the
  26350. domain in which the client workstation has membership is included in the
  26351. message. This is used by the server to determine whether the client is
  26352. eligible for local authentication.
  26353. </summary>
  26354. </member>
  26355. <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateWorkstationSupplied">
  26356. <summary>
  26357. Sent by the client in the Type 1 message to indicate that the client
  26358. workstation's name is included in the message. This is used by the server
  26359. to determine whether the client is eligible for local authentication.
  26360. </summary>
  26361. </member>
  26362. <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateLocalCall">
  26363. <summary>
  26364. Sent by the server to indicate that the server and client are on the same
  26365. machine. Implies that the client may use the established local credentials
  26366. for authentication instead of calculating a response to the challenge.
  26367. </summary>
  26368. </member>
  26369. <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateAlwaysSign">
  26370. <summary>
  26371. Indicates that authenticated communication between the client and server
  26372. should be signed with a "dummy" signature.
  26373. </summary>
  26374. </member>
  26375. <member name="F:MailKit.Security.Ntlm.NtlmFlags.TargetTypeDomain">
  26376. <summary>
  26377. Sent by the server in the Type 2 message to indicate that the target
  26378. authentication realm is a domain.
  26379. </summary>
  26380. </member>
  26381. <member name="F:MailKit.Security.Ntlm.NtlmFlags.TargetTypeServer">
  26382. <summary>
  26383. Sent by the server in the Type 2 message to indicate that the target
  26384. authentication realm is a server.
  26385. </summary>
  26386. </member>
  26387. <member name="F:MailKit.Security.Ntlm.NtlmFlags.TargetTypeShare">
  26388. <summary>
  26389. Sent by the server in the Type 2 message to indicate that the target
  26390. authentication realm is a share. Presumably, this is for share-level
  26391. authentication. Usage is unclear.
  26392. </summary>
  26393. </member>
  26394. <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateNtlm2Key">
  26395. <summary>
  26396. Indicates that the NTLM2 signing and sealing scheme should be used for
  26397. protecting authenticated communications. Note that this refers to a
  26398. particular session security scheme, and is not related to the use of
  26399. NTLMv2 authentication. This flag can, however, have an effect on the
  26400. response calculations.
  26401. </summary>
  26402. </member>
  26403. <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateIdentify">
  26404. <summary>
  26405. This flag's usage has not been identified.
  26406. </summary>
  26407. </member>
  26408. <member name="F:MailKit.Security.Ntlm.NtlmFlags.R5">
  26409. <summary>
  26410. This flag is unused and MUST be zero. (r5)
  26411. </summary>
  26412. </member>
  26413. <member name="F:MailKit.Security.Ntlm.NtlmFlags.RequestNonNTSessionKey">
  26414. <summary>
  26415. Indicates that the LMOWF function should be used to generate a session key.
  26416. </summary>
  26417. </member>
  26418. <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateTargetInfo">
  26419. <summary>
  26420. Sent by the server in the Type 2 message to indicate that it is including
  26421. a Target Information block in the message. The Target Information block
  26422. is used in the calculation of the NTLMv2 response.
  26423. </summary>
  26424. </member>
  26425. <member name="F:MailKit.Security.Ntlm.NtlmFlags.R4">
  26426. <summary>
  26427. This flag is unused and MUST be zero. (r4)
  26428. </summary>
  26429. </member>
  26430. <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateVersion">
  26431. <summary>
  26432. Indicates that the version field is present.
  26433. </summary>
  26434. </member>
  26435. <member name="F:MailKit.Security.Ntlm.NtlmFlags.R3">
  26436. <summary>
  26437. This flag is unused and MUST be zero. (r3)
  26438. </summary>
  26439. </member>
  26440. <member name="F:MailKit.Security.Ntlm.NtlmFlags.R2">
  26441. <summary>
  26442. This flag is unused and MUST be zero. (r2)
  26443. </summary>
  26444. </member>
  26445. <member name="F:MailKit.Security.Ntlm.NtlmFlags.R1">
  26446. <summary>
  26447. This flag is unused and MUST be zero. (r1)
  26448. </summary>
  26449. </member>
  26450. <member name="F:MailKit.Security.Ntlm.NtlmFlags.Negotiate128">
  26451. <summary>
  26452. Indicates that 128-bit encryption is supported.
  26453. </summary>
  26454. </member>
  26455. <member name="F:MailKit.Security.Ntlm.NtlmFlags.NegotiateKeyExchange">
  26456. <summary>
  26457. Indicates that the client will provide an encrypted master key in the
  26458. "Session Key" field of the Type 3 message.
  26459. </summary>
  26460. </member>
  26461. <member name="F:MailKit.Security.Ntlm.NtlmFlags.Negotiate56">
  26462. <summary>
  26463. Indicates that 56-bit encryption is supported.
  26464. </summary>
  26465. </member>
  26466. <member name="T:MailKit.Security.AuthenticationException">
  26467. <summary>
  26468. The exception that is thrown when there is an authentication error.
  26469. </summary>
  26470. <remarks>
  26471. The exception that is thrown when there is an authentication error.
  26472. </remarks>
  26473. </member>
  26474. <member name="M:MailKit.Security.AuthenticationException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  26475. <summary>
  26476. Initializes a new instance of the <see cref="T:MailKit.Security.AuthenticationException"/> class.
  26477. </summary>
  26478. <remarks>
  26479. Creates a new <see cref="T:MailKit.Security.AuthenticationException"/> from the seriaized data.
  26480. </remarks>
  26481. <param name="info">The serialization info.</param>
  26482. <param name="context">The streaming context.</param>
  26483. <exception cref="T:System.ArgumentNullException">
  26484. <paramref name="info"/> is <c>null</c>.
  26485. </exception>
  26486. </member>
  26487. <member name="M:MailKit.Security.AuthenticationException.#ctor(System.String,System.Exception)">
  26488. <summary>
  26489. Initializes a new instance of the <see cref="T:MailKit.Security.AuthenticationException"/> class.
  26490. </summary>
  26491. <remarks>
  26492. Creates a new <see cref="T:MailKit.Security.AuthenticationException"/>.
  26493. </remarks>
  26494. <param name="message">The error message.</param>
  26495. <param name="innerException">An inner exception.</param>
  26496. </member>
  26497. <member name="M:MailKit.Security.AuthenticationException.#ctor(System.String)">
  26498. <summary>
  26499. Initializes a new instance of the <see cref="T:MailKit.Security.AuthenticationException"/> class.
  26500. </summary>
  26501. <remarks>
  26502. Creates a new <see cref="T:MailKit.Security.AuthenticationException"/>.
  26503. </remarks>
  26504. <param name="message">The error message.</param>
  26505. </member>
  26506. <member name="M:MailKit.Security.AuthenticationException.#ctor">
  26507. <summary>
  26508. Initializes a new instance of the <see cref="T:MailKit.Security.AuthenticationException"/> class.
  26509. </summary>
  26510. <remarks>
  26511. Creates a new <see cref="T:MailKit.Security.AuthenticationException"/>.
  26512. </remarks>
  26513. </member>
  26514. <member name="T:MailKit.Security.SaslErrorCode">
  26515. <summary>
  26516. An enumeration of the possible error codes that may be reported by a <see cref="T:MailKit.Security.SaslException"/>.
  26517. </summary>
  26518. <remarks>
  26519. An enumeration of the possible error codes that may be reported by a <see cref="T:MailKit.Security.SaslException"/>.
  26520. </remarks>
  26521. </member>
  26522. <member name="F:MailKit.Security.SaslErrorCode.ChallengeTooLong">
  26523. <summary>
  26524. The server's challenge was too long.
  26525. </summary>
  26526. </member>
  26527. <member name="F:MailKit.Security.SaslErrorCode.IncompleteChallenge">
  26528. <summary>
  26529. The server's response contained an incomplete challenge.
  26530. </summary>
  26531. </member>
  26532. <member name="F:MailKit.Security.SaslErrorCode.InvalidChallenge">
  26533. <summary>
  26534. The server's challenge was invalid.
  26535. </summary>
  26536. </member>
  26537. <member name="F:MailKit.Security.SaslErrorCode.MissingChallenge">
  26538. <summary>
  26539. The server's response did not contain a challenge.
  26540. </summary>
  26541. </member>
  26542. <member name="F:MailKit.Security.SaslErrorCode.IncorrectHash">
  26543. <summary>
  26544. The server's challenge contained an incorrect hash.
  26545. </summary>
  26546. </member>
  26547. <member name="T:MailKit.Security.SaslException">
  26548. <summary>
  26549. A SASL authentication exception.
  26550. </summary>
  26551. <remarks>
  26552. Typically indicates an error while parsing a server's challenge token.
  26553. </remarks>
  26554. </member>
  26555. <member name="M:MailKit.Security.SaslException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  26556. <summary>
  26557. Initializes a new instance of the <see cref="T:MailKit.Security.SaslException"/> class.
  26558. </summary>
  26559. <remarks>
  26560. Deserializes a <see cref="T:MailKit.Security.SaslException"/>.
  26561. </remarks>
  26562. <param name="info">The serialization info.</param>
  26563. <param name="context">The streaming context.</param>
  26564. </member>
  26565. <member name="M:MailKit.Security.SaslException.#ctor(System.String,MailKit.Security.SaslErrorCode,System.String)">
  26566. <summary>
  26567. Initializes a new instance of the <see cref="T:MailKit.Security.SaslException"/> class.
  26568. </summary>
  26569. <remarks>
  26570. Creates a new <see cref="T:MailKit.Security.SaslException"/>.
  26571. </remarks>
  26572. <param name="mechanism">The SASL mechanism.</param>
  26573. <param name="code">The error code.</param>
  26574. <param name="message">The error message.</param>
  26575. <exception cref="T:System.ArgumentNullException">
  26576. <paramref name="mechanism"/> is <c>null</c>.
  26577. </exception>
  26578. </member>
  26579. <member name="M:MailKit.Security.SaslException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  26580. <summary>
  26581. When overridden in a derived class, sets the <see cref="T:System.Runtime.Serialization.SerializationInfo"/>
  26582. with information about the exception.
  26583. </summary>
  26584. <remarks>
  26585. Serializes the state of the <see cref="T:MailKit.Security.SaslException"/>.
  26586. </remarks>
  26587. <param name="info">The serialization info.</param>
  26588. <param name="context">The streaming context.</param>
  26589. <exception cref="T:System.ArgumentNullException">
  26590. <paramref name="info"/> is <c>null</c>.
  26591. </exception>
  26592. </member>
  26593. <member name="P:MailKit.Security.SaslException.ErrorCode">
  26594. <summary>
  26595. Gets the error code.
  26596. </summary>
  26597. <remarks>
  26598. Gets the error code.
  26599. </remarks>
  26600. <value>The error code.</value>
  26601. </member>
  26602. <member name="P:MailKit.Security.SaslException.Mechanism">
  26603. <summary>
  26604. Gets the name of the SASL mechanism that had the error.
  26605. </summary>
  26606. <remarks>
  26607. Gets the name of the SASL mechanism that had the error.
  26608. </remarks>
  26609. <value>The name of the SASL mechanism.</value>
  26610. </member>
  26611. <member name="T:MailKit.Security.SaslMechanism">
  26612. <summary>
  26613. A SASL authentication mechanism.
  26614. </summary>
  26615. <remarks>
  26616. Authenticating via a SASL mechanism may be a multi-step process.
  26617. To determine if the mechanism has completed the necessary steps
  26618. to authentication, check the <see cref="P:MailKit.Security.SaslMechanism.IsAuthenticated"/> after
  26619. each call to <see cref="M:MailKit.Security.SaslMechanism.Challenge(System.String)"/>.
  26620. </remarks>
  26621. </member>
  26622. <member name="F:MailKit.Security.SaslMechanism.AuthMechanismRank">
  26623. <summary>
  26624. The supported authentication mechanisms in order of strongest to weakest.
  26625. </summary>
  26626. <remarks>
  26627. Used by the various clients when authenticating via SASL to determine
  26628. which order the SASL mechanisms supported by the server should be tried.
  26629. </remarks>
  26630. </member>
  26631. <member name="M:MailKit.Security.SaslMechanism.#ctor(System.Uri,System.Net.ICredentials)">
  26632. <summary>
  26633. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanism"/> class.
  26634. </summary>
  26635. <remarks>
  26636. Creates a new SASL context.
  26637. </remarks>
  26638. <param name="uri">The URI of the service.</param>
  26639. <param name="credentials">The user's credentials.</param>
  26640. <exception cref="T:System.ArgumentNullException">
  26641. <para><paramref name="uri"/> is <c>null</c>.</para>
  26642. <para>-or-</para>
  26643. <para><paramref name="credentials"/> is <c>null</c>.</para>
  26644. </exception>
  26645. </member>
  26646. <member name="M:MailKit.Security.SaslMechanism.#ctor(System.Uri,System.String,System.String)">
  26647. <summary>
  26648. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanism"/> class.
  26649. </summary>
  26650. <remarks>
  26651. Creates a new SASL context.
  26652. </remarks>
  26653. <param name="uri">The URI of the service.</param>
  26654. <param name="userName">The user name.</param>
  26655. <param name="password">The password.</param>
  26656. <exception cref="T:System.ArgumentNullException">
  26657. <para><paramref name="uri"/> is <c>null</c>.</para>
  26658. <para>-or-</para>
  26659. <para><paramref name="userName"/> is <c>null</c>.</para>
  26660. <para>-or-</para>
  26661. <para><paramref name="password"/> is <c>null</c>.</para>
  26662. </exception>
  26663. </member>
  26664. <member name="M:MailKit.Security.SaslMechanism.#ctor(System.Net.NetworkCredential)">
  26665. <summary>
  26666. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanism"/> class.
  26667. </summary>
  26668. <remarks>
  26669. Creates a new SASL context.
  26670. </remarks>
  26671. <param name="credentials">The user's credentials.</param>
  26672. <exception cref="T:System.ArgumentNullException">
  26673. <paramref name="credentials"/> is <c>null</c>.
  26674. </exception>
  26675. </member>
  26676. <member name="M:MailKit.Security.SaslMechanism.#ctor(System.String,System.String)">
  26677. <summary>
  26678. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanism"/> class.
  26679. </summary>
  26680. <remarks>
  26681. Creates a new SASL context.
  26682. </remarks>
  26683. <param name="userName">The user name.</param>
  26684. <param name="password">The password.</param>
  26685. <exception cref="T:System.ArgumentNullException">
  26686. <para><paramref name="userName"/> is <c>null</c>.</para>
  26687. <para>-or-</para>
  26688. <para><paramref name="password"/> is <c>null</c>.</para>
  26689. </exception>
  26690. </member>
  26691. <member name="P:MailKit.Security.SaslMechanism.MechanismName">
  26692. <summary>
  26693. Gets the name of the mechanism.
  26694. </summary>
  26695. <remarks>
  26696. Gets the name of the mechanism.
  26697. </remarks>
  26698. <value>The name of the mechanism.</value>
  26699. </member>
  26700. <member name="P:MailKit.Security.SaslMechanism.Credentials">
  26701. <summary>
  26702. Gets the user's credentials.
  26703. </summary>
  26704. <remarks>
  26705. Gets the user's credentials.
  26706. </remarks>
  26707. <value>The user's credentials.</value>
  26708. </member>
  26709. <member name="P:MailKit.Security.SaslMechanism.SupportsInitialResponse">
  26710. <summary>
  26711. Gets whether or not the mechanism supports an initial response (SASL-IR).
  26712. </summary>
  26713. <remarks>
  26714. SASL mechanisms that support sending an initial client response to the server
  26715. should return <value>true</value>.
  26716. </remarks>
  26717. <value><c>true</c> if the mechanism supports an initial response; otherwise, <c>false</c>.</value>
  26718. </member>
  26719. <member name="P:MailKit.Security.SaslMechanism.IsAuthenticated">
  26720. <summary>
  26721. Gets or sets whether the SASL mechanism has finished authenticating.
  26722. </summary>
  26723. <remarks>
  26724. Gets or sets whether the SASL mechanism has finished authenticating.
  26725. </remarks>
  26726. <value><c>true</c> if the SASL mechanism has finished authenticating; otherwise, <c>false</c>.</value>
  26727. </member>
  26728. <member name="P:MailKit.Security.SaslMechanism.NegotiatedSecurityLayer">
  26729. <summary>
  26730. Gets whether or not a security layer was negotiated.
  26731. </summary>
  26732. <remarks>
  26733. <para>Gets whether or not a security layer has been negotiated by the SASL mechanism.</para>
  26734. <note type="note">Some SASL mechanisms, such as GSSAPI, are able to negotiate security layers
  26735. such as integrity and confidentiality protection.</note>
  26736. </remarks>
  26737. <value><c>true</c> if a security layer was negotiated; otherwise, <c>false</c>.</value>
  26738. </member>
  26739. <member name="P:MailKit.Security.SaslMechanism.Uri">
  26740. <summary>
  26741. Gets or sets the URI of the service.
  26742. </summary>
  26743. <remarks>
  26744. Gets or sets the URI of the service.
  26745. </remarks>
  26746. <value>The URI of the service.</value>
  26747. </member>
  26748. <member name="M:MailKit.Security.SaslMechanism.Challenge(System.Byte[],System.Int32,System.Int32)">
  26749. <summary>
  26750. Parses the server's challenge token and returns the next challenge response.
  26751. </summary>
  26752. <remarks>
  26753. Parses the server's challenge token and returns the next challenge response.
  26754. </remarks>
  26755. <returns>The next challenge response.</returns>
  26756. <param name="token">The server's challenge token.</param>
  26757. <param name="startIndex">The index into the token specifying where the server's challenge begins.</param>
  26758. <param name="length">The length of the server's challenge.</param>
  26759. <exception cref="T:System.InvalidOperationException">
  26760. The SASL mechanism is already authenticated.
  26761. </exception>
  26762. <exception cref="T:System.NotSupportedException">
  26763. THe SASL mechanism does not support SASL-IR.
  26764. </exception>
  26765. <exception cref="T:MailKit.Security.SaslException">
  26766. An error has occurred while parsing the server's challenge token.
  26767. </exception>
  26768. </member>
  26769. <member name="M:MailKit.Security.SaslMechanism.Challenge(System.String)">
  26770. <summary>
  26771. Decodes the base64-encoded server challenge and returns the next challenge response encoded in base64.
  26772. </summary>
  26773. <remarks>
  26774. Decodes the base64-encoded server challenge and returns the next challenge response encoded in base64.
  26775. </remarks>
  26776. <returns>The next base64-encoded challenge response.</returns>
  26777. <param name="token">The server's base64-encoded challenge token.</param>
  26778. <exception cref="T:System.InvalidOperationException">
  26779. The SASL mechanism is already authenticated.
  26780. </exception>
  26781. <exception cref="T:System.NotSupportedException">
  26782. THe SASL mechanism does not support SASL-IR.
  26783. </exception>
  26784. <exception cref="T:MailKit.Security.SaslException">
  26785. An error has occurred while parsing the server's challenge token.
  26786. </exception>
  26787. </member>
  26788. <member name="M:MailKit.Security.SaslMechanism.Reset">
  26789. <summary>
  26790. Resets the state of the SASL mechanism.
  26791. </summary>
  26792. <remarks>
  26793. Resets the state of the SASL mechanism.
  26794. </remarks>
  26795. </member>
  26796. <member name="M:MailKit.Security.SaslMechanism.IsSupported(System.String)">
  26797. <summary>
  26798. Determines if the specified SASL mechanism is supported by MailKit.
  26799. </summary>
  26800. <remarks>
  26801. Use this method to make sure that a SASL mechanism is supported before calling
  26802. <see cref="M:MailKit.Security.SaslMechanism.Create(System.String,System.Uri,System.Net.ICredentials)"/>.
  26803. </remarks>
  26804. <returns><c>true</c> if the specified SASL mechanism is supported; otherwise, <c>false</c>.</returns>
  26805. <param name="mechanism">The name of the SASL mechanism.</param>
  26806. <exception cref="T:System.ArgumentNullException">
  26807. <paramref name="mechanism"/> is <c>null</c>.
  26808. </exception>
  26809. </member>
  26810. <member name="M:MailKit.Security.SaslMechanism.Create(System.String,System.Uri,System.Text.Encoding,System.Net.ICredentials)">
  26811. <summary>
  26812. Create an instance of the specified SASL mechanism using the uri and credentials.
  26813. </summary>
  26814. <remarks>
  26815. If unsure that a particular SASL mechanism is supported, you should first call
  26816. <see cref="M:MailKit.Security.SaslMechanism.IsSupported(System.String)"/>.
  26817. </remarks>
  26818. <returns>An instance of the requested SASL mechanism if supported; otherwise <c>null</c>.</returns>
  26819. <param name="mechanism">The name of the SASL mechanism.</param>
  26820. <param name="uri">The URI of the service to authenticate against.</param>
  26821. <param name="encoding">The text encoding to use for the credentials.</param>
  26822. <param name="credentials">The user's credentials.</param>
  26823. <exception cref="T:System.ArgumentNullException">
  26824. <para><paramref name="mechanism"/> is <c>null</c>.</para>
  26825. <para>-or-</para>
  26826. <para><paramref name="uri"/> is <c>null</c>.</para>
  26827. <para>-or-</para>
  26828. <para><paramref name="encoding"/> is <c>null</c>.</para>
  26829. <para>-or-</para>
  26830. <para><paramref name="credentials"/> is <c>null</c>.</para>
  26831. </exception>
  26832. </member>
  26833. <member name="M:MailKit.Security.SaslMechanism.Create(System.String,System.Uri,System.Net.ICredentials)">
  26834. <summary>
  26835. Create an instance of the specified SASL mechanism using the uri and credentials.
  26836. </summary>
  26837. <remarks>
  26838. If unsure that a particular SASL mechanism is supported, you should first call
  26839. <see cref="M:MailKit.Security.SaslMechanism.IsSupported(System.String)"/>.
  26840. </remarks>
  26841. <returns>An instance of the requested SASL mechanism if supported; otherwise <c>null</c>.</returns>
  26842. <param name="mechanism">The name of the SASL mechanism.</param>
  26843. <param name="uri">The URI of the service to authenticate against.</param>
  26844. <param name="credentials">The user's credentials.</param>
  26845. <exception cref="T:System.ArgumentNullException">
  26846. <para><paramref name="mechanism"/> is <c>null</c>.</para>
  26847. <para>-or-</para>
  26848. <para><paramref name="uri"/> is <c>null</c>.</para>
  26849. <para>-or-</para>
  26850. <para><paramref name="credentials"/> is <c>null</c>.</para>
  26851. </exception>
  26852. </member>
  26853. <member name="M:MailKit.Security.SaslMechanism.IsNonAsciiSpace(System.Char)">
  26854. <summary>
  26855. Determines if the character is a non-ASCII space.
  26856. </summary>
  26857. <remarks>
  26858. This list was obtained from http://tools.ietf.org/html/rfc3454#appendix-C.1.2
  26859. </remarks>
  26860. <returns><c>true</c> if the character is a non-ASCII space; otherwise, <c>false</c>.</returns>
  26861. <param name="c">The character.</param>
  26862. </member>
  26863. <member name="M:MailKit.Security.SaslMechanism.IsCommonlyMappedToNothing(System.Char)">
  26864. <summary>
  26865. Determines if the character is commonly mapped to nothing.
  26866. </summary>
  26867. <remarks>
  26868. This list was obtained from http://tools.ietf.org/html/rfc3454#appendix-B.1
  26869. </remarks>
  26870. <returns><c>true</c> if the character is commonly mapped to nothing; otherwise, <c>false</c>.</returns>
  26871. <param name="c">The character.</param>
  26872. </member>
  26873. <member name="M:MailKit.Security.SaslMechanism.IsProhibited(System.String,System.Int32)">
  26874. <summary>
  26875. Determines if the character is prohibited.
  26876. </summary>
  26877. <remarks>
  26878. This list was obtained from http://tools.ietf.org/html/rfc3454#appendix-C.3
  26879. </remarks>
  26880. <returns><c>true</c> if the character is prohibited; otherwise, <c>false</c>.</returns>
  26881. <param name="s">The string.</param>
  26882. <param name="index">The character index.</param>
  26883. </member>
  26884. <member name="M:MailKit.Security.SaslMechanism.SaslPrep(System.String)">
  26885. <summary>
  26886. Prepares the user name or password string.
  26887. </summary>
  26888. <remarks>
  26889. Prepares a user name or password string according to the rules of rfc4013.
  26890. </remarks>
  26891. <returns>The prepared string.</returns>
  26892. <param name="s">The string to prepare.</param>
  26893. <exception cref="T:System.ArgumentNullException">
  26894. <paramref name="s"/> is <c>null</c>.
  26895. </exception>
  26896. <exception cref="T:System.ArgumentException">
  26897. <paramref name="s"/> contains prohibited characters.
  26898. </exception>
  26899. </member>
  26900. <member name="T:MailKit.Security.SaslMechanismCramMd5">
  26901. <summary>
  26902. The CRAM-MD5 SASL mechanism.
  26903. </summary>
  26904. <remarks>
  26905. A SASL mechanism based on HMAC-MD5.
  26906. </remarks>
  26907. </member>
  26908. <member name="M:MailKit.Security.SaslMechanismCramMd5.#ctor(System.Uri,System.Net.ICredentials)">
  26909. <summary>
  26910. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismCramMd5"/> class.
  26911. </summary>
  26912. <remarks>
  26913. Creates a new CRAM-MD5 SASL context.
  26914. </remarks>
  26915. <param name="uri">The URI of the service.</param>
  26916. <param name="credentials">The user's credentials.</param>
  26917. <exception cref="T:System.ArgumentNullException">
  26918. <para><paramref name="uri"/> is <c>null</c>.</para>
  26919. <para>-or-</para>
  26920. <para><paramref name="credentials"/> is <c>null</c>.</para>
  26921. </exception>
  26922. </member>
  26923. <member name="M:MailKit.Security.SaslMechanismCramMd5.#ctor(System.Uri,System.String,System.String)">
  26924. <summary>
  26925. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismCramMd5"/> class.
  26926. </summary>
  26927. <remarks>
  26928. Creates a new CRAM-MD5 SASL context.
  26929. </remarks>
  26930. <param name="uri">The URI of the service.</param>
  26931. <param name="userName">The user name.</param>
  26932. <param name="password">The password.</param>
  26933. <exception cref="T:System.ArgumentNullException">
  26934. <para><paramref name="uri"/> is <c>null</c>.</para>
  26935. <para>-or-</para>
  26936. <para><paramref name="userName"/> is <c>null</c>.</para>
  26937. <para>-or-</para>
  26938. <para><paramref name="password"/> is <c>null</c>.</para>
  26939. </exception>
  26940. </member>
  26941. <member name="M:MailKit.Security.SaslMechanismCramMd5.#ctor(System.Net.NetworkCredential)">
  26942. <summary>
  26943. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismCramMd5"/> class.
  26944. </summary>
  26945. <remarks>
  26946. Creates a new CRAM-MD5 SASL context.
  26947. </remarks>
  26948. <param name="credentials">The user's credentials.</param>
  26949. <exception cref="T:System.ArgumentNullException">
  26950. <paramref name="credentials"/> is <c>null</c>.
  26951. </exception>
  26952. </member>
  26953. <member name="M:MailKit.Security.SaslMechanismCramMd5.#ctor(System.String,System.String)">
  26954. <summary>
  26955. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismCramMd5"/> class.
  26956. </summary>
  26957. <remarks>
  26958. Creates a new CRAM-MD5 SASL context.
  26959. </remarks>
  26960. <param name="userName">The user name.</param>
  26961. <param name="password">The password.</param>
  26962. <exception cref="T:System.ArgumentNullException">
  26963. <para><paramref name="userName"/> is <c>null</c>.</para>
  26964. <para>-or-</para>
  26965. <para><paramref name="password"/> is <c>null</c>.</para>
  26966. </exception>
  26967. </member>
  26968. <member name="P:MailKit.Security.SaslMechanismCramMd5.MechanismName">
  26969. <summary>
  26970. Gets the name of the mechanism.
  26971. </summary>
  26972. <remarks>
  26973. Gets the name of the mechanism.
  26974. </remarks>
  26975. <value>The name of the mechanism.</value>
  26976. </member>
  26977. <member name="M:MailKit.Security.SaslMechanismCramMd5.Challenge(System.Byte[],System.Int32,System.Int32)">
  26978. <summary>
  26979. Parses the server's challenge token and returns the next challenge response.
  26980. </summary>
  26981. <remarks>
  26982. Parses the server's challenge token and returns the next challenge response.
  26983. </remarks>
  26984. <returns>The next challenge response.</returns>
  26985. <param name="token">The server's challenge token.</param>
  26986. <param name="startIndex">The index into the token specifying where the server's challenge begins.</param>
  26987. <param name="length">The length of the server's challenge.</param>
  26988. <exception cref="T:System.InvalidOperationException">
  26989. The SASL mechanism is already authenticated.
  26990. </exception>
  26991. <exception cref="T:System.NotSupportedException">
  26992. The SASL mechanism does not support SASL-IR.
  26993. </exception>
  26994. <exception cref="T:MailKit.Security.SaslException">
  26995. An error has occurred while parsing the server's challenge token.
  26996. </exception>
  26997. </member>
  26998. <member name="T:MailKit.Security.SaslMechanismDigestMd5">
  26999. <summary>
  27000. The DIGEST-MD5 SASL mechanism.
  27001. </summary>
  27002. <remarks>
  27003. Unlike the PLAIN and LOGIN SASL mechanisms, the DIGEST-MD5 mechanism
  27004. provides some level of protection and should be relatively safe to
  27005. use even with a clear-text connection.
  27006. </remarks>
  27007. </member>
  27008. <member name="M:MailKit.Security.SaslMechanismDigestMd5.#ctor(System.Uri,System.Net.ICredentials)">
  27009. <summary>
  27010. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismDigestMd5"/> class.
  27011. </summary>
  27012. <remarks>
  27013. Creates a new DIGEST-MD5 SASL context.
  27014. </remarks>
  27015. <param name="uri">The URI of the service.</param>
  27016. <param name="credentials">The user's credentials.</param>
  27017. <exception cref="T:System.ArgumentNullException">
  27018. <para><paramref name="uri"/> is <c>null</c>.</para>
  27019. <para>-or-</para>
  27020. <para><paramref name="credentials"/> is <c>null</c>.</para>
  27021. </exception>
  27022. </member>
  27023. <member name="M:MailKit.Security.SaslMechanismDigestMd5.#ctor(System.Uri,System.String,System.String)">
  27024. <summary>
  27025. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismDigestMd5"/> class.
  27026. </summary>
  27027. <remarks>
  27028. Creates a new DIGEST-MD5 SASL context.
  27029. </remarks>
  27030. <param name="uri">The URI of the service.</param>
  27031. <param name="userName">The user name.</param>
  27032. <param name="password">The password.</param>
  27033. <exception cref="T:System.ArgumentNullException">
  27034. <para><paramref name="uri"/> is <c>null</c>.</para>
  27035. <para>-or-</para>
  27036. <para><paramref name="userName"/> is <c>null</c>.</para>
  27037. <para>-or-</para>
  27038. <para><paramref name="password"/> is <c>null</c>.</para>
  27039. </exception>
  27040. </member>
  27041. <member name="M:MailKit.Security.SaslMechanismDigestMd5.#ctor(System.Net.NetworkCredential)">
  27042. <summary>
  27043. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismDigestMd5"/> class.
  27044. </summary>
  27045. <remarks>
  27046. Creates a new DIGEST-MD5 SASL context.
  27047. </remarks>
  27048. <param name="credentials">The user's credentials.</param>
  27049. <exception cref="T:System.ArgumentNullException">
  27050. <paramref name="credentials"/> is <c>null</c>.
  27051. </exception>
  27052. </member>
  27053. <member name="M:MailKit.Security.SaslMechanismDigestMd5.#ctor(System.String,System.String)">
  27054. <summary>
  27055. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismDigestMd5"/> class.
  27056. </summary>
  27057. <remarks>
  27058. Creates a new DIGEST-MD5 SASL context.
  27059. </remarks>
  27060. <param name="userName">The user name.</param>
  27061. <param name="password">The password.</param>
  27062. <exception cref="T:System.ArgumentNullException">
  27063. <para><paramref name="userName"/> is <c>null</c>.</para>
  27064. <para>-or-</para>
  27065. <para><paramref name="password"/> is <c>null</c>.</para>
  27066. </exception>
  27067. </member>
  27068. <member name="P:MailKit.Security.SaslMechanismDigestMd5.AuthorizationId">
  27069. <summary>
  27070. Gets or sets the authorization identifier.
  27071. </summary>
  27072. <remarks>
  27073. The authorization identifier is the desired user account that the server should use
  27074. for all accesses. This is separate from the user name used for authentication.
  27075. </remarks>
  27076. <value>The authorization identifier.</value>
  27077. </member>
  27078. <member name="P:MailKit.Security.SaslMechanismDigestMd5.MechanismName">
  27079. <summary>
  27080. Gets the name of the mechanism.
  27081. </summary>
  27082. <remarks>
  27083. Gets the name of the mechanism.
  27084. </remarks>
  27085. <value>The name of the mechanism.</value>
  27086. </member>
  27087. <member name="M:MailKit.Security.SaslMechanismDigestMd5.Challenge(System.Byte[],System.Int32,System.Int32)">
  27088. <summary>
  27089. Parses the server's challenge token and returns the next challenge response.
  27090. </summary>
  27091. <remarks>
  27092. Parses the server's challenge token and returns the next challenge response.
  27093. </remarks>
  27094. <returns>The next challenge response.</returns>
  27095. <param name="token">The server's challenge token.</param>
  27096. <param name="startIndex">The index into the token specifying where the server's challenge begins.</param>
  27097. <param name="length">The length of the server's challenge.</param>
  27098. <exception cref="T:System.InvalidOperationException">
  27099. The SASL mechanism is already authenticated.
  27100. </exception>
  27101. <exception cref="T:System.NotSupportedException">
  27102. THe SASL mechanism does not support SASL-IR.
  27103. </exception>
  27104. <exception cref="T:MailKit.Security.SaslException">
  27105. An error has occurred while parsing the server's challenge token.
  27106. </exception>
  27107. </member>
  27108. <member name="M:MailKit.Security.SaslMechanismDigestMd5.Reset">
  27109. <summary>
  27110. Resets the state of the SASL mechanism.
  27111. </summary>
  27112. <remarks>
  27113. Resets the state of the SASL mechanism.
  27114. </remarks>
  27115. </member>
  27116. <member name="T:MailKit.Security.SaslMechanismLogin">
  27117. <summary>
  27118. The LOGIN SASL mechanism.
  27119. </summary>
  27120. <remarks>
  27121. The LOGIN SASL mechanism provides little protection over the use
  27122. of plain-text passwords by obscuring the user name and password within
  27123. individual base64-encoded blobs and should be avoided unless used in
  27124. combination with an SSL or TLS connection.
  27125. </remarks>
  27126. </member>
  27127. <member name="M:MailKit.Security.SaslMechanismLogin.#ctor(System.Uri,System.Text.Encoding,System.Net.ICredentials)">
  27128. <summary>
  27129. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismLogin"/> class.
  27130. </summary>
  27131. <remarks>
  27132. Creates a new LOGIN SASL context.
  27133. </remarks>
  27134. <param name="uri">The URI of the service.</param>
  27135. <param name="encoding">The encoding to use for the user's credentials.</param>
  27136. <param name="credentials">The user's credentials.</param>
  27137. <exception cref="T:System.ArgumentNullException">
  27138. <para><paramref name="uri"/> is <c>null</c>.</para>
  27139. <para>-or-</para>
  27140. <para><paramref name="encoding"/> is <c>null</c>.</para>
  27141. <para>-or-</para>
  27142. <para><paramref name="credentials"/> is <c>null</c>.</para>
  27143. </exception>
  27144. </member>
  27145. <member name="M:MailKit.Security.SaslMechanismLogin.#ctor(System.Uri,System.Text.Encoding,System.String,System.String)">
  27146. <summary>
  27147. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismLogin"/> class.
  27148. </summary>
  27149. <remarks>
  27150. Creates a new LOGIN SASL context.
  27151. </remarks>
  27152. <param name="uri">The URI of the service.</param>
  27153. <param name="encoding">The encoding to use for the user's credentials.</param>
  27154. <param name="userName">The user name.</param>
  27155. <param name="password">The password.</param>
  27156. <exception cref="T:System.ArgumentNullException">
  27157. <para><paramref name="uri"/> is <c>null</c>.</para>
  27158. <para>-or-</para>
  27159. <para><paramref name="encoding"/> is <c>null</c>.</para>
  27160. <para>-or-</para>
  27161. <para><paramref name="userName"/> is <c>null</c>.</para>
  27162. <para>-or-</para>
  27163. <para><paramref name="password"/> is <c>null</c>.</para>
  27164. </exception>
  27165. </member>
  27166. <member name="M:MailKit.Security.SaslMechanismLogin.#ctor(System.Uri,System.Net.ICredentials)">
  27167. <summary>
  27168. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismLogin"/> class.
  27169. </summary>
  27170. <remarks>
  27171. Creates a new LOGIN SASL context.
  27172. </remarks>
  27173. <param name="uri">The URI of the service.</param>
  27174. <param name="credentials">The user's credentials.</param>
  27175. <exception cref="T:System.ArgumentNullException">
  27176. <para><paramref name="uri"/> is <c>null</c>.</para>
  27177. <para>-or-</para>
  27178. <para><paramref name="credentials"/> is <c>null</c>.</para>
  27179. </exception>
  27180. </member>
  27181. <member name="M:MailKit.Security.SaslMechanismLogin.#ctor(System.Uri,System.String,System.String)">
  27182. <summary>
  27183. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismLogin"/> class.
  27184. </summary>
  27185. <remarks>
  27186. Creates a new LOGIN SASL context.
  27187. </remarks>
  27188. <param name="uri">The URI of the service.</param>
  27189. <param name="userName">The user name.</param>
  27190. <param name="password">The password.</param>
  27191. <exception cref="T:System.ArgumentNullException">
  27192. <para><paramref name="uri"/> is <c>null</c>.</para>
  27193. <para>-or-</para>
  27194. <para><paramref name="userName"/> is <c>null</c>.</para>
  27195. <para>-or-</para>
  27196. <para><paramref name="password"/> is <c>null</c>.</para>
  27197. </exception>
  27198. </member>
  27199. <member name="M:MailKit.Security.SaslMechanismLogin.#ctor(System.Text.Encoding,System.Net.NetworkCredential)">
  27200. <summary>
  27201. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismLogin"/> class.
  27202. </summary>
  27203. <remarks>
  27204. Creates a new LOGIN SASL context.
  27205. </remarks>
  27206. <param name="encoding">The encoding to use for the user's credentials.</param>
  27207. <param name="credentials">The user's credentials.</param>
  27208. <exception cref="T:System.ArgumentNullException">
  27209. <para><paramref name="encoding"/> is <c>null</c>.</para>
  27210. <para>-or-</para>
  27211. <para><paramref name="credentials"/> is <c>null</c>.</para>
  27212. </exception>
  27213. </member>
  27214. <member name="M:MailKit.Security.SaslMechanismLogin.#ctor(System.Text.Encoding,System.String,System.String)">
  27215. <summary>
  27216. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismLogin"/> class.
  27217. </summary>
  27218. <remarks>
  27219. Creates a new LOGIN SASL context.
  27220. </remarks>
  27221. <param name="encoding">The encoding to use for the user's credentials.</param>
  27222. <param name="userName">The user name.</param>
  27223. <param name="password">The password.</param>
  27224. <exception cref="T:System.ArgumentNullException">
  27225. <para><paramref name="encoding"/> is <c>null</c>.</para>
  27226. <para>-or-</para>
  27227. <para><paramref name="userName"/> is <c>null</c>.</para>
  27228. <para>-or-</para>
  27229. <para><paramref name="password"/> is <c>null</c>.</para>
  27230. </exception>
  27231. </member>
  27232. <member name="M:MailKit.Security.SaslMechanismLogin.#ctor(System.Net.NetworkCredential)">
  27233. <summary>
  27234. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismLogin"/> class.
  27235. </summary>
  27236. <remarks>
  27237. Creates a new LOGIN SASL context.
  27238. </remarks>
  27239. <param name="credentials">The user's credentials.</param>
  27240. <exception cref="T:System.ArgumentNullException">
  27241. <paramref name="credentials"/> is <c>null</c>.
  27242. </exception>
  27243. </member>
  27244. <member name="M:MailKit.Security.SaslMechanismLogin.#ctor(System.String,System.String)">
  27245. <summary>
  27246. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismLogin"/> class.
  27247. </summary>
  27248. <remarks>
  27249. Creates a new LOGIN SASL context.
  27250. </remarks>
  27251. <param name="userName">The user name.</param>
  27252. <param name="password">The password.</param>
  27253. <exception cref="T:System.ArgumentNullException">
  27254. <para><paramref name="userName"/> is <c>null</c>.</para>
  27255. <para>-or-</para>
  27256. <para><paramref name="password"/> is <c>null</c>.</para>
  27257. </exception>
  27258. </member>
  27259. <member name="P:MailKit.Security.SaslMechanismLogin.MechanismName">
  27260. <summary>
  27261. Gets the name of the mechanism.
  27262. </summary>
  27263. <remarks>
  27264. Gets the name of the mechanism.
  27265. </remarks>
  27266. <value>The name of the mechanism.</value>
  27267. </member>
  27268. <member name="P:MailKit.Security.SaslMechanismLogin.SupportsInitialResponse">
  27269. <summary>
  27270. Gets whether or not the mechanism supports an initial response (SASL-IR).
  27271. </summary>
  27272. <remarks>
  27273. SASL mechanisms that support sending an initial client response to the server
  27274. should return <value>true</value>.
  27275. </remarks>
  27276. <value><c>true</c> if the mechanism supports an initial response; otherwise, <c>false</c>.</value>
  27277. </member>
  27278. <member name="M:MailKit.Security.SaslMechanismLogin.Challenge(System.Byte[],System.Int32,System.Int32)">
  27279. <summary>
  27280. Parses the server's challenge token and returns the next challenge response.
  27281. </summary>
  27282. <remarks>
  27283. Parses the server's challenge token and returns the next challenge response.
  27284. </remarks>
  27285. <returns>The next challenge response.</returns>
  27286. <param name="token">The server's challenge token.</param>
  27287. <param name="startIndex">The index into the token specifying where the server's challenge begins.</param>
  27288. <param name="length">The length of the server's challenge.</param>
  27289. <exception cref="T:System.InvalidOperationException">
  27290. The SASL mechanism is already authenticated.
  27291. </exception>
  27292. <exception cref="T:System.NotSupportedException">
  27293. The SASL mechanism does not support SASL-IR.
  27294. </exception>
  27295. <exception cref="T:MailKit.Security.SaslException">
  27296. An error has occurred while parsing the server's challenge token.
  27297. </exception>
  27298. </member>
  27299. <member name="M:MailKit.Security.SaslMechanismLogin.Reset">
  27300. <summary>
  27301. Resets the state of the SASL mechanism.
  27302. </summary>
  27303. <remarks>
  27304. Resets the state of the SASL mechanism.
  27305. </remarks>
  27306. </member>
  27307. <member name="T:MailKit.Security.SaslMechanismNtlm">
  27308. <summary>
  27309. The NTLM SASL mechanism.
  27310. </summary>
  27311. <remarks>
  27312. A SASL mechanism based on NTLM.
  27313. </remarks>
  27314. </member>
  27315. <member name="M:MailKit.Security.SaslMechanismNtlm.#ctor(System.Uri,System.Net.ICredentials)">
  27316. <summary>
  27317. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismNtlm"/> class.
  27318. </summary>
  27319. <remarks>
  27320. Creates a new NTLM SASL context.
  27321. </remarks>
  27322. <param name="uri">The URI of the service.</param>
  27323. <param name="credentials">The user's credentials.</param>
  27324. <exception cref="T:System.ArgumentNullException">
  27325. <para><paramref name="uri"/> is <c>null</c>.</para>
  27326. <para>-or-</para>
  27327. <para><paramref name="credentials"/> is <c>null</c>.</para>
  27328. </exception>
  27329. </member>
  27330. <member name="M:MailKit.Security.SaslMechanismNtlm.#ctor(System.Uri,System.String,System.String)">
  27331. <summary>
  27332. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismNtlm"/> class.
  27333. </summary>
  27334. <remarks>
  27335. Creates a new NTLM SASL context.
  27336. </remarks>
  27337. <param name="uri">The URI of the service.</param>
  27338. <param name="userName">The user name.</param>
  27339. <param name="password">The password.</param>
  27340. <exception cref="T:System.ArgumentNullException">
  27341. <para><paramref name="uri"/> is <c>null</c>.</para>
  27342. <para>-or-</para>
  27343. <para><paramref name="userName"/> is <c>null</c>.</para>
  27344. <para>-or-</para>
  27345. <para><paramref name="password"/> is <c>null</c>.</para>
  27346. </exception>
  27347. </member>
  27348. <member name="M:MailKit.Security.SaslMechanismNtlm.#ctor(System.Net.NetworkCredential)">
  27349. <summary>
  27350. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismNtlm"/> class.
  27351. </summary>
  27352. <remarks>
  27353. Creates a new NTLM SASL context.
  27354. </remarks>
  27355. <param name="credentials">The user's credentials.</param>
  27356. <exception cref="T:System.ArgumentNullException">
  27357. <paramref name="credentials"/> is <c>null</c>.
  27358. </exception>
  27359. </member>
  27360. <member name="M:MailKit.Security.SaslMechanismNtlm.#ctor(System.String,System.String)">
  27361. <summary>
  27362. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismNtlm"/> class.
  27363. </summary>
  27364. <remarks>
  27365. Creates a new NTLM SASL context.
  27366. </remarks>
  27367. <param name="userName">The user name.</param>
  27368. <param name="password">The password.</param>
  27369. <exception cref="T:System.ArgumentNullException">
  27370. <para><paramref name="userName"/> is <c>null</c>.</para>
  27371. <para>-or-</para>
  27372. <para><paramref name="password"/> is <c>null</c>.</para>
  27373. </exception>
  27374. </member>
  27375. <member name="P:MailKit.Security.SaslMechanismNtlm.MechanismName">
  27376. <summary>
  27377. Gets the name of the mechanism.
  27378. </summary>
  27379. <remarks>
  27380. Gets the name of the mechanism.
  27381. </remarks>
  27382. <value>The name of the mechanism.</value>
  27383. </member>
  27384. <member name="P:MailKit.Security.SaslMechanismNtlm.SupportsInitialResponse">
  27385. <summary>
  27386. Gets whether or not the mechanism supports an initial response (SASL-IR).
  27387. </summary>
  27388. <remarks>
  27389. SASL mechanisms that support sending an initial client response to the server
  27390. should return <value>true</value>.
  27391. </remarks>
  27392. <value><c>true</c> if the mechanism supports an initial response; otherwise, <c>false</c>.</value>
  27393. </member>
  27394. <member name="P:MailKit.Security.SaslMechanismNtlm.Workstation">
  27395. <summary>
  27396. Gets or sets the workstation name to use for authentication.
  27397. </summary>
  27398. <remarks>
  27399. Gets or sets the workstation name to use for authentication.
  27400. </remarks>
  27401. <value>The workstation name.</value>
  27402. </member>
  27403. <member name="M:MailKit.Security.SaslMechanismNtlm.Challenge(System.Byte[],System.Int32,System.Int32)">
  27404. <summary>
  27405. Parses the server's challenge token and returns the next challenge response.
  27406. </summary>
  27407. <remarks>
  27408. Parses the server's challenge token and returns the next challenge response.
  27409. </remarks>
  27410. <returns>The next challenge response.</returns>
  27411. <param name="token">The server's challenge token.</param>
  27412. <param name="startIndex">The index into the token specifying where the server's challenge begins.</param>
  27413. <param name="length">The length of the server's challenge.</param>
  27414. <exception cref="T:System.InvalidOperationException">
  27415. The SASL mechanism is already authenticated.
  27416. </exception>
  27417. <exception cref="T:MailKit.Security.SaslException">
  27418. An error has occurred while parsing the server's challenge token.
  27419. </exception>
  27420. </member>
  27421. <member name="M:MailKit.Security.SaslMechanismNtlm.Reset">
  27422. <summary>
  27423. Resets the state of the SASL mechanism.
  27424. </summary>
  27425. <remarks>
  27426. Resets the state of the SASL mechanism.
  27427. </remarks>
  27428. </member>
  27429. <member name="T:MailKit.Security.SaslMechanismOAuth2">
  27430. <summary>
  27431. The OAuth2 SASL mechanism.
  27432. </summary>
  27433. <remarks>
  27434. A SASL mechanism used by Google that makes use of a short-lived
  27435. OAuth 2.0 access token.
  27436. </remarks>
  27437. </member>
  27438. <member name="M:MailKit.Security.SaslMechanismOAuth2.#ctor(System.Uri,System.Net.ICredentials)">
  27439. <summary>
  27440. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismOAuth2"/> class.
  27441. </summary>
  27442. <remarks>
  27443. Creates a new XOAUTH2 SASL context.
  27444. </remarks>
  27445. <param name="uri">The URI of the service.</param>
  27446. <param name="credentials">The user's credentials.</param>
  27447. <exception cref="T:System.ArgumentNullException">
  27448. <para><paramref name="uri"/> is <c>null</c>.</para>
  27449. <para>-or-</para>
  27450. <para><paramref name="credentials"/> is <c>null</c>.</para>
  27451. </exception>
  27452. </member>
  27453. <member name="M:MailKit.Security.SaslMechanismOAuth2.#ctor(System.Uri,System.String,System.String)">
  27454. <summary>
  27455. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismOAuth2"/> class.
  27456. </summary>
  27457. <remarks>
  27458. Creates a new XOAUTH2 SASL context.
  27459. </remarks>
  27460. <param name="uri">The URI of the service.</param>
  27461. <param name="userName">The user name.</param>
  27462. <param name="auth_token">The auth token.</param>
  27463. <exception cref="T:System.ArgumentNullException">
  27464. <para><paramref name="uri"/> is <c>null</c>.</para>
  27465. <para>-or-</para>
  27466. <para><paramref name="userName"/> is <c>null</c>.</para>
  27467. <para>-or-</para>
  27468. <para><paramref name="auth_token"/> is <c>null</c>.</para>
  27469. </exception>
  27470. </member>
  27471. <member name="M:MailKit.Security.SaslMechanismOAuth2.#ctor(System.Net.NetworkCredential)">
  27472. <summary>
  27473. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismOAuth2"/> class.
  27474. </summary>
  27475. <remarks>
  27476. Creates a new XOAUTH2 SASL context.
  27477. </remarks>
  27478. <param name="credentials">The user's credentials.</param>
  27479. <exception cref="T:System.ArgumentNullException">
  27480. <paramref name="credentials"/> is <c>null</c>.
  27481. </exception>
  27482. </member>
  27483. <member name="M:MailKit.Security.SaslMechanismOAuth2.#ctor(System.String,System.String)">
  27484. <summary>
  27485. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismOAuth2"/> class.
  27486. </summary>
  27487. <remarks>
  27488. Creates a new XOAUTH2 SASL context.
  27489. </remarks>
  27490. <param name="userName">The user name.</param>
  27491. <param name="auth_token">The auth token.</param>
  27492. <exception cref="T:System.ArgumentNullException">
  27493. <para><paramref name="userName"/> is <c>null</c>.</para>
  27494. <para>-or-</para>
  27495. <para><paramref name="auth_token"/> is <c>null</c>.</para>
  27496. </exception>
  27497. </member>
  27498. <member name="P:MailKit.Security.SaslMechanismOAuth2.MechanismName">
  27499. <summary>
  27500. Gets the name of the mechanism.
  27501. </summary>
  27502. <remarks>
  27503. Gets the name of the mechanism.
  27504. </remarks>
  27505. <value>The name of the mechanism.</value>
  27506. </member>
  27507. <member name="P:MailKit.Security.SaslMechanismOAuth2.SupportsInitialResponse">
  27508. <summary>
  27509. Gets whether or not the mechanism supports an initial response (SASL-IR).
  27510. </summary>
  27511. <remarks>
  27512. SASL mechanisms that support sending an initial client response to the server
  27513. should return <value>true</value>.
  27514. </remarks>
  27515. <value><c>true</c> if the mechanism supports an initial response; otherwise, <c>false</c>.</value>
  27516. </member>
  27517. <member name="M:MailKit.Security.SaslMechanismOAuth2.Challenge(System.Byte[],System.Int32,System.Int32)">
  27518. <summary>
  27519. Parses the server's challenge token and returns the next challenge response.
  27520. </summary>
  27521. <remarks>
  27522. Parses the server's challenge token and returns the next challenge response.
  27523. </remarks>
  27524. <returns>The next challenge response.</returns>
  27525. <param name="token">The server's challenge token.</param>
  27526. <param name="startIndex">The index into the token specifying where the server's challenge begins.</param>
  27527. <param name="length">The length of the server's challenge.</param>
  27528. <exception cref="T:System.InvalidOperationException">
  27529. The SASL mechanism is already authenticated.
  27530. </exception>
  27531. <exception cref="T:MailKit.Security.SaslException">
  27532. An error has occurred while parsing the server's challenge token.
  27533. </exception>
  27534. </member>
  27535. <member name="T:MailKit.Security.SaslMechanismPlain">
  27536. <summary>
  27537. The PLAIN SASL mechanism.
  27538. </summary>
  27539. <remarks>
  27540. The PLAIN SASL mechanism provides little protection over the use
  27541. of plain-text passwords by combining the user name and password and
  27542. obscuring them within a base64-encoded blob and should be avoided
  27543. unless used in combination with an SSL or TLS connection.
  27544. </remarks>
  27545. </member>
  27546. <member name="M:MailKit.Security.SaslMechanismPlain.#ctor(System.Uri,System.Text.Encoding,System.Net.ICredentials)">
  27547. <summary>
  27548. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismPlain"/> class.
  27549. </summary>
  27550. <remarks>
  27551. Creates a new PLAIN SASL context.
  27552. </remarks>
  27553. <param name="uri">The URI of the service.</param>
  27554. <param name="encoding">The encoding to use for the user's credentials.</param>
  27555. <param name="credentials">The user's credentials.</param>
  27556. <exception cref="T:System.ArgumentNullException">
  27557. <para><paramref name="uri"/> is <c>null</c>.</para>
  27558. <para>-or-</para>
  27559. <para><paramref name="encoding"/> is <c>null</c>.</para>
  27560. <para>-or-</para>
  27561. <para><paramref name="credentials"/> is <c>null</c>.</para>
  27562. </exception>
  27563. </member>
  27564. <member name="M:MailKit.Security.SaslMechanismPlain.#ctor(System.Uri,System.Text.Encoding,System.String,System.String)">
  27565. <summary>
  27566. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismPlain"/> class.
  27567. </summary>
  27568. <remarks>
  27569. Creates a new PLAIN SASL context.
  27570. </remarks>
  27571. <param name="uri">The URI of the service.</param>
  27572. <param name="encoding">The encoding to use for the user's credentials.</param>
  27573. <param name="userName">The user name.</param>
  27574. <param name="password">The password.</param>
  27575. <exception cref="T:System.ArgumentNullException">
  27576. <para><paramref name="uri"/> is <c>null</c>.</para>
  27577. <para>-or-</para>
  27578. <para><paramref name="encoding"/> is <c>null</c>.</para>
  27579. <para>-or-</para>
  27580. <para><paramref name="userName"/> is <c>null</c>.</para>
  27581. <para>-or-</para>
  27582. <para><paramref name="password"/> is <c>null</c>.</para>
  27583. </exception>
  27584. </member>
  27585. <member name="M:MailKit.Security.SaslMechanismPlain.#ctor(System.Uri,System.Net.ICredentials)">
  27586. <summary>
  27587. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismPlain"/> class.
  27588. </summary>
  27589. <remarks>
  27590. Creates a new PLAIN SASL context.
  27591. </remarks>
  27592. <param name="uri">The URI of the service.</param>
  27593. <param name="credentials">The user's credentials.</param>
  27594. <exception cref="T:System.ArgumentNullException">
  27595. <para><paramref name="uri"/> is <c>null</c>.</para>
  27596. <para>-or-</para>
  27597. <para><paramref name="credentials"/> is <c>null</c>.</para>
  27598. </exception>
  27599. </member>
  27600. <member name="M:MailKit.Security.SaslMechanismPlain.#ctor(System.Uri,System.String,System.String)">
  27601. <summary>
  27602. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismPlain"/> class.
  27603. </summary>
  27604. <remarks>
  27605. Creates a new PLAIN SASL context.
  27606. </remarks>
  27607. <param name="uri">The URI of the service.</param>
  27608. <param name="userName">The user name.</param>
  27609. <param name="password">The password.</param>
  27610. <exception cref="T:System.ArgumentNullException">
  27611. <para><paramref name="uri"/> is <c>null</c>.</para>
  27612. <para>-or-</para>
  27613. <para><paramref name="userName"/> is <c>null</c>.</para>
  27614. <para>-or-</para>
  27615. <para><paramref name="password"/> is <c>null</c>.</para>
  27616. </exception>
  27617. </member>
  27618. <member name="M:MailKit.Security.SaslMechanismPlain.#ctor(System.Text.Encoding,System.Net.NetworkCredential)">
  27619. <summary>
  27620. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismPlain"/> class.
  27621. </summary>
  27622. <remarks>
  27623. Creates a new PLAIN SASL context.
  27624. </remarks>
  27625. <param name="encoding">The encoding to use for the user's credentials.</param>
  27626. <param name="credentials">The user's credentials.</param>
  27627. <exception cref="T:System.ArgumentNullException">
  27628. <para><paramref name="encoding"/> is <c>null</c>.</para>
  27629. <para>-or-</para>
  27630. <para><paramref name="credentials"/> is <c>null</c>.</para>
  27631. </exception>
  27632. </member>
  27633. <member name="M:MailKit.Security.SaslMechanismPlain.#ctor(System.Text.Encoding,System.String,System.String)">
  27634. <summary>
  27635. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismPlain"/> class.
  27636. </summary>
  27637. <remarks>
  27638. Creates a new PLAIN SASL context.
  27639. </remarks>
  27640. <param name="encoding">The encoding to use for the user's credentials.</param>
  27641. <param name="userName">The user name.</param>
  27642. <param name="password">The password.</param>
  27643. <exception cref="T:System.ArgumentNullException">
  27644. <para><paramref name="encoding"/> is <c>null</c>.</para>
  27645. <para>-or-</para>
  27646. <para><paramref name="userName"/> is <c>null</c>.</para>
  27647. <para>-or-</para>
  27648. <para><paramref name="password"/> is <c>null</c>.</para>
  27649. </exception>
  27650. </member>
  27651. <member name="M:MailKit.Security.SaslMechanismPlain.#ctor(System.Net.NetworkCredential)">
  27652. <summary>
  27653. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismPlain"/> class.
  27654. </summary>
  27655. <remarks>
  27656. Creates a new PLAIN SASL context.
  27657. </remarks>
  27658. <param name="credentials">The user's credentials.</param>
  27659. <exception cref="T:System.ArgumentNullException">
  27660. <paramref name="credentials"/> is <c>null</c>.
  27661. </exception>
  27662. </member>
  27663. <member name="M:MailKit.Security.SaslMechanismPlain.#ctor(System.String,System.String)">
  27664. <summary>
  27665. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismPlain"/> class.
  27666. </summary>
  27667. <remarks>
  27668. Creates a new PLAIN SASL context.
  27669. </remarks>
  27670. <param name="userName">The user name.</param>
  27671. <param name="password">The password.</param>
  27672. <exception cref="T:System.ArgumentNullException">
  27673. <para><paramref name="userName"/> is <c>null</c>.</para>
  27674. <para>-or-</para>
  27675. <para><paramref name="password"/> is <c>null</c>.</para>
  27676. </exception>
  27677. </member>
  27678. <member name="P:MailKit.Security.SaslMechanismPlain.AuthorizationId">
  27679. <summary>
  27680. Gets or sets the authorization identifier.
  27681. </summary>
  27682. <remarks>
  27683. The authorization identifier is the desired user account that the server should use
  27684. for all accesses. This is separate from the user name used for authentication.
  27685. </remarks>
  27686. <value>The authorization identifier.</value>
  27687. </member>
  27688. <member name="P:MailKit.Security.SaslMechanismPlain.MechanismName">
  27689. <summary>
  27690. Gets the name of the mechanism.
  27691. </summary>
  27692. <remarks>
  27693. Gets the name of the mechanism.
  27694. </remarks>
  27695. <value>The name of the mechanism.</value>
  27696. </member>
  27697. <member name="P:MailKit.Security.SaslMechanismPlain.SupportsInitialResponse">
  27698. <summary>
  27699. Gets whether or not the mechanism supports an initial response (SASL-IR).
  27700. </summary>
  27701. <remarks>
  27702. SASL mechanisms that support sending an initial client response to the server
  27703. should return <value>true</value>.
  27704. </remarks>
  27705. <value><c>true</c> if the mechanism supports an initial response; otherwise, <c>false</c>.</value>
  27706. </member>
  27707. <member name="M:MailKit.Security.SaslMechanismPlain.Challenge(System.Byte[],System.Int32,System.Int32)">
  27708. <summary>
  27709. Parses the server's challenge token and returns the next challenge response.
  27710. </summary>
  27711. <remarks>
  27712. Parses the server's challenge token and returns the next challenge response.
  27713. </remarks>
  27714. <returns>The next challenge response.</returns>
  27715. <param name="token">The server's challenge token.</param>
  27716. <param name="startIndex">The index into the token specifying where the server's challenge begins.</param>
  27717. <param name="length">The length of the server's challenge.</param>
  27718. <exception cref="T:System.InvalidOperationException">
  27719. The SASL mechanism is already authenticated.
  27720. </exception>
  27721. <exception cref="T:MailKit.Security.SaslException">
  27722. An error has occurred while parsing the server's challenge token.
  27723. </exception>
  27724. </member>
  27725. <member name="T:MailKit.Security.SaslMechanismScramBase">
  27726. <summary>
  27727. The base class for SCRAM-based SASL mechanisms.
  27728. </summary>
  27729. <remarks>
  27730. SCRAM-based SASL mechanisms are salted challenge/response authentication mechanisms.
  27731. </remarks>
  27732. </member>
  27733. <member name="M:MailKit.Security.SaslMechanismScramBase.#ctor(System.Uri,System.Net.ICredentials)">
  27734. <summary>
  27735. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismScramBase"/> class.
  27736. </summary>
  27737. <remarks>
  27738. Creates a new SCRAM-based SASL context.
  27739. </remarks>
  27740. <param name="uri">The URI of the service.</param>
  27741. <param name="credentials">The user's credentials.</param>
  27742. <exception cref="T:System.ArgumentNullException">
  27743. <para><paramref name="uri"/> is <c>null</c>.</para>
  27744. <para>-or-</para>
  27745. <para><paramref name="credentials"/> is <c>null</c>.</para>
  27746. </exception>
  27747. </member>
  27748. <member name="M:MailKit.Security.SaslMechanismScramBase.#ctor(System.Uri,System.String,System.String)">
  27749. <summary>
  27750. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismScramBase"/> class.
  27751. </summary>
  27752. <remarks>
  27753. Creates a new SCRAM-based SASL context.
  27754. </remarks>
  27755. <param name="uri">The URI of the service.</param>
  27756. <param name="userName">The user name.</param>
  27757. <param name="password">The password.</param>
  27758. <exception cref="T:System.ArgumentNullException">
  27759. <para><paramref name="uri"/> is <c>null</c>.</para>
  27760. <para>-or-</para>
  27761. <para><paramref name="userName"/> is <c>null</c>.</para>
  27762. <para>-or-</para>
  27763. <para><paramref name="password"/> is <c>null</c>.</para>
  27764. </exception>
  27765. </member>
  27766. <member name="M:MailKit.Security.SaslMechanismScramBase.#ctor(System.Net.NetworkCredential)">
  27767. <summary>
  27768. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismScramBase"/> class.
  27769. </summary>
  27770. <remarks>
  27771. Creates a new SCRAM-based SASL context.
  27772. </remarks>
  27773. <param name="credentials">The user's credentials.</param>
  27774. <exception cref="T:System.ArgumentNullException">
  27775. <paramref name="credentials"/> is <c>null</c>.
  27776. </exception>
  27777. </member>
  27778. <member name="M:MailKit.Security.SaslMechanismScramBase.#ctor(System.String,System.String)">
  27779. <summary>
  27780. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismScramBase"/> class.
  27781. </summary>
  27782. <remarks>
  27783. Creates a new SCRAM-based SASL context.
  27784. </remarks>
  27785. <param name="userName">The user name.</param>
  27786. <param name="password">The password.</param>
  27787. <exception cref="T:System.ArgumentNullException">
  27788. <para><paramref name="userName"/> is <c>null</c>.</para>
  27789. <para>-or-</para>
  27790. <para><paramref name="password"/> is <c>null</c>.</para>
  27791. </exception>
  27792. </member>
  27793. <member name="P:MailKit.Security.SaslMechanismScramBase.SupportsInitialResponse">
  27794. <summary>
  27795. Gets whether or not the mechanism supports an initial response (SASL-IR).
  27796. </summary>
  27797. <remarks>
  27798. SASL mechanisms that support sending an initial client response to the server
  27799. should return <value>true</value>.
  27800. </remarks>
  27801. <value><c>true</c> if the mechanism supports an initial response; otherwise, <c>false</c>.</value>
  27802. </member>
  27803. <member name="M:MailKit.Security.SaslMechanismScramBase.CreateHMAC(System.Byte[])">
  27804. <summary>
  27805. Create the HMAC context.
  27806. </summary>
  27807. <remarks>
  27808. Creates the HMAC context using the secret key.
  27809. </remarks>
  27810. <returns>The HMAC context.</returns>
  27811. <param name="key">The secret key.</param>
  27812. </member>
  27813. <member name="M:MailKit.Security.SaslMechanismScramBase.HMAC(System.Byte[],System.Byte[])">
  27814. <summary>
  27815. Apply the HMAC keyed algorithm.
  27816. </summary>
  27817. <remarks>
  27818. HMAC(key, str): Apply the HMAC keyed hash algorithm (defined in
  27819. [RFC2104]) using the octet string represented by "key" as the key
  27820. and the octet string "str" as the input string. The size of the
  27821. result is the hash result size for the hash function in use. For
  27822. example, it is 20 octets for SHA-1 (see [RFC3174]).
  27823. </remarks>
  27824. <returns>The results of the HMAC keyed algorithm.</returns>
  27825. <param name="key">The key.</param>
  27826. <param name="str">The string.</param>
  27827. </member>
  27828. <member name="M:MailKit.Security.SaslMechanismScramBase.Hash(System.Byte[])">
  27829. <summary>
  27830. Apply the cryptographic hash function.
  27831. </summary>
  27832. <remarks>
  27833. H(str): Apply the cryptographic hash function to the octet string
  27834. "str", producing an octet string as a result. The size of the
  27835. result depends on the hash result size for the hash function in
  27836. use.
  27837. </remarks>
  27838. <returns>The results of the hash.</returns>
  27839. <param name="str">The string.</param>
  27840. </member>
  27841. <member name="M:MailKit.Security.SaslMechanismScramBase.Xor(System.Byte[],System.Byte[])">
  27842. <summary>
  27843. Apply the exclusive-or operation to combine two octet strings.
  27844. </summary>
  27845. <remarks>
  27846. Apply the exclusive-or operation to combine the octet string
  27847. on the left of this operator with the octet string on the right of
  27848. this operator. The length of the output and each of the two
  27849. inputs will be the same for this use.
  27850. </remarks>
  27851. <param name="a">The alpha component.</param>
  27852. <param name="b">The blue component.</param>
  27853. </member>
  27854. <member name="M:MailKit.Security.SaslMechanismScramBase.Challenge(System.Byte[],System.Int32,System.Int32)">
  27855. <summary>
  27856. Parses the server's challenge token and returns the next challenge response.
  27857. </summary>
  27858. <remarks>
  27859. Parses the server's challenge token and returns the next challenge response.
  27860. </remarks>
  27861. <returns>The next challenge response.</returns>
  27862. <param name="token">The server's challenge token.</param>
  27863. <param name="startIndex">The index into the token specifying where the server's challenge begins.</param>
  27864. <param name="length">The length of the server's challenge.</param>
  27865. <exception cref="T:System.InvalidOperationException">
  27866. The SASL mechanism is already authenticated.
  27867. </exception>
  27868. <exception cref="T:MailKit.Security.SaslException">
  27869. An error has occurred while parsing the server's challenge token.
  27870. </exception>
  27871. </member>
  27872. <member name="M:MailKit.Security.SaslMechanismScramBase.Reset">
  27873. <summary>
  27874. Resets the state of the SASL mechanism.
  27875. </summary>
  27876. <remarks>
  27877. Resets the state of the SASL mechanism.
  27878. </remarks>
  27879. </member>
  27880. <member name="T:MailKit.Security.SaslMechanismScramSha1">
  27881. <summary>
  27882. The SCRAM-SHA-1 SASL mechanism.
  27883. </summary>
  27884. <remarks>
  27885. A salted challenge/response SASL mechanism that uses the HMAC SHA-1 algorithm.
  27886. </remarks>
  27887. </member>
  27888. <member name="M:MailKit.Security.SaslMechanismScramSha1.#ctor(System.Uri,System.Net.ICredentials)">
  27889. <summary>
  27890. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismScramSha1"/> class.
  27891. </summary>
  27892. <remarks>
  27893. Creates a new SCRAM-SHA-1 SASL context.
  27894. </remarks>
  27895. <param name="uri">The URI of the service.</param>
  27896. <param name="credentials">The user's credentials.</param>
  27897. <exception cref="T:System.ArgumentNullException">
  27898. <para><paramref name="uri"/> is <c>null</c>.</para>
  27899. <para>-or-</para>
  27900. <para><paramref name="credentials"/> is <c>null</c>.</para>
  27901. </exception>
  27902. </member>
  27903. <member name="M:MailKit.Security.SaslMechanismScramSha1.#ctor(System.Uri,System.String,System.String)">
  27904. <summary>
  27905. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismScramSha1"/> class.
  27906. </summary>
  27907. <remarks>
  27908. Creates a new SCRAM-SHA-1 SASL context.
  27909. </remarks>
  27910. <param name="uri">The URI of the service.</param>
  27911. <param name="userName">The user name.</param>
  27912. <param name="password">The password.</param>
  27913. <exception cref="T:System.ArgumentNullException">
  27914. <para><paramref name="uri"/> is <c>null</c>.</para>
  27915. <para>-or-</para>
  27916. <para><paramref name="userName"/> is <c>null</c>.</para>
  27917. <para>-or-</para>
  27918. <para><paramref name="password"/> is <c>null</c>.</para>
  27919. </exception>
  27920. </member>
  27921. <member name="M:MailKit.Security.SaslMechanismScramSha1.#ctor(System.Net.NetworkCredential)">
  27922. <summary>
  27923. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismScramSha1"/> class.
  27924. </summary>
  27925. <remarks>
  27926. Creates a new SCRAM-SHA-1 SASL context.
  27927. </remarks>
  27928. <param name="credentials">The user's credentials.</param>
  27929. <exception cref="T:System.ArgumentNullException">
  27930. <paramref name="credentials"/> is <c>null</c>.
  27931. </exception>
  27932. </member>
  27933. <member name="M:MailKit.Security.SaslMechanismScramSha1.#ctor(System.String,System.String)">
  27934. <summary>
  27935. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismScramSha1"/> class.
  27936. </summary>
  27937. <remarks>
  27938. Creates a new SCRAM-SHA-1 SASL context.
  27939. </remarks>
  27940. <param name="userName">The user name.</param>
  27941. <param name="password">The password.</param>
  27942. <exception cref="T:System.ArgumentNullException">
  27943. <para><paramref name="userName"/> is <c>null</c>.</para>
  27944. <para>-or-</para>
  27945. <para><paramref name="password"/> is <c>null</c>.</para>
  27946. </exception>
  27947. </member>
  27948. <member name="P:MailKit.Security.SaslMechanismScramSha1.MechanismName">
  27949. <summary>
  27950. Gets the name of the mechanism.
  27951. </summary>
  27952. <remarks>
  27953. Gets the name of the mechanism.
  27954. </remarks>
  27955. <value>The name of the mechanism.</value>
  27956. </member>
  27957. <member name="M:MailKit.Security.SaslMechanismScramSha1.CreateHMAC(System.Byte[])">
  27958. <summary>
  27959. Create the HMAC context.
  27960. </summary>
  27961. <remarks>
  27962. Creates the HMAC context using the secret key.
  27963. </remarks>
  27964. <returns>The HMAC context.</returns>
  27965. <param name="key">The secret key.</param>
  27966. </member>
  27967. <member name="M:MailKit.Security.SaslMechanismScramSha1.Hash(System.Byte[])">
  27968. <summary>
  27969. Apply the cryptographic hash function.
  27970. </summary>
  27971. <remarks>
  27972. H(str): Apply the cryptographic hash function to the octet string
  27973. "str", producing an octet string as a result. The size of the
  27974. result depends on the hash result size for the hash function in
  27975. use.
  27976. </remarks>
  27977. <returns>The results of the hash.</returns>
  27978. <param name="str">The string.</param>
  27979. </member>
  27980. <member name="T:MailKit.Security.SaslMechanismScramSha256">
  27981. <summary>
  27982. The SCRAM-SHA-256 SASL mechanism.
  27983. </summary>
  27984. <remarks>
  27985. A salted challenge/response SASL mechanism that uses the HMAC SHA-256 algorithm.
  27986. </remarks>
  27987. </member>
  27988. <member name="M:MailKit.Security.SaslMechanismScramSha256.#ctor(System.Uri,System.Net.ICredentials)">
  27989. <summary>
  27990. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismScramSha256"/> class.
  27991. </summary>
  27992. <remarks>
  27993. Creates a new SCRAM-SHA-256 SASL context.
  27994. </remarks>
  27995. <param name="uri">The URI of the service.</param>
  27996. <param name="credentials">The user's credentials.</param>
  27997. <exception cref="T:System.ArgumentNullException">
  27998. <para><paramref name="uri"/> is <c>null</c>.</para>
  27999. <para>-or-</para>
  28000. <para><paramref name="credentials"/> is <c>null</c>.</para>
  28001. </exception>
  28002. </member>
  28003. <member name="M:MailKit.Security.SaslMechanismScramSha256.#ctor(System.Uri,System.String,System.String)">
  28004. <summary>
  28005. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismScramSha256"/> class.
  28006. </summary>
  28007. <remarks>
  28008. Creates a new SCRAM-SHA-256 SASL context.
  28009. </remarks>
  28010. <param name="uri">The URI of the service.</param>
  28011. <param name="userName">The user name.</param>
  28012. <param name="password">The password.</param>
  28013. <exception cref="T:System.ArgumentNullException">
  28014. <para><paramref name="uri"/> is <c>null</c>.</para>
  28015. <para>-or-</para>
  28016. <para><paramref name="userName"/> is <c>null</c>.</para>
  28017. <para>-or-</para>
  28018. <para><paramref name="password"/> is <c>null</c>.</para>
  28019. </exception>
  28020. </member>
  28021. <member name="M:MailKit.Security.SaslMechanismScramSha256.#ctor(System.Net.NetworkCredential)">
  28022. <summary>
  28023. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismScramSha256"/> class.
  28024. </summary>
  28025. <remarks>
  28026. Creates a new SCRAM-SHA-256 SASL context.
  28027. </remarks>
  28028. <param name="credentials">The user's credentials.</param>
  28029. <exception cref="T:System.ArgumentNullException">
  28030. <paramref name="credentials"/> is <c>null</c>.
  28031. </exception>
  28032. </member>
  28033. <member name="M:MailKit.Security.SaslMechanismScramSha256.#ctor(System.String,System.String)">
  28034. <summary>
  28035. Initializes a new instance of the <see cref="T:MailKit.Security.SaslMechanismScramSha256"/> class.
  28036. </summary>
  28037. <remarks>
  28038. Creates a new SCRAM-SHA-256 SASL context.
  28039. </remarks>
  28040. <param name="userName">The user name.</param>
  28041. <param name="password">The password.</param>
  28042. <exception cref="T:System.ArgumentNullException">
  28043. <para><paramref name="userName"/> is <c>null</c>.</para>
  28044. <para>-or-</para>
  28045. <para><paramref name="password"/> is <c>null</c>.</para>
  28046. </exception>
  28047. </member>
  28048. <member name="P:MailKit.Security.SaslMechanismScramSha256.MechanismName">
  28049. <summary>
  28050. Gets the name of the mechanism.
  28051. </summary>
  28052. <remarks>
  28053. Gets the name of the mechanism.
  28054. </remarks>
  28055. <value>The name of the mechanism.</value>
  28056. </member>
  28057. <member name="M:MailKit.Security.SaslMechanismScramSha256.CreateHMAC(System.Byte[])">
  28058. <summary>
  28059. Create the HMAC context.
  28060. </summary>
  28061. <remarks>
  28062. Creates the HMAC context using the secret key.
  28063. </remarks>
  28064. <returns>The HMAC context.</returns>
  28065. <param name="key">The secret key.</param>
  28066. </member>
  28067. <member name="M:MailKit.Security.SaslMechanismScramSha256.Hash(System.Byte[])">
  28068. <summary>
  28069. Apply the cryptographic hash function.
  28070. </summary>
  28071. <remarks>
  28072. H(str): Apply the cryptographic hash function to the octet string
  28073. "str", producing an octet string as a result. The size of the
  28074. result depends on the hash result size for the hash function in
  28075. use.
  28076. </remarks>
  28077. <returns>The results of the hash.</returns>
  28078. <param name="str">The string.</param>
  28079. </member>
  28080. <member name="T:MailKit.Security.SecureSocketOptions">
  28081. <summary>
  28082. Secure socket options.
  28083. </summary>
  28084. <remarks>
  28085. Provides a way of specifying the SSL and/or TLS encryption that
  28086. should be used for a connection.
  28087. </remarks>
  28088. </member>
  28089. <member name="F:MailKit.Security.SecureSocketOptions.None">
  28090. <summary>
  28091. No SSL or TLS encryption should be used.
  28092. </summary>
  28093. </member>
  28094. <member name="F:MailKit.Security.SecureSocketOptions.Auto">
  28095. <summary>
  28096. Allow the <see cref="T:MailKit.IMailService"/> to decide which SSL or TLS
  28097. options to use (default). If the server does not support SSL or TLS,
  28098. then the connection will continue without any encryption.
  28099. </summary>
  28100. </member>
  28101. <member name="F:MailKit.Security.SecureSocketOptions.SslOnConnect">
  28102. <summary>
  28103. The connection should use SSL or TLS encryption immediately.
  28104. </summary>
  28105. </member>
  28106. <member name="F:MailKit.Security.SecureSocketOptions.StartTls">
  28107. <summary>
  28108. Elevates the connection to use TLS encryption immediately after
  28109. reading the greeting and capabilities of the server. If the server
  28110. does not support the STARTTLS extension, then the connection will
  28111. fail and a <see cref="T:System.NotSupportedException"/> will be thrown.
  28112. </summary>
  28113. </member>
  28114. <member name="F:MailKit.Security.SecureSocketOptions.StartTlsWhenAvailable">
  28115. <summary>
  28116. Elevates the connection to use TLS encryption immediately after
  28117. reading the greeting and capabilities of the server, but only if
  28118. the server supports the STARTTLS extension.
  28119. </summary>
  28120. </member>
  28121. <member name="T:MailKit.Security.SslHandshakeException">
  28122. <summary>
  28123. The exception that is thrown when there is an error during the SSL/TLS handshake.
  28124. </summary>
  28125. <remarks>
  28126. <para>The exception that is thrown when there is an error during the SSL/TLS handshake.</para>
  28127. <para>When this exception occurrs, it typically means that the IMAP, POP3 or SMTP server that
  28128. you are connecting to is using an SSL certificate that is either expired or untrusted by
  28129. your system.</para>
  28130. <para>Often times, mail servers will use self-signed certificates instead of using a certificate
  28131. that has been signed by a trusted Certificate Authority. When your system is unable to validate
  28132. the mail server's certificate because it is not signed by a known and trusted Certificate Authority,
  28133. this exception will occur.</para>
  28134. <para>You can work around this problem by supplying a custom <see cref="T:System.Net.Security.RemoteCertificateValidationCallback"/>
  28135. and setting it on the client's <see cref="P:MailKit.MailService.ServerCertificateValidationCallback"/> property.</para>
  28136. <para>Most likely, you'll want to compare the thumbprint of the server's certificate with a known
  28137. value and/or prompt the user to accept the certificate (similar to what you've probably seen web
  28138. browsers do when they encounter untrusted certificates).</para>
  28139. </remarks>
  28140. </member>
  28141. <member name="M:MailKit.Security.SslHandshakeException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  28142. <summary>
  28143. Initializes a new instance of the <see cref="T:MailKit.Security.SslHandshakeException"/> class.
  28144. </summary>
  28145. <remarks>
  28146. Creates a new <see cref="T:MailKit.Security.SslHandshakeException"/> from the seriaized data.
  28147. </remarks>
  28148. <param name="info">The serialization info.</param>
  28149. <param name="context">The streaming context.</param>
  28150. <exception cref="T:System.ArgumentNullException">
  28151. <paramref name="info"/> is <c>null</c>.
  28152. </exception>
  28153. </member>
  28154. <member name="M:MailKit.Security.SslHandshakeException.#ctor(System.String,System.Exception)">
  28155. <summary>
  28156. Initializes a new instance of the <see cref="T:MailKit.Security.SslHandshakeException"/> class.
  28157. </summary>
  28158. <remarks>
  28159. Creates a new <see cref="T:MailKit.Security.SslHandshakeException"/>.
  28160. </remarks>
  28161. <param name="message">The error message.</param>
  28162. <param name="innerException">An inner exception.</param>
  28163. </member>
  28164. <member name="M:MailKit.Security.SslHandshakeException.#ctor(System.String)">
  28165. <summary>
  28166. Initializes a new instance of the <see cref="T:MailKit.Security.SslHandshakeException"/> class.
  28167. </summary>
  28168. <remarks>
  28169. Creates a new <see cref="T:MailKit.Security.SslHandshakeException"/>.
  28170. </remarks>
  28171. <param name="message">The error message.</param>
  28172. </member>
  28173. <member name="M:MailKit.Security.SslHandshakeException.#ctor">
  28174. <summary>
  28175. Initializes a new instance of the <see cref="T:MailKit.Security.SslHandshakeException"/> class.
  28176. </summary>
  28177. <remarks>
  28178. Creates a new <see cref="T:MailKit.Security.SslHandshakeException"/>.
  28179. </remarks>
  28180. </member>
  28181. <member name="P:MailKit.Security.SslHandshakeException.ServerCertificate">
  28182. <summary>
  28183. Get the server's SSL certificate.
  28184. </summary>
  28185. <remarks>
  28186. Gets the server's SSL certificate, if it is available.
  28187. </remarks>
  28188. <value>The server's SSL certificate.</value>
  28189. </member>
  28190. <member name="P:MailKit.Security.SslHandshakeException.RootCertificateAuthority">
  28191. <summary>
  28192. Get the certificate for the Root Certificate Authority.
  28193. </summary>
  28194. <remarks>
  28195. Gets the certificate for the Root Certificate Authority, if it is available.
  28196. </remarks>
  28197. <value>The Root Certificate Authority certificate.</value>
  28198. </member>
  28199. <member name="M:MailKit.Security.SslHandshakeException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  28200. <summary>
  28201. When overridden in a derived class, sets the <see cref="T:System.Runtime.Serialization.SerializationInfo"/>
  28202. with information about the exception.
  28203. </summary>
  28204. <remarks>
  28205. Sets the <see cref="T:System.Runtime.Serialization.SerializationInfo"/>
  28206. with information about the exception.
  28207. </remarks>
  28208. <param name="info">The serialization info.</param>
  28209. <param name="context">The streaming context.</param>
  28210. <exception cref="T:System.ArgumentNullException">
  28211. <paramref name="info"/> is <c>null</c>.
  28212. </exception>
  28213. </member>
  28214. <member name="T:MailKit.AccessControl">
  28215. <summary>
  28216. An Access Control.
  28217. </summary>
  28218. <remarks>
  28219. An Access Control is a set of permissions available for a particular identity,
  28220. controlling whether or not that identity has the ability to perform various tasks.
  28221. </remarks>
  28222. <example>
  28223. <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
  28224. </example>
  28225. </member>
  28226. <member name="M:MailKit.AccessControl.#ctor(System.String,System.Collections.Generic.IEnumerable{MailKit.AccessRight})">
  28227. <summary>
  28228. Initializes a new instance of the <see cref="T:MailKit.AccessControl"/> class.
  28229. </summary>
  28230. <remarks>
  28231. Creates a new <see cref="T:MailKit.AccessControl"/> with the given name and
  28232. access rights.
  28233. </remarks>
  28234. <param name="name">The identifier name.</param>
  28235. <param name="rights">The access rights.</param>
  28236. <exception cref="T:System.ArgumentNullException">
  28237. <para><paramref name="name"/> is <c>null</c>.</para>
  28238. <para>-or-</para>
  28239. <para><paramref name="rights"/> is <c>null</c>.</para>
  28240. </exception>
  28241. </member>
  28242. <member name="M:MailKit.AccessControl.#ctor(System.String,System.String)">
  28243. <summary>
  28244. Initializes a new instance of the <see cref="T:MailKit.AccessControl"/> class.
  28245. </summary>
  28246. <remarks>
  28247. Creates a new <see cref="T:MailKit.AccessControl"/> with the given name and
  28248. access rights.
  28249. </remarks>
  28250. <param name="name">The identifier name.</param>
  28251. <param name="rights">The access rights.</param>
  28252. <exception cref="T:System.ArgumentNullException">
  28253. <para><paramref name="name"/> is <c>null</c>.</para>
  28254. <para>-or-</para>
  28255. <para><paramref name="rights"/> is <c>null</c>.</para>
  28256. </exception>
  28257. </member>
  28258. <member name="M:MailKit.AccessControl.#ctor(System.String)">
  28259. <summary>
  28260. Initializes a new instance of the <see cref="T:MailKit.AccessControl"/> class.
  28261. </summary>
  28262. <remarks>
  28263. Creates a new <see cref="T:MailKit.AccessControl"/> with the given name and no
  28264. access rights.
  28265. </remarks>
  28266. <param name="name">The identifier name.</param>
  28267. <exception cref="T:System.ArgumentNullException">
  28268. <paramref name="name"/> is <c>null</c>.
  28269. </exception>
  28270. </member>
  28271. <member name="P:MailKit.AccessControl.Name">
  28272. <summary>
  28273. The identifier name for the access control.
  28274. </summary>
  28275. <remarks>
  28276. The identifier name for the access control.
  28277. </remarks>
  28278. <example>
  28279. <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
  28280. </example>
  28281. <value>The identifier name.</value>
  28282. </member>
  28283. <member name="P:MailKit.AccessControl.Rights">
  28284. <summary>
  28285. Get the access rights.
  28286. </summary>
  28287. <remarks>
  28288. Gets the access rights.
  28289. </remarks>
  28290. <example>
  28291. <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
  28292. </example>
  28293. <value>The access rights.</value>
  28294. </member>
  28295. <member name="T:MailKit.AccessControlList">
  28296. <summary>
  28297. An Access Control List (ACL)
  28298. </summary>
  28299. <remarks>
  28300. An Access Control List (ACL) is a list of access controls defining the permissions
  28301. various identities have available.
  28302. </remarks>
  28303. <example>
  28304. <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
  28305. </example>
  28306. </member>
  28307. <member name="M:MailKit.AccessControlList.#ctor(System.Collections.Generic.IEnumerable{MailKit.AccessControl})">
  28308. <summary>
  28309. Initializes a new instance of the <see cref="T:MailKit.AccessControlList"/> class.
  28310. </summary>
  28311. <remarks>
  28312. Creates a new <see cref="T:MailKit.AccessControlList"/>.
  28313. </remarks>
  28314. <param name="controls">The list of access controls.</param>
  28315. <exception cref="T:System.ArgumentNullException">
  28316. <paramref name="controls"/> is <c>null</c>.
  28317. </exception>
  28318. </member>
  28319. <member name="M:MailKit.AccessControlList.#ctor">
  28320. <summary>
  28321. Initializes a new instance of the <see cref="T:MailKit.AccessControlList"/> class.
  28322. </summary>
  28323. <remarks>
  28324. Creates a new <see cref="T:MailKit.AccessControlList"/>.
  28325. </remarks>
  28326. </member>
  28327. <member name="T:MailKit.AccessRight">
  28328. <summary>
  28329. An individual Access Right to be used with ACLs.
  28330. </summary>
  28331. <remarks>
  28332. <para>An individual Access Right meant to be used with
  28333. <see cref="T:MailKit.AccessControlList"/>.</para>
  28334. <para>For more information on what rights are available,
  28335. see https://tools.ietf.org/html/rfc4314#section-2.1
  28336. </para>
  28337. </remarks>
  28338. </member>
  28339. <member name="F:MailKit.AccessRight.LookupFolder">
  28340. <summary>
  28341. The access right for folder lookups.
  28342. </summary>
  28343. <remarks>
  28344. Allows the <see cref="T:MailKit.IMailFolder"/> to be visible when listing folders.
  28345. </remarks>
  28346. </member>
  28347. <member name="F:MailKit.AccessRight.OpenFolder">
  28348. <summary>
  28349. The access right for opening a folder and getting the status.
  28350. </summary>
  28351. <remarks>
  28352. Provides access for opening and getting the status of the folder.
  28353. </remarks>
  28354. </member>
  28355. <member name="F:MailKit.AccessRight.SetMessageSeen">
  28356. <summary>
  28357. The access right for adding or removing the Seen flag on messages in the folder.
  28358. </summary>
  28359. <remarks>
  28360. Provides access to add or remove the <see cref="F:MailKit.MessageFlags.Seen"/> flag on messages within the
  28361. <see cref="T:MailKit.IMailFolder"/>.
  28362. </remarks>
  28363. </member>
  28364. <member name="F:MailKit.AccessRight.SetMessageFlags">
  28365. <summary>
  28366. The access right for adding or removing flags (other than Seen and Deleted)
  28367. on messages in a folder.
  28368. </summary>
  28369. <remarks>
  28370. Provides access to add or remove the <see cref="T:MailKit.MessageFlags"/> on messages
  28371. (other than <see cref="F:MailKit.MessageFlags.Seen"/> and
  28372. <see cref="F:MailKit.MessageFlags.Deleted"/>) within the folder.
  28373. </remarks>
  28374. </member>
  28375. <member name="F:MailKit.AccessRight.AppendMessages">
  28376. <summary>
  28377. The access right allowing messages to be appended or copied into the folder.
  28378. </summary>
  28379. <remarks>
  28380. Provides access to append or copy messages into the folder.
  28381. </remarks>
  28382. </member>
  28383. <member name="F:MailKit.AccessRight.CreateFolder">
  28384. <summary>
  28385. The access right allowing subfolders to be created.
  28386. </summary>
  28387. <remarks>
  28388. Provides access to create subfolders.
  28389. </remarks>
  28390. </member>
  28391. <member name="F:MailKit.AccessRight.DeleteFolder">
  28392. <summary>
  28393. The access right for deleting a folder and/or its subfolders.
  28394. </summary>
  28395. <remarks>
  28396. Provides access to delete the folder and/or any subfolders.
  28397. </remarks>
  28398. </member>
  28399. <member name="F:MailKit.AccessRight.SetMessageDeleted">
  28400. <summary>
  28401. The access right for adding or removing the Deleted flag to messages within a folder.
  28402. </summary>
  28403. <remarks>
  28404. Provides access to add or remove the <see cref="F:MailKit.MessageFlags.Deleted"/> flag from
  28405. messages within the folder. It also provides access for setting the
  28406. <see cref="F:MailKit.MessageFlags.Deleted"/> flag when appending a message to a folder.
  28407. </remarks>
  28408. </member>
  28409. <member name="F:MailKit.AccessRight.ExpungeFolder">
  28410. <summary>
  28411. The access right for expunging deleted messages in a folder.
  28412. </summary>
  28413. <remarks>
  28414. Provides access to expunge deleted messages in a folder.
  28415. </remarks>
  28416. </member>
  28417. <member name="F:MailKit.AccessRight.Administer">
  28418. <summary>
  28419. The access right for administering the ACLs of a folder.
  28420. </summary>
  28421. <remarks>
  28422. Provides administrative access to change the ACLs for the folder.
  28423. </remarks>
  28424. </member>
  28425. <member name="F:MailKit.AccessRight.Right">
  28426. <summary>
  28427. The character representing the particular access right.
  28428. </summary>
  28429. <remarks>
  28430. Represents the character value of the access right.
  28431. </remarks>
  28432. </member>
  28433. <member name="M:MailKit.AccessRight.#ctor(System.Char)">
  28434. <summary>
  28435. Initializes a new instance of the <see cref="T:MailKit.AccessRight"/> struct.
  28436. </summary>
  28437. <remarks>
  28438. Creates a new <see cref="T:MailKit.AccessRight"/> struct.
  28439. </remarks>
  28440. <param name="right">The access right.</param>
  28441. </member>
  28442. <member name="M:MailKit.AccessRight.Equals(MailKit.AccessRight)">
  28443. <summary>
  28444. Determines whether the specified <see cref="T:MailKit.AccessRight"/> is equal to the current <see cref="T:MailKit.AccessRight"/>.
  28445. </summary>
  28446. <remarks>
  28447. Determines whether the specified <see cref="T:MailKit.AccessRight"/> is equal to the current <see cref="T:MailKit.AccessRight"/>.
  28448. </remarks>
  28449. <param name="other">The <see cref="T:MailKit.AccessRight"/> to compare with the current <see cref="T:MailKit.AccessRight"/>.</param>
  28450. <returns><c>true</c> if the specified <see cref="T:MailKit.AccessRight"/> is equal to the current
  28451. <see cref="T:MailKit.AccessRight"/>; otherwise, <c>false</c>.</returns>
  28452. </member>
  28453. <member name="M:MailKit.AccessRight.op_Equality(MailKit.AccessRight,MailKit.AccessRight)">
  28454. <summary>
  28455. Determines whether two access rights are equal.
  28456. </summary>
  28457. <remarks>
  28458. Determines whether two access rights are equal.
  28459. </remarks>
  28460. <returns><c>true</c> if <paramref name="right1"/> and <paramref name="right2"/> are equal; otherwise, <c>false</c>.</returns>
  28461. <param name="right1">The first access right to compare.</param>
  28462. <param name="right2">The second access right to compare.</param>
  28463. </member>
  28464. <member name="M:MailKit.AccessRight.op_Inequality(MailKit.AccessRight,MailKit.AccessRight)">
  28465. <summary>
  28466. Determines whether two access rights are not equal.
  28467. </summary>
  28468. <remarks>
  28469. Determines whether two access rights are not equal.
  28470. </remarks>
  28471. <returns><c>true</c> if <paramref name="right1"/> and <paramref name="right2"/> are not equal; otherwise, <c>false</c>.</returns>
  28472. <param name="right1">The first access right to compare.</param>
  28473. <param name="right2">The second access right to compare.</param>
  28474. </member>
  28475. <member name="M:MailKit.AccessRight.Equals(System.Object)">
  28476. <summary>
  28477. Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:MailKit.AccessRight"/>.
  28478. </summary>
  28479. <remarks>
  28480. Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:MailKit.AccessRight"/>.
  28481. </remarks>
  28482. <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:MailKit.AccessRight"/>.</param>
  28483. <returns><c>true</c> if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:MailKit.AccessRight"/>;
  28484. otherwise, <c>false</c>.</returns>
  28485. </member>
  28486. <member name="M:MailKit.AccessRight.GetHashCode">
  28487. <summary>
  28488. Serves as a hash function for a <see cref="T:MailKit.AccessRight"/> object.
  28489. </summary>
  28490. <remarks>
  28491. Serves as a hash function for a <see cref="T:MailKit.AccessRight"/> object.
  28492. </remarks>
  28493. <returns>A hash code for this instance that is suitable for use in hashing algorithms and data structures such as a hash table.</returns>
  28494. </member>
  28495. <member name="M:MailKit.AccessRight.ToString">
  28496. <summary>
  28497. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.AccessRight"/>.
  28498. </summary>
  28499. <remarks>
  28500. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.AccessRight"/>.
  28501. </remarks>
  28502. <returns>A <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.AccessRight"/>.</returns>
  28503. </member>
  28504. <member name="T:MailKit.AccessRights">
  28505. <summary>
  28506. A set of access rights.
  28507. </summary>
  28508. <remarks>
  28509. The set of access rights for a particular identity.
  28510. </remarks>
  28511. </member>
  28512. <member name="M:MailKit.AccessRights.#ctor(System.Collections.Generic.IEnumerable{MailKit.AccessRight})">
  28513. <summary>
  28514. Initializes a new instance of the <see cref="T:MailKit.AccessRights"/> class.
  28515. </summary>
  28516. <remarks>
  28517. Creates a new set of access rights.
  28518. </remarks>
  28519. <param name="rights">The access rights.</param>
  28520. <exception cref="T:System.ArgumentNullException">
  28521. <paramref name="rights"/> is <c>null</c>.
  28522. </exception>
  28523. </member>
  28524. <member name="M:MailKit.AccessRights.#ctor(System.String)">
  28525. <summary>
  28526. Initializes a new instance of the <see cref="T:MailKit.AccessRights"/> class.
  28527. </summary>
  28528. <remarks>
  28529. Creates a new set of access rights.
  28530. </remarks>
  28531. <param name="rights">The access rights.</param>
  28532. <exception cref="T:System.ArgumentNullException">
  28533. <paramref name="rights"/> is <c>null</c>.
  28534. </exception>
  28535. </member>
  28536. <member name="M:MailKit.AccessRights.#ctor">
  28537. <summary>
  28538. Initializes a new instance of the <see cref="T:MailKit.AccessRights"/> class.
  28539. </summary>
  28540. <remarks>
  28541. Creates an empty set of access rights.
  28542. </remarks>
  28543. </member>
  28544. <member name="P:MailKit.AccessRights.Count">
  28545. <summary>
  28546. Get the number of access rights in the collection.
  28547. </summary>
  28548. <remarks>
  28549. Gets the number of access rights in the collection.
  28550. </remarks>
  28551. <value>The count.</value>
  28552. </member>
  28553. <member name="P:MailKit.AccessRights.IsReadOnly">
  28554. <summary>
  28555. Get whether or not this set of access rights is read only.
  28556. </summary>
  28557. <remarks>
  28558. Gets whether or not this set of access rights is read only.
  28559. </remarks>
  28560. <value><c>true</c> if this collection is read only; otherwise, <c>false</c>.</value>
  28561. </member>
  28562. <member name="M:MailKit.AccessRights.System#Collections#Generic#ICollection{MailKit#AccessRight}#Add(MailKit.AccessRight)">
  28563. <summary>
  28564. Add the specified access right.
  28565. </summary>
  28566. <remarks>
  28567. Adds the specified access right if it is not already included.
  28568. </remarks>
  28569. <param name="right">The access right.</param>
  28570. </member>
  28571. <member name="M:MailKit.AccessRights.Add(MailKit.AccessRight)">
  28572. <summary>
  28573. Add the specified access right.
  28574. </summary>
  28575. <remarks>
  28576. Adds the specified access right if it is not already included.
  28577. </remarks>
  28578. <returns><c>true</c> if the right was added; otherwise, <c>false</c>.</returns>
  28579. <param name="right">The access right.</param>
  28580. </member>
  28581. <member name="M:MailKit.AccessRights.Add(System.Char)">
  28582. <summary>
  28583. Add the specified right.
  28584. </summary>
  28585. <remarks>
  28586. Adds the right specified by the given character.
  28587. </remarks>
  28588. <returns><c>true</c> if the right was added; otherwise, <c>false</c>.</returns>
  28589. <param name="right">The right.</param>
  28590. </member>
  28591. <member name="M:MailKit.AccessRights.AddRange(System.String)">
  28592. <summary>
  28593. Add the rights specified by the characters in the given string.
  28594. </summary>
  28595. <remarks>
  28596. Adds the rights specified by the characters in the given string.
  28597. </remarks>
  28598. <param name="rights">The rights.</param>
  28599. <exception cref="T:System.ArgumentNullException">
  28600. <paramref name="rights"/> is <c>null</c>.
  28601. </exception>
  28602. </member>
  28603. <member name="M:MailKit.AccessRights.AddRange(System.Collections.Generic.IEnumerable{MailKit.AccessRight})">
  28604. <summary>
  28605. Add the range of specified rights.
  28606. </summary>
  28607. <remarks>
  28608. Adds the range of specified rights.
  28609. </remarks>
  28610. <param name="rights">The rights.</param>
  28611. <exception cref="T:System.ArgumentNullException">
  28612. <paramref name="rights"/> is <c>null</c>.
  28613. </exception>
  28614. </member>
  28615. <member name="M:MailKit.AccessRights.Clear">
  28616. <summary>
  28617. Clears the access rights.
  28618. </summary>
  28619. <remarks>
  28620. Removes all of the access rights.
  28621. </remarks>
  28622. </member>
  28623. <member name="M:MailKit.AccessRights.Contains(MailKit.AccessRight)">
  28624. <summary>
  28625. Checks if the set of access rights contains the specified right.
  28626. </summary>
  28627. <remarks>
  28628. Determines whether or not the set of access rights already contains the specified right
  28629. </remarks>
  28630. <returns><value>true</value> if the specified right exists; otherwise <value>false</value>.</returns>
  28631. <param name="right">The access right.</param>
  28632. </member>
  28633. <member name="M:MailKit.AccessRights.CopyTo(MailKit.AccessRight[],System.Int32)">
  28634. <summary>
  28635. Copies all of the access rights to the specified array.
  28636. </summary>
  28637. <remarks>
  28638. Copies all of the access rights into the array,
  28639. starting at the specified array index.
  28640. </remarks>
  28641. <param name="array">The array.</param>
  28642. <param name="arrayIndex">The array index.</param>
  28643. <exception cref="T:System.ArgumentNullException">
  28644. <paramref name="array"/> is <c>null</c>.
  28645. </exception>
  28646. <exception cref="T:System.ArgumentOutOfRangeException">
  28647. <paramref name="arrayIndex"/> is out of range.
  28648. </exception>
  28649. </member>
  28650. <member name="M:MailKit.AccessRights.Remove(MailKit.AccessRight)">
  28651. <summary>
  28652. Removes the specified access right.
  28653. </summary>
  28654. <remarks>
  28655. Removes the specified access right.
  28656. </remarks>
  28657. <returns><value>true</value> if the access right was removed; otherwise <value>false</value>.</returns>
  28658. <param name="right">The access right.</param>
  28659. </member>
  28660. <member name="P:MailKit.AccessRights.Item(System.Int32)">
  28661. <summary>
  28662. Get the access right at the specified index.
  28663. </summary>
  28664. <remarks>
  28665. Gets the access right at the specified index.
  28666. </remarks>
  28667. <value>The access right at the specified index.</value>
  28668. <param name="index">The index.</param>
  28669. <exception cref="T:System.ArgumentOutOfRangeException">
  28670. <paramref name="index"/> is out of range.
  28671. </exception>
  28672. </member>
  28673. <member name="M:MailKit.AccessRights.GetEnumerator">
  28674. <summary>
  28675. Get the access rights enumerator.
  28676. </summary>
  28677. <remarks>
  28678. Gets the access rights enumerator.
  28679. </remarks>
  28680. <returns>The enumerator.</returns>
  28681. </member>
  28682. <member name="M:MailKit.AccessRights.System#Collections#IEnumerable#GetEnumerator">
  28683. <summary>
  28684. Get the access rights enumerator.
  28685. </summary>
  28686. <remarks>
  28687. Gets the access rights enumerator.
  28688. </remarks>
  28689. <returns>The enumerator.</returns>
  28690. </member>
  28691. <member name="M:MailKit.AccessRights.ToString">
  28692. <summary>
  28693. Return a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.AccessRights"/>.
  28694. </summary>
  28695. <remarks>
  28696. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.AccessRights"/>.
  28697. </remarks>
  28698. <returns>A <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.AccessRights"/>.</returns>
  28699. </member>
  28700. <member name="T:MailKit.AlertEventArgs">
  28701. <summary>
  28702. Alert event arguments.
  28703. </summary>
  28704. <remarks>
  28705. Some <see cref="T:MailKit.IMailStore"/> implementations, such as
  28706. <see cref="T:MailKit.Net.Imap.ImapClient"/>, will emit Alert
  28707. events when they receive alert messages from the server.
  28708. </remarks>
  28709. </member>
  28710. <member name="M:MailKit.AlertEventArgs.#ctor(System.String)">
  28711. <summary>
  28712. Initializes a new instance of the <see cref="T:MailKit.AlertEventArgs"/> class.
  28713. </summary>
  28714. <remarks>
  28715. Creates a new <see cref="T:MailKit.AlertEventArgs"/>.
  28716. </remarks>
  28717. <param name="message">The alert message.</param>
  28718. <exception cref="T:System.ArgumentNullException">
  28719. <paramref name="message"/> is <c>null</c>.
  28720. </exception>
  28721. </member>
  28722. <member name="P:MailKit.AlertEventArgs.Message">
  28723. <summary>
  28724. Gets the alert message.
  28725. </summary>
  28726. <remarks>
  28727. The alert message will be the exact message received from the server.
  28728. </remarks>
  28729. <value>The alert message.</value>
  28730. </member>
  28731. <member name="T:MailKit.Annotation">
  28732. <summary>
  28733. An annotation.
  28734. </summary>
  28735. <remarks>
  28736. <para>An annotation.</para>
  28737. <para>For more information about annotations, see
  28738. <a href="https://tools.ietf.org/html/rfc5257">rfc5257</a>.</para>
  28739. </remarks>
  28740. </member>
  28741. <member name="M:MailKit.Annotation.#ctor(MailKit.AnnotationEntry)">
  28742. <summary>
  28743. Initializes a new instance of the <see cref="T:MailKit.Annotation"/> class.
  28744. </summary>
  28745. <remarks>
  28746. Creates a new <see cref="T:MailKit.Annotation"/>.
  28747. </remarks>
  28748. <param name="entry">The annotation entry.</param>
  28749. <exception cref="T:System.ArgumentNullException">
  28750. <paramref name="entry"/> is <c>null</c>.
  28751. </exception>
  28752. </member>
  28753. <member name="P:MailKit.Annotation.Entry">
  28754. <summary>
  28755. Get the annotation tag.
  28756. </summary>
  28757. <remarks>
  28758. Gets the annotation tag.
  28759. </remarks>
  28760. <value>The annotation tag.</value>
  28761. </member>
  28762. <member name="P:MailKit.Annotation.Properties">
  28763. <summary>
  28764. Get the annotation properties.
  28765. </summary>
  28766. <remarks>
  28767. Gets the annotation properties.
  28768. </remarks>
  28769. </member>
  28770. <member name="T:MailKit.AnnotationAccess">
  28771. <summary>
  28772. An annotation access level.
  28773. </summary>
  28774. <remarks>
  28775. <para>An annotation access level.</para>
  28776. <para>For more information about annotations, see
  28777. <a href="https://tools.ietf.org/html/rfc5257">rfc5257</a>.</para>
  28778. </remarks>
  28779. </member>
  28780. <member name="F:MailKit.AnnotationAccess.None">
  28781. <summary>
  28782. Annotations are not supported.
  28783. </summary>
  28784. </member>
  28785. <member name="F:MailKit.AnnotationAccess.ReadOnly">
  28786. <summary>
  28787. Annotations are read-only.
  28788. </summary>
  28789. </member>
  28790. <member name="F:MailKit.AnnotationAccess.ReadWrite">
  28791. <summary>
  28792. Annotations are read-write.
  28793. </summary>
  28794. </member>
  28795. <member name="T:MailKit.AnnotationAttribute">
  28796. <summary>
  28797. An annotation attribute.
  28798. </summary>
  28799. <remarks>
  28800. <para>An annotation attribute.</para>
  28801. <para>For more information about annotations, see
  28802. <a href="https://tools.ietf.org/html/rfc5257">rfc5257</a>.</para>
  28803. </remarks>
  28804. </member>
  28805. <member name="F:MailKit.AnnotationAttribute.Value">
  28806. <summary>
  28807. The annotation value.
  28808. </summary>
  28809. <remarks>
  28810. Used to get or set both the private and shared values of an annotation.
  28811. </remarks>
  28812. </member>
  28813. <member name="F:MailKit.AnnotationAttribute.SharedValue">
  28814. <summary>
  28815. The shared annotation value.
  28816. </summary>
  28817. <remarks>
  28818. Used to get or set the shared value of an annotation.
  28819. </remarks>
  28820. </member>
  28821. <member name="F:MailKit.AnnotationAttribute.PrivateValue">
  28822. <summary>
  28823. The private annotation value.
  28824. </summary>
  28825. <remarks>
  28826. Used to get or set the private value of an annotation.
  28827. </remarks>
  28828. </member>
  28829. <member name="F:MailKit.AnnotationAttribute.Size">
  28830. <summary>
  28831. The size of an annotation value.
  28832. </summary>
  28833. <remarks>
  28834. Used to get the size of the both the private and shared annotation values.
  28835. </remarks>
  28836. </member>
  28837. <member name="F:MailKit.AnnotationAttribute.SharedSize">
  28838. <summary>
  28839. The size of a shared annotation value.
  28840. </summary>
  28841. <remarks>
  28842. Used to get the size of a shared annotation value.
  28843. </remarks>
  28844. </member>
  28845. <member name="F:MailKit.AnnotationAttribute.PrivateSize">
  28846. <summary>
  28847. The size of a private annotation value.
  28848. </summary>
  28849. <remarks>
  28850. Used to get the size of a private annotation value.
  28851. </remarks>
  28852. </member>
  28853. <member name="M:MailKit.AnnotationAttribute.#ctor(System.String)">
  28854. <summary>
  28855. Initializes a new instance of the <see cref="T:MailKit.AnnotationAttribute"/> class.
  28856. </summary>
  28857. <param name="specifier">The annotation attribute specifier.</param>
  28858. <exception cref="T:System.ArgumentNullException">
  28859. <paramref name="specifier"/> is <c>null</c>.
  28860. </exception>
  28861. <exception cref="T:System.ArgumentException">
  28862. <paramref name="specifier"/> contains illegal characters.
  28863. </exception>
  28864. </member>
  28865. <member name="P:MailKit.AnnotationAttribute.Name">
  28866. <summary>
  28867. Get the name of the annotation attribute.
  28868. </summary>
  28869. <remarks>
  28870. Gets the name of the annotation attribute.
  28871. </remarks>
  28872. </member>
  28873. <member name="P:MailKit.AnnotationAttribute.Scope">
  28874. <summary>
  28875. Get the scope of the annotation attribute.
  28876. </summary>
  28877. <remarks>
  28878. Gets the scope of the annotation attribute.
  28879. </remarks>
  28880. </member>
  28881. <member name="P:MailKit.AnnotationAttribute.Specifier">
  28882. <summary>
  28883. Get the annotation attribute specifier.
  28884. </summary>
  28885. <remarks>
  28886. Gets the annotation attribute specifier.
  28887. </remarks>
  28888. </member>
  28889. <member name="M:MailKit.AnnotationAttribute.Equals(MailKit.AnnotationAttribute)">
  28890. <summary>
  28891. Determines whether the specified <see cref="T:MailKit.AnnotationAttribute"/> is equal to the current <see cref="T:MailKit.AnnotationAttribute"/>.
  28892. </summary>
  28893. <remarks>
  28894. Determines whether the specified <see cref="T:MailKit.AnnotationAttribute"/> is equal to the current <see cref="T:MailKit.AnnotationAttribute"/>.
  28895. </remarks>
  28896. <param name="other">The <see cref="T:MailKit.AnnotationAttribute"/> to compare with the current <see cref="T:MailKit.AnnotationAttribute"/>.</param>
  28897. <returns><c>true</c> if the specified <see cref="T:MailKit.AnnotationAttribute"/> is equal to the current
  28898. <see cref="T:MailKit.AnnotationAttribute"/>; otherwise, <c>false</c>.</returns>
  28899. </member>
  28900. <member name="M:MailKit.AnnotationAttribute.op_Equality(MailKit.AnnotationAttribute,MailKit.AnnotationAttribute)">
  28901. <summary>
  28902. Determines whether two annotation attributes are equal.
  28903. </summary>
  28904. <remarks>
  28905. Determines whether two annotation attributes are equal.
  28906. </remarks>
  28907. <returns><c>true</c> if <paramref name="attr1"/> and <paramref name="attr2"/> are equal; otherwise, <c>false</c>.</returns>
  28908. <param name="attr1">The first annotation attribute to compare.</param>
  28909. <param name="attr2">The second annotation attribute to compare.</param>
  28910. </member>
  28911. <member name="M:MailKit.AnnotationAttribute.op_Inequality(MailKit.AnnotationAttribute,MailKit.AnnotationAttribute)">
  28912. <summary>
  28913. Determines whether two annotation attributes are not equal.
  28914. </summary>
  28915. <remarks>
  28916. Determines whether two annotation attributes are not equal.
  28917. </remarks>
  28918. <returns><c>true</c> if <paramref name="attr1"/> and <paramref name="attr2"/> are not equal; otherwise, <c>false</c>.</returns>
  28919. <param name="attr1">The first annotation attribute to compare.</param>
  28920. <param name="attr2">The second annotation attribute to compare.</param>
  28921. </member>
  28922. <member name="M:MailKit.AnnotationAttribute.Equals(System.Object)">
  28923. <summary>
  28924. Determine whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:MailKit.AnnotationAttribute"/>.
  28925. </summary>
  28926. <remarks>
  28927. Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:MailKit.AnnotationAttribute"/>.
  28928. </remarks>
  28929. <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:MailKit.AnnotationAttribute"/>.</param>
  28930. <returns><c>true</c> if the specified <see cref="T:System.Object"/> is equal to the current
  28931. <see cref="T:MailKit.AnnotationAttribute"/>; otherwise, <c>false</c>.</returns>
  28932. </member>
  28933. <member name="M:MailKit.AnnotationAttribute.GetHashCode">
  28934. <summary>
  28935. Serves as a hash function for a <see cref="T:MailKit.AnnotationAttribute"/> object.
  28936. </summary>
  28937. <remarks>
  28938. Serves as a hash function for a <see cref="T:MailKit.AnnotationAttribute"/> object.
  28939. </remarks>
  28940. <returns>A hash code for this instance that is suitable for use in hashing algorithms and data structures such as a hash table.</returns>
  28941. </member>
  28942. <member name="M:MailKit.AnnotationAttribute.ToString">
  28943. <summary>
  28944. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.AnnotationAttribute"/>.
  28945. </summary>
  28946. <remarks>
  28947. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.AnnotationAttribute"/>.
  28948. </remarks>
  28949. <returns>A <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.AnnotationAttribute"/>.</returns>
  28950. </member>
  28951. <member name="T:MailKit.AnnotationEntry">
  28952. <summary>
  28953. An annotation entry.
  28954. </summary>
  28955. <remarks>
  28956. <para>An annotation entry.</para>
  28957. <para>For more information about annotations, see
  28958. <a href="https://tools.ietf.org/html/rfc5257">rfc5257</a>.</para>
  28959. </remarks>
  28960. </member>
  28961. <member name="F:MailKit.AnnotationEntry.Comment">
  28962. <summary>
  28963. An annotation entry for a comment on a message.
  28964. </summary>
  28965. <remarks>
  28966. Used to get or set a comment on a message.
  28967. </remarks>
  28968. </member>
  28969. <member name="F:MailKit.AnnotationEntry.PrivateComment">
  28970. <summary>
  28971. An annotation entry for a private comment on a message.
  28972. </summary>
  28973. <remarks>
  28974. Used to get or set a private comment on a message.
  28975. </remarks>
  28976. </member>
  28977. <member name="F:MailKit.AnnotationEntry.SharedComment">
  28978. <summary>
  28979. An annotation entry for a shared comment on a message.
  28980. </summary>
  28981. <remarks>
  28982. Used to get or set a shared comment on a message.
  28983. </remarks>
  28984. </member>
  28985. <member name="F:MailKit.AnnotationEntry.Flags">
  28986. <summary>
  28987. An annotation entry for flags on a message.
  28988. </summary>
  28989. <remarks>
  28990. Used to get or set flags on a message.
  28991. </remarks>
  28992. </member>
  28993. <member name="F:MailKit.AnnotationEntry.PrivateFlags">
  28994. <summary>
  28995. An annotation entry for private flags on a message.
  28996. </summary>
  28997. <remarks>
  28998. Used to get or set private flags on a message.
  28999. </remarks>
  29000. </member>
  29001. <member name="F:MailKit.AnnotationEntry.SharedFlags">
  29002. <summary>
  29003. Aa annotation entry for shared flags on a message.
  29004. </summary>
  29005. <remarks>
  29006. Used to get or set shared flags on a message.
  29007. </remarks>
  29008. </member>
  29009. <member name="F:MailKit.AnnotationEntry.AltSubject">
  29010. <summary>
  29011. An annotation entry for an alternate subject on a message.
  29012. </summary>
  29013. <remarks>
  29014. Used to get or set an alternate subject on a message.
  29015. </remarks>
  29016. </member>
  29017. <member name="F:MailKit.AnnotationEntry.PrivateAltSubject">
  29018. <summary>
  29019. An annotation entry for a private alternate subject on a message.
  29020. </summary>
  29021. <remarks>
  29022. Used to get or set a private alternate subject on a message.
  29023. </remarks>
  29024. </member>
  29025. <member name="F:MailKit.AnnotationEntry.SharedAltSubject">
  29026. <summary>
  29027. An annotation entry for a shared alternate subject on a message.
  29028. </summary>
  29029. <remarks>
  29030. Used to get or set a shared alternate subject on a message.
  29031. </remarks>
  29032. </member>
  29033. <member name="M:MailKit.AnnotationEntry.#ctor(System.String,MailKit.AnnotationScope)">
  29034. <summary>
  29035. Initializes a new instance of the <see cref="T:MailKit.AnnotationEntry"/> struct.
  29036. </summary>
  29037. <remarks>
  29038. Creates a new <see cref="T:MailKit.AnnotationEntry"/>.
  29039. </remarks>
  29040. <param name="path">The annotation entry path.</param>
  29041. <param name="scope">The scope of the annotation.</param>
  29042. <exception cref="T:System.ArgumentNullException">
  29043. <paramref name="path"/> is <c>null</c>.
  29044. </exception>
  29045. <exception cref="T:System.ArgumentException">
  29046. <paramref name="path"/> is invalid.
  29047. </exception>
  29048. </member>
  29049. <member name="M:MailKit.AnnotationEntry.#ctor(System.String,System.String,MailKit.AnnotationScope)">
  29050. <summary>
  29051. Initializes a new instance of the <see cref="T:MailKit.AnnotationEntry"/> struct.
  29052. </summary>
  29053. <remarks>
  29054. Creates a new <see cref="T:MailKit.AnnotationEntry"/> for an individual body part of a message.
  29055. </remarks>
  29056. <param name="partSpecifier">The part-specifier of the body part of the message.</param>
  29057. <param name="path">The annotation entry path.</param>
  29058. <param name="scope">The scope of the annotation.</param>
  29059. <exception cref="T:System.ArgumentNullException">
  29060. <para><paramref name="partSpecifier"/> is <c>null</c>.</para>
  29061. <para>-or-</para>
  29062. <para><paramref name="path"/> is <c>null</c>.</para>
  29063. </exception>
  29064. <exception cref="T:System.ArgumentException">
  29065. <para><paramref name="partSpecifier"/> is invalid.</para>
  29066. <para>-or-</para>
  29067. <para><paramref name="path"/> is invalid.</para>
  29068. </exception>
  29069. </member>
  29070. <member name="M:MailKit.AnnotationEntry.#ctor(MailKit.BodyPart,System.String,MailKit.AnnotationScope)">
  29071. <summary>
  29072. Initializes a new instance of the <see cref="T:MailKit.AnnotationEntry"/> struct.
  29073. </summary>
  29074. <remarks>
  29075. Creates a new <see cref="T:MailKit.AnnotationEntry"/> for an individual body part of a message.
  29076. </remarks>
  29077. <param name="part">The body part of the message.</param>
  29078. <param name="path">The annotation entry path.</param>
  29079. <param name="scope">The scope of the annotation.</param>
  29080. <exception cref="T:System.ArgumentNullException">
  29081. <para><paramref name="part"/> is <c>null</c>.</para>
  29082. <para>-or-</para>
  29083. <para><paramref name="path"/> is <c>null</c>.</para>
  29084. </exception>
  29085. <exception cref="T:System.ArgumentException">
  29086. <paramref name="path"/> is invalid.
  29087. </exception>
  29088. </member>
  29089. <member name="P:MailKit.AnnotationEntry.Entry">
  29090. <summary>
  29091. Get the annotation entry specifier.
  29092. </summary>
  29093. <remarks>
  29094. Gets the annotation entry specifier.
  29095. </remarks>
  29096. <value>The annotation entry specifier.</value>
  29097. </member>
  29098. <member name="P:MailKit.AnnotationEntry.PartSpecifier">
  29099. <summary>
  29100. Get the part-specifier component of the annotation entry.
  29101. </summary>
  29102. <remarks>
  29103. Gets the part-specifier component of the annotation entry.
  29104. </remarks>
  29105. </member>
  29106. <member name="P:MailKit.AnnotationEntry.Path">
  29107. <summary>
  29108. Get the path component of the annotation entry.
  29109. </summary>
  29110. <remarks>
  29111. Gets the path component of the annotation entry.
  29112. </remarks>
  29113. </member>
  29114. <member name="P:MailKit.AnnotationEntry.Scope">
  29115. <summary>
  29116. Get the scope of the annotation.
  29117. </summary>
  29118. <remarks>
  29119. Gets the scope of the annotation.
  29120. </remarks>
  29121. </member>
  29122. <member name="M:MailKit.AnnotationEntry.Equals(MailKit.AnnotationEntry)">
  29123. <summary>
  29124. Determines whether the specified <see cref="T:MailKit.AnnotationEntry"/> is equal to the current <see cref="T:MailKit.AnnotationEntry"/>.
  29125. </summary>
  29126. <remarks>
  29127. Determines whether the specified <see cref="T:MailKit.AnnotationEntry"/> is equal to the current <see cref="T:MailKit.AnnotationEntry"/>.
  29128. </remarks>
  29129. <param name="other">The <see cref="T:MailKit.AnnotationEntry"/> to compare with the current <see cref="T:MailKit.AnnotationEntry"/>.</param>
  29130. <returns><c>true</c> if the specified <see cref="T:MailKit.AnnotationEntry"/> is equal to the current
  29131. <see cref="T:MailKit.AnnotationEntry"/>; otherwise, <c>false</c>.</returns>
  29132. </member>
  29133. <member name="M:MailKit.AnnotationEntry.op_Equality(MailKit.AnnotationEntry,MailKit.AnnotationEntry)">
  29134. <summary>
  29135. Determines whether two annotation entries are equal.
  29136. </summary>
  29137. <remarks>
  29138. Determines whether two annotation entries are equal.
  29139. </remarks>
  29140. <returns><c>true</c> if <paramref name="entry1"/> and <paramref name="entry2"/> are equal; otherwise, <c>false</c>.</returns>
  29141. <param name="entry1">The first annotation entry to compare.</param>
  29142. <param name="entry2">The second annotation entry to compare.</param>
  29143. </member>
  29144. <member name="M:MailKit.AnnotationEntry.op_Inequality(MailKit.AnnotationEntry,MailKit.AnnotationEntry)">
  29145. <summary>
  29146. Determines whether two annotation entries are not equal.
  29147. </summary>
  29148. <remarks>
  29149. Determines whether two annotation entries are not equal.
  29150. </remarks>
  29151. <returns><c>true</c> if <paramref name="entry1"/> and <paramref name="entry2"/> are not equal; otherwise, <c>false</c>.</returns>
  29152. <param name="entry1">The first annotation entry to compare.</param>
  29153. <param name="entry2">The second annotation entry to compare.</param>
  29154. </member>
  29155. <member name="M:MailKit.AnnotationEntry.Equals(System.Object)">
  29156. <summary>
  29157. Determine whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:MailKit.AnnotationEntry"/>.
  29158. </summary>
  29159. <remarks>
  29160. Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:MailKit.AnnotationEntry"/>.
  29161. </remarks>
  29162. <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:MailKit.AnnotationEntry"/>.</param>
  29163. <returns><c>true</c> if the specified <see cref="T:System.Object"/> is equal to the current
  29164. <see cref="T:MailKit.AnnotationEntry"/>; otherwise, <c>false</c>.</returns>
  29165. </member>
  29166. <member name="M:MailKit.AnnotationEntry.GetHashCode">
  29167. <summary>
  29168. Serves as a hash function for a <see cref="T:MailKit.AnnotationEntry"/> object.
  29169. </summary>
  29170. <remarks>
  29171. Serves as a hash function for a <see cref="T:MailKit.AnnotationEntry"/> object.
  29172. </remarks>
  29173. <returns>A hash code for this instance that is suitable for use in hashing algorithms and data structures such as a hash table.</returns>
  29174. </member>
  29175. <member name="M:MailKit.AnnotationEntry.ToString">
  29176. <summary>
  29177. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.AnnotationEntry"/>.
  29178. </summary>
  29179. <remarks>
  29180. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.AnnotationEntry"/>.
  29181. </remarks>
  29182. <returns>A <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.AnnotationEntry"/>.</returns>
  29183. </member>
  29184. <member name="M:MailKit.AnnotationEntry.Parse(System.String)">
  29185. <summary>
  29186. Parse an annotation entry.
  29187. </summary>
  29188. <remarks>
  29189. Parses an annotation entry.
  29190. </remarks>
  29191. <param name="entry">The annotation entry.</param>
  29192. <returns>The parsed annotation entry.</returns>
  29193. <exception cref="T:System.ArgumentNullException">
  29194. <paramref name="entry"/> is <c>null</c>.
  29195. </exception>
  29196. <exception cref="T:System.FormatException">
  29197. <paramref name="entry"/> does not conform to the annotation entry syntax.
  29198. </exception>
  29199. </member>
  29200. <member name="T:MailKit.AnnotationsChangedEventArgs">
  29201. <summary>
  29202. Event args used when an annotation changes.
  29203. </summary>
  29204. <remarks>
  29205. Event args used when an annotation changes.
  29206. </remarks>
  29207. </member>
  29208. <member name="M:MailKit.AnnotationsChangedEventArgs.#ctor(System.Int32)">
  29209. <summary>
  29210. Initializes a new instance of the <see cref="T:MailKit.AnnotationsChangedEventArgs"/> class.
  29211. </summary>
  29212. <remarks>
  29213. Creates a new <see cref="T:MailKit.AnnotationsChangedEventArgs"/>.
  29214. </remarks>
  29215. <param name="index">The message index.</param>
  29216. </member>
  29217. <member name="M:MailKit.AnnotationsChangedEventArgs.#ctor(System.Int32,System.Collections.Generic.IEnumerable{MailKit.Annotation})">
  29218. <summary>
  29219. Initializes a new instance of the <see cref="T:MailKit.AnnotationsChangedEventArgs"/> class.
  29220. </summary>
  29221. <remarks>
  29222. Creates a new <see cref="T:MailKit.AnnotationsChangedEventArgs"/>.
  29223. </remarks>
  29224. <param name="index">The message index.</param>
  29225. <param name="annotations">The annotations that changed.</param>
  29226. <exception cref="T:System.ArgumentNullException">
  29227. <paramref name="annotations"/> is <c>null</c>.
  29228. </exception>
  29229. </member>
  29230. <member name="P:MailKit.AnnotationsChangedEventArgs.Annotations">
  29231. <summary>
  29232. Get the annotations that changed.
  29233. </summary>
  29234. <remarks>
  29235. Gets the annotations that changed.
  29236. </remarks>
  29237. <value>The annotation.</value>
  29238. </member>
  29239. <member name="P:MailKit.AnnotationsChangedEventArgs.ModSeq">
  29240. <summary>
  29241. Gets the updated mod-sequence value of the message, if available.
  29242. </summary>
  29243. <remarks>
  29244. Gets the updated mod-sequence value of the message, if available.
  29245. </remarks>
  29246. <value>The mod-sequence value.</value>
  29247. </member>
  29248. <member name="T:MailKit.AnnotationScope">
  29249. <summary>
  29250. The scope of an annotation.
  29251. </summary>
  29252. <remarks>
  29253. <para>Represents the scope of an annotation.</para>
  29254. <para>For more information about annotations, see
  29255. <a href="https://tools.ietf.org/html/rfc5257">rfc5257</a>.</para>
  29256. </remarks>
  29257. </member>
  29258. <member name="F:MailKit.AnnotationScope.None">
  29259. <summary>
  29260. No scopes.
  29261. </summary>
  29262. </member>
  29263. <member name="F:MailKit.AnnotationScope.Private">
  29264. <summary>
  29265. The private annotation scope.
  29266. </summary>
  29267. </member>
  29268. <member name="F:MailKit.AnnotationScope.Shared">
  29269. <summary>
  29270. The shared annotation scope.
  29271. </summary>
  29272. </member>
  29273. <member name="F:MailKit.AnnotationScope.Both">
  29274. <summary>
  29275. Both private and shared scopes.
  29276. </summary>
  29277. </member>
  29278. <member name="T:MailKit.AuthenticatedEventArgs">
  29279. <summary>
  29280. Authenticated event arguments.
  29281. </summary>
  29282. <remarks>
  29283. Some servers, such as GMail IMAP, will send some free-form text in
  29284. the response to a successful login.
  29285. </remarks>
  29286. </member>
  29287. <member name="M:MailKit.AuthenticatedEventArgs.#ctor(System.String)">
  29288. <summary>
  29289. Initializes a new instance of the <see cref="T:MailKit.AuthenticatedEventArgs"/> class.
  29290. </summary>
  29291. <remarks>
  29292. Creates a new <see cref="T:MailKit.AuthenticatedEventArgs"/>.
  29293. </remarks>
  29294. <param name="message">The free-form text.</param>
  29295. <exception cref="T:System.ArgumentNullException">
  29296. <paramref name="message"/> is <c>null</c>.
  29297. </exception>
  29298. </member>
  29299. <member name="P:MailKit.AuthenticatedEventArgs.Message">
  29300. <summary>
  29301. Get the free-form text sent by the server.
  29302. </summary>
  29303. <remarks>
  29304. Gets the free-form text sent by the server.
  29305. </remarks>
  29306. <value>The free-form text sent by the server.</value>
  29307. </member>
  29308. <member name="T:MailKit.BodyPart">
  29309. <summary>
  29310. An abstract body part of a message.
  29311. </summary>
  29312. <remarks>
  29313. Each body part will actually be a <see cref="T:MailKit.BodyPartBasic"/>,
  29314. <see cref="T:MailKit.BodyPartText"/>, <see cref="T:MailKit.BodyPartMessage"/>, or
  29315. <see cref="T:MailKit.BodyPartMultipart"/>.
  29316. </remarks>
  29317. <example>
  29318. <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
  29319. </example>
  29320. </member>
  29321. <member name="M:MailKit.BodyPart.#ctor">
  29322. <summary>
  29323. Initializes a new instance of the <see cref="T:MailKit.BodyPart"/> class.
  29324. </summary>
  29325. <remarks>
  29326. Creates a new <see cref="T:MailKit.BodyPart"/>.
  29327. </remarks>
  29328. </member>
  29329. <member name="P:MailKit.BodyPart.ContentType">
  29330. <summary>
  29331. Gets the Content-Type of the body part.
  29332. </summary>
  29333. <remarks>
  29334. Gets the Content-Type of the body part.
  29335. </remarks>
  29336. <value>The content type.</value>
  29337. </member>
  29338. <member name="P:MailKit.BodyPart.PartSpecifier">
  29339. <summary>
  29340. Gets the part specifier.
  29341. </summary>
  29342. <remarks>
  29343. Gets the part specifier.
  29344. </remarks>
  29345. <example>
  29346. <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
  29347. </example>
  29348. <value>The part specifier.</value>
  29349. </member>
  29350. <member name="M:MailKit.BodyPart.Accept(MailKit.BodyPartVisitor)">
  29351. <summary>
  29352. Dispatches to the specific visit method for this MIME body part.
  29353. </summary>
  29354. <remarks>
  29355. This default implementation for <see cref="T:MailKit.BodyPart"/> nodes
  29356. calls <see cref="M:MailKit.BodyPartVisitor.VisitBodyPart(MailKit.BodyPart)"/>. Override this
  29357. method to call into a more specific method on a derived visitor class
  29358. of the <see cref="T:MailKit.BodyPartVisitor"/> class. However, it should still
  29359. support unknown visitors by calling
  29360. <see cref="M:MailKit.BodyPartVisitor.VisitBodyPart(MailKit.BodyPart)"/>.
  29361. </remarks>
  29362. <param name="visitor">The visitor.</param>
  29363. <exception cref="T:System.ArgumentNullException">
  29364. <paramref name="visitor"/> is <c>null</c>.
  29365. </exception>
  29366. </member>
  29367. <member name="M:MailKit.BodyPart.Encode(System.Text.StringBuilder)">
  29368. <summary>
  29369. Encodes the <see cref="T:MailKit.BodyPart"/> into the <see cref="T:System.Text.StringBuilder"/>.
  29370. </summary>
  29371. <remarks>
  29372. Encodes the <see cref="T:MailKit.BodyPart"/> into the <see cref="T:System.Text.StringBuilder"/>.
  29373. </remarks>
  29374. <param name="builder">The string builder.</param>
  29375. </member>
  29376. <member name="M:MailKit.BodyPart.ToString">
  29377. <summary>
  29378. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.BodyPart"/>.
  29379. </summary>
  29380. <remarks>
  29381. <para>Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.BodyPart"/>.</para>
  29382. <note type="note">The syntax of the string returned, while similar to IMAP's BODYSTRUCTURE syntax,
  29383. is not completely compatible.</note>
  29384. </remarks>
  29385. <returns>A <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.BodyPart"/>.</returns>
  29386. </member>
  29387. <member name="M:MailKit.BodyPart.TryParse(System.String,MailKit.BodyPart@)">
  29388. <summary>
  29389. Tries to parse the given text into a new <see cref="T:MailKit.BodyPart"/> instance.
  29390. </summary>
  29391. <remarks>
  29392. <para>Parses a body part from the specified text.</para>
  29393. <note type="note">This syntax, while similar to IMAP's BODYSTRUCTURE syntax, is not completely
  29394. compatible.</note>
  29395. </remarks>
  29396. <returns><c>true</c>, if the body part was successfully parsed, <c>false</c> otherwise.</returns>
  29397. <param name="text">The text to parse.</param>
  29398. <param name="part">The parsed body part.</param>
  29399. <exception cref="T:System.ArgumentNullException">
  29400. <paramref name="text"/> is <c>null</c>.
  29401. </exception>
  29402. </member>
  29403. <member name="T:MailKit.BodyPartBasic">
  29404. <summary>
  29405. A basic message body part.
  29406. </summary>
  29407. <remarks>
  29408. Represents any message body part that is not a multipart,
  29409. message/rfc822 part, or a text part.
  29410. </remarks>
  29411. <example>
  29412. <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
  29413. </example>
  29414. </member>
  29415. <member name="M:MailKit.BodyPartBasic.#ctor">
  29416. <summary>
  29417. Initializes a new instance of the <see cref="T:MailKit.BodyPartBasic"/> class.
  29418. </summary>
  29419. <remarks>
  29420. Creates a new <see cref="T:MailKit.BodyPartBasic"/>.
  29421. </remarks>
  29422. </member>
  29423. <member name="P:MailKit.BodyPartBasic.ContentId">
  29424. <summary>
  29425. Gets the Content-Id of the body part, if available.
  29426. </summary>
  29427. <remarks>
  29428. Gets the Content-Id of the body part, if available.
  29429. </remarks>
  29430. <value>The content identifier.</value>
  29431. </member>
  29432. <member name="P:MailKit.BodyPartBasic.ContentDescription">
  29433. <summary>
  29434. Gets the Content-Description of the body part, if available.
  29435. </summary>
  29436. <remarks>
  29437. Gets the Content-Description of the body part, if available.
  29438. </remarks>
  29439. <value>The content description.</value>
  29440. </member>
  29441. <member name="P:MailKit.BodyPartBasic.ContentTransferEncoding">
  29442. <summary>
  29443. Gets the Content-Transfer-Encoding of the body part.
  29444. </summary>
  29445. <remarks>
  29446. <para>Gets the Content-Transfer-Encoding of the body part.</para>
  29447. <para>Hint: Use the <a href="M_MimeKit_Utils_MimeUtils_TryParse_1.htm">MimeUtils.TryParse</a>
  29448. method to parse this value into a usable <see cref="T:MimeKit.ContentEncoding"/>.</para>
  29449. </remarks>
  29450. <value>The content transfer encoding.</value>
  29451. </member>
  29452. <member name="P:MailKit.BodyPartBasic.Octets">
  29453. <summary>
  29454. Gets the size of the body part, in bytes.
  29455. </summary>
  29456. <remarks>
  29457. Gets the size of the body part, in bytes.
  29458. </remarks>
  29459. <value>The number of octets.</value>
  29460. </member>
  29461. <member name="P:MailKit.BodyPartBasic.ContentMd5">
  29462. <summary>
  29463. Gets the MD5 hash of the content, if available.
  29464. </summary>
  29465. <remarks>
  29466. Gets the MD5 hash of the content, if available.
  29467. </remarks>
  29468. <value>The content md5.</value>
  29469. </member>
  29470. <member name="P:MailKit.BodyPartBasic.ContentDisposition">
  29471. <summary>
  29472. Gets the Content-Disposition of the body part, if available.
  29473. </summary>
  29474. <remarks>
  29475. <para>Gets the Content-Disposition of the body part, if available.</para>
  29476. <note type="note">The Content-Disposition value is only retrieved if the
  29477. <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag is used when fetching
  29478. summary information from an <see cref="T:MailKit.IMailFolder"/>.</note>
  29479. </remarks>
  29480. <value>The content disposition.</value>
  29481. </member>
  29482. <member name="P:MailKit.BodyPartBasic.ContentLanguage">
  29483. <summary>
  29484. Gets the Content-Language of the body part, if available.
  29485. </summary>
  29486. <remarks>
  29487. <para>Gets the Content-Language of the body part, if available.</para>
  29488. <para>The Content-Language value is only retrieved if the
  29489. <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag is used when fetching
  29490. summary information from an <see cref="T:MailKit.IMailFolder"/>.</para>
  29491. </remarks>
  29492. <value>The content language.</value>
  29493. </member>
  29494. <member name="P:MailKit.BodyPartBasic.ContentLocation">
  29495. <summary>
  29496. Gets the Content-Location of the body part, if available.
  29497. </summary>
  29498. <remarks>
  29499. <para>Gets the Content-Location of the body part, if available.</para>
  29500. <para>The Content-Location value is only retrieved if the
  29501. <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag is used when fetching
  29502. summary information from an <see cref="T:MailKit.IMailFolder"/>.</para>
  29503. </remarks>
  29504. <value>The content location.</value>
  29505. </member>
  29506. <member name="P:MailKit.BodyPartBasic.IsAttachment">
  29507. <summary>
  29508. Determines whether or not the body part is an attachment.
  29509. </summary>
  29510. <remarks>
  29511. <para>Determines whether or not the body part is an attachment based on the value of
  29512. the Content-Disposition.</para>
  29513. <note type="note">Since the value of the Content-Disposition header is needed, it
  29514. is necessary to include the <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag when
  29515. fetching summary information from an <see cref="T:MailKit.IMailFolder"/>.</note>
  29516. </remarks>
  29517. <value><c>true</c> if this part is an attachment; otherwise, <c>false</c>.</value>
  29518. </member>
  29519. <member name="P:MailKit.BodyPartBasic.FileName">
  29520. <summary>
  29521. Get the name of the file.
  29522. </summary>
  29523. <remarks>
  29524. <para>First checks for the "filename" parameter on the Content-Disposition header. If
  29525. that does not exist, then the "name" parameter on the Content-Type header is used.</para>
  29526. <note type="note">Since the value of the Content-Disposition header is needed, it is
  29527. necessary to include the <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag when
  29528. fetching summary information from an <see cref="T:MailKit.IMailFolder"/>.</note>
  29529. </remarks>
  29530. <value>The name of the file.</value>
  29531. </member>
  29532. <member name="M:MailKit.BodyPartBasic.Accept(MailKit.BodyPartVisitor)">
  29533. <summary>
  29534. Dispatches to the specific visit method for this MIME body part.
  29535. </summary>
  29536. <remarks>
  29537. This default implementation for <see cref="T:MailKit.BodyPart"/> nodes
  29538. calls <see cref="M:MailKit.BodyPartVisitor.VisitBodyPart(MailKit.BodyPart)"/>. Override this
  29539. method to call into a more specific method on a derived visitor class
  29540. of the <see cref="T:MailKit.BodyPartVisitor"/> class. However, it should still
  29541. support unknown visitors by calling
  29542. <see cref="M:MailKit.BodyPartVisitor.VisitBodyPart(MailKit.BodyPart)"/>.
  29543. </remarks>
  29544. <param name="visitor">The visitor.</param>
  29545. <exception cref="T:System.ArgumentNullException">
  29546. <paramref name="visitor"/> is <c>null</c>.
  29547. </exception>
  29548. </member>
  29549. <member name="M:MailKit.BodyPartBasic.Encode(System.Text.StringBuilder)">
  29550. <summary>
  29551. Encodes the <see cref="T:MailKit.BodyPart"/> into the <see cref="T:System.Text.StringBuilder"/>.
  29552. </summary>
  29553. <remarks>
  29554. Encodes the <see cref="T:MailKit.BodyPart"/> into the <see cref="T:System.Text.StringBuilder"/>.
  29555. </remarks>
  29556. <param name="builder">The string builder.</param>
  29557. </member>
  29558. <member name="T:MailKit.BodyPartCollection">
  29559. <summary>
  29560. A <see cref="T:MailKit.BodyPart"/> collection.
  29561. </summary>
  29562. <remarks>
  29563. A <see cref="T:MailKit.BodyPart"/> collection.
  29564. </remarks>
  29565. </member>
  29566. <member name="M:MailKit.BodyPartCollection.#ctor">
  29567. <summary>
  29568. Initializes a new instance of the <see cref="T:MailKit.BodyPartCollection"/> class.
  29569. </summary>
  29570. <remarks>
  29571. Creates a new <see cref="T:MailKit.BodyPartCollection"/>.
  29572. </remarks>
  29573. </member>
  29574. <member name="P:MailKit.BodyPartCollection.Count">
  29575. <summary>
  29576. Get the number of body parts in the collection.
  29577. </summary>
  29578. <remarks>
  29579. Gets the number of body parts in the collection.
  29580. </remarks>
  29581. <value>The count.</value>
  29582. </member>
  29583. <member name="P:MailKit.BodyPartCollection.IsReadOnly">
  29584. <summary>
  29585. Get whether or not this body part collection is read only.
  29586. </summary>
  29587. <remarks>
  29588. Gets whether or not this body part collection is read only.
  29589. </remarks>
  29590. <value><c>true</c> if this collection is read only; otherwise, <c>false</c>.</value>
  29591. </member>
  29592. <member name="M:MailKit.BodyPartCollection.Add(MailKit.BodyPart)">
  29593. <summary>
  29594. Add the specified body part to the collection.
  29595. </summary>
  29596. <remarks>
  29597. Adds the specified body part to the collection.
  29598. </remarks>
  29599. <param name="part">The body part.</param>
  29600. <exception cref="T:System.ArgumentNullException">
  29601. <paramref name="part"/> is <c>null</c>.
  29602. </exception>
  29603. </member>
  29604. <member name="M:MailKit.BodyPartCollection.Clear">
  29605. <summary>
  29606. Clears the body part collection.
  29607. </summary>
  29608. <remarks>
  29609. Removes all of the body parts from the collection.
  29610. </remarks>
  29611. </member>
  29612. <member name="M:MailKit.BodyPartCollection.Contains(MailKit.BodyPart)">
  29613. <summary>
  29614. Checks if the collection contains the specified body part.
  29615. </summary>
  29616. <remarks>
  29617. Determines whether or not the collection contains the specified body part.
  29618. </remarks>
  29619. <returns><value>true</value> if the specified body part exists; otherwise <value>false</value>.</returns>
  29620. <param name="part">The body part.</param>
  29621. <exception cref="T:System.ArgumentNullException">
  29622. <paramref name="part"/> is <c>null</c>.
  29623. </exception>
  29624. </member>
  29625. <member name="M:MailKit.BodyPartCollection.CopyTo(MailKit.BodyPart[],System.Int32)">
  29626. <summary>
  29627. Copies all of the body parts in the collection to the specified array.
  29628. </summary>
  29629. <remarks>
  29630. Copies all of the body parts within the collection into the array,
  29631. starting at the specified array index.
  29632. </remarks>
  29633. <param name="array">The array.</param>
  29634. <param name="arrayIndex">The array index.</param>
  29635. <exception cref="T:System.ArgumentNullException">
  29636. <paramref name="array"/> is <c>null</c>.
  29637. </exception>
  29638. <exception cref="T:System.ArgumentOutOfRangeException">
  29639. <paramref name="arrayIndex"/> is out of range.
  29640. </exception>
  29641. </member>
  29642. <member name="M:MailKit.BodyPartCollection.Remove(MailKit.BodyPart)">
  29643. <summary>
  29644. Removes the specified body part.
  29645. </summary>
  29646. <remarks>
  29647. Removes the specified body part.
  29648. </remarks>
  29649. <returns><value>true</value> if the body part was removed; otherwise <value>false</value>.</returns>
  29650. <param name="part">The body part.</param>
  29651. <exception cref="T:System.ArgumentNullException">
  29652. <paramref name="part"/> is <c>null</c>.
  29653. </exception>
  29654. </member>
  29655. <member name="P:MailKit.BodyPartCollection.Item(System.Int32)">
  29656. <summary>
  29657. Get the body part at the specified index.
  29658. </summary>
  29659. <remarks>
  29660. Gets the body part at the specified index.
  29661. </remarks>
  29662. <value>The body part at the specified index.</value>
  29663. <param name="index">The index.</param>
  29664. <exception cref="T:System.ArgumentOutOfRangeException">
  29665. <paramref name="index"/> is out of range.
  29666. </exception>
  29667. </member>
  29668. <member name="M:MailKit.BodyPartCollection.IndexOf(System.Uri)">
  29669. <summary>
  29670. Gets the index of the body part matching the specified URI.
  29671. </summary>
  29672. <remarks>
  29673. <para>Finds the index of the body part matching the specified URI, if it exists.</para>
  29674. <para>If the URI scheme is <c>"cid"</c>, then matching is performed based on the Content-Id header
  29675. values, otherwise the Content-Location headers are used. If the provided URI is absolute and a child
  29676. part's Content-Location is relative, then then the child part's Content-Location URI will be combined
  29677. with the value of its Content-Base header, if available, otherwise it will be combined with the
  29678. multipart/related part's Content-Base header in order to produce an absolute URI that can be
  29679. compared with the provided absolute URI.</para>
  29680. </remarks>
  29681. <returns>The index of the part matching the specified URI if found; otherwise <c>-1</c>.</returns>
  29682. <param name="uri">The URI of the body part.</param>
  29683. <exception cref="T:System.ArgumentNullException">
  29684. <paramref name="uri"/> is <c>null</c>.
  29685. </exception>
  29686. </member>
  29687. <member name="M:MailKit.BodyPartCollection.GetEnumerator">
  29688. <summary>
  29689. Get the body part enumerator.
  29690. </summary>
  29691. <remarks>
  29692. Gets the body part enumerator.
  29693. </remarks>
  29694. <returns>The enumerator.</returns>
  29695. </member>
  29696. <member name="M:MailKit.BodyPartCollection.System#Collections#IEnumerable#GetEnumerator">
  29697. <summary>
  29698. Get the body part enumerator.
  29699. </summary>
  29700. <remarks>
  29701. Gets the body part enumerator.
  29702. </remarks>
  29703. <returns>The enumerator.</returns>
  29704. </member>
  29705. <member name="T:MailKit.BodyPartMessage">
  29706. <summary>
  29707. A message/rfc822 body part.
  29708. </summary>
  29709. <remarks>
  29710. Represents a message/rfc822 body part.
  29711. </remarks>
  29712. </member>
  29713. <member name="M:MailKit.BodyPartMessage.#ctor">
  29714. <summary>
  29715. Initializes a new instance of the <see cref="T:MailKit.BodyPartMessage"/> class.
  29716. </summary>
  29717. <remarks>
  29718. Creates a new <see cref="T:MailKit.BodyPartMessage"/>.
  29719. </remarks>
  29720. </member>
  29721. <member name="P:MailKit.BodyPartMessage.Envelope">
  29722. <summary>
  29723. Gets the envelope of the message, if available.
  29724. </summary>
  29725. <remarks>
  29726. Gets the envelope of the message, if available.
  29727. </remarks>
  29728. <value>The envelope.</value>
  29729. </member>
  29730. <member name="P:MailKit.BodyPartMessage.Body">
  29731. <summary>
  29732. Gets the body structure of the message.
  29733. </summary>
  29734. <remarks>
  29735. Gets the body structure of the message.
  29736. </remarks>
  29737. <value>The body structure.</value>
  29738. </member>
  29739. <member name="P:MailKit.BodyPartMessage.Lines">
  29740. <summary>
  29741. Gets the length of the message, in lines.
  29742. </summary>
  29743. <remarks>
  29744. Gets the length of the message, in lines.
  29745. </remarks>
  29746. <value>The number of lines.</value>
  29747. </member>
  29748. <member name="M:MailKit.BodyPartMessage.Accept(MailKit.BodyPartVisitor)">
  29749. <summary>
  29750. Dispatches to the specific visit method for this MIME body part.
  29751. </summary>
  29752. <remarks>
  29753. This default implementation for <see cref="T:MailKit.BodyPart"/> nodes
  29754. calls <see cref="M:MailKit.BodyPartVisitor.VisitBodyPart(MailKit.BodyPart)"/>. Override this
  29755. method to call into a more specific method on a derived visitor class
  29756. of the <see cref="T:MailKit.BodyPartVisitor"/> class. However, it should still
  29757. support unknown visitors by calling
  29758. <see cref="M:MailKit.BodyPartVisitor.VisitBodyPart(MailKit.BodyPart)"/>.
  29759. </remarks>
  29760. <param name="visitor">The visitor.</param>
  29761. <exception cref="T:System.ArgumentNullException">
  29762. <paramref name="visitor"/> is <c>null</c>.
  29763. </exception>
  29764. </member>
  29765. <member name="M:MailKit.BodyPartMessage.Encode(System.Text.StringBuilder)">
  29766. <summary>
  29767. Encodes the <see cref="T:MailKit.BodyPart"/> into the <see cref="T:System.Text.StringBuilder"/>.
  29768. </summary>
  29769. <remarks>
  29770. Encodes the <see cref="T:MailKit.BodyPart"/> into the <see cref="T:System.Text.StringBuilder"/>.
  29771. </remarks>
  29772. <param name="builder">The string builder.</param>
  29773. </member>
  29774. <member name="T:MailKit.BodyPartMultipart">
  29775. <summary>
  29776. A multipart body part.
  29777. </summary>
  29778. <remarks>
  29779. A multipart body part.
  29780. </remarks>
  29781. </member>
  29782. <member name="M:MailKit.BodyPartMultipart.#ctor">
  29783. <summary>
  29784. Initializes a new instance of the <see cref="T:MailKit.BodyPartMultipart"/> class.
  29785. </summary>
  29786. <remarks>
  29787. Creates a new <see cref="T:MailKit.BodyPartMultipart"/>.
  29788. </remarks>
  29789. </member>
  29790. <member name="P:MailKit.BodyPartMultipart.BodyParts">
  29791. <summary>
  29792. Gets the child body parts.
  29793. </summary>
  29794. <remarks>
  29795. Gets the child body parts.
  29796. </remarks>
  29797. <value>The child body parts.</value>
  29798. </member>
  29799. <member name="P:MailKit.BodyPartMultipart.ContentDisposition">
  29800. <summary>
  29801. Gets the Content-Disposition of the body part, if available.
  29802. </summary>
  29803. <remarks>
  29804. Gets the Content-Disposition of the body part, if available.
  29805. </remarks>
  29806. <value>The content disposition.</value>
  29807. </member>
  29808. <member name="P:MailKit.BodyPartMultipart.ContentLanguage">
  29809. <summary>
  29810. Gets the Content-Language of the body part, if available.
  29811. </summary>
  29812. <remarks>
  29813. Gets the Content-Language of the body part, if available.
  29814. </remarks>
  29815. <value>The content language.</value>
  29816. </member>
  29817. <member name="P:MailKit.BodyPartMultipart.ContentLocation">
  29818. <summary>
  29819. Gets the Content-Location of the body part, if available.
  29820. </summary>
  29821. <remarks>
  29822. Gets the Content-Location of the body part, if available.
  29823. </remarks>
  29824. <value>The content location.</value>
  29825. </member>
  29826. <member name="M:MailKit.BodyPartMultipart.Accept(MailKit.BodyPartVisitor)">
  29827. <summary>
  29828. Dispatches to the specific visit method for this MIME body part.
  29829. </summary>
  29830. <remarks>
  29831. This default implementation for <see cref="T:MailKit.BodyPart"/> nodes
  29832. calls <see cref="M:MailKit.BodyPartVisitor.VisitBodyPart(MailKit.BodyPart)"/>. Override this
  29833. method to call into a more specific method on a derived visitor class
  29834. of the <see cref="T:MailKit.BodyPartVisitor"/> class. However, it should still
  29835. support unknown visitors by calling
  29836. <see cref="M:MailKit.BodyPartVisitor.VisitBodyPart(MailKit.BodyPart)"/>.
  29837. </remarks>
  29838. <param name="visitor">The visitor.</param>
  29839. <exception cref="T:System.ArgumentNullException">
  29840. <paramref name="visitor"/> is <c>null</c>.
  29841. </exception>
  29842. </member>
  29843. <member name="M:MailKit.BodyPartMultipart.Encode(System.Text.StringBuilder)">
  29844. <summary>
  29845. Encodes the <see cref="T:MailKit.BodyPart"/> into the <see cref="T:System.Text.StringBuilder"/>.
  29846. </summary>
  29847. <remarks>
  29848. Encodes the <see cref="T:MailKit.BodyPart"/> into the <see cref="T:System.Text.StringBuilder"/>.
  29849. </remarks>
  29850. <param name="builder">The string builder.</param>
  29851. </member>
  29852. <member name="T:MailKit.BodyPartText">
  29853. <summary>
  29854. A textual body part.
  29855. </summary>
  29856. <remarks>
  29857. Represents any body part with a media type of "text".
  29858. </remarks>
  29859. <example>
  29860. <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
  29861. </example>
  29862. </member>
  29863. <member name="M:MailKit.BodyPartText.#ctor">
  29864. <summary>
  29865. Initializes a new instance of the <see cref="T:MailKit.BodyPartText"/> class.
  29866. </summary>
  29867. <remarks>
  29868. Creates a new <see cref="T:MailKit.BodyPartText"/>.
  29869. </remarks>
  29870. </member>
  29871. <member name="P:MailKit.BodyPartText.IsPlain">
  29872. <summary>
  29873. Gets whether or not this text part contains plain text.
  29874. </summary>
  29875. <remarks>
  29876. Checks whether or not the text part's Content-Type is text/plain.
  29877. </remarks>
  29878. <value><c>true</c> if the text is html; otherwise, <c>false</c>.</value>
  29879. </member>
  29880. <member name="P:MailKit.BodyPartText.IsHtml">
  29881. <summary>
  29882. Gets whether or not this text part contains HTML.
  29883. </summary>
  29884. <remarks>
  29885. Checks whether or not the text part's Content-Type is text/html.
  29886. </remarks>
  29887. <value><c>true</c> if the text is html; otherwise, <c>false</c>.</value>
  29888. </member>
  29889. <member name="P:MailKit.BodyPartText.Lines">
  29890. <summary>
  29891. Gets the length of the text, in lines.
  29892. </summary>
  29893. <remarks>
  29894. Gets the length of the text, in lines.
  29895. </remarks>
  29896. <value>The number of lines.</value>
  29897. </member>
  29898. <member name="M:MailKit.BodyPartText.Accept(MailKit.BodyPartVisitor)">
  29899. <summary>
  29900. Dispatches to the specific visit method for this MIME body part.
  29901. </summary>
  29902. <remarks>
  29903. This default implementation for <see cref="T:MailKit.BodyPart"/> nodes
  29904. calls <see cref="M:MailKit.BodyPartVisitor.VisitBodyPart(MailKit.BodyPart)"/>. Override this
  29905. method to call into a more specific method on a derived visitor class
  29906. of the <see cref="T:MailKit.BodyPartVisitor"/> class. However, it should still
  29907. support unknown visitors by calling
  29908. <see cref="M:MailKit.BodyPartVisitor.VisitBodyPart(MailKit.BodyPart)"/>.
  29909. </remarks>
  29910. <param name="visitor">The visitor.</param>
  29911. <exception cref="T:System.ArgumentNullException">
  29912. <paramref name="visitor"/> is <c>null</c>.
  29913. </exception>
  29914. </member>
  29915. <member name="M:MailKit.BodyPartText.Encode(System.Text.StringBuilder)">
  29916. <summary>
  29917. Encodes the <see cref="T:MailKit.BodyPart"/> into the <see cref="T:System.Text.StringBuilder"/>.
  29918. </summary>
  29919. <remarks>
  29920. Encodes the <see cref="T:MailKit.BodyPart"/> into the <see cref="T:System.Text.StringBuilder"/>.
  29921. </remarks>
  29922. <param name="builder">The string builder.</param>
  29923. </member>
  29924. <member name="T:MailKit.BodyPartVisitor">
  29925. <summary>
  29926. Represents a visitor for a tree of MIME body parts.
  29927. </summary>
  29928. <remarks>
  29929. This class is designed to be inherited to create more specialized classes whose
  29930. functionality requires traversing, examining or copying a tree of MIME body parts.
  29931. </remarks>
  29932. </member>
  29933. <member name="M:MailKit.BodyPartVisitor.Visit(MailKit.BodyPart)">
  29934. <summary>
  29935. Dispatches the entity to one of the more specialized visit methods in this class.
  29936. </summary>
  29937. <remarks>
  29938. Dispatches the entity to one of the more specialized visit methods in this class.
  29939. </remarks>
  29940. <param name="body">The MIME body part.</param>
  29941. </member>
  29942. <member name="M:MailKit.BodyPartVisitor.VisitBodyPart(MailKit.BodyPart)">
  29943. <summary>
  29944. Visit the abstract MIME body part.
  29945. </summary>
  29946. <remarks>
  29947. Visits the abstract MIME body part.
  29948. </remarks>
  29949. <param name="entity">The MIME body part.</param>
  29950. </member>
  29951. <member name="M:MailKit.BodyPartVisitor.VisitBodyPartBasic(MailKit.BodyPartBasic)">
  29952. <summary>
  29953. Visit the basic MIME body part.
  29954. </summary>
  29955. <remarks>
  29956. Visits the basic MIME body part.
  29957. </remarks>
  29958. <param name="entity">The basic MIME body part.</param>
  29959. </member>
  29960. <member name="M:MailKit.BodyPartVisitor.VisitMessage(MailKit.BodyPart)">
  29961. <summary>
  29962. Visit the message contained within a message/rfc822 or message/news MIME entity.
  29963. </summary>
  29964. <remarks>
  29965. Visits the message contained within a message/rfc822 or message/news MIME entity.
  29966. </remarks>
  29967. <param name="message">The body part representing the message/rfc822 message.</param>
  29968. </member>
  29969. <member name="M:MailKit.BodyPartVisitor.VisitBodyPartMessage(MailKit.BodyPartMessage)">
  29970. <summary>
  29971. Visit the message/rfc822 or message/news MIME entity.
  29972. </summary>
  29973. <remarks>
  29974. Visits the message/rfc822 or message/news MIME entity.
  29975. </remarks>
  29976. <param name="entity">The message/rfc822 or message/news body part.</param>
  29977. </member>
  29978. <member name="M:MailKit.BodyPartVisitor.VisitChildren(MailKit.BodyPartMultipart)">
  29979. <summary>
  29980. Visit the children of a <see cref="T:MailKit.BodyPartMultipart"/>.
  29981. </summary>
  29982. <remarks>
  29983. Visits the children of a <see cref="T:MailKit.BodyPartMultipart"/>.
  29984. </remarks>
  29985. <param name="multipart">The multipart.</param>
  29986. </member>
  29987. <member name="M:MailKit.BodyPartVisitor.VisitBodyPartMultipart(MailKit.BodyPartMultipart)">
  29988. <summary>
  29989. Visit the abstract multipart MIME entity.
  29990. </summary>
  29991. <remarks>
  29992. Visits the abstract multipart MIME entity.
  29993. </remarks>
  29994. <param name="multipart">The multipart body part.</param>
  29995. </member>
  29996. <member name="M:MailKit.BodyPartVisitor.VisitBodyPartText(MailKit.BodyPartText)">
  29997. <summary>
  29998. Visit the text-based MIME part entity.
  29999. </summary>
  30000. <remarks>
  30001. Visits the text-based MIME part entity.
  30002. </remarks>
  30003. <param name="entity">The text-based body part.</param>
  30004. </member>
  30005. <member name="T:MailKit.CommandException">
  30006. <summary>
  30007. The exception that is thrown when there is a command error.
  30008. </summary>
  30009. <remarks>
  30010. A <see cref="T:MailKit.CommandException"/> can be thrown by any of the various client
  30011. methods in MailKit. Unlike a <see cref="T:MailKit.ProtocolException"/>, a
  30012. <see cref="T:MailKit.CommandException"/> is typically non-fatal (meaning that it does
  30013. not force the client to disconnect).
  30014. </remarks>
  30015. </member>
  30016. <member name="M:MailKit.CommandException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  30017. <summary>
  30018. Initializes a new instance of the <see cref="T:MailKit.CommandException"/> class.
  30019. </summary>
  30020. <remarks>
  30021. Creates a new <see cref="T:MailKit.CommandException"/>.
  30022. </remarks>
  30023. <param name="info">The serialization info.</param>
  30024. <param name="context">The streaming context.</param>
  30025. <exception cref="T:System.ArgumentNullException">
  30026. <paramref name="info"/> is <c>null</c>.
  30027. </exception>
  30028. </member>
  30029. <member name="M:MailKit.CommandException.#ctor(System.String,System.Exception)">
  30030. <summary>
  30031. Initializes a new instance of the <see cref="T:MailKit.CommandException"/> class.
  30032. </summary>
  30033. <remarks>
  30034. Creates a new <see cref="T:MailKit.CommandException"/>.
  30035. </remarks>
  30036. <param name="message">The error message.</param>
  30037. <param name="innerException">An inner exception.</param>
  30038. </member>
  30039. <member name="M:MailKit.CommandException.#ctor(System.String)">
  30040. <summary>
  30041. Initializes a new instance of the <see cref="T:MailKit.CommandException"/> class.
  30042. </summary>
  30043. <remarks>
  30044. Creates a new <see cref="T:MailKit.CommandException"/>.
  30045. </remarks>
  30046. <param name="message">The error message.</param>
  30047. </member>
  30048. <member name="M:MailKit.CommandException.#ctor">
  30049. <summary>
  30050. Initializes a new instance of the <see cref="T:MailKit.CommandException"/> class.
  30051. </summary>
  30052. <remarks>
  30053. Creates a new <see cref="T:MailKit.CommandException"/>.
  30054. </remarks>
  30055. </member>
  30056. <member name="T:MailKit.CompressedStream">
  30057. <summary>
  30058. A compressed stream.
  30059. </summary>
  30060. </member>
  30061. <member name="P:MailKit.CompressedStream.InnerStream">
  30062. <summary>
  30063. Gets the inner stream.
  30064. </summary>
  30065. <value>The inner stream.</value>
  30066. </member>
  30067. <member name="P:MailKit.CompressedStream.CanRead">
  30068. <summary>
  30069. Gets whether the stream supports reading.
  30070. </summary>
  30071. <value><c>true</c> if the stream supports reading; otherwise, <c>false</c>.</value>
  30072. </member>
  30073. <member name="P:MailKit.CompressedStream.CanWrite">
  30074. <summary>
  30075. Gets whether the stream supports writing.
  30076. </summary>
  30077. <value><c>true</c> if the stream supports writing; otherwise, <c>false</c>.</value>
  30078. </member>
  30079. <member name="P:MailKit.CompressedStream.CanSeek">
  30080. <summary>
  30081. Gets whether the stream supports seeking.
  30082. </summary>
  30083. <value><c>true</c> if the stream supports seeking; otherwise, <c>false</c>.</value>
  30084. </member>
  30085. <member name="P:MailKit.CompressedStream.CanTimeout">
  30086. <summary>
  30087. Gets whether the stream supports I/O timeouts.
  30088. </summary>
  30089. <value><c>true</c> if the stream supports I/O timeouts; otherwise, <c>false</c>.</value>
  30090. </member>
  30091. <member name="P:MailKit.CompressedStream.ReadTimeout">
  30092. <summary>
  30093. Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out.
  30094. </summary>
  30095. <returns>A value, in miliseconds, that determines how long the stream will attempt to read before timing out.</returns>
  30096. <value>The read timeout.</value>
  30097. </member>
  30098. <member name="P:MailKit.CompressedStream.WriteTimeout">
  30099. <summary>
  30100. Gets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out.
  30101. </summary>
  30102. <returns>A value, in miliseconds, that determines how long the stream will attempt to write before timing out.</returns>
  30103. <value>The write timeout.</value>
  30104. </member>
  30105. <member name="P:MailKit.CompressedStream.Position">
  30106. <summary>
  30107. Gets or sets the position within the current stream.
  30108. </summary>
  30109. <returns>The current position within the stream.</returns>
  30110. <value>The position of the stream.</value>
  30111. <exception cref="T:System.NotSupportedException">
  30112. The stream does not support seeking.
  30113. </exception>
  30114. </member>
  30115. <member name="P:MailKit.CompressedStream.Length">
  30116. <summary>
  30117. Gets the length in bytes of the stream.
  30118. </summary>
  30119. <returns>A long value representing the length of the stream in bytes.</returns>
  30120. <value>The length of the stream.</value>
  30121. <exception cref="T:System.NotSupportedException">
  30122. The stream does not support seeking.
  30123. </exception>
  30124. </member>
  30125. <member name="M:MailKit.CompressedStream.Read(System.Byte[],System.Int32,System.Int32)">
  30126. <summary>
  30127. Reads a sequence of bytes from the stream and advances the position
  30128. within the stream by the number of bytes read.
  30129. </summary>
  30130. <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many
  30131. bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
  30132. <param name="buffer">The buffer.</param>
  30133. <param name="offset">The buffer offset.</param>
  30134. <param name="count">The number of bytes to read.</param>
  30135. <exception cref="T:System.ArgumentNullException">
  30136. <paramref name="buffer"/> is <c>null</c>.
  30137. </exception>
  30138. <exception cref="T:System.ArgumentOutOfRangeException">
  30139. <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
  30140. <para>-or-</para>
  30141. <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
  30142. at the specified <paramref name="offset"/>.</para>
  30143. </exception>
  30144. <exception cref="T:System.ObjectDisposedException">
  30145. The stream has been disposed.
  30146. </exception>
  30147. <exception cref="T:System.IO.IOException">
  30148. An I/O error occurred.
  30149. </exception>
  30150. </member>
  30151. <member name="M:MailKit.CompressedStream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  30152. <summary>
  30153. Reads a sequence of bytes from the stream and advances the position
  30154. within the stream by the number of bytes read.
  30155. </summary>
  30156. <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many
  30157. bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
  30158. <param name="buffer">The buffer.</param>
  30159. <param name="offset">The buffer offset.</param>
  30160. <param name="count">The number of bytes to read.</param>
  30161. <param name="cancellationToken">The cancellation token.</param>
  30162. <exception cref="T:System.ArgumentNullException">
  30163. <paramref name="buffer"/> is <c>null</c>.
  30164. </exception>
  30165. <exception cref="T:System.ArgumentOutOfRangeException">
  30166. <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
  30167. <para>-or-</para>
  30168. <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
  30169. at the specified <paramref name="offset"/>.</para>
  30170. </exception>
  30171. <exception cref="T:System.ObjectDisposedException">
  30172. The stream has been disposed.
  30173. </exception>
  30174. <exception cref="T:System.IO.IOException">
  30175. An I/O error occurred.
  30176. </exception>
  30177. </member>
  30178. <member name="M:MailKit.CompressedStream.Write(System.Byte[],System.Int32,System.Int32)">
  30179. <summary>
  30180. Writes a sequence of bytes to the stream and advances the current
  30181. position within this stream by the number of bytes written.
  30182. </summary>
  30183. <param name="buffer">The buffer to write.</param>
  30184. <param name="offset">The offset of the first byte to write.</param>
  30185. <param name="count">The number of bytes to write.</param>
  30186. <exception cref="T:System.ArgumentNullException">
  30187. <paramref name="buffer"/> is <c>null</c>.
  30188. </exception>
  30189. <exception cref="T:System.ArgumentOutOfRangeException">
  30190. <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
  30191. <para>-or-</para>
  30192. <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
  30193. at the specified <paramref name="offset"/>.</para>
  30194. </exception>
  30195. <exception cref="T:System.ObjectDisposedException">
  30196. The stream has been disposed.
  30197. </exception>
  30198. <exception cref="T:System.NotSupportedException">
  30199. The stream does not support writing.
  30200. </exception>
  30201. <exception cref="T:System.IO.IOException">
  30202. An I/O error occurred.
  30203. </exception>
  30204. </member>
  30205. <member name="M:MailKit.CompressedStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  30206. <summary>
  30207. Writes a sequence of bytes to the stream and advances the current
  30208. position within this stream by the number of bytes written.
  30209. </summary>
  30210. <returns>A task that represents the asynchronous write operation.</returns>
  30211. <param name="buffer">The buffer to write.</param>
  30212. <param name="offset">The offset of the first byte to write.</param>
  30213. <param name="count">The number of bytes to write.</param>
  30214. <param name="cancellationToken">The cancellation token.</param>
  30215. <exception cref="T:System.ArgumentNullException">
  30216. <paramref name="buffer"/> is <c>null</c>.
  30217. </exception>
  30218. <exception cref="T:System.ArgumentOutOfRangeException">
  30219. <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
  30220. <para>-or-</para>
  30221. <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
  30222. at the specified <paramref name="offset"/>.</para>
  30223. </exception>
  30224. <exception cref="T:System.ObjectDisposedException">
  30225. The stream has been disposed.
  30226. </exception>
  30227. <exception cref="T:System.NotSupportedException">
  30228. The stream does not support writing.
  30229. </exception>
  30230. <exception cref="T:System.IO.IOException">
  30231. An I/O error occurred.
  30232. </exception>
  30233. </member>
  30234. <member name="M:MailKit.CompressedStream.Flush">
  30235. <summary>
  30236. Clears all output buffers for this stream and causes any buffered data to be written
  30237. to the underlying device.
  30238. </summary>
  30239. <exception cref="T:System.ObjectDisposedException">
  30240. The stream has been disposed.
  30241. </exception>
  30242. <exception cref="T:System.NotSupportedException">
  30243. The stream does not support writing.
  30244. </exception>
  30245. <exception cref="T:System.IO.IOException">
  30246. An I/O error occurred.
  30247. </exception>
  30248. </member>
  30249. <member name="M:MailKit.CompressedStream.FlushAsync(System.Threading.CancellationToken)">
  30250. <summary>
  30251. Clears all output buffers for this stream and causes any buffered data to be written
  30252. to the underlying device.
  30253. </summary>
  30254. <returns>A task that represents the asynchronous flush operation.</returns>
  30255. <exception cref="T:System.ObjectDisposedException">
  30256. The stream has been disposed.
  30257. </exception>
  30258. <exception cref="T:System.NotSupportedException">
  30259. The stream does not support writing.
  30260. </exception>
  30261. <exception cref="T:System.IO.IOException">
  30262. An I/O error occurred.
  30263. </exception>
  30264. </member>
  30265. <member name="M:MailKit.CompressedStream.Seek(System.Int64,System.IO.SeekOrigin)">
  30266. <summary>
  30267. Sets the position within the current stream.
  30268. </summary>
  30269. <returns>The new position within the stream.</returns>
  30270. <param name="offset">The offset into the stream relative to the <paramref name="origin"/>.</param>
  30271. <param name="origin">The origin to seek from.</param>
  30272. <exception cref="T:System.NotSupportedException">
  30273. The stream does not support seeking.
  30274. </exception>
  30275. </member>
  30276. <member name="M:MailKit.CompressedStream.SetLength(System.Int64)">
  30277. <summary>
  30278. Sets the length of the stream.
  30279. </summary>
  30280. <param name="value">The desired length of the stream in bytes.</param>
  30281. <exception cref="T:System.NotSupportedException">
  30282. The stream does not support setting the length.
  30283. </exception>
  30284. </member>
  30285. <member name="M:MailKit.CompressedStream.Dispose(System.Boolean)">
  30286. <summary>
  30287. Releases the unmanaged resources used by the <see cref="T:MailKit.CompressedStream"/> and
  30288. optionally releases the managed resources.
  30289. </summary>
  30290. <param name="disposing"><c>true</c> to release both managed and unmanaged resources;
  30291. <c>false</c> to release only the unmanaged resources.</param>
  30292. </member>
  30293. <member name="T:MailKit.ConnectedEventArgs">
  30294. <summary>
  30295. Connected event arguments.
  30296. </summary>
  30297. <remarks>
  30298. When a <see cref="T:MailKit.IMailService"/> is connected, it will emit a
  30299. <see cref="E:MailKit.IMailService.Connected"/> event.
  30300. </remarks>
  30301. </member>
  30302. <member name="M:MailKit.ConnectedEventArgs.#ctor(System.String,System.Int32,MailKit.Security.SecureSocketOptions)">
  30303. <summary>
  30304. Initializes a new instance of the <see cref="T:MailKit.ConnectedEventArgs"/> class.
  30305. </summary>
  30306. <param name="host">The name of the host that the client connected to.</param>
  30307. <param name="port">The port that the client connected to on the remote host.</param>
  30308. <param name="options">The SSL/TLS options that were used when connecting to the remote host.</param>
  30309. </member>
  30310. <member name="P:MailKit.ConnectedEventArgs.Host">
  30311. <summary>
  30312. Get the name of the remote host.
  30313. </summary>
  30314. <remarks>
  30315. Gets the name of the remote host.
  30316. </remarks>
  30317. <value>The host name of the server.</value>
  30318. </member>
  30319. <member name="P:MailKit.ConnectedEventArgs.Port">
  30320. <summary>
  30321. Get the port.
  30322. </summary>
  30323. <remarks>
  30324. Gets the port.
  30325. </remarks>
  30326. <value>The port.</value>
  30327. </member>
  30328. <member name="P:MailKit.ConnectedEventArgs.Options">
  30329. <summary>
  30330. Get the SSL/TLS options.
  30331. </summary>
  30332. <remarks>
  30333. Gets the SSL/TLS options.
  30334. </remarks>
  30335. <value>The SSL/TLS options.</value>
  30336. </member>
  30337. <member name="T:MailKit.DeliveryStatusNotification">
  30338. <summary>
  30339. Delivery status notification types.
  30340. </summary>
  30341. <remarks>
  30342. A set of flags that may be bitwise-or'd together to specify
  30343. when a delivery status notification should be sent for a
  30344. particlar recipient.
  30345. </remarks>
  30346. </member>
  30347. <member name="F:MailKit.DeliveryStatusNotification.Never">
  30348. <summary>
  30349. Never send delivery status notifications.
  30350. </summary>
  30351. </member>
  30352. <member name="F:MailKit.DeliveryStatusNotification.Success">
  30353. <summary>
  30354. Send a notification on successful delivery to the recipient.
  30355. </summary>
  30356. </member>
  30357. <member name="F:MailKit.DeliveryStatusNotification.Failure">
  30358. <summary>
  30359. Send a notification on failure to deliver to the recipient.
  30360. </summary>
  30361. </member>
  30362. <member name="F:MailKit.DeliveryStatusNotification.Delay">
  30363. <summary>
  30364. Send a notification when the delivery to the recipient has
  30365. been delayed for an unusual amount of time.
  30366. </summary>
  30367. </member>
  30368. <member name="T:MailKit.DisconnectedEventArgs">
  30369. <summary>
  30370. Disconnected event arguments.
  30371. </summary>
  30372. <remarks>
  30373. When a <see cref="T:MailKit.IMailService"/> gets disconnected, it will emit a
  30374. <see cref="E:MailKit.IMailService.Disconnected"/> event.
  30375. </remarks>
  30376. </member>
  30377. <member name="M:MailKit.DisconnectedEventArgs.#ctor(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Boolean)">
  30378. <summary>
  30379. Initializes a new instance of the <see cref="T:MailKit.DisconnectedEventArgs"/> class.
  30380. </summary>
  30381. <remarks>
  30382. Initializes a new instance of the <see cref="T:MailKit.DisconnectedEventArgs"/> class.
  30383. </remarks>
  30384. <param name="host">The name of the host that the client was connected to.</param>
  30385. <param name="port">The port that the client was connected to.</param>
  30386. <param name="options">The SSL/TLS options that were used by the client.</param>
  30387. <param name="requested">If <c>true</c>, the <see cref="T:MailKit.IMailService"/> was disconnected via the
  30388. <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/> method.</param>
  30389. </member>
  30390. <member name="P:MailKit.DisconnectedEventArgs.IsRequested">
  30391. <summary>
  30392. Get whether or not the service was explicitly asked to disconnect.
  30393. </summary>
  30394. <remarks>
  30395. If the <see cref="T:MailKit.IMailService"/> was disconnected via the
  30396. <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/> method, then
  30397. the value of <see cref="P:MailKit.DisconnectedEventArgs.IsRequested"/> will be <c>true</c>. If the connection was unexpectedly
  30398. dropped, then the value will be <c>false</c>.
  30399. </remarks>
  30400. <value><c>true</c> if the disconnect was explicitly requested; otherwise, <c>false</c>.</value>
  30401. </member>
  30402. <member name="T:MailKit.DuplexStream">
  30403. <summary>
  30404. A duplex stream.
  30405. </summary>
  30406. </member>
  30407. <member name="M:MailKit.DuplexStream.#ctor(System.IO.Stream,System.IO.Stream)">
  30408. <summary>
  30409. Initializes a new instance of the <see cref="T:MailKit.DuplexStream"/> class.
  30410. </summary>
  30411. <param name="istream">The stream to use for input.</param>
  30412. <param name="ostream">The stream to use for output.</param>
  30413. <exception cref="T:System.ArgumentNullException">
  30414. <para><paramref name="istream"/> is <c>null</c>.</para>
  30415. <para>-or-</para>
  30416. <para><paramref name="ostream"/> is <c>null</c>.</para>
  30417. </exception>
  30418. </member>
  30419. <member name="P:MailKit.DuplexStream.InputStream">
  30420. <summary>
  30421. Gets the input stream.
  30422. </summary>
  30423. <value>The input stream.</value>
  30424. </member>
  30425. <member name="P:MailKit.DuplexStream.OutputStream">
  30426. <summary>
  30427. Gets the output stream.
  30428. </summary>
  30429. <value>The output stream.</value>
  30430. </member>
  30431. <member name="P:MailKit.DuplexStream.CanRead">
  30432. <summary>
  30433. Gets whether the stream supports reading.
  30434. </summary>
  30435. <value><c>true</c> if the stream supports reading; otherwise, <c>false</c>.</value>
  30436. </member>
  30437. <member name="P:MailKit.DuplexStream.CanWrite">
  30438. <summary>
  30439. Gets whether the stream supports writing.
  30440. </summary>
  30441. <value><c>true</c> if the stream supports writing; otherwise, <c>false</c>.</value>
  30442. </member>
  30443. <member name="P:MailKit.DuplexStream.CanSeek">
  30444. <summary>
  30445. Gets whether the stream supports seeking.
  30446. </summary>
  30447. <value><c>true</c> if the stream supports seeking; otherwise, <c>false</c>.</value>
  30448. </member>
  30449. <member name="P:MailKit.DuplexStream.CanTimeout">
  30450. <summary>
  30451. Gets whether the stream supports I/O timeouts.
  30452. </summary>
  30453. <value><c>true</c> if the stream supports I/O timeouts; otherwise, <c>false</c>.</value>
  30454. </member>
  30455. <member name="P:MailKit.DuplexStream.ReadTimeout">
  30456. <summary>
  30457. Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out.
  30458. </summary>
  30459. <returns>A value, in miliseconds, that determines how long the stream will attempt to read before timing out.</returns>
  30460. <value>The read timeout.</value>
  30461. </member>
  30462. <member name="P:MailKit.DuplexStream.WriteTimeout">
  30463. <summary>
  30464. Gets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out.
  30465. </summary>
  30466. <returns>A value, in miliseconds, that determines how long the stream will attempt to write before timing out.</returns>
  30467. <value>The write timeout.</value>
  30468. </member>
  30469. <member name="P:MailKit.DuplexStream.Position">
  30470. <summary>
  30471. Gets or sets the position within the current stream.
  30472. </summary>
  30473. <returns>The current position within the stream.</returns>
  30474. <value>The position of the stream.</value>
  30475. <exception cref="T:System.NotSupportedException">
  30476. The stream does not support seeking.
  30477. </exception>
  30478. </member>
  30479. <member name="P:MailKit.DuplexStream.Length">
  30480. <summary>
  30481. Gets the length in bytes of the stream.
  30482. </summary>
  30483. <returns>A long value representing the length of the stream in bytes.</returns>
  30484. <value>The length of the stream.</value>
  30485. <exception cref="T:System.NotSupportedException">
  30486. The stream does not support seeking.
  30487. </exception>
  30488. </member>
  30489. <member name="M:MailKit.DuplexStream.Read(System.Byte[],System.Int32,System.Int32)">
  30490. <summary>
  30491. Reads a sequence of bytes from the stream and advances the position
  30492. within the stream by the number of bytes read.
  30493. </summary>
  30494. <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many
  30495. bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
  30496. <param name="buffer">The buffer.</param>
  30497. <param name="offset">The buffer offset.</param>
  30498. <param name="count">The number of bytes to read.</param>
  30499. <exception cref="T:System.ArgumentNullException">
  30500. <paramref name="buffer"/> is <c>null</c>.
  30501. </exception>
  30502. <exception cref="T:System.ArgumentOutOfRangeException">
  30503. <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
  30504. <para>-or-</para>
  30505. <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
  30506. at the specified <paramref name="offset"/>.</para>
  30507. </exception>
  30508. <exception cref="T:System.ObjectDisposedException">
  30509. The stream has been disposed.
  30510. </exception>
  30511. <exception cref="T:System.IO.IOException">
  30512. An I/O error occurred.
  30513. </exception>
  30514. </member>
  30515. <member name="M:MailKit.DuplexStream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  30516. <summary>
  30517. Reads a sequence of bytes from the stream and advances the position
  30518. within the stream by the number of bytes read.
  30519. </summary>
  30520. <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many
  30521. bytes are not currently available, or zero (0) if the end of the stream has been reached.</returns>
  30522. <param name="buffer">The buffer.</param>
  30523. <param name="offset">The buffer offset.</param>
  30524. <param name="count">The number of bytes to read.</param>
  30525. <param name="cancellationToken">The cancellation token.</param>
  30526. <exception cref="T:System.ArgumentNullException">
  30527. <paramref name="buffer"/> is <c>null</c>.
  30528. </exception>
  30529. <exception cref="T:System.ArgumentOutOfRangeException">
  30530. <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
  30531. <para>-or-</para>
  30532. <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
  30533. at the specified <paramref name="offset"/>.</para>
  30534. </exception>
  30535. <exception cref="T:System.ObjectDisposedException">
  30536. The stream has been disposed.
  30537. </exception>
  30538. <exception cref="T:System.IO.IOException">
  30539. An I/O error occurred.
  30540. </exception>
  30541. </member>
  30542. <member name="M:MailKit.DuplexStream.Write(System.Byte[],System.Int32,System.Int32)">
  30543. <summary>
  30544. Writes a sequence of bytes to the stream and advances the current
  30545. position within this stream by the number of bytes written.
  30546. </summary>
  30547. <param name="buffer">The buffer to write.</param>
  30548. <param name="offset">The offset of the first byte to write.</param>
  30549. <param name="count">The number of bytes to write.</param>
  30550. <exception cref="T:System.ArgumentNullException">
  30551. <paramref name="buffer"/> is <c>null</c>.
  30552. </exception>
  30553. <exception cref="T:System.ArgumentOutOfRangeException">
  30554. <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
  30555. <para>-or-</para>
  30556. <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
  30557. at the specified <paramref name="offset"/>.</para>
  30558. </exception>
  30559. <exception cref="T:System.ObjectDisposedException">
  30560. The stream has been disposed.
  30561. </exception>
  30562. <exception cref="T:System.NotSupportedException">
  30563. The stream does not support writing.
  30564. </exception>
  30565. <exception cref="T:System.IO.IOException">
  30566. An I/O error occurred.
  30567. </exception>
  30568. </member>
  30569. <member name="M:MailKit.DuplexStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  30570. <summary>
  30571. Writes a sequence of bytes to the stream and advances the current
  30572. position within this stream by the number of bytes written.
  30573. </summary>
  30574. <returns>A task that represents the asynchronous write operation.</returns>
  30575. <param name="buffer">The buffer to write.</param>
  30576. <param name="offset">The offset of the first byte to write.</param>
  30577. <param name="count">The number of bytes to write.</param>
  30578. <param name="cancellationToken">The cancellation token.</param>
  30579. <exception cref="T:System.ArgumentNullException">
  30580. <paramref name="buffer"/> is <c>null</c>.
  30581. </exception>
  30582. <exception cref="T:System.ArgumentOutOfRangeException">
  30583. <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
  30584. <para>-or-</para>
  30585. <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
  30586. at the specified <paramref name="offset"/>.</para>
  30587. </exception>
  30588. <exception cref="T:System.ObjectDisposedException">
  30589. The stream has been disposed.
  30590. </exception>
  30591. <exception cref="T:System.NotSupportedException">
  30592. The stream does not support writing.
  30593. </exception>
  30594. <exception cref="T:System.IO.IOException">
  30595. An I/O error occurred.
  30596. </exception>
  30597. </member>
  30598. <member name="M:MailKit.DuplexStream.Flush">
  30599. <summary>
  30600. Clears all output buffers for this stream and causes any buffered data to be written
  30601. to the underlying device.
  30602. </summary>
  30603. <exception cref="T:System.ObjectDisposedException">
  30604. The stream has been disposed.
  30605. </exception>
  30606. <exception cref="T:System.NotSupportedException">
  30607. The stream does not support writing.
  30608. </exception>
  30609. <exception cref="T:System.IO.IOException">
  30610. An I/O error occurred.
  30611. </exception>
  30612. </member>
  30613. <member name="M:MailKit.DuplexStream.FlushAsync(System.Threading.CancellationToken)">
  30614. <summary>
  30615. Clears all output buffers for this stream and causes any buffered data to be written
  30616. to the underlying device.
  30617. </summary>
  30618. <returns>A task that represents the asynchronous flush operation.</returns>
  30619. <param name="cancellationToken">The cancellation token.</param>
  30620. <exception cref="T:System.ObjectDisposedException">
  30621. The stream has been disposed.
  30622. </exception>
  30623. <exception cref="T:System.NotSupportedException">
  30624. The stream does not support writing.
  30625. </exception>
  30626. <exception cref="T:System.IO.IOException">
  30627. An I/O error occurred.
  30628. </exception>
  30629. </member>
  30630. <member name="M:MailKit.DuplexStream.Seek(System.Int64,System.IO.SeekOrigin)">
  30631. <summary>
  30632. Sets the position within the current stream.
  30633. </summary>
  30634. <returns>The new position within the stream.</returns>
  30635. <param name="offset">The offset into the stream relative to the <paramref name="origin"/>.</param>
  30636. <param name="origin">The origin to seek from.</param>
  30637. <exception cref="T:System.NotSupportedException">
  30638. The stream does not support seeking.
  30639. </exception>
  30640. </member>
  30641. <member name="M:MailKit.DuplexStream.SetLength(System.Int64)">
  30642. <summary>
  30643. Sets the length of the stream.
  30644. </summary>
  30645. <param name="value">The desired length of the stream in bytes.</param>
  30646. <exception cref="T:System.NotSupportedException">
  30647. The stream does not support setting the length.
  30648. </exception>
  30649. </member>
  30650. <member name="M:MailKit.DuplexStream.Dispose(System.Boolean)">
  30651. <summary>
  30652. Releases the unmanaged resources used by the <see cref="T:MailKit.DuplexStream"/> and
  30653. optionally releases the managed resources.
  30654. </summary>
  30655. <param name="disposing"><c>true</c> to release both managed and unmanaged resources;
  30656. <c>false</c> to release only the unmanaged resources.</param>
  30657. </member>
  30658. <member name="T:MailKit.Envelope">
  30659. <summary>
  30660. A message envelope containing a brief summary of the message.
  30661. </summary>
  30662. <remarks>
  30663. The envelope of a message contains information such as the
  30664. date the message was sent, the subject of the message,
  30665. the sender of the message, who the message was sent to,
  30666. which message(s) the message may be in reply to,
  30667. and the message id.
  30668. </remarks>
  30669. </member>
  30670. <member name="M:MailKit.Envelope.#ctor">
  30671. <summary>
  30672. Initializes a new instance of the <see cref="T:MailKit.Envelope"/> class.
  30673. </summary>
  30674. <remarks>
  30675. Creates a new <see cref="T:MailKit.Envelope"/>.
  30676. </remarks>
  30677. </member>
  30678. <member name="P:MailKit.Envelope.From">
  30679. <summary>
  30680. Gets the address(es) that the message is from.
  30681. </summary>
  30682. <remarks>
  30683. Gets the address(es) that the message is from.
  30684. </remarks>
  30685. <value>The address(es) that the message is from.</value>
  30686. </member>
  30687. <member name="P:MailKit.Envelope.Sender">
  30688. <summary>
  30689. Gets the actual sender(s) of the message.
  30690. </summary>
  30691. <remarks>
  30692. The senders may differ from the addresses in <see cref="P:MailKit.Envelope.From"/> if
  30693. the message was sent by someone on behalf of someone else.
  30694. </remarks>
  30695. <value>The actual sender(s) of the message.</value>
  30696. </member>
  30697. <member name="P:MailKit.Envelope.ReplyTo">
  30698. <summary>
  30699. Gets the address(es) that replies should be sent to.
  30700. </summary>
  30701. <remarks>
  30702. The senders of the message may prefer that replies are sent
  30703. somewhere other than the address they used to send the message.
  30704. </remarks>
  30705. <value>The address(es) that replies should be sent to.</value>
  30706. </member>
  30707. <member name="P:MailKit.Envelope.To">
  30708. <summary>
  30709. Gets the list of addresses that the message was sent to.
  30710. </summary>
  30711. <remarks>
  30712. Gets the list of addresses that the message was sent to.
  30713. </remarks>
  30714. <value>The address(es) that the message was sent to.</value>
  30715. </member>
  30716. <member name="P:MailKit.Envelope.Cc">
  30717. <summary>
  30718. Gets the list of addresses that the message was carbon-copied to.
  30719. </summary>
  30720. <remarks>
  30721. Gets the list of addresses that the message was carbon-copied to.
  30722. </remarks>
  30723. <value>The address(es) that the message was carbon-copied to.</value>
  30724. </member>
  30725. <member name="P:MailKit.Envelope.Bcc">
  30726. <summary>
  30727. Gets the list of addresses that the message was blind-carbon-copied to.
  30728. </summary>
  30729. <remarks>
  30730. Gets the list of addresses that the message was blind-carbon-copied to.
  30731. </remarks>
  30732. <value>The address(es) that the message was carbon-copied to.</value>
  30733. </member>
  30734. <member name="P:MailKit.Envelope.InReplyTo">
  30735. <summary>
  30736. The Message-Id that the message is replying to.
  30737. </summary>
  30738. <remarks>
  30739. The Message-Id that the message is replying to.
  30740. </remarks>
  30741. <value>The Message-Id that the message is replying to.</value>
  30742. </member>
  30743. <member name="P:MailKit.Envelope.Date">
  30744. <summary>
  30745. Gets the date that the message was sent on, if available.
  30746. </summary>
  30747. <remarks>
  30748. Gets the date that the message was sent on, if available.
  30749. </remarks>
  30750. <value>The date the message was sent.</value>
  30751. </member>
  30752. <member name="P:MailKit.Envelope.MessageId">
  30753. <summary>
  30754. Gets the ID of the message, if available.
  30755. </summary>
  30756. <remarks>
  30757. Gets the ID of the message, if available.
  30758. </remarks>
  30759. <value>The message identifier.</value>
  30760. </member>
  30761. <member name="P:MailKit.Envelope.Subject">
  30762. <summary>
  30763. Gets the subject of the message.
  30764. </summary>
  30765. <remarks>
  30766. Gets the subject of the message.
  30767. </remarks>
  30768. <value>The subject.</value>
  30769. </member>
  30770. <member name="M:MailKit.Envelope.ToString">
  30771. <summary>
  30772. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.Envelope"/>.
  30773. </summary>
  30774. <remarks>
  30775. <para>The returned string can be parsed by <see cref="M:MailKit.Envelope.TryParse(System.String,MailKit.Envelope@)"/>.</para>
  30776. <note type="warning">The syntax of the string returned, while similar to IMAP's ENVELOPE syntax,
  30777. is not completely compatible.</note>
  30778. </remarks>
  30779. <returns>A <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.Envelope"/>.</returns>
  30780. </member>
  30781. <member name="M:MailKit.Envelope.TryParse(System.String,MailKit.Envelope@)">
  30782. <summary>
  30783. Tries to parse the given text into a new <see cref="T:MailKit.Envelope"/> instance.
  30784. </summary>
  30785. <remarks>
  30786. <para>Parses an Envelope value from the specified text.</para>
  30787. <note type="warning">This syntax, while similar to IMAP's ENVELOPE syntax, is not
  30788. completely compatible.</note>
  30789. </remarks>
  30790. <returns><c>true</c>, if the envelope was successfully parsed, <c>false</c> otherwise.</returns>
  30791. <param name="text">The text to parse.</param>
  30792. <param name="envelope">The parsed envelope.</param>
  30793. <exception cref="T:System.ArgumentNullException">
  30794. <paramref name="text"/> is <c>null</c>.
  30795. </exception>
  30796. </member>
  30797. <member name="T:MailKit.FolderAccess">
  30798. <summary>
  30799. A folder access mode.
  30800. </summary>
  30801. <remarks>
  30802. A folder access mode.
  30803. </remarks>
  30804. <example>
  30805. <code language="c#" source="Examples\ImapExamples.cs" region="DownloadMessages"/>
  30806. </example>
  30807. </member>
  30808. <member name="F:MailKit.FolderAccess.None">
  30809. <summary>
  30810. The folder is not open.
  30811. </summary>
  30812. </member>
  30813. <member name="F:MailKit.FolderAccess.ReadOnly">
  30814. <summary>
  30815. The folder is read-only.
  30816. </summary>
  30817. </member>
  30818. <member name="F:MailKit.FolderAccess.ReadWrite">
  30819. <summary>
  30820. The folder is read/write.
  30821. </summary>
  30822. </member>
  30823. <member name="T:MailKit.FolderAttributes">
  30824. <summary>
  30825. Folder attributes as used by <see cref="P:MailKit.IMailFolder.Attributes"/>.
  30826. </summary>
  30827. <remarks>
  30828. Folder attributes as used by <see cref="P:MailKit.IMailFolder.Attributes"/>.
  30829. </remarks>
  30830. </member>
  30831. <member name="F:MailKit.FolderAttributes.None">
  30832. <summary>
  30833. The folder does not have any attributes.
  30834. </summary>
  30835. </member>
  30836. <member name="F:MailKit.FolderAttributes.NoInferiors">
  30837. <summary>
  30838. It is not possible for any subfolders to exist under the folder.
  30839. </summary>
  30840. </member>
  30841. <member name="F:MailKit.FolderAttributes.NoSelect">
  30842. <summary>
  30843. It is not possible to select the folder.
  30844. </summary>
  30845. </member>
  30846. <member name="F:MailKit.FolderAttributes.Marked">
  30847. <summary>
  30848. The folder has been marked as possibly containing new messages
  30849. since the folder was last selected.
  30850. </summary>
  30851. </member>
  30852. <member name="F:MailKit.FolderAttributes.Unmarked">
  30853. <summary>
  30854. The folder does not contain any new messages since the folder
  30855. was last selected.
  30856. </summary>
  30857. </member>
  30858. <member name="F:MailKit.FolderAttributes.NonExistent">
  30859. <summary>
  30860. The folder does not exist, but is simply a place-holder.
  30861. </summary>
  30862. </member>
  30863. <member name="F:MailKit.FolderAttributes.Subscribed">
  30864. <summary>
  30865. The folder is subscribed.
  30866. </summary>
  30867. </member>
  30868. <member name="F:MailKit.FolderAttributes.Remote">
  30869. <summary>
  30870. The folder is remote.
  30871. </summary>
  30872. </member>
  30873. <member name="F:MailKit.FolderAttributes.HasChildren">
  30874. <summary>
  30875. The folder has subfolders.
  30876. </summary>
  30877. </member>
  30878. <member name="F:MailKit.FolderAttributes.HasNoChildren">
  30879. <summary>
  30880. The folder does not have any subfolders.
  30881. </summary>
  30882. </member>
  30883. <member name="F:MailKit.FolderAttributes.All">
  30884. <summary>
  30885. The folder is a special "All" folder containing an aggregate of all messages.
  30886. </summary>
  30887. </member>
  30888. <member name="F:MailKit.FolderAttributes.Archive">
  30889. <summary>
  30890. The folder is a special "Archive" folder.
  30891. </summary>
  30892. </member>
  30893. <member name="F:MailKit.FolderAttributes.Drafts">
  30894. <summary>
  30895. The folder is the special "Drafts" folder.
  30896. </summary>
  30897. </member>
  30898. <member name="F:MailKit.FolderAttributes.Flagged">
  30899. <summary>
  30900. The folder is the special "Flagged" folder.
  30901. </summary>
  30902. </member>
  30903. <member name="F:MailKit.FolderAttributes.Inbox">
  30904. <summary>
  30905. The folder is the special "Inbox" folder.
  30906. </summary>
  30907. </member>
  30908. <member name="F:MailKit.FolderAttributes.Junk">
  30909. <summary>
  30910. The folder is the special "Junk" folder.
  30911. </summary>
  30912. </member>
  30913. <member name="F:MailKit.FolderAttributes.Sent">
  30914. <summary>
  30915. The folder is the special "Sent" folder.
  30916. </summary>
  30917. </member>
  30918. <member name="F:MailKit.FolderAttributes.Trash">
  30919. <summary>
  30920. The folder is the special "Trash" folder.
  30921. </summary>
  30922. </member>
  30923. <member name="T:MailKit.FolderCreatedEventArgs">
  30924. <summary>
  30925. Event args used when a <see cref="T:MailKit.IMailFolder"/> is created.
  30926. </summary>
  30927. <remarks>
  30928. Event args used when a <see cref="T:MailKit.IMailFolder"/> is created.
  30929. </remarks>
  30930. </member>
  30931. <member name="M:MailKit.FolderCreatedEventArgs.#ctor(MailKit.IMailFolder)">
  30932. <summary>
  30933. Initializes a new instance of the <see cref="T:MailKit.FolderCreatedEventArgs"/> class.
  30934. </summary>
  30935. <remarks>
  30936. Creates a new <see cref="T:MailKit.FolderCreatedEventArgs"/>.
  30937. </remarks>
  30938. <param name="folder">The newly created folder.</param>
  30939. <exception cref="T:System.ArgumentNullException">
  30940. <paramref name="folder"/> is <c>null</c>.
  30941. </exception>
  30942. </member>
  30943. <member name="P:MailKit.FolderCreatedEventArgs.Folder">
  30944. <summary>
  30945. Get the folder that was just created.
  30946. </summary>
  30947. <remarks>
  30948. Gets the folder that was just created.
  30949. </remarks>
  30950. <value>The folder.</value>
  30951. </member>
  30952. <member name="T:MailKit.FolderNamespace">
  30953. <summary>
  30954. A folder namespace.
  30955. </summary>
  30956. <remarks>
  30957. A folder namespace.
  30958. </remarks>
  30959. </member>
  30960. <member name="F:MailKit.FolderNamespace.DirectorySeparator">
  30961. <summary>
  30962. The directory separator for this folder namespace.
  30963. </summary>
  30964. <remarks>
  30965. The directory separator for this folder namespace.
  30966. </remarks>
  30967. </member>
  30968. <member name="F:MailKit.FolderNamespace.Path">
  30969. <summary>
  30970. The base path for this folder namespace.
  30971. </summary>
  30972. <remarks>
  30973. The base path for this folder namespace.
  30974. </remarks>
  30975. </member>
  30976. <member name="M:MailKit.FolderNamespace.#ctor(System.Char,System.String)">
  30977. <summary>
  30978. Initializes a new instance of the <see cref="T:MailKit.FolderNamespace"/> class.
  30979. </summary>
  30980. <remarks>
  30981. Creates a new folder namespace.
  30982. </remarks>
  30983. <param name="directorySeparator">The directory separator.</param>
  30984. <param name="path">The folder path.</param>
  30985. <exception cref="T:System.ArgumentNullException">
  30986. <paramref name="path"/> is <c>null</c>.
  30987. </exception>
  30988. </member>
  30989. <member name="T:MailKit.FolderNamespaceCollection">
  30990. <summary>
  30991. A read-only collection of folder namespaces.
  30992. </summary>
  30993. <remarks>
  30994. A read-only collection of folder namespaces.
  30995. </remarks>
  30996. </member>
  30997. <member name="M:MailKit.FolderNamespaceCollection.#ctor">
  30998. <summary>
  30999. Initializes a new instance of the <see cref="T:MailKit.FolderNamespaceCollection"/> class.
  31000. </summary>
  31001. <remarks>
  31002. Creates a new <see cref="T:MailKit.FolderNamespaceCollection"/>.
  31003. </remarks>
  31004. </member>
  31005. <member name="P:MailKit.FolderNamespaceCollection.Count">
  31006. <summary>
  31007. Gets the number of folder namespaces contained in the collection.
  31008. </summary>
  31009. <remarks>
  31010. Gets the number of folder namespaces contained in the collection.
  31011. </remarks>
  31012. <value>The count.</value>
  31013. </member>
  31014. <member name="M:MailKit.FolderNamespaceCollection.Add(MailKit.FolderNamespace)">
  31015. <summary>
  31016. Adds the specified namespace.
  31017. </summary>
  31018. <remarks>
  31019. Adds the specified namespace.
  31020. </remarks>
  31021. <param name="namespace">The namespace to add.</param>
  31022. <exception cref="T:System.ArgumentNullException">
  31023. <paramref name="namespace"/> is <c>null</c>.
  31024. </exception>
  31025. </member>
  31026. <member name="M:MailKit.FolderNamespaceCollection.Clear">
  31027. <summary>
  31028. Removes all namespaces from the collection.
  31029. </summary>
  31030. <remarks>
  31031. Removes all namespaces from the collection.
  31032. </remarks>
  31033. </member>
  31034. <member name="M:MailKit.FolderNamespaceCollection.Contains(MailKit.FolderNamespace)">
  31035. <summary>
  31036. Checks if the collection contains the specified namespace.
  31037. </summary>
  31038. <remarks>
  31039. Checks if the collection contains the specified namespace.
  31040. </remarks>
  31041. <returns><value>true</value> if the specified namespace exists;
  31042. otherwise <value>false</value>.</returns>
  31043. <param name="namespace">The namespace.</param>
  31044. <exception cref="T:System.ArgumentNullException">
  31045. <paramref name="namespace"/> is <c>null</c>.
  31046. </exception>
  31047. </member>
  31048. <member name="M:MailKit.FolderNamespaceCollection.Remove(MailKit.FolderNamespace)">
  31049. <summary>
  31050. Removes the first occurance of the specified namespace.
  31051. </summary>
  31052. <remarks>
  31053. Removes the first occurance of the specified namespace.
  31054. </remarks>
  31055. <returns><value>true</value> if the frst occurance of the specified
  31056. namespace was removed; otherwise <value>false</value>.</returns>
  31057. <param name="namespace">The namespace.</param>
  31058. <exception cref="T:System.ArgumentNullException">
  31059. <paramref name="namespace"/> is <c>null</c>.
  31060. </exception>
  31061. </member>
  31062. <member name="P:MailKit.FolderNamespaceCollection.Item(System.Int32)">
  31063. <summary>
  31064. Gets the <see cref="T:MailKit.FolderNamespace"/> at the specified index.
  31065. </summary>
  31066. <remarks>
  31067. Gets the <see cref="T:MailKit.FolderNamespace"/> at the specified index.
  31068. </remarks>
  31069. <value>The folder namespace at the specified index.</value>
  31070. <param name="index">The index.</param>
  31071. <exception cref="T:System.ArgumentNullException">
  31072. <paramref name="value"/> is <c>null</c>.
  31073. </exception>
  31074. <exception cref="T:System.ArgumentOutOfRangeException">
  31075. <paramref name="index"/> is out of range.
  31076. </exception>
  31077. </member>
  31078. <member name="M:MailKit.FolderNamespaceCollection.GetEnumerator">
  31079. <summary>
  31080. Gets the enumerator.
  31081. </summary>
  31082. <remarks>
  31083. Gets the enumerator.
  31084. </remarks>
  31085. <returns>The enumerator.</returns>
  31086. </member>
  31087. <member name="M:MailKit.FolderNamespaceCollection.System#Collections#IEnumerable#GetEnumerator">
  31088. <summary>
  31089. Gets the enumerator.
  31090. </summary>
  31091. <remarks>
  31092. Gets the enumerator.
  31093. </remarks>
  31094. <returns>The enumerator.</returns>
  31095. </member>
  31096. <member name="M:MailKit.FolderNamespaceCollection.ToString">
  31097. <summary>
  31098. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.FolderNamespaceCollection"/>.
  31099. </summary>
  31100. <remarks>
  31101. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.FolderNamespaceCollection"/>.
  31102. </remarks>
  31103. <returns>A <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.FolderNamespaceCollection"/>.</returns>
  31104. </member>
  31105. <member name="T:MailKit.FolderNotFoundException">
  31106. <summary>
  31107. The exception that is thrown when a folder could not be found.
  31108. </summary>
  31109. <remarks>
  31110. This exception is thrown by <see cref="M:MailKit.IMailFolder.GetSubfolder(System.String,System.Threading.CancellationToken)"/>.
  31111. </remarks>
  31112. </member>
  31113. <member name="M:MailKit.FolderNotFoundException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  31114. <summary>
  31115. Initializes a new instance of the <see cref="T:MailKit.FolderNotFoundException"/> class.
  31116. </summary>
  31117. <remarks>
  31118. Deserializes a <see cref="T:MailKit.FolderNotFoundException"/>.
  31119. </remarks>
  31120. <param name="info">The serialization info.</param>
  31121. <param name="context">The streaming context.</param>
  31122. <exception cref="T:System.ArgumentNullException">
  31123. <paramref name="info"/> is <c>null</c>.
  31124. </exception>
  31125. </member>
  31126. <member name="M:MailKit.FolderNotFoundException.#ctor(System.String,System.String,System.Exception)">
  31127. <summary>
  31128. Initializes a new instance of the <see cref="T:MailKit.FolderNotFoundException"/> class.
  31129. </summary>
  31130. <remarks>
  31131. Creates a new <see cref="T:MailKit.FolderNotFoundException"/>.
  31132. </remarks>
  31133. <param name="message">The error message.</param>
  31134. <param name="folderName">The name of the folder.</param>
  31135. <param name="innerException">The inner exception.</param>
  31136. <exception cref="T:System.ArgumentNullException">
  31137. <paramref name="folderName"/> is <c>null</c>.
  31138. </exception>
  31139. </member>
  31140. <member name="M:MailKit.FolderNotFoundException.#ctor(System.String,System.String)">
  31141. <summary>
  31142. Initializes a new instance of the <see cref="T:MailKit.FolderNotFoundException"/> class.
  31143. </summary>
  31144. <remarks>
  31145. Creates a new <see cref="T:MailKit.FolderNotFoundException"/>.
  31146. </remarks>
  31147. <param name="message">The error message.</param>
  31148. <param name="folderName">The name of the folder.</param>
  31149. <exception cref="T:System.ArgumentNullException">
  31150. <paramref name="folderName"/> is <c>null</c>.
  31151. </exception>
  31152. </member>
  31153. <member name="M:MailKit.FolderNotFoundException.#ctor(System.String)">
  31154. <summary>
  31155. Initializes a new instance of the <see cref="T:MailKit.FolderNotFoundException"/> class.
  31156. </summary>
  31157. <remarks>
  31158. Creates a new <see cref="T:MailKit.FolderNotFoundException"/>.
  31159. </remarks>
  31160. <param name="folderName">The name of the folder.</param>
  31161. <exception cref="T:System.ArgumentNullException">
  31162. <paramref name="folderName"/> is <c>null</c>.
  31163. </exception>
  31164. </member>
  31165. <member name="P:MailKit.FolderNotFoundException.FolderName">
  31166. <summary>
  31167. Gets the name of the folder that could not be found.
  31168. </summary>
  31169. <remarks>
  31170. Gets the name of the folder that could not be found.
  31171. </remarks>
  31172. <value>The name of the folder.</value>
  31173. </member>
  31174. <member name="M:MailKit.FolderNotFoundException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  31175. <summary>
  31176. When overridden in a derived class, sets the <see cref="T:System.Runtime.Serialization.SerializationInfo"/>
  31177. with information about the exception.
  31178. </summary>
  31179. <remarks>
  31180. Serializes the state of the <see cref="T:MailKit.FolderNotFoundException"/>.
  31181. </remarks>
  31182. <param name="info">The serialization info.</param>
  31183. <param name="context">The streaming context.</param>
  31184. <exception cref="T:System.ArgumentNullException">
  31185. <paramref name="info"/> is <c>null</c>.
  31186. </exception>
  31187. </member>
  31188. <member name="T:MailKit.FolderNotOpenException">
  31189. <summary>
  31190. The exception that is thrown when a folder is not open.
  31191. </summary>
  31192. <remarks>
  31193. This exception is thrown when an operation on a folder could not be completed
  31194. due to the folder being in a closed state. For example, the
  31195. <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>
  31196. method will throw a <see cref="T:MailKit.FolderNotOpenException"/> if the folder is not
  31197. current open.
  31198. </remarks>
  31199. </member>
  31200. <member name="M:MailKit.FolderNotOpenException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  31201. <summary>
  31202. Initializes a new instance of the <see cref="T:MailKit.FolderNotOpenException"/> class.
  31203. </summary>
  31204. <remarks>
  31205. Deserializes a <see cref="T:MailKit.FolderNotOpenException"/>.
  31206. </remarks>
  31207. <param name="info">The serialization info.</param>
  31208. <param name="context">The streaming context.</param>
  31209. <exception cref="T:System.ArgumentNullException">
  31210. <paramref name="info"/> is <c>null</c>.
  31211. </exception>
  31212. </member>
  31213. <member name="M:MailKit.FolderNotOpenException.#ctor(System.String,MailKit.FolderAccess,System.String,System.Exception)">
  31214. <summary>
  31215. Initializes a new instance of the <see cref="T:MailKit.FolderNotOpenException"/> class.
  31216. </summary>
  31217. <remarks>
  31218. Creates a new <see cref="T:MailKit.FolderNotOpenException"/>.
  31219. </remarks>
  31220. <param name="folderName">The folder name.</param>
  31221. <param name="access">The minimum folder access required by the operation.</param>
  31222. <param name="message">The error message.</param>
  31223. <param name="innerException">The inner exception.</param>
  31224. <exception cref="T:System.ArgumentNullException">
  31225. <paramref name="folderName"/> is <c>null</c>.
  31226. </exception>
  31227. </member>
  31228. <member name="M:MailKit.FolderNotOpenException.#ctor(System.String,MailKit.FolderAccess,System.String)">
  31229. <summary>
  31230. Initializes a new instance of the <see cref="T:MailKit.FolderNotOpenException"/> class.
  31231. </summary>
  31232. <remarks>
  31233. Creates a new <see cref="T:MailKit.FolderNotOpenException"/>.
  31234. </remarks>
  31235. <param name="folderName">The folder name.</param>
  31236. <param name="access">The minimum folder access required by the operation.</param>
  31237. <param name="message">The error message.</param>
  31238. <exception cref="T:System.ArgumentNullException">
  31239. <paramref name="folderName"/> is <c>null</c>.
  31240. </exception>
  31241. </member>
  31242. <member name="M:MailKit.FolderNotOpenException.#ctor(System.String,MailKit.FolderAccess)">
  31243. <summary>
  31244. Initializes a new instance of the <see cref="T:MailKit.FolderNotOpenException"/> class.
  31245. </summary>
  31246. <remarks>
  31247. Creates a new <see cref="T:MailKit.FolderNotOpenException"/>.
  31248. </remarks>
  31249. <param name="folderName">The folder name.</param>
  31250. <param name="access">The minimum folder access required by the operation.</param>
  31251. <exception cref="T:System.ArgumentNullException">
  31252. <paramref name="folderName"/> is <c>null</c>.
  31253. </exception>
  31254. </member>
  31255. <member name="P:MailKit.FolderNotOpenException.FolderName">
  31256. <summary>
  31257. Get the name of the folder.
  31258. </summary>
  31259. <remarks>
  31260. Gets the name of the folder.
  31261. </remarks>
  31262. <value>The name of the folder.</value>
  31263. </member>
  31264. <member name="P:MailKit.FolderNotOpenException.FolderAccess">
  31265. <summary>
  31266. Get the minimum folder access required by the operation.
  31267. </summary>
  31268. <remarks>
  31269. Gets the minimum folder access required by the operation.
  31270. </remarks>
  31271. <value>The minimum required folder access.</value>
  31272. </member>
  31273. <member name="M:MailKit.FolderNotOpenException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  31274. <summary>
  31275. When overridden in a derived class, sets the <see cref="T:System.Runtime.Serialization.SerializationInfo"/>
  31276. with information about the exception.
  31277. </summary>
  31278. <remarks>
  31279. Serializes the state of the <see cref="T:MailKit.FolderNotOpenException"/>.
  31280. </remarks>
  31281. <param name="info">The serialization info.</param>
  31282. <param name="context">The streaming context.</param>
  31283. <exception cref="T:System.ArgumentNullException">
  31284. <paramref name="info"/> is <c>null</c>.
  31285. </exception>
  31286. </member>
  31287. <member name="T:MailKit.FolderQuota">
  31288. <summary>
  31289. A folder quota.
  31290. </summary>
  31291. <remarks>
  31292. A <see cref="T:MailKit.FolderQuota"/> is returned by <see cref="M:MailKit.IMailFolder.GetQuota(System.Threading.CancellationToken)"/>.
  31293. </remarks>
  31294. <example>
  31295. <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
  31296. </example>
  31297. </member>
  31298. <member name="M:MailKit.FolderQuota.#ctor(MailKit.IMailFolder)">
  31299. <summary>
  31300. Initializes a new instance of the <see cref="T:MailKit.FolderQuota"/> class.
  31301. </summary>
  31302. <remarks>
  31303. Creates a new <see cref="T:MailKit.FolderQuota"/> with the specified root.
  31304. </remarks>
  31305. <param name="quotaRoot">The quota root.</param>
  31306. </member>
  31307. <member name="P:MailKit.FolderQuota.QuotaRoot">
  31308. <summary>
  31309. Get the quota root.
  31310. </summary>
  31311. <remarks>
  31312. Gets the quota root. If the quota root is <c>null</c>, then
  31313. it suggests that the folder does not have a quota.
  31314. </remarks>
  31315. <example>
  31316. <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
  31317. </example>
  31318. <value>The quota root.</value>
  31319. </member>
  31320. <member name="P:MailKit.FolderQuota.MessageLimit">
  31321. <summary>
  31322. Get or set the message limit.
  31323. </summary>
  31324. <remarks>
  31325. Gets or sets the message limit.
  31326. </remarks>
  31327. <example>
  31328. <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
  31329. </example>
  31330. <value>The message limit.</value>
  31331. </member>
  31332. <member name="P:MailKit.FolderQuota.StorageLimit">
  31333. <summary>
  31334. Get or set the storage limit, in kilobytes.
  31335. </summary>
  31336. <remarks>
  31337. Gets or sets the storage limit, in kilobytes.
  31338. </remarks>
  31339. <example>
  31340. <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
  31341. </example>
  31342. <value>The storage limit, in kilobytes.</value>
  31343. </member>
  31344. <member name="P:MailKit.FolderQuota.CurrentMessageCount">
  31345. <summary>
  31346. Get or set the current message count.
  31347. </summary>
  31348. <remarks>
  31349. Gets or sets the current message count.
  31350. </remarks>
  31351. <example>
  31352. <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
  31353. </example>
  31354. <value>The current message count.</value>
  31355. </member>
  31356. <member name="P:MailKit.FolderQuota.CurrentStorageSize">
  31357. <summary>
  31358. Gets or sets the size of the current storage, in kilobytes.
  31359. </summary>
  31360. <remarks>
  31361. Gets or sets the size of the current storage, in kilobytes.
  31362. </remarks>
  31363. <example>
  31364. <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
  31365. </example>
  31366. <value>The size of the current storage, in kilobytes.</value>
  31367. </member>
  31368. <member name="T:MailKit.FolderRenamedEventArgs">
  31369. <summary>
  31370. Event args used when a <see cref="T:MailKit.IMailFolder"/> is renamed.
  31371. </summary>
  31372. <remarks>
  31373. Event args used when a <see cref="T:MailKit.IMailFolder"/> is renamed.
  31374. </remarks>
  31375. </member>
  31376. <member name="M:MailKit.FolderRenamedEventArgs.#ctor(System.String,System.String)">
  31377. <summary>
  31378. Initializes a new instance of the <see cref="T:MailKit.FolderRenamedEventArgs"/> class.
  31379. </summary>
  31380. <remarks>
  31381. Creates a new <see cref="T:MailKit.FolderRenamedEventArgs"/>.
  31382. </remarks>
  31383. <param name="oldName">The old name of the folder.</param>
  31384. <param name="newName">The new name of the folder.</param>
  31385. <exception cref="T:System.ArgumentNullException">
  31386. <para><paramref name="oldName"/> is <c>null</c>.</para>
  31387. <para>-or-</para>
  31388. <para><paramref name="newName"/> is <c>null</c>.</para>
  31389. </exception>
  31390. </member>
  31391. <member name="P:MailKit.FolderRenamedEventArgs.OldName">
  31392. <summary>
  31393. The old name of the folder.
  31394. </summary>
  31395. <remarks>
  31396. The old name of the folder.
  31397. </remarks>
  31398. <value>The old name.</value>
  31399. </member>
  31400. <member name="P:MailKit.FolderRenamedEventArgs.NewName">
  31401. <summary>
  31402. The new name of the folder.
  31403. </summary>
  31404. <remarks>
  31405. The new name of the folder.
  31406. </remarks>
  31407. <value>The new name.</value>
  31408. </member>
  31409. <member name="T:MailKit.IMailFolder">
  31410. <summary>
  31411. An interface for a mailbox folder as used by <see cref="T:MailKit.IMailStore"/>.
  31412. </summary>
  31413. <remarks>
  31414. Implemented by message stores such as <see cref="T:MailKit.Net.Imap.ImapClient"/>
  31415. </remarks>
  31416. </member>
  31417. <member name="P:MailKit.IMailFolder.SyncRoot">
  31418. <summary>
  31419. Gets an object that can be used to synchronize access to the folder.
  31420. </summary>
  31421. <remarks>
  31422. Gets an object that can be used to synchronize access to the folder.
  31423. </remarks>
  31424. <value>The sync root.</value>
  31425. </member>
  31426. <member name="P:MailKit.IMailFolder.ParentFolder">
  31427. <summary>
  31428. Get the parent folder.
  31429. </summary>
  31430. <remarks>
  31431. Root-level folders do not have a parent folder.
  31432. </remarks>
  31433. <value>The parent folder.</value>
  31434. </member>
  31435. <member name="P:MailKit.IMailFolder.Attributes">
  31436. <summary>
  31437. Get the folder attributes.
  31438. </summary>
  31439. <remarks>
  31440. Gets the folder attributes.
  31441. </remarks>
  31442. <value>The folder attributes.</value>
  31443. </member>
  31444. <member name="P:MailKit.IMailFolder.AnnotationAccess">
  31445. <summary>
  31446. Get the annotation access level.
  31447. </summary>
  31448. <remarks>
  31449. If annotations are supported, this property can be used to determine whether or not
  31450. the <see cref="T:MailKit.IMailFolder"/> supports reading and writing annotations.
  31451. </remarks>
  31452. </member>
  31453. <member name="P:MailKit.IMailFolder.AnnotationScopes">
  31454. <summary>
  31455. Get the supported annotation scopes.
  31456. </summary>
  31457. <remarks>
  31458. If annotations are supported, this property can be used to determine which
  31459. annotation scopes are supported by the <see cref="T:MailKit.IMailFolder"/>.
  31460. </remarks>
  31461. </member>
  31462. <member name="P:MailKit.IMailFolder.MaxAnnotationSize">
  31463. <summary>
  31464. Get the maximum size of annotation values supported by the folder.
  31465. </summary>
  31466. <remarks>
  31467. If annotations are supported, this property can be used to determine the
  31468. maximum size of annotation values supported by the <see cref="T:MailKit.IMailFolder"/>.
  31469. </remarks>
  31470. </member>
  31471. <member name="P:MailKit.IMailFolder.PermanentFlags">
  31472. <summary>
  31473. Get the permanent flags.
  31474. </summary>
  31475. <remarks>
  31476. <para>The permanent flags are the message flags that will persist between sessions.</para>
  31477. <para>If the <see cref="F:MailKit.MessageFlags.UserDefined"/> flag is set, then the folder allows
  31478. storing of user-defined (custom) message flags.</para>
  31479. </remarks>
  31480. <value>The permanent flags.</value>
  31481. </member>
  31482. <member name="P:MailKit.IMailFolder.AcceptedFlags">
  31483. <summary>
  31484. Get the accepted flags.
  31485. </summary>
  31486. <remarks>
  31487. The accepted flags are the message flags that will be accepted and persist
  31488. for the current session. For the set of flags that will persist between
  31489. sessions, see the <see cref="P:MailKit.IMailFolder.PermanentFlags"/> property.
  31490. </remarks>
  31491. <value>The accepted flags.</value>
  31492. </member>
  31493. <member name="P:MailKit.IMailFolder.DirectorySeparator">
  31494. <summary>
  31495. Get the directory separator.
  31496. </summary>
  31497. <remarks>
  31498. Gets the directory separator.
  31499. </remarks>
  31500. <value>The directory separator.</value>
  31501. </member>
  31502. <member name="P:MailKit.IMailFolder.Access">
  31503. <summary>
  31504. Get the read/write access of the folder.
  31505. </summary>
  31506. <remarks>
  31507. Gets the read/write access of the folder.
  31508. </remarks>
  31509. <value>The read/write access.</value>
  31510. </member>
  31511. <member name="P:MailKit.IMailFolder.IsNamespace">
  31512. <summary>
  31513. Get whether or not the folder is a namespace folder.
  31514. </summary>
  31515. <remarks>
  31516. Gets whether or not the folder is a namespace folder.
  31517. </remarks>
  31518. <value><c>true</c> if the folder is a namespace folder; otherwise, <c>false</c>.</value>
  31519. </member>
  31520. <member name="P:MailKit.IMailFolder.FullName">
  31521. <summary>
  31522. Get the full name of the folder.
  31523. </summary>
  31524. <remarks>
  31525. This is the equivalent of the full path of a file on a file system.
  31526. </remarks>
  31527. <value>The full name of the folder.</value>
  31528. </member>
  31529. <member name="P:MailKit.IMailFolder.Name">
  31530. <summary>
  31531. Get the name of the folder.
  31532. </summary>
  31533. <remarks>
  31534. This is the equivalent of the file name of a file on the file system.
  31535. </remarks>
  31536. <value>The name of the folder.</value>
  31537. </member>
  31538. <member name="P:MailKit.IMailFolder.Id">
  31539. <summary>
  31540. Get the unique identifier for the folder, if available.
  31541. </summary>
  31542. <remarks>
  31543. <para>Gets a unique identifier for the folder, if available. This is useful for clients
  31544. implementing a message cache that want to track the folder after it is renamed by another
  31545. client.</para>
  31546. <note type="note">This property will only be available if the server supports the
  31547. <a href="https://tools.ietf.org/html/rfc8474">OBJECTID</a> extension.</note>
  31548. </remarks>
  31549. <value>The unique folder identifier.</value>
  31550. </member>
  31551. <member name="P:MailKit.IMailFolder.IsSubscribed">
  31552. <summary>
  31553. Get whether or not the folder is subscribed.
  31554. </summary>
  31555. <remarks>
  31556. Gets whether or not the folder is subscribed.
  31557. </remarks>
  31558. <value><c>true</c> if the folder is subscribed; otherwise, <c>false</c>.</value>
  31559. </member>
  31560. <member name="P:MailKit.IMailFolder.IsOpen">
  31561. <summary>
  31562. Get whether or not the folder is currently open.
  31563. </summary>
  31564. <remarks>
  31565. Gets whether or not the folder is currently open.
  31566. </remarks>
  31567. <value><c>true</c> if the folder is currently open; otherwise, <c>false</c>.</value>
  31568. </member>
  31569. <member name="P:MailKit.IMailFolder.Exists">
  31570. <summary>
  31571. Get whether or not the folder exists.
  31572. </summary>
  31573. <remarks>
  31574. Gets whether or not the folder exists.
  31575. </remarks>
  31576. <value><c>true</c> if the folder exists; otherwise, <c>false</c>.</value>
  31577. </member>
  31578. <member name="P:MailKit.IMailFolder.SupportsModSeq">
  31579. <summary>
  31580. Get whether or not the folder supports mod-sequences.
  31581. </summary>
  31582. <remarks>
  31583. If mod-sequences are not supported by the folder, then all of the APIs that take a modseq
  31584. argument will throw <see cref="T:System.NotSupportedException"/> and should not be used.
  31585. </remarks>
  31586. <value><c>true</c> if supports mod-sequences; otherwise, <c>false</c>.</value>
  31587. </member>
  31588. <member name="P:MailKit.IMailFolder.HighestModSeq">
  31589. <summary>
  31590. Get the highest mod-sequence value of all messages in the mailbox.
  31591. </summary>
  31592. <remarks>
  31593. Gets the highest mod-sequence value of all messages in the mailbox.
  31594. </remarks>
  31595. <value>The highest mod-sequence value.</value>
  31596. </member>
  31597. <member name="P:MailKit.IMailFolder.UidValidity">
  31598. <summary>
  31599. Get the Unique ID validity.
  31600. </summary>
  31601. <remarks>
  31602. <para>UIDs are only valid so long as the UID validity value remains unchanged. If and when
  31603. the folder's <see cref="P:MailKit.IMailFolder.UidValidity"/> is changed, a client MUST discard its cache of UIDs
  31604. along with any summary information that it may have and re-query the folder.</para>
  31605. <para>The <see cref="P:MailKit.IMailFolder.UidValidity"/> will only be set after the folder has been opened.</para>
  31606. </remarks>
  31607. <value>The UID validity.</value>
  31608. </member>
  31609. <member name="P:MailKit.IMailFolder.UidNext">
  31610. <summary>
  31611. Get the UID that the next message that is added to the folder will be assigned.
  31612. </summary>
  31613. <remarks>
  31614. This value will only be set after the folder has been opened.
  31615. </remarks>
  31616. <value>The next UID.</value>
  31617. </member>
  31618. <member name="P:MailKit.IMailFolder.AppendLimit">
  31619. <summary>
  31620. Get the maximum size of a message that can be appended to the folder.
  31621. </summary>
  31622. <remarks>
  31623. <para>Gets the maximum size of a message that can be appended to the folder.</para>
  31624. <note type="note">If the value is not set, then the limit is unspecified.</note>
  31625. </remarks>
  31626. <value>The append limit.</value>
  31627. </member>
  31628. <member name="P:MailKit.IMailFolder.Size">
  31629. <summary>
  31630. Get the size of the folder.
  31631. </summary>
  31632. <remarks>
  31633. <para>Gets the size of the folder in bytes.</para>
  31634. <note type="note">If the value is not set, then the size is unspecified.</note>
  31635. </remarks>
  31636. <value>The size.</value>
  31637. </member>
  31638. <member name="P:MailKit.IMailFolder.FirstUnread">
  31639. <summary>
  31640. Get the index of the first unread message in the folder.
  31641. </summary>
  31642. <remarks>
  31643. This value will only be set after the folder has been opened.
  31644. </remarks>
  31645. <value>The index of the first unread message.</value>
  31646. </member>
  31647. <member name="P:MailKit.IMailFolder.Unread">
  31648. <summary>
  31649. Get the number of unread messages in the folder.
  31650. </summary>
  31651. <remarks>
  31652. <para>Gets the number of unread messages in the folder.</para>
  31653. <note type="note">This value will only be set after calling
  31654. <see cref="M:MailKit.IMailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/>
  31655. with <see cref="F:MailKit.StatusItems.Unread"/>.</note>
  31656. </remarks>
  31657. <value>The number of unread messages.</value>
  31658. </member>
  31659. <member name="P:MailKit.IMailFolder.Recent">
  31660. <summary>
  31661. Get the number of recently delivered messages in the folder.
  31662. </summary>
  31663. <remarks>
  31664. <para>Gets the number of recently delivered messages in the folder.</para>
  31665. <note type="note">
  31666. This value will only be set after calling
  31667. <see cref="M:MailKit.IMailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/>
  31668. with <see cref="F:MailKit.StatusItems.Recent"/>.</note>
  31669. </remarks>
  31670. <value>The number of recently delivered messages.</value>
  31671. </member>
  31672. <member name="P:MailKit.IMailFolder.Count">
  31673. <summary>
  31674. Get the total number of messages in the folder.
  31675. </summary>
  31676. <remarks>
  31677. Gets the total number of messages in the folder.
  31678. </remarks>
  31679. <value>The total number of messages.</value>
  31680. </member>
  31681. <member name="M:MailKit.IMailFolder.Open(MailKit.FolderAccess,System.UInt32,System.UInt64,System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)">
  31682. <summary>
  31683. Opens the folder using the requested folder access.
  31684. </summary>
  31685. <remarks>
  31686. <para>This variant of the <see cref="M:MailKit.IMailFolder.Open(MailKit.FolderAccess,System.Threading.CancellationToken)"/>
  31687. method is meant for quick resynchronization of the folder. Before calling this method,
  31688. the <see cref="M:MailKit.IMailStore.EnableQuickResync(System.Threading.CancellationToken)"/> method MUST be called.</para>
  31689. <para>You should also make sure to add listeners to the <see cref="E:MailKit.IMailFolder.MessagesVanished"/> and
  31690. <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events to get notifications of changes since
  31691. the last time the folder was opened.</para>
  31692. </remarks>
  31693. <returns>The <see cref="T:MailKit.FolderAccess"/> state of the folder.</returns>
  31694. <param name="access">The requested folder access.</param>
  31695. <param name="uidValidity">The last known <see cref="P:MailKit.IMailFolder.UidValidity"/> value.</param>
  31696. <param name="highestModSeq">The last known <see cref="P:MailKit.IMailFolder.HighestModSeq"/> value.</param>
  31697. <param name="uids">The last known list of unique message identifiers.</param>
  31698. <param name="cancellationToken">The cancellation token.</param>
  31699. </member>
  31700. <member name="M:MailKit.IMailFolder.OpenAsync(MailKit.FolderAccess,System.UInt32,System.UInt64,System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)">
  31701. <summary>
  31702. Asynchronously opens the folder using the requested folder access.
  31703. </summary>
  31704. <remarks>
  31705. <para>This variant of the <see cref="M:MailKit.IMailFolder.OpenAsync(MailKit.FolderAccess,System.Threading.CancellationToken)"/>
  31706. method is meant for quick resynchronization of the folder. Before calling this method,
  31707. the <see cref="M:MailKit.IMailStore.EnableQuickResync(System.Threading.CancellationToken)"/> method MUST be called.</para>
  31708. <para>You should also make sure to add listeners to the <see cref="E:MailKit.IMailFolder.MessagesVanished"/> and
  31709. <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events to get notifications of changes since
  31710. the last time the folder was opened.</para>
  31711. </remarks>
  31712. <returns>The <see cref="T:MailKit.FolderAccess"/> state of the folder.</returns>
  31713. <param name="access">The requested folder access.</param>
  31714. <param name="uidValidity">The last known <see cref="P:MailKit.IMailFolder.UidValidity"/> value.</param>
  31715. <param name="highestModSeq">The last known <see cref="P:MailKit.IMailFolder.HighestModSeq"/> value.</param>
  31716. <param name="uids">The last known list of unique message identifiers.</param>
  31717. <param name="cancellationToken">The cancellation token.</param>
  31718. </member>
  31719. <member name="M:MailKit.IMailFolder.Open(MailKit.FolderAccess,System.Threading.CancellationToken)">
  31720. <summary>
  31721. Open the folder using the requested folder access.
  31722. </summary>
  31723. <remarks>
  31724. Opens the folder using the requested folder access.
  31725. </remarks>
  31726. <returns>The <see cref="T:MailKit.FolderAccess"/> state of the folder.</returns>
  31727. <param name="access">The requested folder access.</param>
  31728. <param name="cancellationToken">The cancellation token.</param>
  31729. </member>
  31730. <member name="M:MailKit.IMailFolder.OpenAsync(MailKit.FolderAccess,System.Threading.CancellationToken)">
  31731. <summary>
  31732. Asynchronously open the folder using the requested folder access.
  31733. </summary>
  31734. <remarks>
  31735. Asynchronously opens the folder using the requested folder access.
  31736. </remarks>
  31737. <returns>The <see cref="T:MailKit.FolderAccess"/> state of the folder.</returns>
  31738. <param name="access">The requested folder access.</param>
  31739. <param name="cancellationToken">The cancellation token.</param>
  31740. </member>
  31741. <member name="M:MailKit.IMailFolder.Close(System.Boolean,System.Threading.CancellationToken)">
  31742. <summary>
  31743. Close the folder, optionally expunging the messages marked for deletion.
  31744. </summary>
  31745. <remarks>
  31746. Closes the folder, optionally expunging the messages marked for deletion.
  31747. </remarks>
  31748. <param name="expunge">If set to <c>true</c>, expunge.</param>
  31749. <param name="cancellationToken">The cancellation token.</param>
  31750. </member>
  31751. <member name="M:MailKit.IMailFolder.CloseAsync(System.Boolean,System.Threading.CancellationToken)">
  31752. <summary>
  31753. Asynchronously close the folder, optionally expunging the messages marked for deletion.
  31754. </summary>
  31755. <remarks>
  31756. Asynchronously closes the folder, optionally expunging the messages marked for deletion.
  31757. </remarks>
  31758. <returns>An asynchronous task context.</returns>
  31759. <param name="expunge">If set to <c>true</c>, expunge.</param>
  31760. <param name="cancellationToken">The cancellation token.</param>
  31761. </member>
  31762. <member name="M:MailKit.IMailFolder.Create(System.String,System.Boolean,System.Threading.CancellationToken)">
  31763. <summary>
  31764. Create a new subfolder with the given name.
  31765. </summary>
  31766. <remarks>
  31767. Creates a new subfolder with the given name.
  31768. </remarks>
  31769. <returns>The created folder.</returns>
  31770. <param name="name">The name of the folder to create.</param>
  31771. <param name="isMessageFolder"><c>true</c> if the folder will be used to contain messages; otherwise <c>false</c>.</param>
  31772. <param name="cancellationToken">The cancellation token.</param>
  31773. </member>
  31774. <member name="M:MailKit.IMailFolder.CreateAsync(System.String,System.Boolean,System.Threading.CancellationToken)">
  31775. <summary>
  31776. Asynchronously create a new subfolder with the given name.
  31777. </summary>
  31778. <remarks>
  31779. Asynchronously creates a new subfolder with the given name.
  31780. </remarks>
  31781. <returns>The created folder.</returns>
  31782. <param name="name">The name of the folder to create.</param>
  31783. <param name="isMessageFolder"><c>true</c> if the folder will be used to contain messages; otherwise <c>false</c>.</param>
  31784. <param name="cancellationToken">The cancellation token.</param>
  31785. </member>
  31786. <member name="M:MailKit.IMailFolder.Create(System.String,System.Collections.Generic.IEnumerable{MailKit.SpecialFolder},System.Threading.CancellationToken)">
  31787. <summary>
  31788. Create a new subfolder with the given name.
  31789. </summary>
  31790. <remarks>
  31791. Creates a new subfolder with the given name.
  31792. </remarks>
  31793. <returns>The created folder.</returns>
  31794. <param name="name">The name of the folder to create.</param>
  31795. <param name="specialUses">A list of special uses for the folder being created.</param>
  31796. <param name="cancellationToken">The cancellation token.</param>
  31797. </member>
  31798. <member name="M:MailKit.IMailFolder.CreateAsync(System.String,System.Collections.Generic.IEnumerable{MailKit.SpecialFolder},System.Threading.CancellationToken)">
  31799. <summary>
  31800. Asynchronously create a new subfolder with the given name.
  31801. </summary>
  31802. <remarks>
  31803. Asynchronously creates a new subfolder with the given name.
  31804. </remarks>
  31805. <returns>The created folder.</returns>
  31806. <param name="name">The name of the folder to create.</param>
  31807. <param name="specialUses">A list of special uses for the folder being created.</param>
  31808. <param name="cancellationToken">The cancellation token.</param>
  31809. </member>
  31810. <member name="M:MailKit.IMailFolder.Create(System.String,MailKit.SpecialFolder,System.Threading.CancellationToken)">
  31811. <summary>
  31812. Create a new subfolder with the given name.
  31813. </summary>
  31814. <remarks>
  31815. Creates a new subfolder with the given name.
  31816. </remarks>
  31817. <returns>The created folder.</returns>
  31818. <param name="name">The name of the folder to create.</param>
  31819. <param name="specialUse">The special use for the folder being created.</param>
  31820. <param name="cancellationToken">The cancellation token.</param>
  31821. </member>
  31822. <member name="M:MailKit.IMailFolder.CreateAsync(System.String,MailKit.SpecialFolder,System.Threading.CancellationToken)">
  31823. <summary>
  31824. Asynchronously create a new subfolder with the given name.
  31825. </summary>
  31826. <remarks>
  31827. Asynchronously creates a new subfolder with the given name.
  31828. </remarks>
  31829. <returns>The created folder.</returns>
  31830. <param name="name">The name of the folder to create.</param>
  31831. <param name="specialUse">The special use for the folder being created.</param>
  31832. <param name="cancellationToken">The cancellation token.</param>
  31833. </member>
  31834. <member name="M:MailKit.IMailFolder.Rename(MailKit.IMailFolder,System.String,System.Threading.CancellationToken)">
  31835. <summary>
  31836. Rename the folder.
  31837. </summary>
  31838. <remarks>
  31839. Renames the folder.
  31840. </remarks>
  31841. <param name="parent">The new parent folder.</param>
  31842. <param name="name">The new name of the folder.</param>
  31843. <param name="cancellationToken">The cancellation token.</param>
  31844. </member>
  31845. <member name="M:MailKit.IMailFolder.RenameAsync(MailKit.IMailFolder,System.String,System.Threading.CancellationToken)">
  31846. <summary>
  31847. Asynchronously rename the folder.
  31848. </summary>
  31849. <remarks>
  31850. Asynchronously renames the folder.
  31851. </remarks>
  31852. <returns>An asynchronous task context.</returns>
  31853. <param name="parent">The new parent folder.</param>
  31854. <param name="name">The new name of the folder.</param>
  31855. <param name="cancellationToken">The cancellation token.</param>
  31856. </member>
  31857. <member name="M:MailKit.IMailFolder.Delete(System.Threading.CancellationToken)">
  31858. <summary>
  31859. Delete the folder.
  31860. </summary>
  31861. <remarks>
  31862. Deletes the folder.
  31863. </remarks>
  31864. <param name="cancellationToken">The cancellation token.</param>
  31865. </member>
  31866. <member name="M:MailKit.IMailFolder.DeleteAsync(System.Threading.CancellationToken)">
  31867. <summary>
  31868. Asynchronously delete the folder.
  31869. </summary>
  31870. <remarks>
  31871. Asynchronously deletes the folder.
  31872. </remarks>
  31873. <returns>An asynchronous task context.</returns>
  31874. <param name="cancellationToken">The cancellation token.</param>
  31875. </member>
  31876. <member name="M:MailKit.IMailFolder.Subscribe(System.Threading.CancellationToken)">
  31877. <summary>
  31878. Subscribe to the folder.
  31879. </summary>
  31880. <remarks>
  31881. Subscribes to the folder.
  31882. </remarks>
  31883. <param name="cancellationToken">The cancellation token.</param>
  31884. </member>
  31885. <member name="M:MailKit.IMailFolder.SubscribeAsync(System.Threading.CancellationToken)">
  31886. <summary>
  31887. Asynchronously subscribe to the folder.
  31888. </summary>
  31889. <remarks>
  31890. Asynchronously subscribes to the folder.
  31891. </remarks>
  31892. <returns>An asynchronous task context.</returns>
  31893. <param name="cancellationToken">The cancellation token.</param>
  31894. </member>
  31895. <member name="M:MailKit.IMailFolder.Unsubscribe(System.Threading.CancellationToken)">
  31896. <summary>
  31897. Unsubscribe from the folder.
  31898. </summary>
  31899. <remarks>
  31900. Unsubscribes from the folder.
  31901. </remarks>
  31902. <param name="cancellationToken">The cancellation token.</param>
  31903. </member>
  31904. <member name="M:MailKit.IMailFolder.UnsubscribeAsync(System.Threading.CancellationToken)">
  31905. <summary>
  31906. Asynchronously unsubscribe from the folder.
  31907. </summary>
  31908. <remarks>
  31909. Asynchronously unsubscribes from the folder.
  31910. </remarks>
  31911. <returns>An asynchronous task context.</returns>
  31912. <param name="cancellationToken">The cancellation token.</param>
  31913. </member>
  31914. <member name="M:MailKit.IMailFolder.GetSubfolders(MailKit.StatusItems,System.Boolean,System.Threading.CancellationToken)">
  31915. <summary>
  31916. Get the subfolders.
  31917. </summary>
  31918. <remarks>
  31919. <para>Gets the subfolders as well as queries the server for the status of the requested items.</para>
  31920. <para>When the <paramref name="items"/> argument is non-empty, this has the equivalent functionality
  31921. of calling <see cref="M:MailKit.IMailFolder.GetSubfolders(System.Boolean,System.Threading.CancellationToken)"/> and then calling
  31922. <see cref="M:MailKit.IMailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/> on each of the returned folders.</para>
  31923. <note type="tip">Using this method is potentially more efficient than querying the status of each returned folder.</note>
  31924. </remarks>
  31925. <returns>The subfolders.</returns>
  31926. <param name="items">The status items to pre-populate.</param>
  31927. <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
  31928. <param name="cancellationToken">The cancellation token.</param>
  31929. </member>
  31930. <member name="M:MailKit.IMailFolder.GetSubfoldersAsync(MailKit.StatusItems,System.Boolean,System.Threading.CancellationToken)">
  31931. <summary>
  31932. Asynchronously get the subfolders.
  31933. </summary>
  31934. <remarks>
  31935. <para>Asynchronously gets the subfolders as well as queries the server for the status of the requested items.</para>
  31936. <para>When the <paramref name="items"/> argument is non-empty, this has the equivalent functionality
  31937. of calling <see cref="M:MailKit.IMailFolder.GetSubfoldersAsync(System.Boolean,System.Threading.CancellationToken)"/> and then calling
  31938. <see cref="M:MailKit.IMailFolder.StatusAsync(MailKit.StatusItems,System.Threading.CancellationToken)"/> on each of the returned folders.</para>
  31939. </remarks>
  31940. <returns>The subfolders.</returns>
  31941. <param name="items">The status items to pre-populate.</param>
  31942. <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
  31943. <param name="cancellationToken">The cancellation token.</param>
  31944. </member>
  31945. <member name="M:MailKit.IMailFolder.GetSubfolders(System.Boolean,System.Threading.CancellationToken)">
  31946. <summary>
  31947. Get the subfolders.
  31948. </summary>
  31949. <remarks>
  31950. Gets the subfolders.
  31951. </remarks>
  31952. <returns>The subfolders.</returns>
  31953. <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
  31954. <param name="cancellationToken">The cancellation token.</param>
  31955. </member>
  31956. <member name="M:MailKit.IMailFolder.GetSubfoldersAsync(System.Boolean,System.Threading.CancellationToken)">
  31957. <summary>
  31958. Asynchronously get the subfolders.
  31959. </summary>
  31960. <remarks>
  31961. Asynchronously gets the subfolders.
  31962. </remarks>
  31963. <returns>The subfolders.</returns>
  31964. <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
  31965. <param name="cancellationToken">The cancellation token.</param>
  31966. </member>
  31967. <member name="M:MailKit.IMailFolder.GetSubfolder(System.String,System.Threading.CancellationToken)">
  31968. <summary>
  31969. Get the specified subfolder.
  31970. </summary>
  31971. <remarks>
  31972. Gets the specified subfolder.
  31973. </remarks>
  31974. <returns>The subfolder.</returns>
  31975. <param name="name">The name of the subfolder.</param>
  31976. <param name="cancellationToken">The cancellation token.</param>
  31977. </member>
  31978. <member name="M:MailKit.IMailFolder.GetSubfolderAsync(System.String,System.Threading.CancellationToken)">
  31979. <summary>
  31980. Asynchronously get the specified subfolder.
  31981. </summary>
  31982. <remarks>
  31983. Asynchronously gets the specified subfolder.
  31984. </remarks>
  31985. <returns>The subfolder.</returns>
  31986. <param name="name">The name of the subfolder.</param>
  31987. <param name="cancellationToken">The cancellation token.</param>
  31988. </member>
  31989. <member name="M:MailKit.IMailFolder.Check(System.Threading.CancellationToken)">
  31990. <summary>
  31991. Force the server to flush its state for the folder.
  31992. </summary>
  31993. <remarks>
  31994. Forces the server to flush its state for the folder.
  31995. </remarks>
  31996. <param name="cancellationToken">The cancellation token.</param>
  31997. </member>
  31998. <member name="M:MailKit.IMailFolder.CheckAsync(System.Threading.CancellationToken)">
  31999. <summary>
  32000. Asynchronously force the server to flush its state for the folder.
  32001. </summary>
  32002. <remarks>
  32003. Asynchronously forces the server to flush its state for the folder.
  32004. </remarks>
  32005. <returns>An asynchronous task context.</returns>
  32006. <param name="cancellationToken">The cancellation token.</param>
  32007. </member>
  32008. <member name="M:MailKit.IMailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)">
  32009. <summary>
  32010. Update the values of the specified items.
  32011. </summary>
  32012. <remarks>
  32013. <para>Updates the values of the specified items.</para>
  32014. <para>The <see cref="M:MailKit.IMailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/> method
  32015. MUST NOT be used on a folder that is already in the opened state. Instead, other ways
  32016. of getting the desired information should be used.</para>
  32017. <para>For example, a common use for the <see cref="M:MailKit.IMailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/>
  32018. method is to get the number of unread messages in the folder. When the folder is open, however, it is
  32019. possible to use the <see cref="M:MailKit.IMailFolder.Search(MailKit.Search.SearchQuery,System.Threading.CancellationToken)"/>
  32020. method to query for the list of unread messages.</para>
  32021. </remarks>
  32022. <param name="items">The items to update.</param>
  32023. <param name="cancellationToken">The cancellation token.</param>
  32024. </member>
  32025. <member name="M:MailKit.IMailFolder.StatusAsync(MailKit.StatusItems,System.Threading.CancellationToken)">
  32026. <summary>
  32027. Asynchronously update the values of the specified items.
  32028. </summary>
  32029. <remarks>
  32030. <para>Updates the values of the specified items.</para>
  32031. <para>The <see cref="M:MailKit.IMailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/> method
  32032. MUST NOT be used on a folder that is already in the opened state. Instead, other ways
  32033. of getting the desired information should be used.</para>
  32034. <para>For example, a common use for the <see cref="M:MailKit.IMailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/>
  32035. method is to get the number of unread messages in the folder. When the folder is open, however, it is
  32036. possible to use the <see cref="M:MailKit.IMailFolder.Search(MailKit.Search.SearchQuery,System.Threading.CancellationToken)"/>
  32037. method to query for the list of unread messages.</para>
  32038. </remarks>
  32039. <returns>An asynchronous task context.</returns>
  32040. <param name="items">The items to update.</param>
  32041. <param name="cancellationToken">The cancellation token.</param>
  32042. </member>
  32043. <member name="M:MailKit.IMailFolder.GetAccessControlList(System.Threading.CancellationToken)">
  32044. <summary>
  32045. Get the complete access control list for the folder.
  32046. </summary>
  32047. <remarks>
  32048. Gets the complete access control list for the folder.
  32049. </remarks>
  32050. <returns>The access control list.</returns>
  32051. <param name="cancellationToken">The cancellation token.</param>
  32052. </member>
  32053. <member name="M:MailKit.IMailFolder.GetAccessControlListAsync(System.Threading.CancellationToken)">
  32054. <summary>
  32055. Asynchronously get the complete access control list for the folder.
  32056. </summary>
  32057. <remarks>
  32058. Asynchronously gets the complete access control list for the folder.
  32059. </remarks>
  32060. <returns>The access control list.</returns>
  32061. <param name="cancellationToken">The cancellation token.</param>
  32062. </member>
  32063. <member name="M:MailKit.IMailFolder.GetAccessRights(System.String,System.Threading.CancellationToken)">
  32064. <summary>
  32065. Get the access rights for a particular identifier.
  32066. </summary>
  32067. <remarks>
  32068. Gets the access rights for a particular identifier.
  32069. </remarks>
  32070. <returns>The access rights.</returns>
  32071. <param name="name">The identifier name.</param>
  32072. <param name="cancellationToken">The cancellation token.</param>
  32073. </member>
  32074. <member name="M:MailKit.IMailFolder.GetAccessRightsAsync(System.String,System.Threading.CancellationToken)">
  32075. <summary>
  32076. Asynchronously get the access rights for a particular identifier.
  32077. </summary>
  32078. <remarks>
  32079. Asynchronously gets the access rights for a particular identifier.
  32080. </remarks>
  32081. <returns>The access rights.</returns>
  32082. <param name="name">The identifier name.</param>
  32083. <param name="cancellationToken">The cancellation token.</param>
  32084. </member>
  32085. <member name="M:MailKit.IMailFolder.GetMyAccessRights(System.Threading.CancellationToken)">
  32086. <summary>
  32087. Get the access rights for the current authenticated user.
  32088. </summary>
  32089. <remarks>
  32090. Gets the access rights for the current authenticated user.
  32091. </remarks>
  32092. <returns>The access rights.</returns>
  32093. <param name="cancellationToken">The cancellation token.</param>
  32094. </member>
  32095. <member name="M:MailKit.IMailFolder.GetMyAccessRightsAsync(System.Threading.CancellationToken)">
  32096. <summary>
  32097. Asynchronously get the access rights for the current authenticated user.
  32098. </summary>
  32099. <remarks>
  32100. Asynchronously gets the access rights for the current authenticated user.
  32101. </remarks>
  32102. <returns>The access rights.</returns>
  32103. <param name="cancellationToken">The cancellation token.</param>
  32104. </member>
  32105. <member name="M:MailKit.IMailFolder.AddAccessRights(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
  32106. <summary>
  32107. Add access rights for the specified identity.
  32108. </summary>
  32109. <remarks>
  32110. Adds the given access rights for the specified identity.
  32111. </remarks>
  32112. <param name="name">The identity name.</param>
  32113. <param name="rights">The access rights.</param>
  32114. <param name="cancellationToken">The cancellation token.</param>
  32115. </member>
  32116. <member name="M:MailKit.IMailFolder.AddAccessRightsAsync(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
  32117. <summary>
  32118. Asynchronously add access rights for the specified identity.
  32119. </summary>
  32120. <remarks>
  32121. Asynchronously adds the given access rights for the specified identity.
  32122. </remarks>
  32123. <returns>An asynchronous task context.</returns>
  32124. <param name="name">The identity name.</param>
  32125. <param name="rights">The access rights.</param>
  32126. <param name="cancellationToken">The cancellation token.</param>
  32127. </member>
  32128. <member name="M:MailKit.IMailFolder.RemoveAccessRights(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
  32129. <summary>
  32130. Remove access rights for the specified identity.
  32131. </summary>
  32132. <remarks>
  32133. Removes the given access rights for the specified identity.
  32134. </remarks>
  32135. <param name="name">The identity name.</param>
  32136. <param name="rights">The access rights.</param>
  32137. <param name="cancellationToken">The cancellation token.</param>
  32138. </member>
  32139. <member name="M:MailKit.IMailFolder.RemoveAccessRightsAsync(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
  32140. <summary>
  32141. Asynchronously remove access rights for the specified identity.
  32142. </summary>
  32143. <remarks>
  32144. Asynchronously removes the given access rights for the specified identity.
  32145. </remarks>
  32146. <returns>An asynchronous task context.</returns>
  32147. <param name="name">The identity name.</param>
  32148. <param name="rights">The access rights.</param>
  32149. <param name="cancellationToken">The cancellation token.</param>
  32150. </member>
  32151. <member name="M:MailKit.IMailFolder.SetAccessRights(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
  32152. <summary>
  32153. Set the access rights for the specified identity.
  32154. </summary>
  32155. <remarks>
  32156. Sets the access rights for the specified identity.
  32157. </remarks>
  32158. <param name="name">The identity name.</param>
  32159. <param name="rights">The access rights.</param>
  32160. <param name="cancellationToken">The cancellation token.</param>
  32161. </member>
  32162. <member name="M:MailKit.IMailFolder.SetAccessRightsAsync(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
  32163. <summary>
  32164. Asynchronously set the access rights for the sepcified identity.
  32165. </summary>
  32166. <remarks>
  32167. Asynchronously sets the access rights for the specified identity.
  32168. </remarks>
  32169. <returns>An asynchronous task context.</returns>
  32170. <param name="name">The identity name.</param>
  32171. <param name="rights">The access rights.</param>
  32172. <param name="cancellationToken">The cancellation token.</param>
  32173. </member>
  32174. <member name="M:MailKit.IMailFolder.RemoveAccess(System.String,System.Threading.CancellationToken)">
  32175. <summary>
  32176. Remove all access rights for the given identity.
  32177. </summary>
  32178. <remarks>
  32179. Removes all access rights for the given identity.
  32180. </remarks>
  32181. <param name="name">The identity name.</param>
  32182. <param name="cancellationToken">The cancellation token.</param>
  32183. </member>
  32184. <member name="M:MailKit.IMailFolder.RemoveAccessAsync(System.String,System.Threading.CancellationToken)">
  32185. <summary>
  32186. Asynchronously remove all access rights for the given identity.
  32187. </summary>
  32188. <remarks>
  32189. Asynchronously removes all access rights for the given identity.
  32190. </remarks>
  32191. <returns>An asynchronous task context.</returns>
  32192. <param name="name">The identity name.</param>
  32193. <param name="cancellationToken">The cancellation token.</param>
  32194. </member>
  32195. <member name="M:MailKit.IMailFolder.GetQuota(System.Threading.CancellationToken)">
  32196. <summary>
  32197. Get the quota information for the folder.
  32198. </summary>
  32199. <remarks>
  32200. <para>Gets the quota information for the folder.</para>
  32201. <para>To determine if a quotas are supported, check the
  32202. <see cref="P:MailKit.IMailStore.SupportsQuotas"/> property.</para>
  32203. </remarks>
  32204. <returns>The folder quota.</returns>
  32205. <param name="cancellationToken">The cancellation token.</param>
  32206. </member>
  32207. <member name="M:MailKit.IMailFolder.GetQuotaAsync(System.Threading.CancellationToken)">
  32208. <summary>
  32209. Asynchronously get the quota information for the folder.
  32210. </summary>
  32211. <remarks>
  32212. <para>Asynchronously gets the quota information for the folder.</para>
  32213. <para>To determine if a quotas are supported, check the
  32214. <see cref="P:MailKit.IMailStore.SupportsQuotas"/> property.</para>
  32215. </remarks>
  32216. <returns>The folder quota.</returns>
  32217. <param name="cancellationToken">The cancellation token.</param>
  32218. </member>
  32219. <member name="M:MailKit.IMailFolder.SetQuota(System.Nullable{System.UInt32},System.Nullable{System.UInt32},System.Threading.CancellationToken)">
  32220. <summary>
  32221. Set the quota limits for the folder.
  32222. </summary>
  32223. <remarks>
  32224. <para>Sets the quota limits for the folder.</para>
  32225. <para>To determine if a quotas are supported, check the
  32226. <see cref="P:MailKit.IMailStore.SupportsQuotas"/> property.</para>
  32227. </remarks>
  32228. <returns>The updated folder quota.</returns>
  32229. <param name="messageLimit">If not <c>null</c>, sets the maximum number of messages to allow.</param>
  32230. <param name="storageLimit">If not <c>null</c>, sets the maximum storage size (in kilobytes).</param>
  32231. <param name="cancellationToken">The cancellation token.</param>
  32232. </member>
  32233. <member name="M:MailKit.IMailFolder.SetQuotaAsync(System.Nullable{System.UInt32},System.Nullable{System.UInt32},System.Threading.CancellationToken)">
  32234. <summary>
  32235. Asynchronously set the quota limits for the folder.
  32236. </summary>
  32237. <remarks>
  32238. <para>Asynchronously sets the quota limits for the folder.</para>
  32239. <para>To determine if a quotas are supported, check the
  32240. <see cref="P:MailKit.IMailStore.SupportsQuotas"/> property.</para>
  32241. </remarks>
  32242. <returns>The updated folder quota.</returns>
  32243. <param name="messageLimit">If not <c>null</c>, sets the maximum number of messages to allow.</param>
  32244. <param name="storageLimit">If not <c>null</c>, sets the maximum storage size (in kilobytes).</param>
  32245. <param name="cancellationToken">The cancellation token.</param>
  32246. </member>
  32247. <member name="M:MailKit.IMailFolder.GetMetadata(MailKit.MetadataTag,System.Threading.CancellationToken)">
  32248. <summary>
  32249. Gets the specified metadata.
  32250. </summary>
  32251. <remarks>
  32252. Gets the specified metadata.
  32253. </remarks>
  32254. <returns>The requested metadata value.</returns>
  32255. <param name="tag">The metadata tag.</param>
  32256. <param name="cancellationToken">The cancellation token.</param>
  32257. </member>
  32258. <member name="M:MailKit.IMailFolder.GetMetadataAsync(MailKit.MetadataTag,System.Threading.CancellationToken)">
  32259. <summary>
  32260. Asynchronously gets the specified metadata.
  32261. </summary>
  32262. <remarks>
  32263. Asynchronously gets the specified metadata.
  32264. </remarks>
  32265. <returns>The requested metadata value.</returns>
  32266. <param name="tag">The metadata tag.</param>
  32267. <param name="cancellationToken">The cancellation token.</param>
  32268. </member>
  32269. <member name="M:MailKit.IMailFolder.GetMetadata(System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
  32270. <summary>
  32271. Gets the specified metadata.
  32272. </summary>
  32273. <remarks>
  32274. Gets the specified metadata.
  32275. </remarks>
  32276. <returns>The requested metadata.</returns>
  32277. <param name="tags">The metadata tags.</param>
  32278. <param name="cancellationToken">The cancellation token.</param>
  32279. </member>
  32280. <member name="M:MailKit.IMailFolder.GetMetadataAsync(System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
  32281. <summary>
  32282. Asynchronously gets the specified metadata.
  32283. </summary>
  32284. <remarks>
  32285. Asynchronously gets the specified metadata.
  32286. </remarks>
  32287. <returns>The requested metadata.</returns>
  32288. <param name="tags">The metadata tags.</param>
  32289. <param name="cancellationToken">The cancellation token.</param>
  32290. </member>
  32291. <member name="M:MailKit.IMailFolder.GetMetadata(MailKit.MetadataOptions,System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
  32292. <summary>
  32293. Gets the specified metadata.
  32294. </summary>
  32295. <remarks>
  32296. Gets the specified metadata.
  32297. </remarks>
  32298. <returns>The requested metadata.</returns>
  32299. <param name="options">The metadata options.</param>
  32300. <param name="tags">The metadata tags.</param>
  32301. <param name="cancellationToken">The cancellation token.</param>
  32302. </member>
  32303. <member name="M:MailKit.IMailFolder.GetMetadataAsync(MailKit.MetadataOptions,System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
  32304. <summary>
  32305. Asynchronously gets the specified metadata.
  32306. </summary>
  32307. <remarks>
  32308. Asynchronously gets the specified metadata.
  32309. </remarks>
  32310. <returns>The requested metadata.</returns>
  32311. <param name="options">The metadata options.</param>
  32312. <param name="tags">The metadata tags.</param>
  32313. <param name="cancellationToken">The cancellation token.</param>
  32314. </member>
  32315. <member name="M:MailKit.IMailFolder.SetMetadata(MailKit.MetadataCollection,System.Threading.CancellationToken)">
  32316. <summary>
  32317. Sets the specified metadata.
  32318. </summary>
  32319. <remarks>
  32320. Sets the specified metadata.
  32321. </remarks>
  32322. <param name="metadata">The metadata.</param>
  32323. <param name="cancellationToken">The cancellation token.</param>
  32324. </member>
  32325. <member name="M:MailKit.IMailFolder.SetMetadataAsync(MailKit.MetadataCollection,System.Threading.CancellationToken)">
  32326. <summary>
  32327. Asynchronously sets the specified metadata.
  32328. </summary>
  32329. <remarks>
  32330. Asynchronously sets the specified metadata.
  32331. </remarks>
  32332. <returns>An asynchronous task context.</returns>
  32333. <param name="metadata">The metadata.</param>
  32334. <param name="cancellationToken">The cancellation token.</param>
  32335. </member>
  32336. <member name="M:MailKit.IMailFolder.Expunge(System.Threading.CancellationToken)">
  32337. <summary>
  32338. Expunge the folder, permanently removing all messages marked for deletion.
  32339. </summary>
  32340. <remarks>
  32341. <para>Expunges the folder, permanently removing all messages marked for deletion.</para>
  32342. <note type="note">Normally, an <see cref="E:MailKit.IMailFolder.MessageExpunged"/> event will be emitted for each
  32343. message that is expunged. However, if the mail store supports the quick
  32344. resynchronization feature and it has been enabled via the
  32345. <see cref="M:MailKit.IMailStore.EnableQuickResync(System.Threading.CancellationToken)"/> method, then
  32346. the <see cref="E:MailKit.IMailFolder.MessagesVanished"/> event will be emitted rather than the
  32347. <see cref="E:MailKit.IMailFolder.MessageExpunged"/> event.</note>
  32348. </remarks>
  32349. <param name="cancellationToken">The cancellation token.</param>
  32350. </member>
  32351. <member name="M:MailKit.IMailFolder.ExpungeAsync(System.Threading.CancellationToken)">
  32352. <summary>
  32353. Asynchronously expunge the folder, permanently removing all messages marked for deletion.
  32354. </summary>
  32355. <remarks>
  32356. <para>Asynchronously expunges the folder, permanently removing all messages marked for deletion.</para>
  32357. <note type="note">Normally, an <see cref="E:MailKit.IMailFolder.MessageExpunged"/> event will be emitted for
  32358. each message that is expunged. However, if the mail store supports the quick
  32359. resynchronization feature and it has been enabled via the
  32360. <see cref="M:MailKit.IMailStore.EnableQuickResync(System.Threading.CancellationToken)"/> method, then
  32361. the <see cref="E:MailKit.IMailFolder.MessagesVanished"/> event will be emitted rather than the
  32362. <see cref="E:MailKit.IMailFolder.MessageExpunged"/> event.</note>
  32363. </remarks>
  32364. <returns>An asynchronous task context.</returns>
  32365. <param name="cancellationToken">The cancellation token.</param>
  32366. </member>
  32367. <member name="M:MailKit.IMailFolder.Expunge(System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)">
  32368. <summary>
  32369. Expunge the specified uids, permanently removing them from the folder.
  32370. </summary>
  32371. <remarks>
  32372. <para>Expunges the specified uids, permanently removing them from the folder.</para>
  32373. <note type="note">Normally, an <see cref="E:MailKit.IMailFolder.MessageExpunged"/> event will be emitted for
  32374. each message that is expunged. However, if the mail store supports the quick
  32375. resynchronization feature and it has been enabled via the
  32376. <see cref="M:MailKit.IMailStore.EnableQuickResync(System.Threading.CancellationToken)"/> method, then
  32377. the <see cref="E:MailKit.IMailFolder.MessagesVanished"/> event will be emitted rather than the
  32378. <see cref="E:MailKit.IMailFolder.MessageExpunged"/> event.</note>
  32379. </remarks>
  32380. <param name="uids">The message uids.</param>
  32381. <param name="cancellationToken">The cancellation token.</param>
  32382. </member>
  32383. <member name="M:MailKit.IMailFolder.ExpungeAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)">
  32384. <summary>
  32385. Asynchronously expunge the specified uids, permanently removing them from the folder.
  32386. </summary>
  32387. <remarks>
  32388. <para>Asynchronously expunges the specified uids, permanently removing them from the folder.</para>
  32389. <note type="note">Normally, an <see cref="E:MailKit.IMailFolder.MessageExpunged"/> event will be emitted for
  32390. each message that is expunged. However, if the mail store supports the quick
  32391. resynchronization feature and it has been enabled via the
  32392. <see cref="M:MailKit.IMailStore.EnableQuickResync(System.Threading.CancellationToken)"/> method, then
  32393. the <see cref="E:MailKit.IMailFolder.MessagesVanished"/> event will be emitted rather than the
  32394. <see cref="E:MailKit.IMailFolder.MessageExpunged"/> event.</note>
  32395. </remarks>
  32396. <returns>An asynchronous task context.</returns>
  32397. <param name="uids">The message uids.</param>
  32398. <param name="cancellationToken">The cancellation token.</param>
  32399. </member>
  32400. <member name="M:MailKit.IMailFolder.Append(MimeKit.MimeMessage,MailKit.MessageFlags,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  32401. <summary>
  32402. Append the specified message to the folder.
  32403. </summary>
  32404. <remarks>
  32405. Appends the specified message to the folder and returns the UniqueId assigned to the message.
  32406. </remarks>
  32407. <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
  32408. <param name="message">The message.</param>
  32409. <param name="flags">The message flags.</param>
  32410. <param name="cancellationToken">The cancellation token.</param>
  32411. <param name="progress">The progress reporting mechanism.</param>
  32412. </member>
  32413. <member name="M:MailKit.IMailFolder.AppendAsync(MimeKit.MimeMessage,MailKit.MessageFlags,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  32414. <summary>
  32415. Asynchronously append the specified message to the folder.
  32416. </summary>
  32417. <remarks>
  32418. Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.
  32419. </remarks>
  32420. <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
  32421. <param name="message">The message.</param>
  32422. <param name="flags">The message flags.</param>
  32423. <param name="cancellationToken">The cancellation token.</param>
  32424. <param name="progress">The progress reporting mechanism.</param>
  32425. </member>
  32426. <member name="M:MailKit.IMailFolder.Append(MimeKit.MimeMessage,MailKit.MessageFlags,System.DateTimeOffset,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  32427. <summary>
  32428. Append the specified message to the folder.
  32429. </summary>
  32430. <remarks>
  32431. Appends the specified message to the folder and returns the UniqueId assigned to the message.
  32432. </remarks>
  32433. <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
  32434. <param name="message">The message.</param>
  32435. <param name="flags">The message flags.</param>
  32436. <param name="date">The received date of the message.</param>
  32437. <param name="cancellationToken">The cancellation token.</param>
  32438. <param name="progress">The progress reporting mechanism.</param>
  32439. </member>
  32440. <member name="M:MailKit.IMailFolder.AppendAsync(MimeKit.MimeMessage,MailKit.MessageFlags,System.DateTimeOffset,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  32441. <summary>
  32442. Asynchronously append the specified message to the folder.
  32443. </summary>
  32444. <remarks>
  32445. Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.
  32446. </remarks>
  32447. <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
  32448. <param name="message">The message.</param>
  32449. <param name="flags">The message flags.</param>
  32450. <param name="date">The received date of the message.</param>
  32451. <param name="cancellationToken">The cancellation token.</param>
  32452. <param name="progress">The progress reporting mechanism.</param>
  32453. </member>
  32454. <member name="M:MailKit.IMailFolder.Append(MimeKit.MimeMessage,MailKit.MessageFlags,System.Nullable{System.DateTimeOffset},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  32455. <summary>
  32456. Append the specified message to the folder.
  32457. </summary>
  32458. <remarks>
  32459. Appends the specified message to the folder and returns the UniqueId assigned to the message.
  32460. </remarks>
  32461. <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
  32462. <param name="message">The message.</param>
  32463. <param name="flags">The message flags.</param>
  32464. <param name="date">The received date of the message.</param>
  32465. <param name="annotations">The message annotations.</param>
  32466. <param name="cancellationToken">The cancellation token.</param>
  32467. <param name="progress">The progress reporting mechanism.</param>
  32468. </member>
  32469. <member name="M:MailKit.IMailFolder.AppendAsync(MimeKit.MimeMessage,MailKit.MessageFlags,System.Nullable{System.DateTimeOffset},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  32470. <summary>
  32471. Asynchronously append the specified message to the folder.
  32472. </summary>
  32473. <remarks>
  32474. Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.
  32475. </remarks>
  32476. <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
  32477. <param name="message">The message.</param>
  32478. <param name="flags">The message flags.</param>
  32479. <param name="date">The received date of the message.</param>
  32480. <param name="annotations">The message annotations.</param>
  32481. <param name="cancellationToken">The cancellation token.</param>
  32482. <param name="progress">The progress reporting mechanism.</param>
  32483. </member>
  32484. <member name="M:MailKit.IMailFolder.Append(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  32485. <summary>
  32486. Append the specified message to the folder.
  32487. </summary>
  32488. <remarks>
  32489. Appends the specified message to the folder and returns the UniqueId assigned to the message.
  32490. </remarks>
  32491. <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
  32492. <param name="options">The formatting options.</param>
  32493. <param name="message">The message.</param>
  32494. <param name="flags">The message flags.</param>
  32495. <param name="cancellationToken">The cancellation token.</param>
  32496. <param name="progress">The progress reporting mechanism.</param>
  32497. </member>
  32498. <member name="M:MailKit.IMailFolder.AppendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  32499. <summary>
  32500. Asynchronously append the specified message to the folder.
  32501. </summary>
  32502. <remarks>
  32503. Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.
  32504. </remarks>
  32505. <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
  32506. <param name="options">The formatting options.</param>
  32507. <param name="message">The message.</param>
  32508. <param name="flags">The message flags.</param>
  32509. <param name="cancellationToken">The cancellation token.</param>
  32510. <param name="progress">The progress reporting mechanism.</param>
  32511. </member>
  32512. <member name="M:MailKit.IMailFolder.Append(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.DateTimeOffset,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  32513. <summary>
  32514. Append the specified message to the folder.
  32515. </summary>
  32516. <remarks>
  32517. Appends the specified message to the folder and returns the UniqueId assigned to the message.
  32518. </remarks>
  32519. <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
  32520. <param name="options">The formatting options.</param>
  32521. <param name="message">The message.</param>
  32522. <param name="flags">The message flags.</param>
  32523. <param name="date">The received date of the message.</param>
  32524. <param name="cancellationToken">The cancellation token.</param>
  32525. <param name="progress">The progress reporting mechanism.</param>
  32526. </member>
  32527. <member name="M:MailKit.IMailFolder.AppendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.DateTimeOffset,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  32528. <summary>
  32529. Asynchronously append the specified message to the folder.
  32530. </summary>
  32531. <remarks>
  32532. Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.
  32533. </remarks>
  32534. <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
  32535. <param name="options">The formatting options.</param>
  32536. <param name="message">The message.</param>
  32537. <param name="flags">The message flags.</param>
  32538. <param name="date">The received date of the message.</param>
  32539. <param name="cancellationToken">The cancellation token.</param>
  32540. <param name="progress">The progress reporting mechanism.</param>
  32541. </member>
  32542. <member name="M:MailKit.IMailFolder.Append(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.Nullable{System.DateTimeOffset},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  32543. <summary>
  32544. Append the specified message to the folder.
  32545. </summary>
  32546. <remarks>
  32547. Appends the specified message to the folder and returns the UniqueId assigned to the message.
  32548. </remarks>
  32549. <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
  32550. <param name="options">The formatting options.</param>
  32551. <param name="message">The message.</param>
  32552. <param name="flags">The message flags.</param>
  32553. <param name="date">The received date of the message.</param>
  32554. <param name="annotations">The message annotations.</param>
  32555. <param name="cancellationToken">The cancellation token.</param>
  32556. <param name="progress">The progress reporting mechanism.</param>
  32557. </member>
  32558. <member name="M:MailKit.IMailFolder.AppendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.Nullable{System.DateTimeOffset},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  32559. <summary>
  32560. Asynchronously append the specified message to the folder.
  32561. </summary>
  32562. <remarks>
  32563. Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.
  32564. </remarks>
  32565. <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
  32566. <param name="options">The formatting options.</param>
  32567. <param name="message">The message.</param>
  32568. <param name="flags">The message flags.</param>
  32569. <param name="date">The received date of the message.</param>
  32570. <param name="annotations">The message annotations.</param>
  32571. <param name="cancellationToken">The cancellation token.</param>
  32572. <param name="progress">The progress reporting mechanism.</param>
  32573. </member>
  32574. <member name="M:MailKit.IMailFolder.Append(System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  32575. <summary>
  32576. Append the specified messages to the folder.
  32577. </summary>
  32578. <remarks>
  32579. Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
  32580. </remarks>
  32581. <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
  32582. <param name="messages">The list of messages to append to the folder.</param>
  32583. <param name="flags">The message flags to use for each message.</param>
  32584. <param name="cancellationToken">The cancellation token.</param>
  32585. <param name="progress">The progress reporting mechanism.</param>
  32586. </member>
  32587. <member name="M:MailKit.IMailFolder.AppendAsync(System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  32588. <summary>
  32589. Asynchronously append the specified messages to the folder.
  32590. </summary>
  32591. <remarks>
  32592. Asynchronously appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
  32593. </remarks>
  32594. <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
  32595. <param name="messages">The list of messages to append to the folder.</param>
  32596. <param name="flags">The message flags to use for each message.</param>
  32597. <param name="cancellationToken">The cancellation token.</param>
  32598. <param name="progress">The progress reporting mechanism.</param>
  32599. </member>
  32600. <member name="M:MailKit.IMailFolder.Append(System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Collections.Generic.IList{System.DateTimeOffset},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  32601. <summary>
  32602. Append the specified messages to the folder.
  32603. </summary>
  32604. <remarks>
  32605. Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
  32606. </remarks>
  32607. <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
  32608. <param name="messages">The list of messages to append to the folder.</param>
  32609. <param name="flags">The message flags to use for each of the messages.</param>
  32610. <param name="dates">The received dates to use for each of the messages.</param>
  32611. <param name="cancellationToken">The cancellation token.</param>
  32612. <param name="progress">The progress reporting mechanism.</param>
  32613. </member>
  32614. <member name="M:MailKit.IMailFolder.AppendAsync(System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Collections.Generic.IList{System.DateTimeOffset},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  32615. <summary>
  32616. Asynchronously append the specified messages to the folder.
  32617. </summary>
  32618. <remarks>
  32619. Asynchronously appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
  32620. </remarks>
  32621. <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
  32622. <param name="messages">The list of messages to append to the folder.</param>
  32623. <param name="flags">The message flags to use for each of the messages.</param>
  32624. <param name="dates">The received dates to use for each of the messages.</param>
  32625. <param name="cancellationToken">The cancellation token.</param>
  32626. <param name="progress">The progress reporting mechanism.</param>
  32627. </member>
  32628. <member name="M:MailKit.IMailFolder.Append(MimeKit.FormatOptions,System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  32629. <summary>
  32630. Append the specified messages to the folder.
  32631. </summary>
  32632. <remarks>
  32633. Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
  32634. </remarks>
  32635. <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
  32636. <param name="options">The formatting options.</param>
  32637. <param name="messages">The list of messages to append to the folder.</param>
  32638. <param name="flags">The message flags to use for each message.</param>
  32639. <param name="cancellationToken">The cancellation token.</param>
  32640. <param name="progress">The progress reporting mechanism.</param>
  32641. </member>
  32642. <member name="M:MailKit.IMailFolder.AppendAsync(MimeKit.FormatOptions,System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  32643. <summary>
  32644. Asynchronously append the specified messages to the folder.
  32645. </summary>
  32646. <remarks>
  32647. Asynchronously appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
  32648. </remarks>
  32649. <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
  32650. <param name="options">The formatting options.</param>
  32651. <param name="messages">The list of messages to append to the folder.</param>
  32652. <param name="flags">The message flags to use for each message.</param>
  32653. <param name="cancellationToken">The cancellation token.</param>
  32654. <param name="progress">The progress reporting mechanism.</param>
  32655. </member>
  32656. <member name="M:MailKit.IMailFolder.Append(MimeKit.FormatOptions,System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Collections.Generic.IList{System.DateTimeOffset},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  32657. <summary>
  32658. Append the specified messages to the folder.
  32659. </summary>
  32660. <remarks>
  32661. Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
  32662. </remarks>
  32663. <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
  32664. <param name="options">The formatting options.</param>
  32665. <param name="messages">The list of messages to append to the folder.</param>
  32666. <param name="flags">The message flags to use for each of the messages.</param>
  32667. <param name="dates">The received dates to use for each of the messages.</param>
  32668. <param name="cancellationToken">The cancellation token.</param>
  32669. <param name="progress">The progress reporting mechanism.</param>
  32670. </member>
  32671. <member name="M:MailKit.IMailFolder.AppendAsync(MimeKit.FormatOptions,System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Collections.Generic.IList{System.DateTimeOffset},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  32672. <summary>
  32673. Asynchronously append the specified messages to the folder.
  32674. </summary>
  32675. <remarks>
  32676. Asynchronously appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
  32677. </remarks>
  32678. <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
  32679. <param name="options">The formatting options.</param>
  32680. <param name="messages">The list of messages to append to the folder.</param>
  32681. <param name="flags">The message flags to use for each of the messages.</param>
  32682. <param name="dates">The received dates to use for each of the messages.</param>
  32683. <param name="cancellationToken">The cancellation token.</param>
  32684. <param name="progress">The progress reporting mechanism.</param>
  32685. </member>
  32686. <member name="M:MailKit.IMailFolder.CopyTo(MailKit.UniqueId,MailKit.IMailFolder,System.Threading.CancellationToken)">
  32687. <summary>
  32688. Copy the specified message to the destination folder.
  32689. </summary>
  32690. <remarks>
  32691. Copies the specified message to the destination folder.
  32692. </remarks>
  32693. <returns>The UID of the message in the destination folder, if available; otherwise, <c>null</c>.</returns>
  32694. <param name="uid">The UID of the message to copy.</param>
  32695. <param name="destination">The destination folder.</param>
  32696. <param name="cancellationToken">The cancellation token.</param>
  32697. </member>
  32698. <member name="M:MailKit.IMailFolder.CopyToAsync(MailKit.UniqueId,MailKit.IMailFolder,System.Threading.CancellationToken)">
  32699. <summary>
  32700. Asynchronously copy the specified message to the destination folder.
  32701. </summary>
  32702. <remarks>
  32703. Asynchronously copies the specified message to the destination folder.
  32704. </remarks>
  32705. <returns>The UID of the message in the destination folder, if available; otherwise, <c>null</c>.</returns>
  32706. <param name="uid">The UID of the message to copy.</param>
  32707. <param name="destination">The destination folder.</param>
  32708. <param name="cancellationToken">The cancellation token.</param>
  32709. </member>
  32710. <member name="M:MailKit.IMailFolder.CopyTo(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.IMailFolder,System.Threading.CancellationToken)">
  32711. <summary>
  32712. Copy the specified messages to the destination folder.
  32713. </summary>
  32714. <remarks>
  32715. Copies the specified messages to the destination folder.
  32716. </remarks>
  32717. <returns>The UID mapping of the messages in the destination folder, if available; otherwise an empty mapping.</returns>
  32718. <param name="uids">The UIDs of the messages to copy.</param>
  32719. <param name="destination">The destination folder.</param>
  32720. <param name="cancellationToken">The cancellation token.</param>
  32721. </member>
  32722. <member name="M:MailKit.IMailFolder.CopyToAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.IMailFolder,System.Threading.CancellationToken)">
  32723. <summary>
  32724. Asynchronously copy the specified messages to the destination folder.
  32725. </summary>
  32726. <remarks>
  32727. Asynchronously copies the specified messages to the destination folder.
  32728. </remarks>
  32729. <returns>The UID mapping of the messages in the destination folder, if available; otherwise an empty mapping.</returns>
  32730. <param name="uids">The UIDs of the messages to copy.</param>
  32731. <param name="destination">The destination folder.</param>
  32732. <param name="cancellationToken">The cancellation token.</param>
  32733. </member>
  32734. <member name="M:MailKit.IMailFolder.MoveTo(MailKit.UniqueId,MailKit.IMailFolder,System.Threading.CancellationToken)">
  32735. <summary>
  32736. Move the specified message to the destination folder.
  32737. </summary>
  32738. <remarks>
  32739. Moves the specified message to the destination folder.
  32740. </remarks>
  32741. <returns>The UID of the message in the destination folder, if available; otherwise, <c>null</c>.</returns>
  32742. <param name="uid">The UID of the message to move.</param>
  32743. <param name="destination">The destination folder.</param>
  32744. <param name="cancellationToken">The cancellation token.</param>
  32745. </member>
  32746. <member name="M:MailKit.IMailFolder.MoveToAsync(MailKit.UniqueId,MailKit.IMailFolder,System.Threading.CancellationToken)">
  32747. <summary>
  32748. Asynchronously move the specified message to the destination folder.
  32749. </summary>
  32750. <remarks>
  32751. Asynchronously moves the specified message to the destination folder.
  32752. </remarks>
  32753. <returns>The UID of the message in the destination folder, if available; otherwise, <c>null</c>.</returns>
  32754. <param name="uid">The UID of the message to move.</param>
  32755. <param name="destination">The destination folder.</param>
  32756. <param name="cancellationToken">The cancellation token.</param>
  32757. </member>
  32758. <member name="M:MailKit.IMailFolder.MoveTo(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.IMailFolder,System.Threading.CancellationToken)">
  32759. <summary>
  32760. Move the specified messages to the destination folder.
  32761. </summary>
  32762. <remarks>
  32763. Moves the specified messages to the destination folder.
  32764. </remarks>
  32765. <returns>The UID mapping of the messages in the destination folder, if available; otherwise an empty mapping.</returns>
  32766. <param name="uids">The UIDs of the messages to copy.</param>
  32767. <param name="destination">The destination folder.</param>
  32768. <param name="cancellationToken">The cancellation token.</param>
  32769. </member>
  32770. <member name="M:MailKit.IMailFolder.MoveToAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.IMailFolder,System.Threading.CancellationToken)">
  32771. <summary>
  32772. Asynchronously move the specified messages to the destination folder.
  32773. </summary>
  32774. <remarks>
  32775. Asynchronously moves the specified messages to the destination folder.
  32776. </remarks>
  32777. <returns>The UID mapping of the messages in the destination folder, if available; otherwise an empty mapping.</returns>
  32778. <param name="uids">The UIDs of the messages to copy.</param>
  32779. <param name="destination">The destination folder.</param>
  32780. <param name="cancellationToken">The cancellation token.</param>
  32781. </member>
  32782. <member name="M:MailKit.IMailFolder.CopyTo(System.Int32,MailKit.IMailFolder,System.Threading.CancellationToken)">
  32783. <summary>
  32784. Copy the specified message to the destination folder.
  32785. </summary>
  32786. <remarks>
  32787. Copies the specified message to the destination folder.
  32788. </remarks>
  32789. <param name="index">The index of the message to copy.</param>
  32790. <param name="destination">The destination folder.</param>
  32791. <param name="cancellationToken">The cancellation token.</param>
  32792. </member>
  32793. <member name="M:MailKit.IMailFolder.CopyToAsync(System.Int32,MailKit.IMailFolder,System.Threading.CancellationToken)">
  32794. <summary>
  32795. Asynchronously copy the specified message to the destination folder.
  32796. </summary>
  32797. <remarks>
  32798. Asynchronously copies the specified message to the destination folder.
  32799. </remarks>
  32800. <returns>An asynchronous task context.</returns>
  32801. <param name="index">The indexes of the message to copy.</param>
  32802. <param name="destination">The destination folder.</param>
  32803. <param name="cancellationToken">The cancellation token.</param>
  32804. </member>
  32805. <member name="M:MailKit.IMailFolder.CopyTo(System.Collections.Generic.IList{System.Int32},MailKit.IMailFolder,System.Threading.CancellationToken)">
  32806. <summary>
  32807. Copy the specified messages to the destination folder.
  32808. </summary>
  32809. <remarks>
  32810. Copies the specified messages to the destination folder.
  32811. </remarks>
  32812. <param name="indexes">The indexes of the messages to copy.</param>
  32813. <param name="destination">The destination folder.</param>
  32814. <param name="cancellationToken">The cancellation token.</param>
  32815. </member>
  32816. <member name="M:MailKit.IMailFolder.CopyToAsync(System.Collections.Generic.IList{System.Int32},MailKit.IMailFolder,System.Threading.CancellationToken)">
  32817. <summary>
  32818. Asynchronously copy the specified messages to the destination folder.
  32819. </summary>
  32820. <remarks>
  32821. Asynchronously copies the specified messages to the destination folder.
  32822. </remarks>
  32823. <returns>An asynchronous task context.</returns>
  32824. <param name="indexes">The indexes of the messages to copy.</param>
  32825. <param name="destination">The destination folder.</param>
  32826. <param name="cancellationToken">The cancellation token.</param>
  32827. </member>
  32828. <member name="M:MailKit.IMailFolder.MoveTo(System.Int32,MailKit.IMailFolder,System.Threading.CancellationToken)">
  32829. <summary>
  32830. Move the specified message to the destination folder.
  32831. </summary>
  32832. <remarks>
  32833. Moves the specified message to the destination folder.
  32834. </remarks>
  32835. <param name="index">The index of the message to move.</param>
  32836. <param name="destination">The destination folder.</param>
  32837. <param name="cancellationToken">The cancellation token.</param>
  32838. </member>
  32839. <member name="M:MailKit.IMailFolder.MoveToAsync(System.Int32,MailKit.IMailFolder,System.Threading.CancellationToken)">
  32840. <summary>
  32841. Asynchronously move the specified message to the destination folder.
  32842. </summary>
  32843. <remarks>
  32844. Asynchronously moves the specified message to the destination folder.
  32845. </remarks>
  32846. <returns>An asynchronous task context.</returns>
  32847. <param name="index">The index of the message to move.</param>
  32848. <param name="destination">The destination folder.</param>
  32849. <param name="cancellationToken">The cancellation token.</param>
  32850. </member>
  32851. <member name="M:MailKit.IMailFolder.MoveTo(System.Collections.Generic.IList{System.Int32},MailKit.IMailFolder,System.Threading.CancellationToken)">
  32852. <summary>
  32853. Move the specified messages to the destination folder.
  32854. </summary>
  32855. <remarks>
  32856. Moves the specified messages to the destination folder.
  32857. </remarks>
  32858. <param name="indexes">The indexes of the messages to move.</param>
  32859. <param name="destination">The destination folder.</param>
  32860. <param name="cancellationToken">The cancellation token.</param>
  32861. </member>
  32862. <member name="M:MailKit.IMailFolder.MoveToAsync(System.Collections.Generic.IList{System.Int32},MailKit.IMailFolder,System.Threading.CancellationToken)">
  32863. <summary>
  32864. Asynchronously move the specified messages to the destination folder.
  32865. </summary>
  32866. <remarks>
  32867. Asynchronously moves the specified messages to the destination folder.
  32868. </remarks>
  32869. <returns>An asynchronous task context.</returns>
  32870. <param name="indexes">The indexes of the messages to move.</param>
  32871. <param name="destination">The destination folder.</param>
  32872. <param name="cancellationToken">The cancellation token.</param>
  32873. </member>
  32874. <member name="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
  32875. <summary>
  32876. Fetch the message summaries for the specified message UIDs.
  32877. </summary>
  32878. <remarks>
  32879. <para>Fetches the message summaries for the specified message UIDs.</para>
  32880. <para>It should be noted that if another client has modified any message
  32881. in the folder, the mail service may choose to return information that was
  32882. not explicitly requested. It is therefore important to be prepared to
  32883. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  32884. messages that were requested as well as summaries for messages that were
  32885. not requested at all.</para>
  32886. </remarks>
  32887. <example>
  32888. <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
  32889. </example>
  32890. <returns>An enumeration of summaries for the requested messages.</returns>
  32891. <param name="uids">The UIDs.</param>
  32892. <param name="items">The message summary items to fetch.</param>
  32893. <param name="cancellationToken">The cancellation token.</param>
  32894. </member>
  32895. <member name="M:MailKit.IMailFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
  32896. <summary>
  32897. Asynchronously fetch the message summaries for the specified message UIDs.
  32898. </summary>
  32899. <remarks>
  32900. <para>Asynchronously fetches the message summaries for the specified message
  32901. UIDs.</para>
  32902. <para>It should be noted that if another client has modified any message
  32903. in the folder, the mail service may choose to return information that was
  32904. not explicitly requested. It is therefore important to be prepared to
  32905. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  32906. messages that were requested as well as summaries for messages that were
  32907. not requested at all.</para>
  32908. </remarks>
  32909. <returns>An enumeration of summaries for the requested messages.</returns>
  32910. <param name="uids">The UIDs.</param>
  32911. <param name="items">The message summary items to fetch.</param>
  32912. <param name="cancellationToken">The cancellation token.</param>
  32913. </member>
  32914. <member name="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
  32915. <summary>
  32916. Fetch the message summaries for the specified message UIDs.
  32917. </summary>
  32918. <remarks>
  32919. <para>Fetches the message summaries for the specified message UIDs.</para>
  32920. <para>It should be noted that if another client has modified any message
  32921. in the folder, the mail service may choose to return information that was
  32922. not explicitly requested. It is therefore important to be prepared to
  32923. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  32924. messages that were requested as well as summaries for messages that were
  32925. not requested at all.</para>
  32926. </remarks>
  32927. <returns>An enumeration of summaries for the requested messages.</returns>
  32928. <param name="uids">The UIDs.</param>
  32929. <param name="items">The message summary items to fetch.</param>
  32930. <param name="headers">The desired header fields.</param>
  32931. <param name="cancellationToken">The cancellation token.</param>
  32932. </member>
  32933. <member name="M:MailKit.IMailFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
  32934. <summary>
  32935. Asynchronously fetch the message summaries for the specified message UIDs.
  32936. </summary>
  32937. <remarks>
  32938. <para>Asynchronously fetches the message summaries for the specified message
  32939. UIDs.</para>
  32940. <para>It should be noted that if another client has modified any message
  32941. in the folder, the mail service may choose to return information that was
  32942. not explicitly requested. It is therefore important to be prepared to
  32943. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  32944. messages that were requested as well as summaries for messages that were
  32945. not requested at all.</para>
  32946. </remarks>
  32947. <returns>An enumeration of summaries for the requested messages.</returns>
  32948. <param name="uids">The UIDs.</param>
  32949. <param name="items">The message summary items to fetch.</param>
  32950. <param name="headers">The desired header fields.</param>
  32951. <param name="cancellationToken">The cancellation token.</param>
  32952. </member>
  32953. <member name="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
  32954. <summary>
  32955. Fetch the message summaries for the specified message UIDs.
  32956. </summary>
  32957. <remarks>
  32958. <para>Fetches the message summaries for the specified message UIDs.</para>
  32959. <para>It should be noted that if another client has modified any message
  32960. in the folder, the mail service may choose to return information that was
  32961. not explicitly requested. It is therefore important to be prepared to
  32962. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  32963. messages that were requested as well as summaries for messages that were
  32964. not requested at all.</para>
  32965. </remarks>
  32966. <returns>An enumeration of summaries for the requested messages.</returns>
  32967. <param name="uids">The UIDs.</param>
  32968. <param name="items">The message summary items to fetch.</param>
  32969. <param name="headers">The desired header fields.</param>
  32970. <param name="cancellationToken">The cancellation token.</param>
  32971. </member>
  32972. <member name="M:MailKit.IMailFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
  32973. <summary>
  32974. Asynchronously fetch the message summaries for the specified message UIDs.
  32975. </summary>
  32976. <remarks>
  32977. <para>Asynchronously fetches the message summaries for the specified message
  32978. UIDs.</para>
  32979. <para>It should be noted that if another client has modified any message
  32980. in the folder, the mail service may choose to return information that was
  32981. not explicitly requested. It is therefore important to be prepared to
  32982. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  32983. messages that were requested as well as summaries for messages that were
  32984. not requested at all.</para>
  32985. </remarks>
  32986. <returns>An enumeration of summaries for the requested messages.</returns>
  32987. <param name="uids">The UIDs.</param>
  32988. <param name="items">The message summary items to fetch.</param>
  32989. <param name="headers">The desired header fields.</param>
  32990. <param name="cancellationToken">The cancellation token.</param>
  32991. </member>
  32992. <member name="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
  32993. <summary>
  32994. Fetch the message summaries for the specified message UIDs that have a
  32995. higher mod-sequence value than the one specified.
  32996. </summary>
  32997. <remarks>
  32998. <para>Fetches the message summaries for the specified message UIDs that
  32999. have a higher mod-sequence value than the one specified.</para>
  33000. <para>If the mail store supports quick resynchronization and the application has
  33001. enabled this feature via <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/>,
  33002. then this method will emit <see cref="E:MailKit.IMailFolder.MessagesVanished"/> events for messages that
  33003. have vanished since the specified mod-sequence value.</para>
  33004. <para>It should be noted that if another client has modified any message
  33005. in the folder, the mail service may choose to return information that was
  33006. not explicitly requested. It is therefore important to be prepared to
  33007. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  33008. messages that were requested as well as summaries for messages that were
  33009. not requested at all.</para>
  33010. </remarks>
  33011. <returns>An enumeration of summaries for the requested messages.</returns>
  33012. <param name="uids">The UIDs.</param>
  33013. <param name="modseq">The mod-sequence value.</param>
  33014. <param name="items">The message summary items to fetch.</param>
  33015. <param name="cancellationToken">The cancellation token.</param>
  33016. </member>
  33017. <member name="M:MailKit.IMailFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
  33018. <summary>
  33019. Asynchronously fetch the message summaries for the specified message UIDs that have a
  33020. higher mod-sequence value than the one specified.
  33021. </summary>
  33022. <remarks>
  33023. <para>Asynchronously fetches the message summaries for the specified message UIDs that
  33024. have a higher mod-sequence value than the one specified.</para>
  33025. <para>If the mail store supports quick resynchronization and the application has
  33026. enabled this feature via <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/>,
  33027. then this method will emit <see cref="E:MailKit.IMailFolder.MessagesVanished"/> events for messages that
  33028. have vanished since the specified mod-sequence value.</para>
  33029. <para>It should be noted that if another client has modified any message
  33030. in the folder, the mail service may choose to return information that was
  33031. not explicitly requested. It is therefore important to be prepared to
  33032. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  33033. messages that were requested as well as summaries for messages that were
  33034. not requested at all.</para>
  33035. </remarks>
  33036. <returns>An enumeration of summaries for the requested messages.</returns>
  33037. <param name="uids">The UIDs.</param>
  33038. <param name="modseq">The mod-sequence value.</param>
  33039. <param name="items">The message summary items to fetch.</param>
  33040. <param name="cancellationToken">The cancellation token.</param>
  33041. </member>
  33042. <member name="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
  33043. <summary>
  33044. Fetch the message summaries for the specified message UIDs that have a
  33045. higher mod-sequence value than the one specified.
  33046. </summary>
  33047. <remarks>
  33048. <para>Fetches the message summaries for the specified message UIDs that
  33049. have a higher mod-sequence value than the one specified.</para>
  33050. <para>If the mail store supports quick resynchronization and the application has
  33051. enabled this feature via <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/>,
  33052. then this method will emit <see cref="E:MailKit.IMailFolder.MessagesVanished"/> events for messages that
  33053. have vanished since the specified mod-sequence value.</para>
  33054. <para>It should be noted that if another client has modified any message
  33055. in the folder, the mail service may choose to return information that was
  33056. not explicitly requested. It is therefore important to be prepared to
  33057. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  33058. messages that were requested as well as summaries for messages that were
  33059. not requested at all.</para>
  33060. </remarks>
  33061. <returns>An enumeration of summaries for the requested messages.</returns>
  33062. <param name="uids">The UIDs.</param>
  33063. <param name="modseq">The mod-sequence value.</param>
  33064. <param name="items">The message summary items to fetch.</param>
  33065. <param name="headers">The desired header fields.</param>
  33066. <param name="cancellationToken">The cancellation token.</param>
  33067. </member>
  33068. <member name="M:MailKit.IMailFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
  33069. <summary>
  33070. Asynchronously fetch the message summaries for the specified message UIDs that have a
  33071. higher mod-sequence value than the one specified.
  33072. </summary>
  33073. <remarks>
  33074. <para>Asynchronously fetches the message summaries for the specified message UIDs that
  33075. have a higher mod-sequence value than the one specified.</para>
  33076. <para>If the mail store supports quick resynchronization and the application has
  33077. enabled this feature via <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/>,
  33078. then this method will emit <see cref="E:MailKit.IMailFolder.MessagesVanished"/> events for messages that
  33079. have vanished since the specified mod-sequence value.</para>
  33080. <para>It should be noted that if another client has modified any message
  33081. in the folder, the mail service may choose to return information that was
  33082. not explicitly requested. It is therefore important to be prepared to
  33083. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  33084. messages that were requested as well as summaries for messages that were
  33085. not requested at all.</para>
  33086. </remarks>
  33087. <returns>An enumeration of summaries for the requested messages.</returns>
  33088. <param name="uids">The UIDs.</param>
  33089. <param name="modseq">The mod-sequence value.</param>
  33090. <param name="items">The message summary items to fetch.</param>
  33091. <param name="headers">The desired header fields.</param>
  33092. <param name="cancellationToken">The cancellation token.</param>
  33093. </member>
  33094. <member name="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
  33095. <summary>
  33096. Fetch the message summaries for the specified message UIDs that have a
  33097. higher mod-sequence value than the one specified.
  33098. </summary>
  33099. <remarks>
  33100. <para>Fetches the message summaries for the specified message UIDs that
  33101. have a higher mod-sequence value than the one specified.</para>
  33102. <para>If the mail store supports quick resynchronization and the application has
  33103. enabled this feature via <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/>,
  33104. then this method will emit <see cref="E:MailKit.IMailFolder.MessagesVanished"/> events for messages that
  33105. have vanished since the specified mod-sequence value.</para>
  33106. <para>It should be noted that if another client has modified any message
  33107. in the folder, the mail service may choose to return information that was
  33108. not explicitly requested. It is therefore important to be prepared to
  33109. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  33110. messages that were requested as well as summaries for messages that were
  33111. not requested at all.</para>
  33112. </remarks>
  33113. <returns>An enumeration of summaries for the requested messages.</returns>
  33114. <param name="uids">The UIDs.</param>
  33115. <param name="modseq">The mod-sequence value.</param>
  33116. <param name="items">The message summary items to fetch.</param>
  33117. <param name="headers">The desired header fields.</param>
  33118. <param name="cancellationToken">The cancellation token.</param>
  33119. </member>
  33120. <member name="M:MailKit.IMailFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
  33121. <summary>
  33122. Asynchronously fetch the message summaries for the specified message UIDs that have a
  33123. higher mod-sequence value than the one specified.
  33124. </summary>
  33125. <remarks>
  33126. <para>Asynchronously fetches the message summaries for the specified message UIDs that
  33127. have a higher mod-sequence value than the one specified.</para>
  33128. <para>If the mail store supports quick resynchronization and the application has
  33129. enabled this feature via <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/>,
  33130. then this method will emit <see cref="E:MailKit.IMailFolder.MessagesVanished"/> events for messages that
  33131. have vanished since the specified mod-sequence value.</para>
  33132. <para>It should be noted that if another client has modified any message
  33133. in the folder, the mail service may choose to return information that was
  33134. not explicitly requested. It is therefore important to be prepared to
  33135. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  33136. messages that were requested as well as summaries for messages that were
  33137. not requested at all.</para>
  33138. </remarks>
  33139. <returns>An enumeration of summaries for the requested messages.</returns>
  33140. <param name="uids">The UIDs.</param>
  33141. <param name="modseq">The mod-sequence value.</param>
  33142. <param name="items">The message summary items to fetch.</param>
  33143. <param name="headers">The desired header fields.</param>
  33144. <param name="cancellationToken">The cancellation token.</param>
  33145. </member>
  33146. <member name="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
  33147. <summary>
  33148. Fetch the message summaries for the specified message indexes.
  33149. </summary>
  33150. <remarks>
  33151. <para>Fetches the message summaries for the specified message indexes.</para>
  33152. <para>It should be noted that if another client has modified any message
  33153. in the folder, the mail service may choose to return information that was
  33154. not explicitly requested. It is therefore important to be prepared to
  33155. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  33156. messages that were requested as well as summaries for messages that were
  33157. not requested at all.</para>
  33158. </remarks>
  33159. <returns>An enumeration of summaries for the requested messages.</returns>
  33160. <param name="indexes">The indexes.</param>
  33161. <param name="items">The message summary items to fetch.</param>
  33162. <param name="cancellationToken">The cancellation token.</param>
  33163. </member>
  33164. <member name="M:MailKit.IMailFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
  33165. <summary>
  33166. Asynchronously fetch the message summaries for the specified message indexes.
  33167. </summary>
  33168. <remarks>
  33169. <para>Asynchronously fetches the message summaries for the specified message
  33170. indexes.</para>
  33171. <para>It should be noted that if another client has modified any message
  33172. in the folder, the mail service may choose to return information that was
  33173. not explicitly requested. It is therefore important to be prepared to
  33174. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  33175. messages that were requested as well as summaries for messages that were
  33176. not requested at all.</para>
  33177. </remarks>
  33178. <returns>An enumeration of summaries for the requested messages.</returns>
  33179. <param name="indexes">The indexes.</param>
  33180. <param name="items">The message summary items to fetch.</param>
  33181. <param name="cancellationToken">The cancellation token.</param>
  33182. </member>
  33183. <member name="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
  33184. <summary>
  33185. Fetch the message summaries for the specified message indexes.
  33186. </summary>
  33187. <remarks>
  33188. <para>Fetches the message summaries for the specified message indexes.</para>
  33189. <para>It should be noted that if another client has modified any message
  33190. in the folder, the mail service may choose to return information that was
  33191. not explicitly requested. It is therefore important to be prepared to
  33192. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  33193. messages that were requested as well as summaries for messages that were
  33194. not requested at all.</para>
  33195. </remarks>
  33196. <returns>An enumeration of summaries for the requested messages.</returns>
  33197. <param name="indexes">The indexes.</param>
  33198. <param name="items">The message summary items to fetch.</param>
  33199. <param name="headers">The desired header fields.</param>
  33200. <param name="cancellationToken">The cancellation token.</param>
  33201. </member>
  33202. <member name="M:MailKit.IMailFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
  33203. <summary>
  33204. Asynchronously fetch the message summaries for the specified message indexes.
  33205. </summary>
  33206. <remarks>
  33207. <para>Asynchronously fetches the message summaries for the specified message
  33208. indexes.</para>
  33209. <para>It should be noted that if another client has modified any message
  33210. in the folder, the mail service may choose to return information that was
  33211. not explicitly requested. It is therefore important to be prepared to
  33212. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  33213. messages that were requested as well as summaries for messages that were
  33214. not requested at all.</para>
  33215. </remarks>
  33216. <returns>An enumeration of summaries for the requested messages.</returns>
  33217. <param name="indexes">The indexes.</param>
  33218. <param name="items">The message summary items to fetch.</param>
  33219. <param name="headers">The desired header fields.</param>
  33220. <param name="cancellationToken">The cancellation token.</param>
  33221. </member>
  33222. <member name="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
  33223. <summary>
  33224. Fetch the message summaries for the specified message indexes.
  33225. </summary>
  33226. <remarks>
  33227. <para>Fetches the message summaries for the specified message indexes.</para>
  33228. <para>It should be noted that if another client has modified any message
  33229. in the folder, the mail service may choose to return information that was
  33230. not explicitly requested. It is therefore important to be prepared to
  33231. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  33232. messages that were requested as well as summaries for messages that were
  33233. not requested at all.</para>
  33234. </remarks>
  33235. <returns>An enumeration of summaries for the requested messages.</returns>
  33236. <param name="indexes">The indexes.</param>
  33237. <param name="items">The message summary items to fetch.</param>
  33238. <param name="headers">The desired header fields.</param>
  33239. <param name="cancellationToken">The cancellation token.</param>
  33240. </member>
  33241. <member name="M:MailKit.IMailFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
  33242. <summary>
  33243. Asynchronously fetch the message summaries for the specified message indexes.
  33244. </summary>
  33245. <remarks>
  33246. <para>Asynchronously fetches the message summaries for the specified message
  33247. indexes.</para>
  33248. <para>It should be noted that if another client has modified any message
  33249. in the folder, the mail service may choose to return information that was
  33250. not explicitly requested. It is therefore important to be prepared to
  33251. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  33252. messages that were requested as well as summaries for messages that were
  33253. not requested at all.</para>
  33254. </remarks>
  33255. <returns>An enumeration of summaries for the requested messages.</returns>
  33256. <param name="indexes">The indexes.</param>
  33257. <param name="items">The message summary items to fetch.</param>
  33258. <param name="headers">The desired header fields.</param>
  33259. <param name="cancellationToken">The cancellation token.</param>
  33260. </member>
  33261. <member name="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
  33262. <summary>
  33263. Fetch the message summaries for the specified message indexes that have a
  33264. higher mod-sequence value than the one specified.
  33265. </summary>
  33266. <remarks>
  33267. <para>Fetches the message summaries for the specified message indexes that
  33268. have a higher mod-sequence value than the one specified.</para>
  33269. <para>It should be noted that if another client has modified any message
  33270. in the folder, the mail service may choose to return information that was
  33271. not explicitly requested. It is therefore important to be prepared to
  33272. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  33273. messages that were requested as well as summaries for messages that were
  33274. not requested at all.</para>
  33275. </remarks>
  33276. <returns>An enumeration of summaries for the requested messages.</returns>
  33277. <param name="indexes">The indexes.</param>
  33278. <param name="modseq">The mod-sequence value.</param>
  33279. <param name="items">The message summary items to fetch.</param>
  33280. <param name="cancellationToken">The cancellation token.</param>
  33281. </member>
  33282. <member name="M:MailKit.IMailFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
  33283. <summary>
  33284. Asynchronously fetch the message summaries for the specified message indexes that have a
  33285. higher mod-sequence value than the one specified.
  33286. </summary>
  33287. <remarks>
  33288. <para>Asynchronously fetches the message summaries for the specified message
  33289. indexes that have a higher mod-sequence value than the one specified.</para>
  33290. <para>It should be noted that if another client has modified any message
  33291. in the folder, the mail service may choose to return information that was
  33292. not explicitly requested. It is therefore important to be prepared to
  33293. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  33294. messages that were requested as well as summaries for messages that were
  33295. not requested at all.</para>
  33296. </remarks>
  33297. <returns>An enumeration of summaries for the requested messages.</returns>
  33298. <param name="indexes">The indexes.</param>
  33299. <param name="modseq">The mod-sequence value.</param>
  33300. <param name="items">The message summary items to fetch.</param>
  33301. <param name="cancellationToken">The cancellation token.</param>
  33302. </member>
  33303. <member name="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
  33304. <summary>
  33305. Fetch the message summaries for the specified message indexes that have a
  33306. higher mod-sequence value than the one specified.
  33307. </summary>
  33308. <remarks>
  33309. <para>Fetches the message summaries for the specified message indexes that
  33310. have a higher mod-sequence value than the one specified.</para>
  33311. <para>It should be noted that if another client has modified any message
  33312. in the folder, the mail service may choose to return information that was
  33313. not explicitly requested. It is therefore important to be prepared to
  33314. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  33315. messages that were requested as well as summaries for messages that were
  33316. not requested at all.</para>
  33317. </remarks>
  33318. <returns>An enumeration of summaries for the requested messages.</returns>
  33319. <param name="indexes">The indexes.</param>
  33320. <param name="modseq">The mod-sequence value.</param>
  33321. <param name="items">The message summary items to fetch.</param>
  33322. <param name="headers">The desired header fields.</param>
  33323. <param name="cancellationToken">The cancellation token.</param>
  33324. </member>
  33325. <member name="M:MailKit.IMailFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
  33326. <summary>
  33327. Asynchronously fetch the message summaries for the specified message indexes
  33328. that have a higher mod-sequence value than the one specified.
  33329. </summary>
  33330. <remarks>
  33331. <para>Asynchronously fetches the message summaries for the specified message
  33332. indexes that have a higher mod-sequence value than the one specified.</para>
  33333. <para>It should be noted that if another client has modified any message
  33334. in the folder, the mail service may choose to return information that was
  33335. not explicitly requested. It is therefore important to be prepared to
  33336. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  33337. messages that were requested as well as summaries for messages that were
  33338. not requested at all.</para>
  33339. </remarks>
  33340. <returns>An enumeration of summaries for the requested messages.</returns>
  33341. <param name="indexes">The indexes.</param>
  33342. <param name="modseq">The mod-sequence value.</param>
  33343. <param name="items">The message summary items to fetch.</param>
  33344. <param name="headers">The desired header fields.</param>
  33345. <param name="cancellationToken">The cancellation token.</param>
  33346. </member>
  33347. <member name="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
  33348. <summary>
  33349. Fetch the message summaries for the specified message indexes that
  33350. have a higher mod-sequence value than the one specified.
  33351. </summary>
  33352. <remarks>
  33353. <para>Fetches the message summaries for the specified message indexes that
  33354. have a higher mod-sequence value than the one specified.</para>
  33355. <para>It should be noted that if another client has modified any message
  33356. in the folder, the mail service may choose to return information that was
  33357. not explicitly requested. It is therefore important to be prepared to
  33358. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  33359. messages that were requested as well as summaries for messages that were
  33360. not requested at all.</para>
  33361. </remarks>
  33362. <returns>An enumeration of summaries for the requested messages.</returns>
  33363. <param name="indexes">The indexes.</param>
  33364. <param name="modseq">The mod-sequence value.</param>
  33365. <param name="items">The message summary items to fetch.</param>
  33366. <param name="headers">The desired header fields.</param>
  33367. <param name="cancellationToken">The cancellation token.</param>
  33368. </member>
  33369. <member name="M:MailKit.IMailFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
  33370. <summary>
  33371. Asynchronously fetch the message summaries for the specified message indexes
  33372. that have a higher mod-sequence value than the one specified.
  33373. </summary>
  33374. <remarks>
  33375. <para>Asynchronously fetches the message summaries for the specified message
  33376. indexes that have a higher mod-sequence value than the one specified.</para>
  33377. <para>It should be noted that if another client has modified any message
  33378. in the folder, the mail service may choose to return information that was
  33379. not explicitly requested. It is therefore important to be prepared to
  33380. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  33381. messages that were requested as well as summaries for messages that were
  33382. not requested at all.</para>
  33383. </remarks>
  33384. <returns>An enumeration of summaries for the requested messages.</returns>
  33385. <param name="indexes">The indexes.</param>
  33386. <param name="modseq">The mod-sequence value.</param>
  33387. <param name="items">The message summary items to fetch.</param>
  33388. <param name="headers">The desired header fields.</param>
  33389. <param name="cancellationToken">The cancellation token.</param>
  33390. </member>
  33391. <member name="M:MailKit.IMailFolder.Fetch(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
  33392. <summary>
  33393. Fetch the message summaries for the messages between the two indexes, inclusive.
  33394. </summary>
  33395. <remarks>
  33396. <para>Fetches the message summaries for the messages between the two
  33397. indexes, inclusive.</para>
  33398. <para>It should be noted that if another client has modified any message
  33399. in the folder, the mail service may choose to return information that was
  33400. not explicitly requested. It is therefore important to be prepared to
  33401. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  33402. messages that were requested as well as summaries for messages that were
  33403. not requested at all.</para>
  33404. </remarks>
  33405. <returns>An enumeration of summaries for the requested messages.</returns>
  33406. <param name="min">The minimum index.</param>
  33407. <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
  33408. <param name="items">The message summary items to fetch.</param>
  33409. <param name="cancellationToken">The cancellation token.</param>
  33410. </member>
  33411. <member name="M:MailKit.IMailFolder.FetchAsync(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
  33412. <summary>
  33413. Asynchronously fetch the message summaries for the messages between the two indexes, inclusive.
  33414. </summary>
  33415. <remarks>
  33416. <para>Asynchronously fetches the message summaries for the messages between
  33417. the two indexes, inclusive.</para>
  33418. <para>It should be noted that if another client has modified any message
  33419. in the folder, the mail service may choose to return information that was
  33420. not explicitly requested. It is therefore important to be prepared to
  33421. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  33422. messages that were requested as well as summaries for messages that were
  33423. not requested at all.</para>
  33424. </remarks>
  33425. <returns>An enumeration of summaries for the requested messages.</returns>
  33426. <param name="min">The minimum index.</param>
  33427. <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
  33428. <param name="items">The message summary items to fetch.</param>
  33429. <param name="cancellationToken">The cancellation token.</param>
  33430. </member>
  33431. <member name="M:MailKit.IMailFolder.Fetch(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
  33432. <summary>
  33433. Fetch the message summaries for the messages between the two indexes, inclusive.
  33434. </summary>
  33435. <remarks>
  33436. <para>Fetches the message summaries for the messages between the two
  33437. indexes, inclusive.</para>
  33438. <para>It should be noted that if another client has modified any message
  33439. in the folder, the mail service may choose to return information that was
  33440. not explicitly requested. It is therefore important to be prepared to
  33441. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  33442. messages that were requested as well as summaries for messages that were
  33443. not requested at all.</para>
  33444. </remarks>
  33445. <returns>An enumeration of summaries for the requested messages.</returns>
  33446. <param name="min">The minimum index.</param>
  33447. <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
  33448. <param name="items">The message summary items to fetch.</param>
  33449. <param name="headers">The desired header fields.</param>
  33450. <param name="cancellationToken">The cancellation token.</param>
  33451. </member>
  33452. <member name="M:MailKit.IMailFolder.FetchAsync(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
  33453. <summary>
  33454. Asynchronously fetch the message summaries for the messages between the two indexes, inclusive.
  33455. </summary>
  33456. <remarks>
  33457. <para>Asynchronously fetches the message summaries for the messages between
  33458. the two indexes, inclusive.</para>
  33459. <para>It should be noted that if another client has modified any message
  33460. in the folder, the mail service may choose to return information that was
  33461. not explicitly requested. It is therefore important to be prepared to
  33462. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  33463. messages that were requested as well as summaries for messages that were
  33464. not requested at all.</para>
  33465. </remarks>
  33466. <returns>An enumeration of summaries for the requested messages.</returns>
  33467. <param name="min">The minimum index.</param>
  33468. <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
  33469. <param name="items">The message summary items to fetch.</param>
  33470. <param name="headers">The desired header fields.</param>
  33471. <param name="cancellationToken">The cancellation token.</param>
  33472. </member>
  33473. <member name="M:MailKit.IMailFolder.Fetch(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
  33474. <summary>
  33475. Fetch the message summaries for the messages between the two indexes, inclusive.
  33476. </summary>
  33477. <remarks>
  33478. <para>Fetches the message summaries for the messages between the two
  33479. indexes, inclusive.</para>
  33480. <para>It should be noted that if another client has modified any message
  33481. in the folder, the mail service may choose to return information that was
  33482. not explicitly requested. It is therefore important to be prepared to
  33483. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  33484. messages that were requested as well as summaries for messages that were
  33485. not requested at all.</para>
  33486. </remarks>
  33487. <returns>An enumeration of summaries for the requested messages.</returns>
  33488. <param name="min">The minimum index.</param>
  33489. <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
  33490. <param name="items">The message summary items to fetch.</param>
  33491. <param name="headers">The desired header fields.</param>
  33492. <param name="cancellationToken">The cancellation token.</param>
  33493. </member>
  33494. <member name="M:MailKit.IMailFolder.FetchAsync(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
  33495. <summary>
  33496. Asynchronously fetch the message summaries for the messages between the two indexes, inclusive.
  33497. </summary>
  33498. <remarks>
  33499. <para>Asynchronously fetches the message summaries for the messages between
  33500. the two indexes, inclusive.</para>
  33501. <para>It should be noted that if another client has modified any message
  33502. in the folder, the mail service may choose to return information that was
  33503. not explicitly requested. It is therefore important to be prepared to
  33504. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  33505. messages that were requested as well as summaries for messages that were
  33506. not requested at all.</para>
  33507. </remarks>
  33508. <returns>An enumeration of summaries for the requested messages.</returns>
  33509. <param name="min">The minimum index.</param>
  33510. <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
  33511. <param name="items">The message summary items to fetch.</param>
  33512. <param name="headers">The desired header fields.</param>
  33513. <param name="cancellationToken">The cancellation token.</param>
  33514. </member>
  33515. <member name="M:MailKit.IMailFolder.Fetch(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
  33516. <summary>
  33517. Fetch the message summaries for the messages between the two indexes (inclusive)
  33518. that have a higher mod-sequence value than the one specified.
  33519. </summary>
  33520. <remarks>
  33521. <para>Fetches the message summaries for the messages between the two
  33522. indexes (inclusive) that have a higher mod-sequence value than the one
  33523. specified.</para>
  33524. <para>It should be noted that if another client has modified any message
  33525. in the folder, the mail service may choose to return information that was
  33526. not explicitly requested. It is therefore important to be prepared to
  33527. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  33528. messages that were requested as well as summaries for messages that were
  33529. not requested at all.</para>
  33530. </remarks>
  33531. <returns>An enumeration of summaries for the requested messages.</returns>
  33532. <param name="min">The minimum index.</param>
  33533. <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
  33534. <param name="modseq">The mod-sequence value.</param>
  33535. <param name="items">The message summary items to fetch.</param>
  33536. <param name="cancellationToken">The cancellation token.</param>
  33537. </member>
  33538. <member name="M:MailKit.IMailFolder.FetchAsync(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
  33539. <summary>
  33540. Asynchronously fetch the message summaries for the messages between the two indexes
  33541. (inclusive) that have a higher mod-sequence value than the one specified.
  33542. </summary>
  33543. <remarks>
  33544. <para>Asynchronously fetches the message summaries for the messages between
  33545. the two indexes (inclusive) that have a higher mod-sequence value than the
  33546. one specified.</para>
  33547. <para>It should be noted that if another client has modified any message
  33548. in the folder, the mail service may choose to return information that was
  33549. not explicitly requested. It is therefore important to be prepared to
  33550. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  33551. messages that were requested as well as summaries for messages that were
  33552. not requested at all.</para>
  33553. </remarks>
  33554. <returns>An enumeration of summaries for the requested messages.</returns>
  33555. <param name="min">The minimum index.</param>
  33556. <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
  33557. <param name="modseq">The mod-sequence value.</param>
  33558. <param name="items">The message summary items to fetch.</param>
  33559. <param name="cancellationToken">The cancellation token.</param>
  33560. </member>
  33561. <member name="M:MailKit.IMailFolder.Fetch(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
  33562. <summary>
  33563. Fetch the message summaries for the messages between the two indexes (inclusive)
  33564. that have a higher mod-sequence value than the one specified.
  33565. </summary>
  33566. <remarks>
  33567. <para>Fetches the message summaries for the messages between the two
  33568. indexes (inclusive) that have a higher mod-sequence value than the one
  33569. specified.</para>
  33570. <para>It should be noted that if another client has modified any message
  33571. in the folder, the mail service may choose to return information that was
  33572. not explicitly requested. It is therefore important to be prepared to
  33573. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  33574. messages that were requested as well as summaries for messages that were
  33575. not requested at all.</para>
  33576. </remarks>
  33577. <returns>An enumeration of summaries for the requested messages.</returns>
  33578. <param name="min">The minimum index.</param>
  33579. <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
  33580. <param name="modseq">The mod-sequence value.</param>
  33581. <param name="items">The message summary items to fetch.</param>
  33582. <param name="headers">The desired header fields.</param>
  33583. <param name="cancellationToken">The cancellation token.</param>
  33584. </member>
  33585. <member name="M:MailKit.IMailFolder.FetchAsync(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
  33586. <summary>
  33587. Asynchronously fetch the message summaries for the messages between the two indexes
  33588. (inclusive) that have a higher mod-sequence value than the one specified.
  33589. </summary>
  33590. <remarks>
  33591. <para>Asynchronously fetches the message summaries for the messages between
  33592. the two indexes (inclusive) that have a higher mod-sequence value than the
  33593. one specified.</para>
  33594. <para>It should be noted that if another client has modified any message
  33595. in the folder, the mail service may choose to return information that was
  33596. not explicitly requested. It is therefore important to be prepared to
  33597. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  33598. messages that were requested as well as summaries for messages that were
  33599. not requested at all.</para>
  33600. </remarks>
  33601. <returns>An enumeration of summaries for the requested messages.</returns>
  33602. <param name="min">The minimum index.</param>
  33603. <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
  33604. <param name="modseq">The mod-sequence value.</param>
  33605. <param name="items">The message summary items to fetch.</param>
  33606. <param name="headers">The desired header fields.</param>
  33607. <param name="cancellationToken">The cancellation token.</param>
  33608. </member>
  33609. <member name="M:MailKit.IMailFolder.Fetch(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
  33610. <summary>
  33611. Fetch the message summaries for the messages between the two indexes (inclusive)
  33612. that have a higher mod-sequence value than the one specified.
  33613. </summary>
  33614. <remarks>
  33615. <para>Fetches the message summaries for the messages between the two
  33616. indexes (inclusive) that have a higher mod-sequence value than the one
  33617. specified.</para>
  33618. <para>It should be noted that if another client has modified any message
  33619. in the folder, the mail service may choose to return information that was
  33620. not explicitly requested. It is therefore important to be prepared to
  33621. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  33622. messages that were requested as well as summaries for messages that were
  33623. not requested at all.</para>
  33624. </remarks>
  33625. <returns>An enumeration of summaries for the requested messages.</returns>
  33626. <param name="min">The minimum index.</param>
  33627. <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
  33628. <param name="modseq">The mod-sequence value.</param>
  33629. <param name="items">The message summary items to fetch.</param>
  33630. <param name="headers">The desired header fields.</param>
  33631. <param name="cancellationToken">The cancellation token.</param>
  33632. </member>
  33633. <member name="M:MailKit.IMailFolder.FetchAsync(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
  33634. <summary>
  33635. Asynchronously fetch the message summaries for the messages between the two indexes
  33636. (inclusive) that have a higher mod-sequence value than the one specified.
  33637. </summary>
  33638. <remarks>
  33639. <para>Asynchronously fetches the message summaries for the messages between
  33640. the two indexes (inclusive) that have a higher mod-sequence value than the
  33641. one specified.</para>
  33642. <para>It should be noted that if another client has modified any message
  33643. in the folder, the mail service may choose to return information that was
  33644. not explicitly requested. It is therefore important to be prepared to
  33645. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  33646. messages that were requested as well as summaries for messages that were
  33647. not requested at all.</para>
  33648. </remarks>
  33649. <returns>An enumeration of summaries for the requested messages.</returns>
  33650. <param name="min">The minimum index.</param>
  33651. <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
  33652. <param name="modseq">The mod-sequence value.</param>
  33653. <param name="items">The message summary items to fetch.</param>
  33654. <param name="headers">The desired header fields.</param>
  33655. <param name="cancellationToken">The cancellation token.</param>
  33656. </member>
  33657. <member name="M:MailKit.IMailFolder.GetHeaders(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  33658. <summary>
  33659. Get the specified message headers.
  33660. </summary>
  33661. <remarks>
  33662. Gets the specified message headers.
  33663. </remarks>
  33664. <returns>The message headers.</returns>
  33665. <param name="uid">The UID of the message.</param>
  33666. <param name="cancellationToken">The cancellation token.</param>
  33667. <param name="progress">The progress reporting mechanism.</param>
  33668. </member>
  33669. <member name="M:MailKit.IMailFolder.GetHeadersAsync(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  33670. <summary>
  33671. Asynchronously get the specified message headers.
  33672. </summary>
  33673. <remarks>
  33674. Asynchronously gets the specified message headers.
  33675. </remarks>
  33676. <returns>The message headers.</returns>
  33677. <param name="uid">The UID of the message.</param>
  33678. <param name="cancellationToken">The cancellation token.</param>
  33679. <param name="progress">The progress reporting mechanism.</param>
  33680. </member>
  33681. <member name="M:MailKit.IMailFolder.GetHeaders(MailKit.UniqueId,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  33682. <summary>
  33683. Get the specified body part headers.
  33684. </summary>
  33685. <remarks>
  33686. Gets the specified body part headers.
  33687. </remarks>
  33688. <returns>The body part headers.</returns>
  33689. <param name="uid">The UID of the message.</param>
  33690. <param name="part">The body part.</param>
  33691. <param name="cancellationToken">The cancellation token.</param>
  33692. <param name="progress">The progress reporting mechanism.</param>
  33693. </member>
  33694. <member name="M:MailKit.IMailFolder.GetHeadersAsync(MailKit.UniqueId,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  33695. <summary>
  33696. Asynchronously get the specified body part headers.
  33697. </summary>
  33698. <remarks>
  33699. Asynchronously gets the specified body part headers.
  33700. </remarks>
  33701. <returns>The body part headers.</returns>
  33702. <param name="uid">The UID of the message.</param>
  33703. <param name="part">The body part.</param>
  33704. <param name="cancellationToken">The cancellation token.</param>
  33705. <param name="progress">The progress reporting mechanism.</param>
  33706. </member>
  33707. <member name="M:MailKit.IMailFolder.GetHeaders(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  33708. <summary>
  33709. Get the specified message headers.
  33710. </summary>
  33711. <remarks>
  33712. Gets the specified message headers.
  33713. </remarks>
  33714. <returns>The message headers.</returns>
  33715. <param name="index">The index of the message.</param>
  33716. <param name="cancellationToken">The cancellation token.</param>
  33717. <param name="progress">The progress reporting mechanism.</param>
  33718. </member>
  33719. <member name="M:MailKit.IMailFolder.GetHeadersAsync(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  33720. <summary>
  33721. Asynchronously get the specified message headers.
  33722. </summary>
  33723. <remarks>
  33724. Asynchronously gets the specified message headers.
  33725. </remarks>
  33726. <returns>The message headers.</returns>
  33727. <param name="index">The index of the message.</param>
  33728. <param name="cancellationToken">The cancellation token.</param>
  33729. <param name="progress">The progress reporting mechanism.</param>
  33730. </member>
  33731. <member name="M:MailKit.IMailFolder.GetHeaders(System.Int32,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  33732. <summary>
  33733. Get the specified body part headers.
  33734. </summary>
  33735. <remarks>
  33736. Gets the specified body part headers.
  33737. </remarks>
  33738. <returns>The body part headers.</returns>
  33739. <param name="index">The index of the message.</param>
  33740. <param name="part">The body part.</param>
  33741. <param name="cancellationToken">The cancellation token.</param>
  33742. <param name="progress">The progress reporting mechanism.</param>
  33743. </member>
  33744. <member name="M:MailKit.IMailFolder.GetHeadersAsync(System.Int32,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  33745. <summary>
  33746. Asynchronously get the specified body part headers.
  33747. </summary>
  33748. <remarks>
  33749. Asynchronously gets the specified body part headers.
  33750. </remarks>
  33751. <returns>The body part headers.</returns>
  33752. <param name="index">The index of the message.</param>
  33753. <param name="part">The body part.</param>
  33754. <param name="cancellationToken">The cancellation token.</param>
  33755. <param name="progress">The progress reporting mechanism.</param>
  33756. </member>
  33757. <member name="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  33758. <summary>
  33759. Get the specified message.
  33760. </summary>
  33761. <remarks>
  33762. Gets the specified message.
  33763. </remarks>
  33764. <returns>The message.</returns>
  33765. <param name="uid">The UID of the message.</param>
  33766. <param name="cancellationToken">The cancellation token.</param>
  33767. <param name="progress">The progress reporting mechanism.</param>
  33768. </member>
  33769. <member name="M:MailKit.IMailFolder.GetMessageAsync(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  33770. <summary>
  33771. Asynchronously get the specified message.
  33772. </summary>
  33773. <remarks>
  33774. Asynchronously gets the specified message.
  33775. </remarks>
  33776. <returns>The message.</returns>
  33777. <param name="uid">The UID of the message.</param>
  33778. <param name="cancellationToken">The cancellation token.</param>
  33779. <param name="progress">The progress reporting mechanism.</param>
  33780. </member>
  33781. <member name="M:MailKit.IMailFolder.GetMessage(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  33782. <summary>
  33783. Get the specified message.
  33784. </summary>
  33785. <remarks>
  33786. Gets the specified message.
  33787. </remarks>
  33788. <returns>The message.</returns>
  33789. <param name="index">The index of the message.</param>
  33790. <param name="cancellationToken">The cancellation token.</param>
  33791. <param name="progress">The progress reporting mechanism.</param>
  33792. </member>
  33793. <member name="M:MailKit.IMailFolder.GetMessageAsync(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  33794. <summary>
  33795. Asynchronously get the specified message.
  33796. </summary>
  33797. <remarks>
  33798. Asynchronously gets the specified message.
  33799. </remarks>
  33800. <returns>The message.</returns>
  33801. <param name="index">The index of the message.</param>
  33802. <param name="cancellationToken">The cancellation token.</param>
  33803. <param name="progress">The progress reporting mechanism.</param>
  33804. </member>
  33805. <member name="M:MailKit.IMailFolder.GetBodyPart(MailKit.UniqueId,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  33806. <summary>
  33807. Get the specified body part.
  33808. </summary>
  33809. <remarks>
  33810. Gets the specified body part.
  33811. </remarks>
  33812. <example>
  33813. <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
  33814. </example>
  33815. <returns>The body part.</returns>
  33816. <param name="uid">The UID of the message.</param>
  33817. <param name="part">The body part.</param>
  33818. <param name="cancellationToken">The cancellation token.</param>
  33819. <param name="progress">The progress reporting mechanism.</param>
  33820. </member>
  33821. <member name="M:MailKit.IMailFolder.GetBodyPartAsync(MailKit.UniqueId,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  33822. <summary>
  33823. Asynchronously get the specified body part.
  33824. </summary>
  33825. <remarks>
  33826. Asynchronously gets the specified body part.
  33827. </remarks>
  33828. <returns>The body part.</returns>
  33829. <param name="uid">The UID of the message.</param>
  33830. <param name="part">The body part.</param>
  33831. <param name="cancellationToken">The cancellation token.</param>
  33832. <param name="progress">The progress reporting mechanism.</param>
  33833. </member>
  33834. <member name="M:MailKit.IMailFolder.GetBodyPart(System.Int32,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  33835. <summary>
  33836. Get the specified body part.
  33837. </summary>
  33838. <remarks>
  33839. Gets the specified body part.
  33840. </remarks>
  33841. <returns>The body part.</returns>
  33842. <param name="index">The index of the message.</param>
  33843. <param name="part">The body part.</param>
  33844. <param name="cancellationToken">The cancellation token.</param>
  33845. <param name="progress">The progress reporting mechanism.</param>
  33846. </member>
  33847. <member name="M:MailKit.IMailFolder.GetBodyPartAsync(System.Int32,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  33848. <summary>
  33849. Asynchronously get the specified body part.
  33850. </summary>
  33851. <remarks>
  33852. Asynchronously gets the specified body part.
  33853. </remarks>
  33854. <returns>The body part.</returns>
  33855. <param name="index">The index of the message.</param>
  33856. <param name="part">The body part.</param>
  33857. <param name="cancellationToken">The cancellation token.</param>
  33858. <param name="progress">The progress reporting mechanism.</param>
  33859. </member>
  33860. <member name="M:MailKit.IMailFolder.GetStream(MailKit.UniqueId,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  33861. <summary>
  33862. Get a substream of the specified message.
  33863. </summary>
  33864. <remarks>
  33865. Gets a substream of the message. If the starting offset is beyond
  33866. the end of the message, an empty stream is returned. If the number of
  33867. bytes desired extends beyond the end of the message, a truncated stream
  33868. will be returned.
  33869. </remarks>
  33870. <returns>The stream.</returns>
  33871. <param name="uid">The UID of the message.</param>
  33872. <param name="offset">The starting offset of the first desired byte.</param>
  33873. <param name="count">The number of bytes desired.</param>
  33874. <param name="cancellationToken">The cancellation token.</param>
  33875. <param name="progress">The progress reporting mechanism.</param>
  33876. </member>
  33877. <member name="M:MailKit.IMailFolder.GetStreamAsync(MailKit.UniqueId,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  33878. <summary>
  33879. Asynchronously get a substream of the specified message.
  33880. </summary>
  33881. <remarks>
  33882. Asynchronously gets a substream of the message. If the starting offset is beyond
  33883. the end of the message, an empty stream is returned. If the number of
  33884. bytes desired extends beyond the end of the message, a truncated stream
  33885. will be returned.
  33886. </remarks>
  33887. <returns>The stream.</returns>
  33888. <param name="uid">The UID of the message.</param>
  33889. <param name="offset">The starting offset of the first desired byte.</param>
  33890. <param name="count">The number of bytes desired.</param>
  33891. <param name="cancellationToken">The cancellation token.</param>
  33892. <param name="progress">The progress reporting mechanism.</param>
  33893. </member>
  33894. <member name="M:MailKit.IMailFolder.GetStream(System.Int32,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  33895. <summary>
  33896. Get a substream of the specified message.
  33897. </summary>
  33898. <remarks>
  33899. Gets a substream of the message. If the starting offset is beyond
  33900. the end of the message, an empty stream is returned. If the number of
  33901. bytes desired extends beyond the end of the message, a truncated stream
  33902. will be returned.
  33903. </remarks>
  33904. <returns>The stream.</returns>
  33905. <param name="index">The index of the message.</param>
  33906. <param name="offset">The starting offset of the first desired byte.</param>
  33907. <param name="count">The number of bytes desired.</param>
  33908. <param name="cancellationToken">The cancellation token.</param>
  33909. <param name="progress">The progress reporting mechanism.</param>
  33910. </member>
  33911. <member name="M:MailKit.IMailFolder.GetStreamAsync(System.Int32,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  33912. <summary>
  33913. Asynchronously get a substream of the specified message.
  33914. </summary>
  33915. <remarks>
  33916. Asynchronously gets a substream of the message. If the starting offset is beyond
  33917. the end of the message, an empty stream is returned. If the number of
  33918. bytes desired extends beyond the end of the message, a truncated stream
  33919. will be returned.
  33920. </remarks>
  33921. <returns>The stream.</returns>
  33922. <param name="index">The index of the message.</param>
  33923. <param name="offset">The starting offset of the first desired byte.</param>
  33924. <param name="count">The number of bytes desired.</param>
  33925. <param name="cancellationToken">The cancellation token.</param>
  33926. <param name="progress">The progress reporting mechanism.</param>
  33927. </member>
  33928. <member name="M:MailKit.IMailFolder.GetStream(MailKit.UniqueId,MailKit.BodyPart,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  33929. <summary>
  33930. Get a substream of the specified body part.
  33931. </summary>
  33932. <remarks>
  33933. Gets a substream of the body part. If the starting offset is beyond
  33934. the end of the body part, an empty stream is returned. If the number of
  33935. bytes desired extends beyond the end of the body part, a truncated stream
  33936. will be returned.
  33937. </remarks>
  33938. <returns>The stream.</returns>
  33939. <param name="uid">The UID of the message.</param>
  33940. <param name="part">The desired body part.</param>
  33941. <param name="offset">The starting offset of the first desired byte.</param>
  33942. <param name="count">The number of bytes desired.</param>
  33943. <param name="cancellationToken">The cancellation token.</param>
  33944. <param name="progress">The progress reporting mechanism.</param>
  33945. </member>
  33946. <member name="M:MailKit.IMailFolder.GetStreamAsync(MailKit.UniqueId,MailKit.BodyPart,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  33947. <summary>
  33948. Asynchronously get a substream of the specified body part.
  33949. </summary>
  33950. <remarks>
  33951. Asynchronously gets a substream of the body part. If the starting offset is beyond
  33952. the end of the body part, an empty stream is returned. If the number of
  33953. bytes desired extends beyond the end of the body part, a truncated stream
  33954. will be returned.
  33955. </remarks>
  33956. <returns>The stream.</returns>
  33957. <param name="uid">The UID of the message.</param>
  33958. <param name="part">The desired body part.</param>
  33959. <param name="offset">The starting offset of the first desired byte.</param>
  33960. <param name="count">The number of bytes desired.</param>
  33961. <param name="cancellationToken">The cancellation token.</param>
  33962. <param name="progress">The progress reporting mechanism.</param>
  33963. </member>
  33964. <member name="M:MailKit.IMailFolder.GetStream(System.Int32,MailKit.BodyPart,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  33965. <summary>
  33966. Get a substream of the specified body part.
  33967. </summary>
  33968. <remarks>
  33969. Gets a substream of the body part. If the starting offset is beyond
  33970. the end of the body part, an empty stream is returned. If the number of
  33971. bytes desired extends beyond the end of the body part, a truncated stream
  33972. will be returned.
  33973. </remarks>
  33974. <returns>The stream.</returns>
  33975. <param name="index">The index of the message.</param>
  33976. <param name="part">The desired body part.</param>
  33977. <param name="offset">The starting offset of the first desired byte.</param>
  33978. <param name="count">The number of bytes desired.</param>
  33979. <param name="cancellationToken">The cancellation token.</param>
  33980. <param name="progress">The progress reporting mechanism.</param>
  33981. </member>
  33982. <member name="M:MailKit.IMailFolder.GetStreamAsync(System.Int32,MailKit.BodyPart,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  33983. <summary>
  33984. Asynchronously get a substream of the specified body part.
  33985. </summary>
  33986. <remarks>
  33987. Asynchronously gets a substream of the body part. If the starting offset is beyond
  33988. the end of the body part, an empty stream is returned. If the number of
  33989. bytes desired extends beyond the end of the body part, a truncated stream
  33990. will be returned.
  33991. </remarks>
  33992. <returns>The stream.</returns>
  33993. <param name="index">The index of the message.</param>
  33994. <param name="part">The desired body part.</param>
  33995. <param name="offset">The starting offset of the first desired byte.</param>
  33996. <param name="count">The number of bytes desired.</param>
  33997. <param name="cancellationToken">The cancellation token.</param>
  33998. <param name="progress">The progress reporting mechanism.</param>
  33999. </member>
  34000. <member name="M:MailKit.IMailFolder.GetStream(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  34001. <summary>
  34002. Get a substream of the specified message.
  34003. </summary>
  34004. <remarks>
  34005. <para>Gets a substream of the specified message.</para>
  34006. <para>For more information about how to construct the <paramref name="section"/>,
  34007. see Section 6.4.5 of RFC3501.</para>
  34008. </remarks>
  34009. <returns>The stream.</returns>
  34010. <param name="uid">The UID of the message.</param>
  34011. <param name="section">The desired section of the message.</param>
  34012. <param name="cancellationToken">The cancellation token.</param>
  34013. <param name="progress">The progress reporting mechanism.</param>
  34014. </member>
  34015. <member name="M:MailKit.IMailFolder.GetStreamAsync(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  34016. <summary>
  34017. Asynchronously get a substream of the specified message.
  34018. </summary>
  34019. <remarks>
  34020. <para>Asynchronously gets a substream of the specified message.</para>
  34021. <para>For more information about how to construct the <paramref name="section"/>,
  34022. see Section 6.4.5 of RFC3501.</para>
  34023. </remarks>
  34024. <returns>The stream.</returns>
  34025. <param name="uid">The UID of the message.</param>
  34026. <param name="section">The desired section of the message.</param>
  34027. <param name="cancellationToken">The cancellation token.</param>
  34028. <param name="progress">The progress reporting mechanism.</param>
  34029. </member>
  34030. <member name="M:MailKit.IMailFolder.GetStream(MailKit.UniqueId,System.String,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  34031. <summary>
  34032. Get a substream of the specified message.
  34033. </summary>
  34034. <remarks>
  34035. <para>Gets a substream of the specified message. If the starting offset is beyond
  34036. the end of the specified section of the message, an empty stream is returned. If
  34037. the number of bytes desired extends beyond the end of the section, a truncated
  34038. stream will be returned.</para>
  34039. <para>For more information about how to construct the <paramref name="section"/>,
  34040. see Section 6.4.5 of RFC3501.</para>
  34041. </remarks>
  34042. <returns>The stream.</returns>
  34043. <param name="uid">The UID of the message.</param>
  34044. <param name="section">The desired section of the message.</param>
  34045. <param name="offset">The starting offset of the first desired byte.</param>
  34046. <param name="count">The number of bytes desired.</param>
  34047. <param name="cancellationToken">The cancellation token.</param>
  34048. <param name="progress">The progress reporting mechanism.</param>
  34049. </member>
  34050. <member name="M:MailKit.IMailFolder.GetStreamAsync(MailKit.UniqueId,System.String,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  34051. <summary>
  34052. Asynchronously get a substream of the specified message.
  34053. </summary>
  34054. <remarks>
  34055. <para>Asynchronously gets a substream of the specified message. If the starting
  34056. offset is beyond the end of the specified section of the message, an empty stream
  34057. is returned. If the number of bytes desired extends beyond the end of the section,
  34058. a truncated stream will be returned.</para>
  34059. <para>For more information about how to construct the <paramref name="section"/>,
  34060. see Section 6.4.5 of RFC3501.</para>
  34061. </remarks>
  34062. <returns>The stream.</returns>
  34063. <param name="uid">The UID of the message.</param>
  34064. <param name="section">The desired section of the message.</param>
  34065. <param name="offset">The starting offset of the first desired byte.</param>
  34066. <param name="count">The number of bytes desired.</param>
  34067. <param name="cancellationToken">The cancellation token.</param>
  34068. <param name="progress">The progress reporting mechanism.</param>
  34069. </member>
  34070. <member name="M:MailKit.IMailFolder.GetStream(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  34071. <summary>
  34072. Get a substream of the specified message.
  34073. </summary>
  34074. <remarks>
  34075. <para>Gets a substream of the specified message.</para>
  34076. <para>For more information about how to construct the <paramref name="section"/>,
  34077. see Section 6.4.5 of RFC3501.</para>
  34078. </remarks>
  34079. <returns>The stream.</returns>
  34080. <param name="index">The index of the message.</param>
  34081. <param name="section">The desired section of the message.</param>
  34082. <param name="cancellationToken">The cancellation token.</param>
  34083. <param name="progress">The progress reporting mechanism.</param>
  34084. </member>
  34085. <member name="M:MailKit.IMailFolder.GetStreamAsync(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  34086. <summary>
  34087. Asynchronously get a substream of the specified message.
  34088. </summary>
  34089. <remarks>
  34090. <para>Asynchronously gets a substream of the specified message.</para>
  34091. <para>For more information about how to construct the <paramref name="section"/>,
  34092. see Section 6.4.5 of RFC3501.</para>
  34093. </remarks>
  34094. <returns>The stream.</returns>
  34095. <param name="index">The index of the message.</param>
  34096. <param name="section">The desired section of the message.</param>
  34097. <param name="cancellationToken">The cancellation token.</param>
  34098. <param name="progress">The progress reporting mechanism.</param>
  34099. </member>
  34100. <member name="M:MailKit.IMailFolder.GetStream(System.Int32,System.String,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  34101. <summary>
  34102. Get a substream of the specified message.
  34103. </summary>
  34104. <remarks>
  34105. <para>Gets a substream of the specified message. If the starting offset is beyond
  34106. the end of the specified section of the message, an empty stream is returned. If
  34107. the number of bytes desired extends beyond the end of the section, a truncated
  34108. stream will be returned.</para>
  34109. <para>For more information about how to construct the <paramref name="section"/>,
  34110. see Section 6.4.5 of RFC3501.</para>
  34111. </remarks>
  34112. <returns>The stream.</returns>
  34113. <param name="index">The index of the message.</param>
  34114. <param name="section">The desired section of the message.</param>
  34115. <param name="offset">The starting offset of the first desired byte.</param>
  34116. <param name="count">The number of bytes desired.</param>
  34117. <param name="cancellationToken">The cancellation token.</param>
  34118. <param name="progress">The progress reporting mechanism.</param>
  34119. </member>
  34120. <member name="M:MailKit.IMailFolder.GetStreamAsync(System.Int32,System.String,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  34121. <summary>
  34122. Asynchronously get a substream of the specified message.
  34123. </summary>
  34124. <remarks>
  34125. <para>Asynchronously gets a substream of the specified message. If the starting
  34126. offset is beyond the end of the specified section of the message, an empty stream
  34127. is returned. If the number of bytes desired extends beyond the end of the section,
  34128. a truncated stream will be returned.</para>
  34129. <para>For more information about how to construct the <paramref name="section"/>,
  34130. see Section 6.4.5 of RFC3501.</para>
  34131. </remarks>
  34132. <returns>The stream.</returns>
  34133. <param name="index">The index of the message.</param>
  34134. <param name="section">The desired section of the message.</param>
  34135. <param name="offset">The starting offset of the first desired byte.</param>
  34136. <param name="count">The number of bytes desired.</param>
  34137. <param name="cancellationToken">The cancellation token.</param>
  34138. <param name="progress">The progress reporting mechanism.</param>
  34139. </member>
  34140. <member name="M:MailKit.IMailFolder.AddFlags(MailKit.UniqueId,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  34141. <summary>
  34142. Add a set of flags to the specified message.
  34143. </summary>
  34144. <remarks>
  34145. Adds a set of flags to the specified message.
  34146. </remarks>
  34147. <param name="uid">The UID of the message.</param>
  34148. <param name="flags">The message flags to add.</param>
  34149. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34150. <param name="cancellationToken">The cancellation token.</param>
  34151. </member>
  34152. <member name="M:MailKit.IMailFolder.AddFlagsAsync(MailKit.UniqueId,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  34153. <summary>
  34154. Asynchronously add a set of flags to the specified message.
  34155. </summary>
  34156. <remarks>
  34157. Asynchronously adds a set of flags to the specified message.
  34158. </remarks>
  34159. <returns>An asynchronous task context.</returns>
  34160. <param name="uid">The UIDs of the message.</param>
  34161. <param name="flags">The message flags to add.</param>
  34162. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34163. <param name="cancellationToken">The cancellation token.</param>
  34164. </member>
  34165. <member name="M:MailKit.IMailFolder.AddFlags(MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  34166. <summary>
  34167. Add a set of flags to the specified message.
  34168. </summary>
  34169. <remarks>
  34170. Adds a set of flags to the specified message.
  34171. </remarks>
  34172. <param name="uid">The UID of the message.</param>
  34173. <param name="flags">The message flags to add.</param>
  34174. <param name="keywords">A set of user-defined flags to add.</param>
  34175. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34176. <param name="cancellationToken">The cancellation token.</param>
  34177. </member>
  34178. <member name="M:MailKit.IMailFolder.AddFlagsAsync(MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  34179. <summary>
  34180. Asynchronously add a set of flags to the specified message.
  34181. </summary>
  34182. <remarks>
  34183. Asynchronously adds a set of flags to the specified message.
  34184. </remarks>
  34185. <returns>An asynchronous task context.</returns>
  34186. <param name="uid">The UIDs of the message.</param>
  34187. <param name="flags">The message flags to add.</param>
  34188. <param name="keywords">A set of user-defined flags to add.</param>
  34189. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34190. <param name="cancellationToken">The cancellation token.</param>
  34191. </member>
  34192. <member name="M:MailKit.IMailFolder.AddFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  34193. <summary>
  34194. Add a set of flags to the specified messages.
  34195. </summary>
  34196. <remarks>
  34197. Adds a set of flags to the specified messages.
  34198. </remarks>
  34199. <param name="uids">The UIDs of the messages.</param>
  34200. <param name="flags">The message flags to add.</param>
  34201. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34202. <param name="cancellationToken">The cancellation token.</param>
  34203. </member>
  34204. <member name="M:MailKit.IMailFolder.AddFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  34205. <summary>
  34206. Asynchronously add a set of flags to the specified messages.
  34207. </summary>
  34208. <remarks>
  34209. Asynchronously adds a set of flags to the specified messages.
  34210. </remarks>
  34211. <returns>An asynchronous task context.</returns>
  34212. <param name="uids">The UIDs of the messages.</param>
  34213. <param name="flags">The message flags to add.</param>
  34214. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34215. <param name="cancellationToken">The cancellation token.</param>
  34216. </member>
  34217. <member name="M:MailKit.IMailFolder.AddFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  34218. <summary>
  34219. Add a set of flags to the specified messages.
  34220. </summary>
  34221. <remarks>
  34222. Adds a set of flags to the specified messages.
  34223. </remarks>
  34224. <param name="uids">The UIDs of the messages.</param>
  34225. <param name="flags">The message flags to add.</param>
  34226. <param name="keywords">A set of user-defined flags to add.</param>
  34227. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34228. <param name="cancellationToken">The cancellation token.</param>
  34229. </member>
  34230. <member name="M:MailKit.IMailFolder.AddFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  34231. <summary>
  34232. Asynchronously add a set of flags to the specified messages.
  34233. </summary>
  34234. <remarks>
  34235. Asynchronously adds a set of flags to the specified messages.
  34236. </remarks>
  34237. <returns>An asynchronous task context.</returns>
  34238. <param name="uids">The UIDs of the messages.</param>
  34239. <param name="flags">The message flags to add.</param>
  34240. <param name="keywords">A set of user-defined flags to add.</param>
  34241. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34242. <param name="cancellationToken">The cancellation token.</param>
  34243. </member>
  34244. <member name="M:MailKit.IMailFolder.RemoveFlags(MailKit.UniqueId,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  34245. <summary>
  34246. Remove a set of flags from the specified message.
  34247. </summary>
  34248. <remarks>
  34249. Removes a set of flags from the specified message.
  34250. </remarks>
  34251. <param name="uid">The UID of the message.</param>
  34252. <param name="flags">The message flags to remove.</param>
  34253. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34254. <param name="cancellationToken">The cancellation token.</param>
  34255. </member>
  34256. <member name="M:MailKit.IMailFolder.RemoveFlagsAsync(MailKit.UniqueId,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  34257. <summary>
  34258. Asynchronously remove a set of flags from the specified message.
  34259. </summary>
  34260. <remarks>
  34261. Asynchronously removes a set of flags from the specified message.
  34262. </remarks>
  34263. <returns>An asynchronous task context.</returns>
  34264. <param name="uid">The UID of the message.</param>
  34265. <param name="flags">The message flags to remove.</param>
  34266. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34267. <param name="cancellationToken">The cancellation token.</param>
  34268. </member>
  34269. <member name="M:MailKit.IMailFolder.RemoveFlags(MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  34270. <summary>
  34271. Remove a set of flags from the specified message.
  34272. </summary>
  34273. <remarks>
  34274. Removes a set of flags from the specified message.
  34275. </remarks>
  34276. <param name="uid">The UID of the message.</param>
  34277. <param name="flags">The message flags to remove.</param>
  34278. <param name="keywords">A set of user-defined flags to remove.</param>
  34279. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34280. <param name="cancellationToken">The cancellation token.</param>
  34281. </member>
  34282. <member name="M:MailKit.IMailFolder.RemoveFlagsAsync(MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  34283. <summary>
  34284. Asynchronously remove a set of flags from the specified message.
  34285. </summary>
  34286. <remarks>
  34287. Asynchronously removes a set of flags from the specified message.
  34288. </remarks>
  34289. <returns>An asynchronous task context.</returns>
  34290. <param name="uid">The UID of the message.</param>
  34291. <param name="flags">The message flags to remove.</param>
  34292. <param name="keywords">A set of user-defined flags to remove.</param>
  34293. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34294. <param name="cancellationToken">The cancellation token.</param>
  34295. </member>
  34296. <member name="M:MailKit.IMailFolder.RemoveFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  34297. <summary>
  34298. Remove a set of flags from the specified messages.
  34299. </summary>
  34300. <remarks>
  34301. Removes a set of flags from the specified messages.
  34302. </remarks>
  34303. <param name="uids">The UIDs of the messages.</param>
  34304. <param name="flags">The message flags to remove.</param>
  34305. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34306. <param name="cancellationToken">The cancellation token.</param>
  34307. </member>
  34308. <member name="M:MailKit.IMailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  34309. <summary>
  34310. Asynchronously remove a set of flags from the specified messages.
  34311. </summary>
  34312. <remarks>
  34313. Asynchronously removes a set of flags from the specified messages.
  34314. </remarks>
  34315. <returns>An asynchronous task context.</returns>
  34316. <param name="uids">The UIDs of the messages.</param>
  34317. <param name="flags">The message flags to remove.</param>
  34318. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34319. <param name="cancellationToken">The cancellation token.</param>
  34320. </member>
  34321. <member name="M:MailKit.IMailFolder.RemoveFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  34322. <summary>
  34323. Remove a set of flags from the specified messages.
  34324. </summary>
  34325. <remarks>
  34326. Removes a set of flags from the specified messages.
  34327. </remarks>
  34328. <param name="uids">The UIDs of the messages.</param>
  34329. <param name="flags">The message flags to remove.</param>
  34330. <param name="keywords">A set of user-defined flags to remove.</param>
  34331. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34332. <param name="cancellationToken">The cancellation token.</param>
  34333. </member>
  34334. <member name="M:MailKit.IMailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  34335. <summary>
  34336. Asynchronously remove a set of flags from the specified messages.
  34337. </summary>
  34338. <remarks>
  34339. Asynchronously removes a set of flags from the specified messages.
  34340. </remarks>
  34341. <returns>An asynchronous task context.</returns>
  34342. <param name="uids">The UIDs of the messages.</param>
  34343. <param name="flags">The message flags to remove.</param>
  34344. <param name="keywords">A set of user-defined flags to remove.</param>
  34345. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34346. <param name="cancellationToken">The cancellation token.</param>
  34347. </member>
  34348. <member name="M:MailKit.IMailFolder.SetFlags(MailKit.UniqueId,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  34349. <summary>
  34350. Set the flags of the specified message.
  34351. </summary>
  34352. <remarks>
  34353. Sets the flags of the specified message.
  34354. </remarks>
  34355. <param name="uid">The UID of the message.</param>
  34356. <param name="flags">The message flags to set.</param>
  34357. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34358. <param name="cancellationToken">The cancellation token.</param>
  34359. </member>
  34360. <member name="M:MailKit.IMailFolder.SetFlagsAsync(MailKit.UniqueId,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  34361. <summary>
  34362. Asynchronously set the flags of the specified message.
  34363. </summary>
  34364. <remarks>
  34365. Asynchronously sets the flags of the specified message.
  34366. </remarks>
  34367. <returns>An asynchronous task context.</returns>
  34368. <param name="uid">The UID of the message.</param>
  34369. <param name="flags">The message flags to set.</param>
  34370. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34371. <param name="cancellationToken">The cancellation token.</param>
  34372. </member>
  34373. <member name="M:MailKit.IMailFolder.SetFlags(MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  34374. <summary>
  34375. Set the flags of the specified message.
  34376. </summary>
  34377. <remarks>
  34378. Sets the flags of the specified message.
  34379. </remarks>
  34380. <param name="uid">The UID of the message.</param>
  34381. <param name="flags">The message flags to set.</param>
  34382. <param name="keywords">A set of user-defined flags to set.</param>
  34383. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34384. <param name="cancellationToken">The cancellation token.</param>
  34385. </member>
  34386. <member name="M:MailKit.IMailFolder.SetFlagsAsync(MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  34387. <summary>
  34388. Asynchronously set the flags of the specified message.
  34389. </summary>
  34390. <remarks>
  34391. Asynchronously sets the flags of the specified message.
  34392. </remarks>
  34393. <returns>An asynchronous task context.</returns>
  34394. <param name="uid">The UID of the message.</param>
  34395. <param name="flags">The message flags to set.</param>
  34396. <param name="keywords">A set of user-defined flags to set.</param>
  34397. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34398. <param name="cancellationToken">The cancellation token.</param>
  34399. </member>
  34400. <member name="M:MailKit.IMailFolder.SetFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  34401. <summary>
  34402. Set the flags of the specified messages.
  34403. </summary>
  34404. <remarks>
  34405. Sets the flags of the specified messages.
  34406. </remarks>
  34407. <param name="uids">The UIDs of the messages.</param>
  34408. <param name="flags">The message flags to set.</param>
  34409. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34410. <param name="cancellationToken">The cancellation token.</param>
  34411. </member>
  34412. <member name="M:MailKit.IMailFolder.SetFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  34413. <summary>
  34414. Asynchronously set the flags of the specified messages.
  34415. </summary>
  34416. <remarks>
  34417. Asynchronously sets the flags of the specified messages.
  34418. </remarks>
  34419. <returns>An asynchronous task context.</returns>
  34420. <param name="uids">The UIDs of the messages.</param>
  34421. <param name="flags">The message flags to set.</param>
  34422. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34423. <param name="cancellationToken">The cancellation token.</param>
  34424. </member>
  34425. <member name="M:MailKit.IMailFolder.SetFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  34426. <summary>
  34427. Set the flags of the specified messages.
  34428. </summary>
  34429. <remarks>
  34430. Sets the flags of the specified messages.
  34431. </remarks>
  34432. <param name="uids">The UIDs of the messages.</param>
  34433. <param name="flags">The message flags to set.</param>
  34434. <param name="keywords">A set of user-defined flags to set.</param>
  34435. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34436. <param name="cancellationToken">The cancellation token.</param>
  34437. </member>
  34438. <member name="M:MailKit.IMailFolder.SetFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  34439. <summary>
  34440. Asynchronously set the flags of the specified messages.
  34441. </summary>
  34442. <remarks>
  34443. Asynchronously sets the flags of the specified messages.
  34444. </remarks>
  34445. <returns>An asynchronous task context.</returns>
  34446. <param name="uids">The UIDs of the messages.</param>
  34447. <param name="flags">The message flags to set.</param>
  34448. <param name="keywords">A set of user-defined flags to set.</param>
  34449. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34450. <param name="cancellationToken">The cancellation token.</param>
  34451. </member>
  34452. <member name="M:MailKit.IMailFolder.AddFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  34453. <summary>
  34454. Add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
  34455. </summary>
  34456. <remarks>
  34457. Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
  34458. </remarks>
  34459. <returns>The unique IDs of the messages that were not updated.</returns>
  34460. <param name="uids">The UIDs of the messages.</param>
  34461. <param name="modseq">The mod-sequence value.</param>
  34462. <param name="flags">The message flags to add.</param>
  34463. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34464. <param name="cancellationToken">The cancellation token.</param>
  34465. </member>
  34466. <member name="M:MailKit.IMailFolder.AddFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  34467. <summary>
  34468. Asynchronously add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
  34469. </summary>
  34470. <remarks>
  34471. Asynchronously adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
  34472. </remarks>
  34473. <returns>The unique IDs of the messages that were not updated.</returns>
  34474. <param name="uids">The UIDs of the messages.</param>
  34475. <param name="modseq">The mod-sequence value.</param>
  34476. <param name="flags">The message flags to add.</param>
  34477. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34478. <param name="cancellationToken">The cancellation token.</param>
  34479. </member>
  34480. <member name="M:MailKit.IMailFolder.AddFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  34481. <summary>
  34482. Add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
  34483. </summary>
  34484. <remarks>
  34485. Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
  34486. </remarks>
  34487. <returns>The unique IDs of the messages that were not updated.</returns>
  34488. <param name="uids">The UIDs of the messages.</param>
  34489. <param name="modseq">The mod-sequence value.</param>
  34490. <param name="flags">The message flags to add.</param>
  34491. <param name="keywords">A set of user-defined flags to set.</param>
  34492. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34493. <param name="cancellationToken">The cancellation token.</param>
  34494. </member>
  34495. <member name="M:MailKit.IMailFolder.AddFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  34496. <summary>
  34497. Asynchronously add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
  34498. </summary>
  34499. <remarks>
  34500. Asynchronously adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
  34501. </remarks>
  34502. <returns>The unique IDs of the messages that were not updated.</returns>
  34503. <param name="uids">The UIDs of the messages.</param>
  34504. <param name="modseq">The mod-sequence value.</param>
  34505. <param name="flags">The message flags to add.</param>
  34506. <param name="keywords">A set of user-defined flags to set.</param>
  34507. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34508. <param name="cancellationToken">The cancellation token.</param>
  34509. </member>
  34510. <member name="M:MailKit.IMailFolder.RemoveFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  34511. <summary>
  34512. Remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
  34513. </summary>
  34514. <remarks>
  34515. Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
  34516. </remarks>
  34517. <returns>The unique IDs of the messages that were not updated.</returns>
  34518. <param name="uids">The UIDs of the messages.</param>
  34519. <param name="modseq">The mod-sequence value.</param>
  34520. <param name="flags">The message flags to remove.</param>
  34521. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34522. <param name="cancellationToken">The cancellation token.</param>
  34523. </member>
  34524. <member name="M:MailKit.IMailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  34525. <summary>
  34526. Asynchronously remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
  34527. </summary>
  34528. <remarks>
  34529. Asynchronously removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
  34530. </remarks>
  34531. <returns>The unique IDs of the messages that were not updated.</returns>
  34532. <param name="uids">The UIDs of the messages.</param>
  34533. <param name="modseq">The mod-sequence value.</param>
  34534. <param name="flags">The message flags to remove.</param>
  34535. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34536. <param name="cancellationToken">The cancellation token.</param>
  34537. </member>
  34538. <member name="M:MailKit.IMailFolder.RemoveFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  34539. <summary>
  34540. Remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
  34541. </summary>
  34542. <remarks>
  34543. Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
  34544. </remarks>
  34545. <returns>The unique IDs of the messages that were not updated.</returns>
  34546. <param name="uids">The UIDs of the messages.</param>
  34547. <param name="modseq">The mod-sequence value.</param>
  34548. <param name="flags">The message flags to remove.</param>
  34549. <param name="keywords">A set of user-defined flags to remove.</param>
  34550. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34551. <param name="cancellationToken">The cancellation token.</param>
  34552. </member>
  34553. <member name="M:MailKit.IMailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  34554. <summary>
  34555. Asynchronously remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
  34556. </summary>
  34557. <remarks>
  34558. Asynchronously removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
  34559. </remarks>
  34560. <returns>The unique IDs of the messages that were not updated.</returns>
  34561. <param name="uids">The UIDs of the messages.</param>
  34562. <param name="modseq">The mod-sequence value.</param>
  34563. <param name="flags">The message flags to remove.</param>
  34564. <param name="keywords">A set of user-defined flags to remove.</param>
  34565. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34566. <param name="cancellationToken">The cancellation token.</param>
  34567. </member>
  34568. <member name="M:MailKit.IMailFolder.SetFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  34569. <summary>
  34570. Set the flags of the specified messages only if their mod-sequence value is less than the specified value.
  34571. </summary>
  34572. <remarks>
  34573. Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
  34574. </remarks>
  34575. <returns>The unique IDs of the messages that were not updated.</returns>
  34576. <param name="uids">The UIDs of the messages.</param>
  34577. <param name="modseq">The mod-sequence value.</param>
  34578. <param name="flags">The message flags to set.</param>
  34579. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34580. <param name="cancellationToken">The cancellation token.</param>
  34581. </member>
  34582. <member name="M:MailKit.IMailFolder.SetFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  34583. <summary>
  34584. Asynchronously set the flags of the specified messages only if their mod-sequence value is less than the specified value.
  34585. </summary>
  34586. <remarks>
  34587. Asynchronously sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
  34588. </remarks>
  34589. <returns>The unique IDs of the messages that were not updated.</returns>
  34590. <param name="uids">The UIDs of the messages.</param>
  34591. <param name="modseq">The mod-sequence value.</param>
  34592. <param name="flags">The message flags to set.</param>
  34593. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34594. <param name="cancellationToken">The cancellation token.</param>
  34595. </member>
  34596. <member name="M:MailKit.IMailFolder.SetFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  34597. <summary>
  34598. Set the flags of the specified messages only if their mod-sequence value is less than the specified value.
  34599. </summary>
  34600. <remarks>
  34601. Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
  34602. </remarks>
  34603. <returns>The unique IDs of the messages that were not updated.</returns>
  34604. <param name="uids">The UIDs of the messages.</param>
  34605. <param name="modseq">The mod-sequence value.</param>
  34606. <param name="flags">The message flags to set.</param>
  34607. <param name="keywords">A set of user-defined flags to set.</param>
  34608. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34609. <param name="cancellationToken">The cancellation token.</param>
  34610. </member>
  34611. <member name="M:MailKit.IMailFolder.SetFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  34612. <summary>
  34613. Asynchronously set the flags of the specified messages only if their mod-sequence value is less than the specified value.
  34614. </summary>
  34615. <remarks>
  34616. Asynchronously sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
  34617. </remarks>
  34618. <returns>The unique IDs of the messages that were not updated.</returns>
  34619. <param name="uids">The UIDs of the messages.</param>
  34620. <param name="modseq">The mod-sequence value.</param>
  34621. <param name="flags">The message flags to set.</param>
  34622. <param name="keywords">A set of user-defined flags to set.</param>
  34623. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34624. <param name="cancellationToken">The cancellation token.</param>
  34625. </member>
  34626. <member name="M:MailKit.IMailFolder.AddFlags(System.Int32,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  34627. <summary>
  34628. Add a set of flags to the specified message.
  34629. </summary>
  34630. <remarks>
  34631. Adds a set of flags to the specified message.
  34632. </remarks>
  34633. <param name="index">The index of the message.</param>
  34634. <param name="flags">The message flags to add.</param>
  34635. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34636. <param name="cancellationToken">The cancellation token.</param>
  34637. </member>
  34638. <member name="M:MailKit.IMailFolder.AddFlagsAsync(System.Int32,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  34639. <summary>
  34640. Asynchronously add a set of flags to the specified message.
  34641. </summary>
  34642. <remarks>
  34643. Asynchronously adds a set of flags to the specified message.
  34644. </remarks>
  34645. <returns>An asynchronous task context.</returns>
  34646. <param name="index">The index of the message.</param>
  34647. <param name="flags">The message flags to add.</param>
  34648. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34649. <param name="cancellationToken">The cancellation token.</param>
  34650. </member>
  34651. <member name="M:MailKit.IMailFolder.AddFlags(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  34652. <summary>
  34653. Add a set of flags to the specified message.
  34654. </summary>
  34655. <remarks>
  34656. Adds a set of flags to the specified message.
  34657. </remarks>
  34658. <param name="index">The index of the message.</param>
  34659. <param name="flags">The message flags to add.</param>
  34660. <param name="keywords">A set of user-defined flags to add.</param>
  34661. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34662. <param name="cancellationToken">The cancellation token.</param>
  34663. </member>
  34664. <member name="M:MailKit.IMailFolder.AddFlagsAsync(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  34665. <summary>
  34666. Asynchronously add a set of flags to the specified message.
  34667. </summary>
  34668. <remarks>
  34669. Asynchronously adds a set of flags to the specified message.
  34670. </remarks>
  34671. <returns>An asynchronous task context.</returns>
  34672. <param name="index">The index of the message.</param>
  34673. <param name="flags">The message flags to add.</param>
  34674. <param name="keywords">A set of user-defined flags to add.</param>
  34675. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34676. <param name="cancellationToken">The cancellation token.</param>
  34677. </member>
  34678. <member name="M:MailKit.IMailFolder.AddFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  34679. <summary>
  34680. Add a set of flags to the specified messages.
  34681. </summary>
  34682. <remarks>
  34683. Adds a set of flags to the specified messages.
  34684. </remarks>
  34685. <param name="indexes">The indexes of the messages.</param>
  34686. <param name="flags">The message flags to add.</param>
  34687. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34688. <param name="cancellationToken">The cancellation token.</param>
  34689. </member>
  34690. <member name="M:MailKit.IMailFolder.AddFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  34691. <summary>
  34692. Asynchronously add a set of flags to the specified messages.
  34693. </summary>
  34694. <remarks>
  34695. Asynchronously adds a set of flags to the specified messages.
  34696. </remarks>
  34697. <returns>An asynchronous task context.</returns>
  34698. <param name="indexes">The indexes of the messages.</param>
  34699. <param name="flags">The message flags to add.</param>
  34700. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34701. <param name="cancellationToken">The cancellation token.</param>
  34702. </member>
  34703. <member name="M:MailKit.IMailFolder.AddFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  34704. <summary>
  34705. Add a set of flags to the specified messages.
  34706. </summary>
  34707. <remarks>
  34708. Adds a set of flags to the specified messages.
  34709. </remarks>
  34710. <param name="indexes">The indexes of the messages.</param>
  34711. <param name="flags">The message flags to add.</param>
  34712. <param name="keywords">A set of user-defined flags to add.</param>
  34713. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34714. <param name="cancellationToken">The cancellation token.</param>
  34715. </member>
  34716. <member name="M:MailKit.IMailFolder.AddFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  34717. <summary>
  34718. Asynchronously add a set of flags to the specified messages.
  34719. </summary>
  34720. <remarks>
  34721. Asynchronously adds a set of flags to the specified messages.
  34722. </remarks>
  34723. <returns>An asynchronous task context.</returns>
  34724. <param name="indexes">The indexes of the messages.</param>
  34725. <param name="flags">The message flags to add.</param>
  34726. <param name="keywords">A set of user-defined flags to add.</param>
  34727. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34728. <param name="cancellationToken">The cancellation token.</param>
  34729. </member>
  34730. <member name="M:MailKit.IMailFolder.RemoveFlags(System.Int32,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  34731. <summary>
  34732. Remove a set of flags from the specified message.
  34733. </summary>
  34734. <remarks>
  34735. Removes a set of flags from the specified message.
  34736. </remarks>
  34737. <param name="index">The index of the message.</param>
  34738. <param name="flags">The message flags to remove.</param>
  34739. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34740. <param name="cancellationToken">The cancellation token.</param>
  34741. </member>
  34742. <member name="M:MailKit.IMailFolder.RemoveFlagsAsync(System.Int32,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  34743. <summary>
  34744. Asynchronously remove a set of flags from the specified message.
  34745. </summary>
  34746. <remarks>
  34747. Asynchronously removes a set of flags from the specified message.
  34748. </remarks>
  34749. <returns>An asynchronous task context.</returns>
  34750. <param name="index">The index of the message.</param>
  34751. <param name="flags">The message flags to remove.</param>
  34752. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34753. <param name="cancellationToken">The cancellation token.</param>
  34754. </member>
  34755. <member name="M:MailKit.IMailFolder.RemoveFlags(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  34756. <summary>
  34757. Remove a set of flags from the specified message.
  34758. </summary>
  34759. <remarks>
  34760. Removes a set of flags from the specified message.
  34761. </remarks>
  34762. <param name="index">The index of the message.</param>
  34763. <param name="flags">The message flags to remove.</param>
  34764. <param name="keywords">A set of user-defined flags to remove.</param>
  34765. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34766. <param name="cancellationToken">The cancellation token.</param>
  34767. </member>
  34768. <member name="M:MailKit.IMailFolder.RemoveFlagsAsync(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  34769. <summary>
  34770. Asynchronously remove a set of flags from the specified message.
  34771. </summary>
  34772. <remarks>
  34773. Asynchronously removes a set of flags from the specified message.
  34774. </remarks>
  34775. <returns>An asynchronous task context.</returns>
  34776. <param name="index">The index of the message.</param>
  34777. <param name="flags">The message flags to remove.</param>
  34778. <param name="keywords">A set of user-defined flags to remove.</param>
  34779. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34780. <param name="cancellationToken">The cancellation token.</param>
  34781. </member>
  34782. <member name="M:MailKit.IMailFolder.RemoveFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  34783. <summary>
  34784. Remove a set of flags from the specified messages.
  34785. </summary>
  34786. <remarks>
  34787. Removes a set of flags from the specified messages.
  34788. </remarks>
  34789. <param name="indexes">The indexes of the messages.</param>
  34790. <param name="flags">The message flags to remove.</param>
  34791. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34792. <param name="cancellationToken">The cancellation token.</param>
  34793. </member>
  34794. <member name="M:MailKit.IMailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  34795. <summary>
  34796. Asynchronously remove a set of flags from the specified messages.
  34797. </summary>
  34798. <remarks>
  34799. Asynchronously removes a set of flags from the specified messages.
  34800. </remarks>
  34801. <returns>An asynchronous task context.</returns>
  34802. <param name="indexes">The indexes of the messages.</param>
  34803. <param name="flags">The message flags to remove.</param>
  34804. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34805. <param name="cancellationToken">The cancellation token.</param>
  34806. </member>
  34807. <member name="M:MailKit.IMailFolder.RemoveFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  34808. <summary>
  34809. Remove a set of flags from the specified messages.
  34810. </summary>
  34811. <remarks>
  34812. Removes a set of flags from the specified messages.
  34813. </remarks>
  34814. <param name="indexes">The indexes of the messages.</param>
  34815. <param name="flags">The message flags to remove.</param>
  34816. <param name="keywords">A set of user-defined flags to remove.</param>
  34817. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34818. <param name="cancellationToken">The cancellation token.</param>
  34819. </member>
  34820. <member name="M:MailKit.IMailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  34821. <summary>
  34822. Asynchronously remove a set of flags from the specified messages.
  34823. </summary>
  34824. <remarks>
  34825. Asynchronously removes a set of flags from the specified messages.
  34826. </remarks>
  34827. <returns>An asynchronous task context.</returns>
  34828. <param name="indexes">The indexes of the messages.</param>
  34829. <param name="flags">The message flags to remove.</param>
  34830. <param name="keywords">A set of user-defined flags to remove.</param>
  34831. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34832. <param name="cancellationToken">The cancellation token.</param>
  34833. </member>
  34834. <member name="M:MailKit.IMailFolder.SetFlags(System.Int32,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  34835. <summary>
  34836. Set the flags of the specified message.
  34837. </summary>
  34838. <remarks>
  34839. Sets the flags of the specified message.
  34840. </remarks>
  34841. <param name="index">The index of the message.</param>
  34842. <param name="flags">The message flags to set.</param>
  34843. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34844. <param name="cancellationToken">The cancellation token.</param>
  34845. </member>
  34846. <member name="M:MailKit.IMailFolder.SetFlagsAsync(System.Int32,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  34847. <summary>
  34848. Asynchronously set the flags of the specified message.
  34849. </summary>
  34850. <remarks>
  34851. Asynchronously sets the flags of the specified message.
  34852. </remarks>
  34853. <returns>An asynchronous task context.</returns>
  34854. <param name="index">The index of the message.</param>
  34855. <param name="flags">The message flags to set.</param>
  34856. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34857. <param name="cancellationToken">The cancellation token.</param>
  34858. </member>
  34859. <member name="M:MailKit.IMailFolder.SetFlags(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  34860. <summary>
  34861. Set the flags of the specified message.
  34862. </summary>
  34863. <remarks>
  34864. Sets the flags of the specified message.
  34865. </remarks>
  34866. <param name="index">The index of the message.</param>
  34867. <param name="flags">The message flags to set.</param>
  34868. <param name="keywords">A set of user-defined flags to set.</param>
  34869. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34870. <param name="cancellationToken">The cancellation token.</param>
  34871. </member>
  34872. <member name="M:MailKit.IMailFolder.SetFlagsAsync(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  34873. <summary>
  34874. Asynchronously set the flags of the specified message.
  34875. </summary>
  34876. <remarks>
  34877. Asynchronously sets the flags of the specified message.
  34878. </remarks>
  34879. <returns>An asynchronous task context.</returns>
  34880. <param name="index">The index of the message.</param>
  34881. <param name="flags">The message flags to set.</param>
  34882. <param name="keywords">A set of user-defined flags to set.</param>
  34883. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34884. <param name="cancellationToken">The cancellation token.</param>
  34885. </member>
  34886. <member name="M:MailKit.IMailFolder.SetFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  34887. <summary>
  34888. Set the flags of the specified messages.
  34889. </summary>
  34890. <remarks>
  34891. Sets the flags of the specified messages.
  34892. </remarks>
  34893. <param name="indexes">The indexes of the messages.</param>
  34894. <param name="flags">The message flags to set.</param>
  34895. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34896. <param name="cancellationToken">The cancellation token.</param>
  34897. </member>
  34898. <member name="M:MailKit.IMailFolder.SetFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  34899. <summary>
  34900. Asynchronously set the flags of the specified messages.
  34901. </summary>
  34902. <remarks>
  34903. Asynchronously sets the flags of the specified messages.
  34904. </remarks>
  34905. <returns>An asynchronous task context.</returns>
  34906. <param name="indexes">The indexes of the messages.</param>
  34907. <param name="flags">The message flags to set.</param>
  34908. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34909. <param name="cancellationToken">The cancellation token.</param>
  34910. </member>
  34911. <member name="M:MailKit.IMailFolder.SetFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  34912. <summary>
  34913. Set the flags of the specified messages.
  34914. </summary>
  34915. <remarks>
  34916. Sets the flags of the specified messages.
  34917. </remarks>
  34918. <param name="indexes">The indexes of the messages.</param>
  34919. <param name="flags">The message flags to set.</param>
  34920. <param name="keywords">A set of user-defined flags to set.</param>
  34921. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34922. <param name="cancellationToken">The cancellation token.</param>
  34923. </member>
  34924. <member name="M:MailKit.IMailFolder.SetFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  34925. <summary>
  34926. Asynchronously set the flags of the specified messages.
  34927. </summary>
  34928. <remarks>
  34929. Asynchronously sets the flags of the specified messages.
  34930. </remarks>
  34931. <returns>An asynchronous task context.</returns>
  34932. <param name="indexes">The indexes of the messages.</param>
  34933. <param name="flags">The message flags to set.</param>
  34934. <param name="keywords">A set of user-defined flags to set.</param>
  34935. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34936. <param name="cancellationToken">The cancellation token.</param>
  34937. </member>
  34938. <member name="M:MailKit.IMailFolder.AddFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  34939. <summary>
  34940. Add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
  34941. </summary>
  34942. <remarks>
  34943. Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
  34944. </remarks>
  34945. <returns>The indexes of the messages that were not updated.</returns>
  34946. <param name="indexes">The indexes of the messages.</param>
  34947. <param name="modseq">The mod-sequence value.</param>
  34948. <param name="flags">The message flags to add.</param>
  34949. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34950. <param name="cancellationToken">The cancellation token.</param>
  34951. </member>
  34952. <member name="M:MailKit.IMailFolder.AddFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  34953. <summary>
  34954. Asynchronously add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
  34955. </summary>
  34956. <remarks>
  34957. Asynchronously adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
  34958. </remarks>
  34959. <returns>The indexes of the messages that were not updated.</returns>
  34960. <param name="indexes">The indexes of the messages.</param>
  34961. <param name="modseq">The mod-sequence value.</param>
  34962. <param name="flags">The message flags to add.</param>
  34963. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34964. <param name="cancellationToken">The cancellation token.</param>
  34965. </member>
  34966. <member name="M:MailKit.IMailFolder.AddFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  34967. <summary>
  34968. Add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
  34969. </summary>
  34970. <remarks>
  34971. Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
  34972. </remarks>
  34973. <returns>The indexes of the messages that were not updated.</returns>
  34974. <param name="indexes">The indexes of the messages.</param>
  34975. <param name="modseq">The mod-sequence value.</param>
  34976. <param name="flags">The message flags to add.</param>
  34977. <param name="keywords">A set of user-defined flags to add.</param>
  34978. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34979. <param name="cancellationToken">The cancellation token.</param>
  34980. </member>
  34981. <member name="M:MailKit.IMailFolder.AddFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  34982. <summary>
  34983. Asynchronously add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
  34984. </summary>
  34985. <remarks>
  34986. Asynchronously adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
  34987. </remarks>
  34988. <returns>The indexes of the messages that were not updated.</returns>
  34989. <param name="indexes">The indexes of the messages.</param>
  34990. <param name="modseq">The mod-sequence value.</param>
  34991. <param name="flags">The message flags to add.</param>
  34992. <param name="keywords">A set of user-defined flags to add.</param>
  34993. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  34994. <param name="cancellationToken">The cancellation token.</param>
  34995. </member>
  34996. <member name="M:MailKit.IMailFolder.RemoveFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  34997. <summary>
  34998. Remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
  34999. </summary>
  35000. <remarks>
  35001. Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
  35002. </remarks>
  35003. <returns>The indexes of the messages that were not updated.</returns>
  35004. <param name="indexes">The indexes of the messages.</param>
  35005. <param name="modseq">The mod-sequence value.</param>
  35006. <param name="flags">The message flags to remove.</param>
  35007. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  35008. <param name="cancellationToken">The cancellation token.</param>
  35009. </member>
  35010. <member name="M:MailKit.IMailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  35011. <summary>
  35012. Asynchronously remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
  35013. </summary>
  35014. <remarks>
  35015. Asynchronously removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
  35016. </remarks>
  35017. <returns>The indexes of the messages that were not updated.</returns>
  35018. <param name="indexes">The indexes of the messages.</param>
  35019. <param name="modseq">The mod-sequence value.</param>
  35020. <param name="flags">The message flags to remove.</param>
  35021. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  35022. <param name="cancellationToken">The cancellation token.</param>
  35023. </member>
  35024. <member name="M:MailKit.IMailFolder.RemoveFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  35025. <summary>
  35026. Remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
  35027. </summary>
  35028. <remarks>
  35029. Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
  35030. </remarks>
  35031. <returns>The indexes of the messages that were not updated.</returns>
  35032. <param name="indexes">The indexes of the messages.</param>
  35033. <param name="modseq">The mod-sequence value.</param>
  35034. <param name="flags">The message flags to remove.</param>
  35035. <param name="keywords">A set of user-defined flags to remove.</param>
  35036. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  35037. <param name="cancellationToken">The cancellation token.</param>
  35038. </member>
  35039. <member name="M:MailKit.IMailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  35040. <summary>
  35041. Asynchronously remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
  35042. </summary>
  35043. <remarks>
  35044. Asynchronously removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
  35045. </remarks>
  35046. <returns>The indexes of the messages that were not updated.</returns>
  35047. <param name="indexes">The indexes of the messages.</param>
  35048. <param name="modseq">The mod-sequence value.</param>
  35049. <param name="flags">The message flags to remove.</param>
  35050. <param name="keywords">A set of user-defined flags to remove.</param>
  35051. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  35052. <param name="cancellationToken">The cancellation token.</param>
  35053. </member>
  35054. <member name="M:MailKit.IMailFolder.SetFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  35055. <summary>
  35056. Set the flags of the specified messages only if their mod-sequence value is less than the specified value.
  35057. </summary>
  35058. <remarks>
  35059. Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
  35060. </remarks>
  35061. <returns>The indexes of the messages that were not updated.</returns>
  35062. <param name="indexes">The indexes of the messages.</param>
  35063. <param name="modseq">The mod-sequence value.</param>
  35064. <param name="flags">The message flags to set.</param>
  35065. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  35066. <param name="cancellationToken">The cancellation token.</param>
  35067. </member>
  35068. <member name="M:MailKit.IMailFolder.SetFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  35069. <summary>
  35070. Asynchronously set the flags of the specified messages only if their mod-sequence value is less than the specified value.
  35071. </summary>
  35072. <remarks>
  35073. Asynchronously sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
  35074. </remarks>
  35075. <returns>The indexes of the messages that were not updated.</returns>
  35076. <param name="indexes">The indexes of the messages.</param>
  35077. <param name="modseq">The mod-sequence value.</param>
  35078. <param name="flags">The message flags to set.</param>
  35079. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  35080. <param name="cancellationToken">The cancellation token.</param>
  35081. </member>
  35082. <member name="M:MailKit.IMailFolder.SetFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  35083. <summary>
  35084. Set the flags of the specified messages only if their mod-sequence value is less than the specified value.
  35085. </summary>
  35086. <remarks>
  35087. Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
  35088. </remarks>
  35089. <returns>The indexes of the messages that were not updated.</returns>
  35090. <param name="indexes">The indexes of the messages.</param>
  35091. <param name="modseq">The mod-sequence value.</param>
  35092. <param name="flags">The message flags to set.</param>
  35093. <param name="keywords">A set of user-defined flags to set.</param>
  35094. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  35095. <param name="cancellationToken">The cancellation token.</param>
  35096. </member>
  35097. <member name="M:MailKit.IMailFolder.SetFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  35098. <summary>
  35099. Asynchronously set the flags of the specified messages only if their mod-sequence value is less than the specified value.
  35100. </summary>
  35101. <remarks>
  35102. Asynchronously sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
  35103. </remarks>
  35104. <returns>The indexes of the messages that were not updated.</returns>
  35105. <param name="indexes">The indexes of the messages.</param>
  35106. <param name="modseq">The mod-sequence value.</param>
  35107. <param name="flags">The message flags to set.</param>
  35108. <param name="keywords">A set of user-defined flags to set.</param>
  35109. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  35110. <param name="cancellationToken">The cancellation token.</param>
  35111. </member>
  35112. <member name="M:MailKit.IMailFolder.AddLabels(MailKit.UniqueId,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  35113. <summary>
  35114. Add a set of labels to the specified message.
  35115. </summary>
  35116. <remarks>
  35117. Adds a set of labels to the specified message.
  35118. </remarks>
  35119. <param name="uid">The UID of the message.</param>
  35120. <param name="labels">The labels to add.</param>
  35121. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  35122. <param name="cancellationToken">The cancellation token.</param>
  35123. </member>
  35124. <member name="M:MailKit.IMailFolder.AddLabelsAsync(MailKit.UniqueId,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  35125. <summary>
  35126. Asynchronously add a set of labels to the specified message.
  35127. </summary>
  35128. <remarks>
  35129. Asynchronously adds a set of labels to the specified message.
  35130. </remarks>
  35131. <returns>An asynchronous task context.</returns>
  35132. <param name="uid">The UIDs of the message.</param>
  35133. <param name="labels">The labels to add.</param>
  35134. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  35135. <param name="cancellationToken">The cancellation token.</param>
  35136. </member>
  35137. <member name="M:MailKit.IMailFolder.AddLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  35138. <summary>
  35139. Add a set of labels to the specified messages.
  35140. </summary>
  35141. <remarks>
  35142. Adds a set of labels to the specified messages.
  35143. </remarks>
  35144. <param name="uids">The UIDs of the messages.</param>
  35145. <param name="labels">The labels to add.</param>
  35146. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  35147. <param name="cancellationToken">The cancellation token.</param>
  35148. </member>
  35149. <member name="M:MailKit.IMailFolder.AddLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  35150. <summary>
  35151. Asynchronously add a set of labels to the specified messages.
  35152. </summary>
  35153. <remarks>
  35154. Asynchronously adds a set of labels to the specified messages.
  35155. </remarks>
  35156. <returns>An asynchronous task context.</returns>
  35157. <param name="uids">The UIDs of the messages.</param>
  35158. <param name="labels">The labels to add.</param>
  35159. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  35160. <param name="cancellationToken">The cancellation token.</param>
  35161. </member>
  35162. <member name="M:MailKit.IMailFolder.RemoveLabels(MailKit.UniqueId,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  35163. <summary>
  35164. Remove a set of labels from the specified message.
  35165. </summary>
  35166. <remarks>
  35167. Removes a set of labels from the specified message.
  35168. </remarks>
  35169. <param name="uid">The UID of the message.</param>
  35170. <param name="labels">The labels to remove.</param>
  35171. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  35172. <param name="cancellationToken">The cancellation token.</param>
  35173. </member>
  35174. <member name="M:MailKit.IMailFolder.RemoveLabelsAsync(MailKit.UniqueId,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  35175. <summary>
  35176. Asynchronously remove a set of labels from the specified message.
  35177. </summary>
  35178. <remarks>
  35179. Asynchronously removes a set of labels from the specified message.
  35180. </remarks>
  35181. <returns>An asynchronous task context.</returns>
  35182. <param name="uid">The UID of the message.</param>
  35183. <param name="labels">The labels to remove.</param>
  35184. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  35185. <param name="cancellationToken">The cancellation token.</param>
  35186. </member>
  35187. <member name="M:MailKit.IMailFolder.RemoveLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  35188. <summary>
  35189. Remove a set of labels from the specified messages.
  35190. </summary>
  35191. <remarks>
  35192. Removes a set of labels from the specified messages.
  35193. </remarks>
  35194. <param name="uids">The UIDs of the messages.</param>
  35195. <param name="labels">The labels to remove.</param>
  35196. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  35197. <param name="cancellationToken">The cancellation token.</param>
  35198. </member>
  35199. <member name="M:MailKit.IMailFolder.RemoveLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  35200. <summary>
  35201. Asynchronously remove a set of labels from the specified messages.
  35202. </summary>
  35203. <remarks>
  35204. Asynchronously removes a set of labels from the specified messages.
  35205. </remarks>
  35206. <returns>An asynchronous task context.</returns>
  35207. <param name="uids">The UIDs of the messages.</param>
  35208. <param name="labels">The labels to remove.</param>
  35209. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  35210. <param name="cancellationToken">The cancellation token.</param>
  35211. </member>
  35212. <member name="M:MailKit.IMailFolder.SetLabels(MailKit.UniqueId,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  35213. <summary>
  35214. Set the labels of the specified message.
  35215. </summary>
  35216. <remarks>
  35217. Sets the labels of the specified message.
  35218. </remarks>
  35219. <param name="uid">The UID of the message.</param>
  35220. <param name="labels">The labels to set.</param>
  35221. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  35222. <param name="cancellationToken">The cancellation token.</param>
  35223. </member>
  35224. <member name="M:MailKit.IMailFolder.SetLabelsAsync(MailKit.UniqueId,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  35225. <summary>
  35226. Asynchronously set the labels of the specified message.
  35227. </summary>
  35228. <remarks>
  35229. Asynchronously sets the labels of the specified message.
  35230. </remarks>
  35231. <returns>An asynchronous task context.</returns>
  35232. <param name="uid">The UID of the message.</param>
  35233. <param name="labels">The labels to set.</param>
  35234. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  35235. <param name="cancellationToken">The cancellation token.</param>
  35236. </member>
  35237. <member name="M:MailKit.IMailFolder.SetLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  35238. <summary>
  35239. Set the labels of the specified messages.
  35240. </summary>
  35241. <remarks>
  35242. Sets the labels of the specified messages.
  35243. </remarks>
  35244. <param name="uids">The UIDs of the messages.</param>
  35245. <param name="labels">The labels to set.</param>
  35246. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  35247. <param name="cancellationToken">The cancellation token.</param>
  35248. </member>
  35249. <member name="M:MailKit.IMailFolder.SetLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  35250. <summary>
  35251. Asynchronously set the labels of the specified messages.
  35252. </summary>
  35253. <remarks>
  35254. Asynchronously sets the labels of the specified messages.
  35255. </remarks>
  35256. <returns>An asynchronous task context.</returns>
  35257. <param name="uids">The UIDs of the messages.</param>
  35258. <param name="labels">The labels to set.</param>
  35259. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  35260. <param name="cancellationToken">The cancellation token.</param>
  35261. </member>
  35262. <member name="M:MailKit.IMailFolder.AddLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  35263. <summary>
  35264. Add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
  35265. </summary>
  35266. <remarks>
  35267. Adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
  35268. </remarks>
  35269. <returns>The unique IDs of the messages that were not updated.</returns>
  35270. <param name="uids">The UIDs of the messages.</param>
  35271. <param name="modseq">The mod-sequence value.</param>
  35272. <param name="labels">The labels to add.</param>
  35273. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  35274. <param name="cancellationToken">The cancellation token.</param>
  35275. </member>
  35276. <member name="M:MailKit.IMailFolder.AddLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  35277. <summary>
  35278. Asynchronously add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
  35279. </summary>
  35280. <remarks>
  35281. Asynchronously adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
  35282. </remarks>
  35283. <returns>The unique IDs of the messages that were not updated.</returns>
  35284. <param name="uids">The UIDs of the messages.</param>
  35285. <param name="modseq">The mod-sequence value.</param>
  35286. <param name="labels">The labels to add.</param>
  35287. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  35288. <param name="cancellationToken">The cancellation token.</param>
  35289. </member>
  35290. <member name="M:MailKit.IMailFolder.RemoveLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  35291. <summary>
  35292. Remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
  35293. </summary>
  35294. <remarks>
  35295. Removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
  35296. </remarks>
  35297. <returns>The unique IDs of the messages that were not updated.</returns>
  35298. <param name="uids">The UIDs of the messages.</param>
  35299. <param name="modseq">The mod-sequence value.</param>
  35300. <param name="labels">The labels to remove.</param>
  35301. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  35302. <param name="cancellationToken">The cancellation token.</param>
  35303. </member>
  35304. <member name="M:MailKit.IMailFolder.RemoveLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  35305. <summary>
  35306. Asynchronously remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
  35307. </summary>
  35308. <remarks>
  35309. Asynchronously removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
  35310. </remarks>
  35311. <returns>The unique IDs of the messages that were not updated.</returns>
  35312. <param name="uids">The UIDs of the messages.</param>
  35313. <param name="modseq">The mod-sequence value.</param>
  35314. <param name="labels">The labels to remove.</param>
  35315. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  35316. <param name="cancellationToken">The cancellation token.</param>
  35317. </member>
  35318. <member name="M:MailKit.IMailFolder.SetLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  35319. <summary>
  35320. Set the labels of the specified messages only if their mod-sequence value is less than the specified value.
  35321. </summary>
  35322. <remarks>
  35323. Sets the labels of the specified messages only if their mod-sequence value is less than the specified value.
  35324. </remarks>
  35325. <returns>The unique IDs of the messages that were not updated.</returns>
  35326. <param name="uids">The UIDs of the messages.</param>
  35327. <param name="modseq">The mod-sequence value.</param>
  35328. <param name="labels">The labels to set.</param>
  35329. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  35330. <param name="cancellationToken">The cancellation token.</param>
  35331. </member>
  35332. <member name="M:MailKit.IMailFolder.SetLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  35333. <summary>
  35334. Asynchronously set the labels of the specified messages only if their mod-sequence value is less than the specified value.
  35335. </summary>
  35336. <remarks>
  35337. Asynchronously sets the labels of the specified messages only if their mod-sequence value is less than the specified value.
  35338. </remarks>
  35339. <returns>The unique IDs of the messages that were not updated.</returns>
  35340. <param name="uids">The UIDs of the messages.</param>
  35341. <param name="modseq">The mod-sequence value.</param>
  35342. <param name="labels">The labels to set.</param>
  35343. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  35344. <param name="cancellationToken">The cancellation token.</param>
  35345. </member>
  35346. <member name="M:MailKit.IMailFolder.AddLabels(System.Int32,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  35347. <summary>
  35348. Add a set of labels to the specified message.
  35349. </summary>
  35350. <remarks>
  35351. Adds a set of labels to the specified message.
  35352. </remarks>
  35353. <param name="index">The index of the message.</param>
  35354. <param name="labels">The labels to add.</param>
  35355. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  35356. <param name="cancellationToken">The cancellation token.</param>
  35357. </member>
  35358. <member name="M:MailKit.IMailFolder.AddLabelsAsync(System.Int32,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  35359. <summary>
  35360. Asynchronously add a set of labels to the specified message.
  35361. </summary>
  35362. <remarks>
  35363. Asynchronously adds a set of labels to the specified message.
  35364. </remarks>
  35365. <returns>An asynchronous task context.</returns>
  35366. <param name="index">The index of the message.</param>
  35367. <param name="labels">The labels to add.</param>
  35368. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  35369. <param name="cancellationToken">The cancellation token.</param>
  35370. </member>
  35371. <member name="M:MailKit.IMailFolder.AddLabels(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  35372. <summary>
  35373. Add a set of labels to the specified messages.
  35374. </summary>
  35375. <remarks>
  35376. Adds a set of labels to the specified messages.
  35377. </remarks>
  35378. <param name="indexes">The indexes of the messages.</param>
  35379. <param name="labels">The labels to add.</param>
  35380. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  35381. <param name="cancellationToken">The cancellation token.</param>
  35382. </member>
  35383. <member name="M:MailKit.IMailFolder.AddLabelsAsync(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  35384. <summary>
  35385. Asynchronously add a set of labels to the specified messages.
  35386. </summary>
  35387. <remarks>
  35388. Asynchronously adds a set of labels to the specified messages.
  35389. </remarks>
  35390. <returns>An asynchronous task context.</returns>
  35391. <param name="indexes">The indexes of the messages.</param>
  35392. <param name="labels">The labels to add.</param>
  35393. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  35394. <param name="cancellationToken">The cancellation token.</param>
  35395. </member>
  35396. <member name="M:MailKit.IMailFolder.RemoveLabels(System.Int32,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  35397. <summary>
  35398. Remove a set of labels from the specified message.
  35399. </summary>
  35400. <remarks>
  35401. Removes a set of labels from the specified message.
  35402. </remarks>
  35403. <param name="index">The index of the message.</param>
  35404. <param name="labels">The labels to remove.</param>
  35405. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  35406. <param name="cancellationToken">The cancellation token.</param>
  35407. </member>
  35408. <member name="M:MailKit.IMailFolder.RemoveLabelsAsync(System.Int32,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  35409. <summary>
  35410. Asynchronously remove a set of labels from the specified message.
  35411. </summary>
  35412. <remarks>
  35413. Asynchronously removes a set of labels from the specified message.
  35414. </remarks>
  35415. <returns>An asynchronous task context.</returns>
  35416. <param name="index">The index of the message.</param>
  35417. <param name="labels">The labels to remove.</param>
  35418. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  35419. <param name="cancellationToken">The cancellation token.</param>
  35420. </member>
  35421. <member name="M:MailKit.IMailFolder.RemoveLabels(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  35422. <summary>
  35423. Remove a set of labels from the specified messages.
  35424. </summary>
  35425. <remarks>
  35426. Removes a set of labels from the specified messages.
  35427. </remarks>
  35428. <param name="indexes">The indexes of the messages.</param>
  35429. <param name="labels">The labels to remove.</param>
  35430. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  35431. <param name="cancellationToken">The cancellation token.</param>
  35432. </member>
  35433. <member name="M:MailKit.IMailFolder.RemoveLabelsAsync(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  35434. <summary>
  35435. Asynchronously remove a set of labels from the specified messages.
  35436. </summary>
  35437. <remarks>
  35438. Asynchronously removes a set of labels from the specified messages.
  35439. </remarks>
  35440. <returns>An asynchronous task context.</returns>
  35441. <param name="indexes">The indexes of the messages.</param>
  35442. <param name="labels">The labels to remove.</param>
  35443. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  35444. <param name="cancellationToken">The cancellation token.</param>
  35445. </member>
  35446. <member name="M:MailKit.IMailFolder.SetLabels(System.Int32,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  35447. <summary>
  35448. Set the labels of the specified message.
  35449. </summary>
  35450. <remarks>
  35451. Sets the labels of the specified message.
  35452. </remarks>
  35453. <param name="index">The index of the message.</param>
  35454. <param name="labels">The labels to set.</param>
  35455. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  35456. <param name="cancellationToken">The cancellation token.</param>
  35457. </member>
  35458. <member name="M:MailKit.IMailFolder.SetLabelsAsync(System.Int32,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  35459. <summary>
  35460. Asynchronously set the labels of the specified message.
  35461. </summary>
  35462. <remarks>
  35463. Asynchronously sets the labels of the specified message.
  35464. </remarks>
  35465. <returns>An asynchronous task context.</returns>
  35466. <param name="index">The index of the message.</param>
  35467. <param name="labels">The labels to set.</param>
  35468. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  35469. <param name="cancellationToken">The cancellation token.</param>
  35470. </member>
  35471. <member name="M:MailKit.IMailFolder.SetLabels(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  35472. <summary>
  35473. Set the labels of the specified messages.
  35474. </summary>
  35475. <remarks>
  35476. Sets the labels of the specified messages.
  35477. </remarks>
  35478. <param name="indexes">The indexes of the messages.</param>
  35479. <param name="labels">The labels to set.</param>
  35480. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  35481. <param name="cancellationToken">The cancellation token.</param>
  35482. </member>
  35483. <member name="M:MailKit.IMailFolder.SetLabelsAsync(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  35484. <summary>
  35485. Asynchronously set the labels of the specified messages.
  35486. </summary>
  35487. <remarks>
  35488. Asynchronously sets the labels of the specified messages.
  35489. </remarks>
  35490. <returns>An asynchronous task context.</returns>
  35491. <param name="indexes">The indexes of the messages.</param>
  35492. <param name="labels">The labels to set.</param>
  35493. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  35494. <param name="cancellationToken">The cancellation token.</param>
  35495. </member>
  35496. <member name="M:MailKit.IMailFolder.AddLabels(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  35497. <summary>
  35498. Add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
  35499. </summary>
  35500. <remarks>
  35501. Adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
  35502. </remarks>
  35503. <returns>The indexes of the messages that were not updated.</returns>
  35504. <param name="indexes">The indexes of the messages.</param>
  35505. <param name="modseq">The mod-sequence value.</param>
  35506. <param name="labels">The labels to add.</param>
  35507. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  35508. <param name="cancellationToken">The cancellation token.</param>
  35509. </member>
  35510. <member name="M:MailKit.IMailFolder.AddLabelsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  35511. <summary>
  35512. Asynchronously add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
  35513. </summary>
  35514. <remarks>
  35515. Asynchronously adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
  35516. </remarks>
  35517. <returns>The indexes of the messages that were not updated.</returns>
  35518. <param name="indexes">The indexes of the messages.</param>
  35519. <param name="modseq">The mod-sequence value.</param>
  35520. <param name="labels">The labels to add.</param>
  35521. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  35522. <param name="cancellationToken">The cancellation token.</param>
  35523. </member>
  35524. <member name="M:MailKit.IMailFolder.RemoveLabels(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  35525. <summary>
  35526. Remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
  35527. </summary>
  35528. <remarks>
  35529. Removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
  35530. </remarks>
  35531. <returns>The indexes of the messages that were not updated.</returns>
  35532. <param name="indexes">The indexes of the messages.</param>
  35533. <param name="modseq">The mod-sequence value.</param>
  35534. <param name="labels">The labels to remove.</param>
  35535. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  35536. <param name="cancellationToken">The cancellation token.</param>
  35537. </member>
  35538. <member name="M:MailKit.IMailFolder.RemoveLabelsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  35539. <summary>
  35540. Asynchronously remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
  35541. </summary>
  35542. <remarks>
  35543. Asynchronously removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
  35544. </remarks>
  35545. <returns>The indexes of the messages that were not updated.</returns>
  35546. <param name="indexes">The indexes of the messages.</param>
  35547. <param name="modseq">The mod-sequence value.</param>
  35548. <param name="labels">The labels to remove.</param>
  35549. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  35550. <param name="cancellationToken">The cancellation token.</param>
  35551. </member>
  35552. <member name="M:MailKit.IMailFolder.SetLabels(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  35553. <summary>
  35554. Set the labels of the specified messages only if their mod-sequence value is less than the specified value.
  35555. </summary>
  35556. <remarks>
  35557. Sets the labels of the specified messages only if their mod-sequence value is less than the specified value.
  35558. </remarks>
  35559. <returns>The indexes of the messages that were not updated.</returns>
  35560. <param name="indexes">The indexes of the messages.</param>
  35561. <param name="modseq">The mod-sequence value.</param>
  35562. <param name="labels">The labels to set.</param>
  35563. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  35564. <param name="cancellationToken">The cancellation token.</param>
  35565. </member>
  35566. <member name="M:MailKit.IMailFolder.SetLabelsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  35567. <summary>
  35568. Asynchronously set the labels of the specified messages only if their mod-sequence value is less than the specified value.
  35569. </summary>
  35570. <remarks>
  35571. Asynchronously sets the labels of the specified messages only if their mod-sequence value is less than the specified value.
  35572. </remarks>
  35573. <returns>The indexes of the messages that were not updated.</returns>
  35574. <param name="indexes">The indexes of the messages.</param>
  35575. <param name="modseq">The mod-sequence value.</param>
  35576. <param name="labels">The labels to set.</param>
  35577. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  35578. <param name="cancellationToken">The cancellation token.</param>
  35579. </member>
  35580. <member name="M:MailKit.IMailFolder.Store(MailKit.UniqueId,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
  35581. <summary>
  35582. Store the annotations for the specified message.
  35583. </summary>
  35584. <remarks>
  35585. Stores the annotations for the specified message.
  35586. </remarks>
  35587. <param name="uid">The UID of the message.</param>
  35588. <param name="annotations">The annotations to store.</param>
  35589. <param name="cancellationToken">The cancellation token.</param>
  35590. </member>
  35591. <member name="M:MailKit.IMailFolder.StoreAsync(MailKit.UniqueId,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
  35592. <summary>
  35593. Asynchronously store the annotations for the specified message.
  35594. </summary>
  35595. <remarks>
  35596. Asynchronously stores the annotations for the specified message.
  35597. </remarks>
  35598. <returns>An asynchronous task context.</returns>
  35599. <param name="uid">The UID of the message.</param>
  35600. <param name="annotations">The annotations to store.</param>
  35601. <param name="cancellationToken">The cancellation token.</param>
  35602. </member>
  35603. <member name="M:MailKit.IMailFolder.Store(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
  35604. <summary>
  35605. Store the annotations for the specified messages.
  35606. </summary>
  35607. <remarks>
  35608. Stores the annotations for the specified messages.
  35609. </remarks>
  35610. <param name="uids">The UIDs of the messages.</param>
  35611. <param name="annotations">The annotations to store.</param>
  35612. <param name="cancellationToken">The cancellation token.</param>
  35613. </member>
  35614. <member name="M:MailKit.IMailFolder.StoreAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
  35615. <summary>
  35616. Asynchronously store the annotations for the specified messages.
  35617. </summary>
  35618. <remarks>
  35619. Asynchronously stores the annotations for the specified messages.
  35620. </remarks>
  35621. <returns>An asynchronous task context.</returns>
  35622. <param name="uids">The UIDs of the messages.</param>
  35623. <param name="annotations">The annotations to store.</param>
  35624. <param name="cancellationToken">The cancellation token.</param>
  35625. </member>
  35626. <member name="M:MailKit.IMailFolder.Store(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
  35627. <summary>
  35628. Store the annotations for the specified messages only if their mod-sequence value is less than the specified value.
  35629. </summary>
  35630. <remarks>
  35631. Stores the annotations for the specified messages only if their mod-sequence value is less than the specified value.
  35632. </remarks>
  35633. <returns>The unique IDs of the messages that were not updated.</returns>
  35634. <param name="uids">The UIDs of the messages.</param>
  35635. <param name="modseq">The mod-sequence value.</param>
  35636. <param name="annotations">The annotations to store.</param>
  35637. <param name="cancellationToken">The cancellation token.</param>
  35638. </member>
  35639. <member name="M:MailKit.IMailFolder.StoreAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
  35640. <summary>
  35641. Asynchronously store the annotations for the specified messages only if their mod-sequence value is less than the specified value.
  35642. </summary>
  35643. <remarks>
  35644. Asynchronously stores the annotations for the specified messages only if their mod-sequence value is less than the specified value.
  35645. </remarks>
  35646. <returns>The unique IDs of the messages that were not updated.</returns>
  35647. <param name="uids">The UIDs of the messages.</param>
  35648. <param name="modseq">The mod-sequence value.</param>
  35649. <param name="annotations">The annotations to store.</param>
  35650. <param name="cancellationToken">The cancellation token.</param>
  35651. </member>
  35652. <member name="M:MailKit.IMailFolder.Store(System.Int32,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
  35653. <summary>
  35654. Store the annotations for the specified message.
  35655. </summary>
  35656. <remarks>
  35657. Stores the annotations for the specified message.
  35658. </remarks>
  35659. <param name="index">The index of the message.</param>
  35660. <param name="annotations">The annotations to store.</param>
  35661. <param name="cancellationToken">The cancellation token.</param>
  35662. </member>
  35663. <member name="M:MailKit.IMailFolder.StoreAsync(System.Int32,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
  35664. <summary>
  35665. Asynchronously store the annotations for the specified message.
  35666. </summary>
  35667. <remarks>
  35668. Asynchronously stores the annotations for the specified message.
  35669. </remarks>
  35670. <returns>An asynchronous task context.</returns>
  35671. <param name="index">The indexes of the message.</param>
  35672. <param name="annotations">The annotations to store.</param>
  35673. <param name="cancellationToken">The cancellation token.</param>
  35674. </member>
  35675. <member name="M:MailKit.IMailFolder.Store(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
  35676. <summary>
  35677. Store the annotations for the specified messages.
  35678. </summary>
  35679. <remarks>
  35680. Stores the annotations for the specified messages.
  35681. </remarks>
  35682. <param name="indexes">The indexes of the messages.</param>
  35683. <param name="annotations">The annotations to store.</param>
  35684. <param name="cancellationToken">The cancellation token.</param>
  35685. </member>
  35686. <member name="M:MailKit.IMailFolder.StoreAsync(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
  35687. <summary>
  35688. Asynchronously store the annotations for the specified messages.
  35689. </summary>
  35690. <remarks>
  35691. Asynchronously stores the annotations for the specified messages.
  35692. </remarks>
  35693. <returns>An asynchronous task context.</returns>
  35694. <param name="indexes">The indexes of the messages.</param>
  35695. <param name="annotations">The annotations to store.</param>
  35696. <param name="cancellationToken">The cancellation token.</param>
  35697. </member>
  35698. <member name="M:MailKit.IMailFolder.Store(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
  35699. <summary>
  35700. Store the annotations for the specified messages only if their mod-sequence value is less than the specified value.
  35701. </summary>
  35702. <remarks>
  35703. Stores the annotations for the specified messages only if their mod-sequence value is less than the specified value.
  35704. </remarks>
  35705. <returns>The indexes of the messages that were not updated.</returns>
  35706. <param name="indexes">The indexes of the messages.</param>
  35707. <param name="modseq">The mod-sequence value.</param>
  35708. <param name="annotations">The annotations to store.</param>
  35709. <param name="cancellationToken">The cancellation token.</param>
  35710. </member>
  35711. <member name="M:MailKit.IMailFolder.StoreAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
  35712. <summary>
  35713. Asynchronously store the annotations for the specified messages only if their mod-sequence value is less than the specified value.
  35714. </summary>
  35715. <remarks>
  35716. Asynchronously stores the annotations for the specified messages only if their mod-sequence value is less than the specified value.s
  35717. </remarks>
  35718. <returns>The indexes of the messages that were not updated.</returns>
  35719. <param name="indexes">The indexes of the messages.</param>
  35720. <param name="modseq">The mod-sequence value.</param>
  35721. <param name="annotations">The annotations to store.</param>
  35722. <param name="cancellationToken">The cancellation token.</param>
  35723. </member>
  35724. <member name="M:MailKit.IMailFolder.Search(MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
  35725. <summary>
  35726. Search the folder for messages matching the specified query.
  35727. </summary>
  35728. <remarks>
  35729. The returned array of unique identifiers can be used with methods such as
  35730. <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
  35731. </remarks>
  35732. <returns>An array of matching UIDs.</returns>
  35733. <param name="query">The search query.</param>
  35734. <param name="cancellationToken">The cancellation token.</param>
  35735. </member>
  35736. <member name="M:MailKit.IMailFolder.SearchAsync(MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
  35737. <summary>
  35738. Asynchronously search the folder for messages matching the specified query.
  35739. </summary>
  35740. <remarks>
  35741. The returned array of unique identifiers can be used with methods such as
  35742. <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
  35743. </remarks>
  35744. <returns>An array of matching UIDs.</returns>
  35745. <param name="query">The search query.</param>
  35746. <param name="cancellationToken">The cancellation token.</param>
  35747. </member>
  35748. <member name="M:MailKit.IMailFolder.Search(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
  35749. <summary>
  35750. Search the subset of UIDs in the folder for messages matching the specified query.
  35751. </summary>
  35752. <remarks>
  35753. The returned array of unique identifiers can be used with methods such as
  35754. <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
  35755. </remarks>
  35756. <returns>An array of matching UIDs.</returns>
  35757. <param name="uids">The subset of UIDs</param>
  35758. <param name="query">The search query.</param>
  35759. <param name="cancellationToken">The cancellation token.</param>
  35760. </member>
  35761. <member name="M:MailKit.IMailFolder.SearchAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
  35762. <summary>
  35763. Asynchronously search the subset of UIDs in the folder for messages matching the specified query.
  35764. </summary>
  35765. <remarks>
  35766. The returned array of unique identifiers can be used with methods such as
  35767. <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
  35768. </remarks>
  35769. <returns>An array of matching UIDs.</returns>
  35770. <param name="uids">The subset of UIDs</param>
  35771. <param name="query">The search query.</param>
  35772. <param name="cancellationToken">The cancellation token.</param>
  35773. </member>
  35774. <member name="M:MailKit.IMailFolder.Search(MailKit.Search.SearchOptions,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
  35775. <summary>
  35776. Search the folder for messages matching the specified query.
  35777. </summary>
  35778. <remarks>
  35779. Searches the folder for messages matching the specified query,
  35780. returning only the specified search results.
  35781. </remarks>
  35782. <returns>The search results.</returns>
  35783. <param name="options">The search options.</param>
  35784. <param name="query">The search query.</param>
  35785. <param name="cancellationToken">The cancellation token.</param>
  35786. </member>
  35787. <member name="M:MailKit.IMailFolder.SearchAsync(MailKit.Search.SearchOptions,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
  35788. <summary>
  35789. Asynchronously search the folder for messages matching the specified query.
  35790. </summary>
  35791. <remarks>
  35792. Asynchronously searches the folder for messages matching the specified query,
  35793. returning only the specified search results.
  35794. </remarks>
  35795. <returns>The search results.</returns>
  35796. <param name="options">The search options.</param>
  35797. <param name="query">The search query.</param>
  35798. <param name="cancellationToken">The cancellation token.</param>
  35799. </member>
  35800. <member name="M:MailKit.IMailFolder.Search(MailKit.Search.SearchOptions,System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
  35801. <summary>
  35802. Search the subset of UIDs in the folder for messages matching the specified query.
  35803. </summary>
  35804. <remarks>
  35805. Searches the fsubset of UIDs in the folder for messages matching the specified query,
  35806. returning only the specified search results.
  35807. </remarks>
  35808. <returns>The search results.</returns>
  35809. <param name="options">The search options.</param>
  35810. <param name="uids">The subset of UIDs</param>
  35811. <param name="query">The search query.</param>
  35812. <param name="cancellationToken">The cancellation token.</param>
  35813. </member>
  35814. <member name="M:MailKit.IMailFolder.SearchAsync(MailKit.Search.SearchOptions,System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
  35815. <summary>
  35816. Asynchronously search the subset of UIDs in the folder for messages matching the specified query.
  35817. </summary>
  35818. <remarks>
  35819. Asynchronously searches the fsubset of UIDs in the folder for messages matching the specified query,
  35820. returning only the specified search results.
  35821. </remarks>
  35822. <returns>The search results.</returns>
  35823. <param name="options">The search options.</param>
  35824. <param name="uids">The subset of UIDs</param>
  35825. <param name="query">The search query.</param>
  35826. <param name="cancellationToken">The cancellation token.</param>
  35827. </member>
  35828. <member name="M:MailKit.IMailFolder.Sort(MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
  35829. <summary>
  35830. Sort messages matching the specified query.
  35831. </summary>
  35832. <remarks>
  35833. The returned array of unique identifiers will be sorted in the preferred order and
  35834. can be used with <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
  35835. </remarks>
  35836. <returns>An array of matching UIDs in the specified sort order.</returns>
  35837. <param name="query">The search query.</param>
  35838. <param name="orderBy">The sort order.</param>
  35839. <param name="cancellationToken">The cancellation token.</param>
  35840. </member>
  35841. <member name="M:MailKit.IMailFolder.SortAsync(MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
  35842. <summary>
  35843. Asynchronously sort messages matching the specified query.
  35844. </summary>
  35845. <remarks>
  35846. The returned array of unique identifiers will be sorted in the preferred order and
  35847. can be used with <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
  35848. </remarks>
  35849. <returns>An array of matching UIDs in the specified sort order.</returns>
  35850. <param name="query">The search query.</param>
  35851. <param name="orderBy">The sort order.</param>
  35852. <param name="cancellationToken">The cancellation token.</param>
  35853. </member>
  35854. <member name="M:MailKit.IMailFolder.Sort(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
  35855. <summary>
  35856. Sort messages matching the specified query.
  35857. </summary>
  35858. <remarks>
  35859. The returned array of unique identifiers will be sorted in the preferred order and
  35860. can be used with <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
  35861. </remarks>
  35862. <returns>An array of matching UIDs in the specified sort order.</returns>
  35863. <param name="uids">The subset of UIDs</param>
  35864. <param name="query">The search query.</param>
  35865. <param name="orderBy">The sort order.</param>
  35866. <param name="cancellationToken">The cancellation token.</param>
  35867. </member>
  35868. <member name="M:MailKit.IMailFolder.SortAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
  35869. <summary>
  35870. Asynchronously sort messages matching the specified query.
  35871. </summary>
  35872. <remarks>
  35873. The returned array of unique identifiers will be sorted in the preferred order and
  35874. can be used with <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
  35875. </remarks>
  35876. <returns>An array of matching UIDs in the specified sort order.</returns>
  35877. <param name="uids">The subset of UIDs</param>
  35878. <param name="query">The search query.</param>
  35879. <param name="orderBy">The sort order.</param>
  35880. <param name="cancellationToken">The cancellation token.</param>
  35881. </member>
  35882. <member name="M:MailKit.IMailFolder.Sort(MailKit.Search.SearchOptions,MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
  35883. <summary>
  35884. Sort messages matching the specified query.
  35885. </summary>
  35886. <remarks>
  35887. Searches the folder for messages matching the specified query, returning the search results in the specified sort order.
  35888. </remarks>
  35889. <returns>The search results.</returns>
  35890. <param name="options">The search options.</param>
  35891. <param name="query">The search query.</param>
  35892. <param name="orderBy">The sort order.</param>
  35893. <param name="cancellationToken">The cancellation token.</param>
  35894. </member>
  35895. <member name="M:MailKit.IMailFolder.SortAsync(MailKit.Search.SearchOptions,MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
  35896. <summary>
  35897. Asynchronously sort messages matching the specified query.
  35898. </summary>
  35899. <remarks>
  35900. Asynchronously searches the folder for messages matching the specified query, returning the search results in the specified sort order.
  35901. </remarks>
  35902. <returns>The search results.</returns>
  35903. <param name="options">The search options.</param>
  35904. <param name="query">The search query.</param>
  35905. <param name="orderBy">The sort order.</param>
  35906. <param name="cancellationToken">The cancellation token.</param>
  35907. </member>
  35908. <member name="M:MailKit.IMailFolder.Sort(MailKit.Search.SearchOptions,System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
  35909. <summary>
  35910. Sort messages matching the specified query.
  35911. </summary>
  35912. <remarks>
  35913. Searches the folder for messages matching the specified query, returning the search results in the specified sort order.
  35914. </remarks>
  35915. <returns>The search results.</returns>
  35916. <param name="options">The search options.</param>
  35917. <param name="uids">The subset of UIDs</param>
  35918. <param name="query">The search query.</param>
  35919. <param name="orderBy">The sort order.</param>
  35920. <param name="cancellationToken">The cancellation token.</param>
  35921. </member>
  35922. <member name="M:MailKit.IMailFolder.SortAsync(MailKit.Search.SearchOptions,System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
  35923. <summary>
  35924. Asynchronously sort messages matching the specified query.
  35925. </summary>
  35926. <remarks>
  35927. Asynchronously searches the folder for messages matching the specified query,
  35928. returning the search results in the specified sort order.
  35929. </remarks>
  35930. <returns>The search results.</returns>
  35931. <param name="options">The search options.</param>
  35932. <param name="uids">The subset of UIDs</param>
  35933. <param name="query">The search query.</param>
  35934. <param name="orderBy">The sort order.</param>
  35935. <param name="cancellationToken">The cancellation token.</param>
  35936. </member>
  35937. <member name="M:MailKit.IMailFolder.Thread(MailKit.ThreadingAlgorithm,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
  35938. <summary>
  35939. Thread the messages in the folder that match the search query using the specified threading algorithm.
  35940. </summary>
  35941. <remarks>
  35942. The <see cref="P:MailKit.MessageThread.UniqueId"/> can be used with methods such as
  35943. <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
  35944. </remarks>
  35945. <returns>An array of message threads.</returns>
  35946. <param name="algorithm">The threading algorithm to use.</param>
  35947. <param name="query">The search query.</param>
  35948. <param name="cancellationToken">The cancellation token.</param>
  35949. </member>
  35950. <member name="M:MailKit.IMailFolder.ThreadAsync(MailKit.ThreadingAlgorithm,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
  35951. <summary>
  35952. Asynchronously thread the messages in the folder that match the search query using the specified threading algorithm.
  35953. </summary>
  35954. <remarks>
  35955. The <see cref="P:MailKit.MessageThread.UniqueId"/> can be used with methods such as
  35956. <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
  35957. </remarks>
  35958. <returns>An array of message threads.</returns>
  35959. <param name="algorithm">The threading algorithm to use.</param>
  35960. <param name="query">The search query.</param>
  35961. <param name="cancellationToken">The cancellation token.</param>
  35962. </member>
  35963. <member name="M:MailKit.IMailFolder.Thread(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.ThreadingAlgorithm,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
  35964. <summary>
  35965. Thread the messages in the folder that match the search query using the specified threading algorithm.
  35966. </summary>
  35967. <remarks>
  35968. The <see cref="P:MailKit.MessageThread.UniqueId"/> can be used with methods such as
  35969. <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
  35970. </remarks>
  35971. <returns>An array of message threads.</returns>
  35972. <param name="uids">The subset of UIDs</param>
  35973. <param name="algorithm">The threading algorithm to use.</param>
  35974. <param name="query">The search query.</param>
  35975. <param name="cancellationToken">The cancellation token.</param>
  35976. </member>
  35977. <member name="M:MailKit.IMailFolder.ThreadAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.ThreadingAlgorithm,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
  35978. <summary>
  35979. Asynchronously thread the messages in the folder that match the search query using the specified threading algorithm.
  35980. </summary>
  35981. <remarks>
  35982. The <see cref="P:MailKit.MessageThread.UniqueId"/> can be used with methods such as
  35983. <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
  35984. </remarks>
  35985. <returns>An array of message threads.</returns>
  35986. <param name="uids">The subset of UIDs</param>
  35987. <param name="algorithm">The threading algorithm to use.</param>
  35988. <param name="query">The search query.</param>
  35989. <param name="cancellationToken">The cancellation token.</param>
  35990. </member>
  35991. <member name="E:MailKit.IMailFolder.Opened">
  35992. <summary>
  35993. Occurs when the folder is opened.
  35994. </summary>
  35995. <remarks>
  35996. Emitted when the folder is opened.
  35997. </remarks>
  35998. </member>
  35999. <member name="E:MailKit.IMailFolder.Closed">
  36000. <summary>
  36001. Occurs when the folder is closed.
  36002. </summary>
  36003. <remarks>
  36004. Emitted when the folder is closed.
  36005. </remarks>
  36006. </member>
  36007. <member name="E:MailKit.IMailFolder.Deleted">
  36008. <summary>
  36009. Occurs when the folder is deleted.
  36010. </summary>
  36011. <remarks>
  36012. Emitted when the folder is deleted.
  36013. </remarks>
  36014. </member>
  36015. <member name="E:MailKit.IMailFolder.Renamed">
  36016. <summary>
  36017. Occurs when the folder is renamed.
  36018. </summary>
  36019. <remarks>
  36020. Emitted when the folder is renamed.
  36021. </remarks>
  36022. </member>
  36023. <member name="E:MailKit.IMailFolder.Subscribed">
  36024. <summary>
  36025. Occurs when the folder is subscribed.
  36026. </summary>
  36027. <remarks>
  36028. Emitted when the folder is subscribed.
  36029. </remarks>
  36030. </member>
  36031. <member name="E:MailKit.IMailFolder.Unsubscribed">
  36032. <summary>
  36033. Occurs when the folder is unsubscribed.
  36034. </summary>
  36035. <remarks>
  36036. Emitted when the folder is unsubscribed.
  36037. </remarks>
  36038. </member>
  36039. <member name="E:MailKit.IMailFolder.MessageExpunged">
  36040. <summary>
  36041. Occurs when a message is expunged from the folder.
  36042. </summary>
  36043. <remarks>
  36044. Emitted when a message is expunged from the folder.
  36045. </remarks>
  36046. <example>
  36047. <code language="c#" source="Examples\ImapIdleExample.cs"/>
  36048. </example>
  36049. </member>
  36050. <member name="E:MailKit.IMailFolder.MessagesVanished">
  36051. <summary>
  36052. Occurs when messages vanish from the folder.
  36053. </summary>
  36054. <remarks>
  36055. Emitted when a messages vanish from the folder.
  36056. </remarks>
  36057. </member>
  36058. <member name="E:MailKit.IMailFolder.MessageFlagsChanged">
  36059. <summary>
  36060. Occurs when flags changed on a message.
  36061. </summary>
  36062. <remarks>
  36063. Emitted when flags changed on a message.
  36064. </remarks>
  36065. <example>
  36066. <code language="c#" source="Examples\ImapIdleExample.cs"/>
  36067. </example>
  36068. </member>
  36069. <member name="E:MailKit.IMailFolder.MessageLabelsChanged">
  36070. <summary>
  36071. Occurs when labels changed on a message.
  36072. </summary>
  36073. <remarks>
  36074. Emitted when labels changed on a message.
  36075. </remarks>
  36076. </member>
  36077. <member name="E:MailKit.IMailFolder.AnnotationsChanged">
  36078. <summary>
  36079. Occurs when annotations changed on a message.
  36080. </summary>
  36081. <remarks>
  36082. Emitted when annotations changed on a message.
  36083. </remarks>
  36084. </member>
  36085. <member name="E:MailKit.IMailFolder.MessageSummaryFetched">
  36086. <summary>
  36087. Occurs when a message summary is fetched from the folder.
  36088. </summary>
  36089. <remarks>
  36090. <para>Emitted when a message summary is fetched from the folder.</para>
  36091. <para>When multiple message summaries are being fetched from a remote folder,
  36092. it is possible that the connection will drop or some other exception will
  36093. occur, causing the Fetch method to fail, requiring the client to request the
  36094. same set of message summaries again after it reconnects. This is obviously
  36095. inefficient. To alleviate this potential problem, this event will be emitted
  36096. as soon as the <see cref="T:MailKit.IMailFolder"/> successfully retrieves the complete
  36097. <see cref="T:MailKit.IMessageSummary"/> for each requested message.</para>
  36098. <note type="note">The <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  36099. methods will return a list of all message summaries that any information was
  36100. retrieved for, regardless of whether or not all of the requested items were fetched,
  36101. therefore there may be a discrepency between the number of times this event is
  36102. emitetd and the number of summary items returned from the Fetch method.</note>
  36103. </remarks>
  36104. </member>
  36105. <member name="E:MailKit.IMailFolder.MetadataChanged">
  36106. <summary>
  36107. Occurs when metadata changes.
  36108. </summary>
  36109. <remarks>
  36110. The <see cref="E:MailKit.IMailFolder.MetadataChanged"/> event is emitted when metadata changes.
  36111. </remarks>
  36112. </member>
  36113. <member name="E:MailKit.IMailFolder.ModSeqChanged">
  36114. <summary>
  36115. Occurs when the mod-sequence changed on a message.
  36116. </summary>
  36117. <remarks>
  36118. Emitted when the mod-sequence changed on a message.
  36119. </remarks>
  36120. </member>
  36121. <member name="E:MailKit.IMailFolder.HighestModSeqChanged">
  36122. <summary>
  36123. Occurs when the highest mod-sequence changes.
  36124. </summary>
  36125. <remarks>
  36126. The <see cref="E:MailKit.IMailFolder.HighestModSeqChanged"/> event is emitted whenever the <see cref="P:MailKit.IMailFolder.HighestModSeq"/> value changes.
  36127. </remarks>
  36128. </member>
  36129. <member name="E:MailKit.IMailFolder.UidNextChanged">
  36130. <summary>
  36131. Occurs when the next UID changes.
  36132. </summary>
  36133. <remarks>
  36134. Emitted when the <see cref="P:MailKit.IMailFolder.UidNext"/> property changes.
  36135. </remarks>
  36136. </member>
  36137. <member name="E:MailKit.IMailFolder.UidValidityChanged">
  36138. <summary>
  36139. Occurs when the UID validity changes.
  36140. </summary>
  36141. <remarks>
  36142. Emitted when the <see cref="P:MailKit.IMailFolder.UidValidity"/> property changes.
  36143. </remarks>
  36144. </member>
  36145. <member name="E:MailKit.IMailFolder.IdChanged">
  36146. <summary>
  36147. Occurs when the ID changes.
  36148. </summary>
  36149. <remarks>
  36150. Emitted when the <see cref="P:MailKit.IMailFolder.Id"/> property changes.
  36151. </remarks>
  36152. </member>
  36153. <member name="E:MailKit.IMailFolder.SizeChanged">
  36154. <summary>
  36155. Occurs when the size of the folder changes.
  36156. </summary>
  36157. <remarks>
  36158. Emitted when the <see cref="P:MailKit.IMailFolder.Size"/> property changes.
  36159. </remarks>
  36160. </member>
  36161. <member name="E:MailKit.IMailFolder.CountChanged">
  36162. <summary>
  36163. Occurs when the message count changes.
  36164. </summary>
  36165. <remarks>
  36166. Emitted when the <see cref="P:MailKit.IMailFolder.Count"/> property changes.
  36167. </remarks>
  36168. <example>
  36169. <code language="c#" source="Examples\ImapIdleExample.cs"/>
  36170. </example>
  36171. </member>
  36172. <member name="E:MailKit.IMailFolder.RecentChanged">
  36173. <summary>
  36174. Occurs when the recent message count changes.
  36175. </summary>
  36176. <remarks>
  36177. Emitted when the <see cref="P:MailKit.IMailFolder.Recent"/> property changes.
  36178. </remarks>
  36179. </member>
  36180. <member name="E:MailKit.IMailFolder.UnreadChanged">
  36181. <summary>
  36182. Occurs when the message unread count changes.
  36183. </summary>
  36184. <remarks>
  36185. Emitted when the <see cref="P:MailKit.IMailFolder.Unread"/> property changes.
  36186. </remarks>
  36187. </member>
  36188. <member name="T:MailKit.IMailService">
  36189. <summary>
  36190. An interface for message services such as SMTP, POP3, or IMAP.
  36191. </summary>
  36192. <remarks>
  36193. Implemented by <see cref="T:MailKit.Net.Smtp.SmtpClient"/>
  36194. and <see cref="T:MailKit.Net.Pop3.Pop3Client"/>.
  36195. </remarks>
  36196. </member>
  36197. <member name="P:MailKit.IMailService.SyncRoot">
  36198. <summary>
  36199. Gets an object that can be used to synchronize access to the folder.
  36200. </summary>
  36201. <remarks>
  36202. Gets an object that can be used to synchronize access to the folder.
  36203. </remarks>
  36204. <value>The sync root.</value>
  36205. </member>
  36206. <member name="P:MailKit.IMailService.SslProtocols">
  36207. <summary>
  36208. Gets or sets the SSL and TLS protocol versions that the client is allowed to use.
  36209. </summary>
  36210. <remarks>
  36211. <para>Gets or sets the SSL and TLS protocol versions that the client is allowed to use.</para>
  36212. <para>By default, MailKit initializes this value to support only TLS v1.0 and greater and
  36213. does not support any version of SSL due to those protocols no longer being considered
  36214. secure.</para>
  36215. <para>This property should be set before calling any of the
  36216. <a href="Overload_MailKit_IMailService_Connect.htm">Connect</a> methods.</para>
  36217. </remarks>
  36218. <value>The SSL and TLS protocol versions that are supported.</value>
  36219. </member>
  36220. <member name="P:MailKit.IMailService.ClientCertificates">
  36221. <summary>
  36222. Get or set the client SSL certificates.
  36223. </summary>
  36224. <remarks>
  36225. <para>Some servers may require the client SSL certificates in order
  36226. to allow the user to connect.</para>
  36227. <para>This property should be set before calling any of the
  36228. <a href="Overload_MailKit_IMailService_Connect.htm">Connect</a> methods.</para>
  36229. </remarks>
  36230. <value>The client SSL certificates.</value>
  36231. </member>
  36232. <member name="P:MailKit.IMailService.CheckCertificateRevocation">
  36233. <summary>
  36234. Get or set whether connecting via SSL/TLS should check certificate revocation.
  36235. </summary>
  36236. <remarks>
  36237. <para>Gets or sets whether connecting via SSL/TLS should check certificate revocation.</para>
  36238. <para>Normally, the value of this property should be set to <c>true</c> (the default) for security
  36239. reasons, but there are times when it may be necessary to set it to <c>false</c>.</para>
  36240. <para>For example, most Certificate Authorities are probably pretty good at keeping their CRL and/or
  36241. OCSP servers up 24/7, but occasionally they do go down or are otherwise unreachable due to other
  36242. network problems between the client and the Certificate Authority. When this happens, it becomes
  36243. impossible to check the revocation status of one or more of the certificates in the chain
  36244. resulting in an <see cref="T:MailKit.Security.SslHandshakeException"/> being thrown in the
  36245. <a href="Overload_MailKit_IMailService_Connect.htm">Connect</a> method. If this becomes a problem,
  36246. it may become desirable to set <see cref="P:MailKit.IMailService.CheckCertificateRevocation"/> to <c>false</c>.</para>
  36247. </remarks>
  36248. <value><c>true</c> if certificate revocation should be checked; otherwise, <c>false</c>.</value>
  36249. </member>
  36250. <member name="P:MailKit.IMailService.ServerCertificateValidationCallback">
  36251. <summary>
  36252. Get or sets a callback function to validate the server certificate.
  36253. </summary>
  36254. <remarks>
  36255. <para>Gets or sets a callback function to validate the server certificate.</para>
  36256. <para>This property should be set before calling any of the
  36257. <a href="Overload_MailKit_IMailService_Connect.htm">Connect</a> methods.</para>
  36258. </remarks>
  36259. <example>
  36260. <code language="c#" source="Examples\SslCertificateValidation.cs"/>
  36261. </example>
  36262. <value>The server certificate validation callback function.</value>
  36263. </member>
  36264. <member name="P:MailKit.IMailService.LocalEndPoint">
  36265. <summary>
  36266. Get or set the local IP end point to use when connecting to a remote host.
  36267. </summary>
  36268. <remarks>
  36269. Gets or sets the local IP end point to use when connecting to a remote host.
  36270. </remarks>
  36271. <value>The local IP end point or <c>null</c> to use the default end point.</value>
  36272. </member>
  36273. <member name="P:MailKit.IMailService.ProxyClient">
  36274. <summary>
  36275. Get or set the proxy client to use when connecting to a remote host.
  36276. </summary>
  36277. <remarks>
  36278. Gets or sets the proxy client to use when connecting to a remote host via any of the
  36279. <a href="Overload_MailKit_IMailService_Connect.htm">Connect</a> methods.
  36280. </remarks>
  36281. <value>The proxy client.</value>
  36282. </member>
  36283. <member name="P:MailKit.IMailService.AuthenticationMechanisms">
  36284. <summary>
  36285. Get the authentication mechanisms supported by the message service.
  36286. </summary>
  36287. <remarks>
  36288. The authentication mechanisms are queried durring the
  36289. <a href="Overload_MailKit_IMailService_Connect.htm">Connect</a> method.
  36290. </remarks>
  36291. <value>The supported authentication mechanisms.</value>
  36292. </member>
  36293. <member name="P:MailKit.IMailService.IsAuthenticated">
  36294. <summary>
  36295. Get whether or not the client is currently authenticated with the mail server.
  36296. </summary>
  36297. <remarks>
  36298. <para>Gets whether or not the client is currently authenticated with the mail server.</para>
  36299. <para>To authenticate with the mail server, use one of the
  36300. <a href="Overload_MailKit_MailService_Authenticate.htm">Authenticate</a> methods
  36301. or any of the Async alternatives.</para>
  36302. </remarks>
  36303. <value><c>true</c> if the client is authenticated; otherwise, <c>false</c>.</value>
  36304. </member>
  36305. <member name="P:MailKit.IMailService.IsConnected">
  36306. <summary>
  36307. Get whether or not the service is currently connected.
  36308. </summary>
  36309. <remarks>
  36310. <para>The <see cref="P:MailKit.IMailService.IsConnected"/> state is set to <c>true</c> immediately after
  36311. one of the <a href="Overload_MailKit_IMailService_Connect.htm">Connect</a>
  36312. methods succeeds and is not set back to <c>false</c> until either the client
  36313. is disconnected via <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/> or until a
  36314. <see cref="T:MailKit.ProtocolException"/> is thrown while attempting to read or write to
  36315. the underlying network socket.</para>
  36316. <para>When an <see cref="T:MailKit.ProtocolException"/> is caught, the connection state of the
  36317. <see cref="T:MailKit.IMailService"/> should be checked before continuing.</para>
  36318. </remarks>
  36319. <value><c>true</c> if the service connected; otherwise, <c>false</c>.</value>
  36320. </member>
  36321. <member name="P:MailKit.IMailService.IsSecure">
  36322. <summary>
  36323. Get whether or not the connection is secure (typically via SSL or TLS).
  36324. </summary>
  36325. <remarks>
  36326. Gets whether or not the connection is secure (typically via SSL or TLS).
  36327. </remarks>
  36328. <value><c>true</c> if the connection is secure; otherwise, <c>false</c>.</value>
  36329. </member>
  36330. <member name="P:MailKit.IMailService.Timeout">
  36331. <summary>
  36332. Get or set the timeout for network streaming operations, in milliseconds.
  36333. </summary>
  36334. <remarks>
  36335. Gets or sets the underlying socket stream's <see cref="P:System.IO.Stream.ReadTimeout"/>
  36336. and <see cref="P:System.IO.Stream.WriteTimeout"/> values.
  36337. </remarks>
  36338. <value>The timeout in milliseconds.</value>
  36339. </member>
  36340. <member name="M:MailKit.IMailService.Connect(System.String,System.Int32,System.Boolean,System.Threading.CancellationToken)">
  36341. <summary>
  36342. Establish a connection to the specified mail server.
  36343. </summary>
  36344. <remarks>
  36345. <para>Establish a connection to the specified mail server.</para>
  36346. <para>If a successful connection is made, the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/>
  36347. property will be populated.</para>
  36348. </remarks>
  36349. <param name="host">The host name to connect to.</param>
  36350. <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
  36351. <param name="useSsl"><value>true</value> if the client should make an SSL-wrapped connection to the server; otherwise, <value>false</value>.</param>
  36352. <param name="cancellationToken">The cancellation token.</param>
  36353. <exception cref="T:System.ArgumentNullException">
  36354. <paramref name="host"/> is <c>null</c>.
  36355. </exception>
  36356. <exception cref="T:System.ArgumentOutOfRangeException">
  36357. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  36358. </exception>
  36359. <exception cref="T:System.ArgumentException">
  36360. The <paramref name="host"/> is a zero-length string.
  36361. </exception>
  36362. <exception cref="T:System.InvalidOperationException">
  36363. The <see cref="T:MailKit.IMailService"/> is already connected.
  36364. </exception>
  36365. <exception cref="T:System.OperationCanceledException">
  36366. The operation was canceled via the cancellation token.
  36367. </exception>
  36368. <exception cref="T:System.IO.IOException">
  36369. An I/O error occurred.
  36370. </exception>
  36371. <exception cref="T:MailKit.CommandException">
  36372. The command was rejected by the mail server.
  36373. </exception>
  36374. <exception cref="T:MailKit.ProtocolException">
  36375. The server responded with an unexpected token.
  36376. </exception>
  36377. </member>
  36378. <member name="M:MailKit.IMailService.ConnectAsync(System.String,System.Int32,System.Boolean,System.Threading.CancellationToken)">
  36379. <summary>
  36380. Asynchronously establish a connection to the specified mail server.
  36381. </summary>
  36382. <remarks>
  36383. <para>Asynchronously establishes a connection to the specified mail server.</para>
  36384. <para>If a successful connection is made, the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/>
  36385. property will be populated.</para>
  36386. </remarks>
  36387. <returns>An asynchronous task context.</returns>
  36388. <param name="host">The host name to connect to.</param>
  36389. <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
  36390. <param name="useSsl"><value>true</value> if the client should make an SSL-wrapped connection to the server; otherwise, <value>false</value>.</param>
  36391. <param name="cancellationToken">The cancellation token.</param>
  36392. <exception cref="T:System.ArgumentNullException">
  36393. The <paramref name="host"/> is <c>null</c>.
  36394. </exception>
  36395. <exception cref="T:System.ArgumentOutOfRangeException">
  36396. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  36397. </exception>
  36398. <exception cref="T:System.ArgumentException">
  36399. The <paramref name="host"/> is a zero-length string.
  36400. </exception>
  36401. <exception cref="T:System.ObjectDisposedException">
  36402. The <see cref="T:MailKit.IMailService"/> has been disposed.
  36403. </exception>
  36404. <exception cref="T:System.InvalidOperationException">
  36405. The <see cref="T:MailKit.IMailService"/> is already connected.
  36406. </exception>
  36407. <exception cref="T:System.OperationCanceledException">
  36408. The operation was canceled via the cancellation token.
  36409. </exception>
  36410. <exception cref="T:System.IO.IOException">
  36411. An I/O error occurred.
  36412. </exception>
  36413. <exception cref="T:MailKit.ProtocolException">
  36414. A protocol error occurred.
  36415. </exception>
  36416. </member>
  36417. <member name="M:MailKit.IMailService.Connect(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
  36418. <summary>
  36419. Establish a connection to the specified mail server.
  36420. </summary>
  36421. <remarks>
  36422. <para>Establish a connection to the specified mail server.</para>
  36423. <para>If a successful connection is made, the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/>
  36424. property will be populated.</para>
  36425. </remarks>
  36426. <param name="host">The host name to connect to.</param>
  36427. <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
  36428. <param name="options">The secure socket options to when connecting.</param>
  36429. <param name="cancellationToken">The cancellation token.</param>
  36430. <exception cref="T:System.ArgumentNullException">
  36431. <paramref name="host"/> is <c>null</c>.
  36432. </exception>
  36433. <exception cref="T:System.ArgumentOutOfRangeException">
  36434. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  36435. </exception>
  36436. <exception cref="T:System.ArgumentException">
  36437. The <paramref name="host"/> is a zero-length string.
  36438. </exception>
  36439. <exception cref="T:System.InvalidOperationException">
  36440. The <see cref="T:MailKit.IMailService"/> is already connected.
  36441. </exception>
  36442. <exception cref="T:System.OperationCanceledException">
  36443. The operation was canceled via the cancellation token.
  36444. </exception>
  36445. <exception cref="T:System.IO.IOException">
  36446. An I/O error occurred.
  36447. </exception>
  36448. <exception cref="T:MailKit.CommandException">
  36449. The command was rejected by the mail server.
  36450. </exception>
  36451. <exception cref="T:MailKit.ProtocolException">
  36452. The server responded with an unexpected token.
  36453. </exception>
  36454. </member>
  36455. <member name="M:MailKit.IMailService.ConnectAsync(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
  36456. <summary>
  36457. Asynchronously establish a connection to the specified mail server.
  36458. </summary>
  36459. <remarks>
  36460. <para>Asynchronously establishes a connection to the specified mail server.</para>
  36461. <para>If a successful connection is made, the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/>
  36462. property will be populated.</para>
  36463. </remarks>
  36464. <returns>An asynchronous task context.</returns>
  36465. <param name="host">The host name to connect to.</param>
  36466. <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
  36467. <param name="options">The secure socket options to when connecting.</param>
  36468. <param name="cancellationToken">The cancellation token.</param>
  36469. <exception cref="T:System.ArgumentNullException">
  36470. The <paramref name="host"/> is <c>null</c>.
  36471. </exception>
  36472. <exception cref="T:System.ArgumentOutOfRangeException">
  36473. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  36474. </exception>
  36475. <exception cref="T:System.ArgumentException">
  36476. The <paramref name="host"/> is a zero-length string.
  36477. </exception>
  36478. <exception cref="T:System.ObjectDisposedException">
  36479. The <see cref="T:MailKit.IMailService"/> has been disposed.
  36480. </exception>
  36481. <exception cref="T:System.InvalidOperationException">
  36482. The <see cref="T:MailKit.IMailService"/> is already connected.
  36483. </exception>
  36484. <exception cref="T:System.OperationCanceledException">
  36485. The operation was canceled via the cancellation token.
  36486. </exception>
  36487. <exception cref="T:System.IO.IOException">
  36488. An I/O error occurred.
  36489. </exception>
  36490. <exception cref="T:MailKit.ProtocolException">
  36491. A protocol error occurred.
  36492. </exception>
  36493. </member>
  36494. <member name="M:MailKit.IMailService.Connect(System.Net.Sockets.Socket,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
  36495. <summary>
  36496. Establish a connection to the specified mail server using the provided socket.
  36497. </summary>
  36498. <remarks>
  36499. <para>Establish a connection to the specified mail server using the provided socket.</para>
  36500. <para>If a successful connection is made, the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/>
  36501. property will be populated.</para>
  36502. </remarks>
  36503. <param name="socket">The socket to use for the connection.</param>
  36504. <param name="host">The host name to connect to.</param>
  36505. <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
  36506. <param name="options">The secure socket options to when connecting.</param>
  36507. <param name="cancellationToken">The cancellation token.</param>
  36508. <exception cref="T:System.ArgumentNullException">
  36509. <para><paramref name="socket"/> is <c>null</c>.</para>
  36510. <para>-or-</para>
  36511. <para><paramref name="host"/> is <c>null</c>.</para>
  36512. </exception>
  36513. <exception cref="T:System.ArgumentOutOfRangeException">
  36514. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  36515. </exception>
  36516. <exception cref="T:System.ArgumentException">
  36517. <para><paramref name="socket"/> is not connected.</para>
  36518. <para>-or-</para>
  36519. <para>The <paramref name="host"/> is a zero-length string.</para>
  36520. </exception>
  36521. <exception cref="T:System.InvalidOperationException">
  36522. The <see cref="T:MailKit.IMailService"/> is already connected.
  36523. </exception>
  36524. <exception cref="T:System.OperationCanceledException">
  36525. The operation was canceled via the cancellation token.
  36526. </exception>
  36527. <exception cref="T:System.IO.IOException">
  36528. An I/O error occurred.
  36529. </exception>
  36530. <exception cref="T:MailKit.CommandException">
  36531. The command was rejected by the mail server.
  36532. </exception>
  36533. <exception cref="T:MailKit.ProtocolException">
  36534. The server responded with an unexpected token.
  36535. </exception>
  36536. </member>
  36537. <member name="M:MailKit.IMailService.ConnectAsync(System.Net.Sockets.Socket,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
  36538. <summary>
  36539. Asynchronously establish a connection to the specified mail server using the provided socket.
  36540. </summary>
  36541. <remarks>
  36542. <para>Asynchronously establishes a connection to the specified mail server using the provided socket.</para>
  36543. <para>If a successful connection is made, the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/>
  36544. property will be populated.</para>
  36545. </remarks>
  36546. <returns>An asynchronous task context.</returns>
  36547. <param name="socket">The socket to use for the connection.</param>
  36548. <param name="host">The host name to connect to.</param>
  36549. <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
  36550. <param name="options">The secure socket options to when connecting.</param>
  36551. <param name="cancellationToken">The cancellation token.</param>
  36552. <exception cref="T:System.ArgumentNullException">
  36553. <para><paramref name="socket"/> is <c>null</c>.</para>
  36554. <para>-or-</para>
  36555. <para><paramref name="host"/> is <c>null</c>.</para>
  36556. </exception>
  36557. <exception cref="T:System.ArgumentOutOfRangeException">
  36558. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  36559. </exception>
  36560. <exception cref="T:System.ArgumentException">
  36561. <para><paramref name="socket"/> is not connected.</para>
  36562. <para>-or-</para>
  36563. <para>The <paramref name="host"/> is a zero-length string.</para>
  36564. </exception>
  36565. <exception cref="T:System.InvalidOperationException">
  36566. The <see cref="T:MailKit.IMailService"/> is already connected.
  36567. </exception>
  36568. <exception cref="T:System.OperationCanceledException">
  36569. The operation was canceled via the cancellation token.
  36570. </exception>
  36571. <exception cref="T:System.IO.IOException">
  36572. An I/O error occurred.
  36573. </exception>
  36574. <exception cref="T:MailKit.CommandException">
  36575. The command was rejected by the mail server.
  36576. </exception>
  36577. <exception cref="T:MailKit.ProtocolException">
  36578. The server responded with an unexpected token.
  36579. </exception>
  36580. </member>
  36581. <member name="M:MailKit.IMailService.Connect(System.IO.Stream,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
  36582. <summary>
  36583. Establish a connection to the specified mail server using the provided stream.
  36584. </summary>
  36585. <remarks>
  36586. <para>Establish a connection to the specified mail server using the provided stream.</para>
  36587. <para>If a successful connection is made, the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/>
  36588. property will be populated.</para>
  36589. </remarks>
  36590. <param name="stream">The stream to use for the connection.</param>
  36591. <param name="host">The host name to connect to.</param>
  36592. <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
  36593. <param name="options">The secure socket options to when connecting.</param>
  36594. <param name="cancellationToken">The cancellation token.</param>
  36595. <exception cref="T:System.ArgumentNullException">
  36596. <para><paramref name="stream"/> is <c>null</c>.</para>
  36597. <para>-or-</para>
  36598. <para><paramref name="host"/> is <c>null</c>.</para>
  36599. </exception>
  36600. <exception cref="T:System.ArgumentOutOfRangeException">
  36601. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  36602. </exception>
  36603. <exception cref="T:System.ArgumentException">
  36604. The <paramref name="host"/> is a zero-length string.
  36605. </exception>
  36606. <exception cref="T:System.InvalidOperationException">
  36607. The <see cref="T:MailKit.IMailService"/> is already connected.
  36608. </exception>
  36609. <exception cref="T:System.OperationCanceledException">
  36610. The operation was canceled via the cancellation token.
  36611. </exception>
  36612. <exception cref="T:System.IO.IOException">
  36613. An I/O error occurred.
  36614. </exception>
  36615. <exception cref="T:MailKit.CommandException">
  36616. The command was rejected by the mail server.
  36617. </exception>
  36618. <exception cref="T:MailKit.ProtocolException">
  36619. The server responded with an unexpected token.
  36620. </exception>
  36621. </member>
  36622. <member name="M:MailKit.IMailService.ConnectAsync(System.IO.Stream,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
  36623. <summary>
  36624. Asynchronously establish a connection to the specified mail server using the provided stream.
  36625. </summary>
  36626. <remarks>
  36627. <para>Asynchronously establishes a connection to the specified mail server using the provided stream.</para>
  36628. <para>If a successful connection is made, the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/>
  36629. property will be populated.</para>
  36630. </remarks>
  36631. <returns>An asynchronous task context.</returns>
  36632. <param name="stream">The stream to use for the connection.</param>
  36633. <param name="host">The host name to connect to.</param>
  36634. <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
  36635. <param name="options">The secure socket options to when connecting.</param>
  36636. <param name="cancellationToken">The cancellation token.</param>
  36637. <exception cref="T:System.ArgumentNullException">
  36638. <para><paramref name="stream"/> is <c>null</c>.</para>
  36639. <para>-or-</para>
  36640. <para><paramref name="host"/> is <c>null</c>.</para>
  36641. </exception>
  36642. <exception cref="T:System.ArgumentOutOfRangeException">
  36643. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  36644. </exception>
  36645. <exception cref="T:System.ArgumentException">
  36646. The <paramref name="host"/> is a zero-length string.
  36647. </exception>
  36648. <exception cref="T:System.InvalidOperationException">
  36649. The <see cref="T:MailKit.IMailService"/> is already connected.
  36650. </exception>
  36651. <exception cref="T:System.OperationCanceledException">
  36652. The operation was canceled via the cancellation token.
  36653. </exception>
  36654. <exception cref="T:System.IO.IOException">
  36655. An I/O error occurred.
  36656. </exception>
  36657. <exception cref="T:MailKit.CommandException">
  36658. The command was rejected by the mail server.
  36659. </exception>
  36660. <exception cref="T:MailKit.ProtocolException">
  36661. The server responded with an unexpected token.
  36662. </exception>
  36663. </member>
  36664. <member name="M:MailKit.IMailService.Authenticate(System.Net.ICredentials,System.Threading.CancellationToken)">
  36665. <summary>
  36666. Authenticate using the supplied credentials.
  36667. </summary>
  36668. <remarks>
  36669. <para>Authenticates using the supplied credentials.</para>
  36670. <para>If the server supports one or more SASL authentication mechanisms, then
  36671. the SASL mechanisms that both the client and server support are tried
  36672. in order of greatest security to weakest security. Once a SASL
  36673. authentication mechanism is found that both client and server support,
  36674. the credentials are used to authenticate.</para>
  36675. <para>If the server does not support SASL or if no common SASL mechanisms
  36676. can be found, then the default login command is used as a fallback.</para>
  36677. </remarks>
  36678. <param name="credentials">The user's credentials.</param>
  36679. <param name="cancellationToken">The cancellation token.</param>
  36680. <exception cref="T:System.ArgumentNullException">
  36681. <paramref name="credentials"/> is <c>null</c>.
  36682. </exception>
  36683. <exception cref="T:System.ObjectDisposedException">
  36684. The <see cref="T:MailKit.IMailService"/> has been disposed.
  36685. </exception>
  36686. <exception cref="T:MailKit.ServiceNotConnectedException">
  36687. The <see cref="T:MailKit.IMailService"/> is not connected.
  36688. </exception>
  36689. <exception cref="T:System.InvalidOperationException">
  36690. The <see cref="T:MailKit.IMailService"/> is already authenticated.
  36691. </exception>
  36692. <exception cref="T:System.OperationCanceledException">
  36693. The operation was canceled via the cancellation token.
  36694. </exception>
  36695. <exception cref="T:MailKit.Security.AuthenticationException">
  36696. Authentication using the supplied credentials has failed.
  36697. </exception>
  36698. <exception cref="T:MailKit.Security.SaslException">
  36699. A SASL authentication error occurred.
  36700. </exception>
  36701. <exception cref="T:System.IO.IOException">
  36702. An I/O error occurred.
  36703. </exception>
  36704. <exception cref="T:MailKit.ProtocolException">
  36705. A protocol error occurred.
  36706. </exception>
  36707. </member>
  36708. <member name="M:MailKit.IMailService.AuthenticateAsync(System.Net.ICredentials,System.Threading.CancellationToken)">
  36709. <summary>
  36710. Asynchronously authenticate using the supplied credentials.
  36711. </summary>
  36712. <remarks>
  36713. <para>Asynchronously authenticates using the supplied credentials.</para>
  36714. <para>If the server supports one or more SASL authentication mechanisms, then
  36715. the SASL mechanisms that both the client and server support are tried
  36716. in order of greatest security to weakest security. Once a SASL
  36717. authentication mechanism is found that both client and server support,
  36718. the credentials are used to authenticate.</para>
  36719. <para>If the server does not support SASL or if no common SASL mechanisms
  36720. can be found, then the default login command is used as a fallback.</para>
  36721. </remarks>
  36722. <returns>An asynchronous task context.</returns>
  36723. <param name="credentials">The user's credentials.</param>
  36724. <param name="cancellationToken">The cancellation token.</param>
  36725. <exception cref="T:System.ArgumentNullException">
  36726. <paramref name="credentials"/> is <c>null</c>.
  36727. </exception>
  36728. <exception cref="T:System.ObjectDisposedException">
  36729. The <see cref="T:MailKit.IMailService"/> has been disposed.
  36730. </exception>
  36731. <exception cref="T:MailKit.ServiceNotConnectedException">
  36732. The <see cref="T:MailKit.IMailService"/> is not connected.
  36733. </exception>
  36734. <exception cref="T:System.InvalidOperationException">
  36735. The <see cref="T:MailKit.IMailService"/> is already authenticated.
  36736. </exception>
  36737. <exception cref="T:System.OperationCanceledException">
  36738. The operation was canceled via the cancellation token.
  36739. </exception>
  36740. <exception cref="T:MailKit.Security.AuthenticationException">
  36741. Authentication using the supplied credentials has failed.
  36742. </exception>
  36743. <exception cref="T:MailKit.Security.SaslException">
  36744. A SASL authentication error occurred.
  36745. </exception>
  36746. <exception cref="T:System.IO.IOException">
  36747. An I/O error occurred.
  36748. </exception>
  36749. <exception cref="T:MailKit.ProtocolException">
  36750. A protocol error occurred.
  36751. </exception>
  36752. </member>
  36753. <member name="M:MailKit.IMailService.Authenticate(System.Text.Encoding,System.Net.ICredentials,System.Threading.CancellationToken)">
  36754. <summary>
  36755. Authenticate using the supplied credentials.
  36756. </summary>
  36757. <remarks>
  36758. <para>Authenticates using the supplied credentials.</para>
  36759. <para>If the server supports one or more SASL authentication mechanisms, then
  36760. the SASL mechanisms that both the client and server support are tried
  36761. in order of greatest security to weakest security. Once a SASL
  36762. authentication mechanism is found that both client and server support,
  36763. the credentials are used to authenticate.</para>
  36764. <para>If the server does not support SASL or if no common SASL mechanisms
  36765. can be found, then the default login command is used as a fallback.</para>
  36766. </remarks>
  36767. <param name="encoding">The encoding to use for the user's credentials.</param>
  36768. <param name="credentials">The user's credentials.</param>
  36769. <param name="cancellationToken">The cancellation token.</param>
  36770. <exception cref="T:System.ArgumentNullException">
  36771. <para><paramref name="encoding"/> is <c>null</c>.</para>
  36772. <para>-or-</para>
  36773. <para><paramref name="credentials"/> is <c>null</c>.</para>
  36774. </exception>
  36775. <exception cref="T:System.ObjectDisposedException">
  36776. The <see cref="T:MailKit.IMailService"/> has been disposed.
  36777. </exception>
  36778. <exception cref="T:MailKit.ServiceNotConnectedException">
  36779. The <see cref="T:MailKit.IMailService"/> is not connected.
  36780. </exception>
  36781. <exception cref="T:System.InvalidOperationException">
  36782. The <see cref="T:MailKit.IMailService"/> is already authenticated.
  36783. </exception>
  36784. <exception cref="T:System.OperationCanceledException">
  36785. The operation was canceled via the cancellation token.
  36786. </exception>
  36787. <exception cref="T:MailKit.Security.AuthenticationException">
  36788. Authentication using the supplied credentials has failed.
  36789. </exception>
  36790. <exception cref="T:MailKit.Security.SaslException">
  36791. A SASL authentication error occurred.
  36792. </exception>
  36793. <exception cref="T:System.IO.IOException">
  36794. An I/O error occurred.
  36795. </exception>
  36796. <exception cref="T:MailKit.ProtocolException">
  36797. A protocol error occurred.
  36798. </exception>
  36799. </member>
  36800. <member name="M:MailKit.IMailService.AuthenticateAsync(System.Text.Encoding,System.Net.ICredentials,System.Threading.CancellationToken)">
  36801. <summary>
  36802. Asynchronously authenticate using the supplied credentials.
  36803. </summary>
  36804. <remarks>
  36805. <para>Asynchronously authenticates using the supplied credentials.</para>
  36806. <para>If the server supports one or more SASL authentication mechanisms, then
  36807. the SASL mechanisms that both the client and server support are tried
  36808. in order of greatest security to weakest security. Once a SASL
  36809. authentication mechanism is found that both client and server support,
  36810. the credentials are used to authenticate.</para>
  36811. <para>If the server does not support SASL or if no common SASL mechanisms
  36812. can be found, then the default login command is used as a fallback.</para>
  36813. </remarks>
  36814. <returns>An asynchronous task context.</returns>
  36815. <param name="encoding">The encoding to use for the user's credentials.</param>
  36816. <param name="credentials">The user's credentials.</param>
  36817. <param name="cancellationToken">The cancellation token.</param>
  36818. <exception cref="T:System.ArgumentNullException">
  36819. <para><paramref name="encoding"/> is <c>null</c>.</para>
  36820. <para>-or-</para>
  36821. <para><paramref name="credentials"/> is <c>null</c>.</para>
  36822. </exception>
  36823. <exception cref="T:System.ObjectDisposedException">
  36824. The <see cref="T:MailKit.IMailService"/> has been disposed.
  36825. </exception>
  36826. <exception cref="T:MailKit.ServiceNotConnectedException">
  36827. The <see cref="T:MailKit.IMailService"/> is not connected.
  36828. </exception>
  36829. <exception cref="T:System.InvalidOperationException">
  36830. The <see cref="T:MailKit.IMailService"/> is already authenticated.
  36831. </exception>
  36832. <exception cref="T:System.OperationCanceledException">
  36833. The operation was canceled via the cancellation token.
  36834. </exception>
  36835. <exception cref="T:MailKit.Security.AuthenticationException">
  36836. Authentication using the supplied credentials has failed.
  36837. </exception>
  36838. <exception cref="T:MailKit.Security.SaslException">
  36839. A SASL authentication error occurred.
  36840. </exception>
  36841. <exception cref="T:System.IO.IOException">
  36842. An I/O error occurred.
  36843. </exception>
  36844. <exception cref="T:MailKit.ProtocolException">
  36845. A protocol error occurred.
  36846. </exception>
  36847. </member>
  36848. <member name="M:MailKit.IMailService.Authenticate(System.Text.Encoding,System.String,System.String,System.Threading.CancellationToken)">
  36849. <summary>
  36850. Authenticate using the specified user name and password.
  36851. </summary>
  36852. <remarks>
  36853. <para>If the server supports one or more SASL authentication mechanisms,
  36854. then the SASL mechanisms that both the client and server support are tried
  36855. in order of greatest security to weakest security. Once a SASL
  36856. authentication mechanism is found that both client and server support,
  36857. the credentials are used to authenticate.</para>
  36858. <para>If the server does not support SASL or if no common SASL mechanisms
  36859. can be found, then the default login command is used as a fallback.</para>
  36860. <note type="tip">To prevent the usage of certain authentication mechanisms,
  36861. simply remove them from the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/> hash set
  36862. before calling this method.</note>
  36863. </remarks>
  36864. <param name="encoding">The encoding to use for the user's credentials.</param>
  36865. <param name="userName">The user name.</param>
  36866. <param name="password">The password.</param>
  36867. <param name="cancellationToken">The cancellation token.</param>
  36868. <exception cref="T:System.ArgumentNullException">
  36869. <para><paramref name="encoding"/> is <c>null</c>.</para>
  36870. <para>-or-</para>
  36871. <para><paramref name="userName"/> is <c>null</c>.</para>
  36872. <para>-or-</para>
  36873. <para><paramref name="password"/> is <c>null</c>.</para>
  36874. </exception>
  36875. <exception cref="T:System.ObjectDisposedException">
  36876. The <see cref="T:MailKit.MailService"/> has been disposed.
  36877. </exception>
  36878. <exception cref="T:System.InvalidOperationException">
  36879. The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
  36880. </exception>
  36881. <exception cref="T:System.OperationCanceledException">
  36882. The operation was canceled via the cancellation token.
  36883. </exception>
  36884. <exception cref="T:MailKit.Security.AuthenticationException">
  36885. Authentication using the supplied credentials has failed.
  36886. </exception>
  36887. <exception cref="T:MailKit.Security.SaslException">
  36888. A SASL authentication error occurred.
  36889. </exception>
  36890. <exception cref="T:System.IO.IOException">
  36891. An I/O error occurred.
  36892. </exception>
  36893. <exception cref="T:MailKit.ProtocolException">
  36894. A protocol error occurred.
  36895. </exception>
  36896. </member>
  36897. <member name="M:MailKit.IMailService.AuthenticateAsync(System.Text.Encoding,System.String,System.String,System.Threading.CancellationToken)">
  36898. <summary>
  36899. Asynchronously authenticate using the specified user name and password.
  36900. </summary>
  36901. <remarks>
  36902. <para>If the server supports one or more SASL authentication mechanisms,
  36903. then the SASL mechanisms that both the client and server support are tried
  36904. in order of greatest security to weakest security. Once a SASL
  36905. authentication mechanism is found that both client and server support,
  36906. the credentials are used to authenticate.</para>
  36907. <para>If the server does not support SASL or if no common SASL mechanisms
  36908. can be found, then the default login command is used as a fallback.</para>
  36909. <note type="tip">To prevent the usage of certain authentication mechanisms,
  36910. simply remove them from the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/> hash set
  36911. before calling this method.</note>
  36912. </remarks>
  36913. <returns>An asynchronous task context.</returns>
  36914. <param name="encoding">The encoding to use for the user's credentials.</param>
  36915. <param name="userName">The user name.</param>
  36916. <param name="password">The password.</param>
  36917. <param name="cancellationToken">The cancellation token.</param>
  36918. <exception cref="T:System.ArgumentNullException">
  36919. <para><paramref name="encoding"/> is <c>null</c>.</para>
  36920. <para>-or-</para>
  36921. <para><paramref name="userName"/> is <c>null</c>.</para>
  36922. <para>-or-</para>
  36923. <para><paramref name="password"/> is <c>null</c>.</para>
  36924. </exception>
  36925. <exception cref="T:System.ObjectDisposedException">
  36926. The <see cref="T:MailKit.MailService"/> has been disposed.
  36927. </exception>
  36928. <exception cref="T:System.InvalidOperationException">
  36929. The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
  36930. </exception>
  36931. <exception cref="T:System.OperationCanceledException">
  36932. The operation was canceled via the cancellation token.
  36933. </exception>
  36934. <exception cref="T:MailKit.Security.AuthenticationException">
  36935. Authentication using the supplied credentials has failed.
  36936. </exception>
  36937. <exception cref="T:MailKit.Security.SaslException">
  36938. A SASL authentication error occurred.
  36939. </exception>
  36940. <exception cref="T:System.IO.IOException">
  36941. An I/O error occurred.
  36942. </exception>
  36943. <exception cref="T:MailKit.ProtocolException">
  36944. A protocol error occurred.
  36945. </exception>
  36946. </member>
  36947. <member name="M:MailKit.IMailService.Authenticate(System.String,System.String,System.Threading.CancellationToken)">
  36948. <summary>
  36949. Authenticate using the specified user name and password.
  36950. </summary>
  36951. <remarks>
  36952. <para>If the server supports one or more SASL authentication mechanisms,
  36953. then the SASL mechanisms that both the client and server support are tried
  36954. in order of greatest security to weakest security. Once a SASL
  36955. authentication mechanism is found that both client and server support,
  36956. the credentials are used to authenticate.</para>
  36957. <para>If the server does not support SASL or if no common SASL mechanisms
  36958. can be found, then the default login command is used as a fallback.</para>
  36959. <note type="tip">To prevent the usage of certain authentication mechanisms,
  36960. simply remove them from the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/> hash set
  36961. before calling this method.</note>
  36962. </remarks>
  36963. <example>
  36964. <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessage"/>
  36965. </example>
  36966. <param name="userName">The user name.</param>
  36967. <param name="password">The password.</param>
  36968. <param name="cancellationToken">The cancellation token.</param>
  36969. <exception cref="T:System.ArgumentNullException">
  36970. <para><paramref name="userName"/> is <c>null</c>.</para>
  36971. <para>-or-</para>
  36972. <para><paramref name="password"/> is <c>null</c>.</para>
  36973. </exception>
  36974. <exception cref="T:System.ObjectDisposedException">
  36975. The <see cref="T:MailKit.MailService"/> has been disposed.
  36976. </exception>
  36977. <exception cref="T:System.InvalidOperationException">
  36978. The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
  36979. </exception>
  36980. <exception cref="T:System.OperationCanceledException">
  36981. The operation was canceled via the cancellation token.
  36982. </exception>
  36983. <exception cref="T:MailKit.Security.AuthenticationException">
  36984. Authentication using the supplied credentials has failed.
  36985. </exception>
  36986. <exception cref="T:MailKit.Security.SaslException">
  36987. A SASL authentication error occurred.
  36988. </exception>
  36989. <exception cref="T:System.IO.IOException">
  36990. An I/O error occurred.
  36991. </exception>
  36992. <exception cref="T:MailKit.ProtocolException">
  36993. A protocol error occurred.
  36994. </exception>
  36995. </member>
  36996. <member name="M:MailKit.IMailService.AuthenticateAsync(System.String,System.String,System.Threading.CancellationToken)">
  36997. <summary>
  36998. Asynchronously authenticate using the specified user name and password.
  36999. </summary>
  37000. <remarks>
  37001. <para>If the server supports one or more SASL authentication mechanisms,
  37002. then the SASL mechanisms that both the client and server support are tried
  37003. in order of greatest security to weakest security. Once a SASL
  37004. authentication mechanism is found that both client and server support,
  37005. the credentials are used to authenticate.</para>
  37006. <para>If the server does not support SASL or if no common SASL mechanisms
  37007. can be found, then the default login command is used as a fallback.</para>
  37008. <note type="tip">To prevent the usage of certain authentication mechanisms,
  37009. simply remove them from the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/> hash set
  37010. before calling this method.</note>
  37011. </remarks>
  37012. <returns>An asynchronous task context.</returns>
  37013. <param name="userName">The user name.</param>
  37014. <param name="password">The password.</param>
  37015. <param name="cancellationToken">The cancellation token.</param>
  37016. <exception cref="T:System.ArgumentNullException">
  37017. <para><paramref name="userName"/> is <c>null</c>.</para>
  37018. <para>-or-</para>
  37019. <para><paramref name="password"/> is <c>null</c>.</para>
  37020. </exception>
  37021. <exception cref="T:System.ObjectDisposedException">
  37022. The <see cref="T:MailKit.MailService"/> has been disposed.
  37023. </exception>
  37024. <exception cref="T:System.InvalidOperationException">
  37025. The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
  37026. </exception>
  37027. <exception cref="T:System.OperationCanceledException">
  37028. The operation was canceled via the cancellation token.
  37029. </exception>
  37030. <exception cref="T:MailKit.Security.AuthenticationException">
  37031. Authentication using the supplied credentials has failed.
  37032. </exception>
  37033. <exception cref="T:MailKit.Security.SaslException">
  37034. A SASL authentication error occurred.
  37035. </exception>
  37036. <exception cref="T:System.IO.IOException">
  37037. An I/O error occurred.
  37038. </exception>
  37039. <exception cref="T:MailKit.ProtocolException">
  37040. A protocol error occurred.
  37041. </exception>
  37042. </member>
  37043. <member name="M:MailKit.IMailService.Authenticate(MailKit.Security.SaslMechanism,System.Threading.CancellationToken)">
  37044. <summary>
  37045. Authenticate using the specified SASL mechanism.
  37046. </summary>
  37047. <remarks>
  37048. <para>Authenticates using the specified SASL mechanism.</para>
  37049. <para>For a list of available SASL authentication mechanisms supported by the server,
  37050. check the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/> property after the service has been
  37051. connected.</para>
  37052. </remarks>
  37053. <param name="mechanism">The SASL mechanism.</param>
  37054. <param name="cancellationToken">The cancellation token.</param>
  37055. <exception cref="T:System.ArgumentNullException">
  37056. <paramref name="mechanism"/> is <c>null</c>.
  37057. </exception>
  37058. <exception cref="T:System.ObjectDisposedException">
  37059. The <see cref="T:MailKit.MailService"/> has been disposed.
  37060. </exception>
  37061. <exception cref="T:System.InvalidOperationException">
  37062. The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
  37063. </exception>
  37064. <exception cref="T:System.OperationCanceledException">
  37065. The operation was canceled via the cancellation token.
  37066. </exception>
  37067. <exception cref="T:MailKit.Security.AuthenticationException">
  37068. Authentication using the supplied credentials has failed.
  37069. </exception>
  37070. <exception cref="T:MailKit.Security.SaslException">
  37071. A SASL authentication error occurred.
  37072. </exception>
  37073. <exception cref="T:System.IO.IOException">
  37074. An I/O error occurred.
  37075. </exception>
  37076. <exception cref="T:MailKit.ProtocolException">
  37077. A protocol error occurred.
  37078. </exception>
  37079. </member>
  37080. <member name="M:MailKit.IMailService.AuthenticateAsync(MailKit.Security.SaslMechanism,System.Threading.CancellationToken)">
  37081. <summary>
  37082. Asynchronously authenticate using the specified SASL mechanism.
  37083. </summary>
  37084. <remarks>
  37085. <para>Authenticates using the specified SASL mechanism.</para>
  37086. <para>For a list of available SASL authentication mechanisms supported by the server,
  37087. check the <see cref="P:MailKit.IMailService.AuthenticationMechanisms"/> property after the service has been
  37088. connected.</para>
  37089. </remarks>
  37090. <returns>An asynchronous task context.</returns>
  37091. <param name="mechanism">The SASL mechanism.</param>
  37092. <param name="cancellationToken">The cancellation token.</param>
  37093. <exception cref="T:System.ArgumentNullException">
  37094. <paramref name="mechanism"/> is <c>null</c>.
  37095. </exception>
  37096. <exception cref="T:System.ObjectDisposedException">
  37097. The <see cref="T:MailKit.MailService"/> has been disposed.
  37098. </exception>
  37099. <exception cref="T:System.InvalidOperationException">
  37100. The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
  37101. </exception>
  37102. <exception cref="T:System.OperationCanceledException">
  37103. The operation was canceled via the cancellation token.
  37104. </exception>
  37105. <exception cref="T:MailKit.Security.AuthenticationException">
  37106. Authentication using the supplied credentials has failed.
  37107. </exception>
  37108. <exception cref="T:MailKit.Security.SaslException">
  37109. A SASL authentication error occurred.
  37110. </exception>
  37111. <exception cref="T:System.IO.IOException">
  37112. An I/O error occurred.
  37113. </exception>
  37114. <exception cref="T:MailKit.ProtocolException">
  37115. A protocol error occurred.
  37116. </exception>
  37117. </member>
  37118. <member name="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)">
  37119. <summary>
  37120. Disconnect the service.
  37121. </summary>
  37122. <remarks>
  37123. <para>Disconnects from the service.</para>
  37124. <para>If <paramref name="quit"/> is <c>true</c>, a "QUIT" command will be issued in order to disconnect cleanly.</para>
  37125. </remarks>
  37126. <param name="quit">If set to <c>true</c>, a "QUIT" command will be issued in order to disconnect cleanly.</param>
  37127. <param name="cancellationToken">The cancellation token.</param>
  37128. <exception cref="T:System.ObjectDisposedException">
  37129. The <see cref="T:MailKit.IMailService"/> has been disposed.
  37130. </exception>
  37131. <exception cref="T:MailKit.ServiceNotConnectedException">
  37132. The <see cref="T:MailKit.IMailService"/> is not connected.
  37133. </exception>
  37134. <exception cref="T:System.OperationCanceledException">
  37135. The operation was canceled via the cancellation token.
  37136. </exception>
  37137. <exception cref="T:System.IO.IOException">
  37138. An I/O error occurred.
  37139. </exception>
  37140. <exception cref="T:MailKit.CommandException">
  37141. The command was rejected by the mail server.
  37142. </exception>
  37143. <exception cref="T:MailKit.ProtocolException">
  37144. The server responded with an unexpected token.
  37145. </exception>
  37146. </member>
  37147. <member name="M:MailKit.IMailService.DisconnectAsync(System.Boolean,System.Threading.CancellationToken)">
  37148. <summary>
  37149. Asynchronously disconnect the service.
  37150. </summary>
  37151. <remarks>
  37152. <para>Asynchronously disconnects from the service.</para>
  37153. <para>If <paramref name="quit"/> is <c>true</c>, a "QUIT" command will be issued in order to disconnect cleanly.</para>
  37154. </remarks>
  37155. <returns>An asynchronous task context.</returns>
  37156. <param name="quit">If set to <c>true</c>, a logout/quit command will be issued in order to disconnect cleanly.</param>
  37157. <param name="cancellationToken">The cancellation token.</param>
  37158. <exception cref="T:System.ObjectDisposedException">
  37159. The <see cref="T:MailKit.IMailService"/> has been disposed.
  37160. </exception>
  37161. <exception cref="T:MailKit.ServiceNotConnectedException">
  37162. The <see cref="T:MailKit.IMailService"/> is not connected.
  37163. </exception>
  37164. <exception cref="T:System.OperationCanceledException">
  37165. The operation was canceled via the cancellation token.
  37166. </exception>
  37167. <exception cref="T:System.IO.IOException">
  37168. An I/O error occurred.
  37169. </exception>
  37170. <exception cref="T:MailKit.CommandException">
  37171. The command was rejected by the mail server.
  37172. </exception>
  37173. <exception cref="T:MailKit.ProtocolException">
  37174. The server responded with an unexpected token.
  37175. </exception>
  37176. </member>
  37177. <member name="M:MailKit.IMailService.NoOp(System.Threading.CancellationToken)">
  37178. <summary>
  37179. Ping the message service to keep the connection alive.
  37180. </summary>
  37181. <remarks>
  37182. Mail servers, if left idle for too long, will automatically drop the connection.
  37183. </remarks>
  37184. <param name="cancellationToken">The cancellation token.</param>
  37185. <exception cref="T:System.ObjectDisposedException">
  37186. The <see cref="T:MailKit.IMailService"/> has been disposed.
  37187. </exception>
  37188. <exception cref="T:MailKit.ServiceNotConnectedException">
  37189. The <see cref="T:MailKit.IMailService"/> is not connected.
  37190. </exception>
  37191. <exception cref="T:System.OperationCanceledException">
  37192. The operation was canceled via the cancellation token.
  37193. </exception>
  37194. <exception cref="T:System.IO.IOException">
  37195. An I/O error occurred.
  37196. </exception>
  37197. <exception cref="T:MailKit.CommandException">
  37198. The command was rejected by the mail server.
  37199. </exception>
  37200. <exception cref="T:MailKit.ProtocolException">
  37201. The server responded with an unexpected token.
  37202. </exception>
  37203. </member>
  37204. <member name="M:MailKit.IMailService.NoOpAsync(System.Threading.CancellationToken)">
  37205. <summary>
  37206. Asynchronously ping the mail server to keep the connection alive.
  37207. </summary>
  37208. <remarks>
  37209. Mail servers, if left idle for too long, will automatically drop the connection.
  37210. </remarks>
  37211. <returns>An asynchronous task context.</returns>
  37212. <param name="cancellationToken">The cancellation token.</param>
  37213. <exception cref="T:System.ObjectDisposedException">
  37214. The <see cref="T:MailKit.IMailService"/> has been disposed.
  37215. </exception>
  37216. <exception cref="T:MailKit.ServiceNotConnectedException">
  37217. The <see cref="T:MailKit.IMailService"/> is not connected.
  37218. </exception>
  37219. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  37220. The <see cref="T:MailKit.IMailService"/> is not authenticated.
  37221. </exception>
  37222. <exception cref="T:System.OperationCanceledException">
  37223. The operation was canceled via the cancellation token.
  37224. </exception>
  37225. <exception cref="T:System.IO.IOException">
  37226. An I/O error occurred.
  37227. </exception>
  37228. <exception cref="T:MailKit.CommandException">
  37229. The command was rejected by the mail server.
  37230. </exception>
  37231. <exception cref="T:MailKit.ProtocolException">
  37232. The server responded with an unexpected token.
  37233. </exception>
  37234. </member>
  37235. <member name="E:MailKit.IMailService.Connected">
  37236. <summary>
  37237. Occurs when the client has been successfully connected.
  37238. </summary>
  37239. <remarks>
  37240. The <see cref="E:MailKit.IMailService.Connected"/> event is raised when the client
  37241. successfully connects to the mail server.
  37242. </remarks>
  37243. </member>
  37244. <member name="E:MailKit.IMailService.Disconnected">
  37245. <summary>
  37246. Occurs when the client has been disconnected.
  37247. </summary>
  37248. <remarks>
  37249. The <see cref="E:MailKit.IMailService.Disconnected"/> event is raised whenever the client
  37250. has been disconnected.
  37251. </remarks>
  37252. </member>
  37253. <member name="E:MailKit.IMailService.Authenticated">
  37254. <summary>
  37255. Occurs when the client has been successfully authenticated.
  37256. </summary>
  37257. <remarks>
  37258. The <see cref="E:MailKit.IMailService.Authenticated"/> event is raised whenever the client
  37259. has been authenticated.
  37260. </remarks>
  37261. </member>
  37262. <member name="T:MailKit.IMailSpool">
  37263. <summary>
  37264. An interface for retreiving messages from a spool.
  37265. </summary>
  37266. <remarks>
  37267. An interface for retreiving messages from a spool.
  37268. </remarks>
  37269. </member>
  37270. <member name="P:MailKit.IMailSpool.Count">
  37271. <summary>
  37272. Get the number of messages available in the message spool.
  37273. </summary>
  37274. <remarks>
  37275. <para>Gets the number of messages available in the message spool.</para>
  37276. <para>Once authenticated, the <see cref="P:MailKit.IMailSpool.Count"/> property will be set
  37277. to the number of available messages in the spool.</para>
  37278. </remarks>
  37279. <value>The message count.</value>
  37280. </member>
  37281. <member name="P:MailKit.IMailSpool.SupportsUids">
  37282. <summary>
  37283. Get whether or not the service supports referencing messages by UIDs.
  37284. </summary>
  37285. <remarks>
  37286. <para>Not all servers support referencing messages by UID, so this property should
  37287. be checked before using <see cref="M:MailKit.IMailSpool.GetMessageUid(System.Int32,System.Threading.CancellationToken)"/>
  37288. and <see cref="M:MailKit.IMailSpool.GetMessageUids(System.Threading.CancellationToken)"/>.</para>
  37289. <para>If the server does not support UIDs, then all methods that take UID arguments
  37290. along with <see cref="M:MailKit.IMailSpool.GetMessageUid(System.Int32,System.Threading.CancellationToken)"/> and
  37291. <see cref="M:MailKit.IMailSpool.GetMessageUids(System.Threading.CancellationToken)"/> will fail.</para>
  37292. </remarks>
  37293. <value><c>true</c> if supports uids; otherwise, <c>false</c>.</value>
  37294. </member>
  37295. <member name="M:MailKit.IMailSpool.GetMessageCount(System.Threading.CancellationToken)">
  37296. <summary>
  37297. Get the message count.
  37298. </summary>
  37299. <remarks>
  37300. Gets the message count.
  37301. </remarks>
  37302. <returns>The message count.</returns>
  37303. </member>
  37304. <member name="M:MailKit.IMailSpool.GetMessageUid(System.Int32,System.Threading.CancellationToken)">
  37305. <summary>
  37306. Get the UID of the message at the specified index.
  37307. </summary>
  37308. <remarks>
  37309. Not all servers support UIDs, so you should first check
  37310. the <see cref="P:MailKit.IMailSpool.SupportsUids"/> property.
  37311. </remarks>
  37312. <returns>The message UID.</returns>
  37313. <param name="index">The message index.</param>
  37314. <param name="cancellationToken">The cancellation token.</param>
  37315. </member>
  37316. <member name="M:MailKit.IMailSpool.GetMessageUidAsync(System.Int32,System.Threading.CancellationToken)">
  37317. <summary>
  37318. Asynchronously get the UID of the message at the specified index.
  37319. </summary>
  37320. <remarks>
  37321. Not all servers support UIDs, so you should first check
  37322. the <see cref="P:MailKit.IMailSpool.SupportsUids"/> property.
  37323. </remarks>
  37324. <returns>The message UID.</returns>
  37325. <param name="index">The message index.</param>
  37326. <param name="cancellationToken">The cancellation token.</param>
  37327. </member>
  37328. <member name="M:MailKit.IMailSpool.GetMessageUids(System.Threading.CancellationToken)">
  37329. <summary>
  37330. Get the full list of available message UIDs.
  37331. </summary>
  37332. <remarks>
  37333. Not all servers support UIDs, so you should first check
  37334. the <see cref="P:MailKit.IMailSpool.SupportsUids"/> property.
  37335. </remarks>
  37336. <returns>The message UIDs.</returns>
  37337. <param name="cancellationToken">The cancellation token.</param>
  37338. </member>
  37339. <member name="M:MailKit.IMailSpool.GetMessageUidsAsync(System.Threading.CancellationToken)">
  37340. <summary>
  37341. Asynchronously get the full list of available message UIDs.
  37342. </summary>
  37343. <remarks>
  37344. Not all servers support UIDs, so you should first check
  37345. the <see cref="P:MailKit.IMailSpool.SupportsUids"/> property.
  37346. </remarks>
  37347. <returns>The message UIDs.</returns>
  37348. <param name="cancellationToken">The cancellation token.</param>
  37349. </member>
  37350. <member name="M:MailKit.IMailSpool.GetMessageSize(System.Int32,System.Threading.CancellationToken)">
  37351. <summary>
  37352. Get the size of the specified message, in bytes.
  37353. </summary>
  37354. <remarks>
  37355. Gets the size of the specified message, in bytes.
  37356. </remarks>
  37357. <returns>The message size, in bytes.</returns>
  37358. <param name="index">The index of the message.</param>
  37359. <param name="cancellationToken">The cancellation token.</param>
  37360. </member>
  37361. <member name="M:MailKit.IMailSpool.GetMessageSizeAsync(System.Int32,System.Threading.CancellationToken)">
  37362. <summary>
  37363. Asynchronously get the size of the specified message, in bytes.
  37364. </summary>
  37365. <remarks>
  37366. Asynchronously gets the size of the specified message, in bytes.
  37367. </remarks>
  37368. <returns>The message size, in bytes.</returns>
  37369. <param name="index">The index of the message.</param>
  37370. <param name="cancellationToken">The cancellation token.</param>
  37371. </member>
  37372. <member name="M:MailKit.IMailSpool.GetMessageSizes(System.Threading.CancellationToken)">
  37373. <summary>
  37374. Get the sizes for all available messages, in bytes.
  37375. </summary>
  37376. <remarks>
  37377. Gets the sizes for all available messages, in bytes.
  37378. </remarks>
  37379. <returns>The message sizes, in bytes.</returns>
  37380. <param name="cancellationToken">The cancellation token.</param>
  37381. </member>
  37382. <member name="M:MailKit.IMailSpool.GetMessageSizesAsync(System.Threading.CancellationToken)">
  37383. <summary>
  37384. Asynchronously get the sizes for all available messages, in bytes.
  37385. </summary>
  37386. <remarks>
  37387. Asynchronously gets the sizes for all available messages, in bytes.
  37388. </remarks>
  37389. <returns>The message sizes, in bytes.</returns>
  37390. <param name="cancellationToken">The cancellation token.</param>
  37391. </member>
  37392. <member name="M:MailKit.IMailSpool.GetMessageHeaders(System.Int32,System.Threading.CancellationToken)">
  37393. <summary>
  37394. Get the headers for the specified message.
  37395. </summary>
  37396. <remarks>
  37397. Gets the headers for the specified message.
  37398. </remarks>
  37399. <returns>The message headers.</returns>
  37400. <param name="index">The index of the message.</param>
  37401. <param name="cancellationToken">The cancellation token.</param>
  37402. </member>
  37403. <member name="M:MailKit.IMailSpool.GetMessageHeadersAsync(System.Int32,System.Threading.CancellationToken)">
  37404. <summary>
  37405. Asynchronously get the headers for the specified message.
  37406. </summary>
  37407. <remarks>
  37408. Asynchronously gets the headers for the specified message.
  37409. </remarks>
  37410. <returns>The message headers.</returns>
  37411. <param name="index">The index of the message.</param>
  37412. <param name="cancellationToken">The cancellation token.</param>
  37413. </member>
  37414. <member name="M:MailKit.IMailSpool.GetMessageHeaders(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken)">
  37415. <summary>
  37416. Get the headers for the specified messages.
  37417. </summary>
  37418. <remarks>
  37419. Gets the headers for the specified messages.
  37420. </remarks>
  37421. <returns>The headers for the specified messages.</returns>
  37422. <param name="indexes">The indexes of the messages.</param>
  37423. <param name="cancellationToken">The cancellation token.</param>
  37424. </member>
  37425. <member name="M:MailKit.IMailSpool.GetMessageHeadersAsync(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken)">
  37426. <summary>
  37427. Asynchronously get the headers for the specified messages.
  37428. </summary>
  37429. <remarks>
  37430. Asynchronously gets the headers for the specified messages.
  37431. </remarks>
  37432. <returns>The headers for the specified messages.</returns>
  37433. <param name="indexes">The indexes of the messages.</param>
  37434. <param name="cancellationToken">The cancellation token.</param>
  37435. </member>
  37436. <member name="M:MailKit.IMailSpool.GetMessageHeaders(System.Int32,System.Int32,System.Threading.CancellationToken)">
  37437. <summary>
  37438. Get the headers of the messages within the specified range.
  37439. </summary>
  37440. <remarks>
  37441. Gets the headers of the messages within the specified range.
  37442. </remarks>
  37443. <returns>The headers of the messages within the specified range.</returns>
  37444. <param name="startIndex">The index of the first message to get.</param>
  37445. <param name="count">The number of messages to get.</param>
  37446. <param name="cancellationToken">The cancellation token.</param>
  37447. </member>
  37448. <member name="M:MailKit.IMailSpool.GetMessageHeadersAsync(System.Int32,System.Int32,System.Threading.CancellationToken)">
  37449. <summary>
  37450. Get the headers of the messages within the specified range.
  37451. </summary>
  37452. <remarks>
  37453. Gets the headers of the messages within the specified range.
  37454. </remarks>
  37455. <returns>The headers of the messages within the specified range.</returns>
  37456. <param name="startIndex">The index of the first message to get.</param>
  37457. <param name="count">The number of messages to get.</param>
  37458. <param name="cancellationToken">The cancellation token.</param>
  37459. </member>
  37460. <member name="M:MailKit.IMailSpool.GetMessage(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  37461. <summary>
  37462. Get the message at the specified index.
  37463. </summary>
  37464. <remarks>
  37465. Gets the message at the specified index.
  37466. </remarks>
  37467. <returns>The message.</returns>
  37468. <param name="index">The index of the message.</param>
  37469. <param name="cancellationToken">The cancellation token.</param>
  37470. <param name="progress">The progress reporting mechanism.</param>
  37471. </member>
  37472. <member name="M:MailKit.IMailSpool.GetMessageAsync(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  37473. <summary>
  37474. Asynchronously get the message at the specified index.
  37475. </summary>
  37476. <remarks>
  37477. Asynchronously gets the message at the specified index.
  37478. </remarks>
  37479. <returns>The message.</returns>
  37480. <param name="index">The index of the message.</param>
  37481. <param name="cancellationToken">The cancellation token.</param>
  37482. <param name="progress">The progress reporting mechanism.</param>
  37483. </member>
  37484. <member name="M:MailKit.IMailSpool.GetMessages(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  37485. <summary>
  37486. Get the messages at the specified indexes.
  37487. </summary>
  37488. <remarks>
  37489. Gets the messages at the specified indexes.
  37490. </remarks>
  37491. <returns>The messages.</returns>
  37492. <param name="indexes">The indexes of the messages.</param>
  37493. <param name="cancellationToken">The cancellation token.</param>
  37494. <param name="progress">The progress reporting mechanism.</param>
  37495. </member>
  37496. <member name="M:MailKit.IMailSpool.GetMessagesAsync(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  37497. <summary>
  37498. Asynchronously get the messages at the specified indexes.
  37499. </summary>
  37500. <remarks>
  37501. Asynchronously gets the messages at the specified indexes.
  37502. </remarks>
  37503. <returns>The messages.</returns>
  37504. <param name="indexes">The indexes of the messages.</param>
  37505. <param name="cancellationToken">The cancellation token.</param>
  37506. <param name="progress">The progress reporting mechanism.</param>
  37507. </member>
  37508. <member name="M:MailKit.IMailSpool.GetMessages(System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  37509. <summary>
  37510. Get the messages within the specified range.
  37511. </summary>
  37512. <remarks>
  37513. Gets the messages within the specified range.
  37514. </remarks>
  37515. <returns>The messages.</returns>
  37516. <param name="startIndex">The index of the first message to get.</param>
  37517. <param name="count">The number of messages to get.</param>
  37518. <param name="cancellationToken">The cancellation token.</param>
  37519. <param name="progress">The progress reporting mechanism.</param>
  37520. </member>
  37521. <member name="M:MailKit.IMailSpool.GetMessagesAsync(System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  37522. <summary>
  37523. Asynchronously get the messages within the specified range.
  37524. </summary>
  37525. <remarks>
  37526. Asynchronously gets the messages within the specified range.
  37527. </remarks>
  37528. <returns>The messages.</returns>
  37529. <param name="startIndex">The index of the first message to get.</param>
  37530. <param name="count">The number of messages to get.</param>
  37531. <param name="cancellationToken">The cancellation token.</param>
  37532. <param name="progress">The progress reporting mechanism.</param>
  37533. </member>
  37534. <member name="M:MailKit.IMailSpool.GetStream(System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  37535. <summary>
  37536. Get the message or header stream at the specified index.
  37537. </summary>
  37538. <remarks>
  37539. Gets the message or header stream at the specified index.
  37540. </remarks>
  37541. <returns>The message or header stream.</returns>
  37542. <param name="index">The index of the message.</param>
  37543. <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
  37544. <param name="cancellationToken">The cancellation token.</param>
  37545. <param name="progress">The progress reporting mechanism.</param>
  37546. </member>
  37547. <member name="M:MailKit.IMailSpool.GetStreamAsync(System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  37548. <summary>
  37549. Asynchronously get the message or header stream at the specified index.
  37550. </summary>
  37551. <remarks>
  37552. Asynchronously gets the message or header stream at the specified index.
  37553. </remarks>
  37554. <returns>The message or header stream.</returns>
  37555. <param name="index">The index of the message.</param>
  37556. <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
  37557. <param name="cancellationToken">The cancellation token.</param>
  37558. <param name="progress">The progress reporting mechanism.</param>
  37559. </member>
  37560. <member name="M:MailKit.IMailSpool.GetStreams(System.Collections.Generic.IList{System.Int32},System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  37561. <summary>
  37562. Get the message or header streams at the specified index.
  37563. </summary>
  37564. <remarks>
  37565. Gets the message or header streams at the specified index.
  37566. </remarks>
  37567. <returns>The message or header streams.</returns>
  37568. <param name="indexes">The indexes of the messages.</param>
  37569. <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
  37570. <param name="cancellationToken">The cancellation token.</param>
  37571. <param name="progress">The progress reporting mechanism.</param>
  37572. </member>
  37573. <member name="M:MailKit.IMailSpool.GetStreamsAsync(System.Collections.Generic.IList{System.Int32},System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  37574. <summary>
  37575. Asynchronously get the message or header streams at the specified indexes.
  37576. </summary>
  37577. <remarks>
  37578. Asynchronously gets the message or header streams at the specified indexes.
  37579. </remarks>
  37580. <returns>The message or header streams.</returns>
  37581. <param name="indexes">The indexes of the messages.</param>
  37582. <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
  37583. <param name="cancellationToken">The cancellation token.</param>
  37584. <param name="progress">The progress reporting mechanism.</param>
  37585. </member>
  37586. <member name="M:MailKit.IMailSpool.GetStreams(System.Int32,System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  37587. <summary>
  37588. Get the message or header streams within the specified range.
  37589. </summary>
  37590. <remarks>
  37591. Gets the message or header streams within the specified range.
  37592. </remarks>
  37593. <returns>The message or header streams.</returns>
  37594. <param name="startIndex">The index of the first stream to get.</param>
  37595. <param name="count">The number of streams to get.</param>
  37596. <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
  37597. <param name="cancellationToken">The cancellation token.</param>
  37598. <param name="progress">The progress reporting mechanism.</param>
  37599. </member>
  37600. <member name="M:MailKit.IMailSpool.GetStreamsAsync(System.Int32,System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  37601. <summary>
  37602. Asynchronously get the message or header streams within the specified range.
  37603. </summary>
  37604. <remarks>
  37605. Asynchronously gets the message or header streams within the specified range.
  37606. </remarks>
  37607. <returns>The messages.</returns>
  37608. <param name="startIndex">The index of the first stream to get.</param>
  37609. <param name="count">The number of streams to get.</param>
  37610. <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
  37611. <param name="cancellationToken">The cancellation token.</param>
  37612. <param name="progress">The progress reporting mechanism.</param>
  37613. </member>
  37614. <member name="M:MailKit.IMailSpool.DeleteMessage(System.Int32,System.Threading.CancellationToken)">
  37615. <summary>
  37616. Mark the specified message for deletion.
  37617. </summary>
  37618. <remarks>
  37619. Messages marked for deletion are not actually deleted until the session
  37620. is cleanly disconnected
  37621. (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
  37622. </remarks>
  37623. <param name="index">The index of the message.</param>
  37624. <param name="cancellationToken">The cancellation token.</param>
  37625. </member>
  37626. <member name="M:MailKit.IMailSpool.DeleteMessageAsync(System.Int32,System.Threading.CancellationToken)">
  37627. <summary>
  37628. Asynchronously mark the specified message for deletion.
  37629. </summary>
  37630. <remarks>
  37631. Messages marked for deletion are not actually deleted until the session
  37632. is cleanly disconnected
  37633. (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
  37634. </remarks>
  37635. <returns>An asynchronous task context.</returns>
  37636. <param name="index">The index of the message.</param>
  37637. <param name="cancellationToken">The cancellation token.</param>
  37638. </member>
  37639. <member name="M:MailKit.IMailSpool.DeleteMessages(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken)">
  37640. <summary>
  37641. Mark the specified messages for deletion.
  37642. </summary>
  37643. <remarks>
  37644. Messages marked for deletion are not actually deleted until the session
  37645. is cleanly disconnected
  37646. (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
  37647. </remarks>
  37648. <param name="indexes">The indexes of the messages.</param>
  37649. <param name="cancellationToken">The cancellation token.</param>
  37650. </member>
  37651. <member name="M:MailKit.IMailSpool.DeleteMessagesAsync(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken)">
  37652. <summary>
  37653. Asynchronously mark the specified messages for deletion.
  37654. </summary>
  37655. <remarks>
  37656. Messages marked for deletion are not actually deleted until the session
  37657. is cleanly disconnected
  37658. (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
  37659. </remarks>
  37660. <returns>An asynchronous task context.</returns>
  37661. <param name="indexes">The indexes of the messages.</param>
  37662. <param name="cancellationToken">The cancellation token.</param>
  37663. </member>
  37664. <member name="M:MailKit.IMailSpool.DeleteMessages(System.Int32,System.Int32,System.Threading.CancellationToken)">
  37665. <summary>
  37666. Mark the specified range of messages for deletion.
  37667. </summary>
  37668. <remarks>
  37669. Messages marked for deletion are not actually deleted until the session
  37670. is cleanly disconnected
  37671. (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
  37672. </remarks>
  37673. <param name="startIndex">The index of the first message to mark for deletion.</param>
  37674. <param name="count">The number of messages to mark for deletion.</param>
  37675. <param name="cancellationToken">The cancellation token.</param>
  37676. </member>
  37677. <member name="M:MailKit.IMailSpool.DeleteMessagesAsync(System.Int32,System.Int32,System.Threading.CancellationToken)">
  37678. <summary>
  37679. Asynchronously mark the specified range of messages for deletion.
  37680. </summary>
  37681. <remarks>
  37682. Messages marked for deletion are not actually deleted until the session
  37683. is cleanly disconnected
  37684. (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
  37685. </remarks>
  37686. <returns>An asynchronous task context.</returns>
  37687. <param name="startIndex">The index of the first message to mark for deletion.</param>
  37688. <param name="count">The number of messages to mark for deletion.</param>
  37689. <param name="cancellationToken">The cancellation token.</param>
  37690. </member>
  37691. <member name="M:MailKit.IMailSpool.DeleteAllMessages(System.Threading.CancellationToken)">
  37692. <summary>
  37693. Mark all messages for deletion.
  37694. </summary>
  37695. <remarks>
  37696. Messages marked for deletion are not actually deleted until the session
  37697. is cleanly disconnected
  37698. (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
  37699. </remarks>
  37700. <param name="cancellationToken">The cancellation token.</param>
  37701. </member>
  37702. <member name="M:MailKit.IMailSpool.DeleteAllMessagesAsync(System.Threading.CancellationToken)">
  37703. <summary>
  37704. Asynchronously mark all messages for deletion.
  37705. </summary>
  37706. <remarks>
  37707. Messages marked for deletion are not actually deleted until the session
  37708. is cleanly disconnected
  37709. (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
  37710. </remarks>
  37711. <returns>An asynchronous task context.</returns>
  37712. <param name="cancellationToken">The cancellation token.</param>
  37713. </member>
  37714. <member name="M:MailKit.IMailSpool.Reset(System.Threading.CancellationToken)">
  37715. <summary>
  37716. Reset the state of all messages marked for deletion.
  37717. </summary>
  37718. <remarks>
  37719. Messages marked for deletion are not actually deleted until the session
  37720. is cleanly disconnected
  37721. (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
  37722. </remarks>
  37723. <param name="cancellationToken">The cancellation token.</param>
  37724. </member>
  37725. <member name="M:MailKit.IMailSpool.ResetAsync(System.Threading.CancellationToken)">
  37726. <summary>
  37727. Asynchronously reset the state of all messages marked for deletion.
  37728. </summary>
  37729. <remarks>
  37730. Messages marked for deletion are not actually deleted until the session
  37731. is cleanly disconnected
  37732. (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
  37733. </remarks>
  37734. <returns>An asynchronous task context.</returns>
  37735. <param name="cancellationToken">The cancellation token.</param>
  37736. </member>
  37737. <member name="T:MailKit.IMailStore">
  37738. <summary>
  37739. An interface for retreiving messages from a message store such as IMAP.
  37740. </summary>
  37741. <remarks>
  37742. Implemented by <see cref="T:MailKit.Net.Imap.ImapClient"/>.
  37743. </remarks>
  37744. </member>
  37745. <member name="P:MailKit.IMailStore.PersonalNamespaces">
  37746. <summary>
  37747. Get the personal namespaces.
  37748. </summary>
  37749. <remarks>
  37750. The personal folder namespaces contain a user's personal mailbox folders.
  37751. </remarks>
  37752. <value>The personal namespaces.</value>
  37753. </member>
  37754. <member name="P:MailKit.IMailStore.SharedNamespaces">
  37755. <summary>
  37756. Get the shared namespaces.
  37757. </summary>
  37758. <remarks>
  37759. The shared folder namespaces contain mailbox folders that are shared with the user.
  37760. </remarks>
  37761. <value>The shared namespaces.</value>
  37762. </member>
  37763. <member name="P:MailKit.IMailStore.OtherNamespaces">
  37764. <summary>
  37765. Get the other namespaces.
  37766. </summary>
  37767. <remarks>
  37768. The other folder namespaces contain other mailbox folders.
  37769. </remarks>
  37770. <value>The other namespaces.</value>
  37771. </member>
  37772. <member name="P:MailKit.IMailStore.SupportsQuotas">
  37773. <summary>
  37774. Get whether or not the mail store supports quotas.
  37775. </summary>
  37776. <remarks>
  37777. Gets whether or not the mail store supports quotas.
  37778. </remarks>
  37779. <value><c>true</c> if the mail store supports quotas; otherwise, <c>false</c>.</value>
  37780. </member>
  37781. <member name="P:MailKit.IMailStore.ThreadingAlgorithms">
  37782. <summary>
  37783. Get the threading algorithms supported by the mail store.
  37784. </summary>
  37785. <remarks>
  37786. The threading algorithms are queried as part of the
  37787. <a href="Overload_MailKit_IMailStore_Connect.htm">Connect</a>
  37788. and <a href="Overload_MailKit_IMailStore_Authenticate.htm">Authenticate</a> methods.
  37789. </remarks>
  37790. <example>
  37791. <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
  37792. </example>
  37793. <value>The threading algorithms.</value>
  37794. </member>
  37795. <member name="P:MailKit.IMailStore.Inbox">
  37796. <summary>
  37797. Get the Inbox folder.
  37798. </summary>
  37799. <remarks>
  37800. The Inbox folder is the default folder and is typically the folder
  37801. where all new messages are delivered.
  37802. </remarks>
  37803. <value>The Inbox folder.</value>
  37804. </member>
  37805. <member name="M:MailKit.IMailStore.EnableQuickResync(System.Threading.CancellationToken)">
  37806. <summary>
  37807. Enable the quick resynchronization feature.
  37808. </summary>
  37809. <remarks>
  37810. <para>Enables quick resynchronization when a folder is opened using the
  37811. <see cref="M:MailKit.IMailFolder.Open(MailKit.FolderAccess,System.UInt32,System.UInt64,System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)"/>
  37812. method.</para>
  37813. <para>If this feature is enabled, the <see cref="E:MailKit.IMailFolder.MessageExpunged"/> event
  37814. is replaced with the <see cref="E:MailKit.IMailFolder.MessagesVanished"/> event.</para>
  37815. <para>This method needs to be called immediately after
  37816. <see cref="M:MailKit.IMailService.Authenticate(System.Net.ICredentials,System.Threading.CancellationToken)"/>,
  37817. before the opening of any folders.</para>
  37818. </remarks>
  37819. <param name="cancellationToken">The cancellation token.</param>
  37820. <exception cref="T:System.ObjectDisposedException">
  37821. The <see cref="T:MailKit.MailStore"/> has been disposed.
  37822. </exception>
  37823. <exception cref="T:MailKit.ServiceNotConnectedException">
  37824. The <see cref="T:MailKit.IMailService"/> is not connected.
  37825. </exception>
  37826. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  37827. The <see cref="T:MailKit.IMailService"/> is not authenticated.
  37828. </exception>
  37829. <exception cref="T:System.InvalidOperationException">
  37830. Quick resynchronization needs to be enabled before selecting a folder.
  37831. </exception>
  37832. <exception cref="T:System.NotSupportedException">
  37833. The mail store does not support quick resynchronization.
  37834. </exception>
  37835. <exception cref="T:System.OperationCanceledException">
  37836. The operation was canceled via the cancellation token.
  37837. </exception>
  37838. <exception cref="T:System.IO.IOException">
  37839. An I/O error occurred.
  37840. </exception>
  37841. <exception cref="T:MailKit.ProtocolException">
  37842. A protocol error occurred.
  37843. </exception>
  37844. <exception cref="T:MailKit.CommandException">
  37845. The command failed.
  37846. </exception>
  37847. </member>
  37848. <member name="M:MailKit.IMailStore.EnableQuickResyncAsync(System.Threading.CancellationToken)">
  37849. <summary>
  37850. Asynchronously enable the quick resynchronization feature.
  37851. </summary>
  37852. <remarks>
  37853. <para>Enables quick resynchronization when a folder is opened using the
  37854. <see cref="M:MailKit.IMailFolder.Open(MailKit.FolderAccess,System.UInt32,System.UInt64,System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)"/>
  37855. method.</para>
  37856. <para>If this feature is enabled, the <see cref="E:MailKit.IMailFolder.MessageExpunged"/> event
  37857. is replaced with the <see cref="E:MailKit.IMailFolder.MessagesVanished"/> event.</para>
  37858. <para>This method needs to be called immediately after
  37859. <see cref="M:MailKit.IMailService.Authenticate(System.Net.ICredentials,System.Threading.CancellationToken)"/>,
  37860. before the opening of any folders.</para>
  37861. </remarks>
  37862. <returns>An asynchronous task context.</returns>
  37863. <param name="cancellationToken">The cancellation token.</param>
  37864. <exception cref="T:System.ObjectDisposedException">
  37865. The <see cref="T:MailKit.MailStore"/> has been disposed.
  37866. </exception>
  37867. <exception cref="T:MailKit.ServiceNotConnectedException">
  37868. The <see cref="T:MailKit.IMailService"/> is not connected.
  37869. </exception>
  37870. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  37871. The <see cref="T:MailKit.IMailService"/> is not authenticated.
  37872. </exception>
  37873. <exception cref="T:System.InvalidOperationException">
  37874. Quick resynchronization needs to be enabled before selecting a folder.
  37875. </exception>
  37876. <exception cref="T:System.NotSupportedException">
  37877. The mail store does not support quick resynchronization.
  37878. </exception>
  37879. <exception cref="T:System.OperationCanceledException">
  37880. The operation was canceled via the cancellation token.
  37881. </exception>
  37882. <exception cref="T:System.IO.IOException">
  37883. An I/O error occurred.
  37884. </exception>
  37885. <exception cref="T:MailKit.ProtocolException">
  37886. A protocol error occurred.
  37887. </exception>
  37888. <exception cref="T:MailKit.CommandException">
  37889. The command failed.
  37890. </exception>
  37891. </member>
  37892. <member name="M:MailKit.IMailStore.GetFolder(MailKit.SpecialFolder)">
  37893. <summary>
  37894. Get the specified special folder.
  37895. </summary>
  37896. <remarks>
  37897. Not all message stores support the concept of special folders,
  37898. so this method may return <c>null</c>.
  37899. </remarks>
  37900. <returns>The folder if available; otherwise <c>null</c>.</returns>
  37901. <param name="folder">The type of special folder.</param>
  37902. <exception cref="T:System.ArgumentOutOfRangeException">
  37903. <paramref name="folder"/> is out of range.
  37904. </exception>
  37905. </member>
  37906. <member name="M:MailKit.IMailStore.GetFolder(MailKit.FolderNamespace)">
  37907. <summary>
  37908. Get the folder for the specified namespace.
  37909. </summary>
  37910. <remarks>
  37911. The main reason to get the toplevel folder in a namespace is
  37912. to list its child folders.
  37913. </remarks>
  37914. <returns>The folder.</returns>
  37915. <param name="namespace">The namespace.</param>
  37916. <exception cref="T:System.ArgumentNullException">
  37917. <paramref name="namespace"/> is <c>null</c>.
  37918. </exception>
  37919. <exception cref="T:MailKit.FolderNotFoundException">
  37920. The folder could not be found.
  37921. </exception>
  37922. </member>
  37923. <member name="M:MailKit.IMailStore.GetFolders(MailKit.FolderNamespace,System.Boolean,System.Threading.CancellationToken)">
  37924. <summary>
  37925. Get all of the folders within the specified namespace.
  37926. </summary>
  37927. <remarks>
  37928. Gets all of the folders within the specified namespace.
  37929. </remarks>
  37930. <returns>The folders.</returns>
  37931. <param name="namespace">The namespace.</param>
  37932. <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
  37933. <param name="cancellationToken">The cancellation token.</param>
  37934. <exception cref="T:System.ArgumentNullException">
  37935. <paramref name="namespace"/> is <c>null</c>.
  37936. </exception>
  37937. <exception cref="T:System.ObjectDisposedException">
  37938. The <see cref="T:MailKit.IMailService"/> has been disposed.
  37939. </exception>
  37940. <exception cref="T:System.OperationCanceledException">
  37941. The operation was canceled via the cancellation token.
  37942. </exception>
  37943. <exception cref="T:MailKit.ServiceNotConnectedException">
  37944. The <see cref="T:MailKit.IMailService"/> is not connected.
  37945. </exception>
  37946. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  37947. The <see cref="T:MailKit.IMailService"/> is not authenticated.
  37948. </exception>
  37949. <exception cref="T:MailKit.FolderNotFoundException">
  37950. The namespace folder could not be found.
  37951. </exception>
  37952. <exception cref="T:System.IO.IOException">
  37953. An I/O error occurred.
  37954. </exception>
  37955. <exception cref="T:MailKit.ProtocolException">
  37956. A protocol error occurred.
  37957. </exception>
  37958. <exception cref="T:MailKit.CommandException">
  37959. The command failed.
  37960. </exception>
  37961. </member>
  37962. <member name="M:MailKit.IMailStore.GetFoldersAsync(MailKit.FolderNamespace,System.Boolean,System.Threading.CancellationToken)">
  37963. <summary>
  37964. Asynchronously get all of the folders within the specified namespace.
  37965. </summary>
  37966. <remarks>
  37967. Asynchronously gets all of the folders within the specified namespace.
  37968. </remarks>
  37969. <returns>The folders.</returns>
  37970. <param name="namespace">The namespace.</param>
  37971. <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
  37972. <param name="cancellationToken">The cancellation token.</param>
  37973. <exception cref="T:System.ArgumentNullException">
  37974. <paramref name="namespace"/> is <c>null</c>.
  37975. </exception>
  37976. <exception cref="T:System.ObjectDisposedException">
  37977. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  37978. </exception>
  37979. <exception cref="T:System.OperationCanceledException">
  37980. The operation was canceled via the cancellation token.
  37981. </exception>
  37982. <exception cref="T:MailKit.ServiceNotConnectedException">
  37983. The <see cref="T:MailKit.IMailService"/> is not connected.
  37984. </exception>
  37985. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  37986. The <see cref="T:MailKit.IMailService"/> is not authenticated.
  37987. </exception>
  37988. <exception cref="T:MailKit.FolderNotFoundException">
  37989. The namespace folder could not be found.
  37990. </exception>
  37991. <exception cref="T:System.IO.IOException">
  37992. An I/O error occurred.
  37993. </exception>
  37994. <exception cref="T:MailKit.ProtocolException">
  37995. A protocol error occurred.
  37996. </exception>
  37997. <exception cref="T:MailKit.CommandException">
  37998. The command failed.
  37999. </exception>
  38000. </member>
  38001. <member name="M:MailKit.IMailStore.GetFolders(MailKit.FolderNamespace,MailKit.StatusItems,System.Boolean,System.Threading.CancellationToken)">
  38002. <summary>
  38003. Get all of the folders within the specified namespace.
  38004. </summary>
  38005. <remarks>
  38006. Gets all of the folders within the specified namespace.
  38007. </remarks>
  38008. <returns>The folders.</returns>
  38009. <param name="namespace">The namespace.</param>
  38010. <param name="items">The status items to pre-populate.</param>
  38011. <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
  38012. <param name="cancellationToken">The cancellation token.</param>
  38013. <exception cref="T:System.ArgumentNullException">
  38014. <paramref name="namespace"/> is <c>null</c>.
  38015. </exception>
  38016. <exception cref="T:System.ObjectDisposedException">
  38017. The <see cref="T:MailKit.IMailService"/> has been disposed.
  38018. </exception>
  38019. <exception cref="T:System.OperationCanceledException">
  38020. The operation was canceled via the cancellation token.
  38021. </exception>
  38022. <exception cref="T:MailKit.ServiceNotConnectedException">
  38023. The <see cref="T:MailKit.IMailService"/> is not connected.
  38024. </exception>
  38025. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  38026. The <see cref="T:MailKit.IMailService"/> is not authenticated.
  38027. </exception>
  38028. <exception cref="T:MailKit.FolderNotFoundException">
  38029. The namespace folder could not be found.
  38030. </exception>
  38031. <exception cref="T:System.IO.IOException">
  38032. An I/O error occurred.
  38033. </exception>
  38034. <exception cref="T:MailKit.ProtocolException">
  38035. A protocol error occurred.
  38036. </exception>
  38037. <exception cref="T:MailKit.CommandException">
  38038. The command failed.
  38039. </exception>
  38040. </member>
  38041. <member name="M:MailKit.IMailStore.GetFoldersAsync(MailKit.FolderNamespace,MailKit.StatusItems,System.Boolean,System.Threading.CancellationToken)">
  38042. <summary>
  38043. Asynchronously get all of the folders within the specified namespace.
  38044. </summary>
  38045. <remarks>
  38046. Asynchronously gets all of the folders within the specified namespace.
  38047. </remarks>
  38048. <returns>The folders.</returns>
  38049. <param name="namespace">The namespace.</param>
  38050. <param name="items">The status items to pre-populate.</param>
  38051. <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
  38052. <param name="cancellationToken">The cancellation token.</param>
  38053. <exception cref="T:System.ArgumentNullException">
  38054. <paramref name="namespace"/> is <c>null</c>.
  38055. </exception>
  38056. <exception cref="T:System.ObjectDisposedException">
  38057. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  38058. </exception>
  38059. <exception cref="T:System.OperationCanceledException">
  38060. The operation was canceled via the cancellation token.
  38061. </exception>
  38062. <exception cref="T:MailKit.ServiceNotConnectedException">
  38063. The <see cref="T:MailKit.IMailService"/> is not connected.
  38064. </exception>
  38065. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  38066. The <see cref="T:MailKit.IMailService"/> is not authenticated.
  38067. </exception>
  38068. <exception cref="T:MailKit.FolderNotFoundException">
  38069. The namespace folder could not be found.
  38070. </exception>
  38071. <exception cref="T:System.IO.IOException">
  38072. An I/O error occurred.
  38073. </exception>
  38074. <exception cref="T:MailKit.ProtocolException">
  38075. A protocol error occurred.
  38076. </exception>
  38077. <exception cref="T:MailKit.CommandException">
  38078. The command failed.
  38079. </exception>
  38080. </member>
  38081. <member name="M:MailKit.IMailStore.GetFolder(System.String,System.Threading.CancellationToken)">
  38082. <summary>
  38083. Get the folder for the specified path.
  38084. </summary>
  38085. <remarks>
  38086. Gets the folder for the specified path.
  38087. </remarks>
  38088. <returns>The folder.</returns>
  38089. <param name="path">The folder path.</param>
  38090. <param name="cancellationToken">The cancellation token.</param>
  38091. <exception cref="T:System.ArgumentNullException">
  38092. <paramref name="path"/> is <c>null</c>.
  38093. </exception>
  38094. <exception cref="T:System.OperationCanceledException">
  38095. The operation was canceled via the cancellation token.
  38096. </exception>
  38097. <exception cref="T:MailKit.FolderNotFoundException">
  38098. The folder could not be found.
  38099. </exception>
  38100. <exception cref="T:System.IO.IOException">
  38101. An I/O error occurred.
  38102. </exception>
  38103. <exception cref="T:MailKit.ProtocolException">
  38104. A protocol error occurred.
  38105. </exception>
  38106. <exception cref="T:MailKit.CommandException">
  38107. The command failed.
  38108. </exception>
  38109. </member>
  38110. <member name="M:MailKit.IMailStore.GetFolderAsync(System.String,System.Threading.CancellationToken)">
  38111. <summary>
  38112. Asynchronously get the folder for the specified path.
  38113. </summary>
  38114. <remarks>
  38115. Asynchronously gets the folder for the specified path.
  38116. </remarks>
  38117. <returns>The folder.</returns>
  38118. <param name="path">The folder path.</param>
  38119. <param name="cancellationToken">The cancellation token.</param>
  38120. <exception cref="T:System.ArgumentNullException">
  38121. <paramref name="path"/> is <c>null</c>.
  38122. </exception>
  38123. <exception cref="T:System.OperationCanceledException">
  38124. The operation was canceled via the cancellation token.
  38125. </exception>
  38126. <exception cref="T:MailKit.FolderNotFoundException">
  38127. The folder could not be found.
  38128. </exception>
  38129. <exception cref="T:System.IO.IOException">
  38130. An I/O error occurred.
  38131. </exception>
  38132. <exception cref="T:MailKit.ProtocolException">
  38133. A protocol error occurred.
  38134. </exception>
  38135. <exception cref="T:MailKit.CommandException">
  38136. The command failed.
  38137. </exception>
  38138. </member>
  38139. <member name="M:MailKit.IMailStore.GetMetadata(MailKit.MetadataTag,System.Threading.CancellationToken)">
  38140. <summary>
  38141. Gets the specified metadata.
  38142. </summary>
  38143. <remarks>
  38144. Gets the specified metadata.
  38145. </remarks>
  38146. <returns>The requested metadata value.</returns>
  38147. <param name="tag">The metadata tag.</param>
  38148. <param name="cancellationToken">The cancellation token.</param>
  38149. </member>
  38150. <member name="M:MailKit.IMailStore.GetMetadataAsync(MailKit.MetadataTag,System.Threading.CancellationToken)">
  38151. <summary>
  38152. Asynchronously gets the specified metadata.
  38153. </summary>
  38154. <remarks>
  38155. Asynchronously gets the specified metadata.
  38156. </remarks>
  38157. <returns>The requested metadata value.</returns>
  38158. <param name="tag">The metadata tag.</param>
  38159. <param name="cancellationToken">The cancellation token.</param>
  38160. </member>
  38161. <member name="M:MailKit.IMailStore.GetMetadata(System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
  38162. <summary>
  38163. Gets the specified metadata.
  38164. </summary>
  38165. <remarks>
  38166. Gets the specified metadata.
  38167. </remarks>
  38168. <returns>The requested metadata.</returns>
  38169. <param name="tags">The metadata tags.</param>
  38170. <param name="cancellationToken">The cancellation token.</param>
  38171. </member>
  38172. <member name="M:MailKit.IMailStore.GetMetadataAsync(System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
  38173. <summary>
  38174. Asynchronously gets the specified metadata.
  38175. </summary>
  38176. <remarks>
  38177. Asynchronously gets the specified metadata.
  38178. </remarks>
  38179. <returns>The requested metadata.</returns>
  38180. <param name="tags">The metadata tags.</param>
  38181. <param name="cancellationToken">The cancellation token.</param>
  38182. </member>
  38183. <member name="M:MailKit.IMailStore.GetMetadata(MailKit.MetadataOptions,System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
  38184. <summary>
  38185. Gets the specified metadata.
  38186. </summary>
  38187. <remarks>
  38188. Gets the specified metadata.
  38189. </remarks>
  38190. <returns>The requested metadata.</returns>
  38191. <param name="options">The metadata options.</param>
  38192. <param name="tags">The metadata tags.</param>
  38193. <param name="cancellationToken">The cancellation token.</param>
  38194. </member>
  38195. <member name="M:MailKit.IMailStore.GetMetadataAsync(MailKit.MetadataOptions,System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
  38196. <summary>
  38197. Asynchronously gets the specified metadata.
  38198. </summary>
  38199. <remarks>
  38200. Asynchronously gets the specified metadata.
  38201. </remarks>
  38202. <returns>The requested metadata.</returns>
  38203. <param name="options">The metadata options.</param>
  38204. <param name="tags">The metadata tags.</param>
  38205. <param name="cancellationToken">The cancellation token.</param>
  38206. </member>
  38207. <member name="M:MailKit.IMailStore.SetMetadata(MailKit.MetadataCollection,System.Threading.CancellationToken)">
  38208. <summary>
  38209. Sets the specified metadata.
  38210. </summary>
  38211. <remarks>
  38212. Sets the specified metadata.
  38213. </remarks>
  38214. <param name="metadata">The metadata.</param>
  38215. <param name="cancellationToken">The cancellation token.</param>
  38216. </member>
  38217. <member name="M:MailKit.IMailStore.SetMetadataAsync(MailKit.MetadataCollection,System.Threading.CancellationToken)">
  38218. <summary>
  38219. Asynchronously sets the specified metadata.
  38220. </summary>
  38221. <remarks>
  38222. Asynchronously sets the specified metadata.
  38223. </remarks>
  38224. <returns>An asynchronous task context.</returns>
  38225. <param name="metadata">The metadata.</param>
  38226. <param name="cancellationToken">The cancellation token.</param>
  38227. </member>
  38228. <member name="E:MailKit.IMailStore.Alert">
  38229. <summary>
  38230. Occurs when a remote message store receives an alert message from the server.
  38231. </summary>
  38232. <remarks>
  38233. Some implementations, such as <see cref="T:MailKit.Net.Imap.ImapClient"/>,
  38234. will emit Alert events when they receive alert messages from the server.
  38235. </remarks>
  38236. </member>
  38237. <member name="E:MailKit.IMailStore.FolderCreated">
  38238. <summary>
  38239. Occurs when a folder is created.
  38240. </summary>
  38241. <remarks>
  38242. The <see cref="E:MailKit.IMailStore.FolderCreated"/> event is emitted when a new folder is created.
  38243. </remarks>
  38244. </member>
  38245. <member name="E:MailKit.IMailStore.MetadataChanged">
  38246. <summary>
  38247. Occurs when metadata changes.
  38248. </summary>
  38249. <remarks>
  38250. The <see cref="E:MailKit.IMailStore.MetadataChanged"/> event is emitted when metadata changes.
  38251. </remarks>
  38252. </member>
  38253. <member name="T:MailKit.IMailTransport">
  38254. <summary>
  38255. An interface for sending messages.
  38256. </summary>
  38257. <remarks>
  38258. An interface for sending messages.
  38259. </remarks>
  38260. </member>
  38261. <member name="M:MailKit.IMailTransport.Send(MimeKit.MimeMessage,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  38262. <summary>
  38263. Send the specified message.
  38264. </summary>
  38265. <remarks>
  38266. <para>Sends the specified message.</para>
  38267. <para>The sender address is determined by checking the following
  38268. message headers (in order of precedence): Resent-Sender,
  38269. Resent-From, Sender, and From.</para>
  38270. <para>If either the Resent-Sender or Resent-From addresses are present,
  38271. the recipients are collected from the Resent-To, Resent-Cc, and
  38272. Resent-Bcc headers, otherwise the To, Cc, and Bcc headers are used.</para>
  38273. </remarks>
  38274. <param name="message">The message.</param>
  38275. <param name="cancellationToken">The cancellation token.</param>
  38276. <param name="progress">The progress reporting mechanism.</param>
  38277. </member>
  38278. <member name="M:MailKit.IMailTransport.SendAsync(MimeKit.MimeMessage,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  38279. <summary>
  38280. Asynchronously send the specified message.
  38281. </summary>
  38282. <remarks>
  38283. <para>Asynchronously sends the specified message.</para>
  38284. <para>The sender address is determined by checking the following
  38285. message headers (in order of precedence): Resent-Sender,
  38286. Resent-From, Sender, and From.</para>
  38287. <para>If either the Resent-Sender or Resent-From addresses are present,
  38288. the recipients are collected from the Resent-To, Resent-Cc, and
  38289. Resent-Bcc headers, otherwise the To, Cc, and Bcc headers are used.</para>
  38290. </remarks>
  38291. <returns>An asynchronous task context.</returns>
  38292. <param name="message">The message.</param>
  38293. <param name="cancellationToken">The cancellation token.</param>
  38294. <param name="progress">The progress reporting mechanism.</param>
  38295. </member>
  38296. <member name="M:MailKit.IMailTransport.Send(MimeKit.MimeMessage,MimeKit.MailboxAddress,System.Collections.Generic.IEnumerable{MimeKit.MailboxAddress},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  38297. <summary>
  38298. Send the specified message using the supplied sender and recipients.
  38299. </summary>
  38300. <remarks>
  38301. Sends the specified message using the supplied sender and recipients.
  38302. </remarks>
  38303. <param name="message">The message.</param>
  38304. <param name="sender">The mailbox address to use for sending the message.</param>
  38305. <param name="recipients">The mailbox addresses that should receive the message.</param>
  38306. <param name="cancellationToken">The cancellation token.</param>
  38307. <param name="progress">The progress reporting mechanism.</param>
  38308. </member>
  38309. <member name="M:MailKit.IMailTransport.SendAsync(MimeKit.MimeMessage,MimeKit.MailboxAddress,System.Collections.Generic.IEnumerable{MimeKit.MailboxAddress},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  38310. <summary>
  38311. Asynchronously send the specified message using the supplied sender and recipients.
  38312. </summary>
  38313. <remarks>
  38314. Asynchronously sends the specified message using the supplied sender and recipients.
  38315. </remarks>
  38316. <returns>An asynchronous task context.</returns>
  38317. <param name="message">The message.</param>
  38318. <param name="sender">The mailbox address to use for sending the message.</param>
  38319. <param name="recipients">The mailbox addresses that should receive the message.</param>
  38320. <param name="cancellationToken">The cancellation token.</param>
  38321. <param name="progress">The progress reporting mechanism.</param>
  38322. </member>
  38323. <member name="M:MailKit.IMailTransport.Send(MimeKit.FormatOptions,MimeKit.MimeMessage,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  38324. <summary>
  38325. Send the specified message.
  38326. </summary>
  38327. <remarks>
  38328. <para>Sends the specified message.</para>
  38329. <para>The sender address is determined by checking the following
  38330. message headers (in order of precedence): Resent-Sender,
  38331. Resent-From, Sender, and From.</para>
  38332. <para>If either the Resent-Sender or Resent-From addresses are present,
  38333. the recipients are collected from the Resent-To, Resent-Cc, and
  38334. Resent-Bcc headers, otherwise the To, Cc, and Bcc headers are used.</para>
  38335. </remarks>
  38336. <param name="options">The formatting options.</param>
  38337. <param name="message">The message.</param>
  38338. <param name="cancellationToken">The cancellation token.</param>
  38339. <param name="progress">The progress reporting mechanism.</param>
  38340. </member>
  38341. <member name="M:MailKit.IMailTransport.SendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  38342. <summary>
  38343. Asynchronously send the specified message.
  38344. </summary>
  38345. <remarks>
  38346. <para>Asynchronously sends the specified message.</para>
  38347. <para>The sender address is determined by checking the following
  38348. message headers (in order of precedence): Resent-Sender,
  38349. Resent-From, Sender, and From.</para>
  38350. <para>If either the Resent-Sender or Resent-From addresses are present,
  38351. the recipients are collected from the Resent-To, Resent-Cc, and
  38352. Resent-Bcc headers, otherwise the To, Cc, and Bcc headers are used.</para>
  38353. </remarks>
  38354. <returns>An asynchronous task context.</returns>
  38355. <param name="options">The formatting options.</param>
  38356. <param name="message">The message.</param>
  38357. <param name="cancellationToken">The cancellation token.</param>
  38358. <param name="progress">The progress reporting mechanism.</param>
  38359. </member>
  38360. <member name="M:MailKit.IMailTransport.Send(MimeKit.FormatOptions,MimeKit.MimeMessage,MimeKit.MailboxAddress,System.Collections.Generic.IEnumerable{MimeKit.MailboxAddress},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  38361. <summary>
  38362. Send the specified message using the supplied sender and recipients.
  38363. </summary>
  38364. <remarks>
  38365. Sends the specified message using the supplied sender and recipients.
  38366. </remarks>
  38367. <param name="options">The formatting options.</param>
  38368. <param name="message">The message.</param>
  38369. <param name="sender">The mailbox address to use for sending the message.</param>
  38370. <param name="recipients">The mailbox addresses that should receive the message.</param>
  38371. <param name="cancellationToken">The cancellation token.</param>
  38372. <param name="progress">The progress reporting mechanism.</param>
  38373. </member>
  38374. <member name="M:MailKit.IMailTransport.SendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,MimeKit.MailboxAddress,System.Collections.Generic.IEnumerable{MimeKit.MailboxAddress},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  38375. <summary>
  38376. Asynchronously send the specified message using the supplied sender and recipients.
  38377. </summary>
  38378. <remarks>
  38379. Asynchronously sends the specified message using the supplied sender and recipients.
  38380. </remarks>
  38381. <returns>An asynchronous task context.</returns>
  38382. <param name="options">The formatting options.</param>
  38383. <param name="message">The message.</param>
  38384. <param name="sender">The mailbox address to use for sending the message.</param>
  38385. <param name="recipients">The mailbox addresses that should receive the message.</param>
  38386. <param name="cancellationToken">The cancellation token.</param>
  38387. <param name="progress">The progress reporting mechanism.</param>
  38388. </member>
  38389. <member name="E:MailKit.IMailTransport.MessageSent">
  38390. <summary>
  38391. Occurs when a message is successfully sent via the transport.
  38392. </summary>
  38393. <remarks>
  38394. The <see cref="E:MailKit.IMailTransport.MessageSent"/> event will be emitted each time a message is successfully sent.
  38395. </remarks>
  38396. </member>
  38397. <member name="T:MailKit.IMessageSummary">
  38398. <summary>
  38399. A summary of a message.
  38400. </summary>
  38401. <remarks>
  38402. A <see cref="T:MailKit.IMessageSummary"/> is returned by
  38403. <see cref="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Threading.CancellationToken)"/>.
  38404. The properties of the <see cref="T:MailKit.IMessageSummary"/> that will be available
  38405. depend on the <see cref="T:MailKit.MessageSummaryItems"/> passed to the aformentioned method.
  38406. </remarks>
  38407. </member>
  38408. <member name="P:MailKit.IMessageSummary.Fields">
  38409. <summary>
  38410. Get a bitmask of fields that have been populated.
  38411. </summary>
  38412. <remarks>
  38413. Gets a bitmask of fields that have been populated.
  38414. </remarks>
  38415. <value>The fields that have been populated.</value>
  38416. </member>
  38417. <member name="P:MailKit.IMessageSummary.Body">
  38418. <summary>
  38419. Gets the body structure of the message, if available.
  38420. </summary>
  38421. <remarks>
  38422. <para>The body will be one of <see cref="T:MailKit.BodyPartText"/>,
  38423. <see cref="T:MailKit.BodyPartMessage"/>, <see cref="T:MailKit.BodyPartBasic"/>,
  38424. or <see cref="T:MailKit.BodyPartMultipart"/>.</para>
  38425. <para>This property will only be set if either the
  38426. <see cref="F:MailKit.MessageSummaryItems.Body"/> flag or the
  38427. <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag is passed to
  38428. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  38429. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  38430. methods.</para>
  38431. </remarks>
  38432. <value>The body structure of the message.</value>
  38433. </member>
  38434. <member name="P:MailKit.IMessageSummary.TextBody">
  38435. <summary>
  38436. Gets the text body part of the message if it exists.
  38437. </summary>
  38438. <remarks>
  38439. <para>Gets the <c>text/plain</c> body part of the message.</para>
  38440. <para>This property will only be usable if the
  38441. <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag is passed to
  38442. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  38443. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  38444. methods.</para>
  38445. </remarks>
  38446. <example>
  38447. <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
  38448. </example>
  38449. <value>The text body if it exists; otherwise, <c>null</c>.</value>
  38450. </member>
  38451. <member name="P:MailKit.IMessageSummary.HtmlBody">
  38452. <summary>
  38453. Gets the html body part of the message if it exists.
  38454. </summary>
  38455. <remarks>
  38456. <para>Gets the <c>text/html</c> body part of the message.</para>
  38457. <para>This property will only be usable if the
  38458. <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag is passed to
  38459. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  38460. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  38461. methods.</para>
  38462. </remarks>
  38463. <value>The html body if it exists; otherwise, <c>null</c>.</value>
  38464. </member>
  38465. <member name="P:MailKit.IMessageSummary.BodyParts">
  38466. <summary>
  38467. Gets the body parts of the message.
  38468. </summary>
  38469. <remarks>
  38470. <para>Traverses over the <see cref="P:MailKit.IMessageSummary.Body"/>, enumerating all of the
  38471. <see cref="T:MailKit.BodyPartBasic"/> objects.</para>
  38472. <para>This property will only be usable if either the
  38473. <see cref="F:MailKit.MessageSummaryItems.Body"/> flag or the
  38474. <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag is passed to
  38475. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  38476. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  38477. methods.</para>
  38478. </remarks>
  38479. <value>The body parts.</value>
  38480. </member>
  38481. <member name="P:MailKit.IMessageSummary.Attachments">
  38482. <summary>
  38483. Gets the attachments.
  38484. </summary>
  38485. <remarks>
  38486. <para>Traverses over the <see cref="P:MailKit.IMessageSummary.Body"/>, enumerating all of the
  38487. <see cref="T:MailKit.BodyPartBasic"/> objects that have a <c>Content-Disposition</c>
  38488. header set to <c>"attachment"</c>.</para>
  38489. <para>This property will only be usable if the
  38490. <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag is passed to
  38491. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  38492. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  38493. methods.</para>
  38494. </remarks>
  38495. <example>
  38496. <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
  38497. </example>
  38498. <value>The attachments.</value>
  38499. </member>
  38500. <member name="P:MailKit.IMessageSummary.PreviewText">
  38501. <summary>
  38502. Gets the preview text of the message.
  38503. </summary>
  38504. <remarks>
  38505. <para>The preview text is a short snippet of the beginning of the message
  38506. text, typically shown in a mail client's message list to provide the user
  38507. with a sense of what the message is about.</para>
  38508. <para>This property will only be set if the
  38509. <see cref="F:MailKit.MessageSummaryItems.PreviewText"/> flag is passed to
  38510. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  38511. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  38512. methods.</para>
  38513. </remarks>
  38514. <value>The preview text.</value>
  38515. </member>
  38516. <member name="P:MailKit.IMessageSummary.Envelope">
  38517. <summary>
  38518. Gets the envelope of the message, if available.
  38519. </summary>
  38520. <remarks>
  38521. <para>The envelope of a message contains information such as the
  38522. date the message was sent, the subject of the message,
  38523. the sender of the message, who the message was sent to,
  38524. which message(s) the message may be in reply to,
  38525. and the message id.</para>
  38526. <para>This property will only be set if the
  38527. <see cref="F:MailKit.MessageSummaryItems.Envelope"/> flag is passed to
  38528. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  38529. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  38530. methods.</para>
  38531. </remarks>
  38532. <value>The envelope of the message.</value>
  38533. </member>
  38534. <member name="P:MailKit.IMessageSummary.NormalizedSubject">
  38535. <summary>
  38536. Gets the normalized subject.
  38537. </summary>
  38538. <remarks>
  38539. <para>A normalized <c>Subject</c> header value where prefixes such as <c>"Re:"</c>, <c>"Re[#]:"</c> and <c>"FWD:"</c> have been pruned.</para>
  38540. <para>This property is typically used for threading messages by subject.</para>
  38541. </remarks>
  38542. <value>The normalized subject.</value>
  38543. </member>
  38544. <member name="P:MailKit.IMessageSummary.Date">
  38545. <summary>
  38546. Gets the Date header value.
  38547. </summary>
  38548. <remarks>
  38549. Gets the Date header value. If the Date header is not present, the arrival date is used.
  38550. If neither are known, <see cref="F:System.DateTimeOffset.MinValue"/> is returned.
  38551. </remarks>
  38552. <value>The date.</value>
  38553. </member>
  38554. <member name="P:MailKit.IMessageSummary.IsReply">
  38555. <summary>
  38556. Gets whether or not the message is a reply.
  38557. </summary>
  38558. <remarks>
  38559. This value should be based on whether the message subject contained any <c>"Re:"</c>, <c>"Re[#]:"</c> or <c>"FWD:"</c> prefixes.
  38560. </remarks>
  38561. <value><c>true</c> if the message is a reply; otherwise, <c>false</c>.</value>
  38562. </member>
  38563. <member name="P:MailKit.IMessageSummary.Flags">
  38564. <summary>
  38565. Gets the message flags, if available.
  38566. </summary>
  38567. <remarks>
  38568. <para>Gets the message flags, if available.</para>
  38569. <para>This property will only be set if the
  38570. <see cref="F:MailKit.MessageSummaryItems.Flags"/> flag is passed to
  38571. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  38572. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  38573. methods.</para>
  38574. </remarks>
  38575. <value>The message flags.</value>
  38576. </member>
  38577. <member name="P:MailKit.IMessageSummary.Keywords">
  38578. <summary>
  38579. Gets the user-defined message flags, if available.
  38580. </summary>
  38581. <remarks>
  38582. <para>Gets the user-defined message flags, if available.</para>
  38583. <para>This property will only be set if the
  38584. <see cref="F:MailKit.MessageSummaryItems.Flags"/> flag is passed to
  38585. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  38586. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  38587. methods.</para>
  38588. </remarks>
  38589. <value>The user-defined message flags.</value>
  38590. </member>
  38591. <member name="P:MailKit.IMessageSummary.UserFlags">
  38592. <summary>
  38593. Gets the user-defined message flags, if available.
  38594. </summary>
  38595. <remarks>
  38596. <para>Gets the user-defined message flags, if available.</para>
  38597. <para>This property will only be set if the
  38598. <see cref="F:MailKit.MessageSummaryItems.Flags"/> flag is passed to
  38599. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  38600. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  38601. methods.</para>
  38602. </remarks>
  38603. <value>The user-defined message flags.</value>
  38604. </member>
  38605. <member name="P:MailKit.IMessageSummary.Annotations">
  38606. <summary>
  38607. Gets the message annotations, if available.
  38608. </summary>
  38609. <remarks>
  38610. <para>Gets the message annotations, if available.</para>
  38611. <para>This property will only be set if the
  38612. <see cref="F:MailKit.MessageSummaryItems.Annotations"/> flag is passed to
  38613. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  38614. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  38615. methods.</para>
  38616. </remarks>
  38617. <value>The message annotations.</value>
  38618. </member>
  38619. <member name="P:MailKit.IMessageSummary.Headers">
  38620. <summary>
  38621. Gets the list of headers, if available.
  38622. </summary>
  38623. <remarks>
  38624. <para>Gets the list of headers, if available.</para>
  38625. <para>This property will only be set if <see cref="F:MailKit.MessageSummaryItems.Headers"/>
  38626. is specified in a call to one of the
  38627. <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  38628. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  38629. methods or specific headers are requested via a one of the Fetch or FetchAsync methods
  38630. that accept list of specific headers to request for each message such as
  38631. <see cref="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)"/>.
  38632. </para>
  38633. </remarks>
  38634. <value>The list of headers.</value>
  38635. </member>
  38636. <member name="P:MailKit.IMessageSummary.InternalDate">
  38637. <summary>
  38638. Gets the internal date of the message, if available.
  38639. </summary>
  38640. <remarks>
  38641. <para>Gets the internal date of the message (often the same date as found in the <c>Received</c> header), if available.</para>
  38642. <para>This property will only be set if the
  38643. <see cref="F:MailKit.MessageSummaryItems.InternalDate"/> flag is passed to
  38644. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  38645. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  38646. methods.</para>
  38647. </remarks>
  38648. <value>The internal date of the message.</value>
  38649. </member>
  38650. <member name="P:MailKit.IMessageSummary.Size">
  38651. <summary>
  38652. Gets the size of the message, in bytes, if available.
  38653. </summary>
  38654. <remarks>
  38655. <para>Gets the size of the message, in bytes, if available.</para>
  38656. <para>This property will only be set if the
  38657. <see cref="F:MailKit.MessageSummaryItems.Size"/> flag is passed to
  38658. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  38659. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  38660. methods.</para>
  38661. </remarks>
  38662. <value>The size of the message.</value>
  38663. </member>
  38664. <member name="P:MailKit.IMessageSummary.ModSeq">
  38665. <summary>
  38666. Gets the mod-sequence value for the message, if available.
  38667. </summary>
  38668. <remarks>
  38669. <para>Gets the mod-sequence value for the message, if available.</para>
  38670. <para>This property will only be set if the
  38671. <see cref="F:MailKit.MessageSummaryItems.ModSeq"/> flag is passed to
  38672. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  38673. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  38674. methods.</para>
  38675. </remarks>
  38676. <value>The mod-sequence value.</value>
  38677. </member>
  38678. <member name="P:MailKit.IMessageSummary.References">
  38679. <summary>
  38680. Gets the message-ids that the message references, if available.
  38681. </summary>
  38682. <remarks>
  38683. <para>Gets the message-ids that the message references, if available.</para>
  38684. <para>This property will only be set if the
  38685. <see cref="F:MailKit.MessageSummaryItems.References"/> flag is passed to
  38686. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  38687. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  38688. methods.</para>
  38689. </remarks>
  38690. <value>The references.</value>
  38691. </member>
  38692. <member name="P:MailKit.IMessageSummary.EmailId">
  38693. <summary>
  38694. Get the globally unique identifier for the message, if available.
  38695. </summary>
  38696. <remarks>
  38697. <para>Gets the globally unique identifier of the message, if available.</para>
  38698. <para>This property will only be set if the
  38699. <see cref="F:MailKit.MessageSummaryItems.EmailId"/> flag is passed to
  38700. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  38701. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  38702. methods.</para>
  38703. <note type="info">This property maps to the <c>EMAILID</c> value defined in the
  38704. <a href="https://tools.ietf.org/html/rfc8474">OBJECTID</a> extension.</note>
  38705. </remarks>
  38706. <value>The globally unique message identifier.</value>
  38707. </member>
  38708. <member name="P:MailKit.IMessageSummary.Id">
  38709. <summary>
  38710. Get the globally unique identifier for the message, if available.
  38711. </summary>
  38712. <remarks>
  38713. <para>Gets the globally unique identifier of the message, if available.</para>
  38714. <para>This property will only be set if the
  38715. <see cref="F:MailKit.MessageSummaryItems.EmailId"/> flag is passed to
  38716. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  38717. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  38718. methods.</para>
  38719. <note type="info">This property maps to the <c>EMAILID</c> value defined in the
  38720. <a href="https://tools.ietf.org/html/rfc8474">OBJECTID</a> extension.</note>
  38721. </remarks>
  38722. <value>The globally unique message identifier.</value>
  38723. </member>
  38724. <member name="P:MailKit.IMessageSummary.ThreadId">
  38725. <summary>
  38726. Get the globally unique thread identifier for the message, if available.
  38727. </summary>
  38728. <remarks>
  38729. <para>Gets the globally unique thread identifier for the message, if available.</para>
  38730. <para>This property will only be set if the
  38731. <see cref="F:MailKit.MessageSummaryItems.ThreadId"/> flag is passed to
  38732. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  38733. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  38734. methods.</para>
  38735. <note type="info">This property maps to the <c>THREADID</c> value defined in the
  38736. <a href="https://tools.ietf.org/html/rfc8474">OBJECTID</a> extension.</note>
  38737. </remarks>
  38738. <value>The globally unique thread identifier.</value>
  38739. </member>
  38740. <member name="P:MailKit.IMessageSummary.UniqueId">
  38741. <summary>
  38742. Gets the unique identifier of the message, if available.
  38743. </summary>
  38744. <remarks>
  38745. <para>Gets the unique identifier of the message, if available.</para>
  38746. <para>This property will only be set if the
  38747. <see cref="F:MailKit.MessageSummaryItems.UniqueId"/> flag is passed to
  38748. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  38749. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  38750. methods.</para>
  38751. </remarks>
  38752. <value>The uid of the message.</value>
  38753. </member>
  38754. <member name="P:MailKit.IMessageSummary.Index">
  38755. <summary>
  38756. Gets the index of the message.
  38757. </summary>
  38758. <remarks>
  38759. <para>Gets the index of the message.</para>
  38760. <para>This property is always set.</para>
  38761. </remarks>
  38762. <value>The index of the message.</value>
  38763. </member>
  38764. <member name="P:MailKit.IMessageSummary.GMailMessageId">
  38765. <summary>
  38766. Gets the GMail message identifier, if available.
  38767. </summary>
  38768. <remarks>
  38769. <para>Gets the GMail message identifier, if available.</para>
  38770. <para>This property will only be set if the
  38771. <see cref="F:MailKit.MessageSummaryItems.GMailMessageId"/> flag is passed to
  38772. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  38773. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  38774. methods.</para>
  38775. </remarks>
  38776. <value>The GMail message identifier.</value>
  38777. </member>
  38778. <member name="P:MailKit.IMessageSummary.GMailThreadId">
  38779. <summary>
  38780. Gets the GMail thread identifier, if available.
  38781. </summary>
  38782. <remarks>
  38783. <para>Gets the GMail thread identifier, if available.</para>
  38784. <para>This property will only be set if the
  38785. <see cref="F:MailKit.MessageSummaryItems.GMailThreadId"/> flag is passed to
  38786. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  38787. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  38788. methods.</para>
  38789. </remarks>
  38790. <value>The GMail thread identifier.</value>
  38791. </member>
  38792. <member name="P:MailKit.IMessageSummary.GMailLabels">
  38793. <summary>
  38794. Gets the list of GMail labels, if available.
  38795. </summary>
  38796. <remarks>
  38797. <para>Gets the list of GMail labels, if available.</para>
  38798. <para>This property will only be set if the
  38799. <see cref="F:MailKit.MessageSummaryItems.GMailLabels"/> flag is passed to
  38800. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  38801. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  38802. methods.</para>
  38803. </remarks>
  38804. <value>The GMail labels.</value>
  38805. </member>
  38806. <member name="T:MailKit.IProtocolLogger">
  38807. <summary>
  38808. An interface for logging the communication between a client and server.
  38809. </summary>
  38810. <remarks>
  38811. An interface for logging the communication between a client and server.
  38812. </remarks>
  38813. <example>
  38814. <code language="c#" source="Examples\SmtpExamples.cs" region="ProtocolLogger" />
  38815. </example>
  38816. </member>
  38817. <member name="M:MailKit.IProtocolLogger.LogConnect(System.Uri)">
  38818. <summary>
  38819. Logs a connection to the specified URI.
  38820. </summary>
  38821. <remarks>
  38822. Logs a connection to the specified URI.
  38823. </remarks>
  38824. <param name="uri">The URI.</param>
  38825. <exception cref="T:System.ArgumentNullException">
  38826. <paramref name="uri"/> is <c>null</c>.
  38827. </exception>
  38828. <exception cref="T:System.ObjectDisposedException">
  38829. The logger has been disposed.
  38830. </exception>
  38831. <exception cref="T:System.IO.IOException">
  38832. An I/O error occurred.
  38833. </exception>
  38834. </member>
  38835. <member name="M:MailKit.IProtocolLogger.LogClient(System.Byte[],System.Int32,System.Int32)">
  38836. <summary>
  38837. Logs a sequence of bytes sent by the client.
  38838. </summary>
  38839. <remarks>
  38840. <para>Logs a sequence of bytes sent by the client.</para>
  38841. <para><see cref="M:MailKit.IProtocolLogger.LogClient(System.Byte[],System.Int32,System.Int32)"/> is called by the <see cref="T:MailKit.IMailService"/> upon every successful
  38842. write operation to its underlying network stream, passing the exact same <paramref name="buffer"/>,
  38843. <paramref name="offset"/>, and <paramref name="count"/> arguments to the logging function.</para>
  38844. </remarks>
  38845. <param name='buffer'>The buffer to log.</param>
  38846. <param name='offset'>The offset of the first byte to log.</param>
  38847. <param name='count'>The number of bytes to log.</param>
  38848. <exception cref="T:System.ArgumentNullException">
  38849. <paramref name="buffer"/> is <c>null</c>.
  38850. </exception>
  38851. <exception cref="T:System.ArgumentOutOfRangeException">
  38852. <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
  38853. <para>-or-</para>
  38854. <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
  38855. at the specified <paramref name="offset"/>.</para>
  38856. </exception>
  38857. <exception cref="T:System.ObjectDisposedException">
  38858. The logger has been disposed.
  38859. </exception>
  38860. <exception cref="T:System.IO.IOException">
  38861. An I/O error occurred.
  38862. </exception>
  38863. </member>
  38864. <member name="M:MailKit.IProtocolLogger.LogServer(System.Byte[],System.Int32,System.Int32)">
  38865. <summary>
  38866. Logs a sequence of bytes sent by the server.
  38867. </summary>
  38868. <remarks>
  38869. <para>Logs a sequence of bytes sent by the server.</para>
  38870. <para><see cref="M:MailKit.IProtocolLogger.LogServer(System.Byte[],System.Int32,System.Int32)"/> is called by the <see cref="T:MailKit.IMailService"/> upon every successful
  38871. read of its underlying network stream with the exact buffer that was read.</para>
  38872. </remarks>
  38873. <param name='buffer'>The buffer to log.</param>
  38874. <param name='offset'>The offset of the first byte to log.</param>
  38875. <param name='count'>The number of bytes to log.</param>
  38876. <exception cref="T:System.ArgumentNullException">
  38877. <paramref name="buffer"/> is <c>null</c>.
  38878. </exception>
  38879. <exception cref="T:System.ArgumentOutOfRangeException">
  38880. <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
  38881. <para>-or-</para>
  38882. <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
  38883. at the specified <paramref name="offset"/>.</para>
  38884. </exception>
  38885. <exception cref="T:System.ObjectDisposedException">
  38886. The logger has been disposed.
  38887. </exception>
  38888. <exception cref="T:System.IO.IOException">
  38889. An I/O error occurred.
  38890. </exception>
  38891. </member>
  38892. <member name="T:MailKit.ITransferProgress">
  38893. <summary>
  38894. An interface for reporting progress of uploading or downloading messages.
  38895. </summary>
  38896. <remarks>
  38897. An interface for reporting progress of uploading or downloading messages.
  38898. </remarks>
  38899. </member>
  38900. <member name="M:MailKit.ITransferProgress.Report(System.Int64,System.Int64)">
  38901. <summary>
  38902. Report the progress of the transfer operation.
  38903. </summary>
  38904. <remarks>
  38905. <para>Reports the progress of the transfer operation.</para>
  38906. <para>This method is only used if the operation knows the size
  38907. of the message, part, or stream being transferred without doing
  38908. extra work to calculate it.</para>
  38909. </remarks>
  38910. <param name="bytesTransferred">The number of bytes transferred.</param>
  38911. <param name="totalSize">The total size, in bytes, of the message, part, or stream being transferred.</param>
  38912. </member>
  38913. <member name="M:MailKit.ITransferProgress.Report(System.Int64)">
  38914. <summary>
  38915. Report the progress of the transfer operation.
  38916. </summary>
  38917. <remarks>
  38918. <para>Reports the progress of the transfer operation.</para>
  38919. </remarks>
  38920. <param name="bytesTransferred">The number of bytes transferred.</param>
  38921. </member>
  38922. <member name="T:MailKit.MailFolder">
  38923. <summary>
  38924. An abstract mail folder implementation.
  38925. </summary>
  38926. <remarks>
  38927. An abstract mail folder implementation.
  38928. </remarks>
  38929. </member>
  38930. <member name="F:MailKit.MailFolder.SettableFlags">
  38931. <summary>
  38932. The bit mask of settable flags.
  38933. </summary>
  38934. <remarks>
  38935. Only flags in the list of settable flags may be set on a message by the client.
  38936. </remarks>
  38937. </member>
  38938. <member name="M:MailKit.MailFolder.#ctor">
  38939. <summary>
  38940. Initialize a new instance of the <see cref="T:MailKit.MailFolder"/> class.
  38941. </summary>
  38942. <remarks>
  38943. Initializes a new instance of the <see cref="T:MailKit.MailFolder"/> class.
  38944. </remarks>
  38945. </member>
  38946. <member name="P:MailKit.MailFolder.SyncRoot">
  38947. <summary>
  38948. Get an object that can be used to synchronize access to the folder.
  38949. </summary>
  38950. <remarks>
  38951. <para>Gets an object that can be used to synchronize access to the folder.</para>
  38952. </remarks>
  38953. <value>The sync root.</value>
  38954. </member>
  38955. <member name="P:MailKit.MailFolder.ParentFolder">
  38956. <summary>
  38957. Get the parent folder.
  38958. </summary>
  38959. <remarks>
  38960. Root-level folders do not have a parent folder.
  38961. </remarks>
  38962. <value>The parent folder.</value>
  38963. </member>
  38964. <member name="P:MailKit.MailFolder.Attributes">
  38965. <summary>
  38966. Get the folder attributes.
  38967. </summary>
  38968. <remarks>
  38969. Gets the folder attributes.
  38970. </remarks>
  38971. <value>The folder attributes.</value>
  38972. </member>
  38973. <member name="P:MailKit.MailFolder.AnnotationAccess">
  38974. <summary>
  38975. Get the annotation access level.
  38976. </summary>
  38977. <remarks>
  38978. If annotations are supported, this property can be used to determine whether or not
  38979. the <see cref="T:MailKit.IMailFolder"/> supports reading and writing annotations.
  38980. </remarks>
  38981. </member>
  38982. <member name="P:MailKit.MailFolder.AnnotationScopes">
  38983. <summary>
  38984. Get the supported annotation scopes.
  38985. </summary>
  38986. <remarks>
  38987. If annotations are supported, this property can be used to determine which
  38988. annotation scopes are supported by the <see cref="T:MailKit.IMailFolder"/>.
  38989. </remarks>
  38990. </member>
  38991. <member name="P:MailKit.MailFolder.MaxAnnotationSize">
  38992. <summary>
  38993. Get the maximum size of annotation values supported by the folder.
  38994. </summary>
  38995. <remarks>
  38996. If annotations are supported, this property can be used to determine the
  38997. maximum size of annotation values supported by the <see cref="T:MailKit.IMailFolder"/>.
  38998. </remarks>
  38999. </member>
  39000. <member name="P:MailKit.MailFolder.PermanentFlags">
  39001. <summary>
  39002. Get the permanent flags.
  39003. </summary>
  39004. <remarks>
  39005. <para>The permanent flags are the message flags that will persist between sessions.</para>
  39006. <para>If the <see cref="F:MailKit.MessageFlags.UserDefined"/> flag is set, then the folder allows
  39007. storing of user-defined (custom) message flags.</para>
  39008. </remarks>
  39009. <value>The permanent flags.</value>
  39010. </member>
  39011. <member name="P:MailKit.MailFolder.AcceptedFlags">
  39012. <summary>
  39013. Get the accepted flags.
  39014. </summary>
  39015. <remarks>
  39016. The accepted flags are the message flags that will be accepted and persist
  39017. for the current session. For the set of flags that will persist between
  39018. sessions, see the <see cref="P:MailKit.MailFolder.PermanentFlags"/> property.
  39019. </remarks>
  39020. <value>The accepted flags.</value>
  39021. </member>
  39022. <member name="P:MailKit.MailFolder.DirectorySeparator">
  39023. <summary>
  39024. Get the directory separator.
  39025. </summary>
  39026. <remarks>
  39027. Gets the directory separator.
  39028. </remarks>
  39029. <value>The directory separator.</value>
  39030. </member>
  39031. <member name="P:MailKit.MailFolder.Access">
  39032. <summary>
  39033. Get the read/write access of the folder.
  39034. </summary>
  39035. <remarks>
  39036. Gets the read/write access of the folder.
  39037. </remarks>
  39038. <value>The read/write access.</value>
  39039. </member>
  39040. <member name="P:MailKit.MailFolder.IsNamespace">
  39041. <summary>
  39042. Get whether or not the folder is a namespace folder.
  39043. </summary>
  39044. <remarks>
  39045. Gets whether or not the folder is a namespace folder.
  39046. </remarks>
  39047. <value><c>true</c> if the folder is a namespace folder; otherwise, <c>false</c>.</value>
  39048. </member>
  39049. <member name="P:MailKit.MailFolder.FullName">
  39050. <summary>
  39051. Get the full name of the folder.
  39052. </summary>
  39053. <remarks>
  39054. This is the equivalent of the full path of a file on a file system.
  39055. </remarks>
  39056. <value>The full name of the folder.</value>
  39057. </member>
  39058. <member name="P:MailKit.MailFolder.Name">
  39059. <summary>
  39060. Get the name of the folder.
  39061. </summary>
  39062. <remarks>
  39063. This is the equivalent of the file name of a file on the file system.
  39064. </remarks>
  39065. <value>The name of the folder.</value>
  39066. </member>
  39067. <member name="P:MailKit.MailFolder.Id">
  39068. <summary>
  39069. Get the unique identifier for the folder, if available.
  39070. </summary>
  39071. <remarks>
  39072. <para>Gets a unique identifier for the folder, if available. This is useful for clients
  39073. implementing a message cache that want to track the folder after it is renamed by another
  39074. client.</para>
  39075. <note type="note">This property will only be available if the server supports the
  39076. <a href="https://tools.ietf.org/html/rfc8474">OBJECTID</a> extension.</note>
  39077. </remarks>
  39078. <value>The unique folder identifier.</value>
  39079. </member>
  39080. <member name="P:MailKit.MailFolder.IsSubscribed">
  39081. <summary>
  39082. Get a value indicating whether the folder is subscribed.
  39083. </summary>
  39084. <remarks>
  39085. Gets a value indicating whether the folder is subscribed.
  39086. </remarks>
  39087. <value><c>true</c> if the folder is subscribed; otherwise, <c>false</c>.</value>
  39088. </member>
  39089. <member name="P:MailKit.MailFolder.IsOpen">
  39090. <summary>
  39091. Get a value indicating whether the folder is currently open.
  39092. </summary>
  39093. <remarks>
  39094. Gets a value indicating whether the folder is currently open.
  39095. </remarks>
  39096. <value><c>true</c> if the folder is currently open; otherwise, <c>false</c>.</value>
  39097. </member>
  39098. <member name="P:MailKit.MailFolder.Exists">
  39099. <summary>
  39100. Get a value indicating whether the folder exists.
  39101. </summary>
  39102. <remarks>
  39103. Gets a value indicating whether the folder exists.
  39104. </remarks>
  39105. <value><c>true</c> if the folder exists; otherwise, <c>false</c>.</value>
  39106. </member>
  39107. <member name="P:MailKit.MailFolder.SupportsModSeq">
  39108. <summary>
  39109. Get whether or not the folder supports mod-sequences.
  39110. </summary>
  39111. <remarks>
  39112. <para>If mod-sequences are not supported by the folder, then all of the APIs that take a modseq
  39113. argument will throw <see cref="T:System.NotSupportedException"/> and should not be used.</para>
  39114. </remarks>
  39115. <value><c>true</c> if supports mod-sequences; otherwise, <c>false</c>.</value>
  39116. </member>
  39117. <member name="P:MailKit.MailFolder.HighestModSeq">
  39118. <summary>
  39119. Get the highest mod-sequence value of all messages in the mailbox.
  39120. </summary>
  39121. <remarks>
  39122. Gets the highest mod-sequence value of all messages in the mailbox.
  39123. </remarks>
  39124. <value>The highest mod-sequence value.</value>
  39125. </member>
  39126. <member name="P:MailKit.MailFolder.UidValidity">
  39127. <summary>
  39128. Get the UID validity.
  39129. </summary>
  39130. <remarks>
  39131. <para>UIDs are only valid so long as the UID validity value remains unchanged. If and when
  39132. the folder's <see cref="P:MailKit.MailFolder.UidValidity"/> is changed, a client MUST discard its cache of UIDs
  39133. along with any summary information that it may have and re-query the folder.</para>
  39134. <para>This value will only be set after the folder has been opened.</para>
  39135. </remarks>
  39136. <value>The UID validity.</value>
  39137. </member>
  39138. <member name="P:MailKit.MailFolder.UidNext">
  39139. <summary>
  39140. Get the UID that the folder will assign to the next message that is added.
  39141. </summary>
  39142. <remarks>
  39143. This value will only be set after the folder has been opened.
  39144. </remarks>
  39145. <value>The next UID.</value>
  39146. </member>
  39147. <member name="P:MailKit.MailFolder.AppendLimit">
  39148. <summary>
  39149. Get the maximum size of a message that can be appended to the folder.
  39150. </summary>
  39151. <remarks>
  39152. <para>Gets the maximum size of a message that can be appended to the folder.</para>
  39153. <note type="note">If the value is not set, then the limit is unspecified.</note>
  39154. </remarks>
  39155. <value>The append limit.</value>
  39156. </member>
  39157. <member name="P:MailKit.MailFolder.Size">
  39158. <summary>
  39159. Get the size of the folder.
  39160. </summary>
  39161. <remarks>
  39162. <para>Gets the size of the folder in bytes.</para>
  39163. <note type="note">If the value is not set, then the size is unspecified.</note>
  39164. </remarks>
  39165. <value>The size.</value>
  39166. </member>
  39167. <member name="P:MailKit.MailFolder.FirstUnread">
  39168. <summary>
  39169. Get the index of the first unread message in the folder.
  39170. </summary>
  39171. <remarks>
  39172. This value will only be set after the folder has been opened.
  39173. </remarks>
  39174. <value>The index of the first unread message.</value>
  39175. </member>
  39176. <member name="P:MailKit.MailFolder.Unread">
  39177. <summary>
  39178. Get the number of unread messages in the folder.
  39179. </summary>
  39180. <remarks>
  39181. <para>Gets the number of unread messages in the folder.</para>
  39182. <note type="note">This value will only be set after calling
  39183. <see cref="M:MailKit.MailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/>
  39184. with <see cref="F:MailKit.StatusItems.Unread"/>.</note>
  39185. </remarks>
  39186. <value>The number of unread messages.</value>
  39187. </member>
  39188. <member name="P:MailKit.MailFolder.Recent">
  39189. <summary>
  39190. Get the number of recently added messages in the folder.
  39191. </summary>
  39192. <remarks>
  39193. <para>Gets the number of recently delivered messages in the folder.</para>
  39194. <note type="note">This value will only be set after calling
  39195. <see cref="M:MailKit.MailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/>
  39196. with <see cref="F:MailKit.StatusItems.Recent"/> or by opening the folder.</note>
  39197. </remarks>
  39198. <value>The number of recently added messages.</value>
  39199. </member>
  39200. <member name="P:MailKit.MailFolder.Count">
  39201. <summary>
  39202. Get the total number of messages in the folder.
  39203. </summary>
  39204. <remarks>
  39205. <para>Gets the total number of messages in the folder.</para>
  39206. <note type="note">This value will only be set after calling
  39207. <see cref="M:MailKit.MailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/>
  39208. with <see cref="F:MailKit.StatusItems.Count"/> or by opening the folder.</note>
  39209. </remarks>
  39210. <value>The total number of messages.</value>
  39211. </member>
  39212. <member name="M:MailKit.MailFolder.Open(MailKit.FolderAccess,System.UInt32,System.UInt64,System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)">
  39213. <summary>
  39214. Opens the folder using the requested folder access.
  39215. </summary>
  39216. <remarks>
  39217. <para>This variant of the <see cref="M:MailKit.MailFolder.Open(MailKit.FolderAccess,System.Threading.CancellationToken)"/>
  39218. method is meant for quick resynchronization of the folder. Before calling this method,
  39219. the <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/> method MUST be called.</para>
  39220. <para>You should also make sure to add listeners to the <see cref="E:MailKit.MailFolder.MessagesVanished"/> and
  39221. <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events to get notifications of changes since
  39222. the last time the folder was opened.</para>
  39223. </remarks>
  39224. <returns>The <see cref="T:MailKit.FolderAccess"/> state of the folder.</returns>
  39225. <param name="access">The requested folder access.</param>
  39226. <param name="uidValidity">The last known <see cref="P:MailKit.MailFolder.UidValidity"/> value.</param>
  39227. <param name="highestModSeq">The last known <see cref="P:MailKit.MailFolder.HighestModSeq"/> value.</param>
  39228. <param name="uids">The last known list of unique message identifiers.</param>
  39229. <param name="cancellationToken">The cancellation token.</param>
  39230. <exception cref="T:System.ArgumentOutOfRangeException">
  39231. <paramref name="access"/> is not a valid value.
  39232. </exception>
  39233. <exception cref="T:System.ObjectDisposedException">
  39234. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  39235. </exception>
  39236. <exception cref="T:MailKit.ServiceNotConnectedException">
  39237. The <see cref="T:MailKit.IMailStore"/> is not connected.
  39238. </exception>
  39239. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  39240. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  39241. </exception>
  39242. <exception cref="T:MailKit.FolderNotFoundException">
  39243. The <see cref="T:MailKit.MailFolder"/> does not exist.
  39244. </exception>
  39245. <exception cref="T:System.InvalidOperationException">
  39246. The quick resynchronization feature has not been enabled.
  39247. </exception>
  39248. <exception cref="T:System.NotSupportedException">
  39249. The mail store does not support the quick resynchronization feature.
  39250. </exception>
  39251. <exception cref="T:System.OperationCanceledException">
  39252. The operation was canceled via the cancellation token.
  39253. </exception>
  39254. <exception cref="T:System.IO.IOException">
  39255. An I/O error occurred.
  39256. </exception>
  39257. <exception cref="T:MailKit.ProtocolException">
  39258. The server's response contained unexpected tokens.
  39259. </exception>
  39260. <exception cref="T:MailKit.CommandException">
  39261. The command failed.
  39262. </exception>
  39263. </member>
  39264. <member name="M:MailKit.MailFolder.OpenAsync(MailKit.FolderAccess,System.UInt32,System.UInt64,System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)">
  39265. <summary>
  39266. Asynchronously opens the folder using the requested folder access.
  39267. </summary>
  39268. <remarks>
  39269. <para>This variant of the <see cref="M:MailKit.MailFolder.OpenAsync(MailKit.FolderAccess,System.Threading.CancellationToken)"/>
  39270. method is meant for quick resynchronization of the folder. Before calling this method,
  39271. the <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/> method MUST be called.</para>
  39272. <para>You should also make sure to add listeners to the <see cref="E:MailKit.MailFolder.MessagesVanished"/> and
  39273. <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events to get notifications of changes since
  39274. the last time the folder was opened.</para>
  39275. </remarks>
  39276. <returns>The <see cref="T:MailKit.FolderAccess"/> state of the folder.</returns>
  39277. <param name="access">The requested folder access.</param>
  39278. <param name="uidValidity">The last known <see cref="P:MailKit.MailFolder.UidValidity"/> value.</param>
  39279. <param name="highestModSeq">The last known <see cref="P:MailKit.MailFolder.HighestModSeq"/> value.</param>
  39280. <param name="uids">The last known list of unique message identifiers.</param>
  39281. <param name="cancellationToken">The cancellation token.</param>
  39282. <exception cref="T:System.ArgumentOutOfRangeException">
  39283. <paramref name="access"/> is not a valid value.
  39284. </exception>
  39285. <exception cref="T:System.ObjectDisposedException">
  39286. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  39287. </exception>
  39288. <exception cref="T:MailKit.ServiceNotConnectedException">
  39289. The <see cref="T:MailKit.IMailStore"/> is not connected.
  39290. </exception>
  39291. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  39292. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  39293. </exception>
  39294. <exception cref="T:MailKit.FolderNotFoundException">
  39295. The <see cref="T:MailKit.MailFolder"/> does not exist.
  39296. </exception>
  39297. <exception cref="T:System.InvalidOperationException">
  39298. The quick resynchronization feature has not been enabled.
  39299. </exception>
  39300. <exception cref="T:System.NotSupportedException">
  39301. The mail store does not support the quick resynchronization feature.
  39302. </exception>
  39303. <exception cref="T:System.OperationCanceledException">
  39304. The operation was canceled via the cancellation token.
  39305. </exception>
  39306. <exception cref="T:System.IO.IOException">
  39307. An I/O error occurred.
  39308. </exception>
  39309. <exception cref="T:MailKit.ProtocolException">
  39310. The server's response contained unexpected tokens.
  39311. </exception>
  39312. <exception cref="T:MailKit.CommandException">
  39313. The command failed.
  39314. </exception>
  39315. </member>
  39316. <member name="M:MailKit.MailFolder.Open(MailKit.FolderAccess,System.Threading.CancellationToken)">
  39317. <summary>
  39318. Open the folder using the requested folder access.
  39319. </summary>
  39320. <remarks>
  39321. Opens the folder using the requested folder access.
  39322. </remarks>
  39323. <returns>The <see cref="T:MailKit.FolderAccess"/> state of the folder.</returns>
  39324. <param name="access">The requested folder access.</param>
  39325. <param name="cancellationToken">The cancellation token.</param>
  39326. <exception cref="T:System.ArgumentOutOfRangeException">
  39327. <paramref name="access"/> is not a valid value.
  39328. </exception>
  39329. <exception cref="T:System.ObjectDisposedException">
  39330. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  39331. </exception>
  39332. <exception cref="T:MailKit.ServiceNotConnectedException">
  39333. The <see cref="T:MailKit.IMailStore"/> is not connected.
  39334. </exception>
  39335. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  39336. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  39337. </exception>
  39338. <exception cref="T:MailKit.FolderNotFoundException">
  39339. The <see cref="T:MailKit.MailFolder"/> does not exist.
  39340. </exception>
  39341. <exception cref="T:System.OperationCanceledException">
  39342. The operation was canceled via the cancellation token.
  39343. </exception>
  39344. <exception cref="T:System.IO.IOException">
  39345. An I/O error occurred.
  39346. </exception>
  39347. <exception cref="T:MailKit.ProtocolException">
  39348. The server's response contained unexpected tokens.
  39349. </exception>
  39350. <exception cref="T:MailKit.CommandException">
  39351. The command failed.
  39352. </exception>
  39353. </member>
  39354. <member name="M:MailKit.MailFolder.OpenAsync(MailKit.FolderAccess,System.Threading.CancellationToken)">
  39355. <summary>
  39356. Asynchronously open the folder using the requested folder access.
  39357. </summary>
  39358. <remarks>
  39359. Asynchronously opens the folder using the requested folder access.
  39360. </remarks>
  39361. <returns>The <see cref="T:MailKit.FolderAccess"/> state of the folder.</returns>
  39362. <param name="access">The requested folder access.</param>
  39363. <param name="cancellationToken">The cancellation token.</param>
  39364. <exception cref="T:System.ArgumentOutOfRangeException">
  39365. <paramref name="access"/> is not a valid value.
  39366. </exception>
  39367. <exception cref="T:System.ObjectDisposedException">
  39368. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  39369. </exception>
  39370. <exception cref="T:MailKit.ServiceNotConnectedException">
  39371. The <see cref="T:MailKit.IMailStore"/> is not connected.
  39372. </exception>
  39373. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  39374. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  39375. </exception>
  39376. <exception cref="T:MailKit.FolderNotFoundException">
  39377. The <see cref="T:MailKit.MailFolder"/> does not exist.
  39378. </exception>
  39379. <exception cref="T:System.OperationCanceledException">
  39380. The operation was canceled via the cancellation token.
  39381. </exception>
  39382. <exception cref="T:System.IO.IOException">
  39383. An I/O error occurred.
  39384. </exception>
  39385. <exception cref="T:MailKit.ProtocolException">
  39386. The server's response contained unexpected tokens.
  39387. </exception>
  39388. <exception cref="T:MailKit.CommandException">
  39389. The command failed.
  39390. </exception>
  39391. </member>
  39392. <member name="M:MailKit.MailFolder.Close(System.Boolean,System.Threading.CancellationToken)">
  39393. <summary>
  39394. Close the folder, optionally expunging the messages marked for deletion.
  39395. </summary>
  39396. <remarks>
  39397. Closes the folder, optionally expunging the messages marked for deletion.
  39398. </remarks>
  39399. <param name="expunge">If set to <c>true</c>, expunge.</param>
  39400. <param name="cancellationToken">The cancellation token.</param>
  39401. <exception cref="T:System.ObjectDisposedException">
  39402. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  39403. </exception>
  39404. <exception cref="T:MailKit.ServiceNotConnectedException">
  39405. The <see cref="T:MailKit.IMailStore"/> is not connected.
  39406. </exception>
  39407. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  39408. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  39409. </exception>
  39410. <exception cref="T:MailKit.FolderNotOpenException">
  39411. The folder is not currently open.
  39412. </exception>
  39413. <exception cref="T:System.OperationCanceledException">
  39414. The operation was canceled via the cancellation token.
  39415. </exception>
  39416. <exception cref="T:System.IO.IOException">
  39417. An I/O error occurred.
  39418. </exception>
  39419. <exception cref="T:MailKit.ProtocolException">
  39420. The server's response contained unexpected tokens.
  39421. </exception>
  39422. <exception cref="T:MailKit.CommandException">
  39423. The command failed.
  39424. </exception>
  39425. </member>
  39426. <member name="M:MailKit.MailFolder.CloseAsync(System.Boolean,System.Threading.CancellationToken)">
  39427. <summary>
  39428. Asynchronously close the folder, optionally expunging the messages marked for deletion.
  39429. </summary>
  39430. <remarks>
  39431. Asynchronously closes the folder, optionally expunging the messages marked for deletion.
  39432. </remarks>
  39433. <returns>An asynchronous task context.</returns>
  39434. <param name="expunge">If set to <c>true</c>, expunge.</param>
  39435. <param name="cancellationToken">The cancellation token.</param>
  39436. <exception cref="T:System.ObjectDisposedException">
  39437. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  39438. </exception>
  39439. <exception cref="T:MailKit.ServiceNotConnectedException">
  39440. The <see cref="T:MailKit.IMailStore"/> is not connected.
  39441. </exception>
  39442. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  39443. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  39444. </exception>
  39445. <exception cref="T:MailKit.FolderNotOpenException">
  39446. The folder is not currently open.
  39447. </exception>
  39448. <exception cref="T:System.OperationCanceledException">
  39449. The operation was canceled via the cancellation token.
  39450. </exception>
  39451. <exception cref="T:System.IO.IOException">
  39452. An I/O error occurred.
  39453. </exception>
  39454. <exception cref="T:MailKit.ProtocolException">
  39455. The server's response contained unexpected tokens.
  39456. </exception>
  39457. <exception cref="T:MailKit.CommandException">
  39458. The command failed.
  39459. </exception>
  39460. </member>
  39461. <member name="M:MailKit.MailFolder.Create(System.String,System.Boolean,System.Threading.CancellationToken)">
  39462. <summary>
  39463. Create a new subfolder with the given name.
  39464. </summary>
  39465. <remarks>
  39466. Creates a new subfolder with the given name.
  39467. </remarks>
  39468. <returns>The created folder.</returns>
  39469. <param name="name">The name of the folder to create.</param>
  39470. <param name="isMessageFolder"><c>true</c> if the folder will be used to contain messages; otherwise <c>false</c>.</param>
  39471. <param name="cancellationToken">The cancellation token.</param>
  39472. <exception cref="T:System.ArgumentNullException">
  39473. <paramref name="name"/> is <c>null</c>.
  39474. </exception>
  39475. <exception cref="T:System.ArgumentException">
  39476. <paramref name="name"/> is empty.
  39477. </exception>
  39478. <exception cref="T:System.ObjectDisposedException">
  39479. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  39480. </exception>
  39481. <exception cref="T:MailKit.ServiceNotConnectedException">
  39482. The <see cref="T:MailKit.IMailStore"/> is not connected.
  39483. </exception>
  39484. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  39485. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  39486. </exception>
  39487. <exception cref="T:System.InvalidOperationException">
  39488. The <see cref="P:MailKit.MailFolder.DirectorySeparator"/> is nil, and thus child folders cannot be created.
  39489. </exception>
  39490. <exception cref="T:System.OperationCanceledException">
  39491. The operation was canceled via the cancellation token.
  39492. </exception>
  39493. <exception cref="T:System.IO.IOException">
  39494. An I/O error occurred.
  39495. </exception>
  39496. <exception cref="T:MailKit.ProtocolException">
  39497. The server's response contained unexpected tokens.
  39498. </exception>
  39499. <exception cref="T:MailKit.CommandException">
  39500. The command failed.
  39501. </exception>
  39502. </member>
  39503. <member name="M:MailKit.MailFolder.CreateAsync(System.String,System.Boolean,System.Threading.CancellationToken)">
  39504. <summary>
  39505. Asynchronously create a new subfolder with the given name.
  39506. </summary>
  39507. <remarks>
  39508. Asynchronously creates a new subfolder with the given name.
  39509. </remarks>
  39510. <returns>The created folder.</returns>
  39511. <param name="name">The name of the folder to create.</param>
  39512. <param name="isMessageFolder"><c>true</c> if the folder will be used to contain messages; otherwise <c>false</c>.</param>
  39513. <param name="cancellationToken">The cancellation token.</param>
  39514. <exception cref="T:System.ArgumentNullException">
  39515. <paramref name="name"/> is <c>null</c>.
  39516. </exception>
  39517. <exception cref="T:System.ArgumentException">
  39518. <paramref name="name"/> is empty.
  39519. </exception>
  39520. <exception cref="T:System.ObjectDisposedException">
  39521. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  39522. </exception>
  39523. <exception cref="T:MailKit.ServiceNotConnectedException">
  39524. The <see cref="T:MailKit.IMailStore"/> is not connected.
  39525. </exception>
  39526. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  39527. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  39528. </exception>
  39529. <exception cref="T:System.InvalidOperationException">
  39530. The <see cref="P:MailKit.MailFolder.DirectorySeparator"/> is nil, and thus child folders cannot be created.
  39531. </exception>
  39532. <exception cref="T:System.OperationCanceledException">
  39533. The operation was canceled via the cancellation token.
  39534. </exception>
  39535. <exception cref="T:System.IO.IOException">
  39536. An I/O error occurred.
  39537. </exception>
  39538. <exception cref="T:MailKit.ProtocolException">
  39539. The server's response contained unexpected tokens.
  39540. </exception>
  39541. <exception cref="T:MailKit.CommandException">
  39542. The command failed.
  39543. </exception>
  39544. </member>
  39545. <member name="M:MailKit.MailFolder.Create(System.String,System.Collections.Generic.IEnumerable{MailKit.SpecialFolder},System.Threading.CancellationToken)">
  39546. <summary>
  39547. Create a new subfolder with the given name.
  39548. </summary>
  39549. <remarks>
  39550. Creates a new subfolder with the given name.
  39551. </remarks>
  39552. <returns>The created folder.</returns>
  39553. <param name="name">The name of the folder to create.</param>
  39554. <param name="specialUses">A list of special uses for the folder being created.</param>
  39555. <param name="cancellationToken">The cancellation token.</param>
  39556. <exception cref="T:System.ArgumentNullException">
  39557. <para><paramref name="name"/> is <c>null</c>.</para>
  39558. <para>-or-</para>
  39559. <para><paramref name="specialUses"/> is <c>null</c>.</para>
  39560. </exception>
  39561. <exception cref="T:System.ArgumentException">
  39562. <paramref name="name"/> is empty.
  39563. </exception>
  39564. <exception cref="T:System.ObjectDisposedException">
  39565. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  39566. </exception>
  39567. <exception cref="T:MailKit.ServiceNotConnectedException">
  39568. The <see cref="T:MailKit.IMailStore"/> is not connected.
  39569. </exception>
  39570. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  39571. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  39572. </exception>
  39573. <exception cref="T:System.InvalidOperationException">
  39574. The <see cref="P:MailKit.MailFolder.DirectorySeparator"/> is nil, and thus child folders cannot be created.
  39575. </exception>
  39576. <exception cref="T:System.NotSupportedException">
  39577. The <see cref="T:MailKit.MailService"/> does not support the creation of special folders.
  39578. </exception>
  39579. <exception cref="T:System.OperationCanceledException">
  39580. The operation was canceled via the cancellation token.
  39581. </exception>
  39582. <exception cref="T:System.IO.IOException">
  39583. An I/O error occurred.
  39584. </exception>
  39585. <exception cref="T:MailKit.ProtocolException">
  39586. The server's response contained unexpected tokens.
  39587. </exception>
  39588. <exception cref="T:MailKit.CommandException">
  39589. The command failed.
  39590. </exception>
  39591. </member>
  39592. <member name="M:MailKit.MailFolder.CreateAsync(System.String,System.Collections.Generic.IEnumerable{MailKit.SpecialFolder},System.Threading.CancellationToken)">
  39593. <summary>
  39594. Asynchronously create a new subfolder with the given name.
  39595. </summary>
  39596. <remarks>
  39597. Asynchronously creates a new subfolder with the given name.
  39598. </remarks>
  39599. <returns>The created folder.</returns>
  39600. <param name="name">The name of the folder to create.</param>
  39601. <param name="specialUses">A list of special uses for the folder being created.</param>
  39602. <param name="cancellationToken">The cancellation token.</param>
  39603. <exception cref="T:System.ArgumentNullException">
  39604. <para><paramref name="name"/> is <c>null</c>.</para>
  39605. <para>-or-</para>
  39606. <para><paramref name="specialUses"/> is <c>null</c>.</para>
  39607. </exception>
  39608. <exception cref="T:System.ArgumentException">
  39609. <paramref name="name"/> is empty.
  39610. </exception>
  39611. <exception cref="T:System.ObjectDisposedException">
  39612. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  39613. </exception>
  39614. <exception cref="T:MailKit.ServiceNotConnectedException">
  39615. The <see cref="T:MailKit.IMailStore"/> is not connected.
  39616. </exception>
  39617. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  39618. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  39619. </exception>
  39620. <exception cref="T:System.InvalidOperationException">
  39621. The <see cref="P:MailKit.MailFolder.DirectorySeparator"/> is nil, and thus child folders cannot be created.
  39622. </exception>
  39623. <exception cref="T:System.NotSupportedException">
  39624. The <see cref="T:MailKit.MailService"/> does not support the creation of special folders.
  39625. </exception>
  39626. <exception cref="T:System.OperationCanceledException">
  39627. The operation was canceled via the cancellation token.
  39628. </exception>
  39629. <exception cref="T:System.IO.IOException">
  39630. An I/O error occurred.
  39631. </exception>
  39632. <exception cref="T:MailKit.ProtocolException">
  39633. The server's response contained unexpected tokens.
  39634. </exception>
  39635. <exception cref="T:MailKit.CommandException">
  39636. The command failed.
  39637. </exception>
  39638. </member>
  39639. <member name="M:MailKit.MailFolder.Create(System.String,MailKit.SpecialFolder,System.Threading.CancellationToken)">
  39640. <summary>
  39641. Create a new subfolder with the given name.
  39642. </summary>
  39643. <remarks>
  39644. Creates a new subfolder with the given name.
  39645. </remarks>
  39646. <returns>The created folder.</returns>
  39647. <param name="name">The name of the folder to create.</param>
  39648. <param name="specialUse">The special use for the folder being created.</param>
  39649. <param name="cancellationToken">The cancellation token.</param>
  39650. <exception cref="T:System.ArgumentNullException">
  39651. <paramref name="name"/> is <c>null</c>.
  39652. </exception>
  39653. <exception cref="T:System.ArgumentException">
  39654. <paramref name="name"/> is empty.
  39655. </exception>
  39656. <exception cref="T:System.ObjectDisposedException">
  39657. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  39658. </exception>
  39659. <exception cref="T:MailKit.ServiceNotConnectedException">
  39660. The <see cref="T:MailKit.IMailStore"/> is not connected.
  39661. </exception>
  39662. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  39663. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  39664. </exception>
  39665. <exception cref="T:System.InvalidOperationException">
  39666. The <see cref="P:MailKit.MailFolder.DirectorySeparator"/> is nil, and thus child folders cannot be created.
  39667. </exception>
  39668. <exception cref="T:System.NotSupportedException">
  39669. The <see cref="T:MailKit.MailService"/> does not support the creation of special folders.
  39670. </exception>
  39671. <exception cref="T:System.OperationCanceledException">
  39672. The operation was canceled via the cancellation token.
  39673. </exception>
  39674. <exception cref="T:System.IO.IOException">
  39675. An I/O error occurred.
  39676. </exception>
  39677. <exception cref="T:MailKit.ProtocolException">
  39678. The server's response contained unexpected tokens.
  39679. </exception>
  39680. <exception cref="T:MailKit.CommandException">
  39681. The command failed.
  39682. </exception>
  39683. </member>
  39684. <member name="M:MailKit.MailFolder.CreateAsync(System.String,MailKit.SpecialFolder,System.Threading.CancellationToken)">
  39685. <summary>
  39686. Asynchronously create a new subfolder with the given name.
  39687. </summary>
  39688. <remarks>
  39689. Asynchronously creates a new subfolder with the given name.
  39690. </remarks>
  39691. <returns>The created folder.</returns>
  39692. <param name="name">The name of the folder to create.</param>
  39693. <param name="specialUse">The special use for the folder being created.</param>
  39694. <param name="cancellationToken">The cancellation token.</param>
  39695. <exception cref="T:System.ArgumentNullException">
  39696. <paramref name="name"/> is <c>null</c>.
  39697. </exception>
  39698. <exception cref="T:System.ArgumentException">
  39699. <paramref name="name"/> is empty.
  39700. </exception>
  39701. <exception cref="T:System.ObjectDisposedException">
  39702. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  39703. </exception>
  39704. <exception cref="T:MailKit.ServiceNotConnectedException">
  39705. The <see cref="T:MailKit.IMailStore"/> is not connected.
  39706. </exception>
  39707. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  39708. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  39709. </exception>
  39710. <exception cref="T:System.InvalidOperationException">
  39711. The <see cref="P:MailKit.MailFolder.DirectorySeparator"/> is nil, and thus child folders cannot be created.
  39712. </exception>
  39713. <exception cref="T:System.NotSupportedException">
  39714. The <see cref="T:MailKit.MailService"/> does not support the creation of special folders.
  39715. </exception>
  39716. <exception cref="T:System.OperationCanceledException">
  39717. The operation was canceled via the cancellation token.
  39718. </exception>
  39719. <exception cref="T:System.IO.IOException">
  39720. An I/O error occurred.
  39721. </exception>
  39722. <exception cref="T:MailKit.ProtocolException">
  39723. The server's response contained unexpected tokens.
  39724. </exception>
  39725. <exception cref="T:MailKit.CommandException">
  39726. The command failed.
  39727. </exception>
  39728. </member>
  39729. <member name="M:MailKit.MailFolder.Rename(MailKit.IMailFolder,System.String,System.Threading.CancellationToken)">
  39730. <summary>
  39731. Rename the folder.
  39732. </summary>
  39733. <remarks>
  39734. Renames the folder.
  39735. </remarks>
  39736. <param name="parent">The new parent folder.</param>
  39737. <param name="name">The new name of the folder.</param>
  39738. <param name="cancellationToken">The cancellation token.</param>
  39739. <exception cref="T:System.ArgumentNullException">
  39740. <para><paramref name="parent"/> is <c>null</c>.</para>
  39741. <para>-or-</para>
  39742. <para><paramref name="name"/> is <c>null</c>.</para>
  39743. </exception>
  39744. <exception cref="T:System.ArgumentException">
  39745. <para><paramref name="parent"/> does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
  39746. <para>-or-</para>
  39747. <para><paramref name="name"/> is not a legal folder name.</para>
  39748. </exception>
  39749. <exception cref="T:System.ObjectDisposedException">
  39750. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  39751. </exception>
  39752. <exception cref="T:MailKit.ServiceNotConnectedException">
  39753. The <see cref="T:MailKit.IMailStore"/> is not connected.
  39754. </exception>
  39755. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  39756. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  39757. </exception>
  39758. <exception cref="T:System.InvalidOperationException">
  39759. The folder cannot be renamed (it is either a namespace or the Inbox).
  39760. </exception>
  39761. <exception cref="T:MailKit.FolderNotFoundException">
  39762. The <see cref="T:MailKit.MailFolder"/> does not exist.
  39763. </exception>
  39764. <exception cref="T:System.OperationCanceledException">
  39765. The operation was canceled via the cancellation token.
  39766. </exception>
  39767. <exception cref="T:System.IO.IOException">
  39768. An I/O error occurred.
  39769. </exception>
  39770. <exception cref="T:MailKit.ProtocolException">
  39771. The server's response contained unexpected tokens.
  39772. </exception>
  39773. <exception cref="T:MailKit.CommandException">
  39774. The command failed.
  39775. </exception>
  39776. </member>
  39777. <member name="M:MailKit.MailFolder.RenameAsync(MailKit.IMailFolder,System.String,System.Threading.CancellationToken)">
  39778. <summary>
  39779. Asynchronously rename the folder.
  39780. </summary>
  39781. <remarks>
  39782. Asynchronously renames the folder.
  39783. </remarks>
  39784. <returns>An asynchronous task context.</returns>
  39785. <param name="parent">The new parent folder.</param>
  39786. <param name="name">The new name of the folder.</param>
  39787. <param name="cancellationToken">The cancellation token.</param>
  39788. <exception cref="T:System.ArgumentNullException">
  39789. <para><paramref name="parent"/> is <c>null</c>.</para>
  39790. <para>-or-</para>
  39791. <para><paramref name="name"/> is <c>null</c>.</para>
  39792. </exception>
  39793. <exception cref="T:System.ArgumentException">
  39794. <para><paramref name="parent"/> does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
  39795. <para>-or-</para>
  39796. <para><paramref name="name"/> is not a legal folder name.</para>
  39797. </exception>
  39798. <exception cref="T:System.ObjectDisposedException">
  39799. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  39800. </exception>
  39801. <exception cref="T:MailKit.ServiceNotConnectedException">
  39802. The <see cref="T:MailKit.IMailStore"/> is not connected.
  39803. </exception>
  39804. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  39805. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  39806. </exception>
  39807. <exception cref="T:System.InvalidOperationException">
  39808. The folder cannot be renamed (it is either a namespace or the Inbox).
  39809. </exception>
  39810. <exception cref="T:MailKit.FolderNotFoundException">
  39811. The <see cref="T:MailKit.MailFolder"/> does not exist.
  39812. </exception>
  39813. <exception cref="T:System.OperationCanceledException">
  39814. The operation was canceled via the cancellation token.
  39815. </exception>
  39816. <exception cref="T:System.IO.IOException">
  39817. An I/O error occurred.
  39818. </exception>
  39819. <exception cref="T:MailKit.ProtocolException">
  39820. The server's response contained unexpected tokens.
  39821. </exception>
  39822. <exception cref="T:MailKit.CommandException">
  39823. The command failed.
  39824. </exception>
  39825. </member>
  39826. <member name="M:MailKit.MailFolder.Delete(System.Threading.CancellationToken)">
  39827. <summary>
  39828. Delete the folder.
  39829. </summary>
  39830. <remarks>
  39831. Deletes the folder.
  39832. </remarks>
  39833. <param name="cancellationToken">The cancellation token.</param>
  39834. <exception cref="T:System.ObjectDisposedException">
  39835. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  39836. </exception>
  39837. <exception cref="T:MailKit.ServiceNotConnectedException">
  39838. The <see cref="T:MailKit.IMailStore"/> is not connected.
  39839. </exception>
  39840. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  39841. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  39842. </exception>
  39843. <exception cref="T:System.InvalidOperationException">
  39844. The folder cannot be deleted (it is either a namespace or the Inbox).
  39845. </exception>
  39846. <exception cref="T:MailKit.FolderNotFoundException">
  39847. The <see cref="T:MailKit.MailFolder"/> does not exist.
  39848. </exception>
  39849. <exception cref="T:System.OperationCanceledException">
  39850. The operation was canceled via the cancellation token.
  39851. </exception>
  39852. <exception cref="T:System.IO.IOException">
  39853. An I/O error occurred.
  39854. </exception>
  39855. <exception cref="T:MailKit.ProtocolException">
  39856. The server's response contained unexpected tokens.
  39857. </exception>
  39858. <exception cref="T:MailKit.CommandException">
  39859. The command failed.
  39860. </exception>
  39861. </member>
  39862. <member name="M:MailKit.MailFolder.DeleteAsync(System.Threading.CancellationToken)">
  39863. <summary>
  39864. Asynchronously delete the folder.
  39865. </summary>
  39866. <remarks>
  39867. Asynchronously deletes the folder.
  39868. </remarks>
  39869. <returns>An asynchronous task context.</returns>
  39870. <param name="cancellationToken">The cancellation token.</param>
  39871. <exception cref="T:System.ObjectDisposedException">
  39872. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  39873. </exception>
  39874. <exception cref="T:MailKit.ServiceNotConnectedException">
  39875. The <see cref="T:MailKit.IMailStore"/> is not connected.
  39876. </exception>
  39877. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  39878. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  39879. </exception>
  39880. <exception cref="T:System.InvalidOperationException">
  39881. The folder cannot be deleted (it is either a namespace or the Inbox).
  39882. </exception>
  39883. <exception cref="T:MailKit.FolderNotFoundException">
  39884. The <see cref="T:MailKit.MailFolder"/> does not exist.
  39885. </exception>
  39886. <exception cref="T:System.OperationCanceledException">
  39887. The operation was canceled via the cancellation token.
  39888. </exception>
  39889. <exception cref="T:System.IO.IOException">
  39890. An I/O error occurred.
  39891. </exception>
  39892. <exception cref="T:MailKit.ProtocolException">
  39893. The server's response contained unexpected tokens.
  39894. </exception>
  39895. <exception cref="T:MailKit.CommandException">
  39896. The command failed.
  39897. </exception>
  39898. </member>
  39899. <member name="M:MailKit.MailFolder.Subscribe(System.Threading.CancellationToken)">
  39900. <summary>
  39901. Subscribe to the folder.
  39902. </summary>
  39903. <remarks>
  39904. Subscribes to the folder.
  39905. </remarks>
  39906. <param name="cancellationToken">The cancellation token.</param>
  39907. <exception cref="T:System.ObjectDisposedException">
  39908. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  39909. </exception>
  39910. <exception cref="T:MailKit.ServiceNotConnectedException">
  39911. The <see cref="T:MailKit.IMailStore"/> is not connected.
  39912. </exception>
  39913. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  39914. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  39915. </exception>
  39916. <exception cref="T:System.OperationCanceledException">
  39917. The operation was canceled via the cancellation token.
  39918. </exception>
  39919. <exception cref="T:System.IO.IOException">
  39920. An I/O error occurred.
  39921. </exception>
  39922. <exception cref="T:MailKit.ProtocolException">
  39923. The server's response contained unexpected tokens.
  39924. </exception>
  39925. <exception cref="T:MailKit.CommandException">
  39926. The command failed.
  39927. </exception>
  39928. </member>
  39929. <member name="M:MailKit.MailFolder.SubscribeAsync(System.Threading.CancellationToken)">
  39930. <summary>
  39931. Asynchronously subscribe to the folder.
  39932. </summary>
  39933. <remarks>
  39934. Asynchronously subscribes to the folder.
  39935. </remarks>
  39936. <returns>An asynchronous task context.</returns>
  39937. <param name="cancellationToken">The cancellation token.</param>
  39938. <exception cref="T:System.ObjectDisposedException">
  39939. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  39940. </exception>
  39941. <exception cref="T:MailKit.ServiceNotConnectedException">
  39942. The <see cref="T:MailKit.IMailStore"/> is not connected.
  39943. </exception>
  39944. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  39945. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  39946. </exception>
  39947. <exception cref="T:System.OperationCanceledException">
  39948. The operation was canceled via the cancellation token.
  39949. </exception>
  39950. <exception cref="T:System.IO.IOException">
  39951. An I/O error occurred.
  39952. </exception>
  39953. <exception cref="T:MailKit.ProtocolException">
  39954. The server's response contained unexpected tokens.
  39955. </exception>
  39956. <exception cref="T:MailKit.CommandException">
  39957. The command failed.
  39958. </exception>
  39959. </member>
  39960. <member name="M:MailKit.MailFolder.Unsubscribe(System.Threading.CancellationToken)">
  39961. <summary>
  39962. Unsubscribe from the folder.
  39963. </summary>
  39964. <remarks>
  39965. Unsubscribes from the folder.
  39966. </remarks>
  39967. <param name="cancellationToken">The cancellation token.</param>
  39968. <exception cref="T:System.ObjectDisposedException">
  39969. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  39970. </exception>
  39971. <exception cref="T:MailKit.ServiceNotConnectedException">
  39972. The <see cref="T:MailKit.IMailStore"/> is not connected.
  39973. </exception>
  39974. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  39975. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  39976. </exception>
  39977. <exception cref="T:System.OperationCanceledException">
  39978. The operation was canceled via the cancellation token.
  39979. </exception>
  39980. <exception cref="T:System.IO.IOException">
  39981. An I/O error occurred.
  39982. </exception>
  39983. <exception cref="T:MailKit.ProtocolException">
  39984. The server's response contained unexpected tokens.
  39985. </exception>
  39986. <exception cref="T:MailKit.CommandException">
  39987. The command failed.
  39988. </exception>
  39989. </member>
  39990. <member name="M:MailKit.MailFolder.UnsubscribeAsync(System.Threading.CancellationToken)">
  39991. <summary>
  39992. Asynchronously unsubscribe from the folder.
  39993. </summary>
  39994. <remarks>
  39995. Asynchronously unsubscribes from the folder.
  39996. </remarks>
  39997. <returns>An asynchronous task context.</returns>
  39998. <param name="cancellationToken">The cancellation token.</param>
  39999. <exception cref="T:System.ObjectDisposedException">
  40000. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  40001. </exception>
  40002. <exception cref="T:MailKit.ServiceNotConnectedException">
  40003. The <see cref="T:MailKit.IMailStore"/> is not connected.
  40004. </exception>
  40005. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  40006. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  40007. </exception>
  40008. <exception cref="T:System.OperationCanceledException">
  40009. The operation was canceled via the cancellation token.
  40010. </exception>
  40011. <exception cref="T:System.IO.IOException">
  40012. An I/O error occurred.
  40013. </exception>
  40014. <exception cref="T:MailKit.ProtocolException">
  40015. The server's response contained unexpected tokens.
  40016. </exception>
  40017. <exception cref="T:MailKit.CommandException">
  40018. The command failed.
  40019. </exception>
  40020. </member>
  40021. <member name="M:MailKit.MailFolder.GetSubfolders(MailKit.StatusItems,System.Boolean,System.Threading.CancellationToken)">
  40022. <summary>
  40023. Get the subfolders.
  40024. </summary>
  40025. <remarks>
  40026. <para>Gets the subfolders as well as queries the server for the status of the requested items.</para>
  40027. <para>When the <paramref name="items"/> argument is non-empty, this has the equivalent functionality
  40028. of calling <see cref="M:MailKit.MailFolder.GetSubfolders(System.Boolean,System.Threading.CancellationToken)"/> and then calling
  40029. <see cref="M:MailKit.MailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/> on each of the returned folders.</para>
  40030. </remarks>
  40031. <returns>The subfolders.</returns>
  40032. <param name="items">The status items to pre-populate.</param>
  40033. <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
  40034. <param name="cancellationToken">The cancellation token.</param>
  40035. <exception cref="T:System.ObjectDisposedException">
  40036. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  40037. </exception>
  40038. <exception cref="T:MailKit.ServiceNotConnectedException">
  40039. The <see cref="T:MailKit.IMailStore"/> is not connected.
  40040. </exception>
  40041. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  40042. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  40043. </exception>
  40044. <exception cref="T:System.OperationCanceledException">
  40045. The operation was canceled via the cancellation token.
  40046. </exception>
  40047. <exception cref="T:System.IO.IOException">
  40048. An I/O error occurred.
  40049. </exception>
  40050. <exception cref="T:MailKit.ProtocolException">
  40051. The server's response contained unexpected tokens.
  40052. </exception>
  40053. <exception cref="T:MailKit.CommandException">
  40054. The command failed.
  40055. </exception>
  40056. </member>
  40057. <member name="M:MailKit.MailFolder.GetSubfoldersAsync(MailKit.StatusItems,System.Boolean,System.Threading.CancellationToken)">
  40058. <summary>
  40059. Asynchronously get the subfolders.
  40060. </summary>
  40061. <remarks>
  40062. <para>Asynchronously gets the subfolders as well as queries the server for the status of the requested items.</para>
  40063. <para>When the <paramref name="items"/> argument is non-empty, this has the equivalent functionality
  40064. of calling <see cref="M:MailKit.MailFolder.GetSubfoldersAsync(System.Boolean,System.Threading.CancellationToken)"/> and then calling
  40065. <see cref="M:MailKit.MailFolder.StatusAsync(MailKit.StatusItems,System.Threading.CancellationToken)"/> on each of the returned folders.</para>
  40066. </remarks>
  40067. <returns>The subfolders.</returns>
  40068. <param name="items">The status items to pre-populate.</param>
  40069. <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
  40070. <param name="cancellationToken">The cancellation token.</param>
  40071. <exception cref="T:System.ObjectDisposedException">
  40072. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  40073. </exception>
  40074. <exception cref="T:MailKit.ServiceNotConnectedException">
  40075. The <see cref="T:MailKit.IMailStore"/> is not connected.
  40076. </exception>
  40077. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  40078. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  40079. </exception>
  40080. <exception cref="T:System.OperationCanceledException">
  40081. The operation was canceled via the cancellation token.
  40082. </exception>
  40083. <exception cref="T:System.IO.IOException">
  40084. An I/O error occurred.
  40085. </exception>
  40086. <exception cref="T:MailKit.ProtocolException">
  40087. The server's response contained unexpected tokens.
  40088. </exception>
  40089. <exception cref="T:MailKit.CommandException">
  40090. The command failed.
  40091. </exception>
  40092. </member>
  40093. <member name="M:MailKit.MailFolder.GetSubfolders(System.Boolean,System.Threading.CancellationToken)">
  40094. <summary>
  40095. Get the subfolders.
  40096. </summary>
  40097. <remarks>
  40098. Gets the subfolders.
  40099. </remarks>
  40100. <returns>The subfolders.</returns>
  40101. <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
  40102. <param name="cancellationToken">The cancellation token.</param>
  40103. <exception cref="T:System.ObjectDisposedException">
  40104. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  40105. </exception>
  40106. <exception cref="T:MailKit.ServiceNotConnectedException">
  40107. The <see cref="T:MailKit.IMailStore"/> is not connected.
  40108. </exception>
  40109. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  40110. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  40111. </exception>
  40112. <exception cref="T:System.OperationCanceledException">
  40113. The operation was canceled via the cancellation token.
  40114. </exception>
  40115. <exception cref="T:System.IO.IOException">
  40116. An I/O error occurred.
  40117. </exception>
  40118. <exception cref="T:MailKit.ProtocolException">
  40119. The server's response contained unexpected tokens.
  40120. </exception>
  40121. <exception cref="T:MailKit.CommandException">
  40122. The command failed.
  40123. </exception>
  40124. </member>
  40125. <member name="M:MailKit.MailFolder.GetSubfoldersAsync(System.Boolean,System.Threading.CancellationToken)">
  40126. <summary>
  40127. Asynchronously get the subfolders.
  40128. </summary>
  40129. <remarks>
  40130. Asynchronously gets the subfolders.
  40131. </remarks>
  40132. <returns>The subfolders.</returns>
  40133. <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
  40134. <param name="cancellationToken">The cancellation token.</param>
  40135. <exception cref="T:System.ObjectDisposedException">
  40136. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  40137. </exception>
  40138. <exception cref="T:MailKit.ServiceNotConnectedException">
  40139. The <see cref="T:MailKit.IMailStore"/> is not connected.
  40140. </exception>
  40141. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  40142. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  40143. </exception>
  40144. <exception cref="T:System.OperationCanceledException">
  40145. The operation was canceled via the cancellation token.
  40146. </exception>
  40147. <exception cref="T:System.IO.IOException">
  40148. An I/O error occurred.
  40149. </exception>
  40150. <exception cref="T:MailKit.ProtocolException">
  40151. The server's response contained unexpected tokens.
  40152. </exception>
  40153. <exception cref="T:MailKit.CommandException">
  40154. The command failed.
  40155. </exception>
  40156. </member>
  40157. <member name="M:MailKit.MailFolder.GetSubfolder(System.String,System.Threading.CancellationToken)">
  40158. <summary>
  40159. Get the specified subfolder.
  40160. </summary>
  40161. <remarks>
  40162. Gets the specified subfolder.
  40163. </remarks>
  40164. <returns>The subfolder.</returns>
  40165. <param name="name">The name of the subfolder.</param>
  40166. <param name="cancellationToken">The cancellation token.</param>
  40167. <exception cref="T:System.ArgumentNullException">
  40168. <paramref name="name"/> is <c>null</c>.
  40169. </exception>
  40170. <exception cref="T:System.ArgumentException">
  40171. <paramref name="name"/> is either an empty string or contains the <see cref="P:MailKit.MailFolder.DirectorySeparator"/>.
  40172. </exception>
  40173. <exception cref="T:System.ObjectDisposedException">
  40174. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  40175. </exception>
  40176. <exception cref="T:MailKit.ServiceNotConnectedException">
  40177. The <see cref="T:MailKit.IMailStore"/> is not connected.
  40178. </exception>
  40179. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  40180. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  40181. </exception>
  40182. <exception cref="T:System.OperationCanceledException">
  40183. The operation was canceled via the cancellation token.
  40184. </exception>
  40185. <exception cref="T:System.IO.IOException">
  40186. An I/O error occurred.
  40187. </exception>
  40188. <exception cref="T:MailKit.FolderNotFoundException">
  40189. The requested folder could not be found.
  40190. </exception>
  40191. <exception cref="T:MailKit.ProtocolException">
  40192. The server's response contained unexpected tokens.
  40193. </exception>
  40194. <exception cref="T:MailKit.CommandException">
  40195. The command failed.
  40196. </exception>
  40197. </member>
  40198. <member name="M:MailKit.MailFolder.GetSubfolderAsync(System.String,System.Threading.CancellationToken)">
  40199. <summary>
  40200. Asynchronously get the specified subfolder.
  40201. </summary>
  40202. <remarks>
  40203. Asynchronously gets the specified subfolder.
  40204. </remarks>
  40205. <returns>The subfolder.</returns>
  40206. <param name="name">The name of the subfolder.</param>
  40207. <param name="cancellationToken">The cancellation token.</param>
  40208. <exception cref="T:System.ArgumentNullException">
  40209. <paramref name="name"/> is <c>null</c>.
  40210. </exception>
  40211. <exception cref="T:System.ArgumentException">
  40212. <paramref name="name"/> is either an empty string or contains the <see cref="P:MailKit.MailFolder.DirectorySeparator"/>.
  40213. </exception>
  40214. <exception cref="T:System.ObjectDisposedException">
  40215. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  40216. </exception>
  40217. <exception cref="T:MailKit.ServiceNotConnectedException">
  40218. The <see cref="T:MailKit.IMailStore"/> is not connected.
  40219. </exception>
  40220. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  40221. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  40222. </exception>
  40223. <exception cref="T:System.OperationCanceledException">
  40224. The operation was canceled via the cancellation token.
  40225. </exception>
  40226. <exception cref="T:System.IO.IOException">
  40227. An I/O error occurred.
  40228. </exception>
  40229. <exception cref="T:MailKit.FolderNotFoundException">
  40230. The requested folder could not be found.
  40231. </exception>
  40232. <exception cref="T:MailKit.ProtocolException">
  40233. The server's response contained unexpected tokens.
  40234. </exception>
  40235. <exception cref="T:MailKit.CommandException">
  40236. The command failed.
  40237. </exception>
  40238. </member>
  40239. <member name="M:MailKit.MailFolder.Check(System.Threading.CancellationToken)">
  40240. <summary>
  40241. Force the server to flush its state for the folder.
  40242. </summary>
  40243. <remarks>
  40244. Forces the server to flush its state for the folder.
  40245. </remarks>
  40246. <param name="cancellationToken">The cancellation token.</param>
  40247. <exception cref="T:System.ObjectDisposedException">
  40248. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  40249. </exception>
  40250. <exception cref="T:MailKit.ServiceNotConnectedException">
  40251. The <see cref="T:MailKit.IMailStore"/> is not connected.
  40252. </exception>
  40253. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  40254. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  40255. </exception>
  40256. <exception cref="T:MailKit.FolderNotOpenException">
  40257. The folder is not currently open.
  40258. </exception>
  40259. <exception cref="T:System.OperationCanceledException">
  40260. The operation was canceled via the cancellation token.
  40261. </exception>
  40262. <exception cref="T:System.IO.IOException">
  40263. An I/O error occurred.
  40264. </exception>
  40265. <exception cref="T:MailKit.ProtocolException">
  40266. The server's response contained unexpected tokens.
  40267. </exception>
  40268. <exception cref="T:MailKit.CommandException">
  40269. The command failed.
  40270. </exception>
  40271. </member>
  40272. <member name="M:MailKit.MailFolder.CheckAsync(System.Threading.CancellationToken)">
  40273. <summary>
  40274. Asynchronously force the server to flush its state for the folder.
  40275. </summary>
  40276. <remarks>
  40277. Asynchronously forces the server to flush its state for the folder.
  40278. </remarks>
  40279. <returns>An asynchronous task context.</returns>
  40280. <param name="cancellationToken">The cancellation token.</param>
  40281. <exception cref="T:System.ObjectDisposedException">
  40282. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  40283. </exception>
  40284. <exception cref="T:MailKit.ServiceNotConnectedException">
  40285. The <see cref="T:MailKit.IMailStore"/> is not connected.
  40286. </exception>
  40287. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  40288. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  40289. </exception>
  40290. <exception cref="T:MailKit.FolderNotOpenException">
  40291. The folder is not currently open.
  40292. </exception>
  40293. <exception cref="T:System.OperationCanceledException">
  40294. The operation was canceled via the cancellation token.
  40295. </exception>
  40296. <exception cref="T:System.IO.IOException">
  40297. An I/O error occurred.
  40298. </exception>
  40299. <exception cref="T:MailKit.ProtocolException">
  40300. The server's response contained unexpected tokens.
  40301. </exception>
  40302. <exception cref="T:MailKit.CommandException">
  40303. The command failed.
  40304. </exception>
  40305. </member>
  40306. <member name="M:MailKit.MailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)">
  40307. <summary>
  40308. Update the values of the specified items.
  40309. </summary>
  40310. <remarks>
  40311. <para>Updates the values of the specified items.</para>
  40312. <para>The <see cref="M:MailKit.MailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/> method
  40313. MUST NOT be used on a folder that is already in the opened state. Instead, other ways
  40314. of getting the desired information should be used.</para>
  40315. <para>For example, a common use for the <see cref="M:MailKit.MailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/>
  40316. method is to get the number of unread messages in the folder. When the folder is open, however, it is
  40317. possible to use the <see cref="M:MailKit.MailFolder.Search(MailKit.Search.SearchQuery,System.Threading.CancellationToken)"/>
  40318. method to query for the list of unread messages.</para>
  40319. </remarks>
  40320. <param name="items">The items to update.</param>
  40321. <param name="cancellationToken">The cancellation token.</param>
  40322. <exception cref="T:System.ObjectDisposedException">
  40323. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  40324. </exception>
  40325. <exception cref="T:MailKit.ServiceNotConnectedException">
  40326. The <see cref="T:MailKit.IMailStore"/> is not connected.
  40327. </exception>
  40328. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  40329. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  40330. </exception>
  40331. <exception cref="T:MailKit.FolderNotFoundException">
  40332. The <see cref="T:MailKit.MailFolder"/> does not exist.
  40333. </exception>
  40334. <exception cref="T:System.NotSupportedException">
  40335. The mail store does not support the STATUS command.
  40336. </exception>
  40337. <exception cref="T:System.OperationCanceledException">
  40338. The operation was canceled via the cancellation token.
  40339. </exception>
  40340. <exception cref="T:System.IO.IOException">
  40341. An I/O error occurred.
  40342. </exception>
  40343. <exception cref="T:MailKit.ProtocolException">
  40344. The server's response contained unexpected tokens.
  40345. </exception>
  40346. <exception cref="T:MailKit.CommandException">
  40347. The command failed.
  40348. </exception>
  40349. </member>
  40350. <member name="M:MailKit.MailFolder.StatusAsync(MailKit.StatusItems,System.Threading.CancellationToken)">
  40351. <summary>
  40352. Asynchronously update the values of the specified items.
  40353. </summary>
  40354. <remarks>
  40355. <para>Updates the values of the specified items.</para>
  40356. <para>The <see cref="M:MailKit.MailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/> method
  40357. MUST NOT be used on a folder that is already in the opened state. Instead, other ways
  40358. of getting the desired information should be used.</para>
  40359. <para>For example, a common use for the <see cref="M:MailKit.MailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/>
  40360. method is to get the number of unread messages in the folder. When the folder is open, however, it is
  40361. possible to use the <see cref="M:MailKit.MailFolder.Search(MailKit.Search.SearchQuery,System.Threading.CancellationToken)"/>
  40362. method to query for the list of unread messages.</para>
  40363. </remarks>
  40364. <returns>An asynchronous task context.</returns>
  40365. <param name="items">The items to update.</param>
  40366. <param name="cancellationToken">The cancellation token.</param>
  40367. <exception cref="T:System.ObjectDisposedException">
  40368. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  40369. </exception>
  40370. <exception cref="T:MailKit.ServiceNotConnectedException">
  40371. The <see cref="T:MailKit.IMailStore"/> is not connected.
  40372. </exception>
  40373. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  40374. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  40375. </exception>
  40376. <exception cref="T:System.NotSupportedException">
  40377. The mail store does not support the STATUS command.
  40378. </exception>
  40379. <exception cref="T:System.OperationCanceledException">
  40380. The operation was canceled via the cancellation token.
  40381. </exception>
  40382. <exception cref="T:System.IO.IOException">
  40383. An I/O error occurred.
  40384. </exception>
  40385. <exception cref="T:MailKit.ProtocolException">
  40386. The server's response contained unexpected tokens.
  40387. </exception>
  40388. <exception cref="T:MailKit.CommandException">
  40389. The command failed.
  40390. </exception>
  40391. </member>
  40392. <member name="M:MailKit.MailFolder.GetAccessControlList(System.Threading.CancellationToken)">
  40393. <summary>
  40394. Get the complete access control list for the folder.
  40395. </summary>
  40396. <remarks>
  40397. Gets the complete access control list for the folder.
  40398. </remarks>
  40399. <returns>The access control list.</returns>
  40400. <param name="cancellationToken">The cancellation token.</param>
  40401. <exception cref="T:System.ObjectDisposedException">
  40402. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  40403. </exception>
  40404. <exception cref="T:MailKit.ServiceNotConnectedException">
  40405. The <see cref="T:MailKit.IMailStore"/> is not connected.
  40406. </exception>
  40407. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  40408. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  40409. </exception>
  40410. <exception cref="T:System.NotSupportedException">
  40411. The mail store does not support the ACL extension.
  40412. </exception>
  40413. <exception cref="T:System.OperationCanceledException">
  40414. The operation was canceled via the cancellation token.
  40415. </exception>
  40416. <exception cref="T:System.IO.IOException">
  40417. An I/O error occurred.
  40418. </exception>
  40419. <exception cref="T:MailKit.ProtocolException">
  40420. The server's response contained unexpected tokens.
  40421. </exception>
  40422. <exception cref="T:MailKit.CommandException">
  40423. The command failed.
  40424. </exception>
  40425. </member>
  40426. <member name="M:MailKit.MailFolder.GetAccessControlListAsync(System.Threading.CancellationToken)">
  40427. <summary>
  40428. Asynchronously get the complete access control list for the folder.
  40429. </summary>
  40430. <remarks>
  40431. Asynchronously gets the complete access control list for the folder.
  40432. </remarks>
  40433. <returns>The access control list.</returns>
  40434. <param name="cancellationToken">The cancellation token.</param>
  40435. <exception cref="T:System.ObjectDisposedException">
  40436. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  40437. </exception>
  40438. <exception cref="T:MailKit.ServiceNotConnectedException">
  40439. The <see cref="T:MailKit.IMailStore"/> is not connected.
  40440. </exception>
  40441. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  40442. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  40443. </exception>
  40444. <exception cref="T:System.NotSupportedException">
  40445. The mail store does not support the ACL extension.
  40446. </exception>
  40447. <exception cref="T:System.OperationCanceledException">
  40448. The operation was canceled via the cancellation token.
  40449. </exception>
  40450. <exception cref="T:System.IO.IOException">
  40451. An I/O error occurred.
  40452. </exception>
  40453. <exception cref="T:MailKit.ProtocolException">
  40454. The server's response contained unexpected tokens.
  40455. </exception>
  40456. <exception cref="T:MailKit.CommandException">
  40457. The command failed.
  40458. </exception>
  40459. </member>
  40460. <member name="M:MailKit.MailFolder.GetAccessRights(System.String,System.Threading.CancellationToken)">
  40461. <summary>
  40462. Get the access rights for a particular identifier.
  40463. </summary>
  40464. <remarks>
  40465. Gets the access rights for a particular identifier.
  40466. </remarks>
  40467. <returns>The access rights.</returns>
  40468. <param name="name">The identifier name.</param>
  40469. <param name="cancellationToken">The cancellation token.</param>
  40470. <exception cref="T:System.ArgumentNullException">
  40471. <paramref name="name"/> is <c>null</c>.
  40472. </exception>
  40473. <exception cref="T:System.ObjectDisposedException">
  40474. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  40475. </exception>
  40476. <exception cref="T:MailKit.ServiceNotConnectedException">
  40477. The <see cref="T:MailKit.IMailStore"/> is not connected.
  40478. </exception>
  40479. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  40480. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  40481. </exception>
  40482. <exception cref="T:System.NotSupportedException">
  40483. The mail store does not support the ACL extension.
  40484. </exception>
  40485. <exception cref="T:System.OperationCanceledException">
  40486. The operation was canceled via the cancellation token.
  40487. </exception>
  40488. <exception cref="T:System.IO.IOException">
  40489. An I/O error occurred.
  40490. </exception>
  40491. <exception cref="T:MailKit.ProtocolException">
  40492. The server's response contained unexpected tokens.
  40493. </exception>
  40494. <exception cref="T:MailKit.CommandException">
  40495. The command failed.
  40496. </exception>
  40497. </member>
  40498. <member name="M:MailKit.MailFolder.GetAccessRightsAsync(System.String,System.Threading.CancellationToken)">
  40499. <summary>
  40500. Asynchronously get the access rights for a particular identifier.
  40501. </summary>
  40502. <remarks>
  40503. Asynchronously gets the access rights for a particular identifier.
  40504. </remarks>
  40505. <returns>The access rights.</returns>
  40506. <param name="name">The identifier name.</param>
  40507. <param name="cancellationToken">The cancellation token.</param>
  40508. <exception cref="T:System.ArgumentNullException">
  40509. <paramref name="name"/> is <c>null</c>.
  40510. </exception>
  40511. <exception cref="T:System.ObjectDisposedException">
  40512. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  40513. </exception>
  40514. <exception cref="T:MailKit.ServiceNotConnectedException">
  40515. The <see cref="T:MailKit.IMailStore"/> is not connected.
  40516. </exception>
  40517. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  40518. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  40519. </exception>
  40520. <exception cref="T:System.NotSupportedException">
  40521. The mail store does not support the ACL extension.
  40522. </exception>
  40523. <exception cref="T:System.OperationCanceledException">
  40524. The operation was canceled via the cancellation token.
  40525. </exception>
  40526. <exception cref="T:System.IO.IOException">
  40527. An I/O error occurred.
  40528. </exception>
  40529. <exception cref="T:MailKit.ProtocolException">
  40530. The server's response contained unexpected tokens.
  40531. </exception>
  40532. <exception cref="T:MailKit.CommandException">
  40533. The command failed.
  40534. </exception>
  40535. </member>
  40536. <member name="M:MailKit.MailFolder.GetMyAccessRights(System.Threading.CancellationToken)">
  40537. <summary>
  40538. Get the access rights for the current authenticated user.
  40539. </summary>
  40540. <remarks>
  40541. Gets the access rights for the current authenticated user.
  40542. </remarks>
  40543. <returns>The access rights.</returns>
  40544. <param name="cancellationToken">The cancellation token.</param>
  40545. <exception cref="T:System.ObjectDisposedException">
  40546. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  40547. </exception>
  40548. <exception cref="T:MailKit.ServiceNotConnectedException">
  40549. The <see cref="T:MailKit.IMailStore"/> is not connected.
  40550. </exception>
  40551. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  40552. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  40553. </exception>
  40554. <exception cref="T:System.NotSupportedException">
  40555. The mail store does not support the ACL extension.
  40556. </exception>
  40557. <exception cref="T:System.OperationCanceledException">
  40558. The operation was canceled via the cancellation token.
  40559. </exception>
  40560. <exception cref="T:System.IO.IOException">
  40561. An I/O error occurred.
  40562. </exception>
  40563. <exception cref="T:MailKit.ProtocolException">
  40564. The server's response contained unexpected tokens.
  40565. </exception>
  40566. <exception cref="T:MailKit.CommandException">
  40567. The command failed.
  40568. </exception>
  40569. </member>
  40570. <member name="M:MailKit.MailFolder.GetMyAccessRightsAsync(System.Threading.CancellationToken)">
  40571. <summary>
  40572. Asynchronously get the access rights for the current authenticated user.
  40573. </summary>
  40574. <remarks>
  40575. Asynchronously gets the access rights for the current authenticated user.
  40576. </remarks>
  40577. <returns>The access rights.</returns>
  40578. <param name="cancellationToken">The cancellation token.</param>
  40579. <exception cref="T:System.ObjectDisposedException">
  40580. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  40581. </exception>
  40582. <exception cref="T:MailKit.ServiceNotConnectedException">
  40583. The <see cref="T:MailKit.IMailStore"/> is not connected.
  40584. </exception>
  40585. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  40586. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  40587. </exception>
  40588. <exception cref="T:System.NotSupportedException">
  40589. The mail store does not support the ACL extension.
  40590. </exception>
  40591. <exception cref="T:System.OperationCanceledException">
  40592. The operation was canceled via the cancellation token.
  40593. </exception>
  40594. <exception cref="T:System.IO.IOException">
  40595. An I/O error occurred.
  40596. </exception>
  40597. <exception cref="T:MailKit.ProtocolException">
  40598. The server's response contained unexpected tokens.
  40599. </exception>
  40600. <exception cref="T:MailKit.CommandException">
  40601. The command failed.
  40602. </exception>
  40603. </member>
  40604. <member name="M:MailKit.MailFolder.AddAccessRights(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
  40605. <summary>
  40606. Add access rights for the specified identity.
  40607. </summary>
  40608. <remarks>
  40609. Adds the given access rights for the specified identity.
  40610. </remarks>
  40611. <param name="name">The identity name.</param>
  40612. <param name="rights">The access rights.</param>
  40613. <param name="cancellationToken">The cancellation token.</param>
  40614. <exception cref="T:System.ArgumentNullException">
  40615. <para><paramref name="name"/> is <c>null</c>.</para>
  40616. <para>-or-</para>
  40617. <para><paramref name="rights"/> is <c>null</c>.</para>
  40618. </exception>
  40619. <exception cref="T:System.ObjectDisposedException">
  40620. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  40621. </exception>
  40622. <exception cref="T:MailKit.ServiceNotConnectedException">
  40623. The <see cref="T:MailKit.IMailStore"/> is not connected.
  40624. </exception>
  40625. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  40626. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  40627. </exception>
  40628. <exception cref="T:System.NotSupportedException">
  40629. The mail store does not support the ACL extension.
  40630. </exception>
  40631. <exception cref="T:System.OperationCanceledException">
  40632. The operation was canceled via the cancellation token.
  40633. </exception>
  40634. <exception cref="T:System.IO.IOException">
  40635. An I/O error occurred.
  40636. </exception>
  40637. <exception cref="T:MailKit.ProtocolException">
  40638. The server's response contained unexpected tokens.
  40639. </exception>
  40640. <exception cref="T:MailKit.CommandException">
  40641. The command failed.
  40642. </exception>
  40643. </member>
  40644. <member name="M:MailKit.MailFolder.AddAccessRightsAsync(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
  40645. <summary>
  40646. Asynchronously add access rights for the specified identity.
  40647. </summary>
  40648. <remarks>
  40649. Asynchronously adds the given access rights for the specified identity.
  40650. </remarks>
  40651. <returns>An asynchronous task context.</returns>
  40652. <param name="name">The identity name.</param>
  40653. <param name="rights">The access rights.</param>
  40654. <param name="cancellationToken">The cancellation token.</param>
  40655. <exception cref="T:System.ArgumentNullException">
  40656. <para><paramref name="name"/> is <c>null</c>.</para>
  40657. <para>-or-</para>
  40658. <para><paramref name="rights"/> is <c>null</c>.</para>
  40659. </exception>
  40660. <exception cref="T:System.ObjectDisposedException">
  40661. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  40662. </exception>
  40663. <exception cref="T:MailKit.ServiceNotConnectedException">
  40664. The <see cref="T:MailKit.IMailStore"/> is not connected.
  40665. </exception>
  40666. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  40667. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  40668. </exception>
  40669. <exception cref="T:System.NotSupportedException">
  40670. The mail store does not support the ACL extension.
  40671. </exception>
  40672. <exception cref="T:System.OperationCanceledException">
  40673. The operation was canceled via the cancellation token.
  40674. </exception>
  40675. <exception cref="T:System.IO.IOException">
  40676. An I/O error occurred.
  40677. </exception>
  40678. <exception cref="T:MailKit.ProtocolException">
  40679. The server's response contained unexpected tokens.
  40680. </exception>
  40681. <exception cref="T:MailKit.CommandException">
  40682. The command failed.
  40683. </exception>
  40684. </member>
  40685. <member name="M:MailKit.MailFolder.RemoveAccessRights(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
  40686. <summary>
  40687. Remove access rights for the specified identity.
  40688. </summary>
  40689. <remarks>
  40690. Removes the given access rights for the specified identity.
  40691. </remarks>
  40692. <param name="name">The identity name.</param>
  40693. <param name="rights">The access rights.</param>
  40694. <param name="cancellationToken">The cancellation token.</param>
  40695. <exception cref="T:System.ArgumentNullException">
  40696. <para><paramref name="name"/> is <c>null</c>.</para>
  40697. <para>-or-</para>
  40698. <para><paramref name="rights"/> is <c>null</c>.</para>
  40699. </exception>
  40700. <exception cref="T:System.ObjectDisposedException">
  40701. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  40702. </exception>
  40703. <exception cref="T:MailKit.ServiceNotConnectedException">
  40704. The <see cref="T:MailKit.IMailStore"/> is not connected.
  40705. </exception>
  40706. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  40707. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  40708. </exception>
  40709. <exception cref="T:System.NotSupportedException">
  40710. The mail store does not support the ACL extension.
  40711. </exception>
  40712. <exception cref="T:System.OperationCanceledException">
  40713. The operation was canceled via the cancellation token.
  40714. </exception>
  40715. <exception cref="T:System.IO.IOException">
  40716. An I/O error occurred.
  40717. </exception>
  40718. <exception cref="T:MailKit.ProtocolException">
  40719. The server's response contained unexpected tokens.
  40720. </exception>
  40721. <exception cref="T:MailKit.CommandException">
  40722. The command failed.
  40723. </exception>
  40724. </member>
  40725. <member name="M:MailKit.MailFolder.RemoveAccessRightsAsync(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
  40726. <summary>
  40727. Asynchronously remove access rights for the specified identity.
  40728. </summary>
  40729. <remarks>
  40730. Asynchronously removes the given access rights for the specified identity.
  40731. </remarks>
  40732. <returns>An asynchronous task context.</returns>
  40733. <param name="name">The identity name.</param>
  40734. <param name="rights">The access rights.</param>
  40735. <param name="cancellationToken">The cancellation token.</param>
  40736. <exception cref="T:System.ArgumentNullException">
  40737. <para><paramref name="name"/> is <c>null</c>.</para>
  40738. <para>-or-</para>
  40739. <para><paramref name="rights"/> is <c>null</c>.</para>
  40740. </exception>
  40741. <exception cref="T:System.ObjectDisposedException">
  40742. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  40743. </exception>
  40744. <exception cref="T:MailKit.ServiceNotConnectedException">
  40745. The <see cref="T:MailKit.IMailStore"/> is not connected.
  40746. </exception>
  40747. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  40748. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  40749. </exception>
  40750. <exception cref="T:System.NotSupportedException">
  40751. The mail store does not support the ACL extension.
  40752. </exception>
  40753. <exception cref="T:System.OperationCanceledException">
  40754. The operation was canceled via the cancellation token.
  40755. </exception>
  40756. <exception cref="T:System.IO.IOException">
  40757. An I/O error occurred.
  40758. </exception>
  40759. <exception cref="T:MailKit.ProtocolException">
  40760. The server's response contained unexpected tokens.
  40761. </exception>
  40762. <exception cref="T:MailKit.CommandException">
  40763. The command failed.
  40764. </exception>
  40765. </member>
  40766. <member name="M:MailKit.MailFolder.SetAccessRights(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
  40767. <summary>
  40768. Set the access rights for the specified identity.
  40769. </summary>
  40770. <remarks>
  40771. Sets the access rights for the specified identity.
  40772. </remarks>
  40773. <param name="name">The identity name.</param>
  40774. <param name="rights">The access rights.</param>
  40775. <param name="cancellationToken">The cancellation token.</param>
  40776. <exception cref="T:System.ArgumentNullException">
  40777. <para><paramref name="name"/> is <c>null</c>.</para>
  40778. <para>-or-</para>
  40779. <para><paramref name="rights"/> is <c>null</c>.</para>
  40780. </exception>
  40781. <exception cref="T:System.ObjectDisposedException">
  40782. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  40783. </exception>
  40784. <exception cref="T:MailKit.ServiceNotConnectedException">
  40785. The <see cref="T:MailKit.IMailStore"/> is not connected.
  40786. </exception>
  40787. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  40788. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  40789. </exception>
  40790. <exception cref="T:System.NotSupportedException">
  40791. The mail store does not support the ACL extension.
  40792. </exception>
  40793. <exception cref="T:System.OperationCanceledException">
  40794. The operation was canceled via the cancellation token.
  40795. </exception>
  40796. <exception cref="T:System.IO.IOException">
  40797. An I/O error occurred.
  40798. </exception>
  40799. <exception cref="T:MailKit.ProtocolException">
  40800. The server's response contained unexpected tokens.
  40801. </exception>
  40802. <exception cref="T:MailKit.CommandException">
  40803. The command failed.
  40804. </exception>
  40805. </member>
  40806. <member name="M:MailKit.MailFolder.SetAccessRightsAsync(System.String,MailKit.AccessRights,System.Threading.CancellationToken)">
  40807. <summary>
  40808. Asynchronously set the access rights for the specified identity.
  40809. </summary>
  40810. <remarks>
  40811. Asynchronously sets the access rights for the specified identity.
  40812. </remarks>
  40813. <returns>An asynchronous task context.</returns>
  40814. <param name="name">The identity name.</param>
  40815. <param name="rights">The access rights.</param>
  40816. <param name="cancellationToken">The cancellation token.</param>
  40817. <exception cref="T:System.ArgumentNullException">
  40818. <para><paramref name="name"/> is <c>null</c>.</para>
  40819. <para>-or-</para>
  40820. <para><paramref name="rights"/> is <c>null</c>.</para>
  40821. </exception>
  40822. <exception cref="T:System.ObjectDisposedException">
  40823. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  40824. </exception>
  40825. <exception cref="T:MailKit.ServiceNotConnectedException">
  40826. The <see cref="T:MailKit.IMailStore"/> is not connected.
  40827. </exception>
  40828. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  40829. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  40830. </exception>
  40831. <exception cref="T:System.NotSupportedException">
  40832. The mail store does not support the ACL extension.
  40833. </exception>
  40834. <exception cref="T:System.OperationCanceledException">
  40835. The operation was canceled via the cancellation token.
  40836. </exception>
  40837. <exception cref="T:System.IO.IOException">
  40838. An I/O error occurred.
  40839. </exception>
  40840. <exception cref="T:MailKit.ProtocolException">
  40841. The server's response contained unexpected tokens.
  40842. </exception>
  40843. <exception cref="T:MailKit.CommandException">
  40844. The command failed.
  40845. </exception>
  40846. </member>
  40847. <member name="M:MailKit.MailFolder.RemoveAccess(System.String,System.Threading.CancellationToken)">
  40848. <summary>
  40849. Remove all access rights for the given identity.
  40850. </summary>
  40851. <remarks>
  40852. Removes all access rights for the given identity.
  40853. </remarks>
  40854. <param name="name">The identity name.</param>
  40855. <param name="cancellationToken">The cancellation token.</param>
  40856. <exception cref="T:System.ArgumentNullException">
  40857. <paramref name="name"/> is <c>null</c>.
  40858. </exception>
  40859. <exception cref="T:System.ObjectDisposedException">
  40860. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  40861. </exception>
  40862. <exception cref="T:MailKit.ServiceNotConnectedException">
  40863. The <see cref="T:MailKit.IMailStore"/> is not connected.
  40864. </exception>
  40865. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  40866. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  40867. </exception>
  40868. <exception cref="T:System.NotSupportedException">
  40869. The mail store does not support the ACL extension.
  40870. </exception>
  40871. <exception cref="T:System.OperationCanceledException">
  40872. The operation was canceled via the cancellation token.
  40873. </exception>
  40874. <exception cref="T:System.IO.IOException">
  40875. An I/O error occurred.
  40876. </exception>
  40877. <exception cref="T:MailKit.ProtocolException">
  40878. The server's response contained unexpected tokens.
  40879. </exception>
  40880. <exception cref="T:MailKit.CommandException">
  40881. The command failed.
  40882. </exception>
  40883. </member>
  40884. <member name="M:MailKit.MailFolder.RemoveAccessAsync(System.String,System.Threading.CancellationToken)">
  40885. <summary>
  40886. Asynchronously remove all access rights for the given identity.
  40887. </summary>
  40888. <remarks>
  40889. Asynchronously removes all access rights for the given identity.
  40890. </remarks>
  40891. <returns>An asynchronous task context.</returns>
  40892. <param name="name">The identity name.</param>
  40893. <param name="cancellationToken">The cancellation token.</param>
  40894. <exception cref="T:System.ArgumentNullException">
  40895. <paramref name="name"/> is <c>null</c>.
  40896. </exception>
  40897. <exception cref="T:System.ObjectDisposedException">
  40898. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  40899. </exception>
  40900. <exception cref="T:MailKit.ServiceNotConnectedException">
  40901. The <see cref="T:MailKit.IMailStore"/> is not connected.
  40902. </exception>
  40903. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  40904. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  40905. </exception>
  40906. <exception cref="T:System.NotSupportedException">
  40907. The mail store does not support the ACL extension.
  40908. </exception>
  40909. <exception cref="T:System.OperationCanceledException">
  40910. The operation was canceled via the cancellation token.
  40911. </exception>
  40912. <exception cref="T:System.IO.IOException">
  40913. An I/O error occurred.
  40914. </exception>
  40915. <exception cref="T:MailKit.ProtocolException">
  40916. The server's response contained unexpected tokens.
  40917. </exception>
  40918. <exception cref="T:MailKit.CommandException">
  40919. The command failed.
  40920. </exception>
  40921. </member>
  40922. <member name="M:MailKit.MailFolder.GetQuota(System.Threading.CancellationToken)">
  40923. <summary>
  40924. Get the quota information for the folder.
  40925. </summary>
  40926. <remarks>
  40927. <para>Gets the quota information for the folder.</para>
  40928. <para>To determine if a quotas are supported, check the
  40929. <see cref="P:MailKit.IMailStore.SupportsQuotas"/> property.</para>
  40930. </remarks>
  40931. <returns>The folder quota.</returns>
  40932. <param name="cancellationToken">The cancellation token.</param>
  40933. <exception cref="T:System.ObjectDisposedException">
  40934. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  40935. </exception>
  40936. <exception cref="T:MailKit.ServiceNotConnectedException">
  40937. The <see cref="T:MailKit.IMailStore"/> is not connected.
  40938. </exception>
  40939. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  40940. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  40941. </exception>
  40942. <exception cref="T:System.NotSupportedException">
  40943. The mail store does not support quotas.
  40944. </exception>
  40945. <exception cref="T:System.OperationCanceledException">
  40946. The operation was canceled via the cancellation token.
  40947. </exception>
  40948. <exception cref="T:System.IO.IOException">
  40949. An I/O error occurred.
  40950. </exception>
  40951. <exception cref="T:MailKit.ProtocolException">
  40952. The server's response contained unexpected tokens.
  40953. </exception>
  40954. <exception cref="T:MailKit.CommandException">
  40955. The command failed.
  40956. </exception>
  40957. </member>
  40958. <member name="M:MailKit.MailFolder.GetQuotaAsync(System.Threading.CancellationToken)">
  40959. <summary>
  40960. Asynchronously get the quota information for the folder.
  40961. </summary>
  40962. <remarks>
  40963. <para>Asynchronously gets the quota information for the folder.</para>
  40964. <para>To determine if a quotas are supported, check the
  40965. <see cref="P:MailKit.IMailStore.SupportsQuotas"/> property.</para>
  40966. </remarks>
  40967. <returns>The folder quota.</returns>
  40968. <param name="cancellationToken">The cancellation token.</param>
  40969. <exception cref="T:System.ObjectDisposedException">
  40970. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  40971. </exception>
  40972. <exception cref="T:MailKit.ServiceNotConnectedException">
  40973. The <see cref="T:MailKit.IMailStore"/> is not connected.
  40974. </exception>
  40975. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  40976. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  40977. </exception>
  40978. <exception cref="T:System.NotSupportedException">
  40979. The mail store does not support quotas.
  40980. </exception>
  40981. <exception cref="T:System.OperationCanceledException">
  40982. The operation was canceled via the cancellation token.
  40983. </exception>
  40984. <exception cref="T:System.IO.IOException">
  40985. An I/O error occurred.
  40986. </exception>
  40987. <exception cref="T:MailKit.ProtocolException">
  40988. The server's response contained unexpected tokens.
  40989. </exception>
  40990. <exception cref="T:MailKit.CommandException">
  40991. The command failed.
  40992. </exception>
  40993. </member>
  40994. <member name="M:MailKit.MailFolder.SetQuota(System.Nullable{System.UInt32},System.Nullable{System.UInt32},System.Threading.CancellationToken)">
  40995. <summary>
  40996. Set the quota limits for the folder.
  40997. </summary>
  40998. <remarks>
  40999. <para>Sets the quota limits for the folder.</para>
  41000. <para>To determine if a quotas are supported, check the
  41001. <see cref="P:MailKit.IMailStore.SupportsQuotas"/> property.</para>
  41002. </remarks>
  41003. <returns>The updated folder quota.</returns>
  41004. <param name="messageLimit">If not <c>null</c>, sets the maximum number of messages to allow.</param>
  41005. <param name="storageLimit">If not <c>null</c>, sets the maximum storage size (in kilobytes).</param>
  41006. <param name="cancellationToken">The cancellation token.</param>
  41007. <exception cref="T:System.ObjectDisposedException">
  41008. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  41009. </exception>
  41010. <exception cref="T:MailKit.ServiceNotConnectedException">
  41011. The <see cref="T:MailKit.IMailStore"/> is not connected.
  41012. </exception>
  41013. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  41014. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  41015. </exception>
  41016. <exception cref="T:System.NotSupportedException">
  41017. The mail store does not support quotas.
  41018. </exception>
  41019. <exception cref="T:System.OperationCanceledException">
  41020. The operation was canceled via the cancellation token.
  41021. </exception>
  41022. <exception cref="T:System.IO.IOException">
  41023. An I/O error occurred.
  41024. </exception>
  41025. <exception cref="T:MailKit.ProtocolException">
  41026. The server's response contained unexpected tokens.
  41027. </exception>
  41028. <exception cref="T:MailKit.CommandException">
  41029. The command failed.
  41030. </exception>
  41031. </member>
  41032. <member name="M:MailKit.MailFolder.SetQuotaAsync(System.Nullable{System.UInt32},System.Nullable{System.UInt32},System.Threading.CancellationToken)">
  41033. <summary>
  41034. Asynchronously set the quota limits for the folder.
  41035. </summary>
  41036. <remarks>
  41037. <para>Asynchronously sets the quota limits for the folder.</para>
  41038. <para>To determine if a quotas are supported, check the
  41039. <see cref="P:MailKit.IMailStore.SupportsQuotas"/> property.</para>
  41040. </remarks>
  41041. <returns>The updated folder quota.</returns>
  41042. <param name="messageLimit">If not <c>null</c>, sets the maximum number of messages to allow.</param>
  41043. <param name="storageLimit">If not <c>null</c>, sets the maximum storage size (in kilobytes).</param>
  41044. <param name="cancellationToken">The cancellation token.</param>
  41045. <exception cref="T:System.ObjectDisposedException">
  41046. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  41047. </exception>
  41048. <exception cref="T:MailKit.ServiceNotConnectedException">
  41049. The <see cref="T:MailKit.IMailStore"/> is not connected.
  41050. </exception>
  41051. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  41052. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  41053. </exception>
  41054. <exception cref="T:System.NotSupportedException">
  41055. The mail store does not support quotas.
  41056. </exception>
  41057. <exception cref="T:System.OperationCanceledException">
  41058. The operation was canceled via the cancellation token.
  41059. </exception>
  41060. <exception cref="T:System.IO.IOException">
  41061. An I/O error occurred.
  41062. </exception>
  41063. <exception cref="T:MailKit.ProtocolException">
  41064. The server's response contained unexpected tokens.
  41065. </exception>
  41066. <exception cref="T:MailKit.CommandException">
  41067. The command failed.
  41068. </exception>
  41069. </member>
  41070. <member name="M:MailKit.MailFolder.GetMetadata(MailKit.MetadataTag,System.Threading.CancellationToken)">
  41071. <summary>
  41072. Get the specified metadata.
  41073. </summary>
  41074. <remarks>
  41075. Gets the specified metadata.
  41076. </remarks>
  41077. <returns>The requested metadata value.</returns>
  41078. <param name="tag">The metadata tag.</param>
  41079. <param name="cancellationToken">The cancellation token.</param>
  41080. <exception cref="T:System.ObjectDisposedException">
  41081. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  41082. </exception>
  41083. <exception cref="T:MailKit.ServiceNotConnectedException">
  41084. The <see cref="T:MailKit.IMailStore"/> is not connected.
  41085. </exception>
  41086. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  41087. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  41088. </exception>
  41089. <exception cref="T:System.NotSupportedException">
  41090. The folder does not support metadata.
  41091. </exception>
  41092. <exception cref="T:System.OperationCanceledException">
  41093. The operation was canceled via the cancellation token.
  41094. </exception>
  41095. <exception cref="T:System.IO.IOException">
  41096. An I/O error occurred.
  41097. </exception>
  41098. <exception cref="T:MailKit.ProtocolException">
  41099. The server's response contained unexpected tokens.
  41100. </exception>
  41101. <exception cref="T:MailKit.CommandException">
  41102. The command failed.
  41103. </exception>
  41104. </member>
  41105. <member name="M:MailKit.MailFolder.GetMetadataAsync(MailKit.MetadataTag,System.Threading.CancellationToken)">
  41106. <summary>
  41107. Asynchronously gets the specified metadata.
  41108. </summary>
  41109. <remarks>
  41110. Asynchronously gets the specified metadata.
  41111. </remarks>
  41112. <returns>The requested metadata value.</returns>
  41113. <param name="tag">The metadata tag.</param>
  41114. <param name="cancellationToken">The cancellation token.</param>
  41115. <exception cref="T:System.ObjectDisposedException">
  41116. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  41117. </exception>
  41118. <exception cref="T:MailKit.ServiceNotConnectedException">
  41119. The <see cref="T:MailKit.IMailStore"/> is not connected.
  41120. </exception>
  41121. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  41122. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  41123. </exception>
  41124. <exception cref="T:System.NotSupportedException">
  41125. The folder does not support metadata.
  41126. </exception>
  41127. <exception cref="T:System.OperationCanceledException">
  41128. The operation was canceled via the cancellation token.
  41129. </exception>
  41130. <exception cref="T:System.IO.IOException">
  41131. An I/O error occurred.
  41132. </exception>
  41133. <exception cref="T:MailKit.ProtocolException">
  41134. The server's response contained unexpected tokens.
  41135. </exception>
  41136. <exception cref="T:MailKit.CommandException">
  41137. The command failed.
  41138. </exception>
  41139. </member>
  41140. <member name="M:MailKit.MailFolder.GetMetadata(System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
  41141. <summary>
  41142. Get the specified metadata.
  41143. </summary>
  41144. <remarks>
  41145. Gets the specified metadata.
  41146. </remarks>
  41147. <returns>The requested metadata.</returns>
  41148. <param name="tags">The metadata tags.</param>
  41149. <param name="cancellationToken">The cancellation token.</param>
  41150. <exception cref="T:System.ArgumentNullException">
  41151. <paramref name="tags"/> is <c>null</c>.
  41152. </exception>
  41153. <exception cref="T:System.ObjectDisposedException">
  41154. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  41155. </exception>
  41156. <exception cref="T:MailKit.ServiceNotConnectedException">
  41157. The <see cref="T:MailKit.IMailStore"/> is not connected.
  41158. </exception>
  41159. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  41160. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  41161. </exception>
  41162. <exception cref="T:System.NotSupportedException">
  41163. The folder does not support metadata.
  41164. </exception>
  41165. <exception cref="T:System.OperationCanceledException">
  41166. The operation was canceled via the cancellation token.
  41167. </exception>
  41168. <exception cref="T:System.IO.IOException">
  41169. An I/O error occurred.
  41170. </exception>
  41171. <exception cref="T:MailKit.ProtocolException">
  41172. The server's response contained unexpected tokens.
  41173. </exception>
  41174. <exception cref="T:MailKit.CommandException">
  41175. The command failed.
  41176. </exception>
  41177. </member>
  41178. <member name="M:MailKit.MailFolder.GetMetadataAsync(System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
  41179. <summary>
  41180. Asynchronously gets the specified metadata.
  41181. </summary>
  41182. <remarks>
  41183. Asynchronously gets the specified metadata.
  41184. </remarks>
  41185. <returns>The requested metadata.</returns>
  41186. <param name="tags">The metadata tags.</param>
  41187. <param name="cancellationToken">The cancellation token.</param>
  41188. <exception cref="T:System.ArgumentNullException">
  41189. <paramref name="tags"/> is <c>null</c>.
  41190. </exception>
  41191. <exception cref="T:System.ObjectDisposedException">
  41192. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  41193. </exception>
  41194. <exception cref="T:MailKit.ServiceNotConnectedException">
  41195. The <see cref="T:MailKit.IMailStore"/> is not connected.
  41196. </exception>
  41197. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  41198. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  41199. </exception>
  41200. <exception cref="T:System.NotSupportedException">
  41201. The folder does not support metadata.
  41202. </exception>
  41203. <exception cref="T:System.OperationCanceledException">
  41204. The operation was canceled via the cancellation token.
  41205. </exception>
  41206. <exception cref="T:System.IO.IOException">
  41207. An I/O error occurred.
  41208. </exception>
  41209. <exception cref="T:MailKit.ProtocolException">
  41210. The server's response contained unexpected tokens.
  41211. </exception>
  41212. <exception cref="T:MailKit.CommandException">
  41213. The command failed.
  41214. </exception>
  41215. </member>
  41216. <member name="M:MailKit.MailFolder.GetMetadata(MailKit.MetadataOptions,System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
  41217. <summary>
  41218. Get the specified metadata.
  41219. </summary>
  41220. <remarks>
  41221. Gets the specified metadata.
  41222. </remarks>
  41223. <returns>The requested metadata.</returns>
  41224. <param name="options">The metadata options.</param>
  41225. <param name="tags">The metadata tags.</param>
  41226. <param name="cancellationToken">The cancellation token.</param>
  41227. <exception cref="T:System.ArgumentNullException">
  41228. <para><paramref name="options"/> is <c>null</c>.</para>
  41229. <para>-or-</para>
  41230. <para><paramref name="tags"/> is <c>null</c>.</para>
  41231. </exception>
  41232. <exception cref="T:System.ObjectDisposedException">
  41233. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  41234. </exception>
  41235. <exception cref="T:MailKit.ServiceNotConnectedException">
  41236. The <see cref="T:MailKit.IMailStore"/> is not connected.
  41237. </exception>
  41238. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  41239. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  41240. </exception>
  41241. <exception cref="T:System.NotSupportedException">
  41242. The folder does not support metadata.
  41243. </exception>
  41244. <exception cref="T:System.OperationCanceledException">
  41245. The operation was canceled via the cancellation token.
  41246. </exception>
  41247. <exception cref="T:System.IO.IOException">
  41248. An I/O error occurred.
  41249. </exception>
  41250. <exception cref="T:MailKit.ProtocolException">
  41251. The server's response contained unexpected tokens.
  41252. </exception>
  41253. <exception cref="T:MailKit.CommandException">
  41254. The command failed.
  41255. </exception>
  41256. </member>
  41257. <member name="M:MailKit.MailFolder.GetMetadataAsync(MailKit.MetadataOptions,System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
  41258. <summary>
  41259. Asynchronously gets the specified metadata.
  41260. </summary>
  41261. <remarks>
  41262. Asynchronously gets the specified metadata.
  41263. </remarks>
  41264. <returns>The requested metadata.</returns>
  41265. <param name="options">The metadata options.</param>
  41266. <param name="tags">The metadata tags.</param>
  41267. <param name="cancellationToken">The cancellation token.</param>
  41268. <exception cref="T:System.ArgumentNullException">
  41269. <para><paramref name="options"/> is <c>null</c>.</para>
  41270. <para>-or-</para>
  41271. <para><paramref name="tags"/> is <c>null</c>.</para>
  41272. </exception>
  41273. <exception cref="T:System.ObjectDisposedException">
  41274. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  41275. </exception>
  41276. <exception cref="T:MailKit.ServiceNotConnectedException">
  41277. The <see cref="T:MailKit.IMailStore"/> is not connected.
  41278. </exception>
  41279. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  41280. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  41281. </exception>
  41282. <exception cref="T:System.NotSupportedException">
  41283. The folder does not support metadata.
  41284. </exception>
  41285. <exception cref="T:System.OperationCanceledException">
  41286. The operation was canceled via the cancellation token.
  41287. </exception>
  41288. <exception cref="T:System.IO.IOException">
  41289. An I/O error occurred.
  41290. </exception>
  41291. <exception cref="T:MailKit.ProtocolException">
  41292. The server's response contained unexpected tokens.
  41293. </exception>
  41294. <exception cref="T:MailKit.CommandException">
  41295. The command failed.
  41296. </exception>
  41297. </member>
  41298. <member name="M:MailKit.MailFolder.SetMetadata(MailKit.MetadataCollection,System.Threading.CancellationToken)">
  41299. <summary>
  41300. Sets the specified metadata.
  41301. </summary>
  41302. <remarks>
  41303. Sets the specified metadata.
  41304. </remarks>
  41305. <param name="metadata">The metadata.</param>
  41306. <param name="cancellationToken">The cancellation token.</param>
  41307. <exception cref="T:System.ArgumentNullException">
  41308. <paramref name="metadata"/> is <c>null</c>.
  41309. </exception>
  41310. <exception cref="T:System.ObjectDisposedException">
  41311. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  41312. </exception>
  41313. <exception cref="T:MailKit.ServiceNotConnectedException">
  41314. The <see cref="T:MailKit.IMailStore"/> is not connected.
  41315. </exception>
  41316. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  41317. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  41318. </exception>
  41319. <exception cref="T:System.NotSupportedException">
  41320. The folder does not support metadata.
  41321. </exception>
  41322. <exception cref="T:System.OperationCanceledException">
  41323. The operation was canceled via the cancellation token.
  41324. </exception>
  41325. <exception cref="T:System.IO.IOException">
  41326. An I/O error occurred.
  41327. </exception>
  41328. <exception cref="T:MailKit.ProtocolException">
  41329. The server's response contained unexpected tokens.
  41330. </exception>
  41331. <exception cref="T:MailKit.CommandException">
  41332. The command failed.
  41333. </exception>
  41334. </member>
  41335. <member name="M:MailKit.MailFolder.SetMetadataAsync(MailKit.MetadataCollection,System.Threading.CancellationToken)">
  41336. <summary>
  41337. Asynchronously sets the specified metadata.
  41338. </summary>
  41339. <remarks>
  41340. Asynchronously sets the specified metadata.
  41341. </remarks>
  41342. <returns>An asynchronous task context.</returns>
  41343. <param name="metadata">The metadata.</param>
  41344. <param name="cancellationToken">The cancellation token.</param>
  41345. <exception cref="T:System.ArgumentNullException">
  41346. <paramref name="metadata"/> is <c>null</c>.
  41347. </exception>
  41348. <exception cref="T:System.ObjectDisposedException">
  41349. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  41350. </exception>
  41351. <exception cref="T:MailKit.ServiceNotConnectedException">
  41352. The <see cref="T:MailKit.IMailStore"/> is not connected.
  41353. </exception>
  41354. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  41355. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  41356. </exception>
  41357. <exception cref="T:System.NotSupportedException">
  41358. The folder does not support metadata.
  41359. </exception>
  41360. <exception cref="T:System.OperationCanceledException">
  41361. The operation was canceled via the cancellation token.
  41362. </exception>
  41363. <exception cref="T:System.IO.IOException">
  41364. An I/O error occurred.
  41365. </exception>
  41366. <exception cref="T:MailKit.ProtocolException">
  41367. The server's response contained unexpected tokens.
  41368. </exception>
  41369. <exception cref="T:MailKit.CommandException">
  41370. The command failed.
  41371. </exception>
  41372. </member>
  41373. <member name="M:MailKit.MailFolder.Expunge(System.Threading.CancellationToken)">
  41374. <summary>
  41375. Expunge the folder, permanently removing all messages marked for deletion.
  41376. </summary>
  41377. <remarks>
  41378. <para>Expunges the folder, permanently removing all messages marked for deletion.</para>
  41379. <note type="note">Normally, an <see cref="E:MailKit.MailFolder.MessageExpunged"/> event will be emitted for
  41380. each message that is expunged. However, if the mail store supports the quick
  41381. resynchronization feature and it has been enabled via the
  41382. <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/> method, then
  41383. the <see cref="E:MailKit.MailFolder.MessagesVanished"/> event will be emitted rather than the
  41384. <see cref="E:MailKit.MailFolder.MessageExpunged"/> event.</note>
  41385. </remarks>
  41386. <param name="cancellationToken">The cancellation token.</param>
  41387. <exception cref="T:System.ObjectDisposedException">
  41388. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  41389. </exception>
  41390. <exception cref="T:MailKit.ServiceNotConnectedException">
  41391. The <see cref="T:MailKit.IMailStore"/> is not connected.
  41392. </exception>
  41393. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  41394. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  41395. </exception>
  41396. <exception cref="T:MailKit.FolderNotOpenException">
  41397. The folder is not currently open in read-write mode.
  41398. </exception>
  41399. <exception cref="T:System.OperationCanceledException">
  41400. The operation was canceled via the cancellation token.
  41401. </exception>
  41402. <exception cref="T:System.IO.IOException">
  41403. An I/O error occurred.
  41404. </exception>
  41405. <exception cref="T:MailKit.ProtocolException">
  41406. The server's response contained unexpected tokens.
  41407. </exception>
  41408. <exception cref="T:MailKit.CommandException">
  41409. The command failed.
  41410. </exception>
  41411. </member>
  41412. <member name="M:MailKit.MailFolder.ExpungeAsync(System.Threading.CancellationToken)">
  41413. <summary>
  41414. Asynchronously expunge the folder, permanently removing all messages marked for deletion.
  41415. </summary>
  41416. <remarks>
  41417. <para>Asynchronously expunges the folder, permanently removing all messages marked for deletion.</para>
  41418. <note type="note">Normally, an <see cref="E:MailKit.MailFolder.MessageExpunged"/> event will be emitted for
  41419. each message that is expunged. However, if the mail store supports the quick
  41420. resynchronization feature and it has been enabled via the
  41421. <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/> method, then
  41422. the <see cref="E:MailKit.MailFolder.MessagesVanished"/> event will be emitted rather than the
  41423. <see cref="E:MailKit.MailFolder.MessageExpunged"/> event.</note>
  41424. </remarks>
  41425. <returns>An asynchronous task context.</returns>
  41426. <param name="cancellationToken">The cancellation token.</param>
  41427. <exception cref="T:System.ObjectDisposedException">
  41428. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  41429. </exception>
  41430. <exception cref="T:MailKit.ServiceNotConnectedException">
  41431. The <see cref="T:MailKit.IMailStore"/> is not connected.
  41432. </exception>
  41433. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  41434. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  41435. </exception>
  41436. <exception cref="T:MailKit.FolderNotOpenException">
  41437. The folder is not currently open in read-write mode.
  41438. </exception>
  41439. <exception cref="T:System.OperationCanceledException">
  41440. The operation was canceled via the cancellation token.
  41441. </exception>
  41442. <exception cref="T:System.IO.IOException">
  41443. An I/O error occurred.
  41444. </exception>
  41445. <exception cref="T:MailKit.ProtocolException">
  41446. The server's response contained unexpected tokens.
  41447. </exception>
  41448. <exception cref="T:MailKit.CommandException">
  41449. The command failed.
  41450. </exception>
  41451. </member>
  41452. <member name="M:MailKit.MailFolder.Expunge(System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)">
  41453. <summary>
  41454. Expunge the specified uids, permanently removing them from the folder.
  41455. </summary>
  41456. <remarks>
  41457. <para>Expunges the specified uids, permanently removing them from the folder.</para>
  41458. <note type="note">Normally, an <see cref="E:MailKit.MailFolder.MessageExpunged"/> event will be emitted for
  41459. each message that is expunged. However, if the mail store supports the quick
  41460. resynchronization feature and it has been enabled via the
  41461. <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/> method, then
  41462. the <see cref="E:MailKit.MailFolder.MessagesVanished"/> event will be emitted rather than the
  41463. <see cref="E:MailKit.MailFolder.MessageExpunged"/> event.</note>
  41464. </remarks>
  41465. <param name="uids">The message uids.</param>
  41466. <param name="cancellationToken">The cancellation token.</param>
  41467. <exception cref="T:System.ArgumentNullException">
  41468. <paramref name="uids"/> is <c>null</c>.
  41469. </exception>
  41470. <exception cref="T:System.ArgumentException">
  41471. One or more of the <paramref name="uids"/> is invalid.
  41472. </exception>
  41473. <exception cref="T:System.ObjectDisposedException">
  41474. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  41475. </exception>
  41476. <exception cref="T:MailKit.ServiceNotConnectedException">
  41477. The <see cref="T:MailKit.IMailStore"/> is not connected.
  41478. </exception>
  41479. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  41480. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  41481. </exception>
  41482. <exception cref="T:MailKit.FolderNotOpenException">
  41483. The folder is not currently open in read-write mode.
  41484. </exception>
  41485. <exception cref="T:System.OperationCanceledException">
  41486. The operation was canceled via the cancellation token.
  41487. </exception>
  41488. <exception cref="T:System.IO.IOException">
  41489. An I/O error occurred.
  41490. </exception>
  41491. <exception cref="T:MailKit.ProtocolException">
  41492. The server's response contained unexpected tokens.
  41493. </exception>
  41494. <exception cref="T:MailKit.CommandException">
  41495. The command failed.
  41496. </exception>
  41497. </member>
  41498. <member name="M:MailKit.MailFolder.ExpungeAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)">
  41499. <summary>
  41500. Asynchronously expunge the specified uids, permanently removing them from the folder.
  41501. </summary>
  41502. <remarks>
  41503. <para>Asynchronously expunges the specified uids, permanently removing them from the folder.</para>
  41504. <note type="note">Normally, an <see cref="E:MailKit.MailFolder.MessageExpunged"/> event will be emitted for
  41505. each message that is expunged. However, if the mail store supports the quick
  41506. resynchronization feature and it has been enabled via the
  41507. <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/> method, then
  41508. the <see cref="E:MailKit.MailFolder.MessagesVanished"/> event will be emitted rather than the
  41509. <see cref="E:MailKit.MailFolder.MessageExpunged"/> event.</note>
  41510. </remarks>
  41511. <returns>An asynchronous task context.</returns>
  41512. <param name="uids">The message uids.</param>
  41513. <param name="cancellationToken">The cancellation token.</param>
  41514. <exception cref="T:System.ArgumentNullException">
  41515. <paramref name="uids"/> is <c>null</c>.
  41516. </exception>
  41517. <exception cref="T:System.ArgumentException">
  41518. One or more of the <paramref name="uids"/> is invalid.
  41519. </exception>
  41520. <exception cref="T:System.ObjectDisposedException">
  41521. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  41522. </exception>
  41523. <exception cref="T:MailKit.ServiceNotConnectedException">
  41524. The <see cref="T:MailKit.IMailStore"/> is not connected.
  41525. </exception>
  41526. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  41527. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  41528. </exception>
  41529. <exception cref="T:MailKit.FolderNotOpenException">
  41530. The folder is not currently open in read-write mode.
  41531. </exception>
  41532. <exception cref="T:System.OperationCanceledException">
  41533. The operation was canceled via the cancellation token.
  41534. </exception>
  41535. <exception cref="T:System.IO.IOException">
  41536. An I/O error occurred.
  41537. </exception>
  41538. <exception cref="T:MailKit.ProtocolException">
  41539. The server's response contained unexpected tokens.
  41540. </exception>
  41541. <exception cref="T:MailKit.CommandException">
  41542. The command failed.
  41543. </exception>
  41544. </member>
  41545. <member name="M:MailKit.MailFolder.Append(MimeKit.MimeMessage,MailKit.MessageFlags,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  41546. <summary>
  41547. Append the specified message to the folder.
  41548. </summary>
  41549. <remarks>
  41550. Appends the specified message to the folder and returns the UniqueId assigned to the message.
  41551. </remarks>
  41552. <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
  41553. <param name="message">The message.</param>
  41554. <param name="flags">The message flags.</param>
  41555. <param name="cancellationToken">The cancellation token.</param>
  41556. <param name="progress">The progress reporting mechanism.</param>
  41557. <exception cref="T:System.ArgumentNullException">
  41558. <paramref name="message"/> is <c>null</c>.
  41559. </exception>
  41560. <exception cref="T:System.ObjectDisposedException">
  41561. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  41562. </exception>
  41563. <exception cref="T:MailKit.ServiceNotConnectedException">
  41564. The <see cref="T:MailKit.IMailStore"/> is not connected.
  41565. </exception>
  41566. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  41567. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  41568. </exception>
  41569. <exception cref="T:MailKit.FolderNotFoundException">
  41570. The <see cref="T:MailKit.MailFolder"/> does not exist.
  41571. </exception>
  41572. <exception cref="T:System.OperationCanceledException">
  41573. The operation was canceled via the cancellation token.
  41574. </exception>
  41575. <exception cref="T:System.IO.IOException">
  41576. An I/O error occurred.
  41577. </exception>
  41578. <exception cref="T:MailKit.ProtocolException">
  41579. The server's response contained unexpected tokens.
  41580. </exception>
  41581. <exception cref="T:MailKit.CommandException">
  41582. The command failed.
  41583. </exception>
  41584. </member>
  41585. <member name="M:MailKit.MailFolder.AppendAsync(MimeKit.MimeMessage,MailKit.MessageFlags,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  41586. <summary>
  41587. Asynchronously append the specified message to the folder.
  41588. </summary>
  41589. <remarks>
  41590. Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.
  41591. </remarks>
  41592. <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
  41593. <param name="message">The message.</param>
  41594. <param name="flags">The message flags.</param>
  41595. <param name="cancellationToken">The cancellation token.</param>
  41596. <param name="progress">The progress reporting mechanism.</param>
  41597. <exception cref="T:System.ArgumentNullException">
  41598. <paramref name="message"/> is <c>null</c>.
  41599. </exception>
  41600. <exception cref="T:System.ObjectDisposedException">
  41601. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  41602. </exception>
  41603. <exception cref="T:MailKit.ServiceNotConnectedException">
  41604. The <see cref="T:MailKit.IMailStore"/> is not connected.
  41605. </exception>
  41606. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  41607. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  41608. </exception>
  41609. <exception cref="T:MailKit.FolderNotFoundException">
  41610. The <see cref="T:MailKit.MailFolder"/> does not exist.
  41611. </exception>
  41612. <exception cref="T:System.OperationCanceledException">
  41613. The operation was canceled via the cancellation token.
  41614. </exception>
  41615. <exception cref="T:System.IO.IOException">
  41616. An I/O error occurred.
  41617. </exception>
  41618. <exception cref="T:MailKit.ProtocolException">
  41619. The server's response contained unexpected tokens.
  41620. </exception>
  41621. <exception cref="T:MailKit.CommandException">
  41622. The command failed.
  41623. </exception>
  41624. </member>
  41625. <member name="M:MailKit.MailFolder.Append(MimeKit.MimeMessage,MailKit.MessageFlags,System.DateTimeOffset,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  41626. <summary>
  41627. Append the specified message to the folder.
  41628. </summary>
  41629. <remarks>
  41630. Appends the specified message to the folder and returns the UniqueId assigned to the message.
  41631. </remarks>
  41632. <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
  41633. <param name="message">The message.</param>
  41634. <param name="flags">The message flags.</param>
  41635. <param name="date">The received date of the message.</param>
  41636. <param name="cancellationToken">The cancellation token.</param>
  41637. <param name="progress">The progress reporting mechanism.</param>
  41638. <exception cref="T:System.ArgumentNullException">
  41639. <paramref name="message"/> is <c>null</c>.
  41640. </exception>
  41641. <exception cref="T:System.ObjectDisposedException">
  41642. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  41643. </exception>
  41644. <exception cref="T:MailKit.ServiceNotConnectedException">
  41645. The <see cref="T:MailKit.IMailStore"/> is not connected.
  41646. </exception>
  41647. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  41648. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  41649. </exception>
  41650. <exception cref="T:MailKit.FolderNotFoundException">
  41651. The <see cref="T:MailKit.MailFolder"/> does not exist.
  41652. </exception>
  41653. <exception cref="T:System.OperationCanceledException">
  41654. The operation was canceled via the cancellation token.
  41655. </exception>
  41656. <exception cref="T:System.IO.IOException">
  41657. An I/O error occurred.
  41658. </exception>
  41659. <exception cref="T:MailKit.ProtocolException">
  41660. The server's response contained unexpected tokens.
  41661. </exception>
  41662. <exception cref="T:MailKit.CommandException">
  41663. The command failed.
  41664. </exception>
  41665. </member>
  41666. <member name="M:MailKit.MailFolder.AppendAsync(MimeKit.MimeMessage,MailKit.MessageFlags,System.DateTimeOffset,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  41667. <summary>
  41668. Asynchronously append the specified message to the folder.
  41669. </summary>
  41670. <remarks>
  41671. Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.
  41672. </remarks>
  41673. <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
  41674. <param name="message">The message.</param>
  41675. <param name="flags">The message flags.</param>
  41676. <param name="date">The received date of the message.</param>
  41677. <param name="cancellationToken">The cancellation token.</param>
  41678. <param name="progress">The progress reporting mechanism.</param>
  41679. <exception cref="T:System.ArgumentNullException">
  41680. <paramref name="message"/> is <c>null</c>.
  41681. </exception>
  41682. <exception cref="T:System.ObjectDisposedException">
  41683. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  41684. </exception>
  41685. <exception cref="T:MailKit.ServiceNotConnectedException">
  41686. The <see cref="T:MailKit.IMailStore"/> is not connected.
  41687. </exception>
  41688. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  41689. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  41690. </exception>
  41691. <exception cref="T:MailKit.FolderNotFoundException">
  41692. The <see cref="T:MailKit.MailFolder"/> does not exist.
  41693. </exception>
  41694. <exception cref="T:System.OperationCanceledException">
  41695. The operation was canceled via the cancellation token.
  41696. </exception>
  41697. <exception cref="T:System.IO.IOException">
  41698. An I/O error occurred.
  41699. </exception>
  41700. <exception cref="T:MailKit.ProtocolException">
  41701. The server's response contained unexpected tokens.
  41702. </exception>
  41703. <exception cref="T:MailKit.CommandException">
  41704. The command failed.
  41705. </exception>
  41706. </member>
  41707. <member name="M:MailKit.MailFolder.Append(MimeKit.MimeMessage,MailKit.MessageFlags,System.Nullable{System.DateTimeOffset},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  41708. <summary>
  41709. Append the specified message to the folder.
  41710. </summary>
  41711. <remarks>
  41712. Appends the specified message to the folder and returns the UniqueId assigned to the message.
  41713. </remarks>
  41714. <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
  41715. <param name="message">The message.</param>
  41716. <param name="flags">The message flags.</param>
  41717. <param name="date">The received date of the message.</param>
  41718. <param name="annotations">The message annotations.</param>
  41719. <param name="cancellationToken">The cancellation token.</param>
  41720. <param name="progress">The progress reporting mechanism.</param>
  41721. <exception cref="T:System.ArgumentNullException">
  41722. <paramref name="message"/> is <c>null</c>.
  41723. </exception>
  41724. <exception cref="T:System.ObjectDisposedException">
  41725. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  41726. </exception>
  41727. <exception cref="T:MailKit.ServiceNotConnectedException">
  41728. The <see cref="T:MailKit.IMailStore"/> is not connected.
  41729. </exception>
  41730. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  41731. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  41732. </exception>
  41733. <exception cref="T:MailKit.FolderNotFoundException">
  41734. The <see cref="T:MailKit.MailFolder"/> does not exist.
  41735. </exception>
  41736. <exception cref="T:System.InvalidOperationException">
  41737. One or more <paramref name="annotations"/> does not define any properties.
  41738. </exception>"
  41739. <exception cref="T:System.OperationCanceledException">
  41740. The operation was canceled via the cancellation token.
  41741. </exception>
  41742. <exception cref="T:System.IO.IOException">
  41743. An I/O error occurred.
  41744. </exception>
  41745. <exception cref="T:MailKit.ProtocolException">
  41746. The server's response contained unexpected tokens.
  41747. </exception>
  41748. <exception cref="T:MailKit.CommandException">
  41749. The command failed.
  41750. </exception>
  41751. </member>
  41752. <member name="M:MailKit.MailFolder.AppendAsync(MimeKit.MimeMessage,MailKit.MessageFlags,System.Nullable{System.DateTimeOffset},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  41753. <summary>
  41754. Asynchronously append the specified message to the folder.
  41755. </summary>
  41756. <remarks>
  41757. Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.
  41758. </remarks>
  41759. <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
  41760. <param name="message">The message.</param>
  41761. <param name="flags">The message flags.</param>
  41762. <param name="date">The received date of the message.</param>
  41763. <param name="annotations">The message annotations.</param>
  41764. <param name="cancellationToken">The cancellation token.</param>
  41765. <param name="progress">The progress reporting mechanism.</param>
  41766. <exception cref="T:System.ArgumentNullException">
  41767. <paramref name="message"/> is <c>null</c>.
  41768. </exception>
  41769. <exception cref="T:System.ObjectDisposedException">
  41770. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  41771. </exception>
  41772. <exception cref="T:MailKit.ServiceNotConnectedException">
  41773. The <see cref="T:MailKit.IMailStore"/> is not connected.
  41774. </exception>
  41775. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  41776. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  41777. </exception>
  41778. <exception cref="T:MailKit.FolderNotFoundException">
  41779. The <see cref="T:MailKit.MailFolder"/> does not exist.
  41780. </exception>
  41781. <exception cref="T:System.InvalidOperationException">
  41782. One or more <paramref name="annotations"/> does not define any properties.
  41783. </exception>"
  41784. <exception cref="T:System.OperationCanceledException">
  41785. The operation was canceled via the cancellation token.
  41786. </exception>
  41787. <exception cref="T:System.IO.IOException">
  41788. An I/O error occurred.
  41789. </exception>
  41790. <exception cref="T:MailKit.ProtocolException">
  41791. The server's response contained unexpected tokens.
  41792. </exception>
  41793. <exception cref="T:MailKit.CommandException">
  41794. The command failed.
  41795. </exception>
  41796. </member>
  41797. <member name="M:MailKit.MailFolder.Append(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  41798. <summary>
  41799. Append the specified message to the folder.
  41800. </summary>
  41801. <remarks>
  41802. Appends the specified message to the folder and returns the UniqueId assigned to the message.
  41803. </remarks>
  41804. <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
  41805. <param name="options">The formatting options.</param>
  41806. <param name="message">The message.</param>
  41807. <param name="flags">The message flags.</param>
  41808. <param name="cancellationToken">The cancellation token.</param>
  41809. <param name="progress">The progress reporting mechanism.</param>
  41810. <exception cref="T:System.ArgumentNullException">
  41811. <para><paramref name="options"/> is <c>null</c>.</para>
  41812. <para>-or-</para>
  41813. <para><paramref name="message"/> is <c>null</c>.</para>
  41814. </exception>
  41815. <exception cref="T:System.ObjectDisposedException">
  41816. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  41817. </exception>
  41818. <exception cref="T:MailKit.ServiceNotConnectedException">
  41819. The <see cref="T:MailKit.IMailStore"/> is not connected.
  41820. </exception>
  41821. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  41822. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  41823. </exception>
  41824. <exception cref="T:MailKit.FolderNotFoundException">
  41825. The <see cref="T:MailKit.MailFolder"/> does not exist.
  41826. </exception>
  41827. <exception cref="T:System.InvalidOperationException">
  41828. Internationalized formatting was requested but has not been enabled.
  41829. </exception>
  41830. <exception cref="T:System.OperationCanceledException">
  41831. The operation was canceled via the cancellation token.
  41832. </exception>
  41833. <exception cref="T:System.NotSupportedException">
  41834. Internationalized formatting was requested but is not supported by the server.
  41835. </exception>
  41836. <exception cref="T:System.IO.IOException">
  41837. An I/O error occurred.
  41838. </exception>
  41839. <exception cref="T:MailKit.ProtocolException">
  41840. The server's response contained unexpected tokens.
  41841. </exception>
  41842. <exception cref="T:MailKit.CommandException">
  41843. The command failed.
  41844. </exception>
  41845. </member>
  41846. <member name="M:MailKit.MailFolder.AppendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  41847. <summary>
  41848. Asynchronously append the specified message to the folder.
  41849. </summary>
  41850. <remarks>
  41851. Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.
  41852. </remarks>
  41853. <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
  41854. <param name="options">The formatting options.</param>
  41855. <param name="message">The message.</param>
  41856. <param name="flags">The message flags.</param>
  41857. <param name="cancellationToken">The cancellation token.</param>
  41858. <param name="progress">The progress reporting mechanism.</param>
  41859. <exception cref="T:System.ArgumentNullException">
  41860. <para><paramref name="options"/> is <c>null</c>.</para>
  41861. <para>-or-</para>
  41862. <para><paramref name="message"/> is <c>null</c>.</para>
  41863. </exception>
  41864. <exception cref="T:System.ObjectDisposedException">
  41865. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  41866. </exception>
  41867. <exception cref="T:MailKit.ServiceNotConnectedException">
  41868. The <see cref="T:MailKit.IMailStore"/> is not connected.
  41869. </exception>
  41870. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  41871. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  41872. </exception>
  41873. <exception cref="T:MailKit.FolderNotFoundException">
  41874. The <see cref="T:MailKit.MailFolder"/> does not exist.
  41875. </exception>
  41876. <exception cref="T:System.InvalidOperationException">
  41877. Internationalized formatting was requested but has not been enabled.
  41878. </exception>
  41879. <exception cref="T:System.OperationCanceledException">
  41880. The operation was canceled via the cancellation token.
  41881. </exception>
  41882. <exception cref="T:System.NotSupportedException">
  41883. Internationalized formatting was requested but is not supported by the server.
  41884. </exception>
  41885. <exception cref="T:System.IO.IOException">
  41886. An I/O error occurred.
  41887. </exception>
  41888. <exception cref="T:MailKit.ProtocolException">
  41889. The server's response contained unexpected tokens.
  41890. </exception>
  41891. <exception cref="T:MailKit.CommandException">
  41892. The command failed.
  41893. </exception>
  41894. </member>
  41895. <member name="M:MailKit.MailFolder.Append(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.DateTimeOffset,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  41896. <summary>
  41897. Append the specified message to the folder.
  41898. </summary>
  41899. <remarks>
  41900. Appends the specified message to the folder and returns the UniqueId assigned to the message.
  41901. </remarks>
  41902. <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
  41903. <param name="options">The formatting options.</param>
  41904. <param name="message">The message.</param>
  41905. <param name="flags">The message flags.</param>
  41906. <param name="date">The received date of the message.</param>
  41907. <param name="cancellationToken">The cancellation token.</param>
  41908. <param name="progress">The progress reporting mechanism.</param>
  41909. <exception cref="T:System.ArgumentNullException">
  41910. <para><paramref name="options"/> is <c>null</c>.</para>
  41911. <para>-or-</para>
  41912. <para><paramref name="message"/> is <c>null</c>.</para>
  41913. </exception>
  41914. <exception cref="T:System.ObjectDisposedException">
  41915. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  41916. </exception>
  41917. <exception cref="T:MailKit.ServiceNotConnectedException">
  41918. The <see cref="T:MailKit.IMailStore"/> is not connected.
  41919. </exception>
  41920. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  41921. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  41922. </exception>
  41923. <exception cref="T:MailKit.FolderNotFoundException">
  41924. The <see cref="T:MailKit.MailFolder"/> does not exist.
  41925. </exception>
  41926. <exception cref="T:System.InvalidOperationException">
  41927. Internationalized formatting was requested but has not been enabled.
  41928. </exception>
  41929. <exception cref="T:System.OperationCanceledException">
  41930. The operation was canceled via the cancellation token.
  41931. </exception>
  41932. <exception cref="T:System.NotSupportedException">
  41933. Internationalized formatting was requested but is not supported by the server.
  41934. </exception>
  41935. <exception cref="T:System.IO.IOException">
  41936. An I/O error occurred.
  41937. </exception>
  41938. <exception cref="T:MailKit.ProtocolException">
  41939. The server's response contained unexpected tokens.
  41940. </exception>
  41941. <exception cref="T:MailKit.CommandException">
  41942. The command failed.
  41943. </exception>
  41944. </member>
  41945. <member name="M:MailKit.MailFolder.AppendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.DateTimeOffset,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  41946. <summary>
  41947. Asynchronously append the specified message to the folder.
  41948. </summary>
  41949. <remarks>
  41950. Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.
  41951. </remarks>
  41952. <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
  41953. <param name="options">The formatting options.</param>
  41954. <param name="message">The message.</param>
  41955. <param name="flags">The message flags.</param>
  41956. <param name="date">The received date of the message.</param>
  41957. <param name="cancellationToken">The cancellation token.</param>
  41958. <param name="progress">The progress reporting mechanism.</param>
  41959. <exception cref="T:System.ArgumentNullException">
  41960. <para><paramref name="options"/> is <c>null</c>.</para>
  41961. <para>-or-</para>
  41962. <para><paramref name="message"/> is <c>null</c>.</para>
  41963. </exception>
  41964. <exception cref="T:System.ObjectDisposedException">
  41965. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  41966. </exception>
  41967. <exception cref="T:MailKit.ServiceNotConnectedException">
  41968. The <see cref="T:MailKit.IMailStore"/> is not connected.
  41969. </exception>
  41970. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  41971. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  41972. </exception>
  41973. <exception cref="T:MailKit.FolderNotFoundException">
  41974. The <see cref="T:MailKit.MailFolder"/> does not exist.
  41975. </exception>
  41976. <exception cref="T:System.InvalidOperationException">
  41977. Internationalized formatting was requested but has not been enabled.
  41978. </exception>
  41979. <exception cref="T:System.OperationCanceledException">
  41980. The operation was canceled via the cancellation token.
  41981. </exception>
  41982. <exception cref="T:System.NotSupportedException">
  41983. Internationalized formatting was requested but is not supported by the server.
  41984. </exception>
  41985. <exception cref="T:System.IO.IOException">
  41986. An I/O error occurred.
  41987. </exception>
  41988. <exception cref="T:MailKit.ProtocolException">
  41989. The server's response contained unexpected tokens.
  41990. </exception>
  41991. <exception cref="T:MailKit.CommandException">
  41992. The command failed.
  41993. </exception>
  41994. </member>
  41995. <member name="M:MailKit.MailFolder.Append(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.Nullable{System.DateTimeOffset},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  41996. <summary>
  41997. Append the specified message to the folder.
  41998. </summary>
  41999. <remarks>
  42000. Appends the specified message to the folder and returns the UniqueId assigned to the message.
  42001. </remarks>
  42002. <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
  42003. <param name="options">The formatting options.</param>
  42004. <param name="message">The message.</param>
  42005. <param name="flags">The message flags.</param>
  42006. <param name="date">The received date of the message.</param>
  42007. <param name="annotations">The message annotations.</param>
  42008. <param name="cancellationToken">The cancellation token.</param>
  42009. <param name="progress">The progress reporting mechanism.</param>
  42010. <exception cref="T:System.ArgumentNullException">
  42011. <para><paramref name="options"/> is <c>null</c>.</para>
  42012. <para>-or-</para>
  42013. <para><paramref name="message"/> is <c>null</c>.</para>
  42014. </exception>
  42015. <exception cref="T:System.ObjectDisposedException">
  42016. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  42017. </exception>
  42018. <exception cref="T:MailKit.ServiceNotConnectedException">
  42019. The <see cref="T:MailKit.IMailStore"/> is not connected.
  42020. </exception>
  42021. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  42022. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  42023. </exception>
  42024. <exception cref="T:MailKit.FolderNotFoundException">
  42025. The <see cref="T:MailKit.MailFolder"/> does not exist.
  42026. </exception>
  42027. <exception cref="T:System.InvalidOperationException">
  42028. Internationalized formatting was requested but has not been enabled.
  42029. </exception>
  42030. <exception cref="T:System.OperationCanceledException">
  42031. The operation was canceled via the cancellation token.
  42032. </exception>
  42033. <exception cref="T:System.NotSupportedException">
  42034. Internationalized formatting was requested but is not supported by the server.
  42035. </exception>
  42036. <exception cref="T:System.IO.IOException">
  42037. An I/O error occurred.
  42038. </exception>
  42039. <exception cref="T:MailKit.ProtocolException">
  42040. The server's response contained unexpected tokens.
  42041. </exception>
  42042. <exception cref="T:MailKit.CommandException">
  42043. The command failed.
  42044. </exception>
  42045. </member>
  42046. <member name="M:MailKit.MailFolder.AppendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,MailKit.MessageFlags,System.Nullable{System.DateTimeOffset},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  42047. <summary>
  42048. Asynchronously append the specified message to the folder.
  42049. </summary>
  42050. <remarks>
  42051. Asynchronously appends the specified message to the folder and returns the UniqueId assigned to the message.
  42052. </remarks>
  42053. <returns>The UID of the appended message, if available; otherwise, <c>null</c>.</returns>
  42054. <param name="options">The formatting options.</param>
  42055. <param name="message">The message.</param>
  42056. <param name="flags">The message flags.</param>
  42057. <param name="date">The received date of the message.</param>
  42058. <param name="annotations">The message annotations.</param>
  42059. <param name="cancellationToken">The cancellation token.</param>
  42060. <param name="progress">The progress reporting mechanism.</param>
  42061. <exception cref="T:System.ArgumentNullException">
  42062. <para><paramref name="options"/> is <c>null</c>.</para>
  42063. <para>-or-</para>
  42064. <para><paramref name="message"/> is <c>null</c>.</para>
  42065. </exception>
  42066. <exception cref="T:System.ObjectDisposedException">
  42067. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  42068. </exception>
  42069. <exception cref="T:MailKit.ServiceNotConnectedException">
  42070. The <see cref="T:MailKit.IMailStore"/> is not connected.
  42071. </exception>
  42072. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  42073. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  42074. </exception>
  42075. <exception cref="T:MailKit.FolderNotFoundException">
  42076. The <see cref="T:MailKit.MailFolder"/> does not exist.
  42077. </exception>
  42078. <exception cref="T:System.InvalidOperationException">
  42079. Internationalized formatting was requested but has not been enabled.
  42080. </exception>
  42081. <exception cref="T:System.OperationCanceledException">
  42082. The operation was canceled via the cancellation token.
  42083. </exception>
  42084. <exception cref="T:System.NotSupportedException">
  42085. Internationalized formatting was requested but is not supported by the server.
  42086. </exception>
  42087. <exception cref="T:System.IO.IOException">
  42088. An I/O error occurred.
  42089. </exception>
  42090. <exception cref="T:MailKit.ProtocolException">
  42091. The server's response contained unexpected tokens.
  42092. </exception>
  42093. <exception cref="T:MailKit.CommandException">
  42094. The command failed.
  42095. </exception>
  42096. </member>
  42097. <member name="M:MailKit.MailFolder.Append(System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  42098. <summary>
  42099. Append the specified messages to the folder.
  42100. </summary>
  42101. <remarks>
  42102. Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
  42103. </remarks>
  42104. <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
  42105. <param name="messages">The array of messages to append to the folder.</param>
  42106. <param name="flags">The message flags to use for each message.</param>
  42107. <param name="cancellationToken">The cancellation token.</param>
  42108. <param name="progress">The progress reporting mechanism.</param>
  42109. <exception cref="T:System.ArgumentNullException">
  42110. <para><paramref name="messages"/> is <c>null</c>.</para>
  42111. <para>-or-</para>
  42112. <para><paramref name="flags"/> is <c>null</c>.</para>
  42113. </exception>
  42114. <exception cref="T:System.ArgumentException">
  42115. <para>One or more of the <paramref name="messages"/> is null.</para>
  42116. <para>-or-</para>
  42117. <para>The number of messages does not match the number of flags.</para>
  42118. </exception>
  42119. <exception cref="T:System.ObjectDisposedException">
  42120. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  42121. </exception>
  42122. <exception cref="T:MailKit.ServiceNotConnectedException">
  42123. The <see cref="T:MailKit.IMailStore"/> is not connected.
  42124. </exception>
  42125. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  42126. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  42127. </exception>
  42128. <exception cref="T:MailKit.FolderNotFoundException">
  42129. The <see cref="T:MailKit.MailFolder"/> does not exist.
  42130. </exception>
  42131. <exception cref="T:System.OperationCanceledException">
  42132. The operation was canceled via the cancellation token.
  42133. </exception>
  42134. <exception cref="T:System.IO.IOException">
  42135. An I/O error occurred.
  42136. </exception>
  42137. <exception cref="T:MailKit.ProtocolException">
  42138. The server's response contained unexpected tokens.
  42139. </exception>
  42140. <exception cref="T:MailKit.CommandException">
  42141. The command failed.
  42142. </exception>
  42143. </member>
  42144. <member name="M:MailKit.MailFolder.AppendAsync(System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  42145. <summary>
  42146. Asynchronously append the specified messages to the folder.
  42147. </summary>
  42148. <remarks>
  42149. Asynchronously appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
  42150. </remarks>
  42151. <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
  42152. <param name="messages">The array of messages to append to the folder.</param>
  42153. <param name="flags">The message flags to use for each message.</param>
  42154. <param name="cancellationToken">The cancellation token.</param>
  42155. <param name="progress">The progress reporting mechanism.</param>
  42156. <exception cref="T:System.ArgumentNullException">
  42157. <para><paramref name="messages"/> is <c>null</c>.</para>
  42158. <para>-or-</para>
  42159. <para><paramref name="flags"/> is <c>null</c>.</para>
  42160. </exception>
  42161. <exception cref="T:System.ArgumentException">
  42162. <para>One or more of the <paramref name="messages"/> is null.</para>
  42163. <para>-or-</para>
  42164. <para>The number of messages does not match the number of flags.</para>
  42165. </exception>
  42166. <exception cref="T:System.ObjectDisposedException">
  42167. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  42168. </exception>
  42169. <exception cref="T:MailKit.ServiceNotConnectedException">
  42170. The <see cref="T:MailKit.IMailStore"/> is not connected.
  42171. </exception>
  42172. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  42173. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  42174. </exception>
  42175. <exception cref="T:MailKit.FolderNotFoundException">
  42176. The <see cref="T:MailKit.MailFolder"/> does not exist.
  42177. </exception>
  42178. <exception cref="T:System.OperationCanceledException">
  42179. The operation was canceled via the cancellation token.
  42180. </exception>
  42181. <exception cref="T:System.IO.IOException">
  42182. An I/O error occurred.
  42183. </exception>
  42184. <exception cref="T:MailKit.ProtocolException">
  42185. The server's response contained unexpected tokens.
  42186. </exception>
  42187. <exception cref="T:MailKit.CommandException">
  42188. The command failed.
  42189. </exception>
  42190. </member>
  42191. <member name="M:MailKit.MailFolder.Append(System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Collections.Generic.IList{System.DateTimeOffset},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  42192. <summary>
  42193. Append the specified messages to the folder.
  42194. </summary>
  42195. <remarks>
  42196. Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
  42197. </remarks>
  42198. <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
  42199. <param name="messages">The array of messages to append to the folder.</param>
  42200. <param name="flags">The message flags to use for each of the messages.</param>
  42201. <param name="dates">The received dates to use for each of the messages.</param>
  42202. <param name="cancellationToken">The cancellation token.</param>
  42203. <param name="progress">The progress reporting mechanism.</param>
  42204. <exception cref="T:System.ArgumentNullException">
  42205. <para><paramref name="messages"/> is <c>null</c>.</para>
  42206. <para>-or-</para>
  42207. <para><paramref name="flags"/> is <c>null</c>.</para>
  42208. <para>-or-</para>
  42209. <para><paramref name="dates"/> is <c>null</c>.</para>
  42210. </exception>
  42211. <exception cref="T:System.ArgumentException">
  42212. <para>One or more of the <paramref name="messages"/> is null.</para>
  42213. <para>-or-</para>
  42214. <para>The number of messages, flags, and dates do not match.</para>
  42215. </exception>
  42216. <exception cref="T:System.ObjectDisposedException">
  42217. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  42218. </exception>
  42219. <exception cref="T:MailKit.ServiceNotConnectedException">
  42220. The <see cref="T:MailKit.IMailStore"/> is not connected.
  42221. </exception>
  42222. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  42223. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  42224. </exception>
  42225. <exception cref="T:MailKit.FolderNotFoundException">
  42226. The <see cref="T:MailKit.MailFolder"/> does not exist.
  42227. </exception>
  42228. <exception cref="T:System.OperationCanceledException">
  42229. The operation was canceled via the cancellation token.
  42230. </exception>
  42231. <exception cref="T:System.IO.IOException">
  42232. An I/O error occurred.
  42233. </exception>
  42234. <exception cref="T:MailKit.ProtocolException">
  42235. The server's response contained unexpected tokens.
  42236. </exception>
  42237. <exception cref="T:MailKit.CommandException">
  42238. The command failed.
  42239. </exception>
  42240. </member>
  42241. <member name="M:MailKit.MailFolder.AppendAsync(System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Collections.Generic.IList{System.DateTimeOffset},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  42242. <summary>
  42243. Asynchronously append the specified messages to the folder.
  42244. </summary>
  42245. <remarks>
  42246. Asynchronously appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
  42247. </remarks>
  42248. <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
  42249. <param name="messages">The array of messages to append to the folder.</param>
  42250. <param name="flags">The message flags to use for each of the messages.</param>
  42251. <param name="dates">The received dates to use for each of the messages.</param>
  42252. <param name="cancellationToken">The cancellation token.</param>
  42253. <param name="progress">The progress reporting mechanism.</param>
  42254. <exception cref="T:System.ArgumentNullException">
  42255. <para><paramref name="messages"/> is <c>null</c>.</para>
  42256. <para>-or-</para>
  42257. <para><paramref name="flags"/> is <c>null</c>.</para>
  42258. <para>-or-</para>
  42259. <para><paramref name="dates"/> is <c>null</c>.</para>
  42260. </exception>
  42261. <exception cref="T:System.ArgumentException">
  42262. <para>One or more of the <paramref name="messages"/> is null.</para>
  42263. <para>-or-</para>
  42264. <para>The number of messages, flags, and dates do not match.</para>
  42265. </exception>
  42266. <exception cref="T:System.ObjectDisposedException">
  42267. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  42268. </exception>
  42269. <exception cref="T:MailKit.ServiceNotConnectedException">
  42270. The <see cref="T:MailKit.IMailStore"/> is not connected.
  42271. </exception>
  42272. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  42273. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  42274. </exception>
  42275. <exception cref="T:MailKit.FolderNotFoundException">
  42276. The <see cref="T:MailKit.MailFolder"/> does not exist.
  42277. </exception>
  42278. <exception cref="T:System.OperationCanceledException">
  42279. The operation was canceled via the cancellation token.
  42280. </exception>
  42281. <exception cref="T:System.IO.IOException">
  42282. An I/O error occurred.
  42283. </exception>
  42284. <exception cref="T:MailKit.ProtocolException">
  42285. The server's response contained unexpected tokens.
  42286. </exception>
  42287. <exception cref="T:MailKit.CommandException">
  42288. The command failed.
  42289. </exception>
  42290. </member>
  42291. <member name="M:MailKit.MailFolder.Append(MimeKit.FormatOptions,System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  42292. <summary>
  42293. Append the specified messages to the folder.
  42294. </summary>
  42295. <remarks>
  42296. Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
  42297. </remarks>
  42298. <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
  42299. <param name="options">The formatting options.</param>
  42300. <param name="messages">The array of messages to append to the folder.</param>
  42301. <param name="flags">The message flags to use for each message.</param>
  42302. <param name="cancellationToken">The cancellation token.</param>
  42303. <param name="progress">The progress reporting mechanism.</param>
  42304. <exception cref="T:System.ArgumentNullException">
  42305. <para><paramref name="options"/> is <c>null</c>.</para>
  42306. <para>-or-</para>
  42307. <para><paramref name="messages"/> is <c>null</c>.</para>
  42308. <para>-or-</para>
  42309. <para><paramref name="flags"/> is <c>null</c>.</para>
  42310. </exception>
  42311. <exception cref="T:System.ArgumentException">
  42312. <para>One or more of the <paramref name="messages"/> is null.</para>
  42313. <para>-or-</para>
  42314. <para>The number of messages does not match the number of flags.</para>
  42315. </exception>
  42316. <exception cref="T:System.ObjectDisposedException">
  42317. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  42318. </exception>
  42319. <exception cref="T:MailKit.ServiceNotConnectedException">
  42320. The <see cref="T:MailKit.IMailStore"/> is not connected.
  42321. </exception>
  42322. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  42323. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  42324. </exception>
  42325. <exception cref="T:MailKit.FolderNotFoundException">
  42326. The <see cref="T:MailKit.MailFolder"/> does not exist.
  42327. </exception>
  42328. <exception cref="T:System.InvalidOperationException">
  42329. Internationalized formatting was requested but has not been enabled.
  42330. </exception>
  42331. <exception cref="T:System.OperationCanceledException">
  42332. The operation was canceled via the cancellation token.
  42333. </exception>
  42334. <exception cref="T:System.NotSupportedException">
  42335. Internationalized formatting was requested but is not supported by the server.
  42336. </exception>
  42337. <exception cref="T:System.IO.IOException">
  42338. An I/O error occurred.
  42339. </exception>
  42340. <exception cref="T:MailKit.ProtocolException">
  42341. The server's response contained unexpected tokens.
  42342. </exception>
  42343. <exception cref="T:MailKit.CommandException">
  42344. The command failed.
  42345. </exception>
  42346. </member>
  42347. <member name="M:MailKit.MailFolder.AppendAsync(MimeKit.FormatOptions,System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  42348. <summary>
  42349. Asynchronously append the specified messages to the folder.
  42350. </summary>
  42351. <remarks>
  42352. Asynchronously appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
  42353. </remarks>
  42354. <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
  42355. <param name="options">The formatting options.</param>
  42356. <param name="messages">The array of messages to append to the folder.</param>
  42357. <param name="flags">The message flags to use for each message.</param>
  42358. <param name="cancellationToken">The cancellation token.</param>
  42359. <param name="progress">The progress reporting mechanism.</param>
  42360. <exception cref="T:System.ArgumentNullException">
  42361. <para><paramref name="options"/> is <c>null</c>.</para>
  42362. <para>-or-</para>
  42363. <para><paramref name="messages"/> is <c>null</c>.</para>
  42364. <para>-or-</para>
  42365. <para><paramref name="flags"/> is <c>null</c>.</para>
  42366. </exception>
  42367. <exception cref="T:System.ArgumentException">
  42368. <para>One or more of the <paramref name="messages"/> is null.</para>
  42369. <para>-or-</para>
  42370. <para>The number of messages does not match the number of flags.</para>
  42371. </exception>
  42372. <exception cref="T:System.ObjectDisposedException">
  42373. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  42374. </exception>
  42375. <exception cref="T:MailKit.ServiceNotConnectedException">
  42376. The <see cref="T:MailKit.IMailStore"/> is not connected.
  42377. </exception>
  42378. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  42379. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  42380. </exception>
  42381. <exception cref="T:MailKit.FolderNotFoundException">
  42382. The <see cref="T:MailKit.MailFolder"/> does not exist.
  42383. </exception>
  42384. <exception cref="T:System.InvalidOperationException">
  42385. Internationalized formatting was requested but has not been enabled.
  42386. </exception>
  42387. <exception cref="T:System.OperationCanceledException">
  42388. The operation was canceled via the cancellation token.
  42389. </exception>
  42390. <exception cref="T:System.NotSupportedException">
  42391. Internationalized formatting was requested but is not supported by the server.
  42392. </exception>
  42393. <exception cref="T:System.IO.IOException">
  42394. An I/O error occurred.
  42395. </exception>
  42396. <exception cref="T:MailKit.ProtocolException">
  42397. The server's response contained unexpected tokens.
  42398. </exception>
  42399. <exception cref="T:MailKit.CommandException">
  42400. The command failed.
  42401. </exception>
  42402. </member>
  42403. <member name="M:MailKit.MailFolder.Append(MimeKit.FormatOptions,System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Collections.Generic.IList{System.DateTimeOffset},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  42404. <summary>
  42405. Append the specified messages to the folder.
  42406. </summary>
  42407. <remarks>
  42408. Appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
  42409. </remarks>
  42410. <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
  42411. <param name="options">The formatting options.</param>
  42412. <param name="messages">The array of messages to append to the folder.</param>
  42413. <param name="flags">The message flags to use for each of the messages.</param>
  42414. <param name="dates">The received dates to use for each of the messages.</param>
  42415. <param name="cancellationToken">The cancellation token.</param>
  42416. <param name="progress">The progress reporting mechanism.</param>
  42417. <exception cref="T:System.ArgumentNullException">
  42418. <para><paramref name="options"/> is <c>null</c>.</para>
  42419. <para>-or-</para>
  42420. <para><paramref name="messages"/> is <c>null</c>.</para>
  42421. <para>-or-</para>
  42422. <para><paramref name="flags"/> is <c>null</c>.</para>
  42423. <para>-or-</para>
  42424. <para><paramref name="dates"/> is <c>null</c>.</para>
  42425. </exception>
  42426. <exception cref="T:System.ArgumentException">
  42427. <para>One or more of the <paramref name="messages"/> is null.</para>
  42428. <para>-or-</para>
  42429. <para>The number of messages, flags, and dates do not match.</para>
  42430. </exception>
  42431. <exception cref="T:System.ObjectDisposedException">
  42432. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  42433. </exception>
  42434. <exception cref="T:MailKit.ServiceNotConnectedException">
  42435. The <see cref="T:MailKit.IMailStore"/> is not connected.
  42436. </exception>
  42437. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  42438. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  42439. </exception>
  42440. <exception cref="T:MailKit.FolderNotFoundException">
  42441. The <see cref="T:MailKit.MailFolder"/> does not exist.
  42442. </exception>
  42443. <exception cref="T:System.InvalidOperationException">
  42444. Internationalized formatting was requested but has not been enabled.
  42445. </exception>
  42446. <exception cref="T:System.OperationCanceledException">
  42447. The operation was canceled via the cancellation token.
  42448. </exception>
  42449. <exception cref="T:System.NotSupportedException">
  42450. Internationalized formatting was requested but is not supported by the server.
  42451. </exception>
  42452. <exception cref="T:System.IO.IOException">
  42453. An I/O error occurred.
  42454. </exception>
  42455. <exception cref="T:MailKit.ProtocolException">
  42456. The server's response contained unexpected tokens.
  42457. </exception>
  42458. <exception cref="T:MailKit.CommandException">
  42459. The command failed.
  42460. </exception>
  42461. </member>
  42462. <member name="M:MailKit.MailFolder.AppendAsync(MimeKit.FormatOptions,System.Collections.Generic.IList{MimeKit.MimeMessage},System.Collections.Generic.IList{MailKit.MessageFlags},System.Collections.Generic.IList{System.DateTimeOffset},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  42463. <summary>
  42464. Asynchronously append the specified messages to the folder.
  42465. </summary>
  42466. <remarks>
  42467. Asynchronously appends the specified messages to the folder and returns the UniqueIds assigned to the messages.
  42468. </remarks>
  42469. <returns>The UIDs of the appended messages, if available; otherwise an empty array.</returns>
  42470. <param name="options">The formatting options.</param>
  42471. <param name="messages">The array of messages to append to the folder.</param>
  42472. <param name="flags">The message flags to use for each of the messages.</param>
  42473. <param name="dates">The received dates to use for each of the messages.</param>
  42474. <param name="cancellationToken">The cancellation token.</param>
  42475. <param name="progress">The progress reporting mechanism.</param>
  42476. <exception cref="T:System.ArgumentNullException">
  42477. <para><paramref name="options"/> is <c>null</c>.</para>
  42478. <para>-or-</para>
  42479. <para><paramref name="messages"/> is <c>null</c>.</para>
  42480. <para>-or-</para>
  42481. <para><paramref name="flags"/> is <c>null</c>.</para>
  42482. <para>-or-</para>
  42483. <para><paramref name="dates"/> is <c>null</c>.</para>
  42484. </exception>
  42485. <exception cref="T:System.ArgumentException">
  42486. <para>One or more of the <paramref name="messages"/> is null.</para>
  42487. <para>-or-</para>
  42488. <para>The number of messages, flags, and dates do not match.</para>
  42489. </exception>
  42490. <exception cref="T:System.ObjectDisposedException">
  42491. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  42492. </exception>
  42493. <exception cref="T:MailKit.ServiceNotConnectedException">
  42494. The <see cref="T:MailKit.IMailStore"/> is not connected.
  42495. </exception>
  42496. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  42497. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  42498. </exception>
  42499. <exception cref="T:MailKit.FolderNotFoundException">
  42500. The <see cref="T:MailKit.MailFolder"/> does not exist.
  42501. </exception>
  42502. <exception cref="T:System.InvalidOperationException">
  42503. Internationalized formatting was requested but has not been enabled.
  42504. </exception>
  42505. <exception cref="T:System.OperationCanceledException">
  42506. The operation was canceled via the cancellation token.
  42507. </exception>
  42508. <exception cref="T:System.NotSupportedException">
  42509. Internationalized formatting was requested but is not supported by the server.
  42510. </exception>
  42511. <exception cref="T:System.IO.IOException">
  42512. An I/O error occurred.
  42513. </exception>
  42514. <exception cref="T:MailKit.ProtocolException">
  42515. The server's response contained unexpected tokens.
  42516. </exception>
  42517. <exception cref="T:MailKit.CommandException">
  42518. The command failed.
  42519. </exception>
  42520. </member>
  42521. <member name="M:MailKit.MailFolder.CopyTo(MailKit.UniqueId,MailKit.IMailFolder,System.Threading.CancellationToken)">
  42522. <summary>
  42523. Copy the specified message to the destination folder.
  42524. </summary>
  42525. <remarks>
  42526. Copies the specified message to the destination folder.
  42527. </remarks>
  42528. <returns>The UID of the message in the destination folder, if available; otherwise, <c>null</c>.</returns>
  42529. <param name="uid">The UID of the message to copy.</param>
  42530. <param name="destination">The destination folder.</param>
  42531. <param name="cancellationToken">The cancellation token.</param>
  42532. <exception cref="T:System.ArgumentNullException">
  42533. <paramref name="destination"/> is <c>null</c>.
  42534. </exception>
  42535. <exception cref="T:System.ArgumentException">
  42536. <para><paramref name="uid"/> is invalid.</para>
  42537. <para>-or-</para>
  42538. <para>The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
  42539. </exception>
  42540. <exception cref="T:System.ObjectDisposedException">
  42541. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  42542. </exception>
  42543. <exception cref="T:MailKit.ServiceNotConnectedException">
  42544. The <see cref="T:MailKit.IMailStore"/> is not connected.
  42545. </exception>
  42546. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  42547. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  42548. </exception>
  42549. <exception cref="T:MailKit.FolderNotOpenException">
  42550. The folder is not currently open.
  42551. </exception>
  42552. <exception cref="T:System.NotSupportedException">
  42553. The mail store does not support the UIDPLUS extension.
  42554. </exception>
  42555. <exception cref="T:System.OperationCanceledException">
  42556. The operation was canceled via the cancellation token.
  42557. </exception>
  42558. <exception cref="T:System.IO.IOException">
  42559. An I/O error occurred.
  42560. </exception>
  42561. <exception cref="T:MailKit.ProtocolException">
  42562. The server's response contained unexpected tokens.
  42563. </exception>
  42564. <exception cref="T:MailKit.CommandException">
  42565. The command failed.
  42566. </exception>
  42567. </member>
  42568. <member name="M:MailKit.MailFolder.CopyToAsync(MailKit.UniqueId,MailKit.IMailFolder,System.Threading.CancellationToken)">
  42569. <summary>
  42570. Asynchronously copy the specified message to the destination folder.
  42571. </summary>
  42572. <remarks>
  42573. Asynchronously copies the specified message to the destination folder.
  42574. </remarks>
  42575. <returns>The UID of the message in the destination folder, if available; otherwise, <c>null</c>.</returns>
  42576. <param name="uid">The UID of the message to copy.</param>
  42577. <param name="destination">The destination folder.</param>
  42578. <param name="cancellationToken">The cancellation token.</param>
  42579. <exception cref="T:System.ArgumentNullException">
  42580. <paramref name="destination"/> is <c>null</c>.
  42581. </exception>
  42582. <exception cref="T:System.ArgumentException">
  42583. <para><paramref name="uid"/> is invalid.</para>
  42584. <para>-or-</para>
  42585. <para>The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
  42586. </exception>
  42587. <exception cref="T:System.ObjectDisposedException">
  42588. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  42589. </exception>
  42590. <exception cref="T:MailKit.ServiceNotConnectedException">
  42591. The <see cref="T:MailKit.IMailStore"/> is not connected.
  42592. </exception>
  42593. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  42594. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  42595. </exception>
  42596. <exception cref="T:MailKit.FolderNotOpenException">
  42597. The folder is not currently open.
  42598. </exception>
  42599. <exception cref="T:System.NotSupportedException">
  42600. The mail store does not support the UIDPLUS extension.
  42601. </exception>
  42602. <exception cref="T:System.OperationCanceledException">
  42603. The operation was canceled via the cancellation token.
  42604. </exception>
  42605. <exception cref="T:System.IO.IOException">
  42606. An I/O error occurred.
  42607. </exception>
  42608. <exception cref="T:MailKit.ProtocolException">
  42609. The server's response contained unexpected tokens.
  42610. </exception>
  42611. <exception cref="T:MailKit.CommandException">
  42612. The command failed.
  42613. </exception>
  42614. </member>
  42615. <member name="M:MailKit.MailFolder.CopyTo(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.IMailFolder,System.Threading.CancellationToken)">
  42616. <summary>
  42617. Copy the specified messages to the destination folder.
  42618. </summary>
  42619. <remarks>
  42620. Copies the specified messages to the destination folder.
  42621. </remarks>
  42622. <returns>The UID mapping of the messages in the destination folder, if available; otherwise an empty mapping.</returns>
  42623. <param name="uids">The UIDs of the messages to copy.</param>
  42624. <param name="destination">The destination folder.</param>
  42625. <param name="cancellationToken">The cancellation token.</param>
  42626. <exception cref="T:System.ArgumentNullException">
  42627. <para><paramref name="uids"/> is <c>null</c>.</para>
  42628. <para>-or-</para>
  42629. <para><paramref name="destination"/> is <c>null</c>.</para>
  42630. </exception>
  42631. <exception cref="T:System.ArgumentException">
  42632. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  42633. <para>-or-</para>
  42634. <para>The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
  42635. </exception>
  42636. <exception cref="T:System.ObjectDisposedException">
  42637. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  42638. </exception>
  42639. <exception cref="T:MailKit.ServiceNotConnectedException">
  42640. The <see cref="T:MailKit.IMailStore"/> is not connected.
  42641. </exception>
  42642. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  42643. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  42644. </exception>
  42645. <exception cref="T:MailKit.FolderNotOpenException">
  42646. The folder is not currently open.
  42647. </exception>
  42648. <exception cref="T:System.NotSupportedException">
  42649. The mail store does not support the UIDPLUS extension.
  42650. </exception>
  42651. <exception cref="T:System.OperationCanceledException">
  42652. The operation was canceled via the cancellation token.
  42653. </exception>
  42654. <exception cref="T:System.IO.IOException">
  42655. An I/O error occurred.
  42656. </exception>
  42657. <exception cref="T:MailKit.ProtocolException">
  42658. The server's response contained unexpected tokens.
  42659. </exception>
  42660. <exception cref="T:MailKit.CommandException">
  42661. The command failed.
  42662. </exception>
  42663. </member>
  42664. <member name="M:MailKit.MailFolder.CopyToAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.IMailFolder,System.Threading.CancellationToken)">
  42665. <summary>
  42666. Asynchronously copy the specified messages to the destination folder.
  42667. </summary>
  42668. <remarks>
  42669. Asynchronously copies the specified messages to the destination folder.
  42670. </remarks>
  42671. <returns>The UID mapping of the messages in the destination folder, if available; otherwise an empty mapping.</returns>
  42672. <param name="uids">The UIDs of the messages to copy.</param>
  42673. <param name="destination">The destination folder.</param>
  42674. <param name="cancellationToken">The cancellation token.</param>
  42675. <exception cref="T:System.ArgumentNullException">
  42676. <para><paramref name="uids"/> is <c>null</c>.</para>
  42677. <para>-or-</para>
  42678. <para><paramref name="destination"/> is <c>null</c>.</para>
  42679. </exception>
  42680. <exception cref="T:System.ArgumentException">
  42681. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  42682. <para>-or-</para>
  42683. <para>The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
  42684. </exception>
  42685. <exception cref="T:System.ObjectDisposedException">
  42686. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  42687. </exception>
  42688. <exception cref="T:MailKit.ServiceNotConnectedException">
  42689. The <see cref="T:MailKit.IMailStore"/> is not connected.
  42690. </exception>
  42691. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  42692. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  42693. </exception>
  42694. <exception cref="T:MailKit.FolderNotOpenException">
  42695. The folder is not currently open.
  42696. </exception>
  42697. <exception cref="T:System.NotSupportedException">
  42698. The mail store does not support the UIDPLUS extension.
  42699. </exception>
  42700. <exception cref="T:System.OperationCanceledException">
  42701. The operation was canceled via the cancellation token.
  42702. </exception>
  42703. <exception cref="T:System.IO.IOException">
  42704. An I/O error occurred.
  42705. </exception>
  42706. <exception cref="T:MailKit.ProtocolException">
  42707. The server's response contained unexpected tokens.
  42708. </exception>
  42709. <exception cref="T:MailKit.CommandException">
  42710. The command failed.
  42711. </exception>
  42712. </member>
  42713. <member name="M:MailKit.MailFolder.MoveTo(MailKit.UniqueId,MailKit.IMailFolder,System.Threading.CancellationToken)">
  42714. <summary>
  42715. Move the specified message to the destination folder.
  42716. </summary>
  42717. <remarks>
  42718. Moves the specified message to the destination folder.
  42719. </remarks>
  42720. <returns>The UID of the message in the destination folder, if available; otherwise, <c>null</c>.</returns>
  42721. <param name="uid">The UID of the message to move.</param>
  42722. <param name="destination">The destination folder.</param>
  42723. <param name="cancellationToken">The cancellation token.</param>
  42724. <exception cref="T:System.ArgumentNullException">
  42725. <paramref name="destination"/> is <c>null</c>.
  42726. </exception>
  42727. <exception cref="T:System.ArgumentException">
  42728. <para><paramref name="uid"/> is invalid.</para>
  42729. <para>-or-</para>
  42730. <para>The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
  42731. </exception>
  42732. <exception cref="T:System.ObjectDisposedException">
  42733. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  42734. </exception>
  42735. <exception cref="T:MailKit.ServiceNotConnectedException">
  42736. The <see cref="T:MailKit.IMailStore"/> is not connected.
  42737. </exception>
  42738. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  42739. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  42740. </exception>
  42741. <exception cref="T:MailKit.FolderNotOpenException">
  42742. The folder is not currently open in read-write mode.
  42743. </exception>
  42744. <exception cref="T:System.NotSupportedException">
  42745. The mail store does not support the UIDPLUS extension.
  42746. </exception>
  42747. <exception cref="T:System.OperationCanceledException">
  42748. The operation was canceled via the cancellation token.
  42749. </exception>
  42750. <exception cref="T:System.IO.IOException">
  42751. An I/O error occurred.
  42752. </exception>
  42753. <exception cref="T:MailKit.ProtocolException">
  42754. The server's response contained unexpected tokens.
  42755. </exception>
  42756. <exception cref="T:MailKit.CommandException">
  42757. The command failed.
  42758. </exception>
  42759. </member>
  42760. <member name="M:MailKit.MailFolder.MoveToAsync(MailKit.UniqueId,MailKit.IMailFolder,System.Threading.CancellationToken)">
  42761. <summary>
  42762. Asynchronously move the specified message to the destination folder.
  42763. </summary>
  42764. <remarks>
  42765. Asynchronously moves the specified message to the destination folder.
  42766. </remarks>
  42767. <returns>The UID of the message in the destination folder, if available; otherwise, <c>null</c>.</returns>
  42768. <param name="uid">The UID of the message to move.</param>
  42769. <param name="destination">The destination folder.</param>
  42770. <param name="cancellationToken">The cancellation token.</param>
  42771. <exception cref="T:System.ArgumentNullException">
  42772. <paramref name="destination"/> is <c>null</c>.
  42773. </exception>
  42774. <exception cref="T:System.ArgumentException">
  42775. <para><paramref name="uid"/> is invalid.</para>
  42776. <para>-or-</para>
  42777. <para>The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
  42778. </exception>
  42779. <exception cref="T:System.ObjectDisposedException">
  42780. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  42781. </exception>
  42782. <exception cref="T:MailKit.ServiceNotConnectedException">
  42783. The <see cref="T:MailKit.IMailStore"/> is not connected.
  42784. </exception>
  42785. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  42786. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  42787. </exception>
  42788. <exception cref="T:MailKit.FolderNotOpenException">
  42789. The folder is not currently open in read-write mode.
  42790. </exception>
  42791. <exception cref="T:System.NotSupportedException">
  42792. The mail store does not support the UIDPLUS extension.
  42793. </exception>
  42794. <exception cref="T:System.OperationCanceledException">
  42795. The operation was canceled via the cancellation token.
  42796. </exception>
  42797. <exception cref="T:System.IO.IOException">
  42798. An I/O error occurred.
  42799. </exception>
  42800. <exception cref="T:MailKit.ProtocolException">
  42801. The server's response contained unexpected tokens.
  42802. </exception>
  42803. <exception cref="T:MailKit.CommandException">
  42804. The command failed.
  42805. </exception>
  42806. </member>
  42807. <member name="M:MailKit.MailFolder.MoveTo(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.IMailFolder,System.Threading.CancellationToken)">
  42808. <summary>
  42809. Move the specified messages to the destination folder.
  42810. </summary>
  42811. <remarks>
  42812. Moves the specified messages to the destination folder.
  42813. </remarks>
  42814. <returns>The UID mapping of the messages in the destination folder, if available; otherwise an empty mapping.</returns>
  42815. <param name="uids">The UIDs of the messages to move.</param>
  42816. <param name="destination">The destination folder.</param>
  42817. <param name="cancellationToken">The cancellation token.</param>
  42818. <exception cref="T:System.ArgumentNullException">
  42819. <para><paramref name="uids"/> is <c>null</c>.</para>
  42820. <para>-or-</para>
  42821. <para><paramref name="destination"/> is <c>null</c>.</para>
  42822. </exception>
  42823. <exception cref="T:System.ArgumentException">
  42824. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  42825. <para>-or-</para>
  42826. <para>The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
  42827. </exception>
  42828. <exception cref="T:System.ObjectDisposedException">
  42829. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  42830. </exception>
  42831. <exception cref="T:MailKit.ServiceNotConnectedException">
  42832. The <see cref="T:MailKit.IMailStore"/> is not connected.
  42833. </exception>
  42834. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  42835. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  42836. </exception>
  42837. <exception cref="T:MailKit.FolderNotOpenException">
  42838. The folder is not currently open in read-write mode.
  42839. </exception>
  42840. <exception cref="T:System.NotSupportedException">
  42841. The mail store does not support the UIDPLUS extension.
  42842. </exception>
  42843. <exception cref="T:System.OperationCanceledException">
  42844. The operation was canceled via the cancellation token.
  42845. </exception>
  42846. <exception cref="T:System.IO.IOException">
  42847. An I/O error occurred.
  42848. </exception>
  42849. <exception cref="T:MailKit.ProtocolException">
  42850. The server's response contained unexpected tokens.
  42851. </exception>
  42852. <exception cref="T:MailKit.CommandException">
  42853. The command failed.
  42854. </exception>
  42855. </member>
  42856. <member name="M:MailKit.MailFolder.MoveToAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.IMailFolder,System.Threading.CancellationToken)">
  42857. <summary>
  42858. Asynchronously move the specified messages to the destination folder.
  42859. </summary>
  42860. <remarks>
  42861. Asynchronously moves the specified messages to the destination folder.
  42862. </remarks>
  42863. <returns>The UID mapping of the messages in the destination folder, if available; otherwise an empty mapping.</returns>
  42864. <param name="uids">The UIDs of the messages to move.</param>
  42865. <param name="destination">The destination folder.</param>
  42866. <param name="cancellationToken">The cancellation token.</param>
  42867. <exception cref="T:System.ArgumentNullException">
  42868. <para><paramref name="uids"/> is <c>null</c>.</para>
  42869. <para>-or-</para>
  42870. <para><paramref name="destination"/> is <c>null</c>.</para>
  42871. </exception>
  42872. <exception cref="T:System.ArgumentException">
  42873. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  42874. <para>-or-</para>
  42875. <para>The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
  42876. </exception>
  42877. <exception cref="T:System.ObjectDisposedException">
  42878. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  42879. </exception>
  42880. <exception cref="T:MailKit.ServiceNotConnectedException">
  42881. The <see cref="T:MailKit.IMailStore"/> is not connected.
  42882. </exception>
  42883. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  42884. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  42885. </exception>
  42886. <exception cref="T:MailKit.FolderNotOpenException">
  42887. The folder is not currently open in read-write mode.
  42888. </exception>
  42889. <exception cref="T:System.NotSupportedException">
  42890. The mail store does not support the UIDPLUS extension.
  42891. </exception>
  42892. <exception cref="T:System.OperationCanceledException">
  42893. The operation was canceled via the cancellation token.
  42894. </exception>
  42895. <exception cref="T:System.IO.IOException">
  42896. An I/O error occurred.
  42897. </exception>
  42898. <exception cref="T:MailKit.ProtocolException">
  42899. The server's response contained unexpected tokens.
  42900. </exception>
  42901. <exception cref="T:MailKit.CommandException">
  42902. The command failed.
  42903. </exception>
  42904. </member>
  42905. <member name="M:MailKit.MailFolder.CopyTo(System.Int32,MailKit.IMailFolder,System.Threading.CancellationToken)">
  42906. <summary>
  42907. Copy the specified message to the destination folder.
  42908. </summary>
  42909. <remarks>
  42910. Copies the specified message to the destination folder.
  42911. </remarks>
  42912. <param name="index">The index of the message to copy.</param>
  42913. <param name="destination">The destination folder.</param>
  42914. <param name="cancellationToken">The cancellation token.</param>
  42915. <exception cref="T:System.ArgumentNullException">
  42916. <paramref name="destination"/> is <c>null</c>.
  42917. </exception>
  42918. <exception cref="T:System.ArgumentOutOfRangeException">
  42919. <paramref name="index"/> does not refer to a valid message index.
  42920. </exception>
  42921. <exception cref="T:System.ArgumentException">
  42922. The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.
  42923. </exception>
  42924. <exception cref="T:System.ObjectDisposedException">
  42925. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  42926. </exception>
  42927. <exception cref="T:MailKit.ServiceNotConnectedException">
  42928. The <see cref="T:MailKit.IMailStore"/> is not connected.
  42929. </exception>
  42930. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  42931. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  42932. </exception>
  42933. <exception cref="T:MailKit.FolderNotOpenException">
  42934. The folder is not currently open.
  42935. </exception>
  42936. <exception cref="T:System.OperationCanceledException">
  42937. The operation was canceled via the cancellation token.
  42938. </exception>
  42939. <exception cref="T:System.IO.IOException">
  42940. An I/O error occurred.
  42941. </exception>
  42942. <exception cref="T:MailKit.ProtocolException">
  42943. The server's response contained unexpected tokens.
  42944. </exception>
  42945. <exception cref="T:MailKit.CommandException">
  42946. The command failed.
  42947. </exception>
  42948. </member>
  42949. <member name="M:MailKit.MailFolder.CopyToAsync(System.Int32,MailKit.IMailFolder,System.Threading.CancellationToken)">
  42950. <summary>
  42951. Asynchronously copy the specified message to the destination folder.
  42952. </summary>
  42953. <remarks>
  42954. Asynchronously copies the specified message to the destination folder.
  42955. </remarks>
  42956. <returns>An asynchronous task context.</returns>
  42957. <param name="index">The indexes of the message to copy.</param>
  42958. <param name="destination">The destination folder.</param>
  42959. <param name="cancellationToken">The cancellation token.</param>
  42960. <exception cref="T:System.ArgumentNullException">
  42961. <paramref name="destination"/> is <c>null</c>.
  42962. </exception>
  42963. <exception cref="T:System.ArgumentOutOfRangeException">
  42964. <paramref name="index"/> does not refer to a valid message index.
  42965. </exception>
  42966. <exception cref="T:System.ArgumentException">
  42967. The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.
  42968. </exception>
  42969. <exception cref="T:System.ObjectDisposedException">
  42970. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  42971. </exception>
  42972. <exception cref="T:MailKit.ServiceNotConnectedException">
  42973. The <see cref="T:MailKit.IMailStore"/> is not connected.
  42974. </exception>
  42975. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  42976. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  42977. </exception>
  42978. <exception cref="T:MailKit.FolderNotOpenException">
  42979. The folder is not currently open.
  42980. </exception>
  42981. <exception cref="T:System.OperationCanceledException">
  42982. The operation was canceled via the cancellation token.
  42983. </exception>
  42984. <exception cref="T:System.IO.IOException">
  42985. An I/O error occurred.
  42986. </exception>
  42987. <exception cref="T:MailKit.ProtocolException">
  42988. The server's response contained unexpected tokens.
  42989. </exception>
  42990. <exception cref="T:MailKit.CommandException">
  42991. The command failed.
  42992. </exception>
  42993. </member>
  42994. <member name="M:MailKit.MailFolder.CopyTo(System.Collections.Generic.IList{System.Int32},MailKit.IMailFolder,System.Threading.CancellationToken)">
  42995. <summary>
  42996. Copy the specified messages to the destination folder.
  42997. </summary>
  42998. <remarks>
  42999. Copies the specified messages to the destination folder.
  43000. </remarks>
  43001. <param name="indexes">The indexes of the messages to copy.</param>
  43002. <param name="destination">The destination folder.</param>
  43003. <param name="cancellationToken">The cancellation token.</param>
  43004. <exception cref="T:System.ArgumentNullException">
  43005. <para><paramref name="indexes"/> is <c>null</c>.</para>
  43006. <para>-or-</para>
  43007. <para><paramref name="destination"/> is <c>null</c>.</para>
  43008. </exception>
  43009. <exception cref="T:System.ArgumentException">
  43010. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  43011. <para>-or-</para>
  43012. <para>The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
  43013. </exception>
  43014. <exception cref="T:System.ObjectDisposedException">
  43015. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  43016. </exception>
  43017. <exception cref="T:MailKit.ServiceNotConnectedException">
  43018. The <see cref="T:MailKit.IMailStore"/> is not connected.
  43019. </exception>
  43020. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  43021. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  43022. </exception>
  43023. <exception cref="T:MailKit.FolderNotOpenException">
  43024. The folder is not currently open.
  43025. </exception>
  43026. <exception cref="T:System.OperationCanceledException">
  43027. The operation was canceled via the cancellation token.
  43028. </exception>
  43029. <exception cref="T:System.IO.IOException">
  43030. An I/O error occurred.
  43031. </exception>
  43032. <exception cref="T:MailKit.ProtocolException">
  43033. The server's response contained unexpected tokens.
  43034. </exception>
  43035. <exception cref="T:MailKit.CommandException">
  43036. The command failed.
  43037. </exception>
  43038. </member>
  43039. <member name="M:MailKit.MailFolder.CopyToAsync(System.Collections.Generic.IList{System.Int32},MailKit.IMailFolder,System.Threading.CancellationToken)">
  43040. <summary>
  43041. Asynchronously copy the specified messages to the destination folder.
  43042. </summary>
  43043. <remarks>
  43044. Asynchronously copies the specified messages to the destination folder.
  43045. </remarks>
  43046. <returns>An asynchronous task context.</returns>
  43047. <param name="indexes">The indexes of the messages to copy.</param>
  43048. <param name="destination">The destination folder.</param>
  43049. <param name="cancellationToken">The cancellation token.</param>
  43050. <exception cref="T:System.ArgumentNullException">
  43051. <para><paramref name="indexes"/> is <c>null</c>.</para>
  43052. <para>-or-</para>
  43053. <para><paramref name="destination"/> is <c>null</c>.</para>
  43054. </exception>
  43055. <exception cref="T:System.ArgumentException">
  43056. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  43057. <para>-or-</para>
  43058. <para>The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
  43059. </exception>
  43060. <exception cref="T:System.ObjectDisposedException">
  43061. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  43062. </exception>
  43063. <exception cref="T:MailKit.ServiceNotConnectedException">
  43064. The <see cref="T:MailKit.IMailStore"/> is not connected.
  43065. </exception>
  43066. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  43067. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  43068. </exception>
  43069. <exception cref="T:MailKit.FolderNotOpenException">
  43070. The folder is not currently open.
  43071. </exception>
  43072. <exception cref="T:System.OperationCanceledException">
  43073. The operation was canceled via the cancellation token.
  43074. </exception>
  43075. <exception cref="T:System.IO.IOException">
  43076. An I/O error occurred.
  43077. </exception>
  43078. <exception cref="T:MailKit.ProtocolException">
  43079. The server's response contained unexpected tokens.
  43080. </exception>
  43081. <exception cref="T:MailKit.CommandException">
  43082. The command failed.
  43083. </exception>
  43084. </member>
  43085. <member name="M:MailKit.MailFolder.MoveTo(System.Int32,MailKit.IMailFolder,System.Threading.CancellationToken)">
  43086. <summary>
  43087. Move the specified message to the destination folder.
  43088. </summary>
  43089. <remarks>
  43090. Moves the specified message to the destination folder.
  43091. </remarks>
  43092. <param name="index">The index of the message to move.</param>
  43093. <param name="destination">The destination folder.</param>
  43094. <param name="cancellationToken">The cancellation token.</param>
  43095. <exception cref="T:System.ArgumentNullException">
  43096. <paramref name="destination"/> is <c>null</c>.
  43097. </exception>
  43098. <exception cref="T:System.ArgumentOutOfRangeException">
  43099. <paramref name="index"/> does not refer to a valid message index.
  43100. </exception>
  43101. <exception cref="T:System.ArgumentException">
  43102. The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.
  43103. </exception>
  43104. <exception cref="T:System.ObjectDisposedException">
  43105. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  43106. </exception>
  43107. <exception cref="T:MailKit.ServiceNotConnectedException">
  43108. The <see cref="T:MailKit.IMailStore"/> is not connected.
  43109. </exception>
  43110. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  43111. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  43112. </exception>
  43113. <exception cref="T:MailKit.FolderNotOpenException">
  43114. The folder is not currently open in read-write mode.
  43115. </exception>
  43116. <exception cref="T:System.OperationCanceledException">
  43117. The operation was canceled via the cancellation token.
  43118. </exception>
  43119. <exception cref="T:System.IO.IOException">
  43120. An I/O error occurred.
  43121. </exception>
  43122. <exception cref="T:MailKit.ProtocolException">
  43123. The server's response contained unexpected tokens.
  43124. </exception>
  43125. <exception cref="T:MailKit.CommandException">
  43126. The command failed.
  43127. </exception>
  43128. </member>
  43129. <member name="M:MailKit.MailFolder.MoveToAsync(System.Int32,MailKit.IMailFolder,System.Threading.CancellationToken)">
  43130. <summary>
  43131. Asynchronously move the specified message to the destination folder.
  43132. </summary>
  43133. <remarks>
  43134. Asynchronously moves the specified message to the destination folder.
  43135. </remarks>
  43136. <returns>An asynchronous task context.</returns>
  43137. <param name="index">The index of the message to move.</param>
  43138. <param name="destination">The destination folder.</param>
  43139. <param name="cancellationToken">The cancellation token.</param>
  43140. <exception cref="T:System.ArgumentNullException">
  43141. <paramref name="destination"/> is <c>null</c>.
  43142. </exception>
  43143. <exception cref="T:System.ArgumentOutOfRangeException">
  43144. <paramref name="index"/> does not refer to a valid message index.
  43145. </exception>
  43146. <exception cref="T:System.ArgumentException">
  43147. The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.
  43148. </exception>
  43149. <exception cref="T:System.ObjectDisposedException">
  43150. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  43151. </exception>
  43152. <exception cref="T:MailKit.ServiceNotConnectedException">
  43153. The <see cref="T:MailKit.IMailStore"/> is not connected.
  43154. </exception>
  43155. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  43156. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  43157. </exception>
  43158. <exception cref="T:MailKit.FolderNotOpenException">
  43159. The folder is not currently open in read-write mode.
  43160. </exception>
  43161. <exception cref="T:System.OperationCanceledException">
  43162. The operation was canceled via the cancellation token.
  43163. </exception>
  43164. <exception cref="T:System.IO.IOException">
  43165. An I/O error occurred.
  43166. </exception>
  43167. <exception cref="T:MailKit.ProtocolException">
  43168. The server's response contained unexpected tokens.
  43169. </exception>
  43170. <exception cref="T:MailKit.CommandException">
  43171. The command failed.
  43172. </exception>
  43173. </member>
  43174. <member name="M:MailKit.MailFolder.MoveTo(System.Collections.Generic.IList{System.Int32},MailKit.IMailFolder,System.Threading.CancellationToken)">
  43175. <summary>
  43176. Move the specified messages to the destination folder.
  43177. </summary>
  43178. <remarks>
  43179. Moves the specified messages to the destination folder.
  43180. </remarks>
  43181. <param name="indexes">The indexes of the messages to move.</param>
  43182. <param name="destination">The destination folder.</param>
  43183. <param name="cancellationToken">The cancellation token.</param>
  43184. <exception cref="T:System.ArgumentNullException">
  43185. <para><paramref name="indexes"/> is <c>null</c>.</para>
  43186. <para>-or-</para>
  43187. <para><paramref name="destination"/> is <c>null</c>.</para>
  43188. </exception>
  43189. <exception cref="T:System.ArgumentException">
  43190. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  43191. <para>-or-</para>
  43192. <para>The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
  43193. </exception>
  43194. <exception cref="T:System.ObjectDisposedException">
  43195. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  43196. </exception>
  43197. <exception cref="T:MailKit.ServiceNotConnectedException">
  43198. The <see cref="T:MailKit.IMailStore"/> is not connected.
  43199. </exception>
  43200. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  43201. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  43202. </exception>
  43203. <exception cref="T:MailKit.FolderNotOpenException">
  43204. The folder is not currently open in read-write mode.
  43205. </exception>
  43206. <exception cref="T:System.OperationCanceledException">
  43207. The operation was canceled via the cancellation token.
  43208. </exception>
  43209. <exception cref="T:System.IO.IOException">
  43210. An I/O error occurred.
  43211. </exception>
  43212. <exception cref="T:MailKit.ProtocolException">
  43213. The server's response contained unexpected tokens.
  43214. </exception>
  43215. <exception cref="T:MailKit.CommandException">
  43216. The command failed.
  43217. </exception>
  43218. </member>
  43219. <member name="M:MailKit.MailFolder.MoveToAsync(System.Collections.Generic.IList{System.Int32},MailKit.IMailFolder,System.Threading.CancellationToken)">
  43220. <summary>
  43221. Asynchronously move the specified messages to the destination folder.
  43222. </summary>
  43223. <remarks>
  43224. Asynchronously moves the specified messages to the destination folder.
  43225. </remarks>
  43226. <returns>An asynchronous task context.</returns>
  43227. <param name="indexes">The indexes of the messages to move.</param>
  43228. <param name="destination">The destination folder.</param>
  43229. <param name="cancellationToken">The cancellation token.</param>
  43230. <exception cref="T:System.ArgumentNullException">
  43231. <para><paramref name="indexes"/> is <c>null</c>.</para>
  43232. <para>-or-</para>
  43233. <para><paramref name="destination"/> is <c>null</c>.</para>
  43234. </exception>
  43235. <exception cref="T:System.ArgumentException">
  43236. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  43237. <para>-or-</para>
  43238. <para>The destination folder does not belong to the <see cref="T:MailKit.IMailStore"/>.</para>
  43239. </exception>
  43240. <exception cref="T:System.ObjectDisposedException">
  43241. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  43242. </exception>
  43243. <exception cref="T:MailKit.ServiceNotConnectedException">
  43244. The <see cref="T:MailKit.IMailStore"/> is not connected.
  43245. </exception>
  43246. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  43247. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  43248. </exception>
  43249. <exception cref="T:MailKit.FolderNotOpenException">
  43250. The folder is not currently open in read-write mode.
  43251. </exception>
  43252. <exception cref="T:System.OperationCanceledException">
  43253. The operation was canceled via the cancellation token.
  43254. </exception>
  43255. <exception cref="T:System.IO.IOException">
  43256. An I/O error occurred.
  43257. </exception>
  43258. <exception cref="T:MailKit.ProtocolException">
  43259. The server's response contained unexpected tokens.
  43260. </exception>
  43261. <exception cref="T:MailKit.CommandException">
  43262. The command failed.
  43263. </exception>
  43264. </member>
  43265. <member name="M:MailKit.MailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
  43266. <summary>
  43267. Fetch the message summaries for the specified message UIDs.
  43268. </summary>
  43269. <remarks>
  43270. <para>Fetches the message summaries for the specified message UIDs.</para>
  43271. <para>It should be noted that if another client has modified any message
  43272. in the folder, the mail service may choose to return information that was
  43273. not explicitly requested. It is therefore important to be prepared to
  43274. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  43275. messages that were requested as well as summaries for messages that were
  43276. not requested at all.</para>
  43277. </remarks>
  43278. <example>
  43279. <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
  43280. </example>
  43281. <returns>An enumeration of summaries for the requested messages.</returns>
  43282. <param name="uids">The UIDs.</param>
  43283. <param name="items">The message summary items to fetch.</param>
  43284. <param name="cancellationToken">The cancellation token.</param>
  43285. <exception cref="T:System.ArgumentNullException">
  43286. <paramref name="uids"/> is <c>null</c>.
  43287. </exception>
  43288. <exception cref="T:System.ArgumentOutOfRangeException">
  43289. <paramref name="items"/> is empty.
  43290. </exception>
  43291. <exception cref="T:System.ArgumentException">
  43292. One or more of the <paramref name="uids"/> is invalid.
  43293. </exception>
  43294. <exception cref="T:System.ObjectDisposedException">
  43295. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  43296. </exception>
  43297. <exception cref="T:MailKit.ServiceNotConnectedException">
  43298. The <see cref="T:MailKit.IMailStore"/> is not connected.
  43299. </exception>
  43300. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  43301. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  43302. </exception>
  43303. <exception cref="T:MailKit.FolderNotOpenException">
  43304. The folder is not currently open.
  43305. </exception>
  43306. <exception cref="T:System.OperationCanceledException">
  43307. The operation was canceled via the cancellation token.
  43308. </exception>
  43309. <exception cref="T:System.IO.IOException">
  43310. An I/O error occurred.
  43311. </exception>
  43312. <exception cref="T:MailKit.ProtocolException">
  43313. The server's response contained unexpected tokens.
  43314. </exception>
  43315. <exception cref="T:MailKit.CommandException">
  43316. The command failed.
  43317. </exception>
  43318. </member>
  43319. <member name="M:MailKit.MailFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
  43320. <summary>
  43321. Asynchronously fetch the message summaries for the specified message UIDs.
  43322. </summary>
  43323. <remarks>
  43324. <para>Asynchronously fetches the message summaries for the specified message
  43325. UIDs.</para>
  43326. <para>It should be noted that if another client has modified any message
  43327. in the folder, the mail service may choose to return information that was
  43328. not explicitly requested. It is therefore important to be prepared to
  43329. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  43330. messages that were requested as well as summaries for messages that were
  43331. not requested at all.</para>
  43332. </remarks>
  43333. <returns>An enumeration of summaries for the requested messages.</returns>
  43334. <param name="uids">The UIDs.</param>
  43335. <param name="items">The message summary items to fetch.</param>
  43336. <param name="cancellationToken">The cancellation token.</param>
  43337. <exception cref="T:System.ArgumentNullException">
  43338. <paramref name="uids"/> is <c>null</c>.
  43339. </exception>
  43340. <exception cref="T:System.ArgumentOutOfRangeException">
  43341. <paramref name="items"/> is empty.
  43342. </exception>
  43343. <exception cref="T:System.ArgumentException">
  43344. One or more of the <paramref name="uids"/> is invalid.
  43345. </exception>
  43346. <exception cref="T:System.ObjectDisposedException">
  43347. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  43348. </exception>
  43349. <exception cref="T:MailKit.ServiceNotConnectedException">
  43350. The <see cref="T:MailKit.IMailStore"/> is not connected.
  43351. </exception>
  43352. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  43353. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  43354. </exception>
  43355. <exception cref="T:MailKit.FolderNotOpenException">
  43356. The folder is not currently open.
  43357. </exception>
  43358. <exception cref="T:System.OperationCanceledException">
  43359. The operation was canceled via the cancellation token.
  43360. </exception>
  43361. <exception cref="T:System.IO.IOException">
  43362. An I/O error occurred.
  43363. </exception>
  43364. <exception cref="T:MailKit.ProtocolException">
  43365. The server's response contained unexpected tokens.
  43366. </exception>
  43367. <exception cref="T:MailKit.CommandException">
  43368. The command failed.
  43369. </exception>
  43370. </member>
  43371. <member name="M:MailKit.MailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
  43372. <summary>
  43373. Fetch the message summaries for the specified message UIDs.
  43374. </summary>
  43375. <remarks>
  43376. <para>Fetches the message summaries for the specified message UIDs.</para>
  43377. <para>It should be noted that if another client has modified any message
  43378. in the folder, the mail service may choose to return information that was
  43379. not explicitly requested. It is therefore important to be prepared to
  43380. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  43381. messages that were requested as well as summaries for messages that were
  43382. not requested at all.</para>
  43383. </remarks>
  43384. <returns>An enumeration of summaries for the requested messages.</returns>
  43385. <param name="uids">The UIDs.</param>
  43386. <param name="items">The message summary items to fetch.</param>
  43387. <param name="headers">The desired header fields.</param>
  43388. <param name="cancellationToken">The cancellation token.</param>
  43389. <exception cref="T:System.ArgumentNullException">
  43390. <para><paramref name="uids"/> is <c>null</c>.</para>
  43391. <para>-or-</para>
  43392. <para><paramref name="headers"/> is <c>null</c>.</para>
  43393. </exception>
  43394. <exception cref="T:System.ArgumentException">
  43395. One or more of the <paramref name="uids"/> is invalid.
  43396. </exception>
  43397. <exception cref="T:System.ObjectDisposedException">
  43398. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  43399. </exception>
  43400. <exception cref="T:MailKit.ServiceNotConnectedException">
  43401. The <see cref="T:MailKit.IMailStore"/> is not connected.
  43402. </exception>
  43403. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  43404. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  43405. </exception>
  43406. <exception cref="T:MailKit.FolderNotOpenException">
  43407. The folder is not currently open.
  43408. </exception>
  43409. <exception cref="T:System.OperationCanceledException">
  43410. The operation was canceled via the cancellation token.
  43411. </exception>
  43412. <exception cref="T:System.IO.IOException">
  43413. An I/O error occurred.
  43414. </exception>
  43415. <exception cref="T:MailKit.ProtocolException">
  43416. The server's response contained unexpected tokens.
  43417. </exception>
  43418. <exception cref="T:MailKit.CommandException">
  43419. The command failed.
  43420. </exception>
  43421. </member>
  43422. <member name="M:MailKit.MailFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
  43423. <summary>
  43424. Asynchronously fetch the message summaries for the specified message UIDs.
  43425. </summary>
  43426. <remarks>
  43427. <para>Asynchronously fetches the message summaries for the specified message
  43428. UIDs.</para>
  43429. <para>It should be noted that if another client has modified any message
  43430. in the folder, the mail service may choose to return information that was
  43431. not explicitly requested. It is therefore important to be prepared to
  43432. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  43433. messages that were requested as well as summaries for messages that were
  43434. not requested at all.</para>
  43435. </remarks>
  43436. <returns>An enumeration of summaries for the requested messages.</returns>
  43437. <param name="uids">The UIDs.</param>
  43438. <param name="items">The message summary items to fetch.</param>
  43439. <param name="headers">The desired header fields.</param>
  43440. <param name="cancellationToken">The cancellation token.</param>
  43441. <exception cref="T:System.ArgumentNullException">
  43442. <para><paramref name="uids"/> is <c>null</c>.</para>
  43443. <para>-or-</para>
  43444. <para><paramref name="headers"/> is <c>null</c>.</para>
  43445. </exception>
  43446. <exception cref="T:System.ArgumentException">
  43447. One or more of the <paramref name="uids"/> is invalid.
  43448. </exception>
  43449. <exception cref="T:System.ObjectDisposedException">
  43450. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  43451. </exception>
  43452. <exception cref="T:MailKit.ServiceNotConnectedException">
  43453. The <see cref="T:MailKit.IMailStore"/> is not connected.
  43454. </exception>
  43455. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  43456. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  43457. </exception>
  43458. <exception cref="T:MailKit.FolderNotOpenException">
  43459. The folder is not currently open.
  43460. </exception>
  43461. <exception cref="T:System.OperationCanceledException">
  43462. The operation was canceled via the cancellation token.
  43463. </exception>
  43464. <exception cref="T:System.IO.IOException">
  43465. An I/O error occurred.
  43466. </exception>
  43467. <exception cref="T:MailKit.ProtocolException">
  43468. The server's response contained unexpected tokens.
  43469. </exception>
  43470. <exception cref="T:MailKit.CommandException">
  43471. The command failed.
  43472. </exception>
  43473. </member>
  43474. <member name="M:MailKit.MailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
  43475. <summary>
  43476. Fetch the message summaries for the specified message UIDs.
  43477. </summary>
  43478. <remarks>
  43479. <para>Fetches the message summaries for the specified message UIDs.</para>
  43480. <para>It should be noted that if another client has modified any message
  43481. in the folder, the mail service may choose to return information that was
  43482. not explicitly requested. It is therefore important to be prepared to
  43483. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  43484. messages that were requested as well as summaries for messages that were
  43485. not requested at all.</para>
  43486. </remarks>
  43487. <returns>An enumeration of summaries for the requested messages.</returns>
  43488. <param name="uids">The UIDs.</param>
  43489. <param name="items">The message summary items to fetch.</param>
  43490. <param name="headers">The desired header fields.</param>
  43491. <param name="cancellationToken">The cancellation token.</param>
  43492. <exception cref="T:System.ArgumentNullException">
  43493. <para><paramref name="uids"/> is <c>null</c>.</para>
  43494. <para>-or-</para>
  43495. <para><paramref name="headers"/> is <c>null</c>.</para>
  43496. </exception>
  43497. <exception cref="T:System.ArgumentException">
  43498. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  43499. <para>-or-</para>
  43500. <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
  43501. </exception>
  43502. <exception cref="T:System.ObjectDisposedException">
  43503. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  43504. </exception>
  43505. <exception cref="T:MailKit.ServiceNotConnectedException">
  43506. The <see cref="T:MailKit.IMailStore"/> is not connected.
  43507. </exception>
  43508. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  43509. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  43510. </exception>
  43511. <exception cref="T:MailKit.FolderNotOpenException">
  43512. The folder is not currently open.
  43513. </exception>
  43514. <exception cref="T:System.OperationCanceledException">
  43515. The operation was canceled via the cancellation token.
  43516. </exception>
  43517. <exception cref="T:System.IO.IOException">
  43518. An I/O error occurred.
  43519. </exception>
  43520. <exception cref="T:MailKit.ProtocolException">
  43521. The server's response contained unexpected tokens.
  43522. </exception>
  43523. <exception cref="T:MailKit.CommandException">
  43524. The command failed.
  43525. </exception>
  43526. </member>
  43527. <member name="M:MailKit.MailFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
  43528. <summary>
  43529. Asynchronously fetch the message summaries for the specified message UIDs.
  43530. </summary>
  43531. <remarks>
  43532. <para>Asynchronously fetches the message summaries for the specified message
  43533. UIDs.</para>
  43534. <para>It should be noted that if another client has modified any message
  43535. in the folder, the mail service may choose to return information that was
  43536. not explicitly requested. It is therefore important to be prepared to
  43537. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  43538. messages that were requested as well as summaries for messages that were
  43539. not requested at all.</para>
  43540. </remarks>
  43541. <returns>An enumeration of summaries for the requested messages.</returns>
  43542. <param name="uids">The UIDs.</param>
  43543. <param name="items">The message summary items to fetch.</param>
  43544. <param name="headers">The desired header fields.</param>
  43545. <param name="cancellationToken">The cancellation token.</param>
  43546. <exception cref="T:System.ArgumentNullException">
  43547. <para><paramref name="uids"/> is <c>null</c>.</para>
  43548. <para>-or-</para>
  43549. <para><paramref name="headers"/> is <c>null</c>.</para>
  43550. </exception>
  43551. <exception cref="T:System.ArgumentException">
  43552. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  43553. <para>-or-</para>
  43554. <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
  43555. </exception>
  43556. <exception cref="T:System.ObjectDisposedException">
  43557. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  43558. </exception>
  43559. <exception cref="T:MailKit.ServiceNotConnectedException">
  43560. The <see cref="T:MailKit.IMailStore"/> is not connected.
  43561. </exception>
  43562. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  43563. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  43564. </exception>
  43565. <exception cref="T:MailKit.FolderNotOpenException">
  43566. The folder is not currently open.
  43567. </exception>
  43568. <exception cref="T:System.OperationCanceledException">
  43569. The operation was canceled via the cancellation token.
  43570. </exception>
  43571. <exception cref="T:System.IO.IOException">
  43572. An I/O error occurred.
  43573. </exception>
  43574. <exception cref="T:MailKit.ProtocolException">
  43575. The server's response contained unexpected tokens.
  43576. </exception>
  43577. <exception cref="T:MailKit.CommandException">
  43578. The command failed.
  43579. </exception>
  43580. </member>
  43581. <member name="M:MailKit.MailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
  43582. <summary>
  43583. Fetch the message summaries for the specified message UIDs that have a
  43584. higher mod-sequence value than the one specified.
  43585. </summary>
  43586. <remarks>
  43587. <para>Fetches the message summaries for the specified message UIDs that
  43588. have a higher mod-sequence value than the one specified.</para>
  43589. <para>If the mail store supports quick resynchronization and the application has
  43590. enabled this feature via <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/>,
  43591. then this method will emit <see cref="E:MailKit.MailFolder.MessagesVanished"/> events for messages that
  43592. have vanished since the specified mod-sequence value.</para>
  43593. <para>It should be noted that if another client has modified any message
  43594. in the folder, the mail service may choose to return information that was
  43595. not explicitly requested. It is therefore important to be prepared to
  43596. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  43597. messages that were requested as well as summaries for messages that were
  43598. not requested at all.</para>
  43599. </remarks>
  43600. <returns>An enumeration of summaries for the requested messages.</returns>
  43601. <param name="uids">The UIDs.</param>
  43602. <param name="modseq">The mod-sequence value.</param>
  43603. <param name="items">The message summary items to fetch.</param>
  43604. <param name="cancellationToken">The cancellation token.</param>
  43605. <exception cref="T:System.ArgumentNullException">
  43606. <paramref name="uids"/> is <c>null</c>.
  43607. </exception>
  43608. <exception cref="T:System.ArgumentOutOfRangeException">
  43609. <paramref name="items"/> is empty.
  43610. </exception>
  43611. <exception cref="T:System.ArgumentException">
  43612. One or more of the <paramref name="uids"/> is invalid.
  43613. </exception>
  43614. <exception cref="T:System.ObjectDisposedException">
  43615. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  43616. </exception>
  43617. <exception cref="T:MailKit.ServiceNotConnectedException">
  43618. The <see cref="T:MailKit.IMailStore"/> is not connected.
  43619. </exception>
  43620. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  43621. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  43622. </exception>
  43623. <exception cref="T:MailKit.FolderNotOpenException">
  43624. The folder is not currently open.
  43625. </exception>
  43626. <exception cref="T:System.NotSupportedException">
  43627. The <see cref="T:MailKit.IMailStore"/> does not support mod-sequences.
  43628. </exception>
  43629. <exception cref="T:System.OperationCanceledException">
  43630. The operation was canceled via the cancellation token.
  43631. </exception>
  43632. <exception cref="T:System.IO.IOException">
  43633. An I/O error occurred.
  43634. </exception>
  43635. <exception cref="T:MailKit.ProtocolException">
  43636. The server's response contained unexpected tokens.
  43637. </exception>
  43638. <exception cref="T:MailKit.CommandException">
  43639. The command failed.
  43640. </exception>
  43641. </member>
  43642. <member name="M:MailKit.MailFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
  43643. <summary>
  43644. Asynchronously fetch the message summaries for the specified message UIDs that have a
  43645. higher mod-sequence value than the one specified.
  43646. </summary>
  43647. <remarks>
  43648. <para>Asynchronously fetches the message summaries for the specified message UIDs that
  43649. have a higher mod-sequence value than the one specified.</para>
  43650. <para>If the mail store supports quick resynchronization and the application has
  43651. enabled this feature via <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/>,
  43652. then this method will emit <see cref="E:MailKit.MailFolder.MessagesVanished"/> events for messages that
  43653. have vanished since the specified mod-sequence value.</para>
  43654. <para>It should be noted that if another client has modified any message
  43655. in the folder, the mail service may choose to return information that was
  43656. not explicitly requested. It is therefore important to be prepared to
  43657. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  43658. messages that were requested as well as summaries for messages that were
  43659. not requested at all.</para>
  43660. </remarks>
  43661. <returns>An enumeration of summaries for the requested messages.</returns>
  43662. <param name="uids">The UIDs.</param>
  43663. <param name="modseq">The mod-sequence value.</param>
  43664. <param name="items">The message summary items to fetch.</param>
  43665. <param name="cancellationToken">The cancellation token.</param>
  43666. <exception cref="T:System.ArgumentNullException">
  43667. <paramref name="uids"/> is <c>null</c>.
  43668. </exception>
  43669. <exception cref="T:System.ArgumentOutOfRangeException">
  43670. <paramref name="items"/> is empty.
  43671. </exception>
  43672. <exception cref="T:System.ArgumentException">
  43673. One or more of the <paramref name="uids"/> is invalid.
  43674. </exception>
  43675. <exception cref="T:System.ObjectDisposedException">
  43676. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  43677. </exception>
  43678. <exception cref="T:MailKit.ServiceNotConnectedException">
  43679. The <see cref="T:MailKit.IMailStore"/> is not connected.
  43680. </exception>
  43681. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  43682. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  43683. </exception>
  43684. <exception cref="T:MailKit.FolderNotOpenException">
  43685. The folder is not currently open.
  43686. </exception>
  43687. <exception cref="T:System.NotSupportedException">
  43688. The <see cref="T:MailKit.IMailStore"/> does not support mod-sequences.
  43689. </exception>
  43690. <exception cref="T:System.OperationCanceledException">
  43691. The operation was canceled via the cancellation token.
  43692. </exception>
  43693. <exception cref="T:System.IO.IOException">
  43694. An I/O error occurred.
  43695. </exception>
  43696. <exception cref="T:MailKit.ProtocolException">
  43697. The server's response contained unexpected tokens.
  43698. </exception>
  43699. <exception cref="T:MailKit.CommandException">
  43700. The command failed.
  43701. </exception>
  43702. </member>
  43703. <member name="M:MailKit.MailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
  43704. <summary>
  43705. Fetch the message summaries for the specified message UIDs that have a
  43706. higher mod-sequence value than the one specified.
  43707. </summary>
  43708. <remarks>
  43709. <para>Fetches the message summaries for the specified message UIDs that
  43710. have a higher mod-sequence value than the one specified.</para>
  43711. <para>If the mail store supports quick resynchronization and the application has
  43712. enabled this feature via <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/>,
  43713. then this method will emit <see cref="E:MailKit.MailFolder.MessagesVanished"/> events for messages that
  43714. have vanished since the specified mod-sequence value.</para>
  43715. <para>It should be noted that if another client has modified any message
  43716. in the folder, the mail service may choose to return information that was
  43717. not explicitly requested. It is therefore important to be prepared to
  43718. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  43719. messages that were requested as well as summaries for messages that were
  43720. not requested at all.</para>
  43721. </remarks>
  43722. <returns>An enumeration of summaries for the requested messages.</returns>
  43723. <param name="uids">The UIDs.</param>
  43724. <param name="modseq">The mod-sequence value.</param>
  43725. <param name="items">The message summary items to fetch.</param>
  43726. <param name="headers">The desired header fields.</param>
  43727. <param name="cancellationToken">The cancellation token.</param>
  43728. <exception cref="T:System.ArgumentNullException">
  43729. <para><paramref name="uids"/> is <c>null</c>.</para>
  43730. <para>-or-</para>
  43731. <para><paramref name="headers"/> is <c>null</c>.</para>
  43732. </exception>
  43733. <exception cref="T:System.ArgumentException">
  43734. One or more of the <paramref name="uids"/> is invalid.
  43735. </exception>
  43736. <exception cref="T:System.ObjectDisposedException">
  43737. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  43738. </exception>
  43739. <exception cref="T:MailKit.ServiceNotConnectedException">
  43740. The <see cref="T:MailKit.IMailStore"/> is not connected.
  43741. </exception>
  43742. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  43743. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  43744. </exception>
  43745. <exception cref="T:MailKit.FolderNotOpenException">
  43746. The folder is not currently open.
  43747. </exception>
  43748. <exception cref="T:System.NotSupportedException">
  43749. The <see cref="T:MailKit.IMailStore"/> does not support mod-sequences.
  43750. </exception>
  43751. <exception cref="T:System.OperationCanceledException">
  43752. The operation was canceled via the cancellation token.
  43753. </exception>
  43754. <exception cref="T:System.IO.IOException">
  43755. An I/O error occurred.
  43756. </exception>
  43757. <exception cref="T:MailKit.ProtocolException">
  43758. The server's response contained unexpected tokens.
  43759. </exception>
  43760. <exception cref="T:MailKit.CommandException">
  43761. The command failed.
  43762. </exception>
  43763. </member>
  43764. <member name="M:MailKit.MailFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
  43765. <summary>
  43766. Asynchronously fetch the message summaries for the specified message UIDs that have a
  43767. higher mod-sequence value than the one specified.
  43768. </summary>
  43769. <remarks>
  43770. <para>Asynchronously fetches the message summaries for the specified message UIDs that
  43771. have a higher mod-sequence value than the one specified.</para>
  43772. <para>If the mail store supports quick resynchronization and the application has
  43773. enabled this feature via <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/>,
  43774. then this method will emit <see cref="E:MailKit.MailFolder.MessagesVanished"/> events for messages that
  43775. have vanished since the specified mod-sequence value.</para>
  43776. <para>It should be noted that if another client has modified any message
  43777. in the folder, the mail service may choose to return information that was
  43778. not explicitly requested. It is therefore important to be prepared to
  43779. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  43780. messages that were requested as well as summaries for messages that were
  43781. not requested at all.</para>
  43782. </remarks>
  43783. <returns>An enumeration of summaries for the requested messages.</returns>
  43784. <param name="uids">The UIDs.</param>
  43785. <param name="modseq">The mod-sequence value.</param>
  43786. <param name="items">The message summary items to fetch.</param>
  43787. <param name="headers">The desired header fields.</param>
  43788. <param name="cancellationToken">The cancellation token.</param>
  43789. <exception cref="T:System.ArgumentNullException">
  43790. <para><paramref name="uids"/> is <c>null</c>.</para>
  43791. <para>-or-</para>
  43792. <para><paramref name="headers"/> is <c>null</c>.</para>
  43793. </exception>
  43794. <exception cref="T:System.ArgumentException">
  43795. One or more of the <paramref name="uids"/> is invalid.
  43796. </exception>
  43797. <exception cref="T:System.ObjectDisposedException">
  43798. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  43799. </exception>
  43800. <exception cref="T:MailKit.ServiceNotConnectedException">
  43801. The <see cref="T:MailKit.IMailStore"/> is not connected.
  43802. </exception>
  43803. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  43804. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  43805. </exception>
  43806. <exception cref="T:MailKit.FolderNotOpenException">
  43807. The folder is not currently open.
  43808. </exception>
  43809. <exception cref="T:System.NotSupportedException">
  43810. The <see cref="T:MailKit.IMailStore"/> does not support mod-sequences.
  43811. </exception>
  43812. <exception cref="T:System.OperationCanceledException">
  43813. The operation was canceled via the cancellation token.
  43814. </exception>
  43815. <exception cref="T:System.IO.IOException">
  43816. An I/O error occurred.
  43817. </exception>
  43818. <exception cref="T:MailKit.ProtocolException">
  43819. The server's response contained unexpected tokens.
  43820. </exception>
  43821. <exception cref="T:MailKit.CommandException">
  43822. The command failed.
  43823. </exception>
  43824. </member>
  43825. <member name="M:MailKit.MailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
  43826. <summary>
  43827. Fetch the message summaries for the specified message UIDs that have a
  43828. higher mod-sequence value than the one specified.
  43829. </summary>
  43830. <remarks>
  43831. <para>Fetches the message summaries for the specified message UIDs that
  43832. have a higher mod-sequence value than the one specified.</para>
  43833. <para>If the mail store supports quick resynchronization and the application has
  43834. enabled this feature via <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/>,
  43835. then this method will emit <see cref="E:MailKit.MailFolder.MessagesVanished"/> events for messages that
  43836. have vanished since the specified mod-sequence value.</para>
  43837. <para>It should be noted that if another client has modified any message
  43838. in the folder, the mail service may choose to return information that was
  43839. not explicitly requested. It is therefore important to be prepared to
  43840. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  43841. messages that were requested as well as summaries for messages that were
  43842. not requested at all.</para>
  43843. </remarks>
  43844. <returns>An enumeration of summaries for the requested messages.</returns>
  43845. <param name="uids">The UIDs.</param>
  43846. <param name="modseq">The mod-sequence value.</param>
  43847. <param name="items">The message summary items to fetch.</param>
  43848. <param name="headers">The desired header fields.</param>
  43849. <param name="cancellationToken">The cancellation token.</param>
  43850. <exception cref="T:System.ArgumentNullException">
  43851. <para><paramref name="uids"/> is <c>null</c>.</para>
  43852. <para>-or-</para>
  43853. <para><paramref name="headers"/> is <c>null</c>.</para>
  43854. </exception>
  43855. <exception cref="T:System.ArgumentException">
  43856. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  43857. <para>-or-</para>
  43858. <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
  43859. </exception>
  43860. <exception cref="T:System.ObjectDisposedException">
  43861. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  43862. </exception>
  43863. <exception cref="T:MailKit.ServiceNotConnectedException">
  43864. The <see cref="T:MailKit.IMailStore"/> is not connected.
  43865. </exception>
  43866. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  43867. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  43868. </exception>
  43869. <exception cref="T:MailKit.FolderNotOpenException">
  43870. The folder is not currently open.
  43871. </exception>
  43872. <exception cref="T:System.NotSupportedException">
  43873. The <see cref="T:MailKit.IMailStore"/> does not support mod-sequences.
  43874. </exception>
  43875. <exception cref="T:System.OperationCanceledException">
  43876. The operation was canceled via the cancellation token.
  43877. </exception>
  43878. <exception cref="T:System.IO.IOException">
  43879. An I/O error occurred.
  43880. </exception>
  43881. <exception cref="T:MailKit.ProtocolException">
  43882. The server's response contained unexpected tokens.
  43883. </exception>
  43884. <exception cref="T:MailKit.CommandException">
  43885. The command failed.
  43886. </exception>
  43887. </member>
  43888. <member name="M:MailKit.MailFolder.FetchAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
  43889. <summary>
  43890. Asynchronously fetch the message summaries for the specified message UIDs that have a
  43891. higher mod-sequence value than the one specified.
  43892. </summary>
  43893. <remarks>
  43894. <para>Asynchronously fetches the message summaries for the specified message UIDs that
  43895. have a higher mod-sequence value than the one specified.</para>
  43896. <para>If the mail store supports quick resynchronization and the application has
  43897. enabled this feature via <see cref="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)"/>,
  43898. then this method will emit <see cref="E:MailKit.MailFolder.MessagesVanished"/> events for messages that
  43899. have vanished since the specified mod-sequence value.</para>
  43900. <para>It should be noted that if another client has modified any message
  43901. in the folder, the mail service may choose to return information that was
  43902. not explicitly requested. It is therefore important to be prepared to
  43903. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  43904. messages that were requested as well as summaries for messages that were
  43905. not requested at all.</para>
  43906. </remarks>
  43907. <returns>An enumeration of summaries for the requested messages.</returns>
  43908. <param name="uids">The UIDs.</param>
  43909. <param name="modseq">The mod-sequence value.</param>
  43910. <param name="items">The message summary items to fetch.</param>
  43911. <param name="headers">The desired header fields.</param>
  43912. <param name="cancellationToken">The cancellation token.</param>
  43913. <exception cref="T:System.ArgumentNullException">
  43914. <para><paramref name="uids"/> is <c>null</c>.</para>
  43915. <para>-or-</para>
  43916. <para><paramref name="headers"/> is <c>null</c>.</para>
  43917. </exception>
  43918. <exception cref="T:System.ArgumentException">
  43919. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  43920. <para>-or-</para>
  43921. <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
  43922. </exception>
  43923. <exception cref="T:System.ObjectDisposedException">
  43924. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  43925. </exception>
  43926. <exception cref="T:MailKit.ServiceNotConnectedException">
  43927. The <see cref="T:MailKit.IMailStore"/> is not connected.
  43928. </exception>
  43929. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  43930. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  43931. </exception>
  43932. <exception cref="T:MailKit.FolderNotOpenException">
  43933. The folder is not currently open.
  43934. </exception>
  43935. <exception cref="T:System.NotSupportedException">
  43936. The <see cref="T:MailKit.IMailStore"/> does not support mod-sequences.
  43937. </exception>
  43938. <exception cref="T:System.OperationCanceledException">
  43939. The operation was canceled via the cancellation token.
  43940. </exception>
  43941. <exception cref="T:System.IO.IOException">
  43942. An I/O error occurred.
  43943. </exception>
  43944. <exception cref="T:MailKit.ProtocolException">
  43945. The server's response contained unexpected tokens.
  43946. </exception>
  43947. <exception cref="T:MailKit.CommandException">
  43948. The command failed.
  43949. </exception>
  43950. </member>
  43951. <member name="M:MailKit.MailFolder.Fetch(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
  43952. <summary>
  43953. Fetch the message summaries for the specified message indexes.
  43954. </summary>
  43955. <remarks>
  43956. <para>Fetches the message summaries for the specified message indexes.</para>
  43957. <para>It should be noted that if another client has modified any message
  43958. in the folder, the mail service may choose to return information that was
  43959. not explicitly requested. It is therefore important to be prepared to
  43960. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  43961. messages that were requested as well as summaries for messages that were
  43962. not requested at all.</para>
  43963. </remarks>
  43964. <returns>An enumeration of summaries for the requested messages.</returns>
  43965. <param name="indexes">The indexes.</param>
  43966. <param name="items">The message summary items to fetch.</param>
  43967. <param name="cancellationToken">The cancellation token.</param>
  43968. <exception cref="T:System.ArgumentNullException">
  43969. <paramref name="indexes"/> is <c>null</c>.
  43970. </exception>
  43971. <exception cref="T:System.ArgumentOutOfRangeException">
  43972. <paramref name="items"/> is empty.
  43973. </exception>
  43974. <exception cref="T:System.ArgumentException">
  43975. One or more of the <paramref name="indexes"/> is invalid.
  43976. </exception>
  43977. <exception cref="T:System.ObjectDisposedException">
  43978. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  43979. </exception>
  43980. <exception cref="T:MailKit.ServiceNotConnectedException">
  43981. The <see cref="T:MailKit.IMailStore"/> is not connected.
  43982. </exception>
  43983. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  43984. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  43985. </exception>
  43986. <exception cref="T:MailKit.FolderNotOpenException">
  43987. The folder is not currently open.
  43988. </exception>
  43989. <exception cref="T:System.OperationCanceledException">
  43990. The operation was canceled via the cancellation token.
  43991. </exception>
  43992. <exception cref="T:System.IO.IOException">
  43993. An I/O error occurred.
  43994. </exception>
  43995. <exception cref="T:MailKit.ProtocolException">
  43996. The server's response contained unexpected tokens.
  43997. </exception>
  43998. <exception cref="T:MailKit.CommandException">
  43999. The command failed.
  44000. </exception>
  44001. </member>
  44002. <member name="M:MailKit.MailFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
  44003. <summary>
  44004. Asynchronously fetch the message summaries for the specified message indexes.
  44005. </summary>
  44006. <remarks>
  44007. <para>Asynchronously fetches the message summaries for the specified message
  44008. indexes.</para>
  44009. <para>It should be noted that if another client has modified any message
  44010. in the folder, the mail service may choose to return information that was
  44011. not explicitly requested. It is therefore important to be prepared to
  44012. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  44013. messages that were requested as well as summaries for messages that were
  44014. not requested at all.</para>
  44015. </remarks>
  44016. <returns>An enumeration of summaries for the requested messages.</returns>
  44017. <param name="indexes">The indexes.</param>
  44018. <param name="items">The message summary items to fetch.</param>
  44019. <param name="cancellationToken">The cancellation token.</param>
  44020. <exception cref="T:System.ArgumentNullException">
  44021. <paramref name="indexes"/> is <c>null</c>.
  44022. </exception>
  44023. <exception cref="T:System.ArgumentOutOfRangeException">
  44024. <paramref name="items"/> is empty.
  44025. </exception>
  44026. <exception cref="T:System.ArgumentException">
  44027. One or more of the <paramref name="indexes"/> is invalid.
  44028. </exception>
  44029. <exception cref="T:System.ObjectDisposedException">
  44030. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  44031. </exception>
  44032. <exception cref="T:MailKit.ServiceNotConnectedException">
  44033. The <see cref="T:MailKit.IMailStore"/> is not connected.
  44034. </exception>
  44035. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  44036. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  44037. </exception>
  44038. <exception cref="T:MailKit.FolderNotOpenException">
  44039. The folder is not currently open.
  44040. </exception>
  44041. <exception cref="T:System.OperationCanceledException">
  44042. The operation was canceled via the cancellation token.
  44043. </exception>
  44044. <exception cref="T:System.IO.IOException">
  44045. An I/O error occurred.
  44046. </exception>
  44047. <exception cref="T:MailKit.ProtocolException">
  44048. The server's response contained unexpected tokens.
  44049. </exception>
  44050. <exception cref="T:MailKit.CommandException">
  44051. The command failed.
  44052. </exception>
  44053. </member>
  44054. <member name="M:MailKit.MailFolder.Fetch(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
  44055. <summary>
  44056. Fetch the message summaries for the specified message indexes.
  44057. </summary>
  44058. <remarks>
  44059. <para>Fetches the message summaries for the specified message indexes.</para>
  44060. <para>It should be noted that if another client has modified any message
  44061. in the folder, the mail service may choose to return information that was
  44062. not explicitly requested. It is therefore important to be prepared to
  44063. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  44064. messages that were requested as well as summaries for messages that were
  44065. not requested at all.</para>
  44066. </remarks>
  44067. <returns>An enumeration of summaries for the requested messages.</returns>
  44068. <param name="indexes">The indexes.</param>
  44069. <param name="items">The message summary items to fetch.</param>
  44070. <param name="headers">The desired header fields.</param>
  44071. <param name="cancellationToken">The cancellation token.</param>
  44072. <exception cref="T:System.ArgumentNullException">
  44073. <para><paramref name="indexes"/> is <c>null</c>.</para>
  44074. <para>-or-</para>
  44075. <para><paramref name="headers"/> is <c>null</c>.</para>
  44076. </exception>
  44077. <exception cref="T:System.ArgumentException">
  44078. One or more of the <paramref name="indexes"/> is invalid.
  44079. </exception>
  44080. <exception cref="T:System.ObjectDisposedException">
  44081. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  44082. </exception>
  44083. <exception cref="T:MailKit.ServiceNotConnectedException">
  44084. The <see cref="T:MailKit.IMailStore"/> is not connected.
  44085. </exception>
  44086. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  44087. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  44088. </exception>
  44089. <exception cref="T:MailKit.FolderNotOpenException">
  44090. The folder is not currently open.
  44091. </exception>
  44092. <exception cref="T:System.OperationCanceledException">
  44093. The operation was canceled via the cancellation token.
  44094. </exception>
  44095. <exception cref="T:System.IO.IOException">
  44096. An I/O error occurred.
  44097. </exception>
  44098. <exception cref="T:MailKit.ProtocolException">
  44099. The server's response contained unexpected tokens.
  44100. </exception>
  44101. <exception cref="T:MailKit.CommandException">
  44102. The command failed.
  44103. </exception>
  44104. </member>
  44105. <member name="M:MailKit.MailFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
  44106. <summary>
  44107. Asynchronously fetch the message summaries for the specified message indexes.
  44108. </summary>
  44109. <remarks>
  44110. <para>Asynchronously fetches the message summaries for the specified message
  44111. indexes.</para>
  44112. <para>It should be noted that if another client has modified any message
  44113. in the folder, the mail service may choose to return information that was
  44114. not explicitly requested. It is therefore important to be prepared to
  44115. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  44116. messages that were requested as well as summaries for messages that were
  44117. not requested at all.</para>
  44118. </remarks>
  44119. <returns>An enumeration of summaries for the requested messages.</returns>
  44120. <param name="indexes">The indexes.</param>
  44121. <param name="items">The message summary items to fetch.</param>
  44122. <param name="headers">The desired header fields.</param>
  44123. <param name="cancellationToken">The cancellation token.</param>
  44124. <exception cref="T:System.ArgumentNullException">
  44125. <para><paramref name="indexes"/> is <c>null</c>.</para>
  44126. <para>-or-</para>
  44127. <para><paramref name="headers"/> is <c>null</c>.</para>
  44128. </exception>
  44129. <exception cref="T:System.ArgumentException">
  44130. One or more of the <paramref name="indexes"/> is invalid.
  44131. </exception>
  44132. <exception cref="T:System.ObjectDisposedException">
  44133. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  44134. </exception>
  44135. <exception cref="T:MailKit.ServiceNotConnectedException">
  44136. The <see cref="T:MailKit.IMailStore"/> is not connected.
  44137. </exception>
  44138. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  44139. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  44140. </exception>
  44141. <exception cref="T:MailKit.FolderNotOpenException">
  44142. The folder is not currently open.
  44143. </exception>
  44144. <exception cref="T:System.OperationCanceledException">
  44145. The operation was canceled via the cancellation token.
  44146. </exception>
  44147. <exception cref="T:System.IO.IOException">
  44148. An I/O error occurred.
  44149. </exception>
  44150. <exception cref="T:MailKit.ProtocolException">
  44151. The server's response contained unexpected tokens.
  44152. </exception>
  44153. <exception cref="T:MailKit.CommandException">
  44154. The command failed.
  44155. </exception>
  44156. </member>
  44157. <member name="M:MailKit.MailFolder.Fetch(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
  44158. <summary>
  44159. Fetch the message summaries for the specified message indexes.
  44160. </summary>
  44161. <remarks>
  44162. <para>Fetches the message summaries for the specified message indexes.</para>
  44163. <para>It should be noted that if another client has modified any message
  44164. in the folder, the mail service may choose to return information that was
  44165. not explicitly requested. It is therefore important to be prepared to
  44166. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  44167. messages that were requested as well as summaries for messages that were
  44168. not requested at all.</para>
  44169. </remarks>
  44170. <returns>An enumeration of summaries for the requested messages.</returns>
  44171. <param name="indexes">The indexes.</param>
  44172. <param name="items">The message summary items to fetch.</param>
  44173. <param name="headers">The desired header fields.</param>
  44174. <param name="cancellationToken">The cancellation token.</param>
  44175. <exception cref="T:System.ArgumentNullException">
  44176. <para><paramref name="indexes"/> is <c>null</c>.</para>
  44177. <para>-or-</para>
  44178. <para><paramref name="headers"/> is <c>null</c>.</para>
  44179. </exception>
  44180. <exception cref="T:System.ArgumentException">
  44181. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  44182. <para>-or-</para>
  44183. <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
  44184. </exception>
  44185. <exception cref="T:System.ObjectDisposedException">
  44186. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  44187. </exception>
  44188. <exception cref="T:MailKit.ServiceNotConnectedException">
  44189. The <see cref="T:MailKit.IMailStore"/> is not connected.
  44190. </exception>
  44191. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  44192. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  44193. </exception>
  44194. <exception cref="T:MailKit.FolderNotOpenException">
  44195. The folder is not currently open.
  44196. </exception>
  44197. <exception cref="T:System.OperationCanceledException">
  44198. The operation was canceled via the cancellation token.
  44199. </exception>
  44200. <exception cref="T:System.IO.IOException">
  44201. An I/O error occurred.
  44202. </exception>
  44203. <exception cref="T:MailKit.ProtocolException">
  44204. The server's response contained unexpected tokens.
  44205. </exception>
  44206. <exception cref="T:MailKit.CommandException">
  44207. The command failed.
  44208. </exception>
  44209. </member>
  44210. <member name="M:MailKit.MailFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
  44211. <summary>
  44212. Asynchronously fetch the message summaries for the specified message indexes.
  44213. </summary>
  44214. <remarks>
  44215. <para>Asynchronously fetches the message summaries for the specified message
  44216. indexes.</para>
  44217. <para>It should be noted that if another client has modified any message
  44218. in the folder, the mail service may choose to return information that was
  44219. not explicitly requested. It is therefore important to be prepared to
  44220. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  44221. messages that were requested as well as summaries for messages that were
  44222. not requested at all.</para>
  44223. </remarks>
  44224. <returns>An enumeration of summaries for the requested messages.</returns>
  44225. <param name="indexes">The indexes.</param>
  44226. <param name="items">The message summary items to fetch.</param>
  44227. <param name="headers">The desired header fields.</param>
  44228. <param name="cancellationToken">The cancellation token.</param>
  44229. <exception cref="T:System.ArgumentNullException">
  44230. <para><paramref name="indexes"/> is <c>null</c>.</para>
  44231. <para>-or-</para>
  44232. <para><paramref name="headers"/> is <c>null</c>.</para>
  44233. </exception>
  44234. <exception cref="T:System.ArgumentException">
  44235. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  44236. <para>-or-</para>
  44237. <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
  44238. </exception>
  44239. <exception cref="T:System.ObjectDisposedException">
  44240. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  44241. </exception>
  44242. <exception cref="T:MailKit.ServiceNotConnectedException">
  44243. The <see cref="T:MailKit.IMailStore"/> is not connected.
  44244. </exception>
  44245. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  44246. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  44247. </exception>
  44248. <exception cref="T:MailKit.FolderNotOpenException">
  44249. The folder is not currently open.
  44250. </exception>
  44251. <exception cref="T:System.OperationCanceledException">
  44252. The operation was canceled via the cancellation token.
  44253. </exception>
  44254. <exception cref="T:System.IO.IOException">
  44255. An I/O error occurred.
  44256. </exception>
  44257. <exception cref="T:MailKit.ProtocolException">
  44258. The server's response contained unexpected tokens.
  44259. </exception>
  44260. <exception cref="T:MailKit.CommandException">
  44261. The command failed.
  44262. </exception>
  44263. </member>
  44264. <member name="M:MailKit.MailFolder.Fetch(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
  44265. <summary>
  44266. Fetch the message summaries for the specified message indexes that have a
  44267. higher mod-sequence value than the one specified.
  44268. </summary>
  44269. <remarks>
  44270. <para>Fetches the message summaries for the specified message indexes that
  44271. have a higher mod-sequence value than the one specified.</para>
  44272. <para>It should be noted that if another client has modified any message
  44273. in the folder, the mail service may choose to return information that was
  44274. not explicitly requested. It is therefore important to be prepared to
  44275. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  44276. messages that were requested as well as summaries for messages that were
  44277. not requested at all.</para>
  44278. </remarks>
  44279. <returns>An enumeration of summaries for the requested messages.</returns>
  44280. <param name="indexes">The indexes.</param>
  44281. <param name="modseq">The mod-sequence value.</param>
  44282. <param name="items">The message summary items to fetch.</param>
  44283. <param name="cancellationToken">The cancellation token.</param>
  44284. <exception cref="T:System.ArgumentNullException">
  44285. <paramref name="indexes"/> is <c>null</c>.
  44286. </exception>
  44287. <exception cref="T:System.ArgumentOutOfRangeException">
  44288. <paramref name="items"/> is empty.
  44289. </exception>
  44290. <exception cref="T:System.ArgumentException">
  44291. One or more of the <paramref name="indexes"/> is invalid.
  44292. </exception>
  44293. <exception cref="T:System.ObjectDisposedException">
  44294. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  44295. </exception>
  44296. <exception cref="T:MailKit.ServiceNotConnectedException">
  44297. The <see cref="T:MailKit.IMailStore"/> is not connected.
  44298. </exception>
  44299. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  44300. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  44301. </exception>
  44302. <exception cref="T:MailKit.FolderNotOpenException">
  44303. The folder is not currently open.
  44304. </exception>
  44305. <exception cref="T:System.NotSupportedException">
  44306. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  44307. </exception>
  44308. <exception cref="T:System.OperationCanceledException">
  44309. The operation was canceled via the cancellation token.
  44310. </exception>
  44311. <exception cref="T:System.IO.IOException">
  44312. An I/O error occurred.
  44313. </exception>
  44314. <exception cref="T:MailKit.ProtocolException">
  44315. The server's response contained unexpected tokens.
  44316. </exception>
  44317. <exception cref="T:MailKit.CommandException">
  44318. The command failed.
  44319. </exception>
  44320. </member>
  44321. <member name="M:MailKit.MailFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
  44322. <summary>
  44323. Asynchronously fetch the message summaries for the specified message indexes that
  44324. have a higher mod-sequence value than the one specified.
  44325. </summary>
  44326. <remarks>
  44327. <para>Asynchronously fetches the message summaries for the specified message
  44328. indexes that have a higher mod-sequence value than the one specified.</para>
  44329. <para>It should be noted that if another client has modified any message
  44330. in the folder, the mail service may choose to return information that was
  44331. not explicitly requested. It is therefore important to be prepared to
  44332. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  44333. messages that were requested as well as summaries for messages that were
  44334. not requested at all.</para>
  44335. </remarks>
  44336. <returns>An enumeration of summaries for the requested messages.</returns>
  44337. <param name="indexes">The indexes.</param>
  44338. <param name="modseq">The mod-sequence value.</param>
  44339. <param name="items">The message summary items to fetch.</param>
  44340. <param name="cancellationToken">The cancellation token.</param>
  44341. <exception cref="T:System.ArgumentNullException">
  44342. <paramref name="indexes"/> is <c>null</c>.
  44343. </exception>
  44344. <exception cref="T:System.ArgumentOutOfRangeException">
  44345. <paramref name="items"/> is empty.
  44346. </exception>
  44347. <exception cref="T:System.ArgumentException">
  44348. One or more of the <paramref name="indexes"/> is invalid.
  44349. </exception>
  44350. <exception cref="T:System.ObjectDisposedException">
  44351. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  44352. </exception>
  44353. <exception cref="T:MailKit.ServiceNotConnectedException">
  44354. The <see cref="T:MailKit.IMailStore"/> is not connected.
  44355. </exception>
  44356. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  44357. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  44358. </exception>
  44359. <exception cref="T:MailKit.FolderNotOpenException">
  44360. The folder is not currently open.
  44361. </exception>
  44362. <exception cref="T:System.NotSupportedException">
  44363. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  44364. </exception>
  44365. <exception cref="T:System.OperationCanceledException">
  44366. The operation was canceled via the cancellation token.
  44367. </exception>
  44368. <exception cref="T:System.IO.IOException">
  44369. An I/O error occurred.
  44370. </exception>
  44371. <exception cref="T:MailKit.ProtocolException">
  44372. The server's response contained unexpected tokens.
  44373. </exception>
  44374. <exception cref="T:MailKit.CommandException">
  44375. The command failed.
  44376. </exception>
  44377. </member>
  44378. <member name="M:MailKit.MailFolder.Fetch(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
  44379. <summary>
  44380. Fetch the message summaries for the specified message indexes that
  44381. have a higher mod-sequence value than the one specified.
  44382. </summary>
  44383. <remarks>
  44384. <para>Fetches the message summaries for the specified message indexes that
  44385. have a higher mod-sequence value than the one specified.</para>
  44386. <para>It should be noted that if another client has modified any message
  44387. in the folder, the mail service may choose to return information that was
  44388. not explicitly requested. It is therefore important to be prepared to
  44389. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  44390. messages that were requested as well as summaries for messages that were
  44391. not requested at all.</para>
  44392. </remarks>
  44393. <returns>An enumeration of summaries for the requested messages.</returns>
  44394. <param name="indexes">The indexes.</param>
  44395. <param name="modseq">The mod-sequence value.</param>
  44396. <param name="items">The message summary items to fetch.</param>
  44397. <param name="headers">The desired header fields.</param>
  44398. <param name="cancellationToken">The cancellation token.</param>
  44399. <exception cref="T:System.ArgumentNullException">
  44400. <para><paramref name="indexes"/> is <c>null</c>.</para>
  44401. <para>-or-</para>
  44402. <para><paramref name="headers"/> is <c>null</c>.</para>
  44403. </exception>
  44404. <exception cref="T:System.ArgumentException">
  44405. One or more of the <paramref name="indexes"/> is invalid.
  44406. </exception>
  44407. <exception cref="T:System.ObjectDisposedException">
  44408. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  44409. </exception>
  44410. <exception cref="T:MailKit.ServiceNotConnectedException">
  44411. The <see cref="T:MailKit.IMailStore"/> is not connected.
  44412. </exception>
  44413. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  44414. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  44415. </exception>
  44416. <exception cref="T:MailKit.FolderNotOpenException">
  44417. The folder is not currently open.
  44418. </exception>
  44419. <exception cref="T:System.OperationCanceledException">
  44420. The operation was canceled via the cancellation token.
  44421. </exception>
  44422. <exception cref="T:System.IO.IOException">
  44423. An I/O error occurred.
  44424. </exception>
  44425. <exception cref="T:MailKit.ProtocolException">
  44426. The server's response contained unexpected tokens.
  44427. </exception>
  44428. <exception cref="T:MailKit.CommandException">
  44429. The command failed.
  44430. </exception>
  44431. </member>
  44432. <member name="M:MailKit.MailFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
  44433. <summary>
  44434. Asynchronously fetch the message summaries for the specified message indexes that
  44435. have a higher mod-sequence value than the one specified.
  44436. </summary>
  44437. <remarks>
  44438. <para>Asynchronously fetches the message summaries for the specified message
  44439. indexes that have a higher mod-sequence value than the one specified.</para>
  44440. <para>It should be noted that if another client has modified any message
  44441. in the folder, the mail service may choose to return information that was
  44442. not explicitly requested. It is therefore important to be prepared to
  44443. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  44444. messages that were requested as well as summaries for messages that were
  44445. not requested at all.</para>
  44446. </remarks>
  44447. <returns>An enumeration of summaries for the requested messages.</returns>
  44448. <param name="indexes">The indexes.</param>
  44449. <param name="modseq">The mod-sequence value.</param>
  44450. <param name="items">The message summary items to fetch.</param>
  44451. <param name="headers">The desired header fields.</param>
  44452. <param name="cancellationToken">The cancellation token.</param>
  44453. <exception cref="T:System.ArgumentNullException">
  44454. <para><paramref name="indexes"/> is <c>null</c>.</para>
  44455. <para>-or-</para>
  44456. <para><paramref name="headers"/> is <c>null</c>.</para>
  44457. </exception>
  44458. <exception cref="T:System.ArgumentException">
  44459. One or more of the <paramref name="indexes"/> is invalid.
  44460. </exception>
  44461. <exception cref="T:System.ObjectDisposedException">
  44462. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  44463. </exception>
  44464. <exception cref="T:MailKit.ServiceNotConnectedException">
  44465. The <see cref="T:MailKit.IMailStore"/> is not connected.
  44466. </exception>
  44467. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  44468. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  44469. </exception>
  44470. <exception cref="T:MailKit.FolderNotOpenException">
  44471. The folder is not currently open.
  44472. </exception>
  44473. <exception cref="T:System.OperationCanceledException">
  44474. The operation was canceled via the cancellation token.
  44475. </exception>
  44476. <exception cref="T:System.IO.IOException">
  44477. An I/O error occurred.
  44478. </exception>
  44479. <exception cref="T:MailKit.ProtocolException">
  44480. The server's response contained unexpected tokens.
  44481. </exception>
  44482. <exception cref="T:MailKit.CommandException">
  44483. The command failed.
  44484. </exception>
  44485. </member>
  44486. <member name="M:MailKit.MailFolder.Fetch(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
  44487. <summary>
  44488. Fetch the message summaries for the specified message indexes that
  44489. have a higher mod-sequence value than the one specified.
  44490. </summary>
  44491. <remarks>
  44492. <para>Fetches the message summaries for the specified message indexes that
  44493. have a higher mod-sequence value than the one specified.</para>
  44494. <para>It should be noted that if another client has modified any message
  44495. in the folder, the mail service may choose to return information that was
  44496. not explicitly requested. It is therefore important to be prepared to
  44497. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  44498. messages that were requested as well as summaries for messages that were
  44499. not requested at all.</para>
  44500. </remarks>
  44501. <returns>An enumeration of summaries for the requested messages.</returns>
  44502. <param name="indexes">The indexes.</param>
  44503. <param name="modseq">The mod-sequence value.</param>
  44504. <param name="items">The message summary items to fetch.</param>
  44505. <param name="headers">The desired header fields.</param>
  44506. <param name="cancellationToken">The cancellation token.</param>
  44507. <exception cref="T:System.ArgumentNullException">
  44508. <para><paramref name="indexes"/> is <c>null</c>.</para>
  44509. <para>-or-</para>
  44510. <para><paramref name="headers"/> is <c>null</c>.</para>
  44511. </exception>
  44512. <exception cref="T:System.ArgumentException">
  44513. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  44514. <para>-or-</para>
  44515. <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
  44516. </exception>
  44517. <exception cref="T:System.ObjectDisposedException">
  44518. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  44519. </exception>
  44520. <exception cref="T:MailKit.ServiceNotConnectedException">
  44521. The <see cref="T:MailKit.IMailStore"/> is not connected.
  44522. </exception>
  44523. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  44524. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  44525. </exception>
  44526. <exception cref="T:MailKit.FolderNotOpenException">
  44527. The folder is not currently open.
  44528. </exception>
  44529. <exception cref="T:System.OperationCanceledException">
  44530. The operation was canceled via the cancellation token.
  44531. </exception>
  44532. <exception cref="T:System.IO.IOException">
  44533. An I/O error occurred.
  44534. </exception>
  44535. <exception cref="T:MailKit.ProtocolException">
  44536. The server's response contained unexpected tokens.
  44537. </exception>
  44538. <exception cref="T:MailKit.CommandException">
  44539. The command failed.
  44540. </exception>
  44541. </member>
  44542. <member name="M:MailKit.MailFolder.FetchAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
  44543. <summary>
  44544. Asynchronously fetch the message summaries for the specified message indexes that
  44545. have a higher mod-sequence value than the one specified.
  44546. </summary>
  44547. <remarks>
  44548. <para>Asynchronously fetches the message summaries for the specified message
  44549. indexes that have a higher mod-sequence value than the one specified.</para>
  44550. <para>It should be noted that if another client has modified any message
  44551. in the folder, the mail service may choose to return information that was
  44552. not explicitly requested. It is therefore important to be prepared to
  44553. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  44554. messages that were requested as well as summaries for messages that were
  44555. not requested at all.</para>
  44556. </remarks>
  44557. <returns>An enumeration of summaries for the requested messages.</returns>
  44558. <param name="indexes">The indexes.</param>
  44559. <param name="modseq">The mod-sequence value.</param>
  44560. <param name="items">The message summary items to fetch.</param>
  44561. <param name="headers">The desired header fields.</param>
  44562. <param name="cancellationToken">The cancellation token.</param>
  44563. <exception cref="T:System.ArgumentNullException">
  44564. <para><paramref name="indexes"/> is <c>null</c>.</para>
  44565. <para>-or-</para>
  44566. <para><paramref name="headers"/> is <c>null</c>.</para>
  44567. </exception>
  44568. <exception cref="T:System.ArgumentException">
  44569. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  44570. <para>-or-</para>
  44571. <para>One or more of the specified <paramref name="headers"/> is invalid.</para>
  44572. </exception>
  44573. <exception cref="T:System.ObjectDisposedException">
  44574. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  44575. </exception>
  44576. <exception cref="T:MailKit.ServiceNotConnectedException">
  44577. The <see cref="T:MailKit.IMailStore"/> is not connected.
  44578. </exception>
  44579. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  44580. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  44581. </exception>
  44582. <exception cref="T:MailKit.FolderNotOpenException">
  44583. The folder is not currently open.
  44584. </exception>
  44585. <exception cref="T:System.OperationCanceledException">
  44586. The operation was canceled via the cancellation token.
  44587. </exception>
  44588. <exception cref="T:System.IO.IOException">
  44589. An I/O error occurred.
  44590. </exception>
  44591. <exception cref="T:MailKit.ProtocolException">
  44592. The server's response contained unexpected tokens.
  44593. </exception>
  44594. <exception cref="T:MailKit.CommandException">
  44595. The command failed.
  44596. </exception>
  44597. </member>
  44598. <member name="M:MailKit.MailFolder.Fetch(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
  44599. <summary>
  44600. Fetch the message summaries for the messages between the two indexes, inclusive.
  44601. </summary>
  44602. <remarks>
  44603. <para>Fetches the message summaries for the messages between the two
  44604. indexes, inclusive.</para>
  44605. <para>It should be noted that if another client has modified any message
  44606. in the folder, the mail service may choose to return information that was
  44607. not explicitly requested. It is therefore important to be prepared to
  44608. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  44609. messages that were requested as well as summaries for messages that were
  44610. not requested at all.</para>
  44611. </remarks>
  44612. <returns>An enumeration of summaries for the requested messages.</returns>
  44613. <param name="min">The minimum index.</param>
  44614. <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
  44615. <param name="items">The message summary items to fetch.</param>
  44616. <param name="cancellationToken">The cancellation token.</param>
  44617. <exception cref="T:System.ArgumentOutOfRangeException">
  44618. <para><paramref name="min"/> is out of range.</para>
  44619. <para>-or-</para>
  44620. <para><paramref name="max"/> is out of range.</para>
  44621. <para>-or-</para>
  44622. <para><paramref name="items"/> is empty.</para>
  44623. </exception>
  44624. <exception cref="T:System.ObjectDisposedException">
  44625. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  44626. </exception>
  44627. <exception cref="T:MailKit.ServiceNotConnectedException">
  44628. The <see cref="T:MailKit.IMailStore"/> is not connected.
  44629. </exception>
  44630. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  44631. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  44632. </exception>
  44633. <exception cref="T:MailKit.FolderNotOpenException">
  44634. The folder is not currently open.
  44635. </exception>
  44636. <exception cref="T:System.OperationCanceledException">
  44637. The operation was canceled via the cancellation token.
  44638. </exception>
  44639. <exception cref="T:System.IO.IOException">
  44640. An I/O error occurred.
  44641. </exception>
  44642. <exception cref="T:MailKit.ProtocolException">
  44643. The server's response contained unexpected tokens.
  44644. </exception>
  44645. <exception cref="T:MailKit.CommandException">
  44646. The command failed.
  44647. </exception>
  44648. </member>
  44649. <member name="M:MailKit.MailFolder.FetchAsync(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
  44650. <summary>
  44651. Asynchronously fetch the message summaries for the messages between the two indexes, inclusive.
  44652. </summary>
  44653. <remarks>
  44654. <para>Asynchronously fetches the message summaries for the messages between
  44655. the two indexes, inclusive.</para>
  44656. <para>It should be noted that if another client has modified any message
  44657. in the folder, the mail service may choose to return information that was
  44658. not explicitly requested. It is therefore important to be prepared to
  44659. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  44660. messages that were requested as well as summaries for messages that were
  44661. not requested at all.</para>
  44662. </remarks>
  44663. <returns>An enumeration of summaries for the requested messages.</returns>
  44664. <param name="min">The minimum index.</param>
  44665. <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
  44666. <param name="items">The message summary items to fetch.</param>
  44667. <param name="cancellationToken">The cancellation token.</param>
  44668. <exception cref="T:System.ArgumentOutOfRangeException">
  44669. <para><paramref name="min"/> is out of range.</para>
  44670. <para>-or-</para>
  44671. <para><paramref name="max"/> is out of range.</para>
  44672. <para>-or-</para>
  44673. <para><paramref name="items"/> is empty.</para>
  44674. </exception>
  44675. <exception cref="T:System.ObjectDisposedException">
  44676. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  44677. </exception>
  44678. <exception cref="T:MailKit.ServiceNotConnectedException">
  44679. The <see cref="T:MailKit.IMailStore"/> is not connected.
  44680. </exception>
  44681. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  44682. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  44683. </exception>
  44684. <exception cref="T:MailKit.FolderNotOpenException">
  44685. The folder is not currently open.
  44686. </exception>
  44687. <exception cref="T:System.OperationCanceledException">
  44688. The operation was canceled via the cancellation token.
  44689. </exception>
  44690. <exception cref="T:System.IO.IOException">
  44691. An I/O error occurred.
  44692. </exception>
  44693. <exception cref="T:MailKit.ProtocolException">
  44694. The server's response contained unexpected tokens.
  44695. </exception>
  44696. <exception cref="T:MailKit.CommandException">
  44697. The command failed.
  44698. </exception>
  44699. </member>
  44700. <member name="M:MailKit.MailFolder.Fetch(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
  44701. <summary>
  44702. Fetch the message summaries for the messages between the two indexes, inclusive.
  44703. </summary>
  44704. <remarks>
  44705. <para>Fetches the message summaries for the messages between the two
  44706. indexes, inclusive.</para>
  44707. <para>It should be noted that if another client has modified any message
  44708. in the folder, the mail service may choose to return information that was
  44709. not explicitly requested. It is therefore important to be prepared to
  44710. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  44711. messages that were requested as well as summaries for messages that were
  44712. not requested at all.</para>
  44713. </remarks>
  44714. <returns>An enumeration of summaries for the requested messages.</returns>
  44715. <param name="min">The minimum index.</param>
  44716. <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
  44717. <param name="items">The message summary items to fetch.</param>
  44718. <param name="headers">The desired header fields.</param>
  44719. <param name="cancellationToken">The cancellation token.</param>
  44720. <exception cref="T:System.ArgumentOutOfRangeException">
  44721. <para><paramref name="min"/> is out of range.</para>
  44722. <para>-or-</para>
  44723. <para><paramref name="max"/> is out of range.</para>
  44724. </exception>
  44725. <exception cref="T:System.ArgumentNullException">
  44726. <paramref name="headers"/> is <c>null</c>.
  44727. </exception>
  44728. <exception cref="T:System.ObjectDisposedException">
  44729. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  44730. </exception>
  44731. <exception cref="T:MailKit.ServiceNotConnectedException">
  44732. The <see cref="T:MailKit.IMailStore"/> is not connected.
  44733. </exception>
  44734. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  44735. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  44736. </exception>
  44737. <exception cref="T:MailKit.FolderNotOpenException">
  44738. The folder is not currently open.
  44739. </exception>
  44740. <exception cref="T:System.OperationCanceledException">
  44741. The operation was canceled via the cancellation token.
  44742. </exception>
  44743. <exception cref="T:System.IO.IOException">
  44744. An I/O error occurred.
  44745. </exception>
  44746. <exception cref="T:MailKit.ProtocolException">
  44747. The server's response contained unexpected tokens.
  44748. </exception>
  44749. <exception cref="T:MailKit.CommandException">
  44750. The command failed.
  44751. </exception>
  44752. </member>
  44753. <member name="M:MailKit.MailFolder.FetchAsync(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
  44754. <summary>
  44755. Asynchronously fetch the message summaries for the messages between the two indexes, inclusive.
  44756. </summary>
  44757. <remarks>
  44758. <para>Asynchronously fetches the message summaries for the messages between
  44759. the two indexes, inclusive.</para>
  44760. <para>It should be noted that if another client has modified any message
  44761. in the folder, the mail service may choose to return information that was
  44762. not explicitly requested. It is therefore important to be prepared to
  44763. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  44764. messages that were requested as well as summaries for messages that were
  44765. not requested at all.</para>
  44766. </remarks>
  44767. <returns>An enumeration of summaries for the requested messages.</returns>
  44768. <param name="min">The minimum index.</param>
  44769. <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
  44770. <param name="items">The message summary items to fetch.</param>
  44771. <param name="headers">The desired header fields.</param>
  44772. <param name="cancellationToken">The cancellation token.</param>
  44773. <exception cref="T:System.ArgumentOutOfRangeException">
  44774. <para><paramref name="min"/> is out of range.</para>
  44775. <para>-or-</para>
  44776. <para><paramref name="max"/> is out of range.</para>
  44777. </exception>
  44778. <exception cref="T:System.ArgumentNullException">
  44779. <paramref name="headers"/> is <c>null</c>.
  44780. </exception>
  44781. <exception cref="T:System.ObjectDisposedException">
  44782. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  44783. </exception>
  44784. <exception cref="T:MailKit.ServiceNotConnectedException">
  44785. The <see cref="T:MailKit.IMailStore"/> is not connected.
  44786. </exception>
  44787. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  44788. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  44789. </exception>
  44790. <exception cref="T:MailKit.FolderNotOpenException">
  44791. The folder is not currently open.
  44792. </exception>
  44793. <exception cref="T:System.OperationCanceledException">
  44794. The operation was canceled via the cancellation token.
  44795. </exception>
  44796. <exception cref="T:System.IO.IOException">
  44797. An I/O error occurred.
  44798. </exception>
  44799. <exception cref="T:MailKit.ProtocolException">
  44800. The server's response contained unexpected tokens.
  44801. </exception>
  44802. <exception cref="T:MailKit.CommandException">
  44803. The command failed.
  44804. </exception>
  44805. </member>
  44806. <member name="M:MailKit.MailFolder.Fetch(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
  44807. <summary>
  44808. Fetch the message summaries for the messages between the two indexes, inclusive.
  44809. </summary>
  44810. <remarks>
  44811. <para>Fetches the message summaries for the messages between the two
  44812. indexes, inclusive.</para>
  44813. <para>It should be noted that if another client has modified any message
  44814. in the folder, the mail service may choose to return information that was
  44815. not explicitly requested. It is therefore important to be prepared to
  44816. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  44817. messages that were requested as well as summaries for messages that were
  44818. not requested at all.</para>
  44819. </remarks>
  44820. <returns>An enumeration of summaries for the requested messages.</returns>
  44821. <param name="min">The minimum index.</param>
  44822. <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
  44823. <param name="items">The message summary items to fetch.</param>
  44824. <param name="headers">The desired header fields.</param>
  44825. <param name="cancellationToken">The cancellation token.</param>
  44826. <exception cref="T:System.ArgumentOutOfRangeException">
  44827. <para><paramref name="min"/> is out of range.</para>
  44828. <para>-or-</para>
  44829. <para><paramref name="max"/> is out of range.</para>
  44830. </exception>
  44831. <exception cref="T:System.ArgumentNullException">
  44832. <paramref name="headers"/> is <c>null</c>.
  44833. </exception>
  44834. <exception cref="T:System.ArgumentException">
  44835. One or more of the specified <paramref name="headers"/> is invalid.
  44836. </exception>
  44837. <exception cref="T:System.ObjectDisposedException">
  44838. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  44839. </exception>
  44840. <exception cref="T:MailKit.ServiceNotConnectedException">
  44841. The <see cref="T:MailKit.IMailStore"/> is not connected.
  44842. </exception>
  44843. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  44844. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  44845. </exception>
  44846. <exception cref="T:MailKit.FolderNotOpenException">
  44847. The folder is not currently open.
  44848. </exception>
  44849. <exception cref="T:System.OperationCanceledException">
  44850. The operation was canceled via the cancellation token.
  44851. </exception>
  44852. <exception cref="T:System.IO.IOException">
  44853. An I/O error occurred.
  44854. </exception>
  44855. <exception cref="T:MailKit.ProtocolException">
  44856. The server's response contained unexpected tokens.
  44857. </exception>
  44858. <exception cref="T:MailKit.CommandException">
  44859. The command failed.
  44860. </exception>
  44861. </member>
  44862. <member name="M:MailKit.MailFolder.FetchAsync(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
  44863. <summary>
  44864. Asynchronously fetch the message summaries for the messages between the two indexes, inclusive.
  44865. </summary>
  44866. <remarks>
  44867. <para>Asynchronously fetches the message summaries for the messages between
  44868. the two indexes, inclusive.</para>
  44869. <para>It should be noted that if another client has modified any message
  44870. in the folder, the mail service may choose to return information that was
  44871. not explicitly requested. It is therefore important to be prepared to
  44872. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  44873. messages that were requested as well as summaries for messages that were
  44874. not requested at all.</para>
  44875. </remarks>
  44876. <returns>An enumeration of summaries for the requested messages.</returns>
  44877. <param name="min">The minimum index.</param>
  44878. <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
  44879. <param name="items">The message summary items to fetch.</param>
  44880. <param name="headers">The desired header fields.</param>
  44881. <param name="cancellationToken">The cancellation token.</param>
  44882. <exception cref="T:System.ArgumentOutOfRangeException">
  44883. <para><paramref name="min"/> is out of range.</para>
  44884. <para>-or-</para>
  44885. <para><paramref name="max"/> is out of range.</para>
  44886. </exception>
  44887. <exception cref="T:System.ArgumentNullException">
  44888. <paramref name="headers"/> is <c>null</c>.
  44889. </exception>
  44890. <exception cref="T:System.ArgumentException">
  44891. One or more of the specified <paramref name="headers"/> is invalid.
  44892. </exception>
  44893. <exception cref="T:System.ObjectDisposedException">
  44894. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  44895. </exception>
  44896. <exception cref="T:MailKit.ServiceNotConnectedException">
  44897. The <see cref="T:MailKit.IMailStore"/> is not connected.
  44898. </exception>
  44899. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  44900. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  44901. </exception>
  44902. <exception cref="T:MailKit.FolderNotOpenException">
  44903. The folder is not currently open.
  44904. </exception>
  44905. <exception cref="T:System.OperationCanceledException">
  44906. The operation was canceled via the cancellation token.
  44907. </exception>
  44908. <exception cref="T:System.IO.IOException">
  44909. An I/O error occurred.
  44910. </exception>
  44911. <exception cref="T:MailKit.ProtocolException">
  44912. The server's response contained unexpected tokens.
  44913. </exception>
  44914. <exception cref="T:MailKit.CommandException">
  44915. The command failed.
  44916. </exception>
  44917. </member>
  44918. <member name="M:MailKit.MailFolder.Fetch(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
  44919. <summary>
  44920. Fetch the message summaries for the messages between the two indexes (inclusive)
  44921. that have a higher mod-sequence value than the one specified.
  44922. </summary>
  44923. <remarks>
  44924. <para>Fetches the message summaries for the messages between the two
  44925. indexes (inclusive) that have a higher mod-sequence value than the one
  44926. specified.</para>
  44927. <para>It should be noted that if another client has modified any message
  44928. in the folder, the mail service may choose to return information that was
  44929. not explicitly requested. It is therefore important to be prepared to
  44930. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  44931. messages that were requested as well as summaries for messages that were
  44932. not requested at all.</para>
  44933. </remarks>
  44934. <returns>An enumeration of summaries for the requested messages.</returns>
  44935. <param name="min">The minimum index.</param>
  44936. <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
  44937. <param name="modseq">The mod-sequence value.</param>
  44938. <param name="items">The message summary items to fetch.</param>
  44939. <param name="cancellationToken">The cancellation token.</param>
  44940. <exception cref="T:System.ArgumentOutOfRangeException">
  44941. <para><paramref name="min"/> is out of range.</para>
  44942. <para>-or-</para>
  44943. <para><paramref name="max"/> is out of range.</para>
  44944. <para>-or-</para>
  44945. <para><paramref name="items"/> is empty.</para>
  44946. </exception>
  44947. <exception cref="T:System.ObjectDisposedException">
  44948. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  44949. </exception>
  44950. <exception cref="T:MailKit.ServiceNotConnectedException">
  44951. The <see cref="T:MailKit.IMailStore"/> is not connected.
  44952. </exception>
  44953. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  44954. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  44955. </exception>
  44956. <exception cref="T:MailKit.FolderNotOpenException">
  44957. The folder is not currently open.
  44958. </exception>
  44959. <exception cref="T:System.NotSupportedException">
  44960. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  44961. </exception>
  44962. <exception cref="T:System.OperationCanceledException">
  44963. The operation was canceled via the cancellation token.
  44964. </exception>
  44965. <exception cref="T:System.IO.IOException">
  44966. An I/O error occurred.
  44967. </exception>
  44968. <exception cref="T:MailKit.ProtocolException">
  44969. The server's response contained unexpected tokens.
  44970. </exception>
  44971. <exception cref="T:MailKit.CommandException">
  44972. The command failed.
  44973. </exception>
  44974. </member>
  44975. <member name="M:MailKit.MailFolder.FetchAsync(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Threading.CancellationToken)">
  44976. <summary>
  44977. Asynchronously fetch the message summaries for the messages between the two indexes
  44978. (inclusive) that have a higher mod-sequence value than the one specified.
  44979. </summary>
  44980. <remarks>
  44981. <para>Asynchronously fetches the message summaries for the messages between
  44982. the two indexes (inclusive) that have a higher mod-sequence value than the
  44983. one specified.</para>
  44984. <para>It should be noted that if another client has modified any message
  44985. in the folder, the mail service may choose to return information that was
  44986. not explicitly requested. It is therefore important to be prepared to
  44987. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  44988. messages that were requested as well as summaries for messages that were
  44989. not requested at all.</para>
  44990. </remarks>
  44991. <returns>An enumeration of summaries for the requested messages.</returns>
  44992. <param name="min">The minimum index.</param>
  44993. <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
  44994. <param name="modseq">The mod-sequence value.</param>
  44995. <param name="items">The message summary items to fetch.</param>
  44996. <param name="cancellationToken">The cancellation token.</param>
  44997. <exception cref="T:System.ArgumentOutOfRangeException">
  44998. <para><paramref name="min"/> is out of range.</para>
  44999. <para>-or-</para>
  45000. <para><paramref name="max"/> is out of range.</para>
  45001. <para>-or-</para>
  45002. <para><paramref name="items"/> is empty.</para>
  45003. </exception>
  45004. <exception cref="T:System.ObjectDisposedException">
  45005. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  45006. </exception>
  45007. <exception cref="T:MailKit.ServiceNotConnectedException">
  45008. The <see cref="T:MailKit.IMailStore"/> is not connected.
  45009. </exception>
  45010. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  45011. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  45012. </exception>
  45013. <exception cref="T:MailKit.FolderNotOpenException">
  45014. The folder is not currently open.
  45015. </exception>
  45016. <exception cref="T:System.NotSupportedException">
  45017. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  45018. </exception>
  45019. <exception cref="T:System.OperationCanceledException">
  45020. The operation was canceled via the cancellation token.
  45021. </exception>
  45022. <exception cref="T:System.IO.IOException">
  45023. An I/O error occurred.
  45024. </exception>
  45025. <exception cref="T:MailKit.ProtocolException">
  45026. The server's response contained unexpected tokens.
  45027. </exception>
  45028. <exception cref="T:MailKit.CommandException">
  45029. The command failed.
  45030. </exception>
  45031. </member>
  45032. <member name="M:MailKit.MailFolder.Fetch(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
  45033. <summary>
  45034. Fetch the message summaries for the messages between the two indexes (inclusive)
  45035. that have a higher mod-sequence value than the one specified.
  45036. </summary>
  45037. <remarks>
  45038. <para>Fetches the message summaries for the messages between the two
  45039. indexes (inclusive) that have a higher mod-sequence value than the one
  45040. specified.</para>
  45041. <para>It should be noted that if another client has modified any message
  45042. in the folder, the mail service may choose to return information that was
  45043. not explicitly requested. It is therefore important to be prepared to
  45044. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  45045. messages that were requested as well as summaries for messages that were
  45046. not requested at all.</para>
  45047. </remarks>
  45048. <returns>An enumeration of summaries for the requested messages.</returns>
  45049. <param name="min">The minimum index.</param>
  45050. <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
  45051. <param name="modseq">The mod-sequence value.</param>
  45052. <param name="items">The message summary items to fetch.</param>
  45053. <param name="headers">The desired header fields.</param>
  45054. <param name="cancellationToken">The cancellation token.</param>
  45055. <exception cref="T:System.ArgumentOutOfRangeException">
  45056. <para><paramref name="min"/> is out of range.</para>
  45057. <para>-or-</para>
  45058. <para><paramref name="max"/> is out of range.</para>
  45059. </exception>
  45060. <exception cref="T:System.ArgumentNullException">
  45061. <paramref name="headers"/> is <c>null</c>.
  45062. </exception>
  45063. <exception cref="T:System.ObjectDisposedException">
  45064. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  45065. </exception>
  45066. <exception cref="T:MailKit.ServiceNotConnectedException">
  45067. The <see cref="T:MailKit.IMailStore"/> is not connected.
  45068. </exception>
  45069. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  45070. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  45071. </exception>
  45072. <exception cref="T:MailKit.FolderNotOpenException">
  45073. The folder is not currently open.
  45074. </exception>
  45075. <exception cref="T:System.NotSupportedException">
  45076. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  45077. </exception>
  45078. <exception cref="T:System.OperationCanceledException">
  45079. The operation was canceled via the cancellation token.
  45080. </exception>
  45081. <exception cref="T:System.IO.IOException">
  45082. An I/O error occurred.
  45083. </exception>
  45084. <exception cref="T:MailKit.ProtocolException">
  45085. The server's response contained unexpected tokens.
  45086. </exception>
  45087. <exception cref="T:MailKit.CommandException">
  45088. The command failed.
  45089. </exception>
  45090. </member>
  45091. <member name="M:MailKit.MailFolder.FetchAsync(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)">
  45092. <summary>
  45093. Asynchronously fetch the message summaries for the messages between the two indexes
  45094. (inclusive) that have a higher mod-sequence value than the one specified.
  45095. </summary>
  45096. <remarks>
  45097. <para>Asynchronously fetches the message summaries for the messages between
  45098. the two indexes (inclusive) that have a higher mod-sequence value than the
  45099. one specified.</para>
  45100. <para>It should be noted that if another client has modified any message
  45101. in the folder, the mail service may choose to return information that was
  45102. not explicitly requested. It is therefore important to be prepared to
  45103. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  45104. messages that were requested as well as summaries for messages that were
  45105. not requested at all.</para>
  45106. </remarks>
  45107. <returns>An enumeration of summaries for the requested messages.</returns>
  45108. <param name="min">The minimum index.</param>
  45109. <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
  45110. <param name="modseq">The mod-sequence value.</param>
  45111. <param name="items">The message summary items to fetch.</param>
  45112. <param name="headers">The desired header fields.</param>
  45113. <param name="cancellationToken">The cancellation token.</param>
  45114. <exception cref="T:System.ArgumentOutOfRangeException">
  45115. <para><paramref name="min"/> is out of range.</para>
  45116. <para>-or-</para>
  45117. <para><paramref name="max"/> is out of range.</para>
  45118. </exception>
  45119. <exception cref="T:System.ArgumentNullException">
  45120. <paramref name="headers"/> is <c>null</c>.
  45121. </exception>
  45122. <exception cref="T:System.ObjectDisposedException">
  45123. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  45124. </exception>
  45125. <exception cref="T:MailKit.ServiceNotConnectedException">
  45126. The <see cref="T:MailKit.IMailStore"/> is not connected.
  45127. </exception>
  45128. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  45129. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  45130. </exception>
  45131. <exception cref="T:MailKit.FolderNotOpenException">
  45132. The folder is not currently open.
  45133. </exception>
  45134. <exception cref="T:System.NotSupportedException">
  45135. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  45136. </exception>
  45137. <exception cref="T:System.OperationCanceledException">
  45138. The operation was canceled via the cancellation token.
  45139. </exception>
  45140. <exception cref="T:System.IO.IOException">
  45141. An I/O error occurred.
  45142. </exception>
  45143. <exception cref="T:MailKit.ProtocolException">
  45144. The server's response contained unexpected tokens.
  45145. </exception>
  45146. <exception cref="T:MailKit.CommandException">
  45147. The command failed.
  45148. </exception>
  45149. </member>
  45150. <member name="M:MailKit.MailFolder.Fetch(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
  45151. <summary>
  45152. Fetch the message summaries for the messages between the two indexes (inclusive)
  45153. that have a higher mod-sequence value than the one specified.
  45154. </summary>
  45155. <remarks>
  45156. <para>Fetches the message summaries for the messages between the two
  45157. indexes (inclusive) that have a higher mod-sequence value than the one
  45158. specified.</para>
  45159. <para>It should be noted that if another client has modified any message
  45160. in the folder, the mail service may choose to return information that was
  45161. not explicitly requested. It is therefore important to be prepared to
  45162. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  45163. messages that were requested as well as summaries for messages that were
  45164. not requested at all.</para>
  45165. </remarks>
  45166. <returns>An enumeration of summaries for the requested messages.</returns>
  45167. <param name="min">The minimum index.</param>
  45168. <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
  45169. <param name="modseq">The mod-sequence value.</param>
  45170. <param name="items">The message summary items to fetch.</param>
  45171. <param name="headers">The desired header fields.</param>
  45172. <param name="cancellationToken">The cancellation token.</param>
  45173. <exception cref="T:System.ArgumentOutOfRangeException">
  45174. <para><paramref name="min"/> is out of range.</para>
  45175. <para>-or-</para>
  45176. <para><paramref name="max"/> is out of range.</para>
  45177. </exception>
  45178. <exception cref="T:System.ArgumentNullException">
  45179. <paramref name="headers"/> is <c>null</c>.
  45180. </exception>
  45181. <exception cref="T:System.ArgumentException">
  45182. One or more of the specified <paramref name="headers"/> is invalid.
  45183. </exception>
  45184. <exception cref="T:System.ObjectDisposedException">
  45185. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  45186. </exception>
  45187. <exception cref="T:MailKit.ServiceNotConnectedException">
  45188. The <see cref="T:MailKit.IMailStore"/> is not connected.
  45189. </exception>
  45190. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  45191. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  45192. </exception>
  45193. <exception cref="T:MailKit.FolderNotOpenException">
  45194. The folder is not currently open.
  45195. </exception>
  45196. <exception cref="T:System.NotSupportedException">
  45197. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  45198. </exception>
  45199. <exception cref="T:System.OperationCanceledException">
  45200. The operation was canceled via the cancellation token.
  45201. </exception>
  45202. <exception cref="T:System.IO.IOException">
  45203. An I/O error occurred.
  45204. </exception>
  45205. <exception cref="T:MailKit.ProtocolException">
  45206. The server's response contained unexpected tokens.
  45207. </exception>
  45208. <exception cref="T:MailKit.CommandException">
  45209. The command failed.
  45210. </exception>
  45211. </member>
  45212. <member name="M:MailKit.MailFolder.FetchAsync(System.Int32,System.Int32,System.UInt64,MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{System.String},System.Threading.CancellationToken)">
  45213. <summary>
  45214. Asynchronously fetch the message summaries for the messages between the two indexes
  45215. (inclusive) that have a higher mod-sequence value than the one specified.
  45216. </summary>
  45217. <remarks>
  45218. <para>Asynchronously fetches the message summaries for the messages between
  45219. the two indexes (inclusive) that have a higher mod-sequence value than the
  45220. one specified.</para>
  45221. <para>It should be noted that if another client has modified any message
  45222. in the folder, the mail service may choose to return information that was
  45223. not explicitly requested. It is therefore important to be prepared to
  45224. handle both additional fields on a <see cref="T:MailKit.IMessageSummary"/> for
  45225. messages that were requested as well as summaries for messages that were
  45226. not requested at all.</para>
  45227. </remarks>
  45228. <returns>An enumeration of summaries for the requested messages.</returns>
  45229. <param name="min">The minimum index.</param>
  45230. <param name="max">The maximum index, or <c>-1</c> to specify no upper bound.</param>
  45231. <param name="modseq">The mod-sequence value.</param>
  45232. <param name="items">The message summary items to fetch.</param>
  45233. <param name="headers">The desired header fields.</param>
  45234. <param name="cancellationToken">The cancellation token.</param>
  45235. <exception cref="T:System.ArgumentOutOfRangeException">
  45236. <para><paramref name="min"/> is out of range.</para>
  45237. <para>-or-</para>
  45238. <para><paramref name="max"/> is out of range.</para>
  45239. </exception>
  45240. <exception cref="T:System.ArgumentNullException">
  45241. <paramref name="headers"/> is <c>null</c>.
  45242. </exception>
  45243. <exception cref="T:System.ArgumentException">
  45244. One or more of the specified <paramref name="headers"/> is invalid.
  45245. </exception>
  45246. <exception cref="T:System.ObjectDisposedException">
  45247. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  45248. </exception>
  45249. <exception cref="T:MailKit.ServiceNotConnectedException">
  45250. The <see cref="T:MailKit.IMailStore"/> is not connected.
  45251. </exception>
  45252. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  45253. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  45254. </exception>
  45255. <exception cref="T:MailKit.FolderNotOpenException">
  45256. The folder is not currently open.
  45257. </exception>
  45258. <exception cref="T:System.NotSupportedException">
  45259. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  45260. </exception>
  45261. <exception cref="T:System.OperationCanceledException">
  45262. The operation was canceled via the cancellation token.
  45263. </exception>
  45264. <exception cref="T:System.IO.IOException">
  45265. An I/O error occurred.
  45266. </exception>
  45267. <exception cref="T:MailKit.ProtocolException">
  45268. The server's response contained unexpected tokens.
  45269. </exception>
  45270. <exception cref="T:MailKit.CommandException">
  45271. The command failed.
  45272. </exception>
  45273. </member>
  45274. <member name="M:MailKit.MailFolder.GetHeaders(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  45275. <summary>
  45276. Get the specified message headers.
  45277. </summary>
  45278. <remarks>
  45279. Gets the specified message headers.
  45280. </remarks>
  45281. <returns>The message headers.</returns>
  45282. <param name="uid">The UID of the message.</param>
  45283. <param name="cancellationToken">The cancellation token.</param>
  45284. <param name="progress">The progress reporting mechanism.</param>
  45285. <exception cref="T:System.ArgumentException">
  45286. <paramref name="uid"/> is invalid.
  45287. </exception>
  45288. <exception cref="T:System.ObjectDisposedException">
  45289. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  45290. </exception>
  45291. <exception cref="T:MailKit.ServiceNotConnectedException">
  45292. The <see cref="T:MailKit.IMailStore"/> is not connected.
  45293. </exception>
  45294. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  45295. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  45296. </exception>
  45297. <exception cref="T:MailKit.FolderNotOpenException">
  45298. The folder is not currently open.
  45299. </exception>
  45300. <exception cref="T:MailKit.MessageNotFoundException">
  45301. The <see cref="T:MailKit.IMailStore"/> did not return the requested message headers.
  45302. </exception>
  45303. <exception cref="T:System.OperationCanceledException">
  45304. The operation was canceled via the cancellation token.
  45305. </exception>
  45306. <exception cref="T:System.IO.IOException">
  45307. An I/O error occurred.
  45308. </exception>
  45309. <exception cref="T:MailKit.ProtocolException">
  45310. The server's response contained unexpected tokens.
  45311. </exception>
  45312. <exception cref="T:MailKit.CommandException">
  45313. The command failed.
  45314. </exception>
  45315. </member>
  45316. <member name="M:MailKit.MailFolder.GetHeadersAsync(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  45317. <summary>
  45318. Asynchronously get the specified message headers.
  45319. </summary>
  45320. <remarks>
  45321. Asynchronously gets the specified message headers.
  45322. </remarks>
  45323. <returns>The message headers.</returns>
  45324. <param name="uid">The UID of the message.</param>
  45325. <param name="cancellationToken">The cancellation token.</param>
  45326. <param name="progress">The progress reporting mechanism.</param>
  45327. <exception cref="T:System.ArgumentException">
  45328. <paramref name="uid"/> is invalid.
  45329. </exception>
  45330. <exception cref="T:System.ObjectDisposedException">
  45331. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  45332. </exception>
  45333. <exception cref="T:MailKit.ServiceNotConnectedException">
  45334. The <see cref="T:MailKit.IMailStore"/> is not connected.
  45335. </exception>
  45336. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  45337. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  45338. </exception>
  45339. <exception cref="T:MailKit.FolderNotOpenException">
  45340. The folder is not currently open.
  45341. </exception>
  45342. <exception cref="T:MailKit.MessageNotFoundException">
  45343. The <see cref="T:MailKit.IMailStore"/> did not return the requested message headers.
  45344. </exception>
  45345. <exception cref="T:System.OperationCanceledException">
  45346. The operation was canceled via the cancellation token.
  45347. </exception>
  45348. <exception cref="T:System.IO.IOException">
  45349. An I/O error occurred.
  45350. </exception>
  45351. <exception cref="T:MailKit.ProtocolException">
  45352. The server's response contained unexpected tokens.
  45353. </exception>
  45354. <exception cref="T:MailKit.CommandException">
  45355. The command failed.
  45356. </exception>
  45357. </member>
  45358. <member name="M:MailKit.MailFolder.GetHeaders(MailKit.UniqueId,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  45359. <summary>
  45360. Get the specified body part headers.
  45361. </summary>
  45362. <remarks>
  45363. Gets the specified body part headers.
  45364. </remarks>
  45365. <returns>The body part headers.</returns>
  45366. <param name="uid">The UID of the message.</param>
  45367. <param name="part">The body part.</param>
  45368. <param name="cancellationToken">The cancellation token.</param>
  45369. <param name="progress">The progress reporting mechanism.</param>
  45370. <exception cref="T:System.ArgumentNullException">
  45371. <paramref name="part"/> is <c>null</c>.
  45372. </exception>
  45373. <exception cref="T:System.ArgumentException">
  45374. <paramref name="uid"/> is invalid.
  45375. </exception>
  45376. <exception cref="T:System.ObjectDisposedException">
  45377. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  45378. </exception>
  45379. <exception cref="T:MailKit.ServiceNotConnectedException">
  45380. The <see cref="T:MailKit.IMailStore"/> is not connected.
  45381. </exception>
  45382. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  45383. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  45384. </exception>
  45385. <exception cref="T:MailKit.FolderNotOpenException">
  45386. The folder is not currently open.
  45387. </exception>
  45388. <exception cref="T:MailKit.MessageNotFoundException">
  45389. The <see cref="T:MailKit.IMailStore"/> did not return the requested body part headers.
  45390. </exception>
  45391. <exception cref="T:System.OperationCanceledException">
  45392. The operation was canceled via the cancellation token.
  45393. </exception>
  45394. <exception cref="T:System.IO.IOException">
  45395. An I/O error occurred.
  45396. </exception>
  45397. <exception cref="T:MailKit.ProtocolException">
  45398. The server's response contained unexpected tokens.
  45399. </exception>
  45400. <exception cref="T:MailKit.CommandException">
  45401. The command failed.
  45402. </exception>
  45403. </member>
  45404. <member name="M:MailKit.MailFolder.GetHeadersAsync(MailKit.UniqueId,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  45405. <summary>
  45406. Asynchronously get the specified body part headers.
  45407. </summary>
  45408. <remarks>
  45409. Asynchronously gets the specified body part headers.
  45410. </remarks>
  45411. <returns>The body part headers.</returns>
  45412. <param name="uid">The UID of the message.</param>
  45413. <param name="part">The body part.</param>
  45414. <param name="cancellationToken">The cancellation token.</param>
  45415. <param name="progress">The progress reporting mechanism.</param>
  45416. <exception cref="T:System.ArgumentNullException">
  45417. <paramref name="part"/> is <c>null</c>.
  45418. </exception>
  45419. <exception cref="T:System.ArgumentException">
  45420. <paramref name="uid"/> is invalid.
  45421. </exception>
  45422. <exception cref="T:System.ObjectDisposedException">
  45423. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  45424. </exception>
  45425. <exception cref="T:MailKit.ServiceNotConnectedException">
  45426. The <see cref="T:MailKit.IMailStore"/> is not connected.
  45427. </exception>
  45428. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  45429. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  45430. </exception>
  45431. <exception cref="T:MailKit.FolderNotOpenException">
  45432. The folder is not currently open.
  45433. </exception>
  45434. <exception cref="T:MailKit.MessageNotFoundException">
  45435. The <see cref="T:MailKit.IMailStore"/> did not return the requested body part headers.
  45436. </exception>
  45437. <exception cref="T:System.OperationCanceledException">
  45438. The operation was canceled via the cancellation token.
  45439. </exception>
  45440. <exception cref="T:System.IO.IOException">
  45441. An I/O error occurred.
  45442. </exception>
  45443. <exception cref="T:MailKit.ProtocolException">
  45444. The server's response contained unexpected tokens.
  45445. </exception>
  45446. <exception cref="T:MailKit.CommandException">
  45447. The command failed.
  45448. </exception>
  45449. </member>
  45450. <member name="M:MailKit.MailFolder.GetHeaders(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  45451. <summary>
  45452. Get the specified message headers.
  45453. </summary>
  45454. <remarks>
  45455. Gets the specified message headers.
  45456. </remarks>
  45457. <returns>The message headers.</returns>
  45458. <param name="index">The index of the message.</param>
  45459. <param name="cancellationToken">The cancellation token.</param>
  45460. <param name="progress">The progress reporting mechanism.</param>
  45461. <exception cref="T:System.ArgumentOutOfRangeException">
  45462. <paramref name="index"/> is out of range.
  45463. </exception>
  45464. <exception cref="T:System.ObjectDisposedException">
  45465. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  45466. </exception>
  45467. <exception cref="T:MailKit.ServiceNotConnectedException">
  45468. The <see cref="T:MailKit.IMailStore"/> is not connected.
  45469. </exception>
  45470. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  45471. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  45472. </exception>
  45473. <exception cref="T:MailKit.FolderNotOpenException">
  45474. The folder is not currently open.
  45475. </exception>
  45476. <exception cref="T:MailKit.MessageNotFoundException">
  45477. The <see cref="T:MailKit.IMailStore"/> did not return the requested message headers.
  45478. </exception>
  45479. <exception cref="T:System.OperationCanceledException">
  45480. The operation was canceled via the cancellation token.
  45481. </exception>
  45482. <exception cref="T:System.IO.IOException">
  45483. An I/O error occurred.
  45484. </exception>
  45485. <exception cref="T:MailKit.ProtocolException">
  45486. The server's response contained unexpected tokens.
  45487. </exception>
  45488. <exception cref="T:MailKit.CommandException">
  45489. The command failed.
  45490. </exception>
  45491. </member>
  45492. <member name="M:MailKit.MailFolder.GetHeadersAsync(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  45493. <summary>
  45494. Asynchronously get the specified message headers.
  45495. </summary>
  45496. <remarks>
  45497. Asynchronously gets the specified message headers.
  45498. </remarks>
  45499. <returns>The message headers.</returns>
  45500. <param name="index">The index of the message.</param>
  45501. <param name="cancellationToken">The cancellation token.</param>
  45502. <param name="progress">The progress reporting mechanism.</param>
  45503. <exception cref="T:System.ArgumentOutOfRangeException">
  45504. <paramref name="index"/> is out of range.
  45505. </exception>
  45506. <exception cref="T:System.ObjectDisposedException">
  45507. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  45508. </exception>
  45509. <exception cref="T:MailKit.ServiceNotConnectedException">
  45510. The <see cref="T:MailKit.IMailStore"/> is not connected.
  45511. </exception>
  45512. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  45513. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  45514. </exception>
  45515. <exception cref="T:MailKit.FolderNotOpenException">
  45516. The folder is not currently open.
  45517. </exception>
  45518. <exception cref="T:MailKit.MessageNotFoundException">
  45519. The <see cref="T:MailKit.IMailStore"/> did not return the requested message headers.
  45520. </exception>
  45521. <exception cref="T:System.OperationCanceledException">
  45522. The operation was canceled via the cancellation token.
  45523. </exception>
  45524. <exception cref="T:System.IO.IOException">
  45525. An I/O error occurred.
  45526. </exception>
  45527. <exception cref="T:MailKit.ProtocolException">
  45528. The server's response contained unexpected tokens.
  45529. </exception>
  45530. <exception cref="T:MailKit.CommandException">
  45531. The command failed.
  45532. </exception>
  45533. </member>
  45534. <member name="M:MailKit.MailFolder.GetHeaders(System.Int32,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  45535. <summary>
  45536. Get the specified body part headers.
  45537. </summary>
  45538. <remarks>
  45539. Gets the specified body part headers.
  45540. </remarks>
  45541. <returns>The body part headers.</returns>
  45542. <param name="index">The index of the message.</param>
  45543. <param name="part">The body part.</param>
  45544. <param name="cancellationToken">The cancellation token.</param>
  45545. <param name="progress">The progress reporting mechanism.</param>
  45546. <exception cref="T:System.ArgumentOutOfRangeException">
  45547. <paramref name="index"/> is out of range.
  45548. </exception>
  45549. <exception cref="T:System.ArgumentNullException">
  45550. <paramref name="part"/> is <c>null</c>.
  45551. </exception>
  45552. <exception cref="T:System.ObjectDisposedException">
  45553. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  45554. </exception>
  45555. <exception cref="T:MailKit.ServiceNotConnectedException">
  45556. The <see cref="T:MailKit.IMailStore"/> is not connected.
  45557. </exception>
  45558. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  45559. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  45560. </exception>
  45561. <exception cref="T:MailKit.FolderNotOpenException">
  45562. The folder is not currently open.
  45563. </exception>
  45564. <exception cref="T:MailKit.MessageNotFoundException">
  45565. The <see cref="T:MailKit.IMailStore"/> did not return the requested body part headers.
  45566. </exception>
  45567. <exception cref="T:System.OperationCanceledException">
  45568. The operation was canceled via the cancellation token.
  45569. </exception>
  45570. <exception cref="T:System.IO.IOException">
  45571. An I/O error occurred.
  45572. </exception>
  45573. <exception cref="T:MailKit.ProtocolException">
  45574. The server's response contained unexpected tokens.
  45575. </exception>
  45576. <exception cref="T:MailKit.CommandException">
  45577. The command failed.
  45578. </exception>
  45579. </member>
  45580. <member name="M:MailKit.MailFolder.GetHeadersAsync(System.Int32,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  45581. <summary>
  45582. Asynchronously get the specified body part headers.
  45583. </summary>
  45584. <remarks>
  45585. Asynchronously gets the specified body part headers.
  45586. </remarks>
  45587. <returns>The body part headers.</returns>
  45588. <param name="index">The index of the message.</param>
  45589. <param name="part">The body part.</param>
  45590. <param name="cancellationToken">The cancellation token.</param>
  45591. <param name="progress">The progress reporting mechanism.</param>
  45592. <exception cref="T:System.ArgumentOutOfRangeException">
  45593. <paramref name="index"/> is out of range.
  45594. </exception>
  45595. <exception cref="T:System.ArgumentNullException">
  45596. <paramref name="part"/> is <c>null</c>.
  45597. </exception>
  45598. <exception cref="T:System.ObjectDisposedException">
  45599. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  45600. </exception>
  45601. <exception cref="T:MailKit.ServiceNotConnectedException">
  45602. The <see cref="T:MailKit.IMailStore"/> is not connected.
  45603. </exception>
  45604. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  45605. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  45606. </exception>
  45607. <exception cref="T:MailKit.FolderNotOpenException">
  45608. The folder is not currently open.
  45609. </exception>
  45610. <exception cref="T:MailKit.MessageNotFoundException">
  45611. The <see cref="T:MailKit.IMailStore"/> did not return the requested body part headers.
  45612. </exception>
  45613. <exception cref="T:System.OperationCanceledException">
  45614. The operation was canceled via the cancellation token.
  45615. </exception>
  45616. <exception cref="T:System.IO.IOException">
  45617. An I/O error occurred.
  45618. </exception>
  45619. <exception cref="T:MailKit.ProtocolException">
  45620. The server's response contained unexpected tokens.
  45621. </exception>
  45622. <exception cref="T:MailKit.CommandException">
  45623. The command failed.
  45624. </exception>
  45625. </member>
  45626. <member name="M:MailKit.MailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  45627. <summary>
  45628. Get the specified message.
  45629. </summary>
  45630. <remarks>
  45631. Gets the specified message.
  45632. </remarks>
  45633. <returns>The message.</returns>
  45634. <param name="uid">The UID of the message.</param>
  45635. <param name="cancellationToken">The cancellation token.</param>
  45636. <param name="progress">The progress reporting mechanism.</param>
  45637. <exception cref="T:System.ArgumentException">
  45638. <paramref name="uid"/> is invalid.
  45639. </exception>
  45640. <exception cref="T:System.ObjectDisposedException">
  45641. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  45642. </exception>
  45643. <exception cref="T:MailKit.ServiceNotConnectedException">
  45644. The <see cref="T:MailKit.IMailStore"/> is not connected.
  45645. </exception>
  45646. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  45647. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  45648. </exception>
  45649. <exception cref="T:MailKit.FolderNotOpenException">
  45650. The folder is not currently open.
  45651. </exception>
  45652. <exception cref="T:MailKit.MessageNotFoundException">
  45653. The <see cref="T:MailKit.IMailStore"/> did not return the requested message.
  45654. </exception>
  45655. <exception cref="T:System.OperationCanceledException">
  45656. The operation was canceled via the cancellation token.
  45657. </exception>
  45658. <exception cref="T:System.IO.IOException">
  45659. An I/O error occurred.
  45660. </exception>
  45661. <exception cref="T:MailKit.ProtocolException">
  45662. The server's response contained unexpected tokens.
  45663. </exception>
  45664. <exception cref="T:MailKit.CommandException">
  45665. The command failed.
  45666. </exception>
  45667. </member>
  45668. <member name="M:MailKit.MailFolder.GetMessageAsync(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  45669. <summary>
  45670. Asynchronously get the specified message.
  45671. </summary>
  45672. <remarks>
  45673. Asynchronously gets the specified message.
  45674. </remarks>
  45675. <returns>The message.</returns>
  45676. <param name="uid">The UID of the message.</param>
  45677. <param name="cancellationToken">The cancellation token.</param>
  45678. <param name="progress">The progress reporting mechanism.</param>
  45679. <exception cref="T:System.ArgumentException">
  45680. <paramref name="uid"/> is invalid.
  45681. </exception>
  45682. <exception cref="T:System.ObjectDisposedException">
  45683. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  45684. </exception>
  45685. <exception cref="T:MailKit.ServiceNotConnectedException">
  45686. The <see cref="T:MailKit.IMailStore"/> is not connected.
  45687. </exception>
  45688. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  45689. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  45690. </exception>
  45691. <exception cref="T:MailKit.FolderNotOpenException">
  45692. The folder is not currently open.
  45693. </exception>
  45694. <exception cref="T:MailKit.MessageNotFoundException">
  45695. The <see cref="T:MailKit.IMailStore"/> did not return the requested message.
  45696. </exception>
  45697. <exception cref="T:System.OperationCanceledException">
  45698. The operation was canceled via the cancellation token.
  45699. </exception>
  45700. <exception cref="T:System.IO.IOException">
  45701. An I/O error occurred.
  45702. </exception>
  45703. <exception cref="T:MailKit.ProtocolException">
  45704. The server's response contained unexpected tokens.
  45705. </exception>
  45706. <exception cref="T:MailKit.CommandException">
  45707. The command failed.
  45708. </exception>
  45709. </member>
  45710. <member name="M:MailKit.MailFolder.GetMessage(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  45711. <summary>
  45712. Get the specified message.
  45713. </summary>
  45714. <remarks>
  45715. Gets the specified message.
  45716. </remarks>
  45717. <returns>The message.</returns>
  45718. <param name="index">The index of the message.</param>
  45719. <param name="cancellationToken">The cancellation token.</param>
  45720. <param name="progress">The progress reporting mechanism.</param>
  45721. <exception cref="T:System.ArgumentOutOfRangeException">
  45722. <paramref name="index"/> is out of range.
  45723. </exception>
  45724. <exception cref="T:System.ObjectDisposedException">
  45725. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  45726. </exception>
  45727. <exception cref="T:MailKit.ServiceNotConnectedException">
  45728. The <see cref="T:MailKit.IMailStore"/> is not connected.
  45729. </exception>
  45730. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  45731. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  45732. </exception>
  45733. <exception cref="T:MailKit.FolderNotOpenException">
  45734. The folder is not currently open.
  45735. </exception>
  45736. <exception cref="T:MailKit.MessageNotFoundException">
  45737. The <see cref="T:MailKit.IMailStore"/> did not return the requested message.
  45738. </exception>
  45739. <exception cref="T:System.OperationCanceledException">
  45740. The operation was canceled via the cancellation token.
  45741. </exception>
  45742. <exception cref="T:System.IO.IOException">
  45743. An I/O error occurred.
  45744. </exception>
  45745. <exception cref="T:MailKit.ProtocolException">
  45746. The server's response contained unexpected tokens.
  45747. </exception>
  45748. <exception cref="T:MailKit.CommandException">
  45749. The command failed.
  45750. </exception>
  45751. </member>
  45752. <member name="M:MailKit.MailFolder.GetMessageAsync(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  45753. <summary>
  45754. Asynchronously get the specified message.
  45755. </summary>
  45756. <remarks>
  45757. Asynchronously gets the specified message.
  45758. </remarks>
  45759. <returns>The message.</returns>
  45760. <param name="index">The index of the message.</param>
  45761. <param name="cancellationToken">The cancellation token.</param>
  45762. <param name="progress">The progress reporting mechanism.</param>
  45763. <exception cref="T:System.ArgumentOutOfRangeException">
  45764. <paramref name="index"/> is out of range.
  45765. </exception>
  45766. <exception cref="T:System.ObjectDisposedException">
  45767. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  45768. </exception>
  45769. <exception cref="T:MailKit.ServiceNotConnectedException">
  45770. The <see cref="T:MailKit.IMailStore"/> is not connected.
  45771. </exception>
  45772. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  45773. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  45774. </exception>
  45775. <exception cref="T:MailKit.FolderNotOpenException">
  45776. The folder is not currently open.
  45777. </exception>
  45778. <exception cref="T:MailKit.MessageNotFoundException">
  45779. The <see cref="T:MailKit.IMailStore"/> did not return the requested message.
  45780. </exception>
  45781. <exception cref="T:System.OperationCanceledException">
  45782. The operation was canceled via the cancellation token.
  45783. </exception>
  45784. <exception cref="T:System.IO.IOException">
  45785. An I/O error occurred.
  45786. </exception>
  45787. <exception cref="T:MailKit.ProtocolException">
  45788. The server's response contained unexpected tokens.
  45789. </exception>
  45790. <exception cref="T:MailKit.CommandException">
  45791. The command failed.
  45792. </exception>
  45793. </member>
  45794. <member name="M:MailKit.MailFolder.GetBodyPart(MailKit.UniqueId,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  45795. <summary>
  45796. Get the specified body part.
  45797. </summary>
  45798. <remarks>
  45799. Gets the specified body part.
  45800. </remarks>
  45801. <example>
  45802. <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
  45803. </example>
  45804. <returns>The body part.</returns>
  45805. <param name="uid">The UID of the message.</param>
  45806. <param name="part">The body part.</param>
  45807. <param name="cancellationToken">The cancellation token.</param>
  45808. <param name="progress">The progress reporting mechanism.</param>
  45809. <exception cref="T:System.ArgumentNullException">
  45810. <paramref name="part"/> is <c>null</c>.
  45811. </exception>
  45812. <exception cref="T:System.ArgumentException">
  45813. <paramref name="uid"/> is invalid.
  45814. </exception>
  45815. <exception cref="T:System.ObjectDisposedException">
  45816. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  45817. </exception>
  45818. <exception cref="T:MailKit.ServiceNotConnectedException">
  45819. The <see cref="T:MailKit.IMailStore"/> is not connected.
  45820. </exception>
  45821. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  45822. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  45823. </exception>
  45824. <exception cref="T:MailKit.FolderNotOpenException">
  45825. The folder is not currently open.
  45826. </exception>
  45827. <exception cref="T:MailKit.MessageNotFoundException">
  45828. The <see cref="T:MailKit.IMailStore"/> did not return the requested message body.
  45829. </exception>
  45830. <exception cref="T:System.OperationCanceledException">
  45831. The operation was canceled via the cancellation token.
  45832. </exception>
  45833. <exception cref="T:System.IO.IOException">
  45834. An I/O error occurred.
  45835. </exception>
  45836. <exception cref="T:MailKit.ProtocolException">
  45837. The server's response contained unexpected tokens.
  45838. </exception>
  45839. <exception cref="T:MailKit.CommandException">
  45840. The command failed.
  45841. </exception>
  45842. </member>
  45843. <member name="M:MailKit.MailFolder.GetBodyPartAsync(MailKit.UniqueId,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  45844. <summary>
  45845. Asynchronously get the specified body part.
  45846. </summary>
  45847. <remarks>
  45848. Asynchronously gets the specified body part.
  45849. </remarks>
  45850. <returns>The body part.</returns>
  45851. <param name="uid">The UID of the message.</param>
  45852. <param name="part">The body part.</param>
  45853. <param name="cancellationToken">The cancellation token.</param>
  45854. <param name="progress">The progress reporting mechanism.</param>
  45855. <exception cref="T:System.ArgumentNullException">
  45856. <paramref name="part"/> is <c>null</c>.
  45857. </exception>
  45858. <exception cref="T:System.ArgumentException">
  45859. <paramref name="uid"/> is invalid.
  45860. </exception>
  45861. <exception cref="T:System.ObjectDisposedException">
  45862. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  45863. </exception>
  45864. <exception cref="T:MailKit.ServiceNotConnectedException">
  45865. The <see cref="T:MailKit.IMailStore"/> is not connected.
  45866. </exception>
  45867. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  45868. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  45869. </exception>
  45870. <exception cref="T:MailKit.FolderNotOpenException">
  45871. The folder is not currently open.
  45872. </exception>
  45873. <exception cref="T:MailKit.MessageNotFoundException">
  45874. The <see cref="T:MailKit.IMailStore"/> did not return the requested message body.
  45875. </exception>
  45876. <exception cref="T:System.OperationCanceledException">
  45877. The operation was canceled via the cancellation token.
  45878. </exception>
  45879. <exception cref="T:System.IO.IOException">
  45880. An I/O error occurred.
  45881. </exception>
  45882. <exception cref="T:MailKit.ProtocolException">
  45883. The server's response contained unexpected tokens.
  45884. </exception>
  45885. <exception cref="T:MailKit.CommandException">
  45886. The command failed.
  45887. </exception>
  45888. </member>
  45889. <member name="M:MailKit.MailFolder.GetBodyPart(System.Int32,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  45890. <summary>
  45891. Get the specified body part.
  45892. </summary>
  45893. <remarks>
  45894. Gets the specified body part.
  45895. </remarks>
  45896. <returns>The body part.</returns>
  45897. <param name="index">The index of the message.</param>
  45898. <param name="part">The body part.</param>
  45899. <param name="cancellationToken">The cancellation token.</param>
  45900. <param name="progress">The progress reporting mechanism.</param>
  45901. <exception cref="T:System.ArgumentNullException">
  45902. <paramref name="part"/> is <c>null</c>.
  45903. </exception>
  45904. <exception cref="T:System.ArgumentOutOfRangeException">
  45905. <paramref name="index"/> is out of range.
  45906. </exception>
  45907. <exception cref="T:System.ObjectDisposedException">
  45908. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  45909. </exception>
  45910. <exception cref="T:MailKit.ServiceNotConnectedException">
  45911. The <see cref="T:MailKit.IMailStore"/> is not connected.
  45912. </exception>
  45913. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  45914. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  45915. </exception>
  45916. <exception cref="T:MailKit.FolderNotOpenException">
  45917. The folder is not currently open.
  45918. </exception>
  45919. <exception cref="T:MailKit.MessageNotFoundException">
  45920. The <see cref="T:MailKit.IMailStore"/> did not return the requested message body.
  45921. </exception>
  45922. <exception cref="T:System.OperationCanceledException">
  45923. The operation was canceled via the cancellation token.
  45924. </exception>
  45925. <exception cref="T:System.IO.IOException">
  45926. An I/O error occurred.
  45927. </exception>
  45928. <exception cref="T:MailKit.ProtocolException">
  45929. The server's response contained unexpected tokens.
  45930. </exception>
  45931. <exception cref="T:MailKit.CommandException">
  45932. The command failed.
  45933. </exception>
  45934. </member>
  45935. <member name="M:MailKit.MailFolder.GetBodyPartAsync(System.Int32,MailKit.BodyPart,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  45936. <summary>
  45937. Asynchronously get the specified body part.
  45938. </summary>
  45939. <remarks>
  45940. Asynchronously gets the specified body part.
  45941. </remarks>
  45942. <returns>The body part.</returns>
  45943. <param name="index">The index of the message.</param>
  45944. <param name="part">The body part.</param>
  45945. <param name="cancellationToken">The cancellation token.</param>
  45946. <param name="progress">The progress reporting mechanism.</param>
  45947. <exception cref="T:System.ArgumentNullException">
  45948. <paramref name="part"/> is <c>null</c>.
  45949. </exception>
  45950. <exception cref="T:System.ArgumentOutOfRangeException">
  45951. <paramref name="index"/> is out of range.
  45952. </exception>
  45953. <exception cref="T:System.ObjectDisposedException">
  45954. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  45955. </exception>
  45956. <exception cref="T:MailKit.ServiceNotConnectedException">
  45957. The <see cref="T:MailKit.IMailStore"/> is not connected.
  45958. </exception>
  45959. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  45960. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  45961. </exception>
  45962. <exception cref="T:MailKit.FolderNotOpenException">
  45963. The folder is not currently open.
  45964. </exception>
  45965. <exception cref="T:MailKit.MessageNotFoundException">
  45966. The <see cref="T:MailKit.IMailStore"/> did not return the requested message body.
  45967. </exception>
  45968. <exception cref="T:System.OperationCanceledException">
  45969. The operation was canceled via the cancellation token.
  45970. </exception>
  45971. <exception cref="T:System.IO.IOException">
  45972. An I/O error occurred.
  45973. </exception>
  45974. <exception cref="T:MailKit.ProtocolException">
  45975. The server's response contained unexpected tokens.
  45976. </exception>
  45977. <exception cref="T:MailKit.CommandException">
  45978. The command failed.
  45979. </exception>
  45980. </member>
  45981. <member name="M:MailKit.MailFolder.GetStream(MailKit.UniqueId,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  45982. <summary>
  45983. Get a substream of the specified message.
  45984. </summary>
  45985. <remarks>
  45986. Gets a substream of the message. If the starting offset is beyond
  45987. the end of the message, an empty stream is returned. If the number of
  45988. bytes desired extends beyond the end of the message, a truncated stream
  45989. will be returned.
  45990. </remarks>
  45991. <returns>The stream.</returns>
  45992. <param name="uid">The UID of the message.</param>
  45993. <param name="offset">The starting offset of the first desired byte.</param>
  45994. <param name="count">The number of bytes desired.</param>
  45995. <param name="cancellationToken">The cancellation token.</param>
  45996. <param name="progress">The progress reporting mechanism.</param>
  45997. <exception cref="T:System.ArgumentException">
  45998. <paramref name="uid"/> is invalid.
  45999. </exception>
  46000. <exception cref="T:System.ArgumentOutOfRangeException">
  46001. <para><paramref name="offset"/> is negative.</para>
  46002. <para>-or-</para>
  46003. <para><paramref name="count"/> is negative.</para>
  46004. </exception>
  46005. <exception cref="T:System.ObjectDisposedException">
  46006. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  46007. </exception>
  46008. <exception cref="T:MailKit.ServiceNotConnectedException">
  46009. The <see cref="T:MailKit.IMailStore"/> is not connected.
  46010. </exception>
  46011. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  46012. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  46013. </exception>
  46014. <exception cref="T:MailKit.FolderNotOpenException">
  46015. The folder is not currently open.
  46016. </exception>
  46017. <exception cref="T:MailKit.MessageNotFoundException">
  46018. The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
  46019. </exception>
  46020. <exception cref="T:System.OperationCanceledException">
  46021. The operation was canceled via the cancellation token.
  46022. </exception>
  46023. <exception cref="T:System.IO.IOException">
  46024. An I/O error occurred.
  46025. </exception>
  46026. <exception cref="T:MailKit.ProtocolException">
  46027. The server's response contained unexpected tokens.
  46028. </exception>
  46029. <exception cref="T:MailKit.CommandException">
  46030. The command failed.
  46031. </exception>
  46032. </member>
  46033. <member name="M:MailKit.MailFolder.GetStreamAsync(MailKit.UniqueId,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  46034. <summary>
  46035. Asynchronously get a substream of the specified message.
  46036. </summary>
  46037. <remarks>
  46038. Asynchronously gets a substream of the message. If the starting offset is beyond
  46039. the end of the message, an empty stream is returned. If the number of
  46040. bytes desired extends beyond the end of the message, a truncated stream
  46041. will be returned.
  46042. </remarks>
  46043. <returns>The stream.</returns>
  46044. <param name="uid">The UID of the message.</param>
  46045. <param name="offset">The starting offset of the first desired byte.</param>
  46046. <param name="count">The number of bytes desired.</param>
  46047. <param name="cancellationToken">The cancellation token.</param>
  46048. <param name="progress">The progress reporting mechanism.</param>
  46049. <exception cref="T:System.ArgumentException">
  46050. <paramref name="uid"/> is invalid.
  46051. </exception>
  46052. <exception cref="T:System.ArgumentOutOfRangeException">
  46053. <para><paramref name="offset"/> is negative.</para>
  46054. <para>-or-</para>
  46055. <para><paramref name="count"/> is negative.</para>
  46056. </exception>
  46057. <exception cref="T:System.ObjectDisposedException">
  46058. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  46059. </exception>
  46060. <exception cref="T:MailKit.ServiceNotConnectedException">
  46061. The <see cref="T:MailKit.IMailStore"/> is not connected.
  46062. </exception>
  46063. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  46064. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  46065. </exception>
  46066. <exception cref="T:MailKit.FolderNotOpenException">
  46067. The folder is not currently open.
  46068. </exception>
  46069. <exception cref="T:MailKit.MessageNotFoundException">
  46070. The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
  46071. </exception>
  46072. <exception cref="T:System.OperationCanceledException">
  46073. The operation was canceled via the cancellation token.
  46074. </exception>
  46075. <exception cref="T:System.IO.IOException">
  46076. An I/O error occurred.
  46077. </exception>
  46078. <exception cref="T:MailKit.ProtocolException">
  46079. The server's response contained unexpected tokens.
  46080. </exception>
  46081. <exception cref="T:MailKit.CommandException">
  46082. The command failed.
  46083. </exception>
  46084. </member>
  46085. <member name="M:MailKit.MailFolder.GetStream(System.Int32,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  46086. <summary>
  46087. Get a substream of the specified message.
  46088. </summary>
  46089. <remarks>
  46090. Gets a substream of the message. If the starting offset is beyond
  46091. the end of the message, an empty stream is returned. If the number of
  46092. bytes desired extends beyond the end of the message, a truncated stream
  46093. will be returned.
  46094. </remarks>
  46095. <returns>The stream.</returns>
  46096. <param name="index">The index of the message.</param>
  46097. <param name="offset">The starting offset of the first desired byte.</param>
  46098. <param name="count">The number of bytes desired.</param>
  46099. <param name="cancellationToken">The cancellation token.</param>
  46100. <param name="progress">The progress reporting mechanism.</param>
  46101. <exception cref="T:System.ArgumentOutOfRangeException">
  46102. <para><paramref name="index"/> is out of range.</para>
  46103. <para>-or-</para>
  46104. <para><paramref name="offset"/> is negative.</para>
  46105. <para>-or-</para>
  46106. <para><paramref name="count"/> is negative.</para>
  46107. </exception>
  46108. <exception cref="T:System.ObjectDisposedException">
  46109. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  46110. </exception>
  46111. <exception cref="T:MailKit.ServiceNotConnectedException">
  46112. The <see cref="T:MailKit.IMailStore"/> is not connected.
  46113. </exception>
  46114. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  46115. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  46116. </exception>
  46117. <exception cref="T:MailKit.FolderNotOpenException">
  46118. The folder is not currently open.
  46119. </exception>
  46120. <exception cref="T:MailKit.MessageNotFoundException">
  46121. The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
  46122. </exception>
  46123. <exception cref="T:System.OperationCanceledException">
  46124. The operation was canceled via the cancellation token.
  46125. </exception>
  46126. <exception cref="T:System.IO.IOException">
  46127. An I/O error occurred.
  46128. </exception>
  46129. <exception cref="T:MailKit.ProtocolException">
  46130. The server's response contained unexpected tokens.
  46131. </exception>
  46132. <exception cref="T:MailKit.CommandException">
  46133. The command failed.
  46134. </exception>
  46135. </member>
  46136. <member name="M:MailKit.MailFolder.GetStreamAsync(System.Int32,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  46137. <summary>
  46138. Asynchronously get a substream of the specified message.
  46139. </summary>
  46140. <remarks>
  46141. Asynchronously gets a substream of the message. If the starting offset is beyond
  46142. the end of the message, an empty stream is returned. If the number of
  46143. bytes desired extends beyond the end of the message, a truncated stream
  46144. will be returned.
  46145. </remarks>
  46146. <returns>The stream.</returns>
  46147. <param name="index">The index of the message.</param>
  46148. <param name="offset">The starting offset of the first desired byte.</param>
  46149. <param name="count">The number of bytes desired.</param>
  46150. <param name="cancellationToken">The cancellation token.</param>
  46151. <param name="progress">The progress reporting mechanism.</param>
  46152. <exception cref="T:System.ArgumentOutOfRangeException">
  46153. <para><paramref name="index"/> is out of range.</para>
  46154. <para>-or-</para>
  46155. <para><paramref name="offset"/> is negative.</para>
  46156. <para>-or-</para>
  46157. <para><paramref name="count"/> is negative.</para>
  46158. </exception>
  46159. <exception cref="T:System.ObjectDisposedException">
  46160. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  46161. </exception>
  46162. <exception cref="T:MailKit.ServiceNotConnectedException">
  46163. The <see cref="T:MailKit.IMailStore"/> is not connected.
  46164. </exception>
  46165. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  46166. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  46167. </exception>
  46168. <exception cref="T:MailKit.FolderNotOpenException">
  46169. The folder is not currently open.
  46170. </exception>
  46171. <exception cref="T:MailKit.MessageNotFoundException">
  46172. The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
  46173. </exception>
  46174. <exception cref="T:System.OperationCanceledException">
  46175. The operation was canceled via the cancellation token.
  46176. </exception>
  46177. <exception cref="T:System.IO.IOException">
  46178. An I/O error occurred.
  46179. </exception>
  46180. <exception cref="T:MailKit.ProtocolException">
  46181. The server's response contained unexpected tokens.
  46182. </exception>
  46183. <exception cref="T:MailKit.CommandException">
  46184. The command failed.
  46185. </exception>
  46186. </member>
  46187. <member name="M:MailKit.MailFolder.GetStream(MailKit.UniqueId,MailKit.BodyPart,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  46188. <summary>
  46189. Get a substream of the specified body part.
  46190. </summary>
  46191. <remarks>
  46192. Gets a substream of the body part. If the starting offset is beyond
  46193. the end of the body part, an empty stream is returned. If the number of
  46194. bytes desired extends beyond the end of the body part, a truncated stream
  46195. will be returned.
  46196. </remarks>
  46197. <returns>The stream.</returns>
  46198. <param name="uid">The UID of the message.</param>
  46199. <param name="part">The desired body part.</param>
  46200. <param name="offset">The starting offset of the first desired byte.</param>
  46201. <param name="count">The number of bytes desired.</param>
  46202. <param name="cancellationToken">The cancellation token.</param>
  46203. <param name="progress">The progress reporting mechanism.</param>
  46204. <exception cref="T:System.ArgumentException">
  46205. <paramref name="uid"/> is invalid.
  46206. </exception>
  46207. <exception cref="T:System.ArgumentNullException">
  46208. <paramref name="part"/> is <c>null</c>.
  46209. </exception>
  46210. <exception cref="T:System.ArgumentOutOfRangeException">
  46211. <para><paramref name="offset"/> is negative.</para>
  46212. <para>-or-</para>
  46213. <para><paramref name="count"/> is negative.</para>
  46214. </exception>
  46215. <exception cref="T:System.ObjectDisposedException">
  46216. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  46217. </exception>
  46218. <exception cref="T:MailKit.ServiceNotConnectedException">
  46219. The <see cref="T:MailKit.IMailStore"/> is not connected.
  46220. </exception>
  46221. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  46222. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  46223. </exception>
  46224. <exception cref="T:MailKit.FolderNotOpenException">
  46225. The folder is not currently open.
  46226. </exception>
  46227. <exception cref="T:MailKit.MessageNotFoundException">
  46228. The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
  46229. </exception>
  46230. <exception cref="T:System.OperationCanceledException">
  46231. The operation was canceled via the cancellation token.
  46232. </exception>
  46233. <exception cref="T:System.IO.IOException">
  46234. An I/O error occurred.
  46235. </exception>
  46236. <exception cref="T:MailKit.ProtocolException">
  46237. The server's response contained unexpected tokens.
  46238. </exception>
  46239. <exception cref="T:MailKit.CommandException">
  46240. The command failed.
  46241. </exception>
  46242. </member>
  46243. <member name="M:MailKit.MailFolder.GetStreamAsync(MailKit.UniqueId,MailKit.BodyPart,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  46244. <summary>
  46245. Asynchronously get a substream of the specified body part.
  46246. </summary>
  46247. <remarks>
  46248. Asynchronously gets a substream of the body part. If the starting offset is beyond
  46249. the end of the body part, an empty stream is returned. If the number of
  46250. bytes desired extends beyond the end of the body part, a truncated stream
  46251. will be returned.
  46252. </remarks>
  46253. <returns>The stream.</returns>
  46254. <param name="uid">The UID of the message.</param>
  46255. <param name="part">The desired body part.</param>
  46256. <param name="offset">The starting offset of the first desired byte.</param>
  46257. <param name="count">The number of bytes desired.</param>
  46258. <param name="cancellationToken">The cancellation token.</param>
  46259. <param name="progress">The progress reporting mechanism.</param>
  46260. <exception cref="T:System.ArgumentException">
  46261. <paramref name="uid"/> is invalid.
  46262. </exception>
  46263. <exception cref="T:System.ArgumentNullException">
  46264. <paramref name="part"/> is <c>null</c>.
  46265. </exception>
  46266. <exception cref="T:System.ArgumentOutOfRangeException">
  46267. <para><paramref name="offset"/> is negative.</para>
  46268. <para>-or-</para>
  46269. <para><paramref name="count"/> is negative.</para>
  46270. </exception>
  46271. <exception cref="T:System.ObjectDisposedException">
  46272. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  46273. </exception>
  46274. <exception cref="T:MailKit.ServiceNotConnectedException">
  46275. The <see cref="T:MailKit.IMailStore"/> is not connected.
  46276. </exception>
  46277. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  46278. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  46279. </exception>
  46280. <exception cref="T:MailKit.FolderNotOpenException">
  46281. The folder is not currently open.
  46282. </exception>
  46283. <exception cref="T:MailKit.MessageNotFoundException">
  46284. The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
  46285. </exception>
  46286. <exception cref="T:System.OperationCanceledException">
  46287. The operation was canceled via the cancellation token.
  46288. </exception>
  46289. <exception cref="T:System.IO.IOException">
  46290. An I/O error occurred.
  46291. </exception>
  46292. <exception cref="T:MailKit.ProtocolException">
  46293. The server's response contained unexpected tokens.
  46294. </exception>
  46295. <exception cref="T:MailKit.CommandException">
  46296. The command failed.
  46297. </exception>
  46298. </member>
  46299. <member name="M:MailKit.MailFolder.GetStream(System.Int32,MailKit.BodyPart,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  46300. <summary>
  46301. Get a substream of the specified body part.
  46302. </summary>
  46303. <remarks>
  46304. Gets a substream of the body part. If the starting offset is beyond
  46305. the end of the body part, an empty stream is returned. If the number of
  46306. bytes desired extends beyond the end of the body part, a truncated stream
  46307. will be returned.
  46308. </remarks>
  46309. <returns>The stream.</returns>
  46310. <param name="index">The index of the message.</param>
  46311. <param name="part">The desired body part.</param>
  46312. <param name="offset">The starting offset of the first desired byte.</param>
  46313. <param name="count">The number of bytes desired.</param>
  46314. <param name="cancellationToken">The cancellation token.</param>
  46315. <param name="progress">The progress reporting mechanism.</param>
  46316. <exception cref="T:System.ArgumentNullException">
  46317. <paramref name="part"/> is <c>null</c>.
  46318. </exception>
  46319. <exception cref="T:System.ArgumentOutOfRangeException">
  46320. <para><paramref name="index"/> is out of range.</para>
  46321. <para>-or-</para>
  46322. <para><paramref name="offset"/> is negative.</para>
  46323. <para>-or-</para>
  46324. <para><paramref name="count"/> is negative.</para>
  46325. </exception>
  46326. <exception cref="T:System.ObjectDisposedException">
  46327. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  46328. </exception>
  46329. <exception cref="T:MailKit.ServiceNotConnectedException">
  46330. The <see cref="T:MailKit.IMailStore"/> is not connected.
  46331. </exception>
  46332. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  46333. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  46334. </exception>
  46335. <exception cref="T:MailKit.FolderNotOpenException">
  46336. The folder is not currently open.
  46337. </exception>
  46338. <exception cref="T:MailKit.MessageNotFoundException">
  46339. The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
  46340. </exception>
  46341. <exception cref="T:System.OperationCanceledException">
  46342. The operation was canceled via the cancellation token.
  46343. </exception>
  46344. <exception cref="T:System.IO.IOException">
  46345. An I/O error occurred.
  46346. </exception>
  46347. <exception cref="T:MailKit.ProtocolException">
  46348. The server's response contained unexpected tokens.
  46349. </exception>
  46350. <exception cref="T:MailKit.CommandException">
  46351. The command failed.
  46352. </exception>
  46353. </member>
  46354. <member name="M:MailKit.MailFolder.GetStreamAsync(System.Int32,MailKit.BodyPart,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  46355. <summary>
  46356. Asynchronously get a substream of the specified body part.
  46357. </summary>
  46358. <remarks>
  46359. Asynchronously gets a substream of the body part. If the starting offset is beyond
  46360. the end of the body part, an empty stream is returned. If the number of
  46361. bytes desired extends beyond the end of the body part, a truncated stream
  46362. will be returned.
  46363. </remarks>
  46364. <returns>The stream.</returns>
  46365. <param name="index">The index of the message.</param>
  46366. <param name="part">The desired body part.</param>
  46367. <param name="offset">The starting offset of the first desired byte.</param>
  46368. <param name="count">The number of bytes desired.</param>
  46369. <param name="cancellationToken">The cancellation token.</param>
  46370. <param name="progress">The progress reporting mechanism.</param>
  46371. <exception cref="T:System.ArgumentNullException">
  46372. <paramref name="part"/> is <c>null</c>.
  46373. </exception>
  46374. <exception cref="T:System.ArgumentOutOfRangeException">
  46375. <para><paramref name="index"/> is out of range.</para>
  46376. <para>-or-</para>
  46377. <para><paramref name="offset"/> is negative.</para>
  46378. <para>-or-</para>
  46379. <para><paramref name="count"/> is negative.</para>
  46380. </exception>
  46381. <exception cref="T:System.ObjectDisposedException">
  46382. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  46383. </exception>
  46384. <exception cref="T:MailKit.ServiceNotConnectedException">
  46385. The <see cref="T:MailKit.IMailStore"/> is not connected.
  46386. </exception>
  46387. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  46388. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  46389. </exception>
  46390. <exception cref="T:MailKit.FolderNotOpenException">
  46391. The folder is not currently open.
  46392. </exception>
  46393. <exception cref="T:MailKit.MessageNotFoundException">
  46394. The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
  46395. </exception>
  46396. <exception cref="T:System.OperationCanceledException">
  46397. The operation was canceled via the cancellation token.
  46398. </exception>
  46399. <exception cref="T:System.IO.IOException">
  46400. An I/O error occurred.
  46401. </exception>
  46402. <exception cref="T:MailKit.ProtocolException">
  46403. The server's response contained unexpected tokens.
  46404. </exception>
  46405. <exception cref="T:MailKit.CommandException">
  46406. The command failed.
  46407. </exception>
  46408. </member>
  46409. <member name="M:MailKit.MailFolder.GetStream(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  46410. <summary>
  46411. Get a substream of the specified message.
  46412. </summary>
  46413. <remarks>
  46414. <para>Gets a substream of the specified message.</para>
  46415. <para>For more information about how to construct the <paramref name="section"/>,
  46416. see Section 6.4.5 of RFC3501.</para>
  46417. </remarks>
  46418. <returns>The stream.</returns>
  46419. <param name="uid">The UID of the message.</param>
  46420. <param name="section">The desired section of the message.</param>
  46421. <param name="cancellationToken">The cancellation token.</param>
  46422. <param name="progress">The progress reporting mechanism.</param>
  46423. <exception cref="T:System.ArgumentException">
  46424. <paramref name="uid"/> is invalid.
  46425. </exception>
  46426. <exception cref="T:System.ArgumentNullException">
  46427. <paramref name="section"/> is <c>null</c>.
  46428. </exception>
  46429. <exception cref="T:System.ObjectDisposedException">
  46430. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  46431. </exception>
  46432. <exception cref="T:MailKit.ServiceNotConnectedException">
  46433. The <see cref="T:MailKit.IMailStore"/> is not connected.
  46434. </exception>
  46435. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  46436. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  46437. </exception>
  46438. <exception cref="T:MailKit.FolderNotOpenException">
  46439. The folder is not currently open.
  46440. </exception>
  46441. <exception cref="T:MailKit.MessageNotFoundException">
  46442. The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
  46443. </exception>
  46444. <exception cref="T:System.OperationCanceledException">
  46445. The operation was canceled via the cancellation token.
  46446. </exception>
  46447. <exception cref="T:System.IO.IOException">
  46448. An I/O error occurred.
  46449. </exception>
  46450. <exception cref="T:MailKit.ProtocolException">
  46451. The server's response contained unexpected tokens.
  46452. </exception>
  46453. <exception cref="T:MailKit.CommandException">
  46454. The command failed.
  46455. </exception>
  46456. </member>
  46457. <member name="M:MailKit.MailFolder.GetStreamAsync(MailKit.UniqueId,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  46458. <summary>
  46459. Asynchronously get a substream of the specified message.
  46460. </summary>
  46461. <remarks>
  46462. <para>Asynchronously gets a substream of the specified message.</para>
  46463. <para>For more information about how to construct the <paramref name="section"/>,
  46464. see Section 6.4.5 of RFC3501.</para>
  46465. </remarks>
  46466. <returns>The stream.</returns>
  46467. <param name="uid">The UID of the message.</param>
  46468. <param name="section">The desired section of the message.</param>
  46469. <param name="cancellationToken">The cancellation token.</param>
  46470. <param name="progress">The progress reporting mechanism.</param>
  46471. <exception cref="T:System.ArgumentException">
  46472. <paramref name="uid"/> is invalid.
  46473. </exception>
  46474. <exception cref="T:System.ArgumentNullException">
  46475. <paramref name="section"/> is <c>null</c>.
  46476. </exception>
  46477. <exception cref="T:System.ObjectDisposedException">
  46478. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  46479. </exception>
  46480. <exception cref="T:MailKit.ServiceNotConnectedException">
  46481. The <see cref="T:MailKit.IMailStore"/> is not connected.
  46482. </exception>
  46483. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  46484. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  46485. </exception>
  46486. <exception cref="T:MailKit.FolderNotOpenException">
  46487. The folder is not currently open.
  46488. </exception>
  46489. <exception cref="T:MailKit.MessageNotFoundException">
  46490. The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
  46491. </exception>
  46492. <exception cref="T:System.OperationCanceledException">
  46493. The operation was canceled via the cancellation token.
  46494. </exception>
  46495. <exception cref="T:System.IO.IOException">
  46496. An I/O error occurred.
  46497. </exception>
  46498. <exception cref="T:MailKit.ProtocolException">
  46499. The server's response contained unexpected tokens.
  46500. </exception>
  46501. <exception cref="T:MailKit.CommandException">
  46502. The command failed.
  46503. </exception>
  46504. </member>
  46505. <member name="M:MailKit.MailFolder.GetStream(MailKit.UniqueId,System.String,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  46506. <summary>
  46507. Get a substream of the specified message.
  46508. </summary>
  46509. <remarks>
  46510. <para>Gets a substream of the specified message. If the starting offset is beyond
  46511. the end of the specified section of the message, an empty stream is returned. If
  46512. the number of bytes desired extends beyond the end of the section, a truncated
  46513. stream will be returned.</para>
  46514. <para>For more information about how to construct the <paramref name="section"/>,
  46515. see Section 6.4.5 of RFC3501.</para>
  46516. </remarks>
  46517. <returns>The stream.</returns>
  46518. <param name="uid">The UID of the message.</param>
  46519. <param name="section">The desired section of the message.</param>
  46520. <param name="offset">The starting offset of the first desired byte.</param>
  46521. <param name="count">The number of bytes desired.</param>
  46522. <param name="cancellationToken">The cancellation token.</param>
  46523. <param name="progress">The progress reporting mechanism.</param>
  46524. <exception cref="T:System.ArgumentException">
  46525. <paramref name="uid"/> is invalid.
  46526. </exception>
  46527. <exception cref="T:System.ArgumentNullException">
  46528. <paramref name="section"/> is <c>null</c>.
  46529. </exception>
  46530. <exception cref="T:System.ArgumentOutOfRangeException">
  46531. <para><paramref name="offset"/> is negative.</para>
  46532. <para>-or-</para>
  46533. <para><paramref name="count"/> is negative.</para>
  46534. </exception>
  46535. <exception cref="T:System.ObjectDisposedException">
  46536. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  46537. </exception>
  46538. <exception cref="T:MailKit.ServiceNotConnectedException">
  46539. The <see cref="T:MailKit.IMailStore"/> is not connected.
  46540. </exception>
  46541. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  46542. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  46543. </exception>
  46544. <exception cref="T:MailKit.FolderNotOpenException">
  46545. The folder is not currently open.
  46546. </exception>
  46547. <exception cref="T:MailKit.MessageNotFoundException">
  46548. The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
  46549. </exception>
  46550. <exception cref="T:System.OperationCanceledException">
  46551. The operation was canceled via the cancellation token.
  46552. </exception>
  46553. <exception cref="T:System.IO.IOException">
  46554. An I/O error occurred.
  46555. </exception>
  46556. <exception cref="T:MailKit.ProtocolException">
  46557. The server's response contained unexpected tokens.
  46558. </exception>
  46559. <exception cref="T:MailKit.CommandException">
  46560. The command failed.
  46561. </exception>
  46562. </member>
  46563. <member name="M:MailKit.MailFolder.GetStreamAsync(MailKit.UniqueId,System.String,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  46564. <summary>
  46565. Asynchronously get a substream of the specified message.
  46566. </summary>
  46567. <remarks>
  46568. <para>Asynchronously gets a substream of the specified message. If the starting
  46569. offset is beyond the end of the specified section of the message, an empty stream
  46570. is returned. If the number of bytes desired extends beyond the end of the section,
  46571. a truncated stream will be returned.</para>
  46572. <para>For more information about how to construct the <paramref name="section"/>,
  46573. see Section 6.4.5 of RFC3501.</para>
  46574. </remarks>
  46575. <returns>The stream.</returns>
  46576. <param name="uid">The UID of the message.</param>
  46577. <param name="section">The desired section of the message.</param>
  46578. <param name="offset">The starting offset of the first desired byte.</param>
  46579. <param name="count">The number of bytes desired.</param>
  46580. <param name="cancellationToken">The cancellation token.</param>
  46581. <param name="progress">The progress reporting mechanism.</param>
  46582. <exception cref="T:System.ArgumentException">
  46583. <paramref name="uid"/> is invalid.
  46584. </exception>
  46585. <exception cref="T:System.ArgumentNullException">
  46586. <paramref name="section"/> is <c>null</c>.
  46587. </exception>
  46588. <exception cref="T:System.ArgumentOutOfRangeException">
  46589. <para><paramref name="offset"/> is negative.</para>
  46590. <para>-or-</para>
  46591. <para><paramref name="count"/> is negative.</para>
  46592. </exception>
  46593. <exception cref="T:System.ObjectDisposedException">
  46594. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  46595. </exception>
  46596. <exception cref="T:MailKit.ServiceNotConnectedException">
  46597. The <see cref="T:MailKit.IMailStore"/> is not connected.
  46598. </exception>
  46599. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  46600. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  46601. </exception>
  46602. <exception cref="T:MailKit.FolderNotOpenException">
  46603. The folder is not currently open.
  46604. </exception>
  46605. <exception cref="T:MailKit.MessageNotFoundException">
  46606. The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
  46607. </exception>
  46608. <exception cref="T:System.OperationCanceledException">
  46609. The operation was canceled via the cancellation token.
  46610. </exception>
  46611. <exception cref="T:System.IO.IOException">
  46612. An I/O error occurred.
  46613. </exception>
  46614. <exception cref="T:MailKit.ProtocolException">
  46615. The server's response contained unexpected tokens.
  46616. </exception>
  46617. <exception cref="T:MailKit.CommandException">
  46618. The command failed.
  46619. </exception>
  46620. </member>
  46621. <member name="M:MailKit.MailFolder.GetStream(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  46622. <summary>
  46623. Get a substream of the specified message.
  46624. </summary>
  46625. <remarks>
  46626. <para>Gets a substream of the specified message.</para>
  46627. <para>For more information about how to construct the <paramref name="section"/>,
  46628. see Section 6.4.5 of RFC3501.</para>
  46629. </remarks>
  46630. <returns>The stream.</returns>
  46631. <param name="index">The index of the message.</param>
  46632. <param name="section">The desired section of the message.</param>
  46633. <param name="cancellationToken">The cancellation token.</param>
  46634. <param name="progress">The progress reporting mechanism.</param>
  46635. <exception cref="T:System.ArgumentNullException">
  46636. <paramref name="section"/> is <c>null</c>.
  46637. </exception>
  46638. <exception cref="T:System.ArgumentOutOfRangeException">
  46639. <paramref name="index"/> is out of range.
  46640. </exception>
  46641. <exception cref="T:System.ObjectDisposedException">
  46642. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  46643. </exception>
  46644. <exception cref="T:MailKit.ServiceNotConnectedException">
  46645. The <see cref="T:MailKit.IMailStore"/> is not connected.
  46646. </exception>
  46647. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  46648. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  46649. </exception>
  46650. <exception cref="T:MailKit.FolderNotOpenException">
  46651. The folder is not currently open.
  46652. </exception>
  46653. <exception cref="T:MailKit.MessageNotFoundException">
  46654. The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
  46655. </exception>
  46656. <exception cref="T:System.OperationCanceledException">
  46657. The operation was canceled via the cancellation token.
  46658. </exception>
  46659. <exception cref="T:System.IO.IOException">
  46660. An I/O error occurred.
  46661. </exception>
  46662. <exception cref="T:MailKit.ProtocolException">
  46663. The server's response contained unexpected tokens.
  46664. </exception>
  46665. <exception cref="T:MailKit.CommandException">
  46666. The command failed.
  46667. </exception>
  46668. </member>
  46669. <member name="M:MailKit.MailFolder.GetStreamAsync(System.Int32,System.String,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  46670. <summary>
  46671. Asynchronously get a substream of the specified body part.
  46672. </summary>
  46673. <remarks>
  46674. <para>Asynchronously gets a substream of the specified message.</para>
  46675. <para>For more information about how to construct the <paramref name="section"/>,
  46676. see Section 6.4.5 of RFC3501.</para>
  46677. </remarks>
  46678. <returns>The stream.</returns>
  46679. <param name="index">The index of the message.</param>
  46680. <param name="section">The desired section of the message.</param>
  46681. <param name="cancellationToken">The cancellation token.</param>
  46682. <param name="progress">The progress reporting mechanism.</param>
  46683. <exception cref="T:System.ArgumentNullException">
  46684. <paramref name="section"/> is <c>null</c>.
  46685. </exception>
  46686. <exception cref="T:System.ArgumentOutOfRangeException">
  46687. <paramref name="index"/> is out of range.
  46688. </exception>
  46689. <exception cref="T:System.ObjectDisposedException">
  46690. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  46691. </exception>
  46692. <exception cref="T:MailKit.ServiceNotConnectedException">
  46693. The <see cref="T:MailKit.IMailStore"/> is not connected.
  46694. </exception>
  46695. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  46696. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  46697. </exception>
  46698. <exception cref="T:MailKit.FolderNotOpenException">
  46699. The folder is not currently open.
  46700. </exception>
  46701. <exception cref="T:MailKit.MessageNotFoundException">
  46702. The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
  46703. </exception>
  46704. <exception cref="T:System.OperationCanceledException">
  46705. The operation was canceled via the cancellation token.
  46706. </exception>
  46707. <exception cref="T:System.IO.IOException">
  46708. An I/O error occurred.
  46709. </exception>
  46710. <exception cref="T:MailKit.ProtocolException">
  46711. The server's response contained unexpected tokens.
  46712. </exception>
  46713. <exception cref="T:MailKit.CommandException">
  46714. The command failed.
  46715. </exception>
  46716. </member>
  46717. <member name="M:MailKit.MailFolder.GetStream(System.Int32,System.String,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  46718. <summary>
  46719. Get a substream of the specified message.
  46720. </summary>
  46721. <remarks>
  46722. <para>Gets a substream of the specified message. If the starting offset is beyond
  46723. the end of the specified section of the message, an empty stream is returned. If
  46724. the number of bytes desired extends beyond the end of the section, a truncated
  46725. stream will be returned.</para>
  46726. <para>For more information about how to construct the <paramref name="section"/>,
  46727. see Section 6.4.5 of RFC3501.</para>
  46728. </remarks>
  46729. <returns>The stream.</returns>
  46730. <param name="index">The index of the message.</param>
  46731. <param name="section">The desired section of the message.</param>
  46732. <param name="offset">The starting offset of the first desired byte.</param>
  46733. <param name="count">The number of bytes desired.</param>
  46734. <param name="cancellationToken">The cancellation token.</param>
  46735. <param name="progress">The progress reporting mechanism.</param>
  46736. <exception cref="T:System.ArgumentNullException">
  46737. <paramref name="section"/> is <c>null</c>.
  46738. </exception>
  46739. <exception cref="T:System.ArgumentOutOfRangeException">
  46740. <para><paramref name="index"/> is out of range.</para>
  46741. <para>-or-</para>
  46742. <para><paramref name="offset"/> is negative.</para>
  46743. <para>-or-</para>
  46744. <para><paramref name="count"/> is negative.</para>
  46745. </exception>
  46746. <exception cref="T:System.ObjectDisposedException">
  46747. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  46748. </exception>
  46749. <exception cref="T:MailKit.ServiceNotConnectedException">
  46750. The <see cref="T:MailKit.IMailStore"/> is not connected.
  46751. </exception>
  46752. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  46753. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  46754. </exception>
  46755. <exception cref="T:MailKit.FolderNotOpenException">
  46756. The folder is not currently open.
  46757. </exception>
  46758. <exception cref="T:MailKit.MessageNotFoundException">
  46759. The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
  46760. </exception>
  46761. <exception cref="T:System.OperationCanceledException">
  46762. The operation was canceled via the cancellation token.
  46763. </exception>
  46764. <exception cref="T:System.IO.IOException">
  46765. An I/O error occurred.
  46766. </exception>
  46767. <exception cref="T:MailKit.ProtocolException">
  46768. The server's response contained unexpected tokens.
  46769. </exception>
  46770. <exception cref="T:MailKit.CommandException">
  46771. The command failed.
  46772. </exception>
  46773. </member>
  46774. <member name="M:MailKit.MailFolder.GetStreamAsync(System.Int32,System.String,System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  46775. <summary>
  46776. Asynchronously get a substream of the specified body part.
  46777. </summary>
  46778. <remarks>
  46779. <para>Asynchronously gets a substream of the specified message. If the starting
  46780. offset is beyond the end of the specified section of the message, an empty stream
  46781. is returned. If the number of bytes desired extends beyond the end of the section,
  46782. a truncated stream will be returned.</para>
  46783. <para>For more information about how to construct the <paramref name="section"/>,
  46784. see Section 6.4.5 of RFC3501.</para>
  46785. </remarks>
  46786. <returns>The stream.</returns>
  46787. <param name="index">The index of the message.</param>
  46788. <param name="section">The desired section of the message.</param>
  46789. <param name="offset">The starting offset of the first desired byte.</param>
  46790. <param name="count">The number of bytes desired.</param>
  46791. <param name="cancellationToken">The cancellation token.</param>
  46792. <param name="progress">The progress reporting mechanism.</param>
  46793. <exception cref="T:System.ArgumentNullException">
  46794. <paramref name="section"/> is <c>null</c>.
  46795. </exception>
  46796. <exception cref="T:System.ArgumentOutOfRangeException">
  46797. <para><paramref name="index"/> is out of range.</para>
  46798. <para>-or-</para>
  46799. <para><paramref name="offset"/> is negative.</para>
  46800. <para>-or-</para>
  46801. <para><paramref name="count"/> is negative.</para>
  46802. </exception>
  46803. <exception cref="T:System.ObjectDisposedException">
  46804. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  46805. </exception>
  46806. <exception cref="T:MailKit.ServiceNotConnectedException">
  46807. The <see cref="T:MailKit.IMailStore"/> is not connected.
  46808. </exception>
  46809. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  46810. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  46811. </exception>
  46812. <exception cref="T:MailKit.FolderNotOpenException">
  46813. The folder is not currently open.
  46814. </exception>
  46815. <exception cref="T:MailKit.MessageNotFoundException">
  46816. The <see cref="T:MailKit.IMailStore"/> did not return the requested message stream.
  46817. </exception>
  46818. <exception cref="T:System.OperationCanceledException">
  46819. The operation was canceled via the cancellation token.
  46820. </exception>
  46821. <exception cref="T:System.IO.IOException">
  46822. An I/O error occurred.
  46823. </exception>
  46824. <exception cref="T:MailKit.ProtocolException">
  46825. The server's response contained unexpected tokens.
  46826. </exception>
  46827. <exception cref="T:MailKit.CommandException">
  46828. The command failed.
  46829. </exception>
  46830. </member>
  46831. <member name="M:MailKit.MailFolder.AddFlags(MailKit.UniqueId,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  46832. <summary>
  46833. Add a set of flags to the specified message.
  46834. </summary>
  46835. <remarks>
  46836. Adds a set of flags to the specified message.
  46837. </remarks>
  46838. <param name="uid">The UID of the message.</param>
  46839. <param name="flags">The message flags to add.</param>
  46840. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  46841. <param name="cancellationToken">The cancellation token.</param>
  46842. <exception cref="T:System.ArgumentException">
  46843. <para><paramref name="uid"/> is invalid.</para>
  46844. <para>-or-</para>
  46845. <para>No flags were specified.</para>
  46846. </exception>
  46847. <exception cref="T:System.ObjectDisposedException">
  46848. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  46849. </exception>
  46850. <exception cref="T:MailKit.ServiceNotConnectedException">
  46851. The <see cref="T:MailKit.IMailStore"/> is not connected.
  46852. </exception>
  46853. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  46854. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  46855. </exception>
  46856. <exception cref="T:MailKit.FolderNotOpenException">
  46857. The folder is not currently open in read-write mode.
  46858. </exception>
  46859. <exception cref="T:System.OperationCanceledException">
  46860. The operation was canceled via the cancellation token.
  46861. </exception>
  46862. <exception cref="T:System.IO.IOException">
  46863. An I/O error occurred.
  46864. </exception>
  46865. <exception cref="T:MailKit.ProtocolException">
  46866. The server's response contained unexpected tokens.
  46867. </exception>
  46868. <exception cref="T:MailKit.CommandException">
  46869. The command failed.
  46870. </exception>
  46871. </member>
  46872. <member name="M:MailKit.MailFolder.AddFlagsAsync(MailKit.UniqueId,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  46873. <summary>
  46874. Asynchronously add a set of flags to the specified message.
  46875. </summary>
  46876. <remarks>
  46877. Asynchronously adds a set of flags to the specified message.
  46878. </remarks>
  46879. <returns>An asynchronous task context.</returns>
  46880. <param name="uid">The UID of the message.</param>
  46881. <param name="flags">The message flags to add.</param>
  46882. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  46883. <param name="cancellationToken">The cancellation token.</param>
  46884. <exception cref="T:System.ArgumentException">
  46885. <para><paramref name="uid"/> is invalid.</para>
  46886. <para>-or-</para>
  46887. <para>No flags were specified.</para>
  46888. </exception>
  46889. <exception cref="T:System.ObjectDisposedException">
  46890. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  46891. </exception>
  46892. <exception cref="T:MailKit.FolderNotOpenException">
  46893. The folder is not currently open in read-write mode.
  46894. </exception>
  46895. <exception cref="T:MailKit.ServiceNotConnectedException">
  46896. The <see cref="T:MailKit.IMailStore"/> is not connected.
  46897. </exception>
  46898. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  46899. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  46900. </exception>
  46901. <exception cref="T:MailKit.FolderNotOpenException">
  46902. The folder is not currently open in read-write mode.
  46903. </exception>
  46904. <exception cref="T:System.OperationCanceledException">
  46905. The operation was canceled via the cancellation token.
  46906. </exception>
  46907. <exception cref="T:System.IO.IOException">
  46908. An I/O error occurred.
  46909. </exception>
  46910. <exception cref="T:MailKit.ProtocolException">
  46911. The server's response contained unexpected tokens.
  46912. </exception>
  46913. <exception cref="T:MailKit.CommandException">
  46914. The command failed.
  46915. </exception>
  46916. </member>
  46917. <member name="M:MailKit.MailFolder.AddFlags(MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  46918. <summary>
  46919. Add a set of flags to the specified message.
  46920. </summary>
  46921. <remarks>
  46922. Adds a set of flags to the specified message.
  46923. </remarks>
  46924. <param name="uid">The UID of the message.</param>
  46925. <param name="flags">The message flags to add.</param>
  46926. <param name="keywords">A set of user-defined flags to add.</param>
  46927. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  46928. <param name="cancellationToken">The cancellation token.</param>
  46929. <exception cref="T:System.ArgumentException">
  46930. <para><paramref name="uid"/> is invalid.</para>
  46931. <para>-or-</para>
  46932. <para>No flags were specified.</para>
  46933. </exception>
  46934. <exception cref="T:System.ObjectDisposedException">
  46935. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  46936. </exception>
  46937. <exception cref="T:MailKit.FolderNotOpenException">
  46938. The folder is not currently open in read-write mode.
  46939. </exception>
  46940. <exception cref="T:MailKit.ServiceNotConnectedException">
  46941. The <see cref="T:MailKit.IMailStore"/> is not connected.
  46942. </exception>
  46943. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  46944. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  46945. </exception>
  46946. <exception cref="T:MailKit.FolderNotOpenException">
  46947. The folder is not currently open in read-write mode.
  46948. </exception>
  46949. <exception cref="T:System.OperationCanceledException">
  46950. The operation was canceled via the cancellation token.
  46951. </exception>
  46952. <exception cref="T:System.IO.IOException">
  46953. An I/O error occurred.
  46954. </exception>
  46955. <exception cref="T:MailKit.ProtocolException">
  46956. The server's response contained unexpected tokens.
  46957. </exception>
  46958. <exception cref="T:MailKit.CommandException">
  46959. The command failed.
  46960. </exception>
  46961. </member>
  46962. <member name="M:MailKit.MailFolder.AddFlagsAsync(MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  46963. <summary>
  46964. Asynchronously add a set of flags to the specified message.
  46965. </summary>
  46966. <remarks>
  46967. Asynchronously adds a set of flags to the specified message.
  46968. </remarks>
  46969. <returns>An asynchronous task context.</returns>
  46970. <param name="uid">The UID of the message.</param>
  46971. <param name="flags">The message flags to add.</param>
  46972. <param name="keywords">A set of user-defined flags to add.</param>
  46973. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  46974. <param name="cancellationToken">The cancellation token.</param>
  46975. <exception cref="T:System.ArgumentException">
  46976. <para><paramref name="uid"/> is invalid.</para>
  46977. <para>-or-</para>
  46978. <para>No flags were specified.</para>
  46979. </exception>
  46980. <exception cref="T:System.ObjectDisposedException">
  46981. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  46982. </exception>
  46983. <exception cref="T:MailKit.FolderNotOpenException">
  46984. The folder is not currently open in read-write mode.
  46985. </exception>
  46986. <exception cref="T:MailKit.ServiceNotConnectedException">
  46987. The <see cref="T:MailKit.IMailStore"/> is not connected.
  46988. </exception>
  46989. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  46990. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  46991. </exception>
  46992. <exception cref="T:MailKit.FolderNotOpenException">
  46993. The folder is not currently open in read-write mode.
  46994. </exception>
  46995. <exception cref="T:System.OperationCanceledException">
  46996. The operation was canceled via the cancellation token.
  46997. </exception>
  46998. <exception cref="T:System.IO.IOException">
  46999. An I/O error occurred.
  47000. </exception>
  47001. <exception cref="T:MailKit.ProtocolException">
  47002. The server's response contained unexpected tokens.
  47003. </exception>
  47004. <exception cref="T:MailKit.CommandException">
  47005. The command failed.
  47006. </exception>
  47007. </member>
  47008. <member name="M:MailKit.MailFolder.AddFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  47009. <summary>
  47010. Add a set of flags to the specified messages.
  47011. </summary>
  47012. <remarks>
  47013. Adds a set of flags to the specified messages.
  47014. </remarks>
  47015. <param name="uids">The UIDs of the messages.</param>
  47016. <param name="flags">The message flags to add.</param>
  47017. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  47018. <param name="cancellationToken">The cancellation token.</param>
  47019. <exception cref="T:System.ArgumentNullException">
  47020. <paramref name="uids"/> is <c>null</c>.
  47021. </exception>
  47022. <exception cref="T:System.ArgumentException">
  47023. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  47024. <para>-or-</para>
  47025. <para>No flags were specified.</para>
  47026. </exception>
  47027. <exception cref="T:System.ObjectDisposedException">
  47028. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  47029. </exception>
  47030. <exception cref="T:MailKit.FolderNotOpenException">
  47031. The folder is not currently open in read-write mode.
  47032. </exception>
  47033. <exception cref="T:MailKit.ServiceNotConnectedException">
  47034. The <see cref="T:MailKit.IMailStore"/> is not connected.
  47035. </exception>
  47036. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  47037. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  47038. </exception>
  47039. <exception cref="T:MailKit.FolderNotOpenException">
  47040. The folder is not currently open in read-write mode.
  47041. </exception>
  47042. <exception cref="T:System.OperationCanceledException">
  47043. The operation was canceled via the cancellation token.
  47044. </exception>
  47045. <exception cref="T:System.IO.IOException">
  47046. An I/O error occurred.
  47047. </exception>
  47048. <exception cref="T:MailKit.ProtocolException">
  47049. The server's response contained unexpected tokens.
  47050. </exception>
  47051. <exception cref="T:MailKit.CommandException">
  47052. The command failed.
  47053. </exception>
  47054. </member>
  47055. <member name="M:MailKit.MailFolder.AddFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  47056. <summary>
  47057. Asynchronously add a set of flags to the specified messages.
  47058. </summary>
  47059. <remarks>
  47060. Asynchronously adds a set of flags to the specified messages.
  47061. </remarks>
  47062. <returns>An asynchronous task context.</returns>
  47063. <param name="uids">The UIDs of the messages.</param>
  47064. <param name="flags">The message flags to add.</param>
  47065. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  47066. <param name="cancellationToken">The cancellation token.</param>
  47067. <exception cref="T:System.ArgumentNullException">
  47068. <paramref name="uids"/> is <c>null</c>.
  47069. </exception>
  47070. <exception cref="T:System.ArgumentException">
  47071. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  47072. <para>-or-</para>
  47073. <para>No flags were specified.</para>
  47074. </exception>
  47075. <exception cref="T:System.ObjectDisposedException">
  47076. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  47077. </exception>
  47078. <exception cref="T:MailKit.FolderNotOpenException">
  47079. The folder is not currently open in read-write mode.
  47080. </exception>
  47081. <exception cref="T:MailKit.ServiceNotConnectedException">
  47082. The <see cref="T:MailKit.IMailStore"/> is not connected.
  47083. </exception>
  47084. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  47085. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  47086. </exception>
  47087. <exception cref="T:MailKit.FolderNotOpenException">
  47088. The folder is not currently open in read-write mode.
  47089. </exception>
  47090. <exception cref="T:System.OperationCanceledException">
  47091. The operation was canceled via the cancellation token.
  47092. </exception>
  47093. <exception cref="T:System.IO.IOException">
  47094. An I/O error occurred.
  47095. </exception>
  47096. <exception cref="T:MailKit.ProtocolException">
  47097. The server's response contained unexpected tokens.
  47098. </exception>
  47099. <exception cref="T:MailKit.CommandException">
  47100. The command failed.
  47101. </exception>
  47102. </member>
  47103. <member name="M:MailKit.MailFolder.AddFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  47104. <summary>
  47105. Add a set of flags to the specified messages.
  47106. </summary>
  47107. <remarks>
  47108. Adds a set of flags to the specified messages.
  47109. </remarks>
  47110. <param name="uids">The UIDs of the messages.</param>
  47111. <param name="flags">The message flags to add.</param>
  47112. <param name="keywords">A set of user-defined flags to add.</param>
  47113. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  47114. <param name="cancellationToken">The cancellation token.</param>
  47115. <exception cref="T:System.ArgumentNullException">
  47116. <paramref name="uids"/> is <c>null</c>.
  47117. </exception>
  47118. <exception cref="T:System.ArgumentException">
  47119. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  47120. <para>-or-</para>
  47121. <para>No flags were specified.</para>
  47122. </exception>
  47123. <exception cref="T:System.ObjectDisposedException">
  47124. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  47125. </exception>
  47126. <exception cref="T:MailKit.FolderNotOpenException">
  47127. The folder is not currently open in read-write mode.
  47128. </exception>
  47129. <exception cref="T:MailKit.ServiceNotConnectedException">
  47130. The <see cref="T:MailKit.IMailStore"/> is not connected.
  47131. </exception>
  47132. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  47133. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  47134. </exception>
  47135. <exception cref="T:MailKit.FolderNotOpenException">
  47136. The folder is not currently open in read-write mode.
  47137. </exception>
  47138. <exception cref="T:System.OperationCanceledException">
  47139. The operation was canceled via the cancellation token.
  47140. </exception>
  47141. <exception cref="T:System.IO.IOException">
  47142. An I/O error occurred.
  47143. </exception>
  47144. <exception cref="T:MailKit.ProtocolException">
  47145. The server's response contained unexpected tokens.
  47146. </exception>
  47147. <exception cref="T:MailKit.CommandException">
  47148. The command failed.
  47149. </exception>
  47150. </member>
  47151. <member name="M:MailKit.MailFolder.AddFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  47152. <summary>
  47153. Asynchronously add a set of flags to the specified messages.
  47154. </summary>
  47155. <remarks>
  47156. Asynchronously adds a set of flags to the specified messages.
  47157. </remarks>
  47158. <returns>An asynchronous task context.</returns>
  47159. <param name="uids">The UIDs of the messages.</param>
  47160. <param name="flags">The message flags to add.</param>
  47161. <param name="keywords">A set of user-defined flags to add.</param>
  47162. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  47163. <param name="cancellationToken">The cancellation token.</param>
  47164. <exception cref="T:System.ArgumentNullException">
  47165. <paramref name="uids"/> is <c>null</c>.
  47166. </exception>
  47167. <exception cref="T:System.ArgumentException">
  47168. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  47169. <para>-or-</para>
  47170. <para>No flags were specified.</para>
  47171. </exception>
  47172. <exception cref="T:System.ObjectDisposedException">
  47173. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  47174. </exception>
  47175. <exception cref="T:MailKit.FolderNotOpenException">
  47176. The folder is not currently open in read-write mode.
  47177. </exception>
  47178. <exception cref="T:MailKit.ServiceNotConnectedException">
  47179. The <see cref="T:MailKit.IMailStore"/> is not connected.
  47180. </exception>
  47181. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  47182. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  47183. </exception>
  47184. <exception cref="T:MailKit.FolderNotOpenException">
  47185. The folder is not currently open in read-write mode.
  47186. </exception>
  47187. <exception cref="T:System.OperationCanceledException">
  47188. The operation was canceled via the cancellation token.
  47189. </exception>
  47190. <exception cref="T:System.IO.IOException">
  47191. An I/O error occurred.
  47192. </exception>
  47193. <exception cref="T:MailKit.ProtocolException">
  47194. The server's response contained unexpected tokens.
  47195. </exception>
  47196. <exception cref="T:MailKit.CommandException">
  47197. The command failed.
  47198. </exception>
  47199. </member>
  47200. <member name="M:MailKit.MailFolder.RemoveFlags(MailKit.UniqueId,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  47201. <summary>
  47202. Remove a set of flags from the specified message.
  47203. </summary>
  47204. <remarks>
  47205. Removes a set of flags from the specified message.
  47206. </remarks>
  47207. <param name="uid">The UIDs of the message.</param>
  47208. <param name="flags">The message flags to remove.</param>
  47209. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  47210. <param name="cancellationToken">The cancellation token.</param>
  47211. <exception cref="T:System.ArgumentException">
  47212. <para><paramref name="uid"/> is invalid.</para>
  47213. <para>-or-</para>
  47214. <para>No flags were specified.</para>
  47215. </exception>
  47216. <exception cref="T:System.ObjectDisposedException">
  47217. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  47218. </exception>
  47219. <exception cref="T:MailKit.FolderNotOpenException">
  47220. The folder is not currently open in read-write mode.
  47221. </exception>
  47222. <exception cref="T:MailKit.ServiceNotConnectedException">
  47223. The <see cref="T:MailKit.IMailStore"/> is not connected.
  47224. </exception>
  47225. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  47226. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  47227. </exception>
  47228. <exception cref="T:MailKit.FolderNotOpenException">
  47229. The folder is not currently open in read-write mode.
  47230. </exception>
  47231. <exception cref="T:System.OperationCanceledException">
  47232. The operation was canceled via the cancellation token.
  47233. </exception>
  47234. <exception cref="T:System.IO.IOException">
  47235. An I/O error occurred.
  47236. </exception>
  47237. <exception cref="T:MailKit.ProtocolException">
  47238. The server's response contained unexpected tokens.
  47239. </exception>
  47240. <exception cref="T:MailKit.CommandException">
  47241. The command failed.
  47242. </exception>
  47243. </member>
  47244. <member name="M:MailKit.MailFolder.RemoveFlagsAsync(MailKit.UniqueId,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  47245. <summary>
  47246. Asynchronously remove a set of flags from the specified message.
  47247. </summary>
  47248. <remarks>
  47249. Asynchronously removes a set of flags from the specified message.
  47250. </remarks>
  47251. <returns>An asynchronous task context.</returns>
  47252. <param name="uid">The UID of the message.</param>
  47253. <param name="flags">The message flags to remove.</param>
  47254. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  47255. <param name="cancellationToken">The cancellation token.</param>
  47256. <exception cref="T:System.ArgumentException">
  47257. <para><paramref name="uid"/> is invalid.</para>
  47258. <para>-or-</para>
  47259. <para>No flags were specified.</para>
  47260. </exception>
  47261. <exception cref="T:System.ObjectDisposedException">
  47262. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  47263. </exception>
  47264. <exception cref="T:MailKit.FolderNotOpenException">
  47265. The folder is not currently open in read-write mode.
  47266. </exception>
  47267. <exception cref="T:MailKit.ServiceNotConnectedException">
  47268. The <see cref="T:MailKit.IMailStore"/> is not connected.
  47269. </exception>
  47270. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  47271. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  47272. </exception>
  47273. <exception cref="T:MailKit.FolderNotOpenException">
  47274. The folder is not currently open in read-write mode.
  47275. </exception>
  47276. <exception cref="T:System.OperationCanceledException">
  47277. The operation was canceled via the cancellation token.
  47278. </exception>
  47279. <exception cref="T:System.IO.IOException">
  47280. An I/O error occurred.
  47281. </exception>
  47282. <exception cref="T:MailKit.ProtocolException">
  47283. The server's response contained unexpected tokens.
  47284. </exception>
  47285. <exception cref="T:MailKit.CommandException">
  47286. The command failed.
  47287. </exception>
  47288. </member>
  47289. <member name="M:MailKit.MailFolder.RemoveFlags(MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  47290. <summary>
  47291. Remove a set of flags from the specified message.
  47292. </summary>
  47293. <remarks>
  47294. Removes a set of flags from the specified message.
  47295. </remarks>
  47296. <param name="uid">The UIDs of the message.</param>
  47297. <param name="flags">The message flags to remove.</param>
  47298. <param name="keywords">A set of user-defined flags to remove.</param>
  47299. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  47300. <param name="cancellationToken">The cancellation token.</param>
  47301. <exception cref="T:System.ArgumentException">
  47302. <para><paramref name="uid"/> is invalid.</para>
  47303. <para>-or-</para>
  47304. <para>No flags were specified.</para>
  47305. </exception>
  47306. <exception cref="T:System.ObjectDisposedException">
  47307. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  47308. </exception>
  47309. <exception cref="T:MailKit.FolderNotOpenException">
  47310. The folder is not currently open in read-write mode.
  47311. </exception>
  47312. <exception cref="T:MailKit.ServiceNotConnectedException">
  47313. The <see cref="T:MailKit.IMailStore"/> is not connected.
  47314. </exception>
  47315. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  47316. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  47317. </exception>
  47318. <exception cref="T:MailKit.FolderNotOpenException">
  47319. The folder is not currently open in read-write mode.
  47320. </exception>
  47321. <exception cref="T:System.OperationCanceledException">
  47322. The operation was canceled via the cancellation token.
  47323. </exception>
  47324. <exception cref="T:System.IO.IOException">
  47325. An I/O error occurred.
  47326. </exception>
  47327. <exception cref="T:MailKit.ProtocolException">
  47328. The server's response contained unexpected tokens.
  47329. </exception>
  47330. <exception cref="T:MailKit.CommandException">
  47331. The command failed.
  47332. </exception>
  47333. </member>
  47334. <member name="M:MailKit.MailFolder.RemoveFlagsAsync(MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  47335. <summary>
  47336. Asynchronously remove a set of flags from the specified message.
  47337. </summary>
  47338. <remarks>
  47339. Asynchronously removes a set of flags from the specified message.
  47340. </remarks>
  47341. <returns>An asynchronous task context.</returns>
  47342. <param name="uid">The UID of the message.</param>
  47343. <param name="flags">The message flags to remove.</param>
  47344. <param name="keywords">A set of user-defined flags to remove.</param>
  47345. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  47346. <param name="cancellationToken">The cancellation token.</param>
  47347. <exception cref="T:System.ArgumentException">
  47348. <para><paramref name="uid"/> is invalid.</para>
  47349. <para>-or-</para>
  47350. <para>No flags were specified.</para>
  47351. </exception>
  47352. <exception cref="T:System.ObjectDisposedException">
  47353. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  47354. </exception>
  47355. <exception cref="T:MailKit.FolderNotOpenException">
  47356. The folder is not currently open in read-write mode.
  47357. </exception>
  47358. <exception cref="T:MailKit.ServiceNotConnectedException">
  47359. The <see cref="T:MailKit.IMailStore"/> is not connected.
  47360. </exception>
  47361. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  47362. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  47363. </exception>
  47364. <exception cref="T:MailKit.FolderNotOpenException">
  47365. The folder is not currently open in read-write mode.
  47366. </exception>
  47367. <exception cref="T:System.OperationCanceledException">
  47368. The operation was canceled via the cancellation token.
  47369. </exception>
  47370. <exception cref="T:System.IO.IOException">
  47371. An I/O error occurred.
  47372. </exception>
  47373. <exception cref="T:MailKit.ProtocolException">
  47374. The server's response contained unexpected tokens.
  47375. </exception>
  47376. <exception cref="T:MailKit.CommandException">
  47377. The command failed.
  47378. </exception>
  47379. </member>
  47380. <member name="M:MailKit.MailFolder.RemoveFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  47381. <summary>
  47382. Remove a set of flags from the specified messages.
  47383. </summary>
  47384. <remarks>
  47385. Removes a set of flags from the specified messages.
  47386. </remarks>
  47387. <param name="uids">The UIDs of the messages.</param>
  47388. <param name="flags">The message flags to remove.</param>
  47389. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  47390. <param name="cancellationToken">The cancellation token.</param>
  47391. <exception cref="T:System.ArgumentNullException">
  47392. <paramref name="uids"/> is <c>null</c>.
  47393. </exception>
  47394. <exception cref="T:System.ArgumentException">
  47395. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  47396. <para>-or-</para>
  47397. <para>No flags were specified.</para>
  47398. </exception>
  47399. <exception cref="T:System.ObjectDisposedException">
  47400. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  47401. </exception>
  47402. <exception cref="T:MailKit.FolderNotOpenException">
  47403. The folder is not currently open in read-write mode.
  47404. </exception>
  47405. <exception cref="T:MailKit.ServiceNotConnectedException">
  47406. The <see cref="T:MailKit.IMailStore"/> is not connected.
  47407. </exception>
  47408. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  47409. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  47410. </exception>
  47411. <exception cref="T:MailKit.FolderNotOpenException">
  47412. The folder is not currently open in read-write mode.
  47413. </exception>
  47414. <exception cref="T:System.OperationCanceledException">
  47415. The operation was canceled via the cancellation token.
  47416. </exception>
  47417. <exception cref="T:System.IO.IOException">
  47418. An I/O error occurred.
  47419. </exception>
  47420. <exception cref="T:MailKit.ProtocolException">
  47421. The server's response contained unexpected tokens.
  47422. </exception>
  47423. <exception cref="T:MailKit.CommandException">
  47424. The command failed.
  47425. </exception>
  47426. </member>
  47427. <member name="M:MailKit.MailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  47428. <summary>
  47429. Asynchronously remove a set of flags from the specified messages.
  47430. </summary>
  47431. <remarks>
  47432. Asynchronously removes a set of flags from the specified messages.
  47433. </remarks>
  47434. <returns>An asynchronous task context.</returns>
  47435. <param name="uids">The UIDs of the messages.</param>
  47436. <param name="flags">The message flags to remove.</param>
  47437. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  47438. <param name="cancellationToken">The cancellation token.</param>
  47439. <exception cref="T:System.ArgumentNullException">
  47440. <paramref name="uids"/> is <c>null</c>.
  47441. </exception>
  47442. <exception cref="T:System.ArgumentException">
  47443. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  47444. <para>-or-</para>
  47445. <para>No flags were specified.</para>
  47446. </exception>
  47447. <exception cref="T:System.ObjectDisposedException">
  47448. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  47449. </exception>
  47450. <exception cref="T:MailKit.FolderNotOpenException">
  47451. The folder is not currently open in read-write mode.
  47452. </exception>
  47453. <exception cref="T:MailKit.ServiceNotConnectedException">
  47454. The <see cref="T:MailKit.IMailStore"/> is not connected.
  47455. </exception>
  47456. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  47457. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  47458. </exception>
  47459. <exception cref="T:MailKit.FolderNotOpenException">
  47460. The folder is not currently open in read-write mode.
  47461. </exception>
  47462. <exception cref="T:System.OperationCanceledException">
  47463. The operation was canceled via the cancellation token.
  47464. </exception>
  47465. <exception cref="T:System.IO.IOException">
  47466. An I/O error occurred.
  47467. </exception>
  47468. <exception cref="T:MailKit.ProtocolException">
  47469. The server's response contained unexpected tokens.
  47470. </exception>
  47471. <exception cref="T:MailKit.CommandException">
  47472. The command failed.
  47473. </exception>
  47474. </member>
  47475. <member name="M:MailKit.MailFolder.RemoveFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  47476. <summary>
  47477. Remove a set of flags from the specified messages.
  47478. </summary>
  47479. <remarks>
  47480. Removes a set of flags from the specified messages.
  47481. </remarks>
  47482. <param name="uids">The UIDs of the messages.</param>
  47483. <param name="flags">The message flags to remove.</param>
  47484. <param name="keywords">A set of user-defined flags to remove.</param>
  47485. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  47486. <param name="cancellationToken">The cancellation token.</param>
  47487. <exception cref="T:System.ArgumentNullException">
  47488. <paramref name="uids"/> is <c>null</c>.
  47489. </exception>
  47490. <exception cref="T:System.ArgumentException">
  47491. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  47492. <para>-or-</para>
  47493. <para>No flags were specified.</para>
  47494. </exception>
  47495. <exception cref="T:System.ObjectDisposedException">
  47496. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  47497. </exception>
  47498. <exception cref="T:MailKit.FolderNotOpenException">
  47499. The folder is not currently open in read-write mode.
  47500. </exception>
  47501. <exception cref="T:MailKit.ServiceNotConnectedException">
  47502. The <see cref="T:MailKit.IMailStore"/> is not connected.
  47503. </exception>
  47504. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  47505. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  47506. </exception>
  47507. <exception cref="T:MailKit.FolderNotOpenException">
  47508. The folder is not currently open in read-write mode.
  47509. </exception>
  47510. <exception cref="T:System.OperationCanceledException">
  47511. The operation was canceled via the cancellation token.
  47512. </exception>
  47513. <exception cref="T:System.IO.IOException">
  47514. An I/O error occurred.
  47515. </exception>
  47516. <exception cref="T:MailKit.ProtocolException">
  47517. The server's response contained unexpected tokens.
  47518. </exception>
  47519. <exception cref="T:MailKit.CommandException">
  47520. The command failed.
  47521. </exception>
  47522. </member>
  47523. <member name="M:MailKit.MailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  47524. <summary>
  47525. Asynchronously remove a set of flags from the specified messages.
  47526. </summary>
  47527. <remarks>
  47528. Asynchronously removes a set of flags from the specified messages.
  47529. </remarks>
  47530. <returns>An asynchronous task context.</returns>
  47531. <param name="uids">The UIDs of the messages.</param>
  47532. <param name="flags">The message flags to remove.</param>
  47533. <param name="keywords">A set of user-defined flags to remove.</param>
  47534. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  47535. <param name="cancellationToken">The cancellation token.</param>
  47536. <exception cref="T:System.ArgumentNullException">
  47537. <paramref name="uids"/> is <c>null</c>.
  47538. </exception>
  47539. <exception cref="T:System.ArgumentException">
  47540. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  47541. <para>-or-</para>
  47542. <para>No flags were specified.</para>
  47543. </exception>
  47544. <exception cref="T:System.ObjectDisposedException">
  47545. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  47546. </exception>
  47547. <exception cref="T:MailKit.FolderNotOpenException">
  47548. The folder is not currently open in read-write mode.
  47549. </exception>
  47550. <exception cref="T:MailKit.ServiceNotConnectedException">
  47551. The <see cref="T:MailKit.IMailStore"/> is not connected.
  47552. </exception>
  47553. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  47554. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  47555. </exception>
  47556. <exception cref="T:MailKit.FolderNotOpenException">
  47557. The folder is not currently open in read-write mode.
  47558. </exception>
  47559. <exception cref="T:System.OperationCanceledException">
  47560. The operation was canceled via the cancellation token.
  47561. </exception>
  47562. <exception cref="T:System.IO.IOException">
  47563. An I/O error occurred.
  47564. </exception>
  47565. <exception cref="T:MailKit.ProtocolException">
  47566. The server's response contained unexpected tokens.
  47567. </exception>
  47568. <exception cref="T:MailKit.CommandException">
  47569. The command failed.
  47570. </exception>
  47571. </member>
  47572. <member name="M:MailKit.MailFolder.SetFlags(MailKit.UniqueId,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  47573. <summary>
  47574. Set the flags of the specified message.
  47575. </summary>
  47576. <remarks>
  47577. Sets the flags of the specified message.
  47578. </remarks>
  47579. <param name="uid">The UIDs of the message.</param>
  47580. <param name="flags">The message flags to set.</param>
  47581. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  47582. <param name="cancellationToken">The cancellation token.</param>
  47583. <exception cref="T:System.ArgumentException">
  47584. <paramref name="uid"/> is invalid.
  47585. </exception>
  47586. <exception cref="T:System.ObjectDisposedException">
  47587. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  47588. </exception>
  47589. <exception cref="T:MailKit.FolderNotOpenException">
  47590. The folder is not currently open in read-write mode.
  47591. </exception>
  47592. <exception cref="T:MailKit.ServiceNotConnectedException">
  47593. The <see cref="T:MailKit.IMailStore"/> is not connected.
  47594. </exception>
  47595. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  47596. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  47597. </exception>
  47598. <exception cref="T:MailKit.FolderNotOpenException">
  47599. The folder is not currently open in read-write mode.
  47600. </exception>
  47601. <exception cref="T:System.OperationCanceledException">
  47602. The operation was canceled via the cancellation token.
  47603. </exception>
  47604. <exception cref="T:System.IO.IOException">
  47605. An I/O error occurred.
  47606. </exception>
  47607. <exception cref="T:MailKit.ProtocolException">
  47608. The server's response contained unexpected tokens.
  47609. </exception>
  47610. <exception cref="T:MailKit.CommandException">
  47611. The command failed.
  47612. </exception>
  47613. </member>
  47614. <member name="M:MailKit.MailFolder.SetFlagsAsync(MailKit.UniqueId,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  47615. <summary>
  47616. Asynchronously set the flags of the specified message.
  47617. </summary>
  47618. <remarks>
  47619. Asynchronously sets the flags of the specified message.
  47620. </remarks>
  47621. <returns>An asynchronous task context.</returns>
  47622. <param name="uid">The UID of the message.</param>
  47623. <param name="flags">The message flags to set.</param>
  47624. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  47625. <param name="cancellationToken">The cancellation token.</param>
  47626. <exception cref="T:System.ArgumentException">
  47627. <paramref name="uid"/> is invalid.
  47628. </exception>
  47629. <exception cref="T:System.ObjectDisposedException">
  47630. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  47631. </exception>
  47632. <exception cref="T:MailKit.FolderNotOpenException">
  47633. The folder is not currently open in read-write mode.
  47634. </exception>
  47635. <exception cref="T:MailKit.ServiceNotConnectedException">
  47636. The <see cref="T:MailKit.IMailStore"/> is not connected.
  47637. </exception>
  47638. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  47639. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  47640. </exception>
  47641. <exception cref="T:MailKit.FolderNotOpenException">
  47642. The folder is not currently open in read-write mode.
  47643. </exception>
  47644. <exception cref="T:System.OperationCanceledException">
  47645. The operation was canceled via the cancellation token.
  47646. </exception>
  47647. <exception cref="T:System.IO.IOException">
  47648. An I/O error occurred.
  47649. </exception>
  47650. <exception cref="T:MailKit.ProtocolException">
  47651. The server's response contained unexpected tokens.
  47652. </exception>
  47653. <exception cref="T:MailKit.CommandException">
  47654. The command failed.
  47655. </exception>
  47656. </member>
  47657. <member name="M:MailKit.MailFolder.SetFlags(MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  47658. <summary>
  47659. Set the flags of the specified message.
  47660. </summary>
  47661. <remarks>
  47662. Sets the flags of the specified message.
  47663. </remarks>
  47664. <param name="uid">The UIDs of the message.</param>
  47665. <param name="flags">The message flags to set.</param>
  47666. <param name="keywords">A set of user-defined flags to set.</param>
  47667. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  47668. <param name="cancellationToken">The cancellation token.</param>
  47669. <exception cref="T:System.ArgumentException">
  47670. <paramref name="uid"/> is invalid.
  47671. </exception>
  47672. <exception cref="T:System.ObjectDisposedException">
  47673. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  47674. </exception>
  47675. <exception cref="T:MailKit.ServiceNotConnectedException">
  47676. The <see cref="T:MailKit.IMailStore"/> is not connected.
  47677. </exception>
  47678. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  47679. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  47680. </exception>
  47681. <exception cref="T:MailKit.FolderNotOpenException">
  47682. The folder is not currently open in read-write mode.
  47683. </exception>
  47684. <exception cref="T:System.OperationCanceledException">
  47685. The operation was canceled via the cancellation token.
  47686. </exception>
  47687. <exception cref="T:System.IO.IOException">
  47688. An I/O error occurred.
  47689. </exception>
  47690. <exception cref="T:MailKit.ProtocolException">
  47691. The server's response contained unexpected tokens.
  47692. </exception>
  47693. <exception cref="T:MailKit.CommandException">
  47694. The command failed.
  47695. </exception>
  47696. </member>
  47697. <member name="M:MailKit.MailFolder.SetFlagsAsync(MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  47698. <summary>
  47699. Asynchronously set the flags of the specified message.
  47700. </summary>
  47701. <remarks>
  47702. Asynchronously sets the flags of the specified message.
  47703. </remarks>
  47704. <returns>An asynchronous task context.</returns>
  47705. <param name="uid">The UID of the message.</param>
  47706. <param name="flags">The message flags to set.</param>
  47707. <param name="keywords">A set of user-defined flags to set.</param>
  47708. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  47709. <param name="cancellationToken">The cancellation token.</param>
  47710. <exception cref="T:System.ArgumentException">
  47711. <paramref name="uid"/> is invalid.
  47712. </exception>
  47713. <exception cref="T:System.ObjectDisposedException">
  47714. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  47715. </exception>
  47716. <exception cref="T:MailKit.ServiceNotConnectedException">
  47717. The <see cref="T:MailKit.IMailStore"/> is not connected.
  47718. </exception>
  47719. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  47720. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  47721. </exception>
  47722. <exception cref="T:MailKit.FolderNotOpenException">
  47723. The folder is not currently open in read-write mode.
  47724. </exception>
  47725. <exception cref="T:System.OperationCanceledException">
  47726. The operation was canceled via the cancellation token.
  47727. </exception>
  47728. <exception cref="T:System.IO.IOException">
  47729. An I/O error occurred.
  47730. </exception>
  47731. <exception cref="T:MailKit.ProtocolException">
  47732. The server's response contained unexpected tokens.
  47733. </exception>
  47734. <exception cref="T:MailKit.CommandException">
  47735. The command failed.
  47736. </exception>
  47737. </member>
  47738. <member name="M:MailKit.MailFolder.SetFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  47739. <summary>
  47740. Set the flags of the specified messages.
  47741. </summary>
  47742. <remarks>
  47743. Sets the flags of the specified messages.
  47744. </remarks>
  47745. <param name="uids">The UIDs of the messages.</param>
  47746. <param name="flags">The message flags to set.</param>
  47747. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  47748. <param name="cancellationToken">The cancellation token.</param>
  47749. <exception cref="T:System.ArgumentNullException">
  47750. <paramref name="uids"/> is <c>null</c>.
  47751. </exception>
  47752. <exception cref="T:System.ArgumentException">
  47753. One or more of the <paramref name="uids"/> is invalid.
  47754. </exception>
  47755. <exception cref="T:System.ObjectDisposedException">
  47756. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  47757. </exception>
  47758. <exception cref="T:MailKit.ServiceNotConnectedException">
  47759. The <see cref="T:MailKit.IMailStore"/> is not connected.
  47760. </exception>
  47761. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  47762. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  47763. </exception>
  47764. <exception cref="T:MailKit.FolderNotOpenException">
  47765. The folder is not currently open in read-write mode.
  47766. </exception>
  47767. <exception cref="T:System.OperationCanceledException">
  47768. The operation was canceled via the cancellation token.
  47769. </exception>
  47770. <exception cref="T:System.IO.IOException">
  47771. An I/O error occurred.
  47772. </exception>
  47773. <exception cref="T:MailKit.ProtocolException">
  47774. The server's response contained unexpected tokens.
  47775. </exception>
  47776. <exception cref="T:MailKit.CommandException">
  47777. The command failed.
  47778. </exception>
  47779. </member>
  47780. <member name="M:MailKit.MailFolder.SetFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  47781. <summary>
  47782. Asynchronously set the flags of the specified messages.
  47783. </summary>
  47784. <remarks>
  47785. Asynchronously sets the flags of the specified messages.
  47786. </remarks>
  47787. <returns>An asynchronous task context.</returns>
  47788. <param name="uids">The UIDs of the messages.</param>
  47789. <param name="flags">The message flags to set.</param>
  47790. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  47791. <param name="cancellationToken">The cancellation token.</param>
  47792. <exception cref="T:System.ArgumentNullException">
  47793. <paramref name="uids"/> is <c>null</c>.
  47794. </exception>
  47795. <exception cref="T:System.ArgumentException">
  47796. One or more of the <paramref name="uids"/> is invalid.
  47797. </exception>
  47798. <exception cref="T:System.ObjectDisposedException">
  47799. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  47800. </exception>
  47801. <exception cref="T:MailKit.ServiceNotConnectedException">
  47802. The <see cref="T:MailKit.IMailStore"/> is not connected.
  47803. </exception>
  47804. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  47805. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  47806. </exception>
  47807. <exception cref="T:MailKit.FolderNotOpenException">
  47808. The folder is not currently open in read-write mode.
  47809. </exception>
  47810. <exception cref="T:System.OperationCanceledException">
  47811. The operation was canceled via the cancellation token.
  47812. </exception>
  47813. <exception cref="T:System.IO.IOException">
  47814. An I/O error occurred.
  47815. </exception>
  47816. <exception cref="T:MailKit.ProtocolException">
  47817. The server's response contained unexpected tokens.
  47818. </exception>
  47819. <exception cref="T:MailKit.CommandException">
  47820. The command failed.
  47821. </exception>
  47822. </member>
  47823. <member name="M:MailKit.MailFolder.SetFlags(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  47824. <summary>
  47825. Set the flags of the specified messages.
  47826. </summary>
  47827. <remarks>
  47828. Sets the flags of the specified messages.
  47829. </remarks>
  47830. <param name="uids">The UIDs of the messages.</param>
  47831. <param name="flags">The message flags to set.</param>
  47832. <param name="keywords">A set of user-defined flags to set.</param>
  47833. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  47834. <param name="cancellationToken">The cancellation token.</param>
  47835. <exception cref="T:System.ArgumentNullException">
  47836. <paramref name="uids"/> is <c>null</c>.
  47837. </exception>
  47838. <exception cref="T:System.ArgumentException">
  47839. One or more of the <paramref name="uids"/> is invalid.
  47840. </exception>
  47841. <exception cref="T:System.ObjectDisposedException">
  47842. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  47843. </exception>
  47844. <exception cref="T:MailKit.ServiceNotConnectedException">
  47845. The <see cref="T:MailKit.IMailStore"/> is not connected.
  47846. </exception>
  47847. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  47848. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  47849. </exception>
  47850. <exception cref="T:MailKit.FolderNotOpenException">
  47851. The folder is not currently open in read-write mode.
  47852. </exception>
  47853. <exception cref="T:System.OperationCanceledException">
  47854. The operation was canceled via the cancellation token.
  47855. </exception>
  47856. <exception cref="T:System.IO.IOException">
  47857. An I/O error occurred.
  47858. </exception>
  47859. <exception cref="T:MailKit.ProtocolException">
  47860. The server's response contained unexpected tokens.
  47861. </exception>
  47862. <exception cref="T:MailKit.CommandException">
  47863. The command failed.
  47864. </exception>
  47865. </member>
  47866. <member name="M:MailKit.MailFolder.SetFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  47867. <summary>
  47868. Asynchronously set the flags of the specified messages.
  47869. </summary>
  47870. <remarks>
  47871. Asynchronously sets the flags of the specified messages.
  47872. </remarks>
  47873. <returns>An asynchronous task context.</returns>
  47874. <param name="uids">The UIDs of the messages.</param>
  47875. <param name="flags">The message flags to set.</param>
  47876. <param name="keywords">A set of user-defined flags to set.</param>
  47877. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  47878. <param name="cancellationToken">The cancellation token.</param>
  47879. <exception cref="T:System.ArgumentNullException">
  47880. <paramref name="uids"/> is <c>null</c>.
  47881. </exception>
  47882. <exception cref="T:System.ArgumentException">
  47883. One or more of the <paramref name="uids"/> is invalid.
  47884. </exception>
  47885. <exception cref="T:System.ObjectDisposedException">
  47886. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  47887. </exception>
  47888. <exception cref="T:MailKit.ServiceNotConnectedException">
  47889. The <see cref="T:MailKit.IMailStore"/> is not connected.
  47890. </exception>
  47891. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  47892. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  47893. </exception>
  47894. <exception cref="T:MailKit.FolderNotOpenException">
  47895. The folder is not currently open in read-write mode.
  47896. </exception>
  47897. <exception cref="T:System.OperationCanceledException">
  47898. The operation was canceled via the cancellation token.
  47899. </exception>
  47900. <exception cref="T:System.IO.IOException">
  47901. An I/O error occurred.
  47902. </exception>
  47903. <exception cref="T:MailKit.ProtocolException">
  47904. The server's response contained unexpected tokens.
  47905. </exception>
  47906. <exception cref="T:MailKit.CommandException">
  47907. The command failed.
  47908. </exception>
  47909. </member>
  47910. <member name="M:MailKit.MailFolder.AddFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  47911. <summary>
  47912. Add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
  47913. </summary>
  47914. <remarks>
  47915. Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
  47916. </remarks>
  47917. <returns>The unique IDs of the messages that were not updated.</returns>
  47918. <param name="uids">The UIDs of the messages.</param>
  47919. <param name="modseq">The mod-sequence value.</param>
  47920. <param name="flags">The message flags to add.</param>
  47921. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  47922. <param name="cancellationToken">The cancellation token.</param>
  47923. <exception cref="T:System.ArgumentNullException">
  47924. <paramref name="uids"/> is <c>null</c>.
  47925. </exception>
  47926. <exception cref="T:System.ArgumentException">
  47927. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  47928. <para>-or-</para>
  47929. <para>No flags were specified.</para>
  47930. </exception>
  47931. <exception cref="T:System.ObjectDisposedException">
  47932. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  47933. </exception>
  47934. <exception cref="T:MailKit.ServiceNotConnectedException">
  47935. The <see cref="T:MailKit.IMailStore"/> is not connected.
  47936. </exception>
  47937. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  47938. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  47939. </exception>
  47940. <exception cref="T:MailKit.FolderNotOpenException">
  47941. The folder is not currently open in read-write mode.
  47942. </exception>
  47943. <exception cref="T:System.NotSupportedException">
  47944. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  47945. </exception>
  47946. <exception cref="T:System.OperationCanceledException">
  47947. The operation was canceled via the cancellation token.
  47948. </exception>
  47949. <exception cref="T:System.IO.IOException">
  47950. An I/O error occurred.
  47951. </exception>
  47952. <exception cref="T:MailKit.ProtocolException">
  47953. The server's response contained unexpected tokens.
  47954. </exception>
  47955. <exception cref="T:MailKit.CommandException">
  47956. The command failed.
  47957. </exception>
  47958. </member>
  47959. <member name="M:MailKit.MailFolder.AddFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  47960. <summary>
  47961. Asynchronously add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
  47962. </summary>
  47963. <remarks>
  47964. Asynchronously adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
  47965. </remarks>
  47966. <returns>The unique IDs of the messages that were not updated.</returns>
  47967. <param name="uids">The UIDs of the messages.</param>
  47968. <param name="modseq">The mod-sequence value.</param>
  47969. <param name="flags">The message flags to add.</param>
  47970. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  47971. <param name="cancellationToken">The cancellation token.</param>
  47972. <exception cref="T:System.ArgumentNullException">
  47973. <paramref name="uids"/> is <c>null</c>.
  47974. </exception>
  47975. <exception cref="T:System.ArgumentException">
  47976. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  47977. <para>-or-</para>
  47978. <para>No flags were specified.</para>
  47979. </exception>
  47980. <exception cref="T:System.ObjectDisposedException">
  47981. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  47982. </exception>
  47983. <exception cref="T:MailKit.ServiceNotConnectedException">
  47984. The <see cref="T:MailKit.IMailStore"/> is not connected.
  47985. </exception>
  47986. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  47987. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  47988. </exception>
  47989. <exception cref="T:MailKit.FolderNotOpenException">
  47990. The folder is not currently open in read-write mode.
  47991. </exception>
  47992. <exception cref="T:System.NotSupportedException">
  47993. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  47994. </exception>
  47995. <exception cref="T:System.OperationCanceledException">
  47996. The operation was canceled via the cancellation token.
  47997. </exception>
  47998. <exception cref="T:System.IO.IOException">
  47999. An I/O error occurred.
  48000. </exception>
  48001. <exception cref="T:MailKit.ProtocolException">
  48002. The server's response contained unexpected tokens.
  48003. </exception>
  48004. <exception cref="T:MailKit.CommandException">
  48005. The command failed.
  48006. </exception>
  48007. </member>
  48008. <member name="M:MailKit.MailFolder.AddFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  48009. <summary>
  48010. Add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
  48011. </summary>
  48012. <remarks>
  48013. Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
  48014. </remarks>
  48015. <returns>The unique IDs of the messages that were not updated.</returns>
  48016. <param name="uids">The UIDs of the messages.</param>
  48017. <param name="modseq">The mod-sequence value.</param>
  48018. <param name="flags">The message flags to add.</param>
  48019. <param name="keywords">A set of user-defined flags to add.</param>
  48020. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  48021. <param name="cancellationToken">The cancellation token.</param>
  48022. <exception cref="T:System.ArgumentNullException">
  48023. <paramref name="uids"/> is <c>null</c>.
  48024. </exception>
  48025. <exception cref="T:System.ArgumentException">
  48026. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  48027. <para>-or-</para>
  48028. <para>No flags were specified.</para>
  48029. </exception>
  48030. <exception cref="T:System.ObjectDisposedException">
  48031. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  48032. </exception>
  48033. <exception cref="T:MailKit.ServiceNotConnectedException">
  48034. The <see cref="T:MailKit.IMailStore"/> is not connected.
  48035. </exception>
  48036. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  48037. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  48038. </exception>
  48039. <exception cref="T:MailKit.FolderNotOpenException">
  48040. The folder is not currently open in read-write mode.
  48041. </exception>
  48042. <exception cref="T:System.NotSupportedException">
  48043. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  48044. </exception>
  48045. <exception cref="T:System.OperationCanceledException">
  48046. The operation was canceled via the cancellation token.
  48047. </exception>
  48048. <exception cref="T:System.IO.IOException">
  48049. An I/O error occurred.
  48050. </exception>
  48051. <exception cref="T:MailKit.ProtocolException">
  48052. The server's response contained unexpected tokens.
  48053. </exception>
  48054. <exception cref="T:MailKit.CommandException">
  48055. The command failed.
  48056. </exception>
  48057. </member>
  48058. <member name="M:MailKit.MailFolder.AddFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  48059. <summary>
  48060. Asynchronously add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
  48061. </summary>
  48062. <remarks>
  48063. Asynchronously adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
  48064. </remarks>
  48065. <returns>The unique IDs of the messages that were not updated.</returns>
  48066. <param name="uids">The UIDs of the messages.</param>
  48067. <param name="modseq">The mod-sequence value.</param>
  48068. <param name="flags">The message flags to add.</param>
  48069. <param name="keywords">A set of user-defined flags to add.</param>
  48070. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  48071. <param name="cancellationToken">The cancellation token.</param>
  48072. <exception cref="T:System.ArgumentNullException">
  48073. <paramref name="uids"/> is <c>null</c>.
  48074. </exception>
  48075. <exception cref="T:System.ArgumentException">
  48076. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  48077. <para>-or-</para>
  48078. <para>No flags were specified.</para>
  48079. </exception>
  48080. <exception cref="T:System.ObjectDisposedException">
  48081. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  48082. </exception>
  48083. <exception cref="T:MailKit.ServiceNotConnectedException">
  48084. The <see cref="T:MailKit.IMailStore"/> is not connected.
  48085. </exception>
  48086. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  48087. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  48088. </exception>
  48089. <exception cref="T:MailKit.FolderNotOpenException">
  48090. The folder is not currently open in read-write mode.
  48091. </exception>
  48092. <exception cref="T:System.NotSupportedException">
  48093. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  48094. </exception>
  48095. <exception cref="T:System.OperationCanceledException">
  48096. The operation was canceled via the cancellation token.
  48097. </exception>
  48098. <exception cref="T:System.IO.IOException">
  48099. An I/O error occurred.
  48100. </exception>
  48101. <exception cref="T:MailKit.ProtocolException">
  48102. The server's response contained unexpected tokens.
  48103. </exception>
  48104. <exception cref="T:MailKit.CommandException">
  48105. The command failed.
  48106. </exception>
  48107. </member>
  48108. <member name="M:MailKit.MailFolder.RemoveFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  48109. <summary>
  48110. Remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
  48111. </summary>
  48112. <remarks>
  48113. Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
  48114. </remarks>
  48115. <returns>The unique IDs of the messages that were not updated.</returns>
  48116. <param name="uids">The UIDs of the messages.</param>
  48117. <param name="modseq">The mod-sequence value.</param>
  48118. <param name="flags">The message flags to remove.</param>
  48119. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  48120. <param name="cancellationToken">The cancellation token.</param>
  48121. <exception cref="T:System.ArgumentNullException">
  48122. <paramref name="uids"/> is <c>null</c>.
  48123. </exception>
  48124. <exception cref="T:System.ArgumentException">
  48125. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  48126. <para>-or-</para>
  48127. <para>No flags were specified.</para>
  48128. </exception>
  48129. <exception cref="T:System.ObjectDisposedException">
  48130. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  48131. </exception>
  48132. <exception cref="T:MailKit.ServiceNotConnectedException">
  48133. The <see cref="T:MailKit.IMailStore"/> is not connected.
  48134. </exception>
  48135. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  48136. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  48137. </exception>
  48138. <exception cref="T:MailKit.FolderNotOpenException">
  48139. The folder is not currently open in read-write mode.
  48140. </exception>
  48141. <exception cref="T:System.NotSupportedException">
  48142. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  48143. </exception>
  48144. <exception cref="T:System.OperationCanceledException">
  48145. The operation was canceled via the cancellation token.
  48146. </exception>
  48147. <exception cref="T:System.IO.IOException">
  48148. An I/O error occurred.
  48149. </exception>
  48150. <exception cref="T:MailKit.ProtocolException">
  48151. The server's response contained unexpected tokens.
  48152. </exception>
  48153. <exception cref="T:MailKit.CommandException">
  48154. The command failed.
  48155. </exception>
  48156. </member>
  48157. <member name="M:MailKit.MailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  48158. <summary>
  48159. Asynchronously remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
  48160. </summary>
  48161. <remarks>
  48162. Asynchronously removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
  48163. </remarks>
  48164. <returns>The unique IDs of the messages that were not updated.</returns>
  48165. <param name="uids">The UIDs of the messages.</param>
  48166. <param name="modseq">The mod-sequence value.</param>
  48167. <param name="flags">The message flags to remove.</param>
  48168. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  48169. <param name="cancellationToken">The cancellation token.</param>
  48170. <exception cref="T:System.ArgumentNullException">
  48171. <paramref name="uids"/> is <c>null</c>.
  48172. </exception>
  48173. <exception cref="T:System.ArgumentException">
  48174. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  48175. <para>-or-</para>
  48176. <para>No flags were specified.</para>
  48177. </exception>
  48178. <exception cref="T:System.ObjectDisposedException">
  48179. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  48180. </exception>
  48181. <exception cref="T:MailKit.ServiceNotConnectedException">
  48182. The <see cref="T:MailKit.IMailStore"/> is not connected.
  48183. </exception>
  48184. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  48185. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  48186. </exception>
  48187. <exception cref="T:MailKit.FolderNotOpenException">
  48188. The folder is not currently open in read-write mode.
  48189. </exception>
  48190. <exception cref="T:System.NotSupportedException">
  48191. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  48192. </exception>
  48193. <exception cref="T:System.OperationCanceledException">
  48194. The operation was canceled via the cancellation token.
  48195. </exception>
  48196. <exception cref="T:System.IO.IOException">
  48197. An I/O error occurred.
  48198. </exception>
  48199. <exception cref="T:MailKit.ProtocolException">
  48200. The server's response contained unexpected tokens.
  48201. </exception>
  48202. <exception cref="T:MailKit.CommandException">
  48203. The command failed.
  48204. </exception>
  48205. </member>
  48206. <member name="M:MailKit.MailFolder.RemoveFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  48207. <summary>
  48208. Remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
  48209. </summary>
  48210. <remarks>
  48211. Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
  48212. </remarks>
  48213. <returns>The unique IDs of the messages that were not updated.</returns>
  48214. <param name="uids">The UIDs of the messages.</param>
  48215. <param name="modseq">The mod-sequence value.</param>
  48216. <param name="flags">The message flags to remove.</param>
  48217. <param name="keywords">A set of user-defined flags to remove.</param>
  48218. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  48219. <param name="cancellationToken">The cancellation token.</param>
  48220. <exception cref="T:System.ArgumentNullException">
  48221. <paramref name="uids"/> is <c>null</c>.
  48222. </exception>
  48223. <exception cref="T:System.ArgumentException">
  48224. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  48225. <para>-or-</para>
  48226. <para>No flags were specified.</para>
  48227. </exception>
  48228. <exception cref="T:System.ObjectDisposedException">
  48229. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  48230. </exception>
  48231. <exception cref="T:MailKit.ServiceNotConnectedException">
  48232. The <see cref="T:MailKit.IMailStore"/> is not connected.
  48233. </exception>
  48234. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  48235. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  48236. </exception>
  48237. <exception cref="T:MailKit.FolderNotOpenException">
  48238. The folder is not currently open in read-write mode.
  48239. </exception>
  48240. <exception cref="T:System.NotSupportedException">
  48241. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  48242. </exception>
  48243. <exception cref="T:System.OperationCanceledException">
  48244. The operation was canceled via the cancellation token.
  48245. </exception>
  48246. <exception cref="T:System.IO.IOException">
  48247. An I/O error occurred.
  48248. </exception>
  48249. <exception cref="T:MailKit.ProtocolException">
  48250. The server's response contained unexpected tokens.
  48251. </exception>
  48252. <exception cref="T:MailKit.CommandException">
  48253. The command failed.
  48254. </exception>
  48255. </member>
  48256. <member name="M:MailKit.MailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  48257. <summary>
  48258. Asynchronously remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
  48259. </summary>
  48260. <remarks>
  48261. Asynchronously removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
  48262. </remarks>
  48263. <returns>The unique IDs of the messages that were not updated.</returns>
  48264. <param name="uids">The UIDs of the messages.</param>
  48265. <param name="modseq">The mod-sequence value.</param>
  48266. <param name="flags">The message flags to remove.</param>
  48267. <param name="keywords">A set of user-defined flags to remove.</param>
  48268. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  48269. <param name="cancellationToken">The cancellation token.</param>
  48270. <exception cref="T:System.ArgumentNullException">
  48271. <paramref name="uids"/> is <c>null</c>.
  48272. </exception>
  48273. <exception cref="T:System.ArgumentException">
  48274. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  48275. <para>-or-</para>
  48276. <para>No flags were specified.</para>
  48277. </exception>
  48278. <exception cref="T:System.ObjectDisposedException">
  48279. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  48280. </exception>
  48281. <exception cref="T:MailKit.ServiceNotConnectedException">
  48282. The <see cref="T:MailKit.IMailStore"/> is not connected.
  48283. </exception>
  48284. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  48285. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  48286. </exception>
  48287. <exception cref="T:MailKit.FolderNotOpenException">
  48288. The folder is not currently open in read-write mode.
  48289. </exception>
  48290. <exception cref="T:System.NotSupportedException">
  48291. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  48292. </exception>
  48293. <exception cref="T:System.OperationCanceledException">
  48294. The operation was canceled via the cancellation token.
  48295. </exception>
  48296. <exception cref="T:System.IO.IOException">
  48297. An I/O error occurred.
  48298. </exception>
  48299. <exception cref="T:MailKit.ProtocolException">
  48300. The server's response contained unexpected tokens.
  48301. </exception>
  48302. <exception cref="T:MailKit.CommandException">
  48303. The command failed.
  48304. </exception>
  48305. </member>
  48306. <member name="M:MailKit.MailFolder.SetFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  48307. <summary>
  48308. Set the flags of the specified messages only if their mod-sequence value is less than the specified value.
  48309. </summary>
  48310. <remarks>
  48311. Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
  48312. </remarks>
  48313. <returns>The unique IDs of the messages that were not updated.</returns>
  48314. <param name="uids">The UIDs of the messages.</param>
  48315. <param name="modseq">The mod-sequence value.</param>
  48316. <param name="flags">The message flags to set.</param>
  48317. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  48318. <param name="cancellationToken">The cancellation token.</param>
  48319. <exception cref="T:System.ArgumentNullException">
  48320. <paramref name="uids"/> is <c>null</c>.
  48321. </exception>
  48322. <exception cref="T:System.ArgumentException">
  48323. One or more of the <paramref name="uids"/> is invalid.
  48324. </exception>
  48325. <exception cref="T:System.ObjectDisposedException">
  48326. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  48327. </exception>
  48328. <exception cref="T:MailKit.ServiceNotConnectedException">
  48329. The <see cref="T:MailKit.IMailStore"/> is not connected.
  48330. </exception>
  48331. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  48332. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  48333. </exception>
  48334. <exception cref="T:MailKit.FolderNotOpenException">
  48335. The folder is not currently open in read-write mode.
  48336. </exception>
  48337. <exception cref="T:System.NotSupportedException">
  48338. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  48339. </exception>
  48340. <exception cref="T:System.OperationCanceledException">
  48341. The operation was canceled via the cancellation token.
  48342. </exception>
  48343. <exception cref="T:System.IO.IOException">
  48344. An I/O error occurred.
  48345. </exception>
  48346. <exception cref="T:MailKit.ProtocolException">
  48347. The server's response contained unexpected tokens.
  48348. </exception>
  48349. <exception cref="T:MailKit.CommandException">
  48350. The command failed.
  48351. </exception>
  48352. </member>
  48353. <member name="M:MailKit.MailFolder.SetFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  48354. <summary>
  48355. Asynchronously set the flags of the specified messages only if their mod-sequence value is less than the specified value.
  48356. </summary>
  48357. <remarks>
  48358. Asynchronously sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
  48359. </remarks>
  48360. <returns>The unique IDs of the messages that were not updated.</returns>
  48361. <param name="uids">The UIDs of the messages.</param>
  48362. <param name="modseq">The mod-sequence value.</param>
  48363. <param name="flags">The message flags to set.</param>
  48364. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  48365. <param name="cancellationToken">The cancellation token.</param>
  48366. <exception cref="T:System.ArgumentNullException">
  48367. <paramref name="uids"/> is <c>null</c>.
  48368. </exception>
  48369. <exception cref="T:System.ArgumentException">
  48370. One or more of the <paramref name="uids"/> is invalid.
  48371. </exception>
  48372. <exception cref="T:System.ObjectDisposedException">
  48373. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  48374. </exception>
  48375. <exception cref="T:MailKit.ServiceNotConnectedException">
  48376. The <see cref="T:MailKit.IMailStore"/> is not connected.
  48377. </exception>
  48378. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  48379. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  48380. </exception>
  48381. <exception cref="T:MailKit.FolderNotOpenException">
  48382. The folder is not currently open in read-write mode.
  48383. </exception>
  48384. <exception cref="T:System.NotSupportedException">
  48385. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  48386. </exception>
  48387. <exception cref="T:System.OperationCanceledException">
  48388. The operation was canceled via the cancellation token.
  48389. </exception>
  48390. <exception cref="T:System.IO.IOException">
  48391. An I/O error occurred.
  48392. </exception>
  48393. <exception cref="T:MailKit.ProtocolException">
  48394. The server's response contained unexpected tokens.
  48395. </exception>
  48396. <exception cref="T:MailKit.CommandException">
  48397. The command failed.
  48398. </exception>
  48399. </member>
  48400. <member name="M:MailKit.MailFolder.SetFlags(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  48401. <summary>
  48402. Set the flags of the specified messages only if their mod-sequence value is less than the specified value.
  48403. </summary>
  48404. <remarks>
  48405. Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
  48406. </remarks>
  48407. <returns>The unique IDs of the messages that were not updated.</returns>
  48408. <param name="uids">The UIDs of the messages.</param>
  48409. <param name="modseq">The mod-sequence value.</param>
  48410. <param name="flags">The message flags to set.</param>
  48411. <param name="keywords">A set of user-defined flags to set.</param>
  48412. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  48413. <param name="cancellationToken">The cancellation token.</param>
  48414. <exception cref="T:System.ArgumentNullException">
  48415. <paramref name="uids"/> is <c>null</c>.
  48416. </exception>
  48417. <exception cref="T:System.ArgumentException">
  48418. One or more of the <paramref name="uids"/> is invalid.
  48419. </exception>
  48420. <exception cref="T:System.ObjectDisposedException">
  48421. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  48422. </exception>
  48423. <exception cref="T:MailKit.ServiceNotConnectedException">
  48424. The <see cref="T:MailKit.IMailStore"/> is not connected.
  48425. </exception>
  48426. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  48427. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  48428. </exception>
  48429. <exception cref="T:MailKit.FolderNotOpenException">
  48430. The folder is not currently open in read-write mode.
  48431. </exception>
  48432. <exception cref="T:System.NotSupportedException">
  48433. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  48434. </exception>
  48435. <exception cref="T:System.OperationCanceledException">
  48436. The operation was canceled via the cancellation token.
  48437. </exception>
  48438. <exception cref="T:System.IO.IOException">
  48439. An I/O error occurred.
  48440. </exception>
  48441. <exception cref="T:MailKit.ProtocolException">
  48442. The server's response contained unexpected tokens.
  48443. </exception>
  48444. <exception cref="T:MailKit.CommandException">
  48445. The command failed.
  48446. </exception>
  48447. </member>
  48448. <member name="M:MailKit.MailFolder.SetFlagsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  48449. <summary>
  48450. Asynchronously set the flags of the specified messages only if their mod-sequence value is less than the specified value.
  48451. </summary>
  48452. <remarks>
  48453. Asynchronously sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
  48454. </remarks>
  48455. <returns>The unique IDs of the messages that were not updated.</returns>
  48456. <param name="uids">The UIDs of the messages.</param>
  48457. <param name="modseq">The mod-sequence value.</param>
  48458. <param name="flags">The message flags to set.</param>
  48459. <param name="keywords">A set of user-defined flags to set.</param>
  48460. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  48461. <param name="cancellationToken">The cancellation token.</param>
  48462. <exception cref="T:System.ArgumentNullException">
  48463. <paramref name="uids"/> is <c>null</c>.
  48464. </exception>
  48465. <exception cref="T:System.ArgumentException">
  48466. One or more of the <paramref name="uids"/> is invalid.
  48467. </exception>
  48468. <exception cref="T:System.ObjectDisposedException">
  48469. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  48470. </exception>
  48471. <exception cref="T:MailKit.ServiceNotConnectedException">
  48472. The <see cref="T:MailKit.IMailStore"/> is not connected.
  48473. </exception>
  48474. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  48475. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  48476. </exception>
  48477. <exception cref="T:MailKit.FolderNotOpenException">
  48478. The folder is not currently open in read-write mode.
  48479. </exception>
  48480. <exception cref="T:System.NotSupportedException">
  48481. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  48482. </exception>
  48483. <exception cref="T:System.OperationCanceledException">
  48484. The operation was canceled via the cancellation token.
  48485. </exception>
  48486. <exception cref="T:System.IO.IOException">
  48487. An I/O error occurred.
  48488. </exception>
  48489. <exception cref="T:MailKit.ProtocolException">
  48490. The server's response contained unexpected tokens.
  48491. </exception>
  48492. <exception cref="T:MailKit.CommandException">
  48493. The command failed.
  48494. </exception>
  48495. </member>
  48496. <member name="M:MailKit.MailFolder.AddFlags(System.Int32,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  48497. <summary>
  48498. Add a set of flags to the specified message.
  48499. </summary>
  48500. <remarks>
  48501. Adds a set of flags to the specified message.
  48502. </remarks>
  48503. <param name="index">The index of the message.</param>
  48504. <param name="flags">The message flags to add.</param>
  48505. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  48506. <param name="cancellationToken">The cancellation token.</param>
  48507. <exception cref="T:System.ArgumentException">
  48508. <para><paramref name="index"/> is invalid.</para>
  48509. <para>-or-</para>
  48510. <para>No flags were specified.</para>
  48511. </exception>
  48512. <exception cref="T:System.ObjectDisposedException">
  48513. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  48514. </exception>
  48515. <exception cref="T:MailKit.ServiceNotConnectedException">
  48516. The <see cref="T:MailKit.IMailStore"/> is not connected.
  48517. </exception>
  48518. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  48519. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  48520. </exception>
  48521. <exception cref="T:MailKit.FolderNotOpenException">
  48522. The folder is not currently open in read-write mode.
  48523. </exception>
  48524. <exception cref="T:System.OperationCanceledException">
  48525. The operation was canceled via the cancellation token.
  48526. </exception>
  48527. <exception cref="T:System.IO.IOException">
  48528. An I/O error occurred.
  48529. </exception>
  48530. <exception cref="T:MailKit.ProtocolException">
  48531. The server's response contained unexpected tokens.
  48532. </exception>
  48533. <exception cref="T:MailKit.CommandException">
  48534. The command failed.
  48535. </exception>
  48536. </member>
  48537. <member name="M:MailKit.MailFolder.AddFlagsAsync(System.Int32,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  48538. <summary>
  48539. Asynchronously add a set of flags to the specified message.
  48540. </summary>
  48541. <remarks>
  48542. Asynchronously adds a set of flags to the specified message.
  48543. </remarks>
  48544. <returns>An asynchronous task context.</returns>
  48545. <param name="index">The index of the messages.</param>
  48546. <param name="flags">The message flags to add.</param>
  48547. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  48548. <param name="cancellationToken">The cancellation token.</param>
  48549. <exception cref="T:System.ArgumentException">
  48550. <para><paramref name="index"/> is invalid.</para>
  48551. <para>-or-</para>
  48552. <para>No flags were specified.</para>
  48553. </exception>
  48554. <exception cref="T:System.ObjectDisposedException">
  48555. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  48556. </exception>
  48557. <exception cref="T:MailKit.ServiceNotConnectedException">
  48558. The <see cref="T:MailKit.IMailStore"/> is not connected.
  48559. </exception>
  48560. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  48561. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  48562. </exception>
  48563. <exception cref="T:MailKit.FolderNotOpenException">
  48564. The folder is not currently open in read-write mode.
  48565. </exception>
  48566. <exception cref="T:System.OperationCanceledException">
  48567. The operation was canceled via the cancellation token.
  48568. </exception>
  48569. <exception cref="T:System.IO.IOException">
  48570. An I/O error occurred.
  48571. </exception>
  48572. <exception cref="T:MailKit.ProtocolException">
  48573. The server's response contained unexpected tokens.
  48574. </exception>
  48575. <exception cref="T:MailKit.CommandException">
  48576. The command failed.
  48577. </exception>
  48578. </member>
  48579. <member name="M:MailKit.MailFolder.AddFlags(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  48580. <summary>
  48581. Add a set of flags to the specified message.
  48582. </summary>
  48583. <remarks>
  48584. Adds a set of flags to the specified message.
  48585. </remarks>
  48586. <param name="index">The index of the message.</param>
  48587. <param name="flags">The message flags to add.</param>
  48588. <param name="keywords">A set of user-defined flags to add.</param>
  48589. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  48590. <param name="cancellationToken">The cancellation token.</param>
  48591. <exception cref="T:System.ArgumentException">
  48592. <para><paramref name="index"/> is invalid.</para>
  48593. <para>-or-</para>
  48594. <para>No flags were specified.</para>
  48595. </exception>
  48596. <exception cref="T:System.ObjectDisposedException">
  48597. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  48598. </exception>
  48599. <exception cref="T:MailKit.ServiceNotConnectedException">
  48600. The <see cref="T:MailKit.IMailStore"/> is not connected.
  48601. </exception>
  48602. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  48603. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  48604. </exception>
  48605. <exception cref="T:MailKit.FolderNotOpenException">
  48606. The folder is not currently open in read-write mode.
  48607. </exception>
  48608. <exception cref="T:System.OperationCanceledException">
  48609. The operation was canceled via the cancellation token.
  48610. </exception>
  48611. <exception cref="T:System.IO.IOException">
  48612. An I/O error occurred.
  48613. </exception>
  48614. <exception cref="T:MailKit.ProtocolException">
  48615. The server's response contained unexpected tokens.
  48616. </exception>
  48617. <exception cref="T:MailKit.CommandException">
  48618. The command failed.
  48619. </exception>
  48620. </member>
  48621. <member name="M:MailKit.MailFolder.AddFlagsAsync(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  48622. <summary>
  48623. Asynchronously add a set of flags to the specified message.
  48624. </summary>
  48625. <remarks>
  48626. Asynchronously adds a set of flags to the specified message.
  48627. </remarks>
  48628. <returns>An asynchronous task context.</returns>
  48629. <param name="index">The index of the messages.</param>
  48630. <param name="flags">The message flags to add.</param>
  48631. <param name="keywords">A set of user-defined flags to add.</param>
  48632. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  48633. <param name="cancellationToken">The cancellation token.</param>
  48634. <exception cref="T:System.ArgumentException">
  48635. <para><paramref name="index"/> is invalid.</para>
  48636. <para>-or-</para>
  48637. <para>No flags were specified.</para>
  48638. </exception>
  48639. <exception cref="T:System.ObjectDisposedException">
  48640. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  48641. </exception>
  48642. <exception cref="T:MailKit.ServiceNotConnectedException">
  48643. The <see cref="T:MailKit.IMailStore"/> is not connected.
  48644. </exception>
  48645. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  48646. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  48647. </exception>
  48648. <exception cref="T:MailKit.FolderNotOpenException">
  48649. The folder is not currently open in read-write mode.
  48650. </exception>
  48651. <exception cref="T:System.OperationCanceledException">
  48652. The operation was canceled via the cancellation token.
  48653. </exception>
  48654. <exception cref="T:System.IO.IOException">
  48655. An I/O error occurred.
  48656. </exception>
  48657. <exception cref="T:MailKit.ProtocolException">
  48658. The server's response contained unexpected tokens.
  48659. </exception>
  48660. <exception cref="T:MailKit.CommandException">
  48661. The command failed.
  48662. </exception>
  48663. </member>
  48664. <member name="M:MailKit.MailFolder.AddFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  48665. <summary>
  48666. Add a set of flags to the specified messages.
  48667. </summary>
  48668. <remarks>
  48669. Adds a set of flags to the specified messages.
  48670. </remarks>
  48671. <param name="indexes">The indexes of the messages.</param>
  48672. <param name="flags">The message flags to add.</param>
  48673. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  48674. <param name="cancellationToken">The cancellation token.</param>
  48675. <exception cref="T:System.ArgumentNullException">
  48676. <paramref name="indexes"/> is <c>null</c>.
  48677. </exception>
  48678. <exception cref="T:System.ArgumentException">
  48679. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  48680. <para>-or-</para>
  48681. <para>No flags were specified.</para>
  48682. </exception>
  48683. <exception cref="T:System.ObjectDisposedException">
  48684. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  48685. </exception>
  48686. <exception cref="T:MailKit.ServiceNotConnectedException">
  48687. The <see cref="T:MailKit.IMailStore"/> is not connected.
  48688. </exception>
  48689. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  48690. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  48691. </exception>
  48692. <exception cref="T:MailKit.FolderNotOpenException">
  48693. The folder is not currently open in read-write mode.
  48694. </exception>
  48695. <exception cref="T:System.OperationCanceledException">
  48696. The operation was canceled via the cancellation token.
  48697. </exception>
  48698. <exception cref="T:System.IO.IOException">
  48699. An I/O error occurred.
  48700. </exception>
  48701. <exception cref="T:MailKit.ProtocolException">
  48702. The server's response contained unexpected tokens.
  48703. </exception>
  48704. <exception cref="T:MailKit.CommandException">
  48705. The command failed.
  48706. </exception>
  48707. </member>
  48708. <member name="M:MailKit.MailFolder.AddFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  48709. <summary>
  48710. Asynchronously add a set of flags to the specified messages.
  48711. </summary>
  48712. <remarks>
  48713. Asynchronously adds a set of flags to the specified messages.
  48714. </remarks>
  48715. <returns>An asynchronous task context.</returns>
  48716. <param name="indexes">The indexes of the messages.</param>
  48717. <param name="flags">The message flags to add.</param>
  48718. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  48719. <param name="cancellationToken">The cancellation token.</param>
  48720. <exception cref="T:System.ArgumentNullException">
  48721. <paramref name="indexes"/> is <c>null</c>.
  48722. </exception>
  48723. <exception cref="T:System.ArgumentException">
  48724. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  48725. <para>-or-</para>
  48726. <para>No flags were specified.</para>
  48727. </exception>
  48728. <exception cref="T:System.ObjectDisposedException">
  48729. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  48730. </exception>
  48731. <exception cref="T:MailKit.ServiceNotConnectedException">
  48732. The <see cref="T:MailKit.IMailStore"/> is not connected.
  48733. </exception>
  48734. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  48735. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  48736. </exception>
  48737. <exception cref="T:MailKit.FolderNotOpenException">
  48738. The folder is not currently open in read-write mode.
  48739. </exception>
  48740. <exception cref="T:System.OperationCanceledException">
  48741. The operation was canceled via the cancellation token.
  48742. </exception>
  48743. <exception cref="T:System.IO.IOException">
  48744. An I/O error occurred.
  48745. </exception>
  48746. <exception cref="T:MailKit.ProtocolException">
  48747. The server's response contained unexpected tokens.
  48748. </exception>
  48749. <exception cref="T:MailKit.CommandException">
  48750. The command failed.
  48751. </exception>
  48752. </member>
  48753. <member name="M:MailKit.MailFolder.AddFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  48754. <summary>
  48755. Add a set of flags to the specified messages.
  48756. </summary>
  48757. <remarks>
  48758. Adds a set of flags to the specified messages.
  48759. </remarks>
  48760. <param name="indexes">The indexes of the messages.</param>
  48761. <param name="flags">The message flags to add.</param>
  48762. <param name="keywords">A set of user-defined flags to add.</param>
  48763. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  48764. <param name="cancellationToken">The cancellation token.</param>
  48765. <exception cref="T:System.ArgumentNullException">
  48766. <paramref name="indexes"/> is <c>null</c>.
  48767. </exception>
  48768. <exception cref="T:System.ArgumentException">
  48769. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  48770. <para>-or-</para>
  48771. <para>No flags were specified.</para>
  48772. </exception>
  48773. <exception cref="T:System.ObjectDisposedException">
  48774. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  48775. </exception>
  48776. <exception cref="T:MailKit.ServiceNotConnectedException">
  48777. The <see cref="T:MailKit.IMailStore"/> is not connected.
  48778. </exception>
  48779. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  48780. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  48781. </exception>
  48782. <exception cref="T:MailKit.FolderNotOpenException">
  48783. The folder is not currently open in read-write mode.
  48784. </exception>
  48785. <exception cref="T:System.OperationCanceledException">
  48786. The operation was canceled via the cancellation token.
  48787. </exception>
  48788. <exception cref="T:System.IO.IOException">
  48789. An I/O error occurred.
  48790. </exception>
  48791. <exception cref="T:MailKit.ProtocolException">
  48792. The server's response contained unexpected tokens.
  48793. </exception>
  48794. <exception cref="T:MailKit.CommandException">
  48795. The command failed.
  48796. </exception>
  48797. </member>
  48798. <member name="M:MailKit.MailFolder.AddFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  48799. <summary>
  48800. Asynchronously add a set of flags to the specified messages.
  48801. </summary>
  48802. <remarks>
  48803. Asynchronously adds a set of flags to the specified messages.
  48804. </remarks>
  48805. <returns>An asynchronous task context.</returns>
  48806. <param name="indexes">The indexes of the messages.</param>
  48807. <param name="flags">The message flags to add.</param>
  48808. <param name="keywords">A set of user-defined flags to add.</param>
  48809. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  48810. <param name="cancellationToken">The cancellation token.</param>
  48811. <exception cref="T:System.ArgumentNullException">
  48812. <paramref name="indexes"/> is <c>null</c>.
  48813. </exception>
  48814. <exception cref="T:System.ArgumentException">
  48815. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  48816. <para>-or-</para>
  48817. <para>No flags were specified.</para>
  48818. </exception>
  48819. <exception cref="T:System.ObjectDisposedException">
  48820. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  48821. </exception>
  48822. <exception cref="T:MailKit.ServiceNotConnectedException">
  48823. The <see cref="T:MailKit.IMailStore"/> is not connected.
  48824. </exception>
  48825. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  48826. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  48827. </exception>
  48828. <exception cref="T:MailKit.FolderNotOpenException">
  48829. The folder is not currently open in read-write mode.
  48830. </exception>
  48831. <exception cref="T:System.OperationCanceledException">
  48832. The operation was canceled via the cancellation token.
  48833. </exception>
  48834. <exception cref="T:System.IO.IOException">
  48835. An I/O error occurred.
  48836. </exception>
  48837. <exception cref="T:MailKit.ProtocolException">
  48838. The server's response contained unexpected tokens.
  48839. </exception>
  48840. <exception cref="T:MailKit.CommandException">
  48841. The command failed.
  48842. </exception>
  48843. </member>
  48844. <member name="M:MailKit.MailFolder.RemoveFlags(System.Int32,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  48845. <summary>
  48846. Remove a set of flags from the specified message.
  48847. </summary>
  48848. <remarks>
  48849. Removes a set of flags from the specified message.
  48850. </remarks>
  48851. <param name="index">The index of the message.</param>
  48852. <param name="flags">The message flags to remove.</param>
  48853. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  48854. <param name="cancellationToken">The cancellation token.</param>
  48855. <exception cref="T:System.ArgumentException">
  48856. <para><paramref name="index"/> is invalid.</para>
  48857. <para>-or-</para>
  48858. <para>No flags were specified.</para>
  48859. </exception>
  48860. <exception cref="T:System.ObjectDisposedException">
  48861. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  48862. </exception>
  48863. <exception cref="T:MailKit.ServiceNotConnectedException">
  48864. The <see cref="T:MailKit.IMailStore"/> is not connected.
  48865. </exception>
  48866. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  48867. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  48868. </exception>
  48869. <exception cref="T:MailKit.FolderNotOpenException">
  48870. The folder is not currently open in read-write mode.
  48871. </exception>
  48872. <exception cref="T:System.OperationCanceledException">
  48873. The operation was canceled via the cancellation token.
  48874. </exception>
  48875. <exception cref="T:System.IO.IOException">
  48876. An I/O error occurred.
  48877. </exception>
  48878. <exception cref="T:MailKit.ProtocolException">
  48879. The server's response contained unexpected tokens.
  48880. </exception>
  48881. <exception cref="T:MailKit.CommandException">
  48882. The command failed.
  48883. </exception>
  48884. </member>
  48885. <member name="M:MailKit.MailFolder.RemoveFlagsAsync(System.Int32,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  48886. <summary>
  48887. Asynchronously remove a set of flags from the specified message.
  48888. </summary>
  48889. <remarks>
  48890. Asynchronously removes a set of flags from the specified message.
  48891. </remarks>
  48892. <returns>An asynchronous task context.</returns>
  48893. <param name="index">The index of the message.</param>
  48894. <param name="flags">The message flags to remove.</param>
  48895. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  48896. <param name="cancellationToken">The cancellation token.</param>
  48897. <exception cref="T:System.ArgumentException">
  48898. <para><paramref name="index"/> is invalid.</para>
  48899. <para>-or-</para>
  48900. <para>No flags were specified.</para>
  48901. </exception>
  48902. <exception cref="T:System.ObjectDisposedException">
  48903. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  48904. </exception>
  48905. <exception cref="T:MailKit.ServiceNotConnectedException">
  48906. The <see cref="T:MailKit.IMailStore"/> is not connected.
  48907. </exception>
  48908. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  48909. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  48910. </exception>
  48911. <exception cref="T:MailKit.FolderNotOpenException">
  48912. The folder is not currently open in read-write mode.
  48913. </exception>
  48914. <exception cref="T:System.OperationCanceledException">
  48915. The operation was canceled via the cancellation token.
  48916. </exception>
  48917. <exception cref="T:System.IO.IOException">
  48918. An I/O error occurred.
  48919. </exception>
  48920. <exception cref="T:MailKit.ProtocolException">
  48921. The server's response contained unexpected tokens.
  48922. </exception>
  48923. <exception cref="T:MailKit.CommandException">
  48924. The command failed.
  48925. </exception>
  48926. </member>
  48927. <member name="M:MailKit.MailFolder.RemoveFlags(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  48928. <summary>
  48929. Remove a set of flags from the specified message.
  48930. </summary>
  48931. <remarks>
  48932. Removes a set of flags from the specified message.
  48933. </remarks>
  48934. <param name="index">The index of the message.</param>
  48935. <param name="flags">The message flags to remove.</param>
  48936. <param name="keywords">A set of user-defined flags to remove.</param>
  48937. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  48938. <param name="cancellationToken">The cancellation token.</param>
  48939. <exception cref="T:System.ArgumentException">
  48940. <para><paramref name="index"/> is invalid.</para>
  48941. <para>-or-</para>
  48942. <para>No flags were specified.</para>
  48943. </exception>
  48944. <exception cref="T:System.ObjectDisposedException">
  48945. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  48946. </exception>
  48947. <exception cref="T:MailKit.ServiceNotConnectedException">
  48948. The <see cref="T:MailKit.IMailStore"/> is not connected.
  48949. </exception>
  48950. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  48951. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  48952. </exception>
  48953. <exception cref="T:MailKit.FolderNotOpenException">
  48954. The folder is not currently open in read-write mode.
  48955. </exception>
  48956. <exception cref="T:System.OperationCanceledException">
  48957. The operation was canceled via the cancellation token.
  48958. </exception>
  48959. <exception cref="T:System.IO.IOException">
  48960. An I/O error occurred.
  48961. </exception>
  48962. <exception cref="T:MailKit.ProtocolException">
  48963. The server's response contained unexpected tokens.
  48964. </exception>
  48965. <exception cref="T:MailKit.CommandException">
  48966. The command failed.
  48967. </exception>
  48968. </member>
  48969. <member name="M:MailKit.MailFolder.RemoveFlagsAsync(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  48970. <summary>
  48971. Asynchronously remove a set of flags from the specified message.
  48972. </summary>
  48973. <remarks>
  48974. Asynchronously removes a set of flags from the specified message.
  48975. </remarks>
  48976. <returns>An asynchronous task context.</returns>
  48977. <param name="index">The index of the message.</param>
  48978. <param name="flags">The message flags to remove.</param>
  48979. <param name="keywords">A set of user-defined flags to remove.</param>
  48980. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  48981. <param name="cancellationToken">The cancellation token.</param>
  48982. <exception cref="T:System.ArgumentException">
  48983. <para><paramref name="index"/> is invalid.</para>
  48984. <para>-or-</para>
  48985. <para>No flags were specified.</para>
  48986. </exception>
  48987. <exception cref="T:System.ObjectDisposedException">
  48988. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  48989. </exception>
  48990. <exception cref="T:MailKit.ServiceNotConnectedException">
  48991. The <see cref="T:MailKit.IMailStore"/> is not connected.
  48992. </exception>
  48993. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  48994. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  48995. </exception>
  48996. <exception cref="T:MailKit.FolderNotOpenException">
  48997. The folder is not currently open in read-write mode.
  48998. </exception>
  48999. <exception cref="T:System.OperationCanceledException">
  49000. The operation was canceled via the cancellation token.
  49001. </exception>
  49002. <exception cref="T:System.IO.IOException">
  49003. An I/O error occurred.
  49004. </exception>
  49005. <exception cref="T:MailKit.ProtocolException">
  49006. The server's response contained unexpected tokens.
  49007. </exception>
  49008. <exception cref="T:MailKit.CommandException">
  49009. The command failed.
  49010. </exception>
  49011. </member>
  49012. <member name="M:MailKit.MailFolder.RemoveFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  49013. <summary>
  49014. Remove a set of flags from the specified messages.
  49015. </summary>
  49016. <remarks>
  49017. Removes a set of flags from the specified messages.
  49018. </remarks>
  49019. <param name="indexes">The indexes of the messages.</param>
  49020. <param name="flags">The message flags to remove.</param>
  49021. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  49022. <param name="cancellationToken">The cancellation token.</param>
  49023. <exception cref="T:System.ArgumentNullException">
  49024. <paramref name="indexes"/> is <c>null</c>.
  49025. </exception>
  49026. <exception cref="T:System.ArgumentException">
  49027. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  49028. <para>-or-</para>
  49029. <para>No flags were specified.</para>
  49030. </exception>
  49031. <exception cref="T:System.ObjectDisposedException">
  49032. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  49033. </exception>
  49034. <exception cref="T:MailKit.ServiceNotConnectedException">
  49035. The <see cref="T:MailKit.IMailStore"/> is not connected.
  49036. </exception>
  49037. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  49038. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  49039. </exception>
  49040. <exception cref="T:MailKit.FolderNotOpenException">
  49041. The folder is not currently open in read-write mode.
  49042. </exception>
  49043. <exception cref="T:System.OperationCanceledException">
  49044. The operation was canceled via the cancellation token.
  49045. </exception>
  49046. <exception cref="T:System.IO.IOException">
  49047. An I/O error occurred.
  49048. </exception>
  49049. <exception cref="T:MailKit.ProtocolException">
  49050. The server's response contained unexpected tokens.
  49051. </exception>
  49052. <exception cref="T:MailKit.CommandException">
  49053. The command failed.
  49054. </exception>
  49055. </member>
  49056. <member name="M:MailKit.MailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  49057. <summary>
  49058. Asynchronously remove a set of flags from the specified messages.
  49059. </summary>
  49060. <remarks>
  49061. Asynchronously removes a set of flags from the specified messages.
  49062. </remarks>
  49063. <returns>An asynchronous task context.</returns>
  49064. <param name="indexes">The indexes of the messages.</param>
  49065. <param name="flags">The message flags to remove.</param>
  49066. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  49067. <param name="cancellationToken">The cancellation token.</param>
  49068. <exception cref="T:System.ArgumentNullException">
  49069. <paramref name="indexes"/> is <c>null</c>.
  49070. </exception>
  49071. <exception cref="T:System.ArgumentException">
  49072. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  49073. <para>-or-</para>
  49074. <para>No flags were specified.</para>
  49075. </exception>
  49076. <exception cref="T:System.ObjectDisposedException">
  49077. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  49078. </exception>
  49079. <exception cref="T:MailKit.ServiceNotConnectedException">
  49080. The <see cref="T:MailKit.IMailStore"/> is not connected.
  49081. </exception>
  49082. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  49083. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  49084. </exception>
  49085. <exception cref="T:MailKit.FolderNotOpenException">
  49086. The folder is not currently open in read-write mode.
  49087. </exception>
  49088. <exception cref="T:System.OperationCanceledException">
  49089. The operation was canceled via the cancellation token.
  49090. </exception>
  49091. <exception cref="T:System.IO.IOException">
  49092. An I/O error occurred.
  49093. </exception>
  49094. <exception cref="T:MailKit.ProtocolException">
  49095. The server's response contained unexpected tokens.
  49096. </exception>
  49097. <exception cref="T:MailKit.CommandException">
  49098. The command failed.
  49099. </exception>
  49100. </member>
  49101. <member name="M:MailKit.MailFolder.RemoveFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  49102. <summary>
  49103. Remove a set of flags from the specified messages.
  49104. </summary>
  49105. <remarks>
  49106. Removes a set of flags from the specified messages.
  49107. </remarks>
  49108. <param name="indexes">The indexes of the messages.</param>
  49109. <param name="flags">The message flags to remove.</param>
  49110. <param name="keywords">A set of user-defined flags to remove.</param>
  49111. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  49112. <param name="cancellationToken">The cancellation token.</param>
  49113. <exception cref="T:System.ArgumentNullException">
  49114. <paramref name="indexes"/> is <c>null</c>.
  49115. </exception>
  49116. <exception cref="T:System.ArgumentException">
  49117. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  49118. <para>-or-</para>
  49119. <para>No flags were specified.</para>
  49120. </exception>
  49121. <exception cref="T:System.ObjectDisposedException">
  49122. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  49123. </exception>
  49124. <exception cref="T:MailKit.ServiceNotConnectedException">
  49125. The <see cref="T:MailKit.IMailStore"/> is not connected.
  49126. </exception>
  49127. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  49128. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  49129. </exception>
  49130. <exception cref="T:MailKit.FolderNotOpenException">
  49131. The folder is not currently open in read-write mode.
  49132. </exception>
  49133. <exception cref="T:System.OperationCanceledException">
  49134. The operation was canceled via the cancellation token.
  49135. </exception>
  49136. <exception cref="T:System.IO.IOException">
  49137. An I/O error occurred.
  49138. </exception>
  49139. <exception cref="T:MailKit.ProtocolException">
  49140. The server's response contained unexpected tokens.
  49141. </exception>
  49142. <exception cref="T:MailKit.CommandException">
  49143. The command failed.
  49144. </exception>
  49145. </member>
  49146. <member name="M:MailKit.MailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  49147. <summary>
  49148. Asynchronously remove a set of flags from the specified messages.
  49149. </summary>
  49150. <remarks>
  49151. Asynchronously removes a set of flags from the specified messages.
  49152. </remarks>
  49153. <returns>An asynchronous task context.</returns>
  49154. <param name="indexes">The indexes of the messages.</param>
  49155. <param name="flags">The message flags to remove.</param>
  49156. <param name="keywords">A set of user-defined flags to remove.</param>
  49157. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  49158. <param name="cancellationToken">The cancellation token.</param>
  49159. <exception cref="T:System.ArgumentNullException">
  49160. <paramref name="indexes"/> is <c>null</c>.
  49161. </exception>
  49162. <exception cref="T:System.ArgumentException">
  49163. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  49164. <para>-or-</para>
  49165. <para>No flags were specified.</para>
  49166. </exception>
  49167. <exception cref="T:System.ObjectDisposedException">
  49168. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  49169. </exception>
  49170. <exception cref="T:MailKit.ServiceNotConnectedException">
  49171. The <see cref="T:MailKit.IMailStore"/> is not connected.
  49172. </exception>
  49173. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  49174. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  49175. </exception>
  49176. <exception cref="T:MailKit.FolderNotOpenException">
  49177. The folder is not currently open in read-write mode.
  49178. </exception>
  49179. <exception cref="T:System.OperationCanceledException">
  49180. The operation was canceled via the cancellation token.
  49181. </exception>
  49182. <exception cref="T:System.IO.IOException">
  49183. An I/O error occurred.
  49184. </exception>
  49185. <exception cref="T:MailKit.ProtocolException">
  49186. The server's response contained unexpected tokens.
  49187. </exception>
  49188. <exception cref="T:MailKit.CommandException">
  49189. The command failed.
  49190. </exception>
  49191. </member>
  49192. <member name="M:MailKit.MailFolder.SetFlags(System.Int32,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  49193. <summary>
  49194. Set the flags of the specified message.
  49195. </summary>
  49196. <remarks>
  49197. Sets the flags of the specified message.
  49198. </remarks>
  49199. <param name="index">The index of the message.</param>
  49200. <param name="flags">The message flags to set.</param>
  49201. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  49202. <param name="cancellationToken">The cancellation token.</param>
  49203. <exception cref="T:System.ArgumentException">
  49204. <para><paramref name="index"/> is invalid.</para>
  49205. </exception>
  49206. <exception cref="T:System.ObjectDisposedException">
  49207. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  49208. </exception>
  49209. <exception cref="T:MailKit.ServiceNotConnectedException">
  49210. The <see cref="T:MailKit.IMailStore"/> is not connected.
  49211. </exception>
  49212. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  49213. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  49214. </exception>
  49215. <exception cref="T:MailKit.FolderNotOpenException">
  49216. The folder is not currently open in read-write mode.
  49217. </exception>
  49218. <exception cref="T:System.OperationCanceledException">
  49219. The operation was canceled via the cancellation token.
  49220. </exception>
  49221. <exception cref="T:System.IO.IOException">
  49222. An I/O error occurred.
  49223. </exception>
  49224. <exception cref="T:MailKit.ProtocolException">
  49225. The server's response contained unexpected tokens.
  49226. </exception>
  49227. <exception cref="T:MailKit.CommandException">
  49228. The command failed.
  49229. </exception>
  49230. </member>
  49231. <member name="M:MailKit.MailFolder.SetFlagsAsync(System.Int32,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  49232. <summary>
  49233. Asynchronously set the flags of the specified message.
  49234. </summary>
  49235. <remarks>
  49236. Asynchronously sets the flags of the specified message.
  49237. </remarks>
  49238. <returns>An asynchronous task context.</returns>
  49239. <param name="index">The index of the message.</param>
  49240. <param name="flags">The message flags to set.</param>
  49241. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  49242. <param name="cancellationToken">The cancellation token.</param>
  49243. <exception cref="T:System.ArgumentException">
  49244. <para><paramref name="index"/> is invalid.</para>
  49245. </exception>
  49246. <exception cref="T:System.ObjectDisposedException">
  49247. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  49248. </exception>
  49249. <exception cref="T:MailKit.ServiceNotConnectedException">
  49250. The <see cref="T:MailKit.IMailStore"/> is not connected.
  49251. </exception>
  49252. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  49253. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  49254. </exception>
  49255. <exception cref="T:MailKit.FolderNotOpenException">
  49256. The folder is not currently open in read-write mode.
  49257. </exception>
  49258. <exception cref="T:System.OperationCanceledException">
  49259. The operation was canceled via the cancellation token.
  49260. </exception>
  49261. <exception cref="T:System.IO.IOException">
  49262. An I/O error occurred.
  49263. </exception>
  49264. <exception cref="T:MailKit.ProtocolException">
  49265. The server's response contained unexpected tokens.
  49266. </exception>
  49267. <exception cref="T:MailKit.CommandException">
  49268. The command failed.
  49269. </exception>
  49270. </member>
  49271. <member name="M:MailKit.MailFolder.SetFlags(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  49272. <summary>
  49273. Set the flags of the specified message.
  49274. </summary>
  49275. <remarks>
  49276. Sets the flags of the specified message.
  49277. </remarks>
  49278. <param name="index">The index of the message.</param>
  49279. <param name="flags">The message flags to set.</param>
  49280. <param name="keywords">A set of user-defined flags to set.</param>
  49281. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  49282. <param name="cancellationToken">The cancellation token.</param>
  49283. <exception cref="T:System.ArgumentException">
  49284. <para><paramref name="index"/> is invalid.</para>
  49285. </exception>
  49286. <exception cref="T:System.ObjectDisposedException">
  49287. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  49288. </exception>
  49289. <exception cref="T:MailKit.ServiceNotConnectedException">
  49290. The <see cref="T:MailKit.IMailStore"/> is not connected.
  49291. </exception>
  49292. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  49293. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  49294. </exception>
  49295. <exception cref="T:MailKit.FolderNotOpenException">
  49296. The folder is not currently open in read-write mode.
  49297. </exception>
  49298. <exception cref="T:System.OperationCanceledException">
  49299. The operation was canceled via the cancellation token.
  49300. </exception>
  49301. <exception cref="T:System.IO.IOException">
  49302. An I/O error occurred.
  49303. </exception>
  49304. <exception cref="T:MailKit.ProtocolException">
  49305. The server's response contained unexpected tokens.
  49306. </exception>
  49307. <exception cref="T:MailKit.CommandException">
  49308. The command failed.
  49309. </exception>
  49310. </member>
  49311. <member name="M:MailKit.MailFolder.SetFlagsAsync(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  49312. <summary>
  49313. Asynchronously set the flags of the specified message.
  49314. </summary>
  49315. <remarks>
  49316. Asynchronously sets the flags of the specified message.
  49317. </remarks>
  49318. <returns>An asynchronous task context.</returns>
  49319. <param name="index">The index of the message.</param>
  49320. <param name="flags">The message flags to set.</param>
  49321. <param name="keywords">A set of user-defined flags to set.</param>
  49322. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  49323. <param name="cancellationToken">The cancellation token.</param>
  49324. <exception cref="T:System.ArgumentException">
  49325. <para><paramref name="index"/> is invalid.</para>
  49326. </exception>
  49327. <exception cref="T:System.ObjectDisposedException">
  49328. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  49329. </exception>
  49330. <exception cref="T:MailKit.ServiceNotConnectedException">
  49331. The <see cref="T:MailKit.IMailStore"/> is not connected.
  49332. </exception>
  49333. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  49334. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  49335. </exception>
  49336. <exception cref="T:MailKit.FolderNotOpenException">
  49337. The folder is not currently open in read-write mode.
  49338. </exception>
  49339. <exception cref="T:System.OperationCanceledException">
  49340. The operation was canceled via the cancellation token.
  49341. </exception>
  49342. <exception cref="T:System.IO.IOException">
  49343. An I/O error occurred.
  49344. </exception>
  49345. <exception cref="T:MailKit.ProtocolException">
  49346. The server's response contained unexpected tokens.
  49347. </exception>
  49348. <exception cref="T:MailKit.CommandException">
  49349. The command failed.
  49350. </exception>
  49351. </member>
  49352. <member name="M:MailKit.MailFolder.SetFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  49353. <summary>
  49354. Set the flags of the specified messages.
  49355. </summary>
  49356. <remarks>
  49357. Sets the flags of the specified messages.
  49358. </remarks>
  49359. <param name="indexes">The indexes of the messages.</param>
  49360. <param name="flags">The message flags to set.</param>
  49361. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  49362. <param name="cancellationToken">The cancellation token.</param>
  49363. <exception cref="T:System.ArgumentNullException">
  49364. <paramref name="indexes"/> is <c>null</c>.
  49365. </exception>
  49366. <exception cref="T:System.ArgumentException">
  49367. One or more of the <paramref name="indexes"/> is invalid.
  49368. </exception>
  49369. <exception cref="T:System.ObjectDisposedException">
  49370. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  49371. </exception>
  49372. <exception cref="T:MailKit.ServiceNotConnectedException">
  49373. The <see cref="T:MailKit.IMailStore"/> is not connected.
  49374. </exception>
  49375. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  49376. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  49377. </exception>
  49378. <exception cref="T:MailKit.FolderNotOpenException">
  49379. The folder is not currently open in read-write mode.
  49380. </exception>
  49381. <exception cref="T:System.OperationCanceledException">
  49382. The operation was canceled via the cancellation token.
  49383. </exception>
  49384. <exception cref="T:System.IO.IOException">
  49385. An I/O error occurred.
  49386. </exception>
  49387. <exception cref="T:MailKit.ProtocolException">
  49388. The server's response contained unexpected tokens.
  49389. </exception>
  49390. <exception cref="T:MailKit.CommandException">
  49391. The command failed.
  49392. </exception>
  49393. </member>
  49394. <member name="M:MailKit.MailFolder.SetFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  49395. <summary>
  49396. Asynchronously set the flags of the specified messages.
  49397. </summary>
  49398. <remarks>
  49399. Asynchronously sets the flags of the specified messages.
  49400. </remarks>
  49401. <returns>An asynchronous task context.</returns>
  49402. <param name="indexes">The indexes of the messages.</param>
  49403. <param name="flags">The message flags to set.</param>
  49404. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  49405. <param name="cancellationToken">The cancellation token.</param>
  49406. <exception cref="T:System.ArgumentNullException">
  49407. <paramref name="indexes"/> is <c>null</c>.
  49408. </exception>
  49409. <exception cref="T:System.ArgumentException">
  49410. One or more of the <paramref name="indexes"/> is invalid.
  49411. </exception>
  49412. <exception cref="T:System.ObjectDisposedException">
  49413. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  49414. </exception>
  49415. <exception cref="T:MailKit.ServiceNotConnectedException">
  49416. The <see cref="T:MailKit.IMailStore"/> is not connected.
  49417. </exception>
  49418. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  49419. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  49420. </exception>
  49421. <exception cref="T:MailKit.FolderNotOpenException">
  49422. The folder is not currently open in read-write mode.
  49423. </exception>
  49424. <exception cref="T:System.OperationCanceledException">
  49425. The operation was canceled via the cancellation token.
  49426. </exception>
  49427. <exception cref="T:System.IO.IOException">
  49428. An I/O error occurred.
  49429. </exception>
  49430. <exception cref="T:MailKit.ProtocolException">
  49431. The server's response contained unexpected tokens.
  49432. </exception>
  49433. <exception cref="T:MailKit.CommandException">
  49434. The command failed.
  49435. </exception>
  49436. </member>
  49437. <member name="M:MailKit.MailFolder.SetFlags(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  49438. <summary>
  49439. Set the flags of the specified messages.
  49440. </summary>
  49441. <remarks>
  49442. Sets the flags of the specified messages.
  49443. </remarks>
  49444. <param name="indexes">The indexes of the messages.</param>
  49445. <param name="flags">The message flags to set.</param>
  49446. <param name="keywords">A set of user-defined flags to set.</param>
  49447. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  49448. <param name="cancellationToken">The cancellation token.</param>
  49449. <exception cref="T:System.ArgumentNullException">
  49450. <paramref name="indexes"/> is <c>null</c>.
  49451. </exception>
  49452. <exception cref="T:System.ArgumentException">
  49453. One or more of the <paramref name="indexes"/> is invalid.
  49454. </exception>
  49455. <exception cref="T:System.ObjectDisposedException">
  49456. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  49457. </exception>
  49458. <exception cref="T:MailKit.ServiceNotConnectedException">
  49459. The <see cref="T:MailKit.IMailStore"/> is not connected.
  49460. </exception>
  49461. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  49462. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  49463. </exception>
  49464. <exception cref="T:MailKit.FolderNotOpenException">
  49465. The folder is not currently open in read-write mode.
  49466. </exception>
  49467. <exception cref="T:System.OperationCanceledException">
  49468. The operation was canceled via the cancellation token.
  49469. </exception>
  49470. <exception cref="T:System.IO.IOException">
  49471. An I/O error occurred.
  49472. </exception>
  49473. <exception cref="T:MailKit.ProtocolException">
  49474. The server's response contained unexpected tokens.
  49475. </exception>
  49476. <exception cref="T:MailKit.CommandException">
  49477. The command failed.
  49478. </exception>
  49479. </member>
  49480. <member name="M:MailKit.MailFolder.SetFlagsAsync(System.Collections.Generic.IList{System.Int32},MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  49481. <summary>
  49482. Asynchronously set the flags of the specified messages.
  49483. </summary>
  49484. <remarks>
  49485. Asynchronously sets the flags of the specified messages.
  49486. </remarks>
  49487. <returns>An asynchronous task context.</returns>
  49488. <param name="indexes">The indexes of the messages.</param>
  49489. <param name="flags">The message flags to set.</param>
  49490. <param name="keywords">A set of user-defined flags to set.</param>
  49491. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  49492. <param name="cancellationToken">The cancellation token.</param>
  49493. <exception cref="T:System.ArgumentNullException">
  49494. <paramref name="indexes"/> is <c>null</c>.
  49495. </exception>
  49496. <exception cref="T:System.ArgumentException">
  49497. One or more of the <paramref name="indexes"/> is invalid.
  49498. </exception>
  49499. <exception cref="T:System.ObjectDisposedException">
  49500. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  49501. </exception>
  49502. <exception cref="T:MailKit.ServiceNotConnectedException">
  49503. The <see cref="T:MailKit.IMailStore"/> is not connected.
  49504. </exception>
  49505. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  49506. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  49507. </exception>
  49508. <exception cref="T:MailKit.FolderNotOpenException">
  49509. The folder is not currently open in read-write mode.
  49510. </exception>
  49511. <exception cref="T:System.OperationCanceledException">
  49512. The operation was canceled via the cancellation token.
  49513. </exception>
  49514. <exception cref="T:System.IO.IOException">
  49515. An I/O error occurred.
  49516. </exception>
  49517. <exception cref="T:MailKit.ProtocolException">
  49518. The server's response contained unexpected tokens.
  49519. </exception>
  49520. <exception cref="T:MailKit.CommandException">
  49521. The command failed.
  49522. </exception>
  49523. </member>
  49524. <member name="M:MailKit.MailFolder.AddFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  49525. <summary>
  49526. Add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
  49527. </summary>
  49528. <remarks>
  49529. Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
  49530. </remarks>
  49531. <returns>The indexes of the messages that were not updated.</returns>
  49532. <param name="indexes">The indexes of the messages.</param>
  49533. <param name="modseq">The mod-sequence value.</param>
  49534. <param name="flags">The message flags to add.</param>
  49535. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  49536. <param name="cancellationToken">The cancellation token.</param>
  49537. <exception cref="T:System.ArgumentNullException">
  49538. <paramref name="indexes"/> is <c>null</c>.
  49539. </exception>
  49540. <exception cref="T:System.ArgumentException">
  49541. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  49542. <para>-or-</para>
  49543. <para>No flags were specified.</para>
  49544. </exception>
  49545. <exception cref="T:System.ObjectDisposedException">
  49546. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  49547. </exception>
  49548. <exception cref="T:MailKit.ServiceNotConnectedException">
  49549. The <see cref="T:MailKit.IMailStore"/> is not connected.
  49550. </exception>
  49551. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  49552. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  49553. </exception>
  49554. <exception cref="T:MailKit.FolderNotOpenException">
  49555. The folder is not currently open in read-write mode.
  49556. </exception>
  49557. <exception cref="T:System.NotSupportedException">
  49558. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  49559. </exception>
  49560. <exception cref="T:System.OperationCanceledException">
  49561. The operation was canceled via the cancellation token.
  49562. </exception>
  49563. <exception cref="T:System.IO.IOException">
  49564. An I/O error occurred.
  49565. </exception>
  49566. <exception cref="T:MailKit.ProtocolException">
  49567. The server's response contained unexpected tokens.
  49568. </exception>
  49569. <exception cref="T:MailKit.CommandException">
  49570. The command failed.
  49571. </exception>
  49572. </member>
  49573. <member name="M:MailKit.MailFolder.AddFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  49574. <summary>
  49575. Asynchronously add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
  49576. </summary>
  49577. <remarks>
  49578. Asynchronously adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
  49579. </remarks>
  49580. <returns>The indexes of the messages that were not updated.</returns>
  49581. <param name="indexes">The indexes of the messages.</param>
  49582. <param name="modseq">The mod-sequence value.</param>
  49583. <param name="flags">The message flags to add.</param>
  49584. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  49585. <param name="cancellationToken">The cancellation token.</param>
  49586. <exception cref="T:System.ArgumentNullException">
  49587. <paramref name="indexes"/> is <c>null</c>.
  49588. </exception>
  49589. <exception cref="T:System.ArgumentException">
  49590. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  49591. <para>-or-</para>
  49592. <para>No flags were specified.</para>
  49593. </exception>
  49594. <exception cref="T:System.ObjectDisposedException">
  49595. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  49596. </exception>
  49597. <exception cref="T:MailKit.ServiceNotConnectedException">
  49598. The <see cref="T:MailKit.IMailStore"/> is not connected.
  49599. </exception>
  49600. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  49601. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  49602. </exception>
  49603. <exception cref="T:MailKit.FolderNotOpenException">
  49604. The folder is not currently open in read-write mode.
  49605. </exception>
  49606. <exception cref="T:System.NotSupportedException">
  49607. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  49608. </exception>
  49609. <exception cref="T:System.OperationCanceledException">
  49610. The operation was canceled via the cancellation token.
  49611. </exception>
  49612. <exception cref="T:System.IO.IOException">
  49613. An I/O error occurred.
  49614. </exception>
  49615. <exception cref="T:MailKit.ProtocolException">
  49616. The server's response contained unexpected tokens.
  49617. </exception>
  49618. <exception cref="T:MailKit.CommandException">
  49619. The command failed.
  49620. </exception>
  49621. </member>
  49622. <member name="M:MailKit.MailFolder.AddFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  49623. <summary>
  49624. Add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
  49625. </summary>
  49626. <remarks>
  49627. Adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
  49628. </remarks>
  49629. <returns>The indexes of the messages that were not updated.</returns>
  49630. <param name="indexes">The indexes of the messages.</param>
  49631. <param name="modseq">The mod-sequence value.</param>
  49632. <param name="flags">The message flags to add.</param>
  49633. <param name="keywords">A set of user-defined flags to add.</param>
  49634. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  49635. <param name="cancellationToken">The cancellation token.</param>
  49636. <exception cref="T:System.ArgumentNullException">
  49637. <paramref name="indexes"/> is <c>null</c>.
  49638. </exception>
  49639. <exception cref="T:System.ArgumentException">
  49640. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  49641. <para>-or-</para>
  49642. <para>No flags were specified.</para>
  49643. </exception>
  49644. <exception cref="T:System.ObjectDisposedException">
  49645. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  49646. </exception>
  49647. <exception cref="T:MailKit.ServiceNotConnectedException">
  49648. The <see cref="T:MailKit.IMailStore"/> is not connected.
  49649. </exception>
  49650. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  49651. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  49652. </exception>
  49653. <exception cref="T:MailKit.FolderNotOpenException">
  49654. The folder is not currently open in read-write mode.
  49655. </exception>
  49656. <exception cref="T:System.NotSupportedException">
  49657. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  49658. </exception>
  49659. <exception cref="T:System.OperationCanceledException">
  49660. The operation was canceled via the cancellation token.
  49661. </exception>
  49662. <exception cref="T:System.IO.IOException">
  49663. An I/O error occurred.
  49664. </exception>
  49665. <exception cref="T:MailKit.ProtocolException">
  49666. The server's response contained unexpected tokens.
  49667. </exception>
  49668. <exception cref="T:MailKit.CommandException">
  49669. The command failed.
  49670. </exception>
  49671. </member>
  49672. <member name="M:MailKit.MailFolder.AddFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  49673. <summary>
  49674. Asynchronously add a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
  49675. </summary>
  49676. <remarks>
  49677. Asynchronously adds a set of flags to the specified messages only if their mod-sequence value is less than the specified value.
  49678. </remarks>
  49679. <returns>The indexes of the messages that were not updated.</returns>
  49680. <param name="indexes">The indexes of the messages.</param>
  49681. <param name="modseq">The mod-sequence value.</param>
  49682. <param name="flags">The message flags to add.</param>
  49683. <param name="keywords">A set of user-defined flags to add.</param>
  49684. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  49685. <param name="cancellationToken">The cancellation token.</param>
  49686. <exception cref="T:System.ArgumentNullException">
  49687. <paramref name="indexes"/> is <c>null</c>.
  49688. </exception>
  49689. <exception cref="T:System.ArgumentException">
  49690. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  49691. <para>-or-</para>
  49692. <para>No flags were specified.</para>
  49693. </exception>
  49694. <exception cref="T:System.ObjectDisposedException">
  49695. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  49696. </exception>
  49697. <exception cref="T:MailKit.ServiceNotConnectedException">
  49698. The <see cref="T:MailKit.IMailStore"/> is not connected.
  49699. </exception>
  49700. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  49701. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  49702. </exception>
  49703. <exception cref="T:MailKit.FolderNotOpenException">
  49704. The folder is not currently open in read-write mode.
  49705. </exception>
  49706. <exception cref="T:System.NotSupportedException">
  49707. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  49708. </exception>
  49709. <exception cref="T:System.OperationCanceledException">
  49710. The operation was canceled via the cancellation token.
  49711. </exception>
  49712. <exception cref="T:System.IO.IOException">
  49713. An I/O error occurred.
  49714. </exception>
  49715. <exception cref="T:MailKit.ProtocolException">
  49716. The server's response contained unexpected tokens.
  49717. </exception>
  49718. <exception cref="T:MailKit.CommandException">
  49719. The command failed.
  49720. </exception>
  49721. </member>
  49722. <member name="M:MailKit.MailFolder.RemoveFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  49723. <summary>
  49724. Remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
  49725. </summary>
  49726. <remarks>
  49727. Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
  49728. </remarks>
  49729. <returns>The indexes of the messages that were not updated.</returns>
  49730. <param name="indexes">The indexes of the messages.</param>
  49731. <param name="modseq">The mod-sequence value.</param>
  49732. <param name="flags">The message flags to remove.</param>
  49733. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  49734. <param name="cancellationToken">The cancellation token.</param>
  49735. <exception cref="T:System.ArgumentNullException">
  49736. <paramref name="indexes"/> is <c>null</c>.
  49737. </exception>
  49738. <exception cref="T:System.ArgumentException">
  49739. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  49740. <para>-or-</para>
  49741. <para>No flags were specified.</para>
  49742. </exception>
  49743. <exception cref="T:System.ObjectDisposedException">
  49744. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  49745. </exception>
  49746. <exception cref="T:MailKit.ServiceNotConnectedException">
  49747. The <see cref="T:MailKit.IMailStore"/> is not connected.
  49748. </exception>
  49749. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  49750. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  49751. </exception>
  49752. <exception cref="T:MailKit.FolderNotOpenException">
  49753. The folder is not currently open in read-write mode.
  49754. </exception>
  49755. <exception cref="T:System.NotSupportedException">
  49756. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  49757. </exception>
  49758. <exception cref="T:System.OperationCanceledException">
  49759. The operation was canceled via the cancellation token.
  49760. </exception>
  49761. <exception cref="T:System.IO.IOException">
  49762. An I/O error occurred.
  49763. </exception>
  49764. <exception cref="T:MailKit.ProtocolException">
  49765. The server's response contained unexpected tokens.
  49766. </exception>
  49767. <exception cref="T:MailKit.CommandException">
  49768. The command failed.
  49769. </exception>
  49770. </member>
  49771. <member name="M:MailKit.MailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  49772. <summary>
  49773. Asynchronously remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
  49774. </summary>
  49775. <remarks>
  49776. Asynchronously removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
  49777. </remarks>
  49778. <returns>The indexes of the messages that were not updated.</returns>
  49779. <param name="indexes">The indexes of the messages.</param>
  49780. <param name="modseq">The mod-sequence value.</param>
  49781. <param name="flags">The message flags to remove.</param>
  49782. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  49783. <param name="cancellationToken">The cancellation token.</param>
  49784. <exception cref="T:System.ArgumentNullException">
  49785. <paramref name="indexes"/> is <c>null</c>.
  49786. </exception>
  49787. <exception cref="T:System.ArgumentException">
  49788. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  49789. <para>-or-</para>
  49790. <para>No flags were specified.</para>
  49791. </exception>
  49792. <exception cref="T:System.ObjectDisposedException">
  49793. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  49794. </exception>
  49795. <exception cref="T:MailKit.ServiceNotConnectedException">
  49796. The <see cref="T:MailKit.IMailStore"/> is not connected.
  49797. </exception>
  49798. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  49799. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  49800. </exception>
  49801. <exception cref="T:MailKit.FolderNotOpenException">
  49802. The folder is not currently open in read-write mode.
  49803. </exception>
  49804. <exception cref="T:System.NotSupportedException">
  49805. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  49806. </exception>
  49807. <exception cref="T:System.OperationCanceledException">
  49808. The operation was canceled via the cancellation token.
  49809. </exception>
  49810. <exception cref="T:System.IO.IOException">
  49811. An I/O error occurred.
  49812. </exception>
  49813. <exception cref="T:MailKit.ProtocolException">
  49814. The server's response contained unexpected tokens.
  49815. </exception>
  49816. <exception cref="T:MailKit.CommandException">
  49817. The command failed.
  49818. </exception>
  49819. </member>
  49820. <member name="M:MailKit.MailFolder.RemoveFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  49821. <summary>
  49822. Remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
  49823. </summary>
  49824. <remarks>
  49825. Removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
  49826. </remarks>
  49827. <returns>The indexes of the messages that were not updated.</returns>
  49828. <param name="indexes">The indexes of the messages.</param>
  49829. <param name="modseq">The mod-sequence value.</param>
  49830. <param name="flags">The message flags to remove.</param>
  49831. <param name="keywords">A set of user-defined flags to remove.</param>
  49832. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  49833. <param name="cancellationToken">The cancellation token.</param>
  49834. <exception cref="T:System.ArgumentNullException">
  49835. <paramref name="indexes"/> is <c>null</c>.
  49836. </exception>
  49837. <exception cref="T:System.ArgumentException">
  49838. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  49839. <para>-or-</para>
  49840. <para>No flags were specified.</para>
  49841. </exception>
  49842. <exception cref="T:System.ObjectDisposedException">
  49843. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  49844. </exception>
  49845. <exception cref="T:MailKit.ServiceNotConnectedException">
  49846. The <see cref="T:MailKit.IMailStore"/> is not connected.
  49847. </exception>
  49848. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  49849. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  49850. </exception>
  49851. <exception cref="T:MailKit.FolderNotOpenException">
  49852. The folder is not currently open in read-write mode.
  49853. </exception>
  49854. <exception cref="T:System.NotSupportedException">
  49855. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  49856. </exception>
  49857. <exception cref="T:System.OperationCanceledException">
  49858. The operation was canceled via the cancellation token.
  49859. </exception>
  49860. <exception cref="T:System.IO.IOException">
  49861. An I/O error occurred.
  49862. </exception>
  49863. <exception cref="T:MailKit.ProtocolException">
  49864. The server's response contained unexpected tokens.
  49865. </exception>
  49866. <exception cref="T:MailKit.CommandException">
  49867. The command failed.
  49868. </exception>
  49869. </member>
  49870. <member name="M:MailKit.MailFolder.RemoveFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  49871. <summary>
  49872. Asynchronously remove a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
  49873. </summary>
  49874. <remarks>
  49875. Asynchronously removes a set of flags from the specified messages only if their mod-sequence value is less than the specified value.
  49876. </remarks>
  49877. <returns>The indexes of the messages that were not updated.</returns>
  49878. <param name="indexes">The indexes of the messages.</param>
  49879. <param name="modseq">The mod-sequence value.</param>
  49880. <param name="flags">The message flags to remove.</param>
  49881. <param name="keywords">A set of user-defined flags to remove.</param>
  49882. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  49883. <param name="cancellationToken">The cancellation token.</param>
  49884. <exception cref="T:System.ArgumentNullException">
  49885. <paramref name="indexes"/> is <c>null</c>.
  49886. </exception>
  49887. <exception cref="T:System.ArgumentException">
  49888. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  49889. <para>-or-</para>
  49890. <para>No flags were specified.</para>
  49891. </exception>
  49892. <exception cref="T:System.ObjectDisposedException">
  49893. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  49894. </exception>
  49895. <exception cref="T:MailKit.ServiceNotConnectedException">
  49896. The <see cref="T:MailKit.IMailStore"/> is not connected.
  49897. </exception>
  49898. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  49899. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  49900. </exception>
  49901. <exception cref="T:MailKit.FolderNotOpenException">
  49902. The folder is not currently open in read-write mode.
  49903. </exception>
  49904. <exception cref="T:System.NotSupportedException">
  49905. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  49906. </exception>
  49907. <exception cref="T:System.OperationCanceledException">
  49908. The operation was canceled via the cancellation token.
  49909. </exception>
  49910. <exception cref="T:System.IO.IOException">
  49911. An I/O error occurred.
  49912. </exception>
  49913. <exception cref="T:MailKit.ProtocolException">
  49914. The server's response contained unexpected tokens.
  49915. </exception>
  49916. <exception cref="T:MailKit.CommandException">
  49917. The command failed.
  49918. </exception>
  49919. </member>
  49920. <member name="M:MailKit.MailFolder.SetFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  49921. <summary>
  49922. Set the flags of the specified messages only if their mod-sequence value is less than the specified value.
  49923. </summary>
  49924. <remarks>
  49925. Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
  49926. </remarks>
  49927. <returns>The indexes of the messages that were not updated.</returns>
  49928. <param name="indexes">The indexes of the messages.</param>
  49929. <param name="modseq">The mod-sequence value.</param>
  49930. <param name="flags">The message flags to set.</param>
  49931. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  49932. <param name="cancellationToken">The cancellation token.</param>
  49933. <exception cref="T:System.ArgumentNullException">
  49934. <paramref name="indexes"/> is <c>null</c>.
  49935. </exception>
  49936. <exception cref="T:System.ArgumentException">
  49937. One or more of the <paramref name="indexes"/> is invalid.
  49938. </exception>
  49939. <exception cref="T:System.ObjectDisposedException">
  49940. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  49941. </exception>
  49942. <exception cref="T:MailKit.ServiceNotConnectedException">
  49943. The <see cref="T:MailKit.IMailStore"/> is not connected.
  49944. </exception>
  49945. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  49946. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  49947. </exception>
  49948. <exception cref="T:MailKit.FolderNotOpenException">
  49949. The folder is not currently open in read-write mode.
  49950. </exception>
  49951. <exception cref="T:System.NotSupportedException">
  49952. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  49953. </exception>
  49954. <exception cref="T:System.OperationCanceledException">
  49955. The operation was canceled via the cancellation token.
  49956. </exception>
  49957. <exception cref="T:System.IO.IOException">
  49958. An I/O error occurred.
  49959. </exception>
  49960. <exception cref="T:MailKit.ProtocolException">
  49961. The server's response contained unexpected tokens.
  49962. </exception>
  49963. <exception cref="T:MailKit.CommandException">
  49964. The command failed.
  49965. </exception>
  49966. </member>
  49967. <member name="M:MailKit.MailFolder.SetFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Boolean,System.Threading.CancellationToken)">
  49968. <summary>
  49969. Asynchronously set the flags of the specified messages only if their mod-sequence value is less than the specified value.
  49970. </summary>
  49971. <remarks>
  49972. Asynchronously sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
  49973. </remarks>
  49974. <returns>The indexes of the messages that were not updated.</returns>
  49975. <param name="indexes">The indexes of the messages.</param>
  49976. <param name="modseq">The mod-sequence value.</param>
  49977. <param name="flags">The message flags to set.</param>
  49978. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  49979. <param name="cancellationToken">The cancellation token.</param>
  49980. <exception cref="T:System.ArgumentNullException">
  49981. <paramref name="indexes"/> is <c>null</c>.
  49982. </exception>
  49983. <exception cref="T:System.ArgumentException">
  49984. One or more of the <paramref name="indexes"/> is invalid.
  49985. </exception>
  49986. <exception cref="T:System.ObjectDisposedException">
  49987. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  49988. </exception>
  49989. <exception cref="T:MailKit.ServiceNotConnectedException">
  49990. The <see cref="T:MailKit.IMailStore"/> is not connected.
  49991. </exception>
  49992. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  49993. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  49994. </exception>
  49995. <exception cref="T:MailKit.FolderNotOpenException">
  49996. The folder is not currently open in read-write mode.
  49997. </exception>
  49998. <exception cref="T:System.NotSupportedException">
  49999. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  50000. </exception>
  50001. <exception cref="T:System.OperationCanceledException">
  50002. The operation was canceled via the cancellation token.
  50003. </exception>
  50004. <exception cref="T:System.IO.IOException">
  50005. An I/O error occurred.
  50006. </exception>
  50007. <exception cref="T:MailKit.ProtocolException">
  50008. The server's response contained unexpected tokens.
  50009. </exception>
  50010. <exception cref="T:MailKit.CommandException">
  50011. The command failed.
  50012. </exception>
  50013. </member>
  50014. <member name="M:MailKit.MailFolder.SetFlags(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  50015. <summary>
  50016. Set the flags of the specified messages only if their mod-sequence value is less than the specified value.
  50017. </summary>
  50018. <remarks>
  50019. Sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
  50020. </remarks>
  50021. <returns>The indexes of the messages that were not updated.</returns>
  50022. <param name="indexes">The indexes of the messages.</param>
  50023. <param name="modseq">The mod-sequence value.</param>
  50024. <param name="flags">The message flags to set.</param>
  50025. <param name="keywords">A set of user-defined flags to set.</param>
  50026. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  50027. <param name="cancellationToken">The cancellation token.</param>
  50028. <exception cref="T:System.ArgumentNullException">
  50029. <paramref name="indexes"/> is <c>null</c>.
  50030. </exception>
  50031. <exception cref="T:System.ArgumentException">
  50032. One or more of the <paramref name="indexes"/> is invalid.
  50033. </exception>
  50034. <exception cref="T:System.ObjectDisposedException">
  50035. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  50036. </exception>
  50037. <exception cref="T:MailKit.ServiceNotConnectedException">
  50038. The <see cref="T:MailKit.IMailStore"/> is not connected.
  50039. </exception>
  50040. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  50041. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  50042. </exception>
  50043. <exception cref="T:MailKit.FolderNotOpenException">
  50044. The folder is not currently open in read-write mode.
  50045. </exception>
  50046. <exception cref="T:System.NotSupportedException">
  50047. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  50048. </exception>
  50049. <exception cref="T:System.OperationCanceledException">
  50050. The operation was canceled via the cancellation token.
  50051. </exception>
  50052. <exception cref="T:System.IO.IOException">
  50053. An I/O error occurred.
  50054. </exception>
  50055. <exception cref="T:MailKit.ProtocolException">
  50056. The server's response contained unexpected tokens.
  50057. </exception>
  50058. <exception cref="T:MailKit.CommandException">
  50059. The command failed.
  50060. </exception>
  50061. </member>
  50062. <member name="M:MailKit.MailFolder.SetFlagsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.Boolean,System.Threading.CancellationToken)">
  50063. <summary>
  50064. Asynchronously set the flags of the specified messages only if their mod-sequence value is less than the specified value.
  50065. </summary>
  50066. <remarks>
  50067. Asynchronously sets the flags of the specified messages only if their mod-sequence value is less than the specified value.
  50068. </remarks>
  50069. <returns>The indexes of the messages that were not updated.</returns>
  50070. <param name="indexes">The indexes of the messages.</param>
  50071. <param name="modseq">The mod-sequence value.</param>
  50072. <param name="flags">The message flags to set.</param>
  50073. <param name="keywords">A set of user-defined flags to set.</param>
  50074. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> events will be emitted.</param>
  50075. <param name="cancellationToken">The cancellation token.</param>
  50076. <exception cref="T:System.ArgumentNullException">
  50077. <paramref name="indexes"/> is <c>null</c>.
  50078. </exception>
  50079. <exception cref="T:System.ArgumentException">
  50080. One or more of the <paramref name="indexes"/> is invalid.
  50081. </exception>
  50082. <exception cref="T:System.ObjectDisposedException">
  50083. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  50084. </exception>
  50085. <exception cref="T:MailKit.ServiceNotConnectedException">
  50086. The <see cref="T:MailKit.IMailStore"/> is not connected.
  50087. </exception>
  50088. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  50089. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  50090. </exception>
  50091. <exception cref="T:MailKit.FolderNotOpenException">
  50092. The folder is not currently open in read-write mode.
  50093. </exception>
  50094. <exception cref="T:System.NotSupportedException">
  50095. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  50096. </exception>
  50097. <exception cref="T:System.OperationCanceledException">
  50098. The operation was canceled via the cancellation token.
  50099. </exception>
  50100. <exception cref="T:System.IO.IOException">
  50101. An I/O error occurred.
  50102. </exception>
  50103. <exception cref="T:MailKit.ProtocolException">
  50104. The server's response contained unexpected tokens.
  50105. </exception>
  50106. <exception cref="T:MailKit.CommandException">
  50107. The command failed.
  50108. </exception>
  50109. </member>
  50110. <member name="M:MailKit.MailFolder.AddLabels(MailKit.UniqueId,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  50111. <summary>
  50112. Add a set of labels to the specified message.
  50113. </summary>
  50114. <remarks>
  50115. Adds a set of labels to the specified message.
  50116. </remarks>
  50117. <param name="uid">The UID of the message.</param>
  50118. <param name="labels">The labels to add.</param>
  50119. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  50120. <param name="cancellationToken">The cancellation token.</param>
  50121. <exception cref="T:System.ArgumentNullException">
  50122. <paramref name="labels"/> is <c>null</c>.
  50123. </exception>
  50124. <exception cref="T:System.ArgumentException">
  50125. <para><paramref name="uid"/> is invalid.</para>
  50126. <para>-or-</para>
  50127. <para>No labels were specified.</para>
  50128. </exception>
  50129. <exception cref="T:System.ObjectDisposedException">
  50130. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  50131. </exception>
  50132. <exception cref="T:MailKit.ServiceNotConnectedException">
  50133. The <see cref="T:MailKit.IMailStore"/> is not connected.
  50134. </exception>
  50135. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  50136. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  50137. </exception>
  50138. <exception cref="T:MailKit.FolderNotOpenException">
  50139. The folder is not currently open in read-write mode.
  50140. </exception>
  50141. <exception cref="T:System.OperationCanceledException">
  50142. The operation was canceled via the cancellation token.
  50143. </exception>
  50144. <exception cref="T:System.IO.IOException">
  50145. An I/O error occurred.
  50146. </exception>
  50147. <exception cref="T:MailKit.ProtocolException">
  50148. The server's response contained unexpected tokens.
  50149. </exception>
  50150. <exception cref="T:MailKit.CommandException">
  50151. The command failed.
  50152. </exception>
  50153. </member>
  50154. <member name="M:MailKit.MailFolder.AddLabelsAsync(MailKit.UniqueId,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  50155. <summary>
  50156. Asynchronously add a set of labels to the specified message.
  50157. </summary>
  50158. <remarks>
  50159. Asynchronously adds a set of labels to the specified message.
  50160. </remarks>
  50161. <returns>An asynchronous task context.</returns>
  50162. <param name="uid">The UID of the message.</param>
  50163. <param name="labels">The labels to add.</param>
  50164. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  50165. <param name="cancellationToken">The cancellation token.</param>
  50166. <exception cref="T:System.ArgumentNullException">
  50167. <paramref name="labels"/> is <c>null</c>.
  50168. </exception>
  50169. <exception cref="T:System.ArgumentException">
  50170. <para><paramref name="uid"/> is invalid.</para>
  50171. <para>-or-</para>
  50172. <para>No labels were specified.</para>
  50173. </exception>
  50174. <exception cref="T:System.ObjectDisposedException">
  50175. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  50176. </exception>
  50177. <exception cref="T:MailKit.ServiceNotConnectedException">
  50178. The <see cref="T:MailKit.IMailStore"/> is not connected.
  50179. </exception>
  50180. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  50181. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  50182. </exception>
  50183. <exception cref="T:MailKit.FolderNotOpenException">
  50184. The folder is not currently open in read-write mode.
  50185. </exception>
  50186. <exception cref="T:System.OperationCanceledException">
  50187. The operation was canceled via the cancellation token.
  50188. </exception>
  50189. <exception cref="T:System.IO.IOException">
  50190. An I/O error occurred.
  50191. </exception>
  50192. <exception cref="T:MailKit.ProtocolException">
  50193. The server's response contained unexpected tokens.
  50194. </exception>
  50195. <exception cref="T:MailKit.CommandException">
  50196. The command failed.
  50197. </exception>
  50198. </member>
  50199. <member name="M:MailKit.MailFolder.AddLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  50200. <summary>
  50201. Add a set of labels to the specified messages.
  50202. </summary>
  50203. <remarks>
  50204. Adds a set of labels to the specified messages.
  50205. </remarks>
  50206. <param name="uids">The UIDs of the messages.</param>
  50207. <param name="labels">The labels to add.</param>
  50208. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  50209. <param name="cancellationToken">The cancellation token.</param>
  50210. <exception cref="T:System.ArgumentNullException">
  50211. <para><paramref name="uids"/> is <c>null</c>.</para>
  50212. <para>-or-</para>
  50213. <para><paramref name="labels"/> is <c>null</c>.</para>
  50214. </exception>
  50215. <exception cref="T:System.ArgumentException">
  50216. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  50217. <para>-or-</para>
  50218. <para>No labels were specified.</para>
  50219. </exception>
  50220. <exception cref="T:System.ObjectDisposedException">
  50221. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  50222. </exception>
  50223. <exception cref="T:MailKit.ServiceNotConnectedException">
  50224. The <see cref="T:MailKit.IMailStore"/> is not connected.
  50225. </exception>
  50226. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  50227. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  50228. </exception>
  50229. <exception cref="T:MailKit.FolderNotOpenException">
  50230. The folder is not currently open in read-write mode.
  50231. </exception>
  50232. <exception cref="T:System.OperationCanceledException">
  50233. The operation was canceled via the cancellation token.
  50234. </exception>
  50235. <exception cref="T:System.IO.IOException">
  50236. An I/O error occurred.
  50237. </exception>
  50238. <exception cref="T:MailKit.ProtocolException">
  50239. The server's response contained unexpected tokens.
  50240. </exception>
  50241. <exception cref="T:MailKit.CommandException">
  50242. The command failed.
  50243. </exception>
  50244. </member>
  50245. <member name="M:MailKit.MailFolder.AddLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  50246. <summary>
  50247. Asynchronously add a set of labels to the specified messages.
  50248. </summary>
  50249. <remarks>
  50250. Asynchronously adds a set of labels to the specified messages.
  50251. </remarks>
  50252. <returns>An asynchronous task context.</returns>
  50253. <param name="uids">The UIDs of the messages.</param>
  50254. <param name="labels">The labels to add.</param>
  50255. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  50256. <param name="cancellationToken">The cancellation token.</param>
  50257. <exception cref="T:System.ArgumentNullException">
  50258. <para><paramref name="uids"/> is <c>null</c>.</para>
  50259. <para>-or-</para>
  50260. <para><paramref name="labels"/> is <c>null</c>.</para>
  50261. </exception>
  50262. <exception cref="T:System.ArgumentException">
  50263. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  50264. <para>-or-</para>
  50265. <para>No labels were specified.</para>
  50266. </exception>
  50267. <exception cref="T:System.ObjectDisposedException">
  50268. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  50269. </exception>
  50270. <exception cref="T:MailKit.ServiceNotConnectedException">
  50271. The <see cref="T:MailKit.IMailStore"/> is not connected.
  50272. </exception>
  50273. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  50274. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  50275. </exception>
  50276. <exception cref="T:MailKit.FolderNotOpenException">
  50277. The folder is not currently open in read-write mode.
  50278. </exception>
  50279. <exception cref="T:System.OperationCanceledException">
  50280. The operation was canceled via the cancellation token.
  50281. </exception>
  50282. <exception cref="T:System.IO.IOException">
  50283. An I/O error occurred.
  50284. </exception>
  50285. <exception cref="T:MailKit.ProtocolException">
  50286. The server's response contained unexpected tokens.
  50287. </exception>
  50288. <exception cref="T:MailKit.CommandException">
  50289. The command failed.
  50290. </exception>
  50291. </member>
  50292. <member name="M:MailKit.MailFolder.RemoveLabels(MailKit.UniqueId,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  50293. <summary>
  50294. Remove a set of labels from the specified message.
  50295. </summary>
  50296. <remarks>
  50297. Removes a set of labels from the specified message.
  50298. </remarks>
  50299. <param name="uid">The UIDs of the message.</param>
  50300. <param name="labels">The labels to remove.</param>
  50301. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  50302. <param name="cancellationToken">The cancellation token.</param>
  50303. <exception cref="T:System.ArgumentNullException">
  50304. <paramref name="labels"/> is <c>null</c>.
  50305. </exception>
  50306. <exception cref="T:System.ArgumentException">
  50307. <para><paramref name="uid"/> is invalid.</para>
  50308. <para>-or-</para>
  50309. <para>No labels were specified.</para>
  50310. </exception>
  50311. <exception cref="T:System.ObjectDisposedException">
  50312. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  50313. </exception>
  50314. <exception cref="T:MailKit.ServiceNotConnectedException">
  50315. The <see cref="T:MailKit.IMailStore"/> is not connected.
  50316. </exception>
  50317. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  50318. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  50319. </exception>
  50320. <exception cref="T:MailKit.FolderNotOpenException">
  50321. The folder is not currently open in read-write mode.
  50322. </exception>
  50323. <exception cref="T:System.OperationCanceledException">
  50324. The operation was canceled via the cancellation token.
  50325. </exception>
  50326. <exception cref="T:System.IO.IOException">
  50327. An I/O error occurred.
  50328. </exception>
  50329. <exception cref="T:MailKit.ProtocolException">
  50330. The server's response contained unexpected tokens.
  50331. </exception>
  50332. <exception cref="T:MailKit.CommandException">
  50333. The command failed.
  50334. </exception>
  50335. </member>
  50336. <member name="M:MailKit.MailFolder.RemoveLabelsAsync(MailKit.UniqueId,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  50337. <summary>
  50338. Asynchronously remove a set of labels from the specified message.
  50339. </summary>
  50340. <remarks>
  50341. Asynchronously removes a set of labels from the specified message.
  50342. </remarks>
  50343. <returns>An asynchronous task context.</returns>
  50344. <param name="uid">The UID of the message.</param>
  50345. <param name="labels">The labels to remove.</param>
  50346. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  50347. <param name="cancellationToken">The cancellation token.</param>
  50348. <exception cref="T:System.ArgumentNullException">
  50349. <paramref name="labels"/> is <c>null</c>.
  50350. </exception>
  50351. <exception cref="T:System.ArgumentException">
  50352. <para><paramref name="uid"/> is invalid.</para>
  50353. <para>-or-</para>
  50354. <para>No labels were specified.</para>
  50355. </exception>
  50356. <exception cref="T:System.ObjectDisposedException">
  50357. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  50358. </exception>
  50359. <exception cref="T:MailKit.ServiceNotConnectedException">
  50360. The <see cref="T:MailKit.IMailStore"/> is not connected.
  50361. </exception>
  50362. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  50363. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  50364. </exception>
  50365. <exception cref="T:MailKit.FolderNotOpenException">
  50366. The folder is not currently open in read-write mode.
  50367. </exception>
  50368. <exception cref="T:System.OperationCanceledException">
  50369. The operation was canceled via the cancellation token.
  50370. </exception>
  50371. <exception cref="T:System.IO.IOException">
  50372. An I/O error occurred.
  50373. </exception>
  50374. <exception cref="T:MailKit.ProtocolException">
  50375. The server's response contained unexpected tokens.
  50376. </exception>
  50377. <exception cref="T:MailKit.CommandException">
  50378. The command failed.
  50379. </exception>
  50380. </member>
  50381. <member name="M:MailKit.MailFolder.RemoveLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  50382. <summary>
  50383. Remove a set of labels from the specified messages.
  50384. </summary>
  50385. <remarks>
  50386. Removes a set of labels from the specified messages.
  50387. </remarks>
  50388. <param name="uids">The UIDs of the messages.</param>
  50389. <param name="labels">The labels to remove.</param>
  50390. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  50391. <param name="cancellationToken">The cancellation token.</param>
  50392. <exception cref="T:System.ArgumentNullException">
  50393. <para><paramref name="uids"/> is <c>null</c>.</para>
  50394. <para>-or-</para>
  50395. <para><paramref name="labels"/> is <c>null</c>.</para>
  50396. </exception>
  50397. <exception cref="T:System.ArgumentException">
  50398. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  50399. <para>-or-</para>
  50400. <para>No labels were specified.</para>
  50401. </exception>
  50402. <exception cref="T:System.ObjectDisposedException">
  50403. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  50404. </exception>
  50405. <exception cref="T:MailKit.ServiceNotConnectedException">
  50406. The <see cref="T:MailKit.IMailStore"/> is not connected.
  50407. </exception>
  50408. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  50409. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  50410. </exception>
  50411. <exception cref="T:MailKit.FolderNotOpenException">
  50412. The folder is not currently open in read-write mode.
  50413. </exception>
  50414. <exception cref="T:System.OperationCanceledException">
  50415. The operation was canceled via the cancellation token.
  50416. </exception>
  50417. <exception cref="T:System.IO.IOException">
  50418. An I/O error occurred.
  50419. </exception>
  50420. <exception cref="T:MailKit.ProtocolException">
  50421. The server's response contained unexpected tokens.
  50422. </exception>
  50423. <exception cref="T:MailKit.CommandException">
  50424. The command failed.
  50425. </exception>
  50426. </member>
  50427. <member name="M:MailKit.MailFolder.RemoveLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  50428. <summary>
  50429. Asynchronously remove a set of labels from the specified messages.
  50430. </summary>
  50431. <remarks>
  50432. Asynchronously removes a set of labels from the specified messages.
  50433. </remarks>
  50434. <returns>An asynchronous task context.</returns>
  50435. <param name="uids">The UIDs of the messages.</param>
  50436. <param name="labels">The labels to remove.</param>
  50437. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  50438. <param name="cancellationToken">The cancellation token.</param>
  50439. <exception cref="T:System.ArgumentNullException">
  50440. <para><paramref name="uids"/> is <c>null</c>.</para>
  50441. <para>-or-</para>
  50442. <para><paramref name="labels"/> is <c>null</c>.</para>
  50443. </exception>
  50444. <exception cref="T:System.ArgumentException">
  50445. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  50446. <para>-or-</para>
  50447. <para>No labels were specified.</para>
  50448. </exception>
  50449. <exception cref="T:System.ObjectDisposedException">
  50450. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  50451. </exception>
  50452. <exception cref="T:MailKit.ServiceNotConnectedException">
  50453. The <see cref="T:MailKit.IMailStore"/> is not connected.
  50454. </exception>
  50455. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  50456. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  50457. </exception>
  50458. <exception cref="T:MailKit.FolderNotOpenException">
  50459. The folder is not currently open in read-write mode.
  50460. </exception>
  50461. <exception cref="T:System.OperationCanceledException">
  50462. The operation was canceled via the cancellation token.
  50463. </exception>
  50464. <exception cref="T:System.IO.IOException">
  50465. An I/O error occurred.
  50466. </exception>
  50467. <exception cref="T:MailKit.ProtocolException">
  50468. The server's response contained unexpected tokens.
  50469. </exception>
  50470. <exception cref="T:MailKit.CommandException">
  50471. The command failed.
  50472. </exception>
  50473. </member>
  50474. <member name="M:MailKit.MailFolder.SetLabels(MailKit.UniqueId,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  50475. <summary>
  50476. Set the labels of the specified message.
  50477. </summary>
  50478. <remarks>
  50479. Sets the labels of the specified message.
  50480. </remarks>
  50481. <param name="uid">The UIDs of the message.</param>
  50482. <param name="labels">The labels to set.</param>
  50483. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  50484. <param name="cancellationToken">The cancellation token.</param>
  50485. <exception cref="T:System.ArgumentNullException">
  50486. <paramref name="labels"/> is <c>null</c>.
  50487. </exception>
  50488. <exception cref="T:System.ArgumentException">
  50489. <paramref name="uid"/> is invalid.
  50490. </exception>
  50491. <exception cref="T:System.ObjectDisposedException">
  50492. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  50493. </exception>
  50494. <exception cref="T:MailKit.ServiceNotConnectedException">
  50495. The <see cref="T:MailKit.IMailStore"/> is not connected.
  50496. </exception>
  50497. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  50498. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  50499. </exception>
  50500. <exception cref="T:MailKit.FolderNotOpenException">
  50501. The folder is not currently open in read-write mode.
  50502. </exception>
  50503. <exception cref="T:System.OperationCanceledException">
  50504. The operation was canceled via the cancellation token.
  50505. </exception>
  50506. <exception cref="T:System.IO.IOException">
  50507. An I/O error occurred.
  50508. </exception>
  50509. <exception cref="T:MailKit.ProtocolException">
  50510. The server's response contained unexpected tokens.
  50511. </exception>
  50512. <exception cref="T:MailKit.CommandException">
  50513. The command failed.
  50514. </exception>
  50515. </member>
  50516. <member name="M:MailKit.MailFolder.SetLabelsAsync(MailKit.UniqueId,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  50517. <summary>
  50518. Asynchronously set the labels of the specified message.
  50519. </summary>
  50520. <remarks>
  50521. Asynchronously sets the labels of the specified message.
  50522. </remarks>
  50523. <returns>An asynchronous task context.</returns>
  50524. <param name="uid">The UID of the message.</param>
  50525. <param name="labels">The labels to set.</param>
  50526. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  50527. <param name="cancellationToken">The cancellation token.</param>
  50528. <exception cref="T:System.ArgumentNullException">
  50529. <paramref name="labels"/> is <c>null</c>.
  50530. </exception>
  50531. <exception cref="T:System.ArgumentException">
  50532. <paramref name="uid"/> is invalid.
  50533. </exception>
  50534. <exception cref="T:System.ObjectDisposedException">
  50535. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  50536. </exception>
  50537. <exception cref="T:MailKit.ServiceNotConnectedException">
  50538. The <see cref="T:MailKit.IMailStore"/> is not connected.
  50539. </exception>
  50540. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  50541. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  50542. </exception>
  50543. <exception cref="T:MailKit.FolderNotOpenException">
  50544. The folder is not currently open in read-write mode.
  50545. </exception>
  50546. <exception cref="T:System.OperationCanceledException">
  50547. The operation was canceled via the cancellation token.
  50548. </exception>
  50549. <exception cref="T:System.IO.IOException">
  50550. An I/O error occurred.
  50551. </exception>
  50552. <exception cref="T:MailKit.ProtocolException">
  50553. The server's response contained unexpected tokens.
  50554. </exception>
  50555. <exception cref="T:MailKit.CommandException">
  50556. The command failed.
  50557. </exception>
  50558. </member>
  50559. <member name="M:MailKit.MailFolder.SetLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  50560. <summary>
  50561. Set the labels of the specified messages.
  50562. </summary>
  50563. <remarks>
  50564. Sets the labels of the specified messages.
  50565. </remarks>
  50566. <param name="uids">The UIDs of the messages.</param>
  50567. <param name="labels">The labels to set.</param>
  50568. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  50569. <param name="cancellationToken">The cancellation token.</param>
  50570. <exception cref="T:System.ArgumentNullException">
  50571. <para><paramref name="uids"/> is <c>null</c>.</para>
  50572. <para>-or-</para>
  50573. <para><paramref name="labels"/> is <c>null</c>.</para>
  50574. </exception>
  50575. <exception cref="T:System.ArgumentException">
  50576. One or more of the <paramref name="uids"/> is invalid.
  50577. </exception>
  50578. <exception cref="T:System.ObjectDisposedException">
  50579. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  50580. </exception>
  50581. <exception cref="T:MailKit.ServiceNotConnectedException">
  50582. The <see cref="T:MailKit.IMailStore"/> is not connected.
  50583. </exception>
  50584. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  50585. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  50586. </exception>
  50587. <exception cref="T:MailKit.FolderNotOpenException">
  50588. The folder is not currently open in read-write mode.
  50589. </exception>
  50590. <exception cref="T:System.OperationCanceledException">
  50591. The operation was canceled via the cancellation token.
  50592. </exception>
  50593. <exception cref="T:System.IO.IOException">
  50594. An I/O error occurred.
  50595. </exception>
  50596. <exception cref="T:MailKit.ProtocolException">
  50597. The server's response contained unexpected tokens.
  50598. </exception>
  50599. <exception cref="T:MailKit.CommandException">
  50600. The command failed.
  50601. </exception>
  50602. </member>
  50603. <member name="M:MailKit.MailFolder.SetLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  50604. <summary>
  50605. Asynchronously set the labels of the specified messages.
  50606. </summary>
  50607. <remarks>
  50608. Asynchronously sets the labels of the specified messages.
  50609. </remarks>
  50610. <returns>An asynchronous task context.</returns>
  50611. <param name="uids">The UIDs of the messages.</param>
  50612. <param name="labels">The labels to set.</param>
  50613. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  50614. <param name="cancellationToken">The cancellation token.</param>
  50615. <exception cref="T:System.ArgumentNullException">
  50616. <para><paramref name="uids"/> is <c>null</c>.</para>
  50617. <para>-or-</para>
  50618. <para><paramref name="labels"/> is <c>null</c>.</para>
  50619. </exception>
  50620. <exception cref="T:System.ArgumentException">
  50621. One or more of the <paramref name="uids"/> is invalid.
  50622. </exception>
  50623. <exception cref="T:System.ObjectDisposedException">
  50624. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  50625. </exception>
  50626. <exception cref="T:MailKit.ServiceNotConnectedException">
  50627. The <see cref="T:MailKit.IMailStore"/> is not connected.
  50628. </exception>
  50629. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  50630. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  50631. </exception>
  50632. <exception cref="T:MailKit.FolderNotOpenException">
  50633. The folder is not currently open in read-write mode.
  50634. </exception>
  50635. <exception cref="T:System.OperationCanceledException">
  50636. The operation was canceled via the cancellation token.
  50637. </exception>
  50638. <exception cref="T:System.IO.IOException">
  50639. An I/O error occurred.
  50640. </exception>
  50641. <exception cref="T:MailKit.ProtocolException">
  50642. The server's response contained unexpected tokens.
  50643. </exception>
  50644. <exception cref="T:MailKit.CommandException">
  50645. The command failed.
  50646. </exception>
  50647. </member>
  50648. <member name="M:MailKit.MailFolder.AddLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  50649. <summary>
  50650. Add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
  50651. </summary>
  50652. <remarks>
  50653. Adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
  50654. </remarks>
  50655. <returns>The unique IDs of the messages that were not updated.</returns>
  50656. <param name="uids">The UIDs of the messages.</param>
  50657. <param name="modseq">The mod-sequence value.</param>
  50658. <param name="labels">The labels to add.</param>
  50659. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  50660. <param name="cancellationToken">The cancellation token.</param>
  50661. <exception cref="T:System.ArgumentNullException">
  50662. <para><paramref name="uids"/> is <c>null</c>.</para>
  50663. <para>-or-</para>
  50664. <para><paramref name="labels"/> is <c>null</c>.</para>
  50665. </exception>
  50666. <exception cref="T:System.ArgumentException">
  50667. One or more of the <paramref name="uids"/> is invalid.
  50668. <para>-or-</para>
  50669. <para>No labels were specified.</para>
  50670. </exception>
  50671. <exception cref="T:System.ObjectDisposedException">
  50672. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  50673. </exception>
  50674. <exception cref="T:MailKit.ServiceNotConnectedException">
  50675. The <see cref="T:MailKit.IMailStore"/> is not connected.
  50676. </exception>
  50677. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  50678. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  50679. </exception>
  50680. <exception cref="T:MailKit.FolderNotOpenException">
  50681. The folder is not currently open in read-write mode.
  50682. </exception>
  50683. <exception cref="T:System.NotSupportedException">
  50684. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  50685. </exception>
  50686. <exception cref="T:System.OperationCanceledException">
  50687. The operation was canceled via the cancellation token.
  50688. </exception>
  50689. <exception cref="T:System.IO.IOException">
  50690. An I/O error occurred.
  50691. </exception>
  50692. <exception cref="T:MailKit.ProtocolException">
  50693. The server's response contained unexpected tokens.
  50694. </exception>
  50695. <exception cref="T:MailKit.CommandException">
  50696. The command failed.
  50697. </exception>
  50698. </member>
  50699. <member name="M:MailKit.MailFolder.AddLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  50700. <summary>
  50701. Asynchronously add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
  50702. </summary>
  50703. <remarks>
  50704. Asynchronously adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
  50705. </remarks>
  50706. <returns>The unique IDs of the messages that were not updated.</returns>
  50707. <param name="uids">The UIDs of the messages.</param>
  50708. <param name="modseq">The mod-sequence value.</param>
  50709. <param name="labels">The labels to add.</param>
  50710. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  50711. <param name="cancellationToken">The cancellation token.</param>
  50712. <exception cref="T:System.ArgumentNullException">
  50713. <para><paramref name="uids"/> is <c>null</c>.</para>
  50714. <para>-or-</para>
  50715. <para><paramref name="labels"/> is <c>null</c>.</para>
  50716. </exception>
  50717. <exception cref="T:System.ArgumentException">
  50718. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  50719. <para>-or-</para>
  50720. <para>No labels were specified.</para>
  50721. </exception>
  50722. <exception cref="T:System.ObjectDisposedException">
  50723. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  50724. </exception>
  50725. <exception cref="T:MailKit.ServiceNotConnectedException">
  50726. The <see cref="T:MailKit.IMailStore"/> is not connected.
  50727. </exception>
  50728. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  50729. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  50730. </exception>
  50731. <exception cref="T:MailKit.FolderNotOpenException">
  50732. The folder is not currently open in read-write mode.
  50733. </exception>
  50734. <exception cref="T:System.NotSupportedException">
  50735. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  50736. </exception>
  50737. <exception cref="T:System.OperationCanceledException">
  50738. The operation was canceled via the cancellation token.
  50739. </exception>
  50740. <exception cref="T:System.IO.IOException">
  50741. An I/O error occurred.
  50742. </exception>
  50743. <exception cref="T:MailKit.ProtocolException">
  50744. The server's response contained unexpected tokens.
  50745. </exception>
  50746. <exception cref="T:MailKit.CommandException">
  50747. The command failed.
  50748. </exception>
  50749. </member>
  50750. <member name="M:MailKit.MailFolder.RemoveLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  50751. <summary>
  50752. Remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
  50753. </summary>
  50754. <remarks>
  50755. Removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
  50756. </remarks>
  50757. <returns>The unique IDs of the messages that were not updated.</returns>
  50758. <param name="uids">The UIDs of the messages.</param>
  50759. <param name="modseq">The mod-sequence value.</param>
  50760. <param name="labels">The labels to remove.</param>
  50761. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  50762. <param name="cancellationToken">The cancellation token.</param>
  50763. <exception cref="T:System.ArgumentNullException">
  50764. <para><paramref name="uids"/> is <c>null</c>.</para>
  50765. <para>-or-</para>
  50766. <para><paramref name="labels"/> is <c>null</c>.</para>
  50767. </exception>
  50768. <exception cref="T:System.ArgumentException">
  50769. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  50770. <para>-or-</para>
  50771. <para>No labels were specified.</para>
  50772. </exception>
  50773. <exception cref="T:System.ObjectDisposedException">
  50774. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  50775. </exception>
  50776. <exception cref="T:MailKit.ServiceNotConnectedException">
  50777. The <see cref="T:MailKit.IMailStore"/> is not connected.
  50778. </exception>
  50779. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  50780. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  50781. </exception>
  50782. <exception cref="T:MailKit.FolderNotOpenException">
  50783. The folder is not currently open in read-write mode.
  50784. </exception>
  50785. <exception cref="T:System.NotSupportedException">
  50786. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  50787. </exception>
  50788. <exception cref="T:System.OperationCanceledException">
  50789. The operation was canceled via the cancellation token.
  50790. </exception>
  50791. <exception cref="T:System.IO.IOException">
  50792. An I/O error occurred.
  50793. </exception>
  50794. <exception cref="T:MailKit.ProtocolException">
  50795. The server's response contained unexpected tokens.
  50796. </exception>
  50797. <exception cref="T:MailKit.CommandException">
  50798. The command failed.
  50799. </exception>
  50800. </member>
  50801. <member name="M:MailKit.MailFolder.RemoveLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  50802. <summary>
  50803. Asynchronously remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
  50804. </summary>
  50805. <remarks>
  50806. Asynchronously removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
  50807. </remarks>
  50808. <returns>The unique IDs of the messages that were not updated.</returns>
  50809. <param name="uids">The UIDs of the messages.</param>
  50810. <param name="modseq">The mod-sequence value.</param>
  50811. <param name="labels">The labels to remove.</param>
  50812. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  50813. <param name="cancellationToken">The cancellation token.</param>
  50814. <exception cref="T:System.ArgumentNullException">
  50815. <para><paramref name="uids"/> is <c>null</c>.</para>
  50816. <para>-or-</para>
  50817. <para><paramref name="labels"/> is <c>null</c>.</para>
  50818. </exception>
  50819. <exception cref="T:System.ArgumentException">
  50820. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  50821. <para>-or-</para>
  50822. <para>No labels were specified.</para>
  50823. </exception>
  50824. <exception cref="T:System.ObjectDisposedException">
  50825. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  50826. </exception>
  50827. <exception cref="T:MailKit.ServiceNotConnectedException">
  50828. The <see cref="T:MailKit.IMailStore"/> is not connected.
  50829. </exception>
  50830. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  50831. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  50832. </exception>
  50833. <exception cref="T:MailKit.FolderNotOpenException">
  50834. The folder is not currently open in read-write mode.
  50835. </exception>
  50836. <exception cref="T:System.NotSupportedException">
  50837. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  50838. </exception>
  50839. <exception cref="T:System.OperationCanceledException">
  50840. The operation was canceled via the cancellation token.
  50841. </exception>
  50842. <exception cref="T:System.IO.IOException">
  50843. An I/O error occurred.
  50844. </exception>
  50845. <exception cref="T:MailKit.ProtocolException">
  50846. The server's response contained unexpected tokens.
  50847. </exception>
  50848. <exception cref="T:MailKit.CommandException">
  50849. The command failed.
  50850. </exception>
  50851. </member>
  50852. <member name="M:MailKit.MailFolder.SetLabels(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  50853. <summary>
  50854. Set the labels of the specified messages only if their mod-sequence value is less than the specified value.
  50855. </summary>
  50856. <remarks>
  50857. Sets the labels of the specified messages only if their mod-sequence value is less than the specified value.
  50858. </remarks>
  50859. <returns>The unique IDs of the messages that were not updated.</returns>
  50860. <param name="uids">The UIDs of the messages.</param>
  50861. <param name="modseq">The mod-sequence value.</param>
  50862. <param name="labels">The labels to set.</param>
  50863. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  50864. <param name="cancellationToken">The cancellation token.</param>
  50865. <exception cref="T:System.ArgumentNullException">
  50866. <para><paramref name="uids"/> is <c>null</c>.</para>
  50867. <para>-or-</para>
  50868. <para><paramref name="labels"/> is <c>null</c>.</para>
  50869. </exception>
  50870. <exception cref="T:System.ArgumentException">
  50871. One or more of the <paramref name="uids"/> is invalid.
  50872. </exception>
  50873. <exception cref="T:System.ObjectDisposedException">
  50874. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  50875. </exception>
  50876. <exception cref="T:MailKit.ServiceNotConnectedException">
  50877. The <see cref="T:MailKit.IMailStore"/> is not connected.
  50878. </exception>
  50879. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  50880. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  50881. </exception>
  50882. <exception cref="T:MailKit.FolderNotOpenException">
  50883. The folder is not currently open in read-write mode.
  50884. </exception>
  50885. <exception cref="T:System.NotSupportedException">
  50886. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  50887. </exception>
  50888. <exception cref="T:System.OperationCanceledException">
  50889. The operation was canceled via the cancellation token.
  50890. </exception>
  50891. <exception cref="T:System.IO.IOException">
  50892. An I/O error occurred.
  50893. </exception>
  50894. <exception cref="T:MailKit.ProtocolException">
  50895. The server's response contained unexpected tokens.
  50896. </exception>
  50897. <exception cref="T:MailKit.CommandException">
  50898. The command failed.
  50899. </exception>
  50900. </member>
  50901. <member name="M:MailKit.MailFolder.SetLabelsAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  50902. <summary>
  50903. Asynchronously set the labels of the specified messages only if their mod-sequence value is less than the specified value.
  50904. </summary>
  50905. <remarks>
  50906. Asynchronously sets the labels of the specified messages only if their mod-sequence value is less than the specified value.
  50907. </remarks>
  50908. <returns>The unique IDs of the messages that were not updated.</returns>
  50909. <param name="uids">The UIDs of the messages.</param>
  50910. <param name="modseq">The mod-sequence value.</param>
  50911. <param name="labels">The labels to set.</param>
  50912. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  50913. <param name="cancellationToken">The cancellation token.</param>
  50914. <exception cref="T:System.ArgumentNullException">
  50915. <para><paramref name="uids"/> is <c>null</c>.</para>
  50916. <para>-or-</para>
  50917. <para><paramref name="labels"/> is <c>null</c>.</para>
  50918. </exception>
  50919. <exception cref="T:System.ArgumentException">
  50920. One or more of the <paramref name="uids"/> is invalid.
  50921. </exception>
  50922. <exception cref="T:System.ObjectDisposedException">
  50923. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  50924. </exception>
  50925. <exception cref="T:MailKit.ServiceNotConnectedException">
  50926. The <see cref="T:MailKit.IMailStore"/> is not connected.
  50927. </exception>
  50928. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  50929. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  50930. </exception>
  50931. <exception cref="T:MailKit.FolderNotOpenException">
  50932. The folder is not currently open in read-write mode.
  50933. </exception>
  50934. <exception cref="T:System.NotSupportedException">
  50935. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  50936. </exception>
  50937. <exception cref="T:System.OperationCanceledException">
  50938. The operation was canceled via the cancellation token.
  50939. </exception>
  50940. <exception cref="T:System.IO.IOException">
  50941. An I/O error occurred.
  50942. </exception>
  50943. <exception cref="T:MailKit.ProtocolException">
  50944. The server's response contained unexpected tokens.
  50945. </exception>
  50946. <exception cref="T:MailKit.CommandException">
  50947. The command failed.
  50948. </exception>
  50949. </member>
  50950. <member name="M:MailKit.MailFolder.AddLabels(System.Int32,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  50951. <summary>
  50952. Add a set of labels to the specified message.
  50953. </summary>
  50954. <remarks>
  50955. Adds a set of labels to the specified message.
  50956. </remarks>
  50957. <param name="index">The index of the message.</param>
  50958. <param name="labels">The labels to add.</param>
  50959. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  50960. <param name="cancellationToken">The cancellation token.</param>
  50961. <exception cref="T:System.ArgumentNullException">
  50962. <paramref name="labels"/> is <c>null</c>.
  50963. </exception>
  50964. <exception cref="T:System.ArgumentException">
  50965. <para><paramref name="index"/> is invalid.</para>
  50966. <para>-or-</para>
  50967. <para>No labels were specified.</para>
  50968. </exception>
  50969. <exception cref="T:System.ObjectDisposedException">
  50970. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  50971. </exception>
  50972. <exception cref="T:MailKit.ServiceNotConnectedException">
  50973. The <see cref="T:MailKit.IMailStore"/> is not connected.
  50974. </exception>
  50975. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  50976. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  50977. </exception>
  50978. <exception cref="T:MailKit.FolderNotOpenException">
  50979. The folder is not currently open in read-write mode.
  50980. </exception>
  50981. <exception cref="T:System.OperationCanceledException">
  50982. The operation was canceled via the cancellation token.
  50983. </exception>
  50984. <exception cref="T:System.IO.IOException">
  50985. An I/O error occurred.
  50986. </exception>
  50987. <exception cref="T:MailKit.ProtocolException">
  50988. The server's response contained unexpected tokens.
  50989. </exception>
  50990. <exception cref="T:MailKit.CommandException">
  50991. The command failed.
  50992. </exception>
  50993. </member>
  50994. <member name="M:MailKit.MailFolder.AddLabelsAsync(System.Int32,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  50995. <summary>
  50996. Asynchronously add a set of labels to the specified message.
  50997. </summary>
  50998. <remarks>
  50999. Asynchronously adds a set of labels to the specified message.
  51000. </remarks>
  51001. <returns>An asynchronous task context.</returns>
  51002. <param name="index">The index of the messages.</param>
  51003. <param name="labels">The labels to add.</param>
  51004. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  51005. <param name="cancellationToken">The cancellation token.</param>
  51006. <exception cref="T:System.ArgumentNullException">
  51007. <paramref name="labels"/> is <c>null</c>.
  51008. </exception>
  51009. <exception cref="T:System.ArgumentException">
  51010. <para><paramref name="index"/> is invalid.</para>
  51011. <para>-or-</para>
  51012. <para>No labels were specified.</para>
  51013. </exception>
  51014. <exception cref="T:System.ObjectDisposedException">
  51015. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  51016. </exception>
  51017. <exception cref="T:MailKit.ServiceNotConnectedException">
  51018. The <see cref="T:MailKit.IMailStore"/> is not connected.
  51019. </exception>
  51020. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  51021. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  51022. </exception>
  51023. <exception cref="T:MailKit.FolderNotOpenException">
  51024. The folder is not currently open in read-write mode.
  51025. </exception>
  51026. <exception cref="T:System.OperationCanceledException">
  51027. The operation was canceled via the cancellation token.
  51028. </exception>
  51029. <exception cref="T:System.IO.IOException">
  51030. An I/O error occurred.
  51031. </exception>
  51032. <exception cref="T:MailKit.ProtocolException">
  51033. The server's response contained unexpected tokens.
  51034. </exception>
  51035. <exception cref="T:MailKit.CommandException">
  51036. The command failed.
  51037. </exception>
  51038. </member>
  51039. <member name="M:MailKit.MailFolder.AddLabels(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  51040. <summary>
  51041. Add a set of labels to the specified messages.
  51042. </summary>
  51043. <remarks>
  51044. Adds a set of labels to the specified messages.
  51045. </remarks>
  51046. <param name="indexes">The indexes of the messages.</param>
  51047. <param name="labels">The labels to add.</param>
  51048. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  51049. <param name="cancellationToken">The cancellation token.</param>
  51050. <exception cref="T:System.ArgumentNullException">
  51051. <para><paramref name="indexes"/> is <c>null</c>.</para>
  51052. <para>-or-</para>
  51053. <para><paramref name="labels"/> is <c>null</c>.</para>
  51054. </exception>
  51055. <exception cref="T:System.ArgumentException">
  51056. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  51057. <para>-or-</para>
  51058. <para>No labels were specified.</para>
  51059. </exception>
  51060. <exception cref="T:System.ObjectDisposedException">
  51061. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  51062. </exception>
  51063. <exception cref="T:MailKit.ServiceNotConnectedException">
  51064. The <see cref="T:MailKit.IMailStore"/> is not connected.
  51065. </exception>
  51066. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  51067. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  51068. </exception>
  51069. <exception cref="T:MailKit.FolderNotOpenException">
  51070. The folder is not currently open in read-write mode.
  51071. </exception>
  51072. <exception cref="T:System.OperationCanceledException">
  51073. The operation was canceled via the cancellation token.
  51074. </exception>
  51075. <exception cref="T:System.IO.IOException">
  51076. An I/O error occurred.
  51077. </exception>
  51078. <exception cref="T:MailKit.ProtocolException">
  51079. The server's response contained unexpected tokens.
  51080. </exception>
  51081. <exception cref="T:MailKit.CommandException">
  51082. The command failed.
  51083. </exception>
  51084. </member>
  51085. <member name="M:MailKit.MailFolder.AddLabelsAsync(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  51086. <summary>
  51087. Asynchronously add a set of labels to the specified messages.
  51088. </summary>
  51089. <remarks>
  51090. Asynchronously adds a set of labels to the specified messages.
  51091. </remarks>
  51092. <returns>An asynchronous task context.</returns>
  51093. <param name="indexes">The indexes of the messages.</param>
  51094. <param name="labels">The labels to add.</param>
  51095. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  51096. <param name="cancellationToken">The cancellation token.</param>
  51097. <exception cref="T:System.ArgumentNullException">
  51098. <para><paramref name="indexes"/> is <c>null</c>.</para>
  51099. <para>-or-</para>
  51100. <para><paramref name="labels"/> is <c>null</c>.</para>
  51101. </exception>
  51102. <exception cref="T:System.ArgumentException">
  51103. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  51104. <para>-or-</para>
  51105. <para>No labels were specified.</para>
  51106. </exception>
  51107. <exception cref="T:System.ObjectDisposedException">
  51108. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  51109. </exception>
  51110. <exception cref="T:MailKit.ServiceNotConnectedException">
  51111. The <see cref="T:MailKit.IMailStore"/> is not connected.
  51112. </exception>
  51113. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  51114. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  51115. </exception>
  51116. <exception cref="T:MailKit.FolderNotOpenException">
  51117. The folder is not currently open in read-write mode.
  51118. </exception>
  51119. <exception cref="T:System.OperationCanceledException">
  51120. The operation was canceled via the cancellation token.
  51121. </exception>
  51122. <exception cref="T:System.IO.IOException">
  51123. An I/O error occurred.
  51124. </exception>
  51125. <exception cref="T:MailKit.ProtocolException">
  51126. The server's response contained unexpected tokens.
  51127. </exception>
  51128. <exception cref="T:MailKit.CommandException">
  51129. The command failed.
  51130. </exception>
  51131. </member>
  51132. <member name="M:MailKit.MailFolder.RemoveLabels(System.Int32,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  51133. <summary>
  51134. Remove a set of labels from the specified message.
  51135. </summary>
  51136. <remarks>
  51137. Removes a set of labels from the specified message.
  51138. </remarks>
  51139. <param name="index">The index of the message.</param>
  51140. <param name="labels">The labels to remove.</param>
  51141. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  51142. <param name="cancellationToken">The cancellation token.</param>
  51143. <exception cref="T:System.ArgumentNullException">
  51144. <paramref name="labels"/> is <c>null</c>.
  51145. </exception>
  51146. <exception cref="T:System.ArgumentException">
  51147. <para><paramref name="index"/> is invalid.</para>
  51148. <para>-or-</para>
  51149. <para>No labels were specified.</para>
  51150. </exception>
  51151. <exception cref="T:System.ObjectDisposedException">
  51152. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  51153. </exception>
  51154. <exception cref="T:MailKit.ServiceNotConnectedException">
  51155. The <see cref="T:MailKit.IMailStore"/> is not connected.
  51156. </exception>
  51157. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  51158. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  51159. </exception>
  51160. <exception cref="T:MailKit.FolderNotOpenException">
  51161. The folder is not currently open in read-write mode.
  51162. </exception>
  51163. <exception cref="T:System.OperationCanceledException">
  51164. The operation was canceled via the cancellation token.
  51165. </exception>
  51166. <exception cref="T:System.IO.IOException">
  51167. An I/O error occurred.
  51168. </exception>
  51169. <exception cref="T:MailKit.ProtocolException">
  51170. The server's response contained unexpected tokens.
  51171. </exception>
  51172. <exception cref="T:MailKit.CommandException">
  51173. The command failed.
  51174. </exception>
  51175. </member>
  51176. <member name="M:MailKit.MailFolder.RemoveLabelsAsync(System.Int32,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  51177. <summary>
  51178. Asynchronously remove a set of labels from the specified message.
  51179. </summary>
  51180. <remarks>
  51181. Asynchronously removes a set of labels from the specified message.
  51182. </remarks>
  51183. <returns>An asynchronous task context.</returns>
  51184. <param name="index">The index of the message.</param>
  51185. <param name="labels">The labels to remove.</param>
  51186. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  51187. <param name="cancellationToken">The cancellation token.</param>
  51188. <exception cref="T:System.ArgumentNullException">
  51189. <paramref name="labels"/> is <c>null</c>.
  51190. </exception>
  51191. <exception cref="T:System.ArgumentException">
  51192. <para><paramref name="index"/> is invalid.</para>
  51193. <para>-or-</para>
  51194. <para>No labels were specified.</para>
  51195. </exception>
  51196. <exception cref="T:System.ObjectDisposedException">
  51197. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  51198. </exception>
  51199. <exception cref="T:MailKit.ServiceNotConnectedException">
  51200. The <see cref="T:MailKit.IMailStore"/> is not connected.
  51201. </exception>
  51202. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  51203. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  51204. </exception>
  51205. <exception cref="T:MailKit.FolderNotOpenException">
  51206. The folder is not currently open in read-write mode.
  51207. </exception>
  51208. <exception cref="T:System.OperationCanceledException">
  51209. The operation was canceled via the cancellation token.
  51210. </exception>
  51211. <exception cref="T:System.IO.IOException">
  51212. An I/O error occurred.
  51213. </exception>
  51214. <exception cref="T:MailKit.ProtocolException">
  51215. The server's response contained unexpected tokens.
  51216. </exception>
  51217. <exception cref="T:MailKit.CommandException">
  51218. The command failed.
  51219. </exception>
  51220. </member>
  51221. <member name="M:MailKit.MailFolder.RemoveLabels(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  51222. <summary>
  51223. Remove a set of labels from the specified messages.
  51224. </summary>
  51225. <remarks>
  51226. Removes a set of labels from the specified messages.
  51227. </remarks>
  51228. <param name="indexes">The indexes of the messages.</param>
  51229. <param name="labels">The labels to remove.</param>
  51230. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  51231. <param name="cancellationToken">The cancellation token.</param>
  51232. <exception cref="T:System.ArgumentNullException">
  51233. <para><paramref name="indexes"/> is <c>null</c>.</para>
  51234. <para>-or-</para>
  51235. <para><paramref name="labels"/> is <c>null</c>.</para>
  51236. </exception>
  51237. <exception cref="T:System.ArgumentException">
  51238. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  51239. <para>-or-</para>
  51240. <para>No labels were specified.</para>
  51241. </exception>
  51242. <exception cref="T:System.ObjectDisposedException">
  51243. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  51244. </exception>
  51245. <exception cref="T:MailKit.ServiceNotConnectedException">
  51246. The <see cref="T:MailKit.IMailStore"/> is not connected.
  51247. </exception>
  51248. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  51249. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  51250. </exception>
  51251. <exception cref="T:MailKit.FolderNotOpenException">
  51252. The folder is not currently open in read-write mode.
  51253. </exception>
  51254. <exception cref="T:System.OperationCanceledException">
  51255. The operation was canceled via the cancellation token.
  51256. </exception>
  51257. <exception cref="T:System.IO.IOException">
  51258. An I/O error occurred.
  51259. </exception>
  51260. <exception cref="T:MailKit.ProtocolException">
  51261. The server's response contained unexpected tokens.
  51262. </exception>
  51263. <exception cref="T:MailKit.CommandException">
  51264. The command failed.
  51265. </exception>
  51266. </member>
  51267. <member name="M:MailKit.MailFolder.RemoveLabelsAsync(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  51268. <summary>
  51269. Asynchronously remove a set of labels from the specified messages.
  51270. </summary>
  51271. <remarks>
  51272. Asynchronously removes a set of labels from the specified messages.
  51273. </remarks>
  51274. <returns>An asynchronous task context.</returns>
  51275. <param name="indexes">The indexes of the messages.</param>
  51276. <param name="labels">The labels to remove.</param>
  51277. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  51278. <param name="cancellationToken">The cancellation token.</param>
  51279. <exception cref="T:System.ArgumentNullException">
  51280. <para><paramref name="indexes"/> is <c>null</c>.</para>
  51281. <para>-or-</para>
  51282. <para><paramref name="labels"/> is <c>null</c>.</para>
  51283. </exception>
  51284. <exception cref="T:System.ArgumentException">
  51285. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  51286. <para>-or-</para>
  51287. <para>No labels were specified.</para>
  51288. </exception>
  51289. <exception cref="T:System.ObjectDisposedException">
  51290. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  51291. </exception>
  51292. <exception cref="T:MailKit.ServiceNotConnectedException">
  51293. The <see cref="T:MailKit.IMailStore"/> is not connected.
  51294. </exception>
  51295. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  51296. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  51297. </exception>
  51298. <exception cref="T:MailKit.FolderNotOpenException">
  51299. The folder is not currently open in read-write mode.
  51300. </exception>
  51301. <exception cref="T:System.OperationCanceledException">
  51302. The operation was canceled via the cancellation token.
  51303. </exception>
  51304. <exception cref="T:System.IO.IOException">
  51305. An I/O error occurred.
  51306. </exception>
  51307. <exception cref="T:MailKit.ProtocolException">
  51308. The server's response contained unexpected tokens.
  51309. </exception>
  51310. <exception cref="T:MailKit.CommandException">
  51311. The command failed.
  51312. </exception>
  51313. </member>
  51314. <member name="M:MailKit.MailFolder.SetLabels(System.Int32,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  51315. <summary>
  51316. Set the labels of the specified message.
  51317. </summary>
  51318. <remarks>
  51319. Sets the labels of the specified message.
  51320. </remarks>
  51321. <param name="index">The index of the message.</param>
  51322. <param name="labels">The labels to set.</param>
  51323. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  51324. <param name="cancellationToken">The cancellation token.</param>
  51325. <exception cref="T:System.ArgumentNullException">
  51326. <paramref name="labels"/> is <c>null</c>.
  51327. </exception>
  51328. <exception cref="T:System.ArgumentException">
  51329. <para><paramref name="index"/> is invalid.</para>
  51330. </exception>
  51331. <exception cref="T:System.ObjectDisposedException">
  51332. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  51333. </exception>
  51334. <exception cref="T:MailKit.ServiceNotConnectedException">
  51335. The <see cref="T:MailKit.IMailStore"/> is not connected.
  51336. </exception>
  51337. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  51338. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  51339. </exception>
  51340. <exception cref="T:MailKit.FolderNotOpenException">
  51341. The folder is not currently open in read-write mode.
  51342. </exception>
  51343. <exception cref="T:System.OperationCanceledException">
  51344. The operation was canceled via the cancellation token.
  51345. </exception>
  51346. <exception cref="T:System.IO.IOException">
  51347. An I/O error occurred.
  51348. </exception>
  51349. <exception cref="T:MailKit.ProtocolException">
  51350. The server's response contained unexpected tokens.
  51351. </exception>
  51352. <exception cref="T:MailKit.CommandException">
  51353. The command failed.
  51354. </exception>
  51355. </member>
  51356. <member name="M:MailKit.MailFolder.SetLabelsAsync(System.Int32,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  51357. <summary>
  51358. Asynchronously set the labels of the specified message.
  51359. </summary>
  51360. <remarks>
  51361. Asynchronously sets the labels of the specified message.
  51362. </remarks>
  51363. <returns>An asynchronous task context.</returns>
  51364. <param name="index">The index of the message.</param>
  51365. <param name="labels">The labels to set.</param>
  51366. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  51367. <param name="cancellationToken">The cancellation token.</param>
  51368. <exception cref="T:System.ArgumentNullException">
  51369. <paramref name="labels"/> is <c>null</c>.
  51370. </exception>
  51371. <exception cref="T:System.ArgumentException">
  51372. <para><paramref name="index"/> is invalid.</para>
  51373. </exception>
  51374. <exception cref="T:System.ObjectDisposedException">
  51375. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  51376. </exception>
  51377. <exception cref="T:MailKit.ServiceNotConnectedException">
  51378. The <see cref="T:MailKit.IMailStore"/> is not connected.
  51379. </exception>
  51380. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  51381. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  51382. </exception>
  51383. <exception cref="T:MailKit.FolderNotOpenException">
  51384. The folder is not currently open in read-write mode.
  51385. </exception>
  51386. <exception cref="T:System.OperationCanceledException">
  51387. The operation was canceled via the cancellation token.
  51388. </exception>
  51389. <exception cref="T:System.IO.IOException">
  51390. An I/O error occurred.
  51391. </exception>
  51392. <exception cref="T:MailKit.ProtocolException">
  51393. The server's response contained unexpected tokens.
  51394. </exception>
  51395. <exception cref="T:MailKit.CommandException">
  51396. The command failed.
  51397. </exception>
  51398. </member>
  51399. <member name="M:MailKit.MailFolder.SetLabels(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  51400. <summary>
  51401. Set the labels of the specified messages.
  51402. </summary>
  51403. <remarks>
  51404. Sets the labels of the specified messages.
  51405. </remarks>
  51406. <param name="indexes">The indexes of the messages.</param>
  51407. <param name="labels">The labels to set.</param>
  51408. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  51409. <param name="cancellationToken">The cancellation token.</param>
  51410. <exception cref="T:System.ArgumentNullException">
  51411. <para><paramref name="indexes"/> is <c>null</c>.</para>
  51412. <para>-or-</para>
  51413. <para><paramref name="labels"/> is <c>null</c>.</para>
  51414. </exception>
  51415. <exception cref="T:System.ArgumentException">
  51416. One or more of the <paramref name="indexes"/> is invalid.
  51417. </exception>
  51418. <exception cref="T:System.ObjectDisposedException">
  51419. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  51420. </exception>
  51421. <exception cref="T:MailKit.ServiceNotConnectedException">
  51422. The <see cref="T:MailKit.IMailStore"/> is not connected.
  51423. </exception>
  51424. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  51425. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  51426. </exception>
  51427. <exception cref="T:MailKit.FolderNotOpenException">
  51428. The folder is not currently open in read-write mode.
  51429. </exception>
  51430. <exception cref="T:System.OperationCanceledException">
  51431. The operation was canceled via the cancellation token.
  51432. </exception>
  51433. <exception cref="T:System.IO.IOException">
  51434. An I/O error occurred.
  51435. </exception>
  51436. <exception cref="T:MailKit.ProtocolException">
  51437. The server's response contained unexpected tokens.
  51438. </exception>
  51439. <exception cref="T:MailKit.CommandException">
  51440. The command failed.
  51441. </exception>
  51442. </member>
  51443. <member name="M:MailKit.MailFolder.SetLabelsAsync(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  51444. <summary>
  51445. Asynchronously set the labels of the specified messages.
  51446. </summary>
  51447. <remarks>
  51448. Asynchronously sets the labels of the specified messages.
  51449. </remarks>
  51450. <returns>An asynchronous task context.</returns>
  51451. <param name="indexes">The indexes of the messages.</param>
  51452. <param name="labels">The labels to set.</param>
  51453. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  51454. <param name="cancellationToken">The cancellation token.</param>
  51455. <exception cref="T:System.ArgumentNullException">
  51456. <para><paramref name="indexes"/> is <c>null</c>.</para>
  51457. <para>-or-</para>
  51458. <para><paramref name="labels"/> is <c>null</c>.</para>
  51459. </exception>
  51460. <exception cref="T:System.ArgumentException">
  51461. One or more of the <paramref name="indexes"/> is invalid.
  51462. </exception>
  51463. <exception cref="T:System.ObjectDisposedException">
  51464. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  51465. </exception>
  51466. <exception cref="T:MailKit.ServiceNotConnectedException">
  51467. The <see cref="T:MailKit.IMailStore"/> is not connected.
  51468. </exception>
  51469. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  51470. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  51471. </exception>
  51472. <exception cref="T:MailKit.FolderNotOpenException">
  51473. The folder is not currently open in read-write mode.
  51474. </exception>
  51475. <exception cref="T:System.OperationCanceledException">
  51476. The operation was canceled via the cancellation token.
  51477. </exception>
  51478. <exception cref="T:System.IO.IOException">
  51479. An I/O error occurred.
  51480. </exception>
  51481. <exception cref="T:MailKit.ProtocolException">
  51482. The server's response contained unexpected tokens.
  51483. </exception>
  51484. <exception cref="T:MailKit.CommandException">
  51485. The command failed.
  51486. </exception>
  51487. </member>
  51488. <member name="M:MailKit.MailFolder.AddLabels(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  51489. <summary>
  51490. Add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
  51491. </summary>
  51492. <remarks>
  51493. Adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
  51494. </remarks>
  51495. <returns>The indexes of the messages that were not updated.</returns>
  51496. <param name="indexes">The indexes of the messages.</param>
  51497. <param name="modseq">The mod-sequence value.</param>
  51498. <param name="labels">The labels to add.</param>
  51499. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  51500. <param name="cancellationToken">The cancellation token.</param>
  51501. <exception cref="T:System.ArgumentNullException">
  51502. <para><paramref name="indexes"/> is <c>null</c>.</para>
  51503. <para>-or-</para>
  51504. <para><paramref name="labels"/> is <c>null</c>.</para>
  51505. </exception>
  51506. <exception cref="T:System.ArgumentException">
  51507. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  51508. <para>-or-</para>
  51509. <para>No labels were specified.</para>
  51510. </exception>
  51511. <exception cref="T:System.ObjectDisposedException">
  51512. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  51513. </exception>
  51514. <exception cref="T:MailKit.ServiceNotConnectedException">
  51515. The <see cref="T:MailKit.IMailStore"/> is not connected.
  51516. </exception>
  51517. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  51518. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  51519. </exception>
  51520. <exception cref="T:MailKit.FolderNotOpenException">
  51521. The folder is not currently open in read-write mode.
  51522. </exception>
  51523. <exception cref="T:System.NotSupportedException">
  51524. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  51525. </exception>
  51526. <exception cref="T:System.OperationCanceledException">
  51527. The operation was canceled via the cancellation token.
  51528. </exception>
  51529. <exception cref="T:System.IO.IOException">
  51530. An I/O error occurred.
  51531. </exception>
  51532. <exception cref="T:MailKit.ProtocolException">
  51533. The server's response contained unexpected tokens.
  51534. </exception>
  51535. <exception cref="T:MailKit.CommandException">
  51536. The command failed.
  51537. </exception>
  51538. </member>
  51539. <member name="M:MailKit.MailFolder.AddLabelsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  51540. <summary>
  51541. Asynchronously add a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
  51542. </summary>
  51543. <remarks>
  51544. Asynchronously adds a set of labels to the specified messages only if their mod-sequence value is less than the specified value.
  51545. </remarks>
  51546. <returns>The indexes of the messages that were not updated.</returns>
  51547. <param name="indexes">The indexes of the messages.</param>
  51548. <param name="modseq">The mod-sequence value.</param>
  51549. <param name="labels">The labels to add.</param>
  51550. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  51551. <param name="cancellationToken">The cancellation token.</param>
  51552. <exception cref="T:System.ArgumentNullException">
  51553. <para><paramref name="indexes"/> is <c>null</c>.</para>
  51554. <para>-or-</para>
  51555. <para><paramref name="labels"/> is <c>null</c>.</para>
  51556. </exception>
  51557. <exception cref="T:System.ArgumentException">
  51558. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  51559. <para>-or-</para>
  51560. <para>No labels were specified.</para>
  51561. </exception>
  51562. <exception cref="T:System.ObjectDisposedException">
  51563. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  51564. </exception>
  51565. <exception cref="T:MailKit.ServiceNotConnectedException">
  51566. The <see cref="T:MailKit.IMailStore"/> is not connected.
  51567. </exception>
  51568. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  51569. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  51570. </exception>
  51571. <exception cref="T:MailKit.FolderNotOpenException">
  51572. The folder is not currently open in read-write mode.
  51573. </exception>
  51574. <exception cref="T:System.NotSupportedException">
  51575. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  51576. </exception>
  51577. <exception cref="T:System.OperationCanceledException">
  51578. The operation was canceled via the cancellation token.
  51579. </exception>
  51580. <exception cref="T:System.IO.IOException">
  51581. An I/O error occurred.
  51582. </exception>
  51583. <exception cref="T:MailKit.ProtocolException">
  51584. The server's response contained unexpected tokens.
  51585. </exception>
  51586. <exception cref="T:MailKit.CommandException">
  51587. The command failed.
  51588. </exception>
  51589. </member>
  51590. <member name="M:MailKit.MailFolder.RemoveLabels(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  51591. <summary>
  51592. Remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
  51593. </summary>
  51594. <remarks>
  51595. Removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
  51596. </remarks>
  51597. <returns>The indexes of the messages that were not updated.</returns>
  51598. <param name="indexes">The indexes of the messages.</param>
  51599. <param name="modseq">The mod-sequence value.</param>
  51600. <param name="labels">The labels to remove.</param>
  51601. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  51602. <param name="cancellationToken">The cancellation token.</param>
  51603. <exception cref="T:System.ArgumentNullException">
  51604. <para><paramref name="indexes"/> is <c>null</c>.</para>
  51605. <para>-or-</para>
  51606. <para><paramref name="labels"/> is <c>null</c>.</para>
  51607. </exception>
  51608. <exception cref="T:System.ArgumentException">
  51609. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  51610. <para>-or-</para>
  51611. <para>No labels were specified.</para>
  51612. </exception>
  51613. <exception cref="T:System.ObjectDisposedException">
  51614. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  51615. </exception>
  51616. <exception cref="T:MailKit.ServiceNotConnectedException">
  51617. The <see cref="T:MailKit.IMailStore"/> is not connected.
  51618. </exception>
  51619. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  51620. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  51621. </exception>
  51622. <exception cref="T:MailKit.FolderNotOpenException">
  51623. The folder is not currently open in read-write mode.
  51624. </exception>
  51625. <exception cref="T:System.NotSupportedException">
  51626. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  51627. </exception>
  51628. <exception cref="T:System.OperationCanceledException">
  51629. The operation was canceled via the cancellation token.
  51630. </exception>
  51631. <exception cref="T:System.IO.IOException">
  51632. An I/O error occurred.
  51633. </exception>
  51634. <exception cref="T:MailKit.ProtocolException">
  51635. The server's response contained unexpected tokens.
  51636. </exception>
  51637. <exception cref="T:MailKit.CommandException">
  51638. The command failed.
  51639. </exception>
  51640. </member>
  51641. <member name="M:MailKit.MailFolder.RemoveLabelsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  51642. <summary>
  51643. Asynchronously remove a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
  51644. </summary>
  51645. <remarks>
  51646. Asynchronously removes a set of labels from the specified messages only if their mod-sequence value is less than the specified value.
  51647. </remarks>
  51648. <returns>The indexes of the messages that were not updated.</returns>
  51649. <param name="indexes">The indexes of the messages.</param>
  51650. <param name="modseq">The mod-sequence value.</param>
  51651. <param name="labels">The labels to remove.</param>
  51652. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  51653. <param name="cancellationToken">The cancellation token.</param>
  51654. <exception cref="T:System.ArgumentNullException">
  51655. <para><paramref name="indexes"/> is <c>null</c>.</para>
  51656. <para>-or-</para>
  51657. <para><paramref name="labels"/> is <c>null</c>.</para>
  51658. </exception>
  51659. <exception cref="T:System.ArgumentException">
  51660. <para>One or more of the <paramref name="indexes"/> is invalid.</para>
  51661. <para>-or-</para>
  51662. <para>No labels were specified.</para>
  51663. </exception>
  51664. <exception cref="T:System.ObjectDisposedException">
  51665. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  51666. </exception>
  51667. <exception cref="T:MailKit.ServiceNotConnectedException">
  51668. The <see cref="T:MailKit.IMailStore"/> is not connected.
  51669. </exception>
  51670. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  51671. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  51672. </exception>
  51673. <exception cref="T:MailKit.FolderNotOpenException">
  51674. The folder is not currently open in read-write mode.
  51675. </exception>
  51676. <exception cref="T:System.NotSupportedException">
  51677. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  51678. </exception>
  51679. <exception cref="T:System.OperationCanceledException">
  51680. The operation was canceled via the cancellation token.
  51681. </exception>
  51682. <exception cref="T:System.IO.IOException">
  51683. An I/O error occurred.
  51684. </exception>
  51685. <exception cref="T:MailKit.ProtocolException">
  51686. The server's response contained unexpected tokens.
  51687. </exception>
  51688. <exception cref="T:MailKit.CommandException">
  51689. The command failed.
  51690. </exception>
  51691. </member>
  51692. <member name="M:MailKit.MailFolder.SetLabels(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  51693. <summary>
  51694. Set the labels of the specified messages only if their mod-sequence value is less than the specified value.
  51695. </summary>
  51696. <remarks>
  51697. Sets the labels of the specified messages only if their mod-sequence value is less than the specified value.
  51698. </remarks>
  51699. <returns>The indexes of the messages that were not updated.</returns>
  51700. <param name="indexes">The indexes of the messages.</param>
  51701. <param name="modseq">The mod-sequence value.</param>
  51702. <param name="labels">The labels to set.</param>
  51703. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  51704. <param name="cancellationToken">The cancellation token.</param>
  51705. <exception cref="T:System.ArgumentNullException">
  51706. <para><paramref name="indexes"/> is <c>null</c>.</para>
  51707. <para>-or-</para>
  51708. <para><paramref name="labels"/> is <c>null</c>.</para>
  51709. </exception>
  51710. <exception cref="T:System.ArgumentException">
  51711. One or more of the <paramref name="indexes"/> is invalid.
  51712. </exception>
  51713. <exception cref="T:System.ObjectDisposedException">
  51714. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  51715. </exception>
  51716. <exception cref="T:MailKit.ServiceNotConnectedException">
  51717. The <see cref="T:MailKit.IMailStore"/> is not connected.
  51718. </exception>
  51719. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  51720. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  51721. </exception>
  51722. <exception cref="T:MailKit.FolderNotOpenException">
  51723. The folder is not currently open in read-write mode.
  51724. </exception>
  51725. <exception cref="T:System.NotSupportedException">
  51726. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  51727. </exception>
  51728. <exception cref="T:System.OperationCanceledException">
  51729. The operation was canceled via the cancellation token.
  51730. </exception>
  51731. <exception cref="T:System.IO.IOException">
  51732. An I/O error occurred.
  51733. </exception>
  51734. <exception cref="T:MailKit.ProtocolException">
  51735. The server's response contained unexpected tokens.
  51736. </exception>
  51737. <exception cref="T:MailKit.CommandException">
  51738. The command failed.
  51739. </exception>
  51740. </member>
  51741. <member name="M:MailKit.MailFolder.SetLabelsAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{System.String},System.Boolean,System.Threading.CancellationToken)">
  51742. <summary>
  51743. Asynchronously set the labels of the specified messages only if their mod-sequence value is less than the specified value.
  51744. </summary>
  51745. <remarks>
  51746. Asynchronously sets the labels of the specified messages only if their mod-sequence value is less than the specified value.
  51747. </remarks>
  51748. <returns>The indexes of the messages that were not updated.</returns>
  51749. <param name="indexes">The indexes of the messages.</param>
  51750. <param name="modseq">The mod-sequence value.</param>
  51751. <param name="labels">The labels to set.</param>
  51752. <param name="silent">If set to <c>true</c>, no <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> events will be emitted.</param>
  51753. <param name="cancellationToken">The cancellation token.</param>
  51754. <exception cref="T:System.ArgumentNullException">
  51755. <para><paramref name="indexes"/> is <c>null</c>.</para>
  51756. <para>-or-</para>
  51757. <para><paramref name="labels"/> is <c>null</c>.</para>
  51758. </exception>
  51759. <exception cref="T:System.ArgumentException">
  51760. One or more of the <paramref name="indexes"/> is invalid.
  51761. </exception>
  51762. <exception cref="T:System.ObjectDisposedException">
  51763. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  51764. </exception>
  51765. <exception cref="T:MailKit.ServiceNotConnectedException">
  51766. The <see cref="T:MailKit.IMailStore"/> is not connected.
  51767. </exception>
  51768. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  51769. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  51770. </exception>
  51771. <exception cref="T:MailKit.FolderNotOpenException">
  51772. The folder is not currently open in read-write mode.
  51773. </exception>
  51774. <exception cref="T:System.NotSupportedException">
  51775. The <see cref="T:MailKit.MailFolder"/> does not support mod-sequences.
  51776. </exception>
  51777. <exception cref="T:System.OperationCanceledException">
  51778. The operation was canceled via the cancellation token.
  51779. </exception>
  51780. <exception cref="T:System.IO.IOException">
  51781. An I/O error occurred.
  51782. </exception>
  51783. <exception cref="T:MailKit.ProtocolException">
  51784. The server's response contained unexpected tokens.
  51785. </exception>
  51786. <exception cref="T:MailKit.CommandException">
  51787. The command failed.
  51788. </exception>
  51789. </member>
  51790. <member name="M:MailKit.MailFolder.Store(MailKit.UniqueId,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
  51791. <summary>
  51792. Store the annotations for the specified message.
  51793. </summary>
  51794. <remarks>
  51795. Stores the annotations for the specified message.
  51796. </remarks>
  51797. <param name="uid">The UID of the message.</param>
  51798. <param name="annotations">The annotations to store.</param>
  51799. <param name="cancellationToken">The cancellation token.</param>
  51800. <exception cref="T:System.ArgumentNullException">
  51801. <paramref name="annotations"/> is <c>null</c>.
  51802. </exception>
  51803. <exception cref="T:System.ArgumentException">
  51804. <paramref name="uid"/> is invalid.
  51805. </exception>
  51806. <exception cref="T:System.ObjectDisposedException">
  51807. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  51808. </exception>
  51809. <exception cref="T:MailKit.ServiceNotConnectedException">
  51810. The <see cref="T:MailKit.IMailStore"/> is not connected.
  51811. </exception>
  51812. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  51813. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  51814. </exception>
  51815. <exception cref="T:MailKit.FolderNotOpenException">
  51816. The <see cref="T:MailKit.IMailFolder"/> is not currently open in read-write mode.
  51817. </exception>
  51818. <exception cref="T:System.InvalidOperationException">
  51819. Cannot store annotations without any properties defined.
  51820. </exception>
  51821. <exception cref="T:System.NotSupportedException">
  51822. The <see cref="T:MailKit.IMailFolder"/> does not support annotations.
  51823. </exception>
  51824. <exception cref="T:System.OperationCanceledException">
  51825. The operation was canceled via the cancellation token.
  51826. </exception>
  51827. <exception cref="T:System.IO.IOException">
  51828. An I/O error occurred.
  51829. </exception>
  51830. <exception cref="T:MailKit.ProtocolException">
  51831. The server's response contained unexpected tokens.
  51832. </exception>
  51833. <exception cref="T:MailKit.CommandException">
  51834. The command failed.
  51835. </exception>
  51836. </member>
  51837. <member name="M:MailKit.MailFolder.StoreAsync(MailKit.UniqueId,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
  51838. <summary>
  51839. Asynchronously store the annotations for the specified message.
  51840. </summary>
  51841. <remarks>
  51842. Asynchronously stores the annotations for the specified message.
  51843. </remarks>
  51844. <returns>An asynchronous task context.</returns>
  51845. <param name="uid">The UID of the message.</param>
  51846. <param name="annotations">The annotations to store.</param>
  51847. <param name="cancellationToken">The cancellation token.</param>
  51848. <exception cref="T:System.ArgumentNullException">
  51849. <paramref name="annotations"/> is <c>null</c>.
  51850. </exception>
  51851. <exception cref="T:System.ArgumentException">
  51852. <paramref name="uid"/> is invalid.
  51853. </exception>
  51854. <exception cref="T:System.ObjectDisposedException">
  51855. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  51856. </exception>
  51857. <exception cref="T:MailKit.ServiceNotConnectedException">
  51858. The <see cref="T:MailKit.IMailStore"/> is not connected.
  51859. </exception>
  51860. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  51861. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  51862. </exception>
  51863. <exception cref="T:MailKit.FolderNotOpenException">
  51864. The <see cref="T:MailKit.IMailFolder"/> is not currently open in read-write mode.
  51865. </exception>
  51866. <exception cref="T:System.InvalidOperationException">
  51867. Cannot store annotations without any properties defined.
  51868. </exception>
  51869. <exception cref="T:System.NotSupportedException">
  51870. The <see cref="T:MailKit.IMailFolder"/> does not support annotations.
  51871. </exception>
  51872. <exception cref="T:System.OperationCanceledException">
  51873. The operation was canceled via the cancellation token.
  51874. </exception>
  51875. <exception cref="T:System.IO.IOException">
  51876. An I/O error occurred.
  51877. </exception>
  51878. <exception cref="T:MailKit.ProtocolException">
  51879. The server's response contained unexpected tokens.
  51880. </exception>
  51881. <exception cref="T:MailKit.CommandException">
  51882. The command failed.
  51883. </exception>
  51884. </member>
  51885. <member name="M:MailKit.MailFolder.Store(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
  51886. <summary>
  51887. Store the annotations for the specified messages.
  51888. </summary>
  51889. <remarks>
  51890. Stores the annotations for the specified messages.
  51891. </remarks>
  51892. <param name="uids">The UIDs of the messages.</param>
  51893. <param name="annotations">The annotations to store.</param>
  51894. <param name="cancellationToken">The cancellation token.</param>
  51895. <exception cref="T:System.ArgumentNullException">
  51896. <para><paramref name="uids"/> is <c>null</c>.</para>
  51897. <para>-or-</para>
  51898. <para><paramref name="annotations"/> is <c>null</c>.</para>
  51899. </exception>
  51900. <exception cref="T:System.ArgumentException">
  51901. One or more of the <paramref name="uids"/> is invalid.
  51902. </exception>
  51903. <exception cref="T:System.ObjectDisposedException">
  51904. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  51905. </exception>
  51906. <exception cref="T:MailKit.ServiceNotConnectedException">
  51907. The <see cref="T:MailKit.IMailStore"/> is not connected.
  51908. </exception>
  51909. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  51910. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  51911. </exception>
  51912. <exception cref="T:MailKit.FolderNotOpenException">
  51913. The <see cref="T:MailKit.IMailFolder"/> is not currently open in read-write mode.
  51914. </exception>
  51915. <exception cref="T:System.InvalidOperationException">
  51916. Cannot store annotations without any properties defined.
  51917. </exception>
  51918. <exception cref="T:System.NotSupportedException">
  51919. The <see cref="T:MailKit.IMailFolder"/> does not support annotations.
  51920. </exception>
  51921. <exception cref="T:System.OperationCanceledException">
  51922. The operation was canceled via the cancellation token.
  51923. </exception>
  51924. <exception cref="T:System.IO.IOException">
  51925. An I/O error occurred.
  51926. </exception>
  51927. <exception cref="T:MailKit.ProtocolException">
  51928. The server's response contained unexpected tokens.
  51929. </exception>
  51930. <exception cref="T:MailKit.CommandException">
  51931. The command failed.
  51932. </exception>
  51933. </member>
  51934. <member name="M:MailKit.MailFolder.StoreAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
  51935. <summary>
  51936. Asynchronously store the annotations for the specified messages.
  51937. </summary>
  51938. <remarks>
  51939. Asynchronously stores the annotations for the specified messages.
  51940. </remarks>
  51941. <returns>An asynchronous task context.</returns>
  51942. <param name="uids">The UIDs of the messages.</param>
  51943. <param name="annotations">The annotations to store.</param>
  51944. <param name="cancellationToken">The cancellation token.</param>
  51945. <exception cref="T:System.ArgumentNullException">
  51946. <para><paramref name="uids"/> is <c>null</c>.</para>
  51947. <para>-or-</para>
  51948. <para><paramref name="annotations"/> is <c>null</c>.</para>
  51949. </exception>
  51950. <exception cref="T:System.ArgumentException">
  51951. One or more of the <paramref name="uids"/> is invalid.
  51952. </exception>
  51953. <exception cref="T:System.ObjectDisposedException">
  51954. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  51955. </exception>
  51956. <exception cref="T:MailKit.ServiceNotConnectedException">
  51957. The <see cref="T:MailKit.IMailStore"/> is not connected.
  51958. </exception>
  51959. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  51960. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  51961. </exception>
  51962. <exception cref="T:MailKit.FolderNotOpenException">
  51963. The <see cref="T:MailKit.IMailFolder"/> is not currently open in read-write mode.
  51964. </exception>
  51965. <exception cref="T:System.InvalidOperationException">
  51966. Cannot store annotations without any properties defined.
  51967. </exception>
  51968. <exception cref="T:System.NotSupportedException">
  51969. The <see cref="T:MailKit.IMailFolder"/> does not support annotations.
  51970. </exception>
  51971. <exception cref="T:System.OperationCanceledException">
  51972. The operation was canceled via the cancellation token.
  51973. </exception>
  51974. <exception cref="T:System.IO.IOException">
  51975. An I/O error occurred.
  51976. </exception>
  51977. <exception cref="T:MailKit.ProtocolException">
  51978. The server's response contained unexpected tokens.
  51979. </exception>
  51980. <exception cref="T:MailKit.CommandException">
  51981. The command failed.
  51982. </exception>
  51983. </member>
  51984. <member name="M:MailKit.MailFolder.Store(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
  51985. <summary>
  51986. Store the annotations for the specified messages only if their mod-sequence value is less than the specified value.
  51987. </summary>
  51988. <remarks>
  51989. Stores the annotations for the specified messages only if their mod-sequence value is less than the specified value.
  51990. </remarks>
  51991. <returns>The unique IDs of the messages that were not updated.</returns>
  51992. <param name="uids">The UIDs of the messages.</param>
  51993. <param name="modseq">The mod-sequence value.</param>
  51994. <param name="annotations">The annotations to store.</param>
  51995. <param name="cancellationToken">The cancellation token.</param>
  51996. <exception cref="T:System.ArgumentNullException">
  51997. <para><paramref name="uids"/> is <c>null</c>.</para>
  51998. <para>-or-</para>
  51999. <para><paramref name="annotations"/> is <c>null</c>.</para>
  52000. </exception>
  52001. <exception cref="T:System.ArgumentException">
  52002. One or more of the <paramref name="uids"/> is invalid.
  52003. </exception>
  52004. <exception cref="T:System.ObjectDisposedException">
  52005. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  52006. </exception>
  52007. <exception cref="T:MailKit.ServiceNotConnectedException">
  52008. The <see cref="T:MailKit.IMailStore"/> is not connected.
  52009. </exception>
  52010. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  52011. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  52012. </exception>
  52013. <exception cref="T:MailKit.FolderNotOpenException">
  52014. The <see cref="T:MailKit.IMailFolder"/> is not currently open in read-write mode.
  52015. </exception>
  52016. <exception cref="T:System.InvalidOperationException">
  52017. Cannot store annotations without any properties defined.
  52018. </exception>
  52019. <exception cref="T:System.NotSupportedException">
  52020. <para>The <see cref="T:MailKit.IMailFolder"/> does not support annotations.</para>
  52021. <para>-or-</para>
  52022. <para>The <see cref="T:MailKit.IMailFolder"/> does not support mod-sequences.</para>
  52023. </exception>
  52024. <exception cref="T:System.OperationCanceledException">
  52025. The operation was canceled via the cancellation token.
  52026. </exception>
  52027. <exception cref="T:System.IO.IOException">
  52028. An I/O error occurred.
  52029. </exception>
  52030. <exception cref="T:MailKit.ProtocolException">
  52031. The server's response contained unexpected tokens.
  52032. </exception>
  52033. <exception cref="T:MailKit.CommandException">
  52034. The command failed.
  52035. </exception>
  52036. </member>
  52037. <member name="M:MailKit.MailFolder.StoreAsync(System.Collections.Generic.IList{MailKit.UniqueId},System.UInt64,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
  52038. <summary>
  52039. Asynchronously store the annotations for the specified messages only if their mod-sequence value is less than the specified value.
  52040. </summary>
  52041. <remarks>
  52042. Asynchronously stores the annotations for the specified messages only if their mod-sequence value is less than the specified value.
  52043. </remarks>
  52044. <returns>The unique IDs of the messages that were not updated.</returns>
  52045. <param name="uids">The UIDs of the messages.</param>
  52046. <param name="modseq">The mod-sequence value.</param>
  52047. <param name="annotations">The annotations to store.</param>
  52048. <param name="cancellationToken">The cancellation token.</param>
  52049. <exception cref="T:System.ArgumentNullException">
  52050. <para><paramref name="uids"/> is <c>null</c>.</para>
  52051. <para>-or-</para>
  52052. <para><paramref name="annotations"/> is <c>null</c>.</para>
  52053. </exception>
  52054. <exception cref="T:System.ArgumentException">
  52055. One or more of the <paramref name="uids"/> is invalid.
  52056. </exception>
  52057. <exception cref="T:System.ObjectDisposedException">
  52058. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  52059. </exception>
  52060. <exception cref="T:MailKit.ServiceNotConnectedException">
  52061. The <see cref="T:MailKit.IMailStore"/> is not connected.
  52062. </exception>
  52063. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  52064. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  52065. </exception>
  52066. <exception cref="T:MailKit.FolderNotOpenException">
  52067. The <see cref="T:MailKit.IMailFolder"/> is not currently open in read-write mode.
  52068. </exception>
  52069. <exception cref="T:System.InvalidOperationException">
  52070. Cannot store annotations without any properties defined.
  52071. </exception>
  52072. <exception cref="T:System.NotSupportedException">
  52073. <para>The <see cref="T:MailKit.IMailFolder"/> does not support annotations.</para>
  52074. <para>-or-</para>
  52075. <para>The <see cref="T:MailKit.IMailFolder"/> does not support mod-sequences.</para>
  52076. </exception>
  52077. <exception cref="T:System.OperationCanceledException">
  52078. The operation was canceled via the cancellation token.
  52079. </exception>
  52080. <exception cref="T:System.IO.IOException">
  52081. An I/O error occurred.
  52082. </exception>
  52083. <exception cref="T:MailKit.ProtocolException">
  52084. The server's response contained unexpected tokens.
  52085. </exception>
  52086. <exception cref="T:MailKit.CommandException">
  52087. The command failed.
  52088. </exception>
  52089. </member>
  52090. <member name="M:MailKit.MailFolder.Store(System.Int32,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
  52091. <summary>
  52092. Store the annotations for the specified message.
  52093. </summary>
  52094. <remarks>
  52095. Stores the annotations for the specified message.
  52096. </remarks>
  52097. <param name="index">The index of the message.</param>
  52098. <param name="annotations">The annotations to store.</param>
  52099. <param name="cancellationToken">The cancellation token.</param>
  52100. <exception cref="T:System.ArgumentNullException">
  52101. <paramref name="annotations"/> is <c>null</c>.
  52102. </exception>
  52103. <exception cref="T:System.ArgumentException">
  52104. <paramref name="index"/> is invalid.
  52105. </exception>
  52106. <exception cref="T:System.ObjectDisposedException">
  52107. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  52108. </exception>
  52109. <exception cref="T:MailKit.ServiceNotConnectedException">
  52110. The <see cref="T:MailKit.IMailStore"/> is not connected.
  52111. </exception>
  52112. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  52113. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  52114. </exception>
  52115. <exception cref="T:MailKit.FolderNotOpenException">
  52116. The <see cref="T:MailKit.IMailFolder"/> is not currently open in read-write mode.
  52117. </exception>
  52118. <exception cref="T:System.InvalidOperationException">
  52119. Cannot store annotations without any properties defined.
  52120. </exception>
  52121. <exception cref="T:System.NotSupportedException">
  52122. The <see cref="T:MailKit.IMailFolder"/> does not support annotations.
  52123. </exception>
  52124. <exception cref="T:System.OperationCanceledException">
  52125. The operation was canceled via the cancellation token.
  52126. </exception>
  52127. <exception cref="T:System.IO.IOException">
  52128. An I/O error occurred.
  52129. </exception>
  52130. <exception cref="T:MailKit.ProtocolException">
  52131. The server's response contained unexpected tokens.
  52132. </exception>
  52133. <exception cref="T:MailKit.CommandException">
  52134. The command failed.
  52135. </exception>
  52136. </member>
  52137. <member name="M:MailKit.MailFolder.StoreAsync(System.Int32,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
  52138. <summary>
  52139. Asynchronously store the annotations for the specified message.
  52140. </summary>
  52141. <remarks>
  52142. Asynchronously stores the annotations for the specified message.
  52143. </remarks>
  52144. <returns>An asynchronous task context.</returns>
  52145. <param name="index">The indexes of the message.</param>
  52146. <param name="annotations">The annotations to store.</param>
  52147. <param name="cancellationToken">The cancellation token.</param>
  52148. <exception cref="T:System.ArgumentNullException">
  52149. <paramref name="annotations"/> is <c>null</c>.
  52150. </exception>
  52151. <exception cref="T:System.ArgumentException">
  52152. <paramref name="index"/> is invalid.
  52153. </exception>
  52154. <exception cref="T:System.ObjectDisposedException">
  52155. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  52156. </exception>
  52157. <exception cref="T:MailKit.ServiceNotConnectedException">
  52158. The <see cref="T:MailKit.IMailStore"/> is not connected.
  52159. </exception>
  52160. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  52161. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  52162. </exception>
  52163. <exception cref="T:MailKit.FolderNotOpenException">
  52164. The <see cref="T:MailKit.IMailFolder"/> is not currently open in read-write mode.
  52165. </exception>
  52166. <exception cref="T:System.InvalidOperationException">
  52167. Cannot store annotations without any properties defined.
  52168. </exception>
  52169. <exception cref="T:System.NotSupportedException">
  52170. The <see cref="T:MailKit.IMailFolder"/> does not support annotations.
  52171. </exception>
  52172. <exception cref="T:System.OperationCanceledException">
  52173. The operation was canceled via the cancellation token.
  52174. </exception>
  52175. <exception cref="T:System.IO.IOException">
  52176. An I/O error occurred.
  52177. </exception>
  52178. <exception cref="T:MailKit.ProtocolException">
  52179. The server's response contained unexpected tokens.
  52180. </exception>
  52181. <exception cref="T:MailKit.CommandException">
  52182. The command failed.
  52183. </exception>
  52184. </member>
  52185. <member name="M:MailKit.MailFolder.Store(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
  52186. <summary>
  52187. Store the annotations for the specified messages.
  52188. </summary>
  52189. <remarks>
  52190. Stores the annotations for the specified messages.
  52191. </remarks>
  52192. <param name="indexes">The indexes of the messages.</param>
  52193. <param name="annotations">The annotations to store.</param>
  52194. <param name="cancellationToken">The cancellation token.</param>
  52195. <exception cref="T:System.ArgumentNullException">
  52196. <para><paramref name="indexes"/> is <c>null</c>.</para>
  52197. <para>-or-</para>
  52198. <para><paramref name="annotations"/> is <c>null</c>.</para>
  52199. </exception>
  52200. <exception cref="T:System.ArgumentException">
  52201. One or more of the <paramref name="indexes"/> is invalid.
  52202. </exception>
  52203. <exception cref="T:System.ObjectDisposedException">
  52204. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  52205. </exception>
  52206. <exception cref="T:MailKit.ServiceNotConnectedException">
  52207. The <see cref="T:MailKit.IMailStore"/> is not connected.
  52208. </exception>
  52209. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  52210. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  52211. </exception>
  52212. <exception cref="T:MailKit.FolderNotOpenException">
  52213. The <see cref="T:MailKit.IMailFolder"/> is not currently open in read-write mode.
  52214. </exception>
  52215. <exception cref="T:System.InvalidOperationException">
  52216. Cannot store annotations without any properties defined.
  52217. </exception>
  52218. <exception cref="T:System.NotSupportedException">
  52219. The <see cref="T:MailKit.IMailFolder"/> does not support annotations.
  52220. </exception>
  52221. <exception cref="T:System.OperationCanceledException">
  52222. The operation was canceled via the cancellation token.
  52223. </exception>
  52224. <exception cref="T:System.IO.IOException">
  52225. An I/O error occurred.
  52226. </exception>
  52227. <exception cref="T:MailKit.ProtocolException">
  52228. The server's response contained unexpected tokens.
  52229. </exception>
  52230. <exception cref="T:MailKit.CommandException">
  52231. The command failed.
  52232. </exception>
  52233. </member>
  52234. <member name="M:MailKit.MailFolder.StoreAsync(System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
  52235. <summary>
  52236. Asynchronously store the annotations for the specified messages.
  52237. </summary>
  52238. <remarks>
  52239. Asynchronously stores the annotations for the specified messages.
  52240. </remarks>
  52241. <returns>An asynchronous task context.</returns>
  52242. <param name="indexes">The indexes of the messages.</param>
  52243. <param name="annotations">The annotations to store.</param>
  52244. <param name="cancellationToken">The cancellation token.</param>
  52245. <exception cref="T:System.ArgumentNullException">
  52246. <para><paramref name="indexes"/> is <c>null</c>.</para>
  52247. <para>-or-</para>
  52248. <para><paramref name="annotations"/> is <c>null</c>.</para>
  52249. </exception>
  52250. <exception cref="T:System.ArgumentException">
  52251. One or more of the <paramref name="indexes"/> is invalid.
  52252. </exception>
  52253. <exception cref="T:System.ObjectDisposedException">
  52254. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  52255. </exception>
  52256. <exception cref="T:MailKit.ServiceNotConnectedException">
  52257. The <see cref="T:MailKit.IMailStore"/> is not connected.
  52258. </exception>
  52259. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  52260. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  52261. </exception>
  52262. <exception cref="T:MailKit.FolderNotOpenException">
  52263. The <see cref="T:MailKit.IMailFolder"/> is not currently open in read-write mode.
  52264. </exception>
  52265. <exception cref="T:System.InvalidOperationException">
  52266. Cannot store annotations without any properties defined.
  52267. </exception>
  52268. <exception cref="T:System.NotSupportedException">
  52269. The <see cref="T:MailKit.IMailFolder"/> does not support annotations.
  52270. </exception>
  52271. <exception cref="T:System.OperationCanceledException">
  52272. The operation was canceled via the cancellation token.
  52273. </exception>
  52274. <exception cref="T:System.IO.IOException">
  52275. An I/O error occurred.
  52276. </exception>
  52277. <exception cref="T:MailKit.ProtocolException">
  52278. The server's response contained unexpected tokens.
  52279. </exception>
  52280. <exception cref="T:MailKit.CommandException">
  52281. The command failed.
  52282. </exception>
  52283. </member>
  52284. <member name="M:MailKit.MailFolder.Store(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
  52285. <summary>
  52286. Store the annotations for the specified messages only if their mod-sequence value is less than the specified value.
  52287. </summary>
  52288. <remarks>
  52289. Stores the annotations for the specified messages only if their mod-sequence value is less than the specified value.
  52290. </remarks>
  52291. <returns>The indexes of the messages that were not updated.</returns>
  52292. <param name="indexes">The indexes of the messages.</param>
  52293. <param name="modseq">The mod-sequence value.</param>
  52294. <param name="annotations">The annotations to store.</param>
  52295. <param name="cancellationToken">The cancellation token.</param>
  52296. <exception cref="T:System.ArgumentNullException">
  52297. <para><paramref name="indexes"/> is <c>null</c>.</para>
  52298. <para>-or-</para>
  52299. <para><paramref name="annotations"/> is <c>null</c>.</para>
  52300. </exception>
  52301. <exception cref="T:System.ArgumentException">
  52302. One or more of the <paramref name="indexes"/> is invalid.
  52303. </exception>
  52304. <exception cref="T:System.ObjectDisposedException">
  52305. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  52306. </exception>
  52307. <exception cref="T:MailKit.ServiceNotConnectedException">
  52308. The <see cref="T:MailKit.IMailStore"/> is not connected.
  52309. </exception>
  52310. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  52311. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  52312. </exception>
  52313. <exception cref="T:MailKit.FolderNotOpenException">
  52314. The <see cref="T:MailKit.IMailFolder"/> is not currently open in read-write mode.
  52315. </exception>
  52316. <exception cref="T:System.InvalidOperationException">
  52317. Cannot store annotations without any properties defined.
  52318. </exception>
  52319. <exception cref="T:System.NotSupportedException">
  52320. <para>The <see cref="T:MailKit.IMailFolder"/> does not support annotations.</para>
  52321. <para>-or-</para>
  52322. <para>The <see cref="T:MailKit.IMailFolder"/> does not support mod-sequences.</para>
  52323. </exception>
  52324. <exception cref="T:System.OperationCanceledException">
  52325. The operation was canceled via the cancellation token.
  52326. </exception>
  52327. <exception cref="T:System.IO.IOException">
  52328. An I/O error occurred.
  52329. </exception>
  52330. <exception cref="T:MailKit.ProtocolException">
  52331. The server's response contained unexpected tokens.
  52332. </exception>
  52333. <exception cref="T:MailKit.CommandException">
  52334. The command failed.
  52335. </exception>
  52336. </member>
  52337. <member name="M:MailKit.MailFolder.StoreAsync(System.Collections.Generic.IList{System.Int32},System.UInt64,System.Collections.Generic.IList{MailKit.Annotation},System.Threading.CancellationToken)">
  52338. <summary>
  52339. Asynchronously store the annotations for the specified messages only if their mod-sequence value is less than the specified value.
  52340. </summary>
  52341. <remarks>
  52342. Asynchronously stores the annotations for the specified messages only if their mod-sequence value is less than the specified value.s
  52343. </remarks>
  52344. <returns>The indexes of the messages that were not updated.</returns>
  52345. <param name="indexes">The indexes of the messages.</param>
  52346. <param name="modseq">The mod-sequence value.</param>
  52347. <param name="annotations">The annotations to store.</param>
  52348. <param name="cancellationToken">The cancellation token.</param>
  52349. <exception cref="T:System.ArgumentNullException">
  52350. <para><paramref name="indexes"/> is <c>null</c>.</para>
  52351. <para>-or-</para>
  52352. <para><paramref name="annotations"/> is <c>null</c>.</para>
  52353. </exception>
  52354. <exception cref="T:System.ArgumentException">
  52355. One or more of the <paramref name="indexes"/> is invalid.
  52356. </exception>
  52357. <exception cref="T:System.ObjectDisposedException">
  52358. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  52359. </exception>
  52360. <exception cref="T:MailKit.ServiceNotConnectedException">
  52361. The <see cref="T:MailKit.IMailStore"/> is not connected.
  52362. </exception>
  52363. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  52364. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  52365. </exception>
  52366. <exception cref="T:MailKit.FolderNotOpenException">
  52367. The <see cref="T:MailKit.IMailFolder"/> is not currently open in read-write mode.
  52368. </exception>
  52369. <exception cref="T:System.InvalidOperationException">
  52370. Cannot store annotations without any properties defined.
  52371. </exception>
  52372. <exception cref="T:System.NotSupportedException">
  52373. <para>The <see cref="T:MailKit.IMailFolder"/> does not support annotations.</para>
  52374. <para>-or-</para>
  52375. <para>The <see cref="T:MailKit.IMailFolder"/> does not support mod-sequences.</para>
  52376. </exception>
  52377. <exception cref="T:System.OperationCanceledException">
  52378. The operation was canceled via the cancellation token.
  52379. </exception>
  52380. <exception cref="T:System.IO.IOException">
  52381. An I/O error occurred.
  52382. </exception>
  52383. <exception cref="T:MailKit.ProtocolException">
  52384. The server's response contained unexpected tokens.
  52385. </exception>
  52386. <exception cref="T:MailKit.CommandException">
  52387. The command failed.
  52388. </exception>
  52389. </member>
  52390. <member name="M:MailKit.MailFolder.Search(MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
  52391. <summary>
  52392. Search the folder for messages matching the specified query.
  52393. </summary>
  52394. <remarks>
  52395. The returned array of unique identifiers can be used with methods such as
  52396. <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
  52397. </remarks>
  52398. <returns>An array of matching UIDs.</returns>
  52399. <param name="query">The search query.</param>
  52400. <param name="cancellationToken">The cancellation token.</param>
  52401. <exception cref="T:System.ArgumentNullException">
  52402. <paramref name="query"/> is <c>null</c>.
  52403. </exception>
  52404. <exception cref="T:System.NotSupportedException">
  52405. One or more search terms in the <paramref name="query"/> are not supported by the mail store.
  52406. </exception>
  52407. <exception cref="T:System.ObjectDisposedException">
  52408. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  52409. </exception>
  52410. <exception cref="T:MailKit.ServiceNotConnectedException">
  52411. The <see cref="T:MailKit.IMailStore"/> is not connected.
  52412. </exception>
  52413. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  52414. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  52415. </exception>
  52416. <exception cref="T:MailKit.FolderNotOpenException">
  52417. The folder is not currently open.
  52418. </exception>
  52419. <exception cref="T:System.OperationCanceledException">
  52420. The operation was canceled via the cancellation token.
  52421. </exception>
  52422. <exception cref="T:System.IO.IOException">
  52423. An I/O error occurred.
  52424. </exception>
  52425. <exception cref="T:MailKit.ProtocolException">
  52426. The server's response contained unexpected tokens.
  52427. </exception>
  52428. <exception cref="T:MailKit.CommandException">
  52429. The command failed.
  52430. </exception>
  52431. </member>
  52432. <member name="M:MailKit.MailFolder.SearchAsync(MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
  52433. <summary>
  52434. Asynchronously search the folder for messages matching the specified query.
  52435. </summary>
  52436. <remarks>
  52437. The returned array of unique identifiers can be used with methods such as
  52438. <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
  52439. </remarks>
  52440. <returns>An array of matching UIDs.</returns>
  52441. <param name="query">The search query.</param>
  52442. <param name="cancellationToken">The cancellation token.</param>
  52443. <exception cref="T:System.ArgumentNullException">
  52444. <paramref name="query"/> is <c>null</c>.
  52445. </exception>
  52446. <exception cref="T:System.NotSupportedException">
  52447. One or more search terms in the <paramref name="query"/> are not supported by the mail store.
  52448. </exception>
  52449. <exception cref="T:System.ObjectDisposedException">
  52450. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  52451. </exception>
  52452. <exception cref="T:MailKit.ServiceNotConnectedException">
  52453. The <see cref="T:MailKit.IMailStore"/> is not connected.
  52454. </exception>
  52455. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  52456. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  52457. </exception>
  52458. <exception cref="T:MailKit.FolderNotOpenException">
  52459. The folder is not currently open.
  52460. </exception>
  52461. <exception cref="T:System.OperationCanceledException">
  52462. The operation was canceled via the cancellation token.
  52463. </exception>
  52464. <exception cref="T:System.IO.IOException">
  52465. An I/O error occurred.
  52466. </exception>
  52467. <exception cref="T:MailKit.ProtocolException">
  52468. The server's response contained unexpected tokens.
  52469. </exception>
  52470. <exception cref="T:MailKit.CommandException">
  52471. The command failed.
  52472. </exception>
  52473. </member>
  52474. <member name="M:MailKit.MailFolder.Search(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
  52475. <summary>
  52476. Search the subset of UIDs in the folder for messages matching the specified query.
  52477. </summary>
  52478. <remarks>
  52479. The returned array of unique identifiers can be used with methods such as
  52480. <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
  52481. </remarks>
  52482. <returns>An array of matching UIDs in the specified sort order.</returns>
  52483. <param name="uids">The subset of UIDs</param>
  52484. <param name="query">The search query.</param>
  52485. <param name="cancellationToken">The cancellation token.</param>
  52486. <exception cref="T:System.ArgumentNullException">
  52487. <para><paramref name="uids"/> is <c>null</c>.</para>
  52488. <para>-or-</para>
  52489. <para><paramref name="query"/> is <c>null</c>.</para>
  52490. </exception>
  52491. <exception cref="T:System.ArgumentException">
  52492. <para><paramref name="uids"/> is empty.</para>
  52493. <para>-or-</para>
  52494. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  52495. </exception>
  52496. <exception cref="T:System.NotSupportedException">
  52497. One or more search terms in the <paramref name="query"/> are not supported by the mail store.
  52498. </exception>
  52499. <exception cref="T:System.ObjectDisposedException">
  52500. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  52501. </exception>
  52502. <exception cref="T:MailKit.ServiceNotConnectedException">
  52503. The <see cref="T:MailKit.IMailStore"/> is not connected.
  52504. </exception>
  52505. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  52506. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  52507. </exception>
  52508. <exception cref="T:MailKit.FolderNotOpenException">
  52509. The folder is not currently open.
  52510. </exception>
  52511. <exception cref="T:System.OperationCanceledException">
  52512. The operation was canceled via the cancellation token.
  52513. </exception>
  52514. <exception cref="T:System.IO.IOException">
  52515. An I/O error occurred.
  52516. </exception>
  52517. <exception cref="T:MailKit.ProtocolException">
  52518. The server's response contained unexpected tokens.
  52519. </exception>
  52520. <exception cref="T:MailKit.CommandException">
  52521. The command failed.
  52522. </exception>
  52523. </member>
  52524. <member name="M:MailKit.MailFolder.SearchAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
  52525. <summary>
  52526. Asynchronously search the subset of UIDs in the folder for messages matching the specified query.
  52527. </summary>
  52528. <remarks>
  52529. The returned array of unique identifiers can be used with methods such as
  52530. <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
  52531. </remarks>
  52532. <returns>An array of matching UIDs in the specified sort order.</returns>
  52533. <param name="uids">The subset of UIDs</param>
  52534. <param name="query">The search query.</param>
  52535. <param name="cancellationToken">The cancellation token.</param>
  52536. <exception cref="T:System.ArgumentNullException">
  52537. <para><paramref name="uids"/> is <c>null</c>.</para>
  52538. <para>-or-</para>
  52539. <para><paramref name="query"/> is <c>null</c>.</para>
  52540. </exception>
  52541. <exception cref="T:System.ArgumentException">
  52542. <para><paramref name="uids"/> is empty.</para>
  52543. <para>-or-</para>
  52544. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  52545. </exception>
  52546. <exception cref="T:System.NotSupportedException">
  52547. One or more search terms in the <paramref name="query"/> are not supported.
  52548. </exception>
  52549. <exception cref="T:System.ObjectDisposedException">
  52550. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  52551. </exception>
  52552. <exception cref="T:MailKit.ServiceNotConnectedException">
  52553. The <see cref="T:MailKit.IMailStore"/> is not connected.
  52554. </exception>
  52555. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  52556. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  52557. </exception>
  52558. <exception cref="T:MailKit.FolderNotOpenException">
  52559. The folder is not currently open.
  52560. </exception>
  52561. <exception cref="T:System.OperationCanceledException">
  52562. The operation was canceled via the cancellation token.
  52563. </exception>
  52564. <exception cref="T:System.IO.IOException">
  52565. An I/O error occurred.
  52566. </exception>
  52567. <exception cref="T:MailKit.ProtocolException">
  52568. The server's response contained unexpected tokens.
  52569. </exception>
  52570. <exception cref="T:MailKit.CommandException">
  52571. The command failed.
  52572. </exception>
  52573. </member>
  52574. <member name="M:MailKit.MailFolder.Search(MailKit.Search.SearchOptions,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
  52575. <summary>
  52576. Search the folder for messages matching the specified query.
  52577. </summary>
  52578. <remarks>
  52579. Searches the folder for messages matching the specified query,
  52580. returning only the specified search results.
  52581. </remarks>
  52582. <returns>The search results.</returns>
  52583. <param name="options">The search options.</param>
  52584. <param name="query">The search query.</param>
  52585. <param name="cancellationToken">The cancellation token.</param>
  52586. <exception cref="T:System.ArgumentNullException">
  52587. <paramref name="query"/> is <c>null</c>.
  52588. </exception>
  52589. <exception cref="T:System.NotSupportedException">
  52590. <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
  52591. <para>-or-</para>
  52592. <para>The server does not support the specified search options.</para>
  52593. </exception>
  52594. <exception cref="T:System.ObjectDisposedException">
  52595. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  52596. </exception>
  52597. <exception cref="T:MailKit.ServiceNotConnectedException">
  52598. The <see cref="T:MailKit.IMailStore"/> is not connected.
  52599. </exception>
  52600. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  52601. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  52602. </exception>
  52603. <exception cref="T:MailKit.FolderNotOpenException">
  52604. The <see cref="T:MailKit.MailFolder"/> is not currently open.
  52605. </exception>
  52606. <exception cref="T:System.OperationCanceledException">
  52607. The operation was canceled via the cancellation token.
  52608. </exception>
  52609. <exception cref="T:System.IO.IOException">
  52610. An I/O error occurred.
  52611. </exception>
  52612. <exception cref="T:MailKit.ProtocolException">
  52613. The server's response contained unexpected tokens.
  52614. </exception>
  52615. <exception cref="T:MailKit.CommandException">
  52616. The command failed.
  52617. </exception>
  52618. </member>
  52619. <member name="M:MailKit.MailFolder.SearchAsync(MailKit.Search.SearchOptions,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
  52620. <summary>
  52621. Asynchronously search the folder for messages matching the specified query.
  52622. </summary>
  52623. <remarks>
  52624. Asynchronously searches the folder for messages matching the specified query,
  52625. returning only the specified search results.
  52626. </remarks>
  52627. <returns>The search results.</returns>
  52628. <param name="options">The search options.</param>
  52629. <param name="query">The search query.</param>
  52630. <param name="cancellationToken">The cancellation token.</param>
  52631. <exception cref="T:System.ArgumentNullException">
  52632. <paramref name="query"/> is <c>null</c>.
  52633. </exception>
  52634. <exception cref="T:System.NotSupportedException">
  52635. <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
  52636. <para>-or-</para>
  52637. <para>The server does not support the specified search options.</para>
  52638. </exception>
  52639. <exception cref="T:System.ObjectDisposedException">
  52640. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  52641. </exception>
  52642. <exception cref="T:MailKit.ServiceNotConnectedException">
  52643. The <see cref="T:MailKit.IMailStore"/> is not connected.
  52644. </exception>
  52645. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  52646. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  52647. </exception>
  52648. <exception cref="T:MailKit.FolderNotOpenException">
  52649. The <see cref="T:MailKit.MailFolder"/> is not currently open.
  52650. </exception>
  52651. <exception cref="T:System.OperationCanceledException">
  52652. The operation was canceled via the cancellation token.
  52653. </exception>
  52654. <exception cref="T:System.IO.IOException">
  52655. An I/O error occurred.
  52656. </exception>
  52657. <exception cref="T:MailKit.ProtocolException">
  52658. The server's response contained unexpected tokens.
  52659. </exception>
  52660. <exception cref="T:MailKit.CommandException">
  52661. The command failed.
  52662. </exception>
  52663. </member>
  52664. <member name="M:MailKit.MailFolder.Search(MailKit.Search.SearchOptions,System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
  52665. <summary>
  52666. Search the subset of UIDs in the folder for messages matching the specified query.
  52667. </summary>
  52668. <remarks>
  52669. Searches the fsubset of UIDs in the folder for messages matching the specified query,
  52670. returning only the specified search results.
  52671. </remarks>
  52672. <returns>The search results.</returns>
  52673. <param name="options">The search options.</param>
  52674. <param name="uids">The subset of UIDs</param>
  52675. <param name="query">The search query.</param>
  52676. <param name="cancellationToken">The cancellation token.</param>
  52677. <exception cref="T:System.ArgumentNullException">
  52678. <para><paramref name="uids"/> is <c>null</c>.</para>
  52679. <para>-or-</para>
  52680. <para><paramref name="query"/> is <c>null</c>.</para>
  52681. </exception>
  52682. <exception cref="T:System.ArgumentException">
  52683. <para><paramref name="uids"/> is empty.</para>
  52684. <para>-or-</para>
  52685. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  52686. </exception>
  52687. <exception cref="T:System.NotSupportedException">
  52688. <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
  52689. <para>-or-</para>
  52690. <para>The server does not support the specified search options.</para>
  52691. </exception>
  52692. <exception cref="T:System.ObjectDisposedException">
  52693. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  52694. </exception>
  52695. <exception cref="T:MailKit.ServiceNotConnectedException">
  52696. The <see cref="T:MailKit.IMailStore"/> is not connected.
  52697. </exception>
  52698. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  52699. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  52700. </exception>
  52701. <exception cref="T:MailKit.FolderNotOpenException">
  52702. The folder is not currently open.
  52703. </exception>
  52704. <exception cref="T:System.OperationCanceledException">
  52705. The operation was canceled via the cancellation token.
  52706. </exception>
  52707. <exception cref="T:System.IO.IOException">
  52708. An I/O error occurred.
  52709. </exception>
  52710. <exception cref="T:MailKit.ProtocolException">
  52711. The server's response contained unexpected tokens.
  52712. </exception>
  52713. <exception cref="T:MailKit.CommandException">
  52714. The command failed.
  52715. </exception>
  52716. </member>
  52717. <member name="M:MailKit.MailFolder.SearchAsync(MailKit.Search.SearchOptions,System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
  52718. <summary>
  52719. Asynchronously search the subset of UIDs in the folder for messages matching the specified query.
  52720. </summary>
  52721. <remarks>
  52722. Asynchronously searches the fsubset of UIDs in the folder for messages matching the specified query,
  52723. returning only the specified search results.
  52724. </remarks>
  52725. <returns>The search results.</returns>
  52726. <param name="options">The search options.</param>
  52727. <param name="uids">The subset of UIDs</param>
  52728. <param name="query">The search query.</param>
  52729. <param name="cancellationToken">The cancellation token.</param>
  52730. <exception cref="T:System.ArgumentNullException">
  52731. <para><paramref name="uids"/> is <c>null</c>.</para>
  52732. <para>-or-</para>
  52733. <para><paramref name="query"/> is <c>null</c>.</para>
  52734. </exception>
  52735. <exception cref="T:System.ArgumentException">
  52736. <para><paramref name="uids"/> is empty.</para>
  52737. <para>-or-</para>
  52738. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  52739. </exception>
  52740. <exception cref="T:System.NotSupportedException">
  52741. <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
  52742. <para>-or-</para>
  52743. <para>The server does not support the specified search options.</para>
  52744. </exception>
  52745. <exception cref="T:System.ObjectDisposedException">
  52746. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  52747. </exception>
  52748. <exception cref="T:MailKit.ServiceNotConnectedException">
  52749. The <see cref="T:MailKit.IMailStore"/> is not connected.
  52750. </exception>
  52751. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  52752. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  52753. </exception>
  52754. <exception cref="T:MailKit.FolderNotOpenException">
  52755. The folder is not currently open.
  52756. </exception>
  52757. <exception cref="T:System.OperationCanceledException">
  52758. The operation was canceled via the cancellation token.
  52759. </exception>
  52760. <exception cref="T:System.IO.IOException">
  52761. An I/O error occurred.
  52762. </exception>
  52763. <exception cref="T:MailKit.ProtocolException">
  52764. The server's response contained unexpected tokens.
  52765. </exception>
  52766. <exception cref="T:MailKit.CommandException">
  52767. The command failed.
  52768. </exception>
  52769. </member>
  52770. <member name="M:MailKit.MailFolder.Sort(MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
  52771. <summary>
  52772. Sort messages matching the specified query.
  52773. </summary>
  52774. <remarks>
  52775. The returned array of unique identifiers will be sorted in the preferred order and
  52776. can be used with <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
  52777. </remarks>
  52778. /// <returns>An array of matching UIDs in the specified sort order.</returns>
  52779. <param name="query">The search query.</param>
  52780. <param name="orderBy">The sort order.</param>
  52781. <param name="cancellationToken">The cancellation token.</param>
  52782. <exception cref="T:System.ArgumentNullException">
  52783. <para><paramref name="query"/> is <c>null</c>.</para>
  52784. <para>-or-</para>
  52785. <para><paramref name="orderBy"/> is <c>null</c>.</para>
  52786. </exception>
  52787. <exception cref="T:System.ArgumentException">
  52788. <paramref name="orderBy"/> is empty.
  52789. </exception>
  52790. <exception cref="T:System.NotSupportedException">
  52791. <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
  52792. <para>-or-</para>
  52793. <para>The server does not support sorting search results.</para>
  52794. </exception>
  52795. <exception cref="T:System.ObjectDisposedException">
  52796. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  52797. </exception>
  52798. <exception cref="T:MailKit.ServiceNotConnectedException">
  52799. The <see cref="T:MailKit.IMailStore"/> is not connected.
  52800. </exception>
  52801. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  52802. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  52803. </exception>
  52804. <exception cref="T:MailKit.FolderNotOpenException">
  52805. The folder is not currently open.
  52806. </exception>
  52807. <exception cref="T:System.OperationCanceledException">
  52808. The operation was canceled via the cancellation token.
  52809. </exception>
  52810. <exception cref="T:System.IO.IOException">
  52811. An I/O error occurred.
  52812. </exception>
  52813. <exception cref="T:MailKit.ProtocolException">
  52814. The server's response contained unexpected tokens.
  52815. </exception>
  52816. <exception cref="T:MailKit.CommandException">
  52817. The command failed.
  52818. </exception>
  52819. </member>
  52820. <member name="M:MailKit.MailFolder.SortAsync(MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
  52821. <summary>
  52822. Asynchronously sort messages matching the specified query.
  52823. </summary>
  52824. <remarks>
  52825. The returned array of unique identifiers will be sorted in the preferred order and
  52826. can be used with <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
  52827. </remarks>
  52828. <returns>An array of matching UIDs in the specified sort order.</returns>
  52829. <param name="query">The search query.</param>
  52830. <param name="orderBy">The sort order.</param>
  52831. <param name="cancellationToken">The cancellation token.</param>
  52832. <exception cref="T:System.ArgumentNullException">
  52833. <para><paramref name="query"/> is <c>null</c>.</para>
  52834. <para>-or-</para>
  52835. <para><paramref name="orderBy"/> is <c>null</c>.</para>
  52836. </exception>
  52837. <exception cref="T:System.ArgumentException">
  52838. <paramref name="orderBy"/> is empty.
  52839. </exception>
  52840. <exception cref="T:System.NotSupportedException">
  52841. <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
  52842. <para>-or-</para>
  52843. <para>The server does not support sorting search results.</para>
  52844. </exception>
  52845. <exception cref="T:System.ObjectDisposedException">
  52846. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  52847. </exception>
  52848. <exception cref="T:MailKit.ServiceNotConnectedException">
  52849. The <see cref="T:MailKit.IMailStore"/> is not connected.
  52850. </exception>
  52851. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  52852. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  52853. </exception>
  52854. <exception cref="T:MailKit.FolderNotOpenException">
  52855. The folder is not currently open.
  52856. </exception>
  52857. <exception cref="T:System.OperationCanceledException">
  52858. The operation was canceled via the cancellation token.
  52859. </exception>
  52860. <exception cref="T:System.IO.IOException">
  52861. An I/O error occurred.
  52862. </exception>
  52863. <exception cref="T:MailKit.ProtocolException">
  52864. The server's response contained unexpected tokens.
  52865. </exception>
  52866. <exception cref="T:MailKit.CommandException">
  52867. The command failed.
  52868. </exception>
  52869. </member>
  52870. <member name="M:MailKit.MailFolder.Sort(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
  52871. <summary>
  52872. Sort messages matching the specified query.
  52873. </summary>
  52874. <remarks>
  52875. The returned array of unique identifiers will be sorted in the preferred order and
  52876. can be used with <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
  52877. </remarks>
  52878. <returns>An array of matching UIDs in the specified sort order.</returns>
  52879. <param name="uids">The subset of UIDs</param>
  52880. <param name="query">The search query.</param>
  52881. <param name="orderBy">The sort order.</param>
  52882. <param name="cancellationToken">The cancellation token.</param>
  52883. <exception cref="T:System.ArgumentNullException">
  52884. <para><paramref name="uids"/> is <c>null</c>.</para>
  52885. <para>-or-</para>
  52886. <para><paramref name="query"/> is <c>null</c>.</para>
  52887. <para>-or-</para>
  52888. <para><paramref name="orderBy"/> is <c>null</c>.</para>
  52889. </exception>
  52890. <exception cref="T:System.ArgumentException">
  52891. <para><paramref name="uids"/> is empty.</para>
  52892. <para>-or-</para>
  52893. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  52894. <para>-or-</para>
  52895. <para><paramref name="orderBy"/> is empty.</para>
  52896. </exception>
  52897. <exception cref="T:System.NotSupportedException">
  52898. <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
  52899. <para>-or-</para>
  52900. <para>The server does not support sorting search results.</para>
  52901. </exception>
  52902. <exception cref="T:System.ObjectDisposedException">
  52903. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  52904. </exception>
  52905. <exception cref="T:MailKit.ServiceNotConnectedException">
  52906. The <see cref="T:MailKit.IMailStore"/> is not connected.
  52907. </exception>
  52908. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  52909. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  52910. </exception>
  52911. <exception cref="T:MailKit.FolderNotOpenException">
  52912. The folder is not currently open.
  52913. </exception>
  52914. <exception cref="T:System.OperationCanceledException">
  52915. The operation was canceled via the cancellation token.
  52916. </exception>
  52917. <exception cref="T:System.IO.IOException">
  52918. An I/O error occurred.
  52919. </exception>
  52920. <exception cref="T:MailKit.ProtocolException">
  52921. The server's response contained unexpected tokens.
  52922. </exception>
  52923. <exception cref="T:MailKit.CommandException">
  52924. The command failed.
  52925. </exception>
  52926. </member>
  52927. <member name="M:MailKit.MailFolder.SortAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
  52928. <summary>
  52929. Asynchronously sort messages matching the specified query.
  52930. </summary>
  52931. <remarks>
  52932. The returned array of unique identifiers will be sorted in the preferred order and
  52933. can be used with <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
  52934. </remarks>
  52935. <returns>An array of matching UIDs in the specified sort order.</returns>
  52936. <param name="uids">The subset of UIDs</param>
  52937. <param name="query">The search query.</param>
  52938. <param name="orderBy">The sort order.</param>
  52939. <param name="cancellationToken">The cancellation token.</param>
  52940. <exception cref="T:System.ArgumentNullException">
  52941. <para><paramref name="uids"/> is <c>null</c>.</para>
  52942. <para>-or-</para>
  52943. <para><paramref name="query"/> is <c>null</c>.</para>
  52944. <para>-or-</para>
  52945. <para><paramref name="orderBy"/> is <c>null</c>.</para>
  52946. </exception>
  52947. <exception cref="T:System.ArgumentException">
  52948. <para><paramref name="uids"/> is empty.</para>
  52949. <para>-or-</para>
  52950. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  52951. <para>-or-</para>
  52952. <para><paramref name="orderBy"/> is empty.</para>
  52953. </exception>
  52954. <exception cref="T:System.NotSupportedException">
  52955. <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
  52956. <para>-or-</para>
  52957. <para>The server does not support sorting search results.</para>
  52958. </exception>
  52959. <exception cref="T:System.ObjectDisposedException">
  52960. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  52961. </exception>
  52962. <exception cref="T:MailKit.ServiceNotConnectedException">
  52963. The <see cref="T:MailKit.IMailStore"/> is not connected.
  52964. </exception>
  52965. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  52966. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  52967. </exception>
  52968. <exception cref="T:MailKit.FolderNotOpenException">
  52969. The folder is not currently open.
  52970. </exception>
  52971. <exception cref="T:System.OperationCanceledException">
  52972. The operation was canceled via the cancellation token.
  52973. </exception>
  52974. <exception cref="T:System.IO.IOException">
  52975. An I/O error occurred.
  52976. </exception>
  52977. <exception cref="T:MailKit.ProtocolException">
  52978. The server's response contained unexpected tokens.
  52979. </exception>
  52980. <exception cref="T:MailKit.CommandException">
  52981. The command failed.
  52982. </exception>
  52983. </member>
  52984. <member name="M:MailKit.MailFolder.Sort(MailKit.Search.SearchOptions,MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
  52985. <summary>
  52986. Sort messages matching the specified query.
  52987. </summary>
  52988. <remarks>
  52989. Searches the folder for messages matching the specified query, returning the search results in the specified sort order.
  52990. </remarks>
  52991. <returns>The search results.</returns>
  52992. <param name="options">The search options.</param>
  52993. <param name="query">The search query.</param>
  52994. <param name="orderBy">The sort order.</param>
  52995. <param name="cancellationToken">The cancellation token.</param>
  52996. <exception cref="T:System.ArgumentNullException">
  52997. <para><paramref name="query"/> is <c>null</c>.</para>
  52998. <para>-or-</para>
  52999. <para><paramref name="orderBy"/> is <c>null</c>.</para>
  53000. </exception>
  53001. <exception cref="T:System.ArgumentException">
  53002. <paramref name="orderBy"/> is empty.
  53003. </exception>
  53004. <exception cref="T:System.NotSupportedException">
  53005. <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
  53006. <para>-or-</para>
  53007. <para>The server does not support the specified search options.</para>
  53008. <para>-or-</para>
  53009. <para>The server does not support sorting search results.</para>
  53010. </exception>
  53011. <exception cref="T:System.ObjectDisposedException">
  53012. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  53013. </exception>
  53014. <exception cref="T:MailKit.ServiceNotConnectedException">
  53015. The <see cref="T:MailKit.IMailStore"/> is not connected.
  53016. </exception>
  53017. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  53018. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  53019. </exception>
  53020. <exception cref="T:MailKit.FolderNotOpenException">
  53021. The <see cref="T:MailKit.MailFolder"/> is not currently open.
  53022. </exception>
  53023. <exception cref="T:System.OperationCanceledException">
  53024. The operation was canceled via the cancellation token.
  53025. </exception>
  53026. <exception cref="T:System.IO.IOException">
  53027. An I/O error occurred.
  53028. </exception>
  53029. <exception cref="T:MailKit.ProtocolException">
  53030. The server's response contained unexpected tokens.
  53031. </exception>
  53032. <exception cref="T:MailKit.CommandException">
  53033. The command failed.
  53034. </exception>
  53035. </member>
  53036. <member name="M:MailKit.MailFolder.SortAsync(MailKit.Search.SearchOptions,MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
  53037. <summary>
  53038. Asynchronously sort messages matching the specified query.
  53039. </summary>
  53040. <remarks>
  53041. Asynchronously searches the folder for messages matching the specified query, returning the search results in the specified sort order.
  53042. </remarks>
  53043. <returns>The search results.</returns>
  53044. <param name="options">The search options.</param>
  53045. <param name="query">The search query.</param>
  53046. <param name="orderBy">The sort order.</param>
  53047. <param name="cancellationToken">The cancellation token.</param>
  53048. <exception cref="T:System.ArgumentNullException">
  53049. <para><paramref name="query"/> is <c>null</c>.</para>
  53050. <para>-or-</para>
  53051. <para><paramref name="orderBy"/> is <c>null</c>.</para>
  53052. </exception>
  53053. <exception cref="T:System.ArgumentException">
  53054. <paramref name="orderBy"/> is empty.
  53055. </exception>
  53056. <exception cref="T:System.NotSupportedException">
  53057. <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
  53058. <para>-or-</para>
  53059. <para>The server does not support the specified search options.</para>
  53060. <para>-or-</para>
  53061. <para>The server does not support sorting search results.</para>
  53062. </exception>
  53063. <exception cref="T:System.ObjectDisposedException">
  53064. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  53065. </exception>
  53066. <exception cref="T:MailKit.ServiceNotConnectedException">
  53067. The <see cref="T:MailKit.IMailStore"/> is not connected.
  53068. </exception>
  53069. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  53070. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  53071. </exception>
  53072. <exception cref="T:MailKit.FolderNotOpenException">
  53073. The <see cref="T:MailKit.MailFolder"/> is not currently open.
  53074. </exception>
  53075. <exception cref="T:System.OperationCanceledException">
  53076. The operation was canceled via the cancellation token.
  53077. </exception>
  53078. <exception cref="T:System.IO.IOException">
  53079. An I/O error occurred.
  53080. </exception>
  53081. <exception cref="T:MailKit.ProtocolException">
  53082. The server's response contained unexpected tokens.
  53083. </exception>
  53084. <exception cref="T:MailKit.CommandException">
  53085. The command failed.
  53086. </exception>
  53087. </member>
  53088. <member name="M:MailKit.MailFolder.Sort(MailKit.Search.SearchOptions,System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
  53089. <summary>
  53090. Sort messages matching the specified query.
  53091. </summary>
  53092. <remarks>
  53093. Searches the folder for messages matching the specified query, returning the search results in the specified sort order.
  53094. </remarks>
  53095. <returns>The search results.</returns>
  53096. <param name="options">The search options.</param>
  53097. <param name="uids">The subset of UIDs</param>
  53098. <param name="query">The search query.</param>
  53099. <param name="orderBy">The sort order.</param>
  53100. <param name="cancellationToken">The cancellation token.</param>
  53101. <exception cref="T:System.ArgumentNullException">
  53102. <para><paramref name="uids"/> is <c>null</c>.</para>
  53103. <para>-or-</para>
  53104. <para><paramref name="query"/> is <c>null</c>.</para>
  53105. <para>-or-</para>
  53106. <para><paramref name="orderBy"/> is <c>null</c>.</para>
  53107. </exception>
  53108. <exception cref="T:System.ArgumentException">
  53109. <para><paramref name="uids"/> is empty.</para>
  53110. <para>-or-</para>
  53111. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  53112. <para>-or-</para>
  53113. <para><paramref name="orderBy"/> is empty.</para>
  53114. </exception>
  53115. <exception cref="T:System.NotSupportedException">
  53116. <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
  53117. <para>-or-</para>
  53118. <para>The server does not support the specified search options.</para>
  53119. <para>-or-</para>
  53120. <para>The server does not support sorting search results.</para>
  53121. </exception>
  53122. <exception cref="T:System.ObjectDisposedException">
  53123. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  53124. </exception>
  53125. <exception cref="T:MailKit.ServiceNotConnectedException">
  53126. The <see cref="T:MailKit.IMailStore"/> is not connected.
  53127. </exception>
  53128. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  53129. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  53130. </exception>
  53131. <exception cref="T:MailKit.FolderNotOpenException">
  53132. The folder is not currently open.
  53133. </exception>
  53134. <exception cref="T:System.OperationCanceledException">
  53135. The operation was canceled via the cancellation token.
  53136. </exception>
  53137. <exception cref="T:System.IO.IOException">
  53138. An I/O error occurred.
  53139. </exception>
  53140. <exception cref="T:MailKit.ProtocolException">
  53141. The server's response contained unexpected tokens.
  53142. </exception>
  53143. <exception cref="T:MailKit.CommandException">
  53144. The command failed.
  53145. </exception>
  53146. </member>
  53147. <member name="M:MailKit.MailFolder.SortAsync(MailKit.Search.SearchOptions,System.Collections.Generic.IList{MailKit.UniqueId},MailKit.Search.SearchQuery,System.Collections.Generic.IList{MailKit.Search.OrderBy},System.Threading.CancellationToken)">
  53148. <summary>
  53149. Asynchronously sort messages matching the specified query, returning the search results in the specified sort order.
  53150. </summary>
  53151. <remarks>
  53152. Asynchronously searches the folder for messages matching the specified query,
  53153. returning the search results in the specified sort order.
  53154. </remarks>
  53155. <returns>The search results.</returns>
  53156. <param name="options">The search options.</param>
  53157. <param name="uids">The subset of UIDs</param>
  53158. <param name="query">The search query.</param>
  53159. <param name="orderBy">The sort order.</param>
  53160. <param name="cancellationToken">The cancellation token.</param>
  53161. <exception cref="T:System.ArgumentNullException">
  53162. <para><paramref name="uids"/> is <c>null</c>.</para>
  53163. <para>-or-</para>
  53164. <para><paramref name="query"/> is <c>null</c>.</para>
  53165. <para>-or-</para>
  53166. <para><paramref name="orderBy"/> is <c>null</c>.</para>
  53167. </exception>
  53168. <exception cref="T:System.ArgumentException">
  53169. <para><paramref name="uids"/> is empty.</para>
  53170. <para>-or-</para>
  53171. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  53172. <para>-or-</para>
  53173. <para><paramref name="orderBy"/> is empty.</para>
  53174. </exception>
  53175. <exception cref="T:System.NotSupportedException">
  53176. <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
  53177. <para>-or-</para>
  53178. <para>The server does not support the specified search options.</para>
  53179. <para>-or-</para>
  53180. <para>The server does not support sorting search results.</para>
  53181. </exception>
  53182. <exception cref="T:System.ObjectDisposedException">
  53183. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  53184. </exception>
  53185. <exception cref="T:MailKit.ServiceNotConnectedException">
  53186. The <see cref="T:MailKit.IMailStore"/> is not connected.
  53187. </exception>
  53188. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  53189. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  53190. </exception>
  53191. <exception cref="T:MailKit.FolderNotOpenException">
  53192. The folder is not currently open.
  53193. </exception>
  53194. <exception cref="T:System.OperationCanceledException">
  53195. The operation was canceled via the cancellation token.
  53196. </exception>
  53197. <exception cref="T:System.IO.IOException">
  53198. An I/O error occurred.
  53199. </exception>
  53200. <exception cref="T:MailKit.ProtocolException">
  53201. The server's response contained unexpected tokens.
  53202. </exception>
  53203. <exception cref="T:MailKit.CommandException">
  53204. The command failed.
  53205. </exception>
  53206. </member>
  53207. <member name="M:MailKit.MailFolder.Thread(MailKit.ThreadingAlgorithm,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
  53208. <summary>
  53209. Thread the messages in the folder that match the search query using the specified threading algorithm.
  53210. </summary>
  53211. <remarks>
  53212. The <see cref="P:MailKit.MessageThread.UniqueId"/> can be used with methods such as
  53213. <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
  53214. </remarks>
  53215. <returns>An array of message threads.</returns>
  53216. <param name="algorithm">The threading algorithm to use.</param>
  53217. <param name="query">The search query.</param>
  53218. <param name="cancellationToken">The cancellation token.</param>
  53219. <exception cref="T:System.ArgumentOutOfRangeException">
  53220. <paramref name="algorithm"/> is not supported.
  53221. </exception>
  53222. <exception cref="T:System.ArgumentNullException">
  53223. <paramref name="query"/> is <c>null</c>.
  53224. </exception>
  53225. <exception cref="T:System.NotSupportedException">
  53226. <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
  53227. <para>-or-</para>
  53228. <para>The server does not support threading search results.</para>
  53229. </exception>
  53230. <exception cref="T:System.ObjectDisposedException">
  53231. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  53232. </exception>
  53233. <exception cref="T:MailKit.ServiceNotConnectedException">
  53234. The <see cref="T:MailKit.IMailStore"/> is not connected.
  53235. </exception>
  53236. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  53237. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  53238. </exception>
  53239. <exception cref="T:MailKit.FolderNotOpenException">
  53240. The folder is not currently open.
  53241. </exception>
  53242. <exception cref="T:System.OperationCanceledException">
  53243. The operation was canceled via the cancellation token.
  53244. </exception>
  53245. <exception cref="T:System.IO.IOException">
  53246. An I/O error occurred.
  53247. </exception>
  53248. <exception cref="T:MailKit.ProtocolException">
  53249. The server's response contained unexpected tokens.
  53250. </exception>
  53251. <exception cref="T:MailKit.CommandException">
  53252. The command failed.
  53253. </exception>
  53254. </member>
  53255. <member name="M:MailKit.MailFolder.ThreadAsync(MailKit.ThreadingAlgorithm,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
  53256. <summary>
  53257. Asynchronously thread the messages in the folder that match the search query using the specified threading algorithm.
  53258. </summary>
  53259. <remarks>
  53260. The <see cref="P:MailKit.MessageThread.UniqueId"/> can be used with methods such as
  53261. <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
  53262. </remarks>
  53263. <returns>An array of message threads.</returns>
  53264. <param name="algorithm">The threading algorithm to use.</param>
  53265. <param name="query">The search query.</param>
  53266. <param name="cancellationToken">The cancellation token.</param>
  53267. <exception cref="T:System.ArgumentOutOfRangeException">
  53268. <paramref name="algorithm"/> is not supported.
  53269. </exception>
  53270. <exception cref="T:System.ArgumentNullException">
  53271. <paramref name="query"/> is <c>null</c>.
  53272. </exception>
  53273. <exception cref="T:System.NotSupportedException">
  53274. <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
  53275. <para>-or-</para>
  53276. <para>The server does not support threading search results.</para>
  53277. </exception>
  53278. <exception cref="T:System.ObjectDisposedException">
  53279. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  53280. </exception>
  53281. <exception cref="T:MailKit.ServiceNotConnectedException">
  53282. The <see cref="T:MailKit.IMailStore"/> is not connected.
  53283. </exception>
  53284. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  53285. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  53286. </exception>
  53287. <exception cref="T:MailKit.FolderNotOpenException">
  53288. The folder is not currently open.
  53289. </exception>
  53290. <exception cref="T:System.OperationCanceledException">
  53291. The operation was canceled via the cancellation token.
  53292. </exception>
  53293. <exception cref="T:System.IO.IOException">
  53294. An I/O error occurred.
  53295. </exception>
  53296. <exception cref="T:MailKit.ProtocolException">
  53297. The server's response contained unexpected tokens.
  53298. </exception>
  53299. <exception cref="T:MailKit.CommandException">
  53300. The command failed.
  53301. </exception>
  53302. </member>
  53303. <member name="M:MailKit.MailFolder.Thread(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.ThreadingAlgorithm,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
  53304. <summary>
  53305. Thread the messages in the folder that match the search query using the specified threading algorithm.
  53306. </summary>
  53307. <remarks>
  53308. The <see cref="P:MailKit.MessageThread.UniqueId"/> can be used with methods such as
  53309. <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
  53310. </remarks>
  53311. <returns>An array of message threads.</returns>
  53312. <param name="uids">The subset of UIDs</param>
  53313. <param name="algorithm">The threading algorithm to use.</param>
  53314. <param name="query">The search query.</param>
  53315. <param name="cancellationToken">The cancellation token.</param>
  53316. <exception cref="T:System.ArgumentOutOfRangeException">
  53317. <paramref name="algorithm"/> is not supported.
  53318. </exception>
  53319. <exception cref="T:System.ArgumentNullException">
  53320. <para><paramref name="uids"/> is <c>null</c>.</para>
  53321. <para>-or-</para>
  53322. <para><paramref name="query"/> is <c>null</c>.</para>
  53323. </exception>
  53324. <exception cref="T:System.ArgumentException">
  53325. <para><paramref name="uids"/> is empty.</para>
  53326. <para>-or-</para>
  53327. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  53328. </exception>
  53329. <exception cref="T:System.NotSupportedException">
  53330. <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
  53331. <para>-or-</para>
  53332. <para>The server does not support threading search results.</para>
  53333. </exception>
  53334. <exception cref="T:System.ObjectDisposedException">
  53335. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  53336. </exception>
  53337. <exception cref="T:MailKit.ServiceNotConnectedException">
  53338. The <see cref="T:MailKit.IMailStore"/> is not connected.
  53339. </exception>
  53340. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  53341. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  53342. </exception>
  53343. <exception cref="T:MailKit.FolderNotOpenException">
  53344. The folder is not currently open.
  53345. </exception>
  53346. <exception cref="T:System.OperationCanceledException">
  53347. The operation was canceled via the cancellation token.
  53348. </exception>
  53349. <exception cref="T:System.IO.IOException">
  53350. An I/O error occurred.
  53351. </exception>
  53352. <exception cref="T:MailKit.ProtocolException">
  53353. The server's response contained unexpected tokens.
  53354. </exception>
  53355. <exception cref="T:MailKit.CommandException">
  53356. The command failed.
  53357. </exception>
  53358. </member>
  53359. <member name="M:MailKit.MailFolder.ThreadAsync(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.ThreadingAlgorithm,MailKit.Search.SearchQuery,System.Threading.CancellationToken)">
  53360. <summary>
  53361. Asynchronously thread the messages in the folder that match the search query using the specified threading algorithm.
  53362. </summary>
  53363. <remarks>
  53364. The <see cref="P:MailKit.MessageThread.UniqueId"/> can be used with methods such as
  53365. <see cref="M:MailKit.IMailFolder.GetMessage(MailKit.UniqueId,System.Threading.CancellationToken,MailKit.ITransferProgress)"/>.
  53366. </remarks>
  53367. <returns>An array of message threads.</returns>
  53368. <param name="uids">The subset of UIDs</param>
  53369. <param name="algorithm">The threading algorithm to use.</param>
  53370. <param name="query">The search query.</param>
  53371. <param name="cancellationToken">The cancellation token.</param>
  53372. <exception cref="T:System.ArgumentOutOfRangeException">
  53373. <paramref name="algorithm"/> is not supported.
  53374. </exception>
  53375. <exception cref="T:System.ArgumentNullException">
  53376. <para><paramref name="uids"/> is <c>null</c>.</para>
  53377. <para>-or-</para>
  53378. <para><paramref name="query"/> is <c>null</c>.</para>
  53379. </exception>
  53380. <exception cref="T:System.ArgumentException">
  53381. <para><paramref name="uids"/> is empty.</para>
  53382. <para>-or-</para>
  53383. <para>One or more of the <paramref name="uids"/> is invalid.</para>
  53384. </exception>
  53385. <exception cref="T:System.NotSupportedException">
  53386. <para>One or more search terms in the <paramref name="query"/> are not supported.</para>
  53387. <para>-or-</para>
  53388. <para>The server does not support threading search results.</para>
  53389. </exception>
  53390. <exception cref="T:System.ObjectDisposedException">
  53391. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  53392. </exception>
  53393. <exception cref="T:MailKit.ServiceNotConnectedException">
  53394. The <see cref="T:MailKit.IMailStore"/> is not connected.
  53395. </exception>
  53396. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  53397. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  53398. </exception>
  53399. <exception cref="T:MailKit.FolderNotOpenException">
  53400. The folder is not currently open.
  53401. </exception>
  53402. <exception cref="T:System.OperationCanceledException">
  53403. The operation was canceled via the cancellation token.
  53404. </exception>
  53405. <exception cref="T:System.IO.IOException">
  53406. An I/O error occurred.
  53407. </exception>
  53408. <exception cref="T:MailKit.ProtocolException">
  53409. The server's response contained unexpected tokens.
  53410. </exception>
  53411. <exception cref="T:MailKit.CommandException">
  53412. The command failed.
  53413. </exception>
  53414. </member>
  53415. <member name="E:MailKit.MailFolder.Opened">
  53416. <summary>
  53417. Occurs when the folder is opened.
  53418. </summary>
  53419. <remarks>
  53420. The <see cref="E:MailKit.MailFolder.Opened"/> event is emitted when the folder is opened.
  53421. </remarks>
  53422. </member>
  53423. <member name="M:MailKit.MailFolder.OnOpened">
  53424. <summary>
  53425. Raise the opened event.
  53426. </summary>
  53427. <remarks>
  53428. Raises the opened event.
  53429. </remarks>
  53430. </member>
  53431. <member name="E:MailKit.MailFolder.Closed">
  53432. <summary>
  53433. Occurs when the folder is closed.
  53434. </summary>
  53435. <remarks>
  53436. The <see cref="E:MailKit.MailFolder.Closed"/> event is emitted when the folder is closed.
  53437. </remarks>
  53438. </member>
  53439. <member name="M:MailKit.MailFolder.OnClosed">
  53440. <summary>
  53441. Raise the closed event.
  53442. </summary>
  53443. <remarks>
  53444. Raises the closed event.
  53445. </remarks>
  53446. </member>
  53447. <member name="E:MailKit.MailFolder.Deleted">
  53448. <summary>
  53449. Occurs when the folder is deleted.
  53450. </summary>
  53451. <remarks>
  53452. The <see cref="E:MailKit.MailFolder.Deleted"/> event is emitted when the folder is deleted.
  53453. </remarks>
  53454. </member>
  53455. <member name="M:MailKit.MailFolder.OnDeleted">
  53456. <summary>
  53457. Raise the deleted event.
  53458. </summary>
  53459. <remarks>
  53460. Raises the deleted event.
  53461. </remarks>
  53462. </member>
  53463. <member name="E:MailKit.MailFolder.Renamed">
  53464. <summary>
  53465. Occurs when the folder is renamed.
  53466. </summary>
  53467. <remarks>
  53468. The <see cref="E:MailKit.MailFolder.Renamed"/> event is emitted when the folder is renamed.
  53469. </remarks>
  53470. </member>
  53471. <member name="M:MailKit.MailFolder.OnRenamed(System.String,System.String)">
  53472. <summary>
  53473. Raise the renamed event.
  53474. </summary>
  53475. <remarks>
  53476. Raises the renamed event.
  53477. </remarks>
  53478. <param name="oldName">The old name of the folder.</param>
  53479. <param name="newName">The new name of the folder.</param>
  53480. </member>
  53481. <member name="M:MailKit.MailFolder.OnParentFolderRenamed">
  53482. <summary>
  53483. Notifies the folder that a parent folder has been renamed.
  53484. </summary>
  53485. <remarks>
  53486. <see cref="T:MailKit.IMailFolder"/> implementations should override this method
  53487. to update their state (such as updating their <see cref="P:MailKit.MailFolder.FullName"/>
  53488. property).
  53489. </remarks>
  53490. </member>
  53491. <member name="E:MailKit.MailFolder.Subscribed">
  53492. <summary>
  53493. Occurs when the folder is subscribed.
  53494. </summary>
  53495. <remarks>
  53496. The <see cref="E:MailKit.MailFolder.Subscribed"/> event is emitted when the folder is subscribed.
  53497. </remarks>
  53498. </member>
  53499. <member name="M:MailKit.MailFolder.OnSubscribed">
  53500. <summary>
  53501. Raise the subscribed event.
  53502. </summary>
  53503. <remarks>
  53504. Raises the subscribed event.
  53505. </remarks>
  53506. </member>
  53507. <member name="E:MailKit.MailFolder.Unsubscribed">
  53508. <summary>
  53509. Occurs when the folder is unsubscribed.
  53510. </summary>
  53511. <remarks>
  53512. The <see cref="E:MailKit.MailFolder.Unsubscribed"/> event is emitted when the folder is unsubscribed.
  53513. </remarks>
  53514. </member>
  53515. <member name="M:MailKit.MailFolder.OnUnsubscribed">
  53516. <summary>
  53517. Raise the unsubscribed event.
  53518. </summary>
  53519. <remarks>
  53520. Raises the unsubscribed event.
  53521. </remarks>
  53522. </member>
  53523. <member name="E:MailKit.MailFolder.MessageExpunged">
  53524. <summary>
  53525. Occurs when a message is expunged from the folder.
  53526. </summary>
  53527. <remarks>
  53528. The <see cref="E:MailKit.MailFolder.MessageExpunged"/> event is emitted when a message is expunged from the folder.
  53529. </remarks>
  53530. <example>
  53531. <code language="c#" source="Examples\ImapIdleExample.cs"/>
  53532. </example>
  53533. </member>
  53534. <member name="M:MailKit.MailFolder.OnMessageExpunged(MailKit.MessageEventArgs)">
  53535. <summary>
  53536. Raise the message expunged event.
  53537. </summary>
  53538. <remarks>
  53539. Raises the message expunged event.
  53540. </remarks>
  53541. <param name="args">The message expunged event args.</param>
  53542. </member>
  53543. <member name="E:MailKit.MailFolder.MessagesVanished">
  53544. <summary>
  53545. Occurs when a message vanishes from the folder.
  53546. </summary>
  53547. <remarks>
  53548. The <see cref="E:MailKit.MailFolder.MessagesVanished"/> event is emitted when messages vanish from the folder.
  53549. </remarks>
  53550. </member>
  53551. <member name="M:MailKit.MailFolder.OnMessagesVanished(MailKit.MessagesVanishedEventArgs)">
  53552. <summary>
  53553. Raise the messages vanished event.
  53554. </summary>
  53555. <remarks>
  53556. Raises the messages vanished event.
  53557. </remarks>
  53558. <param name="args">The messages vanished event args.</param>
  53559. </member>
  53560. <member name="E:MailKit.MailFolder.MessageFlagsChanged">
  53561. <summary>
  53562. Occurs when flags changed on a message.
  53563. </summary>
  53564. <remarks>
  53565. The <see cref="E:MailKit.MailFolder.MessageFlagsChanged"/> event is emitted when the flags for a message are changed.
  53566. </remarks>
  53567. <example>
  53568. <code language="c#" source="Examples\ImapIdleExample.cs"/>
  53569. </example>
  53570. </member>
  53571. <member name="M:MailKit.MailFolder.OnMessageFlagsChanged(MailKit.MessageFlagsChangedEventArgs)">
  53572. <summary>
  53573. Raise the message flags changed event.
  53574. </summary>
  53575. <remarks>
  53576. Raises the message flags changed event.
  53577. </remarks>
  53578. <param name="args">The message flags changed event args.</param>
  53579. </member>
  53580. <member name="E:MailKit.MailFolder.MessageLabelsChanged">
  53581. <summary>
  53582. Occurs when labels changed on a message.
  53583. </summary>
  53584. <remarks>
  53585. The <see cref="E:MailKit.MailFolder.MessageLabelsChanged"/> event is emitted when the labels for a message are changed.
  53586. </remarks>
  53587. </member>
  53588. <member name="M:MailKit.MailFolder.OnMessageLabelsChanged(MailKit.MessageLabelsChangedEventArgs)">
  53589. <summary>
  53590. Raise the message labels changed event.
  53591. </summary>
  53592. <remarks>
  53593. Raises the message labels changed event.
  53594. </remarks>
  53595. <param name="args">The message labels changed event args.</param>
  53596. </member>
  53597. <member name="E:MailKit.MailFolder.AnnotationsChanged">
  53598. <summary>
  53599. Occurs when annotations changed on a message.
  53600. </summary>
  53601. <remarks>
  53602. The <see cref="E:MailKit.MailFolder.AnnotationsChanged"/> event is emitted when the annotations for a message are changed.
  53603. </remarks>
  53604. </member>
  53605. <member name="M:MailKit.MailFolder.OnAnnotationsChanged(MailKit.AnnotationsChangedEventArgs)">
  53606. <summary>
  53607. Raise the message annotations changed event.
  53608. </summary>
  53609. <remarks>
  53610. Raises the message annotations changed event.
  53611. </remarks>
  53612. <param name="args">The message annotations changed event args.</param>
  53613. </member>
  53614. <member name="E:MailKit.MailFolder.MessageSummaryFetched">
  53615. <summary>
  53616. Occurs when a message summary is fetched from the folder.
  53617. </summary>
  53618. <remarks>
  53619. <para>Emitted when a message summary is fetched from the folder.</para>
  53620. <para>When multiple message summaries are being fetched from a remote folder,
  53621. it is possible that the connection will drop or some other exception will
  53622. occur, causing the Fetch method to fail and lose all of the data that has been
  53623. downloaded up to that point, requiring the client to request the same set of
  53624. message summaries all over again after it reconnects. This is obviously
  53625. inefficient. To alleviate this potential problem, this event will be emitted
  53626. as soon as the <see cref="T:MailKit.IMailFolder"/> successfully parses each untagged FETCH
  53627. response from the server, allowing the client to commit this data immediately to
  53628. its local cache.</para>
  53629. <note type="note">Depending on the IMAP server, it is possible that the
  53630. <see cref="E:MailKit.MailFolder.MessageSummaryFetched"/> event will be emitted for the same message
  53631. multiple times if the IMAP server happens to split the requested fields into
  53632. multiple untagged FETCH responses. Use the <see cref="P:MailKit.IMessageSummary.Fields"/>
  53633. property to determine which f<see cref="T:MailKit.IMessageSummary"/> properties have
  53634. been populated.</note>
  53635. </remarks>
  53636. </member>
  53637. <member name="M:MailKit.MailFolder.OnMessageSummaryFetched(MailKit.IMessageSummary)">
  53638. <summary>
  53639. Raise the message summary fetched event.
  53640. </summary>
  53641. <remarks>
  53642. <para>Raises the message summary fetched event.</para>
  53643. <para>When multiple message summaries are being fetched from a remote folder,
  53644. it is possible that the connection will drop or some other exception will
  53645. occur, causing the Fetch method to fail and lose all of the data that has been
  53646. downloaded up to that point, requiring the client to request the same set of
  53647. message summaries all over again after it reconnects. This is obviously
  53648. inefficient. To alleviate this potential problem, this event will be emitted
  53649. as soon as the <see cref="T:MailKit.IMailFolder"/> successfully parses each untagged FETCH
  53650. response from the server, allowing the client to commit this data immediately to
  53651. its local cache.</para>
  53652. <note type="note">Depending on the IMAP server, it is possible that
  53653. <see cref="M:MailKit.MailFolder.OnMessageSummaryFetched(MailKit.IMessageSummary)"/> will be invoked for the same message
  53654. multiple times if the IMAP server happens to split the requested fields into
  53655. multiple untagged FETCH responses. Use the <see cref="P:MailKit.IMessageSummary.Fields"/>
  53656. property to determine which f<see cref="T:MailKit.IMessageSummary"/> properties have
  53657. been populated.</note>
  53658. </remarks>
  53659. <param name="message">The message summary.</param>
  53660. </member>
  53661. <member name="E:MailKit.MailFolder.MetadataChanged">
  53662. <summary>
  53663. Occurs when metadata changes.
  53664. </summary>
  53665. <remarks>
  53666. The <see cref="E:MailKit.MailFolder.MetadataChanged"/> event is emitted when metadata changes.
  53667. </remarks>
  53668. </member>
  53669. <member name="M:MailKit.MailFolder.OnMetadataChanged(MailKit.Metadata)">
  53670. <summary>
  53671. Raise the metadata changed event.
  53672. </summary>
  53673. <remarks>
  53674. Raises the metadata changed event.
  53675. </remarks>
  53676. <param name="metadata">The metadata that changed.</param>
  53677. </member>
  53678. <member name="E:MailKit.MailFolder.ModSeqChanged">
  53679. <summary>
  53680. Occurs when the mod-sequence changed on a message.
  53681. </summary>
  53682. <remarks>
  53683. The <see cref="E:MailKit.MailFolder.ModSeqChanged"/> event is emitted when the mod-sequence for a message is changed.
  53684. </remarks>
  53685. </member>
  53686. <member name="M:MailKit.MailFolder.OnModSeqChanged(MailKit.ModSeqChangedEventArgs)">
  53687. <summary>
  53688. Raise the message mod-sequence changed event.
  53689. </summary>
  53690. <remarks>
  53691. Raises the message mod-sequence changed event.
  53692. </remarks>
  53693. <param name="args">The mod-sequence changed event args.</param>
  53694. </member>
  53695. <member name="E:MailKit.MailFolder.HighestModSeqChanged">
  53696. <summary>
  53697. Occurs when the highest mod-sequence changes.
  53698. </summary>
  53699. <remarks>
  53700. The <see cref="E:MailKit.MailFolder.HighestModSeqChanged"/> event is emitted whenever the <see cref="P:MailKit.MailFolder.HighestModSeq"/> value changes.
  53701. </remarks>
  53702. </member>
  53703. <member name="M:MailKit.MailFolder.OnHighestModSeqChanged">
  53704. <summary>
  53705. Raise the highest mod-sequence changed event.
  53706. </summary>
  53707. <remarks>
  53708. Raises the highest mod-sequence changed event.
  53709. </remarks>
  53710. </member>
  53711. <member name="E:MailKit.MailFolder.UidNextChanged">
  53712. <summary>
  53713. Occurs when the next UID changes.
  53714. </summary>
  53715. <remarks>
  53716. The <see cref="E:MailKit.MailFolder.UidNextChanged"/> event is emitted whenever the <see cref="P:MailKit.MailFolder.UidNext"/> value changes.
  53717. </remarks>
  53718. </member>
  53719. <member name="M:MailKit.MailFolder.OnUidNextChanged">
  53720. <summary>
  53721. Raise the next UID changed event.
  53722. </summary>
  53723. <remarks>
  53724. Raises the next UID changed event.
  53725. </remarks>
  53726. </member>
  53727. <member name="E:MailKit.MailFolder.UidValidityChanged">
  53728. <summary>
  53729. Occurs when the UID validity changes.
  53730. </summary>
  53731. <remarks>
  53732. The <see cref="E:MailKit.MailFolder.UidValidityChanged"/> event is emitted whenever the <see cref="P:MailKit.MailFolder.UidValidity"/> value changes.
  53733. </remarks>
  53734. </member>
  53735. <member name="M:MailKit.MailFolder.OnUidValidityChanged">
  53736. <summary>
  53737. Raise the uid validity changed event.
  53738. </summary>
  53739. <remarks>
  53740. Raises the uid validity changed event.
  53741. </remarks>
  53742. </member>
  53743. <member name="E:MailKit.MailFolder.IdChanged">
  53744. <summary>
  53745. Occurs when the folder ID changes.
  53746. </summary>
  53747. <remarks>
  53748. The <see cref="E:MailKit.MailFolder.IdChanged"/> event is emitted whenever the <see cref="P:MailKit.MailFolder.Id"/> value changes.
  53749. </remarks>
  53750. </member>
  53751. <member name="M:MailKit.MailFolder.OnIdChanged">
  53752. <summary>
  53753. Raise the ID changed event.
  53754. </summary>
  53755. <remarks>
  53756. Raises the ID changed event.
  53757. </remarks>
  53758. </member>
  53759. <member name="E:MailKit.MailFolder.SizeChanged">
  53760. <summary>
  53761. Occurs when the folder size changes.
  53762. </summary>
  53763. <remarks>
  53764. The <see cref="E:MailKit.MailFolder.SizeChanged"/> event is emitted whenever the <see cref="P:MailKit.MailFolder.Size"/> value changes.
  53765. </remarks>
  53766. </member>
  53767. <member name="M:MailKit.MailFolder.OnSizeChanged">
  53768. <summary>
  53769. Raise the size changed event.
  53770. </summary>
  53771. <remarks>
  53772. Raises the size changed event.
  53773. </remarks>
  53774. </member>
  53775. <member name="E:MailKit.MailFolder.CountChanged">
  53776. <summary>
  53777. Occurs when the message count changes.
  53778. </summary>
  53779. <remarks>
  53780. The <see cref="E:MailKit.MailFolder.CountChanged"/> event is emitted whenever the <see cref="P:MailKit.MailFolder.Count"/> value changes.
  53781. </remarks>
  53782. <example>
  53783. <code language="c#" source="Examples\ImapIdleExample.cs"/>
  53784. </example>
  53785. </member>
  53786. <member name="M:MailKit.MailFolder.OnCountChanged">
  53787. <summary>
  53788. Raise the message count changed event.
  53789. </summary>
  53790. <remarks>
  53791. Raises the message count changed event.
  53792. </remarks>
  53793. </member>
  53794. <member name="E:MailKit.MailFolder.RecentChanged">
  53795. <summary>
  53796. Occurs when the recent message count changes.
  53797. </summary>
  53798. <remarks>
  53799. The <see cref="E:MailKit.MailFolder.RecentChanged"/> event is emitted whenever the <see cref="P:MailKit.MailFolder.Recent"/> value changes.
  53800. </remarks>
  53801. </member>
  53802. <member name="M:MailKit.MailFolder.OnRecentChanged">
  53803. <summary>
  53804. Raise the recent message count changed event.
  53805. </summary>
  53806. <remarks>
  53807. Raises the recent message count changed event.
  53808. </remarks>
  53809. </member>
  53810. <member name="E:MailKit.MailFolder.UnreadChanged">
  53811. <summary>
  53812. Occurs when the unread message count changes.
  53813. </summary>
  53814. <remarks>
  53815. The <see cref="E:MailKit.MailFolder.UnreadChanged"/> event is emitted whenever the <see cref="P:MailKit.MailFolder.Unread"/> value changes.
  53816. </remarks>
  53817. </member>
  53818. <member name="M:MailKit.MailFolder.OnUnreadChanged">
  53819. <summary>
  53820. Raise the unread message count changed event.
  53821. </summary>
  53822. <remarks>
  53823. Raises the unread message count changed event.
  53824. </remarks>
  53825. </member>
  53826. <member name="M:MailKit.MailFolder.GetEnumerator">
  53827. <summary>
  53828. Get an enumerator for the messages in the folder.
  53829. </summary>
  53830. <remarks>
  53831. Gets an enumerator for the messages in the folder.
  53832. </remarks>
  53833. <returns>The enumerator.</returns>
  53834. <exception cref="T:System.ObjectDisposedException">
  53835. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  53836. </exception>
  53837. <exception cref="T:MailKit.ServiceNotConnectedException">
  53838. The <see cref="T:MailKit.IMailStore"/> is not connected.
  53839. </exception>
  53840. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  53841. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  53842. </exception>
  53843. <exception cref="T:MailKit.FolderNotOpenException">
  53844. The folder is not currently open.
  53845. </exception>
  53846. </member>
  53847. <member name="M:MailKit.MailFolder.System#Collections#IEnumerable#GetEnumerator">
  53848. <summary>
  53849. Get an enumerator for the messages in the folder.
  53850. </summary>
  53851. <remarks>
  53852. Gets an enumerator for the messages in the folder.
  53853. </remarks>
  53854. <returns>The enumerator.</returns>
  53855. <exception cref="T:System.ObjectDisposedException">
  53856. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  53857. </exception>
  53858. <exception cref="T:MailKit.ServiceNotConnectedException">
  53859. The <see cref="T:MailKit.IMailStore"/> is not connected.
  53860. </exception>
  53861. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  53862. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  53863. </exception>
  53864. <exception cref="T:MailKit.FolderNotOpenException">
  53865. The folder is not currently open.
  53866. </exception>
  53867. </member>
  53868. <member name="M:MailKit.MailFolder.ToString">
  53869. <summary>
  53870. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.MailFolder"/>.
  53871. </summary>
  53872. <remarks>
  53873. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.MailFolder"/>.
  53874. </remarks>
  53875. <returns>A <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.MailFolder"/>.</returns>
  53876. </member>
  53877. <member name="T:MailKit.MailService">
  53878. <summary>
  53879. An abstract mail service implementation.
  53880. </summary>
  53881. <remarks>
  53882. An abstract mail service implementation.
  53883. </remarks>
  53884. </member>
  53885. <member name="M:MailKit.MailService.#ctor(MailKit.IProtocolLogger)">
  53886. <summary>
  53887. Initializes a new instance of the <see cref="T:MailKit.MailService"/> class.
  53888. </summary>
  53889. <remarks>
  53890. Initializes a new instance of the <see cref="T:MailKit.MailService"/> class.
  53891. </remarks>
  53892. <param name="protocolLogger">The protocol logger.</param>
  53893. <exception cref="T:System.ArgumentNullException">
  53894. <paramref name="protocolLogger"/> is <c>null</c>.
  53895. </exception>
  53896. </member>
  53897. <member name="M:MailKit.MailService.#ctor">
  53898. <summary>
  53899. Initializes a new instance of the <see cref="T:MailKit.MailService"/> class.
  53900. </summary>
  53901. <remarks>
  53902. Initializes a new instance of the <see cref="T:MailKit.MailService"/> class.
  53903. </remarks>
  53904. </member>
  53905. <member name="M:MailKit.MailService.Finalize">
  53906. <summary>
  53907. Releases unmanaged resources and performs other cleanup operations before the
  53908. <see cref="T:MailKit.MailService"/> is reclaimed by garbage collection.
  53909. </summary>
  53910. <remarks>
  53911. Releases unmanaged resources and performs other cleanup operations before the
  53912. <see cref="T:MailKit.MailService"/> is reclaimed by garbage collection.
  53913. </remarks>
  53914. </member>
  53915. <member name="P:MailKit.MailService.SyncRoot">
  53916. <summary>
  53917. Gets an object that can be used to synchronize access to the service.
  53918. </summary>
  53919. <remarks>
  53920. <para>Gets an object that can be used to synchronize access to the service.</para>
  53921. </remarks>
  53922. <value>The sync root.</value>
  53923. </member>
  53924. <member name="P:MailKit.MailService.Protocol">
  53925. <summary>
  53926. Gets the protocol supported by the message service.
  53927. </summary>
  53928. <remarks>
  53929. Gets the protocol supported by the message service.
  53930. </remarks>
  53931. <value>The protocol.</value>
  53932. </member>
  53933. <member name="P:MailKit.MailService.ProtocolLogger">
  53934. <summary>
  53935. Get the protocol logger.
  53936. </summary>
  53937. <remarks>
  53938. Gets the protocol logger.
  53939. </remarks>
  53940. <value>The protocol logger.</value>
  53941. </member>
  53942. <member name="P:MailKit.MailService.SslProtocols">
  53943. <summary>
  53944. Gets or sets the SSL and TLS protocol versions that the client is allowed to use.
  53945. </summary>
  53946. <remarks>
  53947. <para>Gets or sets the SSL and TLS protocol versions that the client is allowed to use.</para>
  53948. <para>By default, MailKit initializes this value to support only TLS v1.1 and greater and
  53949. does not support TLS v1.0 or any version of SSL due to those protocols no longer being considered
  53950. secure.</para>
  53951. <para>This property should be set before calling any of the
  53952. <a href="Overload_MailKit_MailService_Connect.htm">Connect</a> methods.</para>
  53953. </remarks>
  53954. <value>The SSL and TLS protocol versions that are supported.</value>
  53955. </member>
  53956. <member name="P:MailKit.MailService.ClientCertificates">
  53957. <summary>
  53958. Gets or sets the client SSL certificates.
  53959. </summary>
  53960. <remarks>
  53961. <para>Some servers may require the client SSL certificates in order
  53962. to allow the user to connect.</para>
  53963. <para>This property should be set before calling any of the
  53964. <a href="Overload_MailKit_MailService_Connect.htm">Connect</a> methods.</para>
  53965. </remarks>
  53966. <value>The client SSL certificates.</value>
  53967. </member>
  53968. <member name="P:MailKit.MailService.CheckCertificateRevocation">
  53969. <summary>
  53970. Get or set whether connecting via SSL/TLS should check certificate revocation.
  53971. </summary>
  53972. <remarks>
  53973. <para>Gets or sets whether connecting via SSL/TLS should check certificate revocation.</para>
  53974. <para>Normally, the value of this property should be set to <c>true</c> (the default) for security
  53975. reasons, but there are times when it may be necessary to set it to <c>false</c>.</para>
  53976. <para>For example, most Certificate Authorities are probably pretty good at keeping their CRL and/or
  53977. OCSP servers up 24/7, but occasionally they do go down or are otherwise unreachable due to other
  53978. network problems between the client and the Certificate Authority. When this happens, it becomes
  53979. impossible to check the revocation status of one or more of the certificates in the chain
  53980. resulting in an <see cref="T:MailKit.Security.SslHandshakeException"/> being thrown in the
  53981. <a href="Overload_MailKit_MailService_Connect.htm">Connect</a> method. If this becomes a problem,
  53982. it may become desirable to set <see cref="P:MailKit.MailService.CheckCertificateRevocation"/> to <c>false</c>.</para>
  53983. </remarks>
  53984. <value><c>true</c> if certificate revocation should be checked; otherwise, <c>false</c>.</value>
  53985. </member>
  53986. <member name="P:MailKit.MailService.ServerCertificateValidationCallback">
  53987. <summary>
  53988. Get or sets a callback function to validate the server certificate.
  53989. </summary>
  53990. <remarks>
  53991. <para>Gets or sets a callback function to validate the server certificate.</para>
  53992. <para>This property should be set before calling any of the
  53993. <a href="Overload_MailKit_MailService_Connect.htm">Connect</a> methods.</para>
  53994. </remarks>
  53995. <example>
  53996. <code language="c#" source="Examples\SslCertificateValidation.cs"/>
  53997. </example>
  53998. <value>The server certificate validation callback function.</value>
  53999. </member>
  54000. <member name="P:MailKit.MailService.LocalEndPoint">
  54001. <summary>
  54002. Get or set the local IP end point to use when connecting to the remote host.
  54003. </summary>
  54004. <remarks>
  54005. Gets or sets the local IP end point to use when connecting to the remote host.
  54006. </remarks>
  54007. <value>The local IP end point or <c>null</c> to use the default end point.</value>
  54008. </member>
  54009. <member name="P:MailKit.MailService.ProxyClient">
  54010. <summary>
  54011. Get or set the proxy client to use when connecting to a remote host.
  54012. </summary>
  54013. <remarks>
  54014. Gets or sets the proxy client to use when connecting to a remote host via any of the
  54015. <a href="Overload_MailKit_MailService_Connect.htm">Connect</a> methods.
  54016. </remarks>
  54017. <value>The proxy client.</value>
  54018. </member>
  54019. <member name="P:MailKit.MailService.AuthenticationMechanisms">
  54020. <summary>
  54021. Gets the authentication mechanisms supported by the mail server.
  54022. </summary>
  54023. <remarks>
  54024. The authentication mechanisms are queried as part of the
  54025. <a href="Overload_MailKit_MailService_Connect.htm">Connect</a> method.
  54026. </remarks>
  54027. <value>The authentication mechanisms.</value>
  54028. </member>
  54029. <member name="P:MailKit.MailService.IsConnected">
  54030. <summary>
  54031. Gets whether or not the client is currently connected to an mail server.
  54032. </summary>
  54033. <remarks>
  54034. <para>The <see cref="P:MailKit.MailService.IsConnected"/> state is set to <c>true</c> immediately after
  54035. one of the <a href="Overload_MailKit_MailService_Connect.htm">Connect</a>
  54036. methods succeeds and is not set back to <c>false</c> until either the client
  54037. is disconnected via <see cref="M:MailKit.MailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/> or until a
  54038. <see cref="T:MailKit.ProtocolException"/> is thrown while attempting to read or write to
  54039. the underlying network socket.</para>
  54040. <para>When an <see cref="T:MailKit.ProtocolException"/> is caught, the connection state of the
  54041. <see cref="T:MailKit.MailService"/> should be checked before continuing.</para>
  54042. </remarks>
  54043. <value><c>true</c> if the client is connected; otherwise, <c>false</c>.</value>
  54044. </member>
  54045. <member name="P:MailKit.MailService.IsSecure">
  54046. <summary>
  54047. Get whether or not the connection is secure (typically via SSL or TLS).
  54048. </summary>
  54049. <remarks>
  54050. Gets whether or not the connection is secure (typically via SSL or TLS).
  54051. </remarks>
  54052. <value><c>true</c> if the connection is secure; otherwise, <c>false</c>.</value>
  54053. </member>
  54054. <member name="P:MailKit.MailService.IsAuthenticated">
  54055. <summary>
  54056. Get whether or not the client is currently authenticated with the mail server.
  54057. </summary>
  54058. <remarks>
  54059. <para>Gets whether or not the client is currently authenticated with the mail server.</para>
  54060. <para>To authenticate with the mail server, use one of the
  54061. <a href="Overload_MailKit_MailService_Authenticate.htm">Authenticate</a> methods
  54062. or any of the Async alternatives.</para>
  54063. </remarks>
  54064. <value><c>true</c> if the client is authenticated; otherwise, <c>false</c>.</value>
  54065. </member>
  54066. <member name="P:MailKit.MailService.Timeout">
  54067. <summary>
  54068. Gets or sets the timeout for network streaming operations, in milliseconds.
  54069. </summary>
  54070. <remarks>
  54071. Gets or sets the underlying socket stream's <see cref="P:System.IO.Stream.ReadTimeout"/>
  54072. and <see cref="P:System.IO.Stream.WriteTimeout"/> values.
  54073. </remarks>
  54074. <value>The timeout in milliseconds.</value>
  54075. </member>
  54076. <!-- Badly formed XML comment ignored for member "M:MailKit.MailService.DefaultServerCertificateValidationCallback(System.Object,System.Security.Cryptography.X509Certificates.X509Certificate,System.Security.Cryptography.X509Certificates.X509Chain,System.Net.Security.SslPolicyErrors)" -->
  54077. <member name="M:MailKit.MailService.Connect(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
  54078. <summary>
  54079. Establish a connection to the specified mail server.
  54080. </summary>
  54081. <remarks>
  54082. Establishes a connection to the specified mail server.
  54083. </remarks>
  54084. <example>
  54085. <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessage"/>
  54086. </example>
  54087. <param name="host">The host name to connect to.</param>
  54088. <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
  54089. <param name="options">The secure socket options to when connecting.</param>
  54090. <param name="cancellationToken">The cancellation token.</param>
  54091. <exception cref="T:System.ArgumentNullException">
  54092. <paramref name="host"/> is <c>null</c>.
  54093. </exception>
  54094. <exception cref="T:System.ArgumentOutOfRangeException">
  54095. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  54096. </exception>
  54097. <exception cref="T:System.ArgumentException">
  54098. The <paramref name="host"/> is a zero-length string.
  54099. </exception>
  54100. <exception cref="T:System.ObjectDisposedException">
  54101. The <see cref="T:MailKit.MailService"/> has been disposed.
  54102. </exception>
  54103. <exception cref="T:System.InvalidOperationException">
  54104. The <see cref="T:MailKit.MailService"/> is already connected.
  54105. </exception>
  54106. <exception cref="T:System.OperationCanceledException">
  54107. The operation was canceled via the cancellation token.
  54108. </exception>
  54109. <exception cref="T:System.Net.Sockets.SocketException">
  54110. A socket error occurred trying to connect to the remote host.
  54111. </exception>
  54112. <exception cref="T:System.IO.IOException">
  54113. An I/O error occurred.
  54114. </exception>
  54115. <exception cref="T:MailKit.ProtocolException">
  54116. A protocol error occurred.
  54117. </exception>
  54118. </member>
  54119. <member name="M:MailKit.MailService.ConnectAsync(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
  54120. <summary>
  54121. Asynchronously establish a connection to the specified mail server.
  54122. </summary>
  54123. <remarks>
  54124. Asynchronously establishes a connection to the specified mail server.
  54125. </remarks>
  54126. <returns>An asynchronous task context.</returns>
  54127. <param name="host">The host name to connect to.</param>
  54128. <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
  54129. <param name="options">The secure socket options to when connecting.</param>
  54130. <param name="cancellationToken">The cancellation token.</param>
  54131. <exception cref="T:System.ArgumentNullException">
  54132. <paramref name="host"/> is <c>null</c>.
  54133. </exception>
  54134. <exception cref="T:System.ArgumentOutOfRangeException">
  54135. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  54136. </exception>
  54137. <exception cref="T:System.ArgumentException">
  54138. The <paramref name="host"/> is a zero-length string.
  54139. </exception>
  54140. <exception cref="T:System.ObjectDisposedException">
  54141. The <see cref="T:MailKit.MailService"/> has been disposed.
  54142. </exception>
  54143. <exception cref="T:System.InvalidOperationException">
  54144. The <see cref="T:MailKit.MailService"/> is already connected.
  54145. </exception>
  54146. <exception cref="T:System.OperationCanceledException">
  54147. The operation was canceled via the cancellation token.
  54148. </exception>
  54149. <exception cref="T:System.Net.Sockets.SocketException">
  54150. A socket error occurred trying to connect to the remote host.
  54151. </exception>
  54152. <exception cref="T:System.IO.IOException">
  54153. An I/O error occurred.
  54154. </exception>
  54155. <exception cref="T:MailKit.ProtocolException">
  54156. A protocol error occurred.
  54157. </exception>
  54158. </member>
  54159. <member name="M:MailKit.MailService.Connect(System.Net.Sockets.Socket,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
  54160. <summary>
  54161. Establish a connection to the specified mail server using the provided socket.
  54162. </summary>
  54163. <remarks>
  54164. <para>Establish a connection to the specified mail server using the provided socket.</para>
  54165. <para>If a successful connection is made, the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/>
  54166. property will be populated.</para>
  54167. </remarks>
  54168. <param name="socket">The socket to use for the connection.</param>
  54169. <param name="host">The host name to connect to.</param>
  54170. <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
  54171. <param name="options">The secure socket options to when connecting.</param>
  54172. <param name="cancellationToken">The cancellation token.</param>
  54173. <exception cref="T:System.ArgumentNullException">
  54174. <para><paramref name="socket"/> is <c>null</c>.</para>
  54175. <para>-or-</para>
  54176. <para><paramref name="host"/> is <c>null</c>.</para>
  54177. </exception>
  54178. <exception cref="T:System.ArgumentOutOfRangeException">
  54179. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  54180. </exception>
  54181. <exception cref="T:System.ArgumentException">
  54182. <para><paramref name="socket"/> is not connected.</para>
  54183. <para>-or-</para>
  54184. <para>The <paramref name="host"/> is a zero-length string.</para>
  54185. </exception>
  54186. <exception cref="T:System.InvalidOperationException">
  54187. The <see cref="T:MailKit.IMailService"/> is already connected.
  54188. </exception>
  54189. <exception cref="T:System.OperationCanceledException">
  54190. The operation was canceled via the cancellation token.
  54191. </exception>
  54192. <exception cref="T:System.IO.IOException">
  54193. An I/O error occurred.
  54194. </exception>
  54195. <exception cref="T:MailKit.CommandException">
  54196. The command was rejected by the mail server.
  54197. </exception>
  54198. <exception cref="T:MailKit.ProtocolException">
  54199. The server responded with an unexpected token.
  54200. </exception>
  54201. </member>
  54202. <member name="M:MailKit.MailService.ConnectAsync(System.Net.Sockets.Socket,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
  54203. <summary>
  54204. Asynchronously establish a connection to the specified mail server using the provided socket.
  54205. </summary>
  54206. <remarks>
  54207. <para>Asynchronously establishes a connection to the specified mail server using the provided socket.</para>
  54208. <para>If a successful connection is made, the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/>
  54209. property will be populated.</para>
  54210. </remarks>
  54211. <returns>An asynchronous task context.</returns>
  54212. <param name="socket">The socket to use for the connection.</param>
  54213. <param name="host">The host name to connect to.</param>
  54214. <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
  54215. <param name="options">The secure socket options to when connecting.</param>
  54216. <param name="cancellationToken">The cancellation token.</param>
  54217. <exception cref="T:System.ArgumentNullException">
  54218. <para><paramref name="socket"/> is <c>null</c>.</para>
  54219. <para>-or-</para>
  54220. <para><paramref name="host"/> is <c>null</c>.</para>
  54221. </exception>
  54222. <exception cref="T:System.ArgumentOutOfRangeException">
  54223. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  54224. </exception>
  54225. <exception cref="T:System.ArgumentException">
  54226. <para><paramref name="socket"/> is not connected.</para>
  54227. <para>-or-</para>
  54228. <para>The <paramref name="host"/> is a zero-length string.</para>
  54229. </exception>
  54230. <exception cref="T:System.InvalidOperationException">
  54231. The <see cref="T:MailKit.IMailService"/> is already connected.
  54232. </exception>
  54233. <exception cref="T:System.OperationCanceledException">
  54234. The operation was canceled via the cancellation token.
  54235. </exception>
  54236. <exception cref="T:System.IO.IOException">
  54237. An I/O error occurred.
  54238. </exception>
  54239. <exception cref="T:MailKit.CommandException">
  54240. The command was rejected by the mail server.
  54241. </exception>
  54242. <exception cref="T:MailKit.ProtocolException">
  54243. The server responded with an unexpected token.
  54244. </exception>
  54245. </member>
  54246. <member name="M:MailKit.MailService.Connect(System.IO.Stream,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
  54247. <summary>
  54248. Establish a connection to the specified mail server using the provided stream.
  54249. </summary>
  54250. <remarks>
  54251. <para>Establish a connection to the specified mail server using the provided stream.</para>
  54252. <para>If a successful connection is made, the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/>
  54253. property will be populated.</para>
  54254. </remarks>
  54255. <param name="stream">The stream to use for the connection.</param>
  54256. <param name="host">The host name to connect to.</param>
  54257. <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
  54258. <param name="options">The secure socket options to when connecting.</param>
  54259. <param name="cancellationToken">The cancellation token.</param>
  54260. <exception cref="T:System.ArgumentNullException">
  54261. <para><paramref name="stream"/> is <c>null</c>.</para>
  54262. <para>-or-</para>
  54263. <para><paramref name="host"/> is <c>null</c>.</para>
  54264. </exception>
  54265. <exception cref="T:System.ArgumentOutOfRangeException">
  54266. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  54267. </exception>
  54268. <exception cref="T:System.ArgumentException">
  54269. The <paramref name="host"/> is a zero-length string.
  54270. </exception>
  54271. <exception cref="T:System.InvalidOperationException">
  54272. The <see cref="T:MailKit.IMailService"/> is already connected.
  54273. </exception>
  54274. <exception cref="T:System.OperationCanceledException">
  54275. The operation was canceled via the cancellation token.
  54276. </exception>
  54277. <exception cref="T:System.IO.IOException">
  54278. An I/O error occurred.
  54279. </exception>
  54280. <exception cref="T:MailKit.CommandException">
  54281. The command was rejected by the mail server.
  54282. </exception>
  54283. <exception cref="T:MailKit.ProtocolException">
  54284. The server responded with an unexpected token.
  54285. </exception>
  54286. </member>
  54287. <member name="M:MailKit.MailService.ConnectAsync(System.IO.Stream,System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)">
  54288. <summary>
  54289. Asynchronously establish a connection to the specified mail server using the provided stream.
  54290. </summary>
  54291. <remarks>
  54292. <para>Asynchronously establishes a connection to the specified mail server using the provided stream.</para>
  54293. <para>If a successful connection is made, the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/>
  54294. property will be populated.</para>
  54295. </remarks>
  54296. <returns>An asynchronous task context.</returns>
  54297. <param name="stream">The stream to use for the connection.</param>
  54298. <param name="host">The host name to connect to.</param>
  54299. <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
  54300. <param name="options">The secure socket options to when connecting.</param>
  54301. <param name="cancellationToken">The cancellation token.</param>
  54302. <exception cref="T:System.ArgumentNullException">
  54303. <para><paramref name="stream"/> is <c>null</c>.</para>
  54304. <para>-or-</para>
  54305. <para><paramref name="host"/> is <c>null</c>.</para>
  54306. </exception>
  54307. <exception cref="T:System.ArgumentOutOfRangeException">
  54308. <paramref name="port"/> is not between <c>0</c> and <c>65535</c>.
  54309. </exception>
  54310. <exception cref="T:System.ArgumentException">
  54311. The <paramref name="host"/> is a zero-length string.
  54312. </exception>
  54313. <exception cref="T:System.InvalidOperationException">
  54314. The <see cref="T:MailKit.IMailService"/> is already connected.
  54315. </exception>
  54316. <exception cref="T:System.OperationCanceledException">
  54317. The operation was canceled via the cancellation token.
  54318. </exception>
  54319. <exception cref="T:System.IO.IOException">
  54320. An I/O error occurred.
  54321. </exception>
  54322. <exception cref="T:MailKit.CommandException">
  54323. The command was rejected by the mail server.
  54324. </exception>
  54325. <exception cref="T:MailKit.ProtocolException">
  54326. The server responded with an unexpected token.
  54327. </exception>
  54328. </member>
  54329. <member name="M:MailKit.MailService.Connect(System.Uri,System.Threading.CancellationToken)">
  54330. <summary>
  54331. Establish a connection to the specified mail server.
  54332. </summary>
  54333. <remarks>
  54334. Establishes a connection to the specified mail server.
  54335. </remarks>
  54336. <example>
  54337. <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessageUri"/>
  54338. </example>
  54339. <param name="uri">The server URI.</param>
  54340. <param name="cancellationToken">The cancellation token.</param>
  54341. <exception cref="T:System.ArgumentNullException">
  54342. The <paramref name="uri"/> is <c>null</c>.
  54343. </exception>
  54344. <exception cref="T:System.ArgumentException">
  54345. The <paramref name="uri"/> is not an absolute URI.
  54346. </exception>
  54347. <exception cref="T:System.ObjectDisposedException">
  54348. The <see cref="T:MailKit.MailService"/> has been disposed.
  54349. </exception>
  54350. <exception cref="T:System.InvalidOperationException">
  54351. The <see cref="T:MailKit.MailService"/> is already connected.
  54352. </exception>
  54353. <exception cref="T:System.OperationCanceledException">
  54354. The operation was canceled via the cancellation token.
  54355. </exception>
  54356. <exception cref="T:System.Net.Sockets.SocketException">
  54357. A socket error occurred trying to connect to the remote host.
  54358. </exception>
  54359. <exception cref="T:System.IO.IOException">
  54360. An I/O error occurred.
  54361. </exception>
  54362. <exception cref="T:MailKit.ProtocolException">
  54363. A protocol error occurred.
  54364. </exception>
  54365. </member>
  54366. <member name="M:MailKit.MailService.ConnectAsync(System.Uri,System.Threading.CancellationToken)">
  54367. <summary>
  54368. Asynchronously establish a connection to the specified mail server.
  54369. </summary>
  54370. <remarks>
  54371. Asynchronously establishes a connection to the specified mail server.
  54372. </remarks>
  54373. <returns>An asynchronous task context.</returns>
  54374. <param name="uri">The server URI.</param>
  54375. <param name="cancellationToken">The cancellation token.</param>
  54376. <exception cref="T:System.ArgumentNullException">
  54377. The <paramref name="uri"/> is <c>null</c>.
  54378. </exception>
  54379. <exception cref="T:System.ArgumentException">
  54380. The <paramref name="uri"/> is not an absolute URI.
  54381. </exception>
  54382. <exception cref="T:System.ObjectDisposedException">
  54383. The <see cref="T:MailKit.MailService"/> has been disposed.
  54384. </exception>
  54385. <exception cref="T:System.InvalidOperationException">
  54386. The <see cref="T:MailKit.MailService"/> is already connected.
  54387. </exception>
  54388. <exception cref="T:System.OperationCanceledException">
  54389. The operation was canceled via the cancellation token.
  54390. </exception>
  54391. <exception cref="T:System.Net.Sockets.SocketException">
  54392. A socket error occurred trying to connect to the remote host.
  54393. </exception>
  54394. <exception cref="T:System.IO.IOException">
  54395. An I/O error occurred.
  54396. </exception>
  54397. <exception cref="T:MailKit.ProtocolException">
  54398. A protocol error occurred.
  54399. </exception>
  54400. </member>
  54401. <member name="M:MailKit.MailService.Connect(System.String,System.Int32,System.Boolean,System.Threading.CancellationToken)">
  54402. <summary>
  54403. Establish a connection to the specified mail server.
  54404. </summary>
  54405. <remarks>
  54406. <para>Establishes a connection to the specified mail server.</para>
  54407. <note type="note">
  54408. <para>The <paramref name="useSsl"/> argument only controls whether or
  54409. not the client makes an SSL-wrapped connection. In other words, even if the
  54410. <paramref name="useSsl"/> parameter is <c>false</c>, SSL/TLS may still be used if
  54411. the mail server supports the STARTTLS extension.</para>
  54412. <para>To disable all use of SSL/TLS, use the
  54413. <see cref="M:MailKit.MailService.Connect(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)"/>
  54414. overload with a value of
  54415. <see cref="F:MailKit.Security.SecureSocketOptions.None">SecureSocketOptions.None</see>
  54416. instead.</para>
  54417. </note>
  54418. </remarks>
  54419. <param name="host">The host to connect to.</param>
  54420. <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
  54421. <param name="useSsl"><value>true</value> if the client should make an SSL-wrapped connection to the server; otherwise, <value>false</value>.</param>
  54422. <param name="cancellationToken">The cancellation token.</param>
  54423. <exception cref="T:System.ArgumentNullException">
  54424. The <paramref name="host"/> is <c>null</c>.
  54425. </exception>
  54426. <exception cref="T:System.ArgumentOutOfRangeException">
  54427. <paramref name="port"/> is out of range (<value>0</value> to <value>65535</value>, inclusive).
  54428. </exception>
  54429. <exception cref="T:System.ArgumentException">
  54430. The <paramref name="host"/> is a zero-length string.
  54431. </exception>
  54432. <exception cref="T:System.ObjectDisposedException">
  54433. The <see cref="T:MailKit.MailService"/> has been disposed.
  54434. </exception>
  54435. <exception cref="T:System.InvalidOperationException">
  54436. The <see cref="T:MailKit.MailService"/> is already connected.
  54437. </exception>
  54438. <exception cref="T:System.OperationCanceledException">
  54439. The operation was canceled via the cancellation token.
  54440. </exception>
  54441. <exception cref="T:System.Net.Sockets.SocketException">
  54442. A socket error occurred trying to connect to the remote host.
  54443. </exception>
  54444. <exception cref="T:System.IO.IOException">
  54445. An I/O error occurred.
  54446. </exception>
  54447. <exception cref="T:MailKit.ProtocolException">
  54448. A protocol error occurred.
  54449. </exception>
  54450. </member>
  54451. <member name="M:MailKit.MailService.ConnectAsync(System.String,System.Int32,System.Boolean,System.Threading.CancellationToken)">
  54452. <summary>
  54453. Asynchronously establish a connection to the specified mail server.
  54454. </summary>
  54455. <remarks>
  54456. <para>Asynchronously establishes a connection to the specified mail server.</para>
  54457. <note type="note">
  54458. <para>The <paramref name="useSsl"/> argument only controls whether or
  54459. not the client makes an SSL-wrapped connection. In other words, even if the
  54460. <paramref name="useSsl"/> parameter is <c>false</c>, SSL/TLS may still be used if
  54461. the mail server supports the STARTTLS extension.</para>
  54462. <para>To disable all use of SSL/TLS, use the
  54463. <see cref="M:MailKit.MailService.ConnectAsync(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Threading.CancellationToken)"/>
  54464. overload with a value of
  54465. <see cref="F:MailKit.Security.SecureSocketOptions.None">SecureSocketOptions.None</see>
  54466. instead.</para>
  54467. </note>
  54468. </remarks>
  54469. <returns>An asynchronous task context.</returns>
  54470. <param name="host">The host to connect to.</param>
  54471. <param name="port">The port to connect to. If the specified port is <c>0</c>, then the default port will be used.</param>
  54472. <param name="useSsl"><value>true</value> if the client should make an SSL-wrapped connection to the server; otherwise, <value>false</value>.</param>
  54473. <param name="cancellationToken">The cancellation token.</param>
  54474. <exception cref="T:System.ArgumentNullException">
  54475. The <paramref name="host"/> is <c>null</c>.
  54476. </exception>
  54477. <exception cref="T:System.ArgumentOutOfRangeException">
  54478. <paramref name="port"/> is out of range (<value>0</value> to <value>65535</value>, inclusive).
  54479. </exception>
  54480. <exception cref="T:System.ArgumentException">
  54481. The <paramref name="host"/> is a zero-length string.
  54482. </exception>
  54483. <exception cref="T:System.ObjectDisposedException">
  54484. The <see cref="T:MailKit.MailService"/> has been disposed.
  54485. </exception>
  54486. <exception cref="T:System.InvalidOperationException">
  54487. The <see cref="T:MailKit.MailService"/> is already connected.
  54488. </exception>
  54489. <exception cref="T:System.OperationCanceledException">
  54490. The operation was canceled via the cancellation token.
  54491. </exception>
  54492. <exception cref="T:System.Net.Sockets.SocketException">
  54493. A socket error occurred trying to connect to the remote host.
  54494. </exception>
  54495. <exception cref="T:System.IO.IOException">
  54496. An I/O error occurred.
  54497. </exception>
  54498. <exception cref="T:MailKit.ProtocolException">
  54499. A protocol error occurred.
  54500. </exception>
  54501. </member>
  54502. <member name="M:MailKit.MailService.Authenticate(System.Text.Encoding,System.Net.ICredentials,System.Threading.CancellationToken)">
  54503. <summary>
  54504. Authenticate using the supplied credentials.
  54505. </summary>
  54506. <remarks>
  54507. <para>If the server supports one or more SASL authentication mechanisms,
  54508. then the SASL mechanisms that both the client and server support are tried
  54509. in order of greatest security to weakest security. Once a SASL
  54510. authentication mechanism is found that both client and server support,
  54511. the credentials are used to authenticate.</para>
  54512. <para>If the server does not support SASL or if no common SASL mechanisms
  54513. can be found, then the default login command is used as a fallback.</para>
  54514. <note type="tip">To prevent the usage of certain authentication mechanisms,
  54515. simply remove them from the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/> hash set
  54516. before calling this method.</note>
  54517. </remarks>
  54518. <param name="encoding">The encoding to use for the user's credentials.</param>
  54519. <param name="credentials">The user's credentials.</param>
  54520. <param name="cancellationToken">The cancellation token.</param>
  54521. <exception cref="T:System.ArgumentNullException">
  54522. <para><paramref name="encoding"/> is <c>null</c>.</para>
  54523. <para>-or-</para>
  54524. <para><paramref name="credentials"/> is <c>null</c>.</para>
  54525. </exception>
  54526. <exception cref="T:System.ObjectDisposedException">
  54527. The <see cref="T:MailKit.MailService"/> has been disposed.
  54528. </exception>
  54529. <exception cref="T:System.InvalidOperationException">
  54530. The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
  54531. </exception>
  54532. <exception cref="T:System.OperationCanceledException">
  54533. The operation was canceled via the cancellation token.
  54534. </exception>
  54535. <exception cref="T:MailKit.Security.AuthenticationException">
  54536. Authentication using the supplied credentials has failed.
  54537. </exception>
  54538. <exception cref="T:MailKit.Security.SaslException">
  54539. A SASL authentication error occurred.
  54540. </exception>
  54541. <exception cref="T:System.IO.IOException">
  54542. An I/O error occurred.
  54543. </exception>
  54544. <exception cref="T:MailKit.ProtocolException">
  54545. A protocol error occurred.
  54546. </exception>
  54547. </member>
  54548. <member name="M:MailKit.MailService.AuthenticateAsync(System.Text.Encoding,System.Net.ICredentials,System.Threading.CancellationToken)">
  54549. <summary>
  54550. Asynchronously authenticate using the supplied credentials.
  54551. </summary>
  54552. <remarks>
  54553. <para>If the server supports one or more SASL authentication mechanisms,
  54554. then the SASL mechanisms that both the client and server support are tried
  54555. in order of greatest security to weakest security. Once a SASL
  54556. authentication mechanism is found that both client and server support,
  54557. the credentials are used to authenticate.</para>
  54558. <para>If the server does not support SASL or if no common SASL mechanisms
  54559. can be found, then the default login command is used as a fallback.</para>
  54560. <note type="tip">To prevent the usage of certain authentication mechanisms,
  54561. simply remove them from the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/> hash set
  54562. before calling this method.</note>
  54563. </remarks>
  54564. <returns>An asynchronous task context.</returns>
  54565. <param name="encoding">The encoding to use for the user's credentials.</param>
  54566. <param name="credentials">The user's credentials.</param>
  54567. <param name="cancellationToken">The cancellation token.</param>
  54568. <exception cref="T:System.ArgumentNullException">
  54569. <para><paramref name="encoding"/> is <c>null</c>.</para>
  54570. <para>-or-</para>
  54571. <para><paramref name="credentials"/> is <c>null</c>.</para>
  54572. </exception>
  54573. <exception cref="T:System.ObjectDisposedException">
  54574. The <see cref="T:MailKit.MailService"/> has been disposed.
  54575. </exception>
  54576. <exception cref="T:System.InvalidOperationException">
  54577. The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
  54578. </exception>
  54579. <exception cref="T:System.OperationCanceledException">
  54580. The operation was canceled via the cancellation token.
  54581. </exception>
  54582. <exception cref="T:MailKit.Security.AuthenticationException">
  54583. Authentication using the supplied credentials has failed.
  54584. </exception>
  54585. <exception cref="T:MailKit.Security.SaslException">
  54586. A SASL authentication error occurred.
  54587. </exception>
  54588. <exception cref="T:System.IO.IOException">
  54589. An I/O error occurred.
  54590. </exception>
  54591. <exception cref="T:MailKit.ProtocolException">
  54592. A protocol error occurred.
  54593. </exception>
  54594. </member>
  54595. <member name="M:MailKit.MailService.Authenticate(System.Net.ICredentials,System.Threading.CancellationToken)">
  54596. <summary>
  54597. Authenticate using the supplied credentials.
  54598. </summary>
  54599. <remarks>
  54600. <para>If the server supports one or more SASL authentication mechanisms,
  54601. then the SASL mechanisms that both the client and server support are tried
  54602. in order of greatest security to weakest security. Once a SASL
  54603. authentication mechanism is found that both client and server support,
  54604. the credentials are used to authenticate.</para>
  54605. <para>If the server does not support SASL or if no common SASL mechanisms
  54606. can be found, then the default login command is used as a fallback.</para>
  54607. <note type="tip">To prevent the usage of certain authentication mechanisms,
  54608. simply remove them from the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/> hash set
  54609. before calling this method.</note>
  54610. </remarks>
  54611. <param name="credentials">The user's credentials.</param>
  54612. <param name="cancellationToken">The cancellation token.</param>
  54613. <exception cref="T:System.ArgumentNullException">
  54614. <paramref name="credentials"/> is <c>null</c>.
  54615. </exception>
  54616. <exception cref="T:System.ObjectDisposedException">
  54617. The <see cref="T:MailKit.MailService"/> has been disposed.
  54618. </exception>
  54619. <exception cref="T:System.InvalidOperationException">
  54620. The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
  54621. </exception>
  54622. <exception cref="T:System.OperationCanceledException">
  54623. The operation was canceled via the cancellation token.
  54624. </exception>
  54625. <exception cref="T:MailKit.Security.AuthenticationException">
  54626. Authentication using the supplied credentials has failed.
  54627. </exception>
  54628. <exception cref="T:MailKit.Security.SaslException">
  54629. A SASL authentication error occurred.
  54630. </exception>
  54631. <exception cref="T:System.IO.IOException">
  54632. An I/O error occurred.
  54633. </exception>
  54634. <exception cref="T:MailKit.ProtocolException">
  54635. A protocol error occurred.
  54636. </exception>
  54637. </member>
  54638. <member name="M:MailKit.MailService.AuthenticateAsync(System.Net.ICredentials,System.Threading.CancellationToken)">
  54639. <summary>
  54640. Asynchronously authenticate using the supplied credentials.
  54641. </summary>
  54642. <remarks>
  54643. <para>If the server supports one or more SASL authentication mechanisms,
  54644. then the SASL mechanisms that both the client and server support are tried
  54645. in order of greatest security to weakest security. Once a SASL
  54646. authentication mechanism is found that both client and server support,
  54647. the credentials are used to authenticate.</para>
  54648. <para>If the server does not support SASL or if no common SASL mechanisms
  54649. can be found, then the default login command is used as a fallback.</para>
  54650. <note type="tip">To prevent the usage of certain authentication mechanisms,
  54651. simply remove them from the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/> hash set
  54652. before calling this method.</note>
  54653. </remarks>
  54654. <returns>An asynchronous task context.</returns>
  54655. <param name="credentials">The user's credentials.</param>
  54656. <param name="cancellationToken">The cancellation token.</param>
  54657. <exception cref="T:System.ArgumentNullException">
  54658. <paramref name="credentials"/> is <c>null</c>.
  54659. </exception>
  54660. <exception cref="T:System.ObjectDisposedException">
  54661. The <see cref="T:MailKit.MailService"/> has been disposed.
  54662. </exception>
  54663. <exception cref="T:System.InvalidOperationException">
  54664. The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
  54665. </exception>
  54666. <exception cref="T:System.OperationCanceledException">
  54667. The operation was canceled via the cancellation token.
  54668. </exception>
  54669. <exception cref="T:MailKit.Security.AuthenticationException">
  54670. Authentication using the supplied credentials has failed.
  54671. </exception>
  54672. <exception cref="T:MailKit.Security.SaslException">
  54673. A SASL authentication error occurred.
  54674. </exception>
  54675. <exception cref="T:System.IO.IOException">
  54676. An I/O error occurred.
  54677. </exception>
  54678. <exception cref="T:MailKit.ProtocolException">
  54679. A protocol error occurred.
  54680. </exception>
  54681. </member>
  54682. <member name="M:MailKit.MailService.Authenticate(System.Text.Encoding,System.String,System.String,System.Threading.CancellationToken)">
  54683. <summary>
  54684. Authenticate using the specified user name and password.
  54685. </summary>
  54686. <remarks>
  54687. <para>If the server supports one or more SASL authentication mechanisms,
  54688. then the SASL mechanisms that both the client and server support are tried
  54689. in order of greatest security to weakest security. Once a SASL
  54690. authentication mechanism is found that both client and server support,
  54691. the credentials are used to authenticate.</para>
  54692. <para>If the server does not support SASL or if no common SASL mechanisms
  54693. can be found, then the default login command is used as a fallback.</para>
  54694. <note type="tip">To prevent the usage of certain authentication mechanisms,
  54695. simply remove them from the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/> hash set
  54696. before calling this method.</note>
  54697. </remarks>
  54698. <param name="encoding">The encoding to use for the user's credentials.</param>
  54699. <param name="userName">The user name.</param>
  54700. <param name="password">The password.</param>
  54701. <param name="cancellationToken">The cancellation token.</param>
  54702. <exception cref="T:System.ArgumentNullException">
  54703. <para><paramref name="encoding"/> is <c>null</c>.</para>
  54704. <para>-or-</para>
  54705. <para><paramref name="userName"/> is <c>null</c>.</para>
  54706. <para>-or-</para>
  54707. <para><paramref name="password"/> is <c>null</c>.</para>
  54708. </exception>
  54709. <exception cref="T:System.ObjectDisposedException">
  54710. The <see cref="T:MailKit.MailService"/> has been disposed.
  54711. </exception>
  54712. <exception cref="T:System.InvalidOperationException">
  54713. The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
  54714. </exception>
  54715. <exception cref="T:System.OperationCanceledException">
  54716. The operation was canceled via the cancellation token.
  54717. </exception>
  54718. <exception cref="T:MailKit.Security.AuthenticationException">
  54719. Authentication using the supplied credentials has failed.
  54720. </exception>
  54721. <exception cref="T:MailKit.Security.SaslException">
  54722. A SASL authentication error occurred.
  54723. </exception>
  54724. <exception cref="T:System.IO.IOException">
  54725. An I/O error occurred.
  54726. </exception>
  54727. <exception cref="T:MailKit.ProtocolException">
  54728. A protocol error occurred.
  54729. </exception>
  54730. </member>
  54731. <member name="M:MailKit.MailService.AuthenticateAsync(System.Text.Encoding,System.String,System.String,System.Threading.CancellationToken)">
  54732. <summary>
  54733. Asynchronously authenticate using the specified user name and password.
  54734. </summary>
  54735. <remarks>
  54736. <para>If the server supports one or more SASL authentication mechanisms,
  54737. then the SASL mechanisms that both the client and server support are tried
  54738. in order of greatest security to weakest security. Once a SASL
  54739. authentication mechanism is found that both client and server support,
  54740. the credentials are used to authenticate.</para>
  54741. <para>If the server does not support SASL or if no common SASL mechanisms
  54742. can be found, then the default login command is used as a fallback.</para>
  54743. <note type="tip">To prevent the usage of certain authentication mechanisms,
  54744. simply remove them from the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/> hash set
  54745. before calling this method.</note>
  54746. </remarks>
  54747. <returns>An asynchronous task context.</returns>
  54748. <param name="encoding">The encoding to use for the user's credentials.</param>
  54749. <param name="userName">The user name.</param>
  54750. <param name="password">The password.</param>
  54751. <param name="cancellationToken">The cancellation token.</param>
  54752. <exception cref="T:System.ArgumentNullException">
  54753. <para><paramref name="encoding"/> is <c>null</c>.</para>
  54754. <para>-or-</para>
  54755. <para><paramref name="userName"/> is <c>null</c>.</para>
  54756. <para>-or-</para>
  54757. <para><paramref name="password"/> is <c>null</c>.</para>
  54758. </exception>
  54759. <exception cref="T:System.ObjectDisposedException">
  54760. The <see cref="T:MailKit.MailService"/> has been disposed.
  54761. </exception>
  54762. <exception cref="T:System.InvalidOperationException">
  54763. The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
  54764. </exception>
  54765. <exception cref="T:System.OperationCanceledException">
  54766. The operation was canceled via the cancellation token.
  54767. </exception>
  54768. <exception cref="T:MailKit.Security.AuthenticationException">
  54769. Authentication using the supplied credentials has failed.
  54770. </exception>
  54771. <exception cref="T:MailKit.Security.SaslException">
  54772. A SASL authentication error occurred.
  54773. </exception>
  54774. <exception cref="T:System.IO.IOException">
  54775. An I/O error occurred.
  54776. </exception>
  54777. <exception cref="T:MailKit.ProtocolException">
  54778. A protocol error occurred.
  54779. </exception>
  54780. </member>
  54781. <member name="M:MailKit.MailService.Authenticate(System.String,System.String,System.Threading.CancellationToken)">
  54782. <summary>
  54783. Authenticate using the specified user name and password.
  54784. </summary>
  54785. <remarks>
  54786. <para>If the server supports one or more SASL authentication mechanisms,
  54787. then the SASL mechanisms that both the client and server support are tried
  54788. in order of greatest security to weakest security. Once a SASL
  54789. authentication mechanism is found that both client and server support,
  54790. the credentials are used to authenticate.</para>
  54791. <para>If the server does not support SASL or if no common SASL mechanisms
  54792. can be found, then the default login command is used as a fallback.</para>
  54793. <note type="tip">To prevent the usage of certain authentication mechanisms,
  54794. simply remove them from the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/> hash set
  54795. before calling this method.</note>
  54796. </remarks>
  54797. <example>
  54798. <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessage"/>
  54799. </example>
  54800. <param name="userName">The user name.</param>
  54801. <param name="password">The password.</param>
  54802. <param name="cancellationToken">The cancellation token.</param>
  54803. <exception cref="T:System.ArgumentNullException">
  54804. <para><paramref name="userName"/> is <c>null</c>.</para>
  54805. <para>-or-</para>
  54806. <para><paramref name="password"/> is <c>null</c>.</para>
  54807. </exception>
  54808. <exception cref="T:System.ObjectDisposedException">
  54809. The <see cref="T:MailKit.MailService"/> has been disposed.
  54810. </exception>
  54811. <exception cref="T:System.InvalidOperationException">
  54812. The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
  54813. </exception>
  54814. <exception cref="T:System.OperationCanceledException">
  54815. The operation was canceled via the cancellation token.
  54816. </exception>
  54817. <exception cref="T:MailKit.Security.AuthenticationException">
  54818. Authentication using the supplied credentials has failed.
  54819. </exception>
  54820. <exception cref="T:MailKit.Security.SaslException">
  54821. A SASL authentication error occurred.
  54822. </exception>
  54823. <exception cref="T:System.IO.IOException">
  54824. An I/O error occurred.
  54825. </exception>
  54826. <exception cref="T:MailKit.ProtocolException">
  54827. A protocol error occurred.
  54828. </exception>
  54829. </member>
  54830. <member name="M:MailKit.MailService.AuthenticateAsync(System.String,System.String,System.Threading.CancellationToken)">
  54831. <summary>
  54832. Asynchronously authenticate using the specified user name and password.
  54833. </summary>
  54834. <remarks>
  54835. <para>If the server supports one or more SASL authentication mechanisms,
  54836. then the SASL mechanisms that both the client and server support are tried
  54837. in order of greatest security to weakest security. Once a SASL
  54838. authentication mechanism is found that both client and server support,
  54839. the credentials are used to authenticate.</para>
  54840. <para>If the server does not support SASL or if no common SASL mechanisms
  54841. can be found, then the default login command is used as a fallback.</para>
  54842. <note type="tip">To prevent the usage of certain authentication mechanisms,
  54843. simply remove them from the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/> hash set
  54844. before calling this method.</note>
  54845. </remarks>
  54846. <returns>An asynchronous task context.</returns>
  54847. <param name="userName">The user name.</param>
  54848. <param name="password">The password.</param>
  54849. <param name="cancellationToken">The cancellation token.</param>
  54850. <exception cref="T:System.ArgumentNullException">
  54851. <para><paramref name="userName"/> is <c>null</c>.</para>
  54852. <para>-or-</para>
  54853. <para><paramref name="password"/> is <c>null</c>.</para>
  54854. </exception>
  54855. <exception cref="T:System.ObjectDisposedException">
  54856. The <see cref="T:MailKit.MailService"/> has been disposed.
  54857. </exception>
  54858. <exception cref="T:System.InvalidOperationException">
  54859. The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
  54860. </exception>
  54861. <exception cref="T:System.OperationCanceledException">
  54862. The operation was canceled via the cancellation token.
  54863. </exception>
  54864. <exception cref="T:MailKit.Security.AuthenticationException">
  54865. Authentication using the supplied credentials has failed.
  54866. </exception>
  54867. <exception cref="T:MailKit.Security.SaslException">
  54868. A SASL authentication error occurred.
  54869. </exception>
  54870. <exception cref="T:System.IO.IOException">
  54871. An I/O error occurred.
  54872. </exception>
  54873. <exception cref="T:MailKit.ProtocolException">
  54874. A protocol error occurred.
  54875. </exception>
  54876. </member>
  54877. <member name="M:MailKit.MailService.Authenticate(MailKit.Security.SaslMechanism,System.Threading.CancellationToken)">
  54878. <summary>
  54879. Authenticate using the specified SASL mechanism.
  54880. </summary>
  54881. <remarks>
  54882. <para>Authenticates using the specified SASL mechanism.</para>
  54883. <para>For a list of available SASL authentication mechanisms supported by the server,
  54884. check the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/> property after the service has been
  54885. connected.</para>
  54886. </remarks>
  54887. <param name="mechanism">The SASL mechanism.</param>
  54888. <param name="cancellationToken">The cancellation token.</param>
  54889. <exception cref="T:System.ArgumentNullException">
  54890. <paramref name="mechanism"/> is <c>null</c>.
  54891. </exception>
  54892. <exception cref="T:System.ObjectDisposedException">
  54893. The <see cref="T:MailKit.MailService"/> has been disposed.
  54894. </exception>
  54895. <exception cref="T:System.InvalidOperationException">
  54896. The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
  54897. </exception>
  54898. <exception cref="T:System.OperationCanceledException">
  54899. The operation was canceled via the cancellation token.
  54900. </exception>
  54901. <exception cref="T:MailKit.Security.AuthenticationException">
  54902. Authentication using the supplied credentials has failed.
  54903. </exception>
  54904. <exception cref="T:MailKit.Security.SaslException">
  54905. A SASL authentication error occurred.
  54906. </exception>
  54907. <exception cref="T:System.IO.IOException">
  54908. An I/O error occurred.
  54909. </exception>
  54910. <exception cref="T:MailKit.ProtocolException">
  54911. A protocol error occurred.
  54912. </exception>
  54913. </member>
  54914. <member name="M:MailKit.MailService.AuthenticateAsync(MailKit.Security.SaslMechanism,System.Threading.CancellationToken)">
  54915. <summary>
  54916. Asynchronously authenticate using the specified SASL mechanism.
  54917. </summary>
  54918. <remarks>
  54919. <para>Authenticates using the specified SASL mechanism.</para>
  54920. <para>For a list of available SASL authentication mechanisms supported by the server,
  54921. check the <see cref="P:MailKit.MailService.AuthenticationMechanisms"/> property after the service has been
  54922. connected.</para>
  54923. </remarks>
  54924. <returns>An asynchronous task context.</returns>
  54925. <param name="mechanism">The SASL mechanism.</param>
  54926. <param name="cancellationToken">The cancellation token.</param>
  54927. <exception cref="T:System.ArgumentNullException">
  54928. <paramref name="mechanism"/> is <c>null</c>.
  54929. </exception>
  54930. <exception cref="T:System.ObjectDisposedException">
  54931. The <see cref="T:MailKit.MailService"/> has been disposed.
  54932. </exception>
  54933. <exception cref="T:System.InvalidOperationException">
  54934. The <see cref="T:MailKit.MailService"/> is not connected or is already authenticated.
  54935. </exception>
  54936. <exception cref="T:System.OperationCanceledException">
  54937. The operation was canceled via the cancellation token.
  54938. </exception>
  54939. <exception cref="T:MailKit.Security.AuthenticationException">
  54940. Authentication using the supplied credentials has failed.
  54941. </exception>
  54942. <exception cref="T:MailKit.Security.SaslException">
  54943. A SASL authentication error occurred.
  54944. </exception>
  54945. <exception cref="T:System.IO.IOException">
  54946. An I/O error occurred.
  54947. </exception>
  54948. <exception cref="T:MailKit.ProtocolException">
  54949. A protocol error occurred.
  54950. </exception>
  54951. </member>
  54952. <member name="M:MailKit.MailService.Disconnect(System.Boolean,System.Threading.CancellationToken)">
  54953. <summary>
  54954. Disconnect the service.
  54955. </summary>
  54956. <remarks>
  54957. If <paramref name="quit"/> is <c>true</c>, a logout/quit command will be issued in order to disconnect cleanly.
  54958. </remarks>
  54959. <example>
  54960. <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessage"/>
  54961. </example>
  54962. <param name="quit">If set to <c>true</c>, a logout/quit command will be issued in order to disconnect cleanly.</param>
  54963. <param name="cancellationToken">The cancellation token.</param>
  54964. <exception cref="T:System.ObjectDisposedException">
  54965. The <see cref="T:MailKit.MailService"/> has been disposed.
  54966. </exception>
  54967. </member>
  54968. <member name="M:MailKit.MailService.DisconnectAsync(System.Boolean,System.Threading.CancellationToken)">
  54969. <summary>
  54970. Asynchronously disconnect the service.
  54971. </summary>
  54972. <remarks>
  54973. If <paramref name="quit"/> is <c>true</c>, a logout/quit command will be issued in order to disconnect cleanly.
  54974. </remarks>
  54975. <returns>An asynchronous task context.</returns>
  54976. <param name="quit">If set to <c>true</c>, a logout/quit command will be issued in order to disconnect cleanly.</param>
  54977. <param name="cancellationToken">The cancellation token.</param>
  54978. <exception cref="T:System.ObjectDisposedException">
  54979. The <see cref="T:MailKit.MailService"/> has been disposed.
  54980. </exception>
  54981. </member>
  54982. <member name="M:MailKit.MailService.NoOp(System.Threading.CancellationToken)">
  54983. <summary>
  54984. Ping the mail server to keep the connection alive.
  54985. </summary>
  54986. <remarks>
  54987. Mail servers, if left idle for too long, will automatically drop the connection.
  54988. </remarks>
  54989. <param name="cancellationToken">The cancellation token.</param>
  54990. <exception cref="T:System.ObjectDisposedException">
  54991. The <see cref="T:MailKit.MailService"/> has been disposed.
  54992. </exception>
  54993. <exception cref="T:System.InvalidOperationException">
  54994. <para>The <see cref="T:MailKit.MailService"/> is not connected.</para>
  54995. <para>-or-</para>
  54996. <para>The <see cref="T:MailKit.MailService"/> is not authenticated.</para>
  54997. </exception>
  54998. <exception cref="T:System.OperationCanceledException">
  54999. The operation was canceled via the cancellation token.
  55000. </exception>
  55001. <exception cref="T:System.IO.IOException">
  55002. An I/O error occurred.
  55003. </exception>
  55004. <exception cref="T:MailKit.CommandException">
  55005. The command was rejected by the mail server.
  55006. </exception>
  55007. <exception cref="T:MailKit.ProtocolException">
  55008. The server responded with an unexpected token.
  55009. </exception>
  55010. </member>
  55011. <member name="M:MailKit.MailService.NoOpAsync(System.Threading.CancellationToken)">
  55012. <summary>
  55013. Asynchronously ping the mail server to keep the connection alive.
  55014. </summary>
  55015. <remarks>
  55016. Mail servers, if left idle for too long, will automatically drop the connection.
  55017. </remarks>
  55018. <returns>An asynchronous task context.</returns>
  55019. <param name="cancellationToken">The cancellation token.</param>
  55020. <exception cref="T:System.ObjectDisposedException">
  55021. The <see cref="T:MailKit.MailService"/> has been disposed.
  55022. </exception>
  55023. <exception cref="T:System.InvalidOperationException">
  55024. <para>The <see cref="T:MailKit.MailService"/> is not connected.</para>
  55025. <para>-or-</para>
  55026. <para>The <see cref="T:MailKit.MailService"/> is not authenticated.</para>
  55027. </exception>
  55028. <exception cref="T:System.OperationCanceledException">
  55029. The operation was canceled via the cancellation token.
  55030. </exception>
  55031. <exception cref="T:System.IO.IOException">
  55032. An I/O error occurred.
  55033. </exception>
  55034. <exception cref="T:MailKit.CommandException">
  55035. The command was rejected by the mail server.
  55036. </exception>
  55037. <exception cref="T:MailKit.ProtocolException">
  55038. The server responded with an unexpected token.
  55039. </exception>
  55040. </member>
  55041. <member name="E:MailKit.MailService.Connected">
  55042. <summary>
  55043. Occurs when the client has been successfully connected.
  55044. </summary>
  55045. <remarks>
  55046. The <see cref="E:MailKit.MailService.Connected"/> event is raised when the client
  55047. successfully connects to the mail server.
  55048. </remarks>
  55049. </member>
  55050. <member name="M:MailKit.MailService.OnConnected(System.String,System.Int32,MailKit.Security.SecureSocketOptions)">
  55051. <summary>
  55052. Raise the connected event.
  55053. </summary>
  55054. <remarks>
  55055. Raises the connected event.
  55056. </remarks>
  55057. <param name="host">The name of the host that the client connected to.</param>
  55058. <param name="port">The port that the client connected to on the remote host.</param>
  55059. <param name="options">The SSL/TLS options that were used when connecting.</param>
  55060. </member>
  55061. <member name="E:MailKit.MailService.Disconnected">
  55062. <summary>
  55063. Occurs when the client gets disconnected.
  55064. </summary>
  55065. <remarks>
  55066. The <see cref="E:MailKit.MailService.Disconnected"/> event is raised whenever the client
  55067. gets disconnected.
  55068. </remarks>
  55069. </member>
  55070. <member name="M:MailKit.MailService.OnDisconnected(System.String,System.Int32,MailKit.Security.SecureSocketOptions,System.Boolean)">
  55071. <summary>
  55072. Raise the disconnected event.
  55073. </summary>
  55074. <remarks>
  55075. Raises the disconnected event.
  55076. </remarks>
  55077. <param name="host">The name of the host that the client was connected to.</param>
  55078. <param name="port">The port that the client was connected to on the remote host.</param>
  55079. <param name="options">The SSL/TLS options that were used by the client.</param>
  55080. <param name="requested"><c>true</c> if the disconnect was explicitly requested; otherwise, <c>false</c>.</param>
  55081. </member>
  55082. <member name="E:MailKit.MailService.Authenticated">
  55083. <summary>
  55084. Occurs when the client has been successfully authenticated.
  55085. </summary>
  55086. <remarks>
  55087. The <see cref="E:MailKit.MailService.Authenticated"/> event is raised whenever the client
  55088. has been authenticated.
  55089. </remarks>
  55090. </member>
  55091. <member name="M:MailKit.MailService.OnAuthenticated(System.String)">
  55092. <summary>
  55093. Raise the authenticated event.
  55094. </summary>
  55095. <remarks>
  55096. Raises the authenticated event.
  55097. </remarks>
  55098. <param name="message">The notification sent by the server when the client successfully authenticates.</param>
  55099. </member>
  55100. <member name="M:MailKit.MailService.Dispose(System.Boolean)">
  55101. <summary>
  55102. Releases the unmanaged resources used by the <see cref="T:MailKit.MailService"/> and
  55103. optionally releases the managed resources.
  55104. </summary>
  55105. <remarks>
  55106. Releases the unmanaged resources used by the <see cref="T:MailKit.MailService"/> and
  55107. optionally releases the managed resources.
  55108. </remarks>
  55109. <param name="disposing"><c>true</c> to release both managed and unmanaged resources;
  55110. <c>false</c> to release only the unmanaged resources.</param>
  55111. </member>
  55112. <member name="M:MailKit.MailService.Dispose">
  55113. <summary>
  55114. Releases all resource used by the <see cref="T:MailKit.MailService"/> object.
  55115. </summary>
  55116. <remarks>Call <see cref="M:MailKit.MailService.Dispose"/> when you are finished using the <see cref="T:MailKit.MailService"/>. The
  55117. <see cref="M:MailKit.MailService.Dispose"/> method leaves the <see cref="T:MailKit.MailService"/> in an unusable state. After
  55118. calling <see cref="M:MailKit.MailService.Dispose"/>, you must release all references to the <see cref="T:MailKit.MailService"/> so
  55119. the garbage collector can reclaim the memory that the <see cref="T:MailKit.MailService"/> was occupying.</remarks>
  55120. </member>
  55121. <member name="T:MailKit.MailSpool">
  55122. <summary>
  55123. An abstract mail spool implementation.
  55124. </summary>
  55125. <remarks>
  55126. An abstract mail spool implementation.
  55127. </remarks>
  55128. </member>
  55129. <member name="M:MailKit.MailSpool.#ctor(MailKit.IProtocolLogger)">
  55130. <summary>
  55131. Initializes a new instance of the <see cref="T:MailKit.MailSpool"/> class.
  55132. </summary>
  55133. <remarks>
  55134. Initializes a new instance of the <see cref="T:MailKit.MailSpool"/> class.
  55135. </remarks>
  55136. <param name="protocolLogger">The protocol logger.</param>
  55137. <exception cref="T:System.ArgumentNullException">
  55138. <paramref name="protocolLogger"/> is <c>null</c>.
  55139. </exception>
  55140. </member>
  55141. <member name="P:MailKit.MailSpool.Count">
  55142. <summary>
  55143. Get the number of messages available in the message spool.
  55144. </summary>
  55145. <remarks>
  55146. <para>Gets the number of messages available in the message spool.</para>
  55147. <para>Once authenticated, the <see cref="P:MailKit.MailSpool.Count"/> property will be set
  55148. to the number of available messages in the spool.</para>
  55149. </remarks>
  55150. <example>
  55151. <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadMessages"/>
  55152. </example>
  55153. <value>The message count.</value>
  55154. <exception cref="T:System.ObjectDisposedException">
  55155. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  55156. </exception>
  55157. <exception cref="T:System.InvalidOperationException">
  55158. The <see cref="T:MailKit.MailSpool"/> is not connected.
  55159. </exception>
  55160. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  55161. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  55162. </exception>
  55163. </member>
  55164. <member name="P:MailKit.MailSpool.SupportsUids">
  55165. <summary>
  55166. Get whether or not the service supports referencing messages by UIDs.
  55167. </summary>
  55168. <remarks>
  55169. <para>Not all servers support referencing messages by UID, so this property should
  55170. be checked before using <see cref="M:MailKit.MailSpool.GetMessageUid(System.Int32,System.Threading.CancellationToken)"/>
  55171. and <see cref="M:MailKit.MailSpool.GetMessageUids(System.Threading.CancellationToken)"/>.</para>
  55172. <para>If the server does not support UIDs, then all methods that take UID arguments
  55173. along with <see cref="M:MailKit.MailSpool.GetMessageUid(System.Int32,System.Threading.CancellationToken)"/> and
  55174. <see cref="M:MailKit.MailSpool.GetMessageUids(System.Threading.CancellationToken)"/> will fail.</para>
  55175. </remarks>
  55176. <value><c>true</c> if supports uids; otherwise, <c>false</c>.</value>
  55177. <exception cref="T:System.ObjectDisposedException">
  55178. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  55179. </exception>
  55180. <exception cref="T:System.InvalidOperationException">
  55181. The <see cref="T:MailKit.MailSpool"/> is not connected.
  55182. </exception>
  55183. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  55184. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  55185. </exception>
  55186. </member>
  55187. <member name="M:MailKit.MailSpool.GetMessageCount(System.Threading.CancellationToken)">
  55188. <summary>
  55189. Get the message count.
  55190. </summary>
  55191. <remarks>
  55192. Gets the message count.
  55193. </remarks>
  55194. <returns>The message count.</returns>
  55195. <param name="cancellationToken">The cancellation token.</param>
  55196. <exception cref="T:System.ObjectDisposedException">
  55197. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  55198. </exception>
  55199. <exception cref="T:MailKit.ServiceNotConnectedException">
  55200. The <see cref="T:MailKit.MailSpool"/> is not connected.
  55201. </exception>
  55202. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  55203. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  55204. </exception>
  55205. <exception cref="T:System.OperationCanceledException">
  55206. The operation was canceled via the cancellation token.
  55207. </exception>
  55208. <exception cref="T:System.IO.IOException">
  55209. An I/O error occurred.
  55210. </exception>
  55211. <exception cref="T:MailKit.CommandException">
  55212. The command failed.
  55213. </exception>
  55214. <exception cref="T:MailKit.ProtocolException">
  55215. A protocol error occurred.
  55216. </exception>
  55217. </member>
  55218. <member name="M:MailKit.MailSpool.GetMessageCountAsync(System.Threading.CancellationToken)">
  55219. <summary>
  55220. Asynchronously get the message count.
  55221. </summary>
  55222. <remarks>
  55223. Asynchronously gets the message count.
  55224. </remarks>
  55225. <returns>The message count.</returns>
  55226. <param name="cancellationToken">The cancellation token.</param>
  55227. <exception cref="T:System.ObjectDisposedException">
  55228. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  55229. </exception>
  55230. <exception cref="T:MailKit.ServiceNotConnectedException">
  55231. The <see cref="T:MailKit.MailSpool"/> is not connected.
  55232. </exception>
  55233. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  55234. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  55235. </exception>
  55236. <exception cref="T:System.OperationCanceledException">
  55237. The operation was canceled via the cancellation token.
  55238. </exception>
  55239. <exception cref="T:System.IO.IOException">
  55240. An I/O error occurred.
  55241. </exception>
  55242. <exception cref="T:MailKit.CommandException">
  55243. The command failed.
  55244. </exception>
  55245. <exception cref="T:MailKit.ProtocolException">
  55246. A protocol error occurred.
  55247. </exception>
  55248. </member>
  55249. <member name="M:MailKit.MailSpool.GetMessageUid(System.Int32,System.Threading.CancellationToken)">
  55250. <summary>
  55251. Get the UID of the message at the specified index.
  55252. </summary>
  55253. <remarks>
  55254. Not all servers support UIDs, so you should first check
  55255. the <see cref="P:MailKit.MailSpool.SupportsUids"/> property.
  55256. </remarks>
  55257. <returns>The message UID.</returns>
  55258. <param name="index">The message index.</param>
  55259. <param name="cancellationToken">The cancellation token.</param>
  55260. <exception cref="T:System.ArgumentOutOfRangeException">
  55261. <paramref name="index"/> is not a valid message index.
  55262. </exception>
  55263. <exception cref="T:System.ObjectDisposedException">
  55264. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  55265. </exception>
  55266. <exception cref="T:MailKit.ServiceNotConnectedException">
  55267. The <see cref="T:MailKit.MailSpool"/> is not connected.
  55268. </exception>
  55269. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  55270. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  55271. </exception>
  55272. <exception cref="T:System.NotSupportedException">
  55273. The mail spool does not support UIDs.
  55274. </exception>
  55275. <exception cref="T:System.OperationCanceledException">
  55276. The operation was canceled via the cancellation token.
  55277. </exception>
  55278. <exception cref="T:System.IO.IOException">
  55279. An I/O error occurred.
  55280. </exception>
  55281. <exception cref="T:MailKit.CommandException">
  55282. The command failed.
  55283. </exception>
  55284. <exception cref="T:MailKit.ProtocolException">
  55285. A protocol error occurred.
  55286. </exception>
  55287. </member>
  55288. <member name="M:MailKit.MailSpool.GetMessageUidAsync(System.Int32,System.Threading.CancellationToken)">
  55289. <summary>
  55290. Asynchronously get the UID of the message at the specified index.
  55291. </summary>
  55292. <remarks>
  55293. Not all servers support UIDs, so you should first check
  55294. the <see cref="P:MailKit.MailSpool.SupportsUids"/> property.
  55295. </remarks>
  55296. <returns>The message UID.</returns>
  55297. <param name="index">The message index.</param>
  55298. <param name="cancellationToken">The cancellation token.</param>
  55299. <exception cref="T:System.ArgumentOutOfRangeException">
  55300. <paramref name="index"/> is not a valid message index.
  55301. </exception>
  55302. <exception cref="T:System.ObjectDisposedException">
  55303. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  55304. </exception>
  55305. <exception cref="T:MailKit.ServiceNotConnectedException">
  55306. The <see cref="T:MailKit.MailSpool"/> is not connected.
  55307. </exception>
  55308. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  55309. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  55310. </exception>
  55311. <exception cref="T:System.NotSupportedException">
  55312. The mail spool does not support UIDs.
  55313. </exception>
  55314. <exception cref="T:System.OperationCanceledException">
  55315. The operation was canceled via the cancellation token.
  55316. </exception>
  55317. <exception cref="T:System.IO.IOException">
  55318. An I/O error occurred.
  55319. </exception>
  55320. <exception cref="T:MailKit.CommandException">
  55321. The command failed.
  55322. </exception>
  55323. <exception cref="T:MailKit.ProtocolException">
  55324. A protocol error occurred.
  55325. </exception>
  55326. </member>
  55327. <member name="M:MailKit.MailSpool.GetMessageUids(System.Threading.CancellationToken)">
  55328. <summary>
  55329. Get the full list of available message UIDs.
  55330. </summary>
  55331. <remarks>
  55332. Not all servers support UIDs, so you should first check
  55333. the <see cref="P:MailKit.MailSpool.SupportsUids"/> property.
  55334. </remarks>
  55335. <example>
  55336. <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadNewMessages"/>
  55337. </example>
  55338. <returns>The message uids.</returns>
  55339. <param name="cancellationToken">The cancellation token.</param>
  55340. <exception cref="T:System.ObjectDisposedException">
  55341. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  55342. </exception>
  55343. <exception cref="T:MailKit.ServiceNotConnectedException">
  55344. The <see cref="T:MailKit.MailSpool"/> is not connected.
  55345. </exception>
  55346. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  55347. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  55348. </exception>
  55349. <exception cref="T:System.NotSupportedException">
  55350. The mail spool does not support UIDs.
  55351. </exception>
  55352. <exception cref="T:System.OperationCanceledException">
  55353. The operation was canceled via the cancellation token.
  55354. </exception>
  55355. <exception cref="T:System.IO.IOException">
  55356. An I/O error occurred.
  55357. </exception>
  55358. <exception cref="T:MailKit.CommandException">
  55359. The command failed.
  55360. </exception>
  55361. <exception cref="T:MailKit.ProtocolException">
  55362. A protocol error occurred.
  55363. </exception>
  55364. </member>
  55365. <member name="M:MailKit.MailSpool.GetMessageUidsAsync(System.Threading.CancellationToken)">
  55366. <summary>
  55367. Get the full list of available message UIDs.
  55368. </summary>
  55369. <remarks>
  55370. Not all servers support UIDs, so you should first check
  55371. the <see cref="P:MailKit.MailSpool.SupportsUids"/> property.
  55372. </remarks>
  55373. <returns>The message uids.</returns>
  55374. <param name="cancellationToken">The cancellation token.</param>
  55375. <exception cref="T:System.ObjectDisposedException">
  55376. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  55377. </exception>
  55378. <exception cref="T:MailKit.ServiceNotConnectedException">
  55379. The <see cref="T:MailKit.MailSpool"/> is not connected.
  55380. </exception>
  55381. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  55382. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  55383. </exception>
  55384. <exception cref="T:System.NotSupportedException">
  55385. The mail spool does not support UIDs.
  55386. </exception>
  55387. <exception cref="T:System.OperationCanceledException">
  55388. The operation was canceled via the cancellation token.
  55389. </exception>
  55390. <exception cref="T:System.IO.IOException">
  55391. An I/O error occurred.
  55392. </exception>
  55393. <exception cref="T:MailKit.CommandException">
  55394. The command failed.
  55395. </exception>
  55396. <exception cref="T:MailKit.ProtocolException">
  55397. A protocol error occurred.
  55398. </exception>
  55399. </member>
  55400. <member name="M:MailKit.MailSpool.GetMessageSize(System.Int32,System.Threading.CancellationToken)">
  55401. <summary>
  55402. Get the size of the specified message, in bytes.
  55403. </summary>
  55404. <remarks>
  55405. Gets the size of the specified message, in bytes.
  55406. </remarks>
  55407. <returns>The message size, in bytes.</returns>
  55408. <param name="index">The index of the message.</param>
  55409. <param name="cancellationToken">The cancellation token.</param>
  55410. <exception cref="T:System.ArgumentOutOfRangeException">
  55411. <paramref name="index"/> is not a valid message index.
  55412. </exception>
  55413. <exception cref="T:System.ObjectDisposedException">
  55414. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  55415. </exception>
  55416. <exception cref="T:MailKit.ServiceNotConnectedException">
  55417. The <see cref="T:MailKit.MailSpool"/> is not connected.
  55418. </exception>
  55419. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  55420. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  55421. </exception>
  55422. <exception cref="T:System.OperationCanceledException">
  55423. The operation was canceled via the cancellation token.
  55424. </exception>
  55425. <exception cref="T:System.IO.IOException">
  55426. An I/O error occurred.
  55427. </exception>
  55428. <exception cref="T:MailKit.CommandException">
  55429. The command failed.
  55430. </exception>
  55431. <exception cref="T:MailKit.ProtocolException">
  55432. A protocol error occurred.
  55433. </exception>
  55434. </member>
  55435. <member name="M:MailKit.MailSpool.GetMessageSizeAsync(System.Int32,System.Threading.CancellationToken)">
  55436. <summary>
  55437. Asynchronously get the size of the specified message, in bytes.
  55438. </summary>
  55439. <remarks>
  55440. Asynchronously gets the size of the specified message, in bytes.
  55441. </remarks>
  55442. <returns>The message size, in bytes.</returns>
  55443. <param name="index">The index of the message.</param>
  55444. <param name="cancellationToken">The cancellation token.</param>
  55445. <exception cref="T:System.ArgumentOutOfRangeException">
  55446. <paramref name="index"/> is not a valid message index.
  55447. </exception>
  55448. <exception cref="T:System.ObjectDisposedException">
  55449. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  55450. </exception>
  55451. <exception cref="T:MailKit.ServiceNotConnectedException">
  55452. The <see cref="T:MailKit.MailSpool"/> is not connected.
  55453. </exception>
  55454. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  55455. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  55456. </exception>
  55457. <exception cref="T:System.OperationCanceledException">
  55458. The operation was canceled via the cancellation token.
  55459. </exception>
  55460. <exception cref="T:System.IO.IOException">
  55461. An I/O error occurred.
  55462. </exception>
  55463. <exception cref="T:MailKit.CommandException">
  55464. The command failed.
  55465. </exception>
  55466. <exception cref="T:MailKit.ProtocolException">
  55467. A protocol error occurred.
  55468. </exception>
  55469. </member>
  55470. <member name="M:MailKit.MailSpool.GetMessageSizes(System.Threading.CancellationToken)">
  55471. <summary>
  55472. Get the sizes for all available messages, in bytes.
  55473. </summary>
  55474. <remarks>
  55475. Gets the sizes for all available messages, in bytes.
  55476. </remarks>
  55477. <returns>The message sizes, in bytes.</returns>
  55478. <param name="cancellationToken">The cancellation token.</param>
  55479. <exception cref="T:System.ObjectDisposedException">
  55480. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  55481. </exception>
  55482. <exception cref="T:MailKit.ServiceNotConnectedException">
  55483. The <see cref="T:MailKit.MailSpool"/> is not connected.
  55484. </exception>
  55485. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  55486. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  55487. </exception>
  55488. <exception cref="T:System.OperationCanceledException">
  55489. The operation was canceled via the cancellation token.
  55490. </exception>
  55491. <exception cref="T:System.IO.IOException">
  55492. An I/O error occurred.
  55493. </exception>
  55494. <exception cref="T:MailKit.CommandException">
  55495. The command failed.
  55496. </exception>
  55497. <exception cref="T:MailKit.ProtocolException">
  55498. A protocol error occurred.
  55499. </exception>
  55500. </member>
  55501. <member name="M:MailKit.MailSpool.GetMessageSizesAsync(System.Threading.CancellationToken)">
  55502. <summary>
  55503. Asynchronously get the sizes for all available messages, in bytes.
  55504. </summary>
  55505. <remarks>
  55506. Asynchronously gets the sizes for all available messages, in bytes.
  55507. </remarks>
  55508. <returns>The message sizes, in bytes.</returns>
  55509. <param name="cancellationToken">The cancellation token.</param>
  55510. <exception cref="T:System.ObjectDisposedException">
  55511. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  55512. </exception>
  55513. <exception cref="T:MailKit.ServiceNotConnectedException">
  55514. The <see cref="T:MailKit.MailSpool"/> is not connected.
  55515. </exception>
  55516. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  55517. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  55518. </exception>
  55519. <exception cref="T:System.OperationCanceledException">
  55520. The operation was canceled via the cancellation token.
  55521. </exception>
  55522. <exception cref="T:System.IO.IOException">
  55523. An I/O error occurred.
  55524. </exception>
  55525. <exception cref="T:MailKit.CommandException">
  55526. The command failed.
  55527. </exception>
  55528. <exception cref="T:MailKit.ProtocolException">
  55529. A protocol error occurred.
  55530. </exception>
  55531. </member>
  55532. <member name="M:MailKit.MailSpool.GetMessageHeaders(System.Int32,System.Threading.CancellationToken)">
  55533. <summary>
  55534. Get the headers for the specified message.
  55535. </summary>
  55536. <remarks>
  55537. Gets the headers for the specified message.
  55538. </remarks>
  55539. <returns>The message headers.</returns>
  55540. <param name="index">The index of the message.</param>
  55541. <param name="cancellationToken">The cancellation token.</param>
  55542. <exception cref="T:System.ArgumentOutOfRangeException">
  55543. <paramref name="index"/> is not a valid message index.
  55544. </exception>
  55545. <exception cref="T:System.ObjectDisposedException">
  55546. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  55547. </exception>
  55548. <exception cref="T:MailKit.ServiceNotConnectedException">
  55549. The <see cref="T:MailKit.MailSpool"/> is not connected.
  55550. </exception>
  55551. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  55552. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  55553. </exception>
  55554. <exception cref="T:System.OperationCanceledException">
  55555. The operation was canceled via the cancellation token.
  55556. </exception>
  55557. <exception cref="T:System.IO.IOException">
  55558. An I/O error occurred.
  55559. </exception>
  55560. <exception cref="T:MailKit.CommandException">
  55561. The command failed.
  55562. </exception>
  55563. <exception cref="T:MailKit.ProtocolException">
  55564. A protocol error occurred.
  55565. </exception>
  55566. </member>
  55567. <member name="M:MailKit.MailSpool.GetMessageHeadersAsync(System.Int32,System.Threading.CancellationToken)">
  55568. <summary>
  55569. Asynchronously get the headers for the specified message.
  55570. </summary>
  55571. <remarks>
  55572. Asynchronously gets the headers for the specified message.
  55573. </remarks>
  55574. <returns>The message headers.</returns>
  55575. <param name="index">The index of the message.</param>
  55576. <param name="cancellationToken">The cancellation token.</param>
  55577. <exception cref="T:System.ArgumentOutOfRangeException">
  55578. <paramref name="index"/> is not a valid message index.
  55579. </exception>
  55580. <exception cref="T:System.ObjectDisposedException">
  55581. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  55582. </exception>
  55583. <exception cref="T:MailKit.ServiceNotConnectedException">
  55584. The <see cref="T:MailKit.MailSpool"/> is not connected.
  55585. </exception>
  55586. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  55587. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  55588. </exception>
  55589. <exception cref="T:System.OperationCanceledException">
  55590. The operation was canceled via the cancellation token.
  55591. </exception>
  55592. <exception cref="T:System.IO.IOException">
  55593. An I/O error occurred.
  55594. </exception>
  55595. <exception cref="T:MailKit.CommandException">
  55596. The command failed.
  55597. </exception>
  55598. <exception cref="T:MailKit.ProtocolException">
  55599. A protocol error occurred.
  55600. </exception>
  55601. </member>
  55602. <member name="M:MailKit.MailSpool.GetMessageHeaders(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken)">
  55603. <summary>
  55604. Get the headers for the specified messages.
  55605. </summary>
  55606. <remarks>
  55607. Gets the headers for the specified messages.
  55608. </remarks>
  55609. <returns>The headers for the specified messages.</returns>
  55610. <param name="indexes">The indexes of the messages.</param>
  55611. <param name="cancellationToken">The cancellation token.</param>
  55612. <exception cref="T:System.ArgumentNullException">
  55613. <paramref name="indexes"/> is <c>null</c>.
  55614. </exception>
  55615. <exception cref="T:System.ArgumentException">
  55616. <para>One or more of the <paramref name="indexes"/> are invalid.</para>
  55617. <para>-or-</para>
  55618. <para>No indexes were specified.</para>
  55619. </exception>
  55620. <exception cref="T:System.ObjectDisposedException">
  55621. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  55622. </exception>
  55623. <exception cref="T:MailKit.ServiceNotConnectedException">
  55624. The <see cref="T:MailKit.MailSpool"/> is not connected.
  55625. </exception>
  55626. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  55627. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  55628. </exception>
  55629. <exception cref="T:System.OperationCanceledException">
  55630. The operation was canceled via the cancellation token.
  55631. </exception>
  55632. <exception cref="T:System.IO.IOException">
  55633. An I/O error occurred.
  55634. </exception>
  55635. <exception cref="T:MailKit.CommandException">
  55636. The command failed.
  55637. </exception>
  55638. <exception cref="T:MailKit.ProtocolException">
  55639. A protocol error occurred.
  55640. </exception>
  55641. </member>
  55642. <member name="M:MailKit.MailSpool.GetMessageHeadersAsync(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken)">
  55643. <summary>
  55644. Asynchronously get the headers for the specified messages.
  55645. </summary>
  55646. <remarks>
  55647. Asynchronously gets the headers for the specified messages.
  55648. </remarks>
  55649. <returns>The headers for the specified messages.</returns>
  55650. <param name="indexes">The indexes of the messages.</param>
  55651. <param name="cancellationToken">The cancellation token.</param>
  55652. <exception cref="T:System.ArgumentNullException">
  55653. <paramref name="indexes"/> is <c>null</c>.
  55654. </exception>
  55655. <exception cref="T:System.ArgumentException">
  55656. <para>One or more of the <paramref name="indexes"/> are invalid.</para>
  55657. <para>-or-</para>
  55658. <para>No indexes were specified.</para>
  55659. </exception>
  55660. <exception cref="T:System.ObjectDisposedException">
  55661. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  55662. </exception>
  55663. <exception cref="T:MailKit.ServiceNotConnectedException">
  55664. The <see cref="T:MailKit.MailSpool"/> is not connected.
  55665. </exception>
  55666. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  55667. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  55668. </exception>
  55669. <exception cref="T:System.OperationCanceledException">
  55670. The operation was canceled via the cancellation token.
  55671. </exception>
  55672. <exception cref="T:System.IO.IOException">
  55673. An I/O error occurred.
  55674. </exception>
  55675. <exception cref="T:MailKit.CommandException">
  55676. The command failed.
  55677. </exception>
  55678. <exception cref="T:MailKit.ProtocolException">
  55679. A protocol error occurred.
  55680. </exception>
  55681. </member>
  55682. <member name="M:MailKit.MailSpool.GetMessageHeaders(System.Int32,System.Int32,System.Threading.CancellationToken)">
  55683. <summary>
  55684. Get the headers of the messages within the specified range.
  55685. </summary>
  55686. <remarks>
  55687. Gets the headers of the messages within the specified range.
  55688. </remarks>
  55689. <returns>The headers of the messages within the specified range.</returns>
  55690. <param name="startIndex">The index of the first message to get.</param>
  55691. <param name="count">The number of messages to get.</param>
  55692. <param name="cancellationToken">The cancellation token.</param>
  55693. <exception cref="T:System.ArgumentOutOfRangeException">
  55694. <paramref name="startIndex"/> and <paramref name="count"/> do not specify
  55695. a valid range of messages.
  55696. </exception>
  55697. <exception cref="T:System.ObjectDisposedException">
  55698. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  55699. </exception>
  55700. <exception cref="T:MailKit.ServiceNotConnectedException">
  55701. The <see cref="T:MailKit.MailSpool"/> is not connected.
  55702. </exception>
  55703. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  55704. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  55705. </exception>
  55706. <exception cref="T:System.OperationCanceledException">
  55707. The operation was canceled via the cancellation token.
  55708. </exception>
  55709. <exception cref="T:System.IO.IOException">
  55710. An I/O error occurred.
  55711. </exception>
  55712. <exception cref="T:MailKit.CommandException">
  55713. The command failed.
  55714. </exception>
  55715. <exception cref="T:MailKit.ProtocolException">
  55716. A protocol error occurred.
  55717. </exception>
  55718. </member>
  55719. <member name="M:MailKit.MailSpool.GetMessageHeadersAsync(System.Int32,System.Int32,System.Threading.CancellationToken)">
  55720. <summary>
  55721. Get the headers of the messages within the specified range.
  55722. </summary>
  55723. <remarks>
  55724. Gets the headers of the messages within the specified range.
  55725. </remarks>
  55726. <returns>The headers of the messages within the specified range.</returns>
  55727. <param name="startIndex">The index of the first message to get.</param>
  55728. <param name="count">The number of messages to get.</param>
  55729. <param name="cancellationToken">The cancellation token.</param>
  55730. <exception cref="T:System.ArgumentOutOfRangeException">
  55731. <paramref name="startIndex"/> and <paramref name="count"/> do not specify
  55732. a valid range of messages.
  55733. </exception>
  55734. <exception cref="T:System.ObjectDisposedException">
  55735. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  55736. </exception>
  55737. <exception cref="T:MailKit.ServiceNotConnectedException">
  55738. The <see cref="T:MailKit.MailSpool"/> is not connected.
  55739. </exception>
  55740. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  55741. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  55742. </exception>
  55743. <exception cref="T:System.OperationCanceledException">
  55744. The operation was canceled via the cancellation token.
  55745. </exception>
  55746. <exception cref="T:System.IO.IOException">
  55747. An I/O error occurred.
  55748. </exception>
  55749. <exception cref="T:MailKit.CommandException">
  55750. The command failed.
  55751. </exception>
  55752. <exception cref="T:MailKit.ProtocolException">
  55753. A protocol error occurred.
  55754. </exception>
  55755. </member>
  55756. <member name="M:MailKit.MailSpool.GetMessage(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  55757. <summary>
  55758. Get the message at the specified index.
  55759. </summary>
  55760. <remarks>
  55761. Gets the message at the specified index.
  55762. </remarks>
  55763. <example>
  55764. <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadMessages"/>
  55765. </example>
  55766. <returns>The message.</returns>
  55767. <param name="index">The index of the message.</param>
  55768. <param name="cancellationToken">The cancellation token.</param>
  55769. <param name="progress">The progress reporting mechanism.</param>
  55770. <exception cref="T:System.ArgumentOutOfRangeException">
  55771. <paramref name="index"/> is not a valid message index.
  55772. </exception>
  55773. <exception cref="T:System.ObjectDisposedException">
  55774. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  55775. </exception>
  55776. <exception cref="T:MailKit.ServiceNotConnectedException">
  55777. The <see cref="T:MailKit.MailSpool"/> is not connected.
  55778. </exception>
  55779. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  55780. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  55781. </exception>
  55782. <exception cref="T:System.OperationCanceledException">
  55783. The operation was canceled via the cancellation token.
  55784. </exception>
  55785. <exception cref="T:System.IO.IOException">
  55786. An I/O error occurred.
  55787. </exception>
  55788. <exception cref="T:MailKit.CommandException">
  55789. The command failed.
  55790. </exception>
  55791. <exception cref="T:MailKit.ProtocolException">
  55792. A protocol error occurred.
  55793. </exception>
  55794. </member>
  55795. <member name="M:MailKit.MailSpool.GetMessageAsync(System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  55796. <summary>
  55797. Asynchronously get the message at the specified index.
  55798. </summary>
  55799. <remarks>
  55800. Asynchronously gets the message at the specified index.
  55801. </remarks>
  55802. <returns>The message.</returns>
  55803. <param name="index">The index of the message.</param>
  55804. <param name="cancellationToken">The cancellation token.</param>
  55805. <param name="progress">The progress reporting mechanism.</param>
  55806. <exception cref="T:System.ArgumentOutOfRangeException">
  55807. <paramref name="index"/> is not a valid message index.
  55808. </exception>
  55809. <exception cref="T:System.ObjectDisposedException">
  55810. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  55811. </exception>
  55812. <exception cref="T:MailKit.ServiceNotConnectedException">
  55813. The <see cref="T:MailKit.MailSpool"/> is not connected.
  55814. </exception>
  55815. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  55816. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  55817. </exception>
  55818. <exception cref="T:System.OperationCanceledException">
  55819. The operation was canceled via the cancellation token.
  55820. </exception>
  55821. <exception cref="T:System.IO.IOException">
  55822. An I/O error occurred.
  55823. </exception>
  55824. <exception cref="T:MailKit.CommandException">
  55825. The command failed.
  55826. </exception>
  55827. <exception cref="T:MailKit.ProtocolException">
  55828. A protocol error occurred.
  55829. </exception>
  55830. </member>
  55831. <member name="M:MailKit.MailSpool.GetMessages(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  55832. <summary>
  55833. Get the messages at the specified indexes.
  55834. </summary>
  55835. <remarks>
  55836. Get the messages at the specified indexes.
  55837. </remarks>
  55838. <returns>The messages.</returns>
  55839. <param name="indexes">The indexes of the messages.</param>
  55840. <param name="cancellationToken">The cancellation token.</param>
  55841. <param name="progress">The progress reporting mechanism.</param>
  55842. <exception cref="T:System.ArgumentNullException">
  55843. <paramref name="indexes"/> is <c>null</c>.
  55844. </exception>
  55845. <exception cref="T:System.ArgumentException">
  55846. <para>One or more of the <paramref name="indexes"/> are invalid.</para>
  55847. <para>-or-</para>
  55848. <para>No indexes were specified.</para>
  55849. </exception>
  55850. <exception cref="T:System.ObjectDisposedException">
  55851. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  55852. </exception>
  55853. <exception cref="T:MailKit.ServiceNotConnectedException">
  55854. The <see cref="T:MailKit.MailSpool"/> is not connected.
  55855. </exception>
  55856. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  55857. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  55858. </exception>
  55859. <exception cref="T:System.OperationCanceledException">
  55860. The operation was canceled via the cancellation token.
  55861. </exception>
  55862. <exception cref="T:System.IO.IOException">
  55863. An I/O error occurred.
  55864. </exception>
  55865. <exception cref="T:MailKit.CommandException">
  55866. The command failed.
  55867. </exception>
  55868. <exception cref="T:MailKit.ProtocolException">
  55869. A protocol error occurred.
  55870. </exception>
  55871. </member>
  55872. <member name="M:MailKit.MailSpool.GetMessagesAsync(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  55873. <summary>
  55874. Asynchronously get the messages at the specified indexes.
  55875. </summary>
  55876. <remarks>
  55877. Asynchronously get the messages at the specified indexes.
  55878. </remarks>
  55879. <returns>The messages.</returns>
  55880. <param name="indexes">The indexes of the messages.</param>
  55881. <param name="cancellationToken">The cancellation token.</param>
  55882. <param name="progress">The progress reporting mechanism.</param>
  55883. <exception cref="T:System.ArgumentNullException">
  55884. <paramref name="indexes"/> is <c>null</c>.
  55885. </exception>
  55886. <exception cref="T:System.ArgumentException">
  55887. <para>One or more of the <paramref name="indexes"/> are invalid.</para>
  55888. <para>-or-</para>
  55889. <para>No indexes were specified.</para>
  55890. </exception>
  55891. <exception cref="T:System.ObjectDisposedException">
  55892. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  55893. </exception>
  55894. <exception cref="T:MailKit.ServiceNotConnectedException">
  55895. The <see cref="T:MailKit.MailSpool"/> is not connected.
  55896. </exception>
  55897. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  55898. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  55899. </exception>
  55900. <exception cref="T:System.OperationCanceledException">
  55901. The operation was canceled via the cancellation token.
  55902. </exception>
  55903. <exception cref="T:System.IO.IOException">
  55904. An I/O error occurred.
  55905. </exception>
  55906. <exception cref="T:MailKit.CommandException">
  55907. The command failed.
  55908. </exception>
  55909. <exception cref="T:MailKit.ProtocolException">
  55910. A protocol error occurred.
  55911. </exception>
  55912. </member>
  55913. <member name="M:MailKit.MailSpool.GetMessages(System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  55914. <summary>
  55915. Get the messages within the specified range.
  55916. </summary>
  55917. <remarks>
  55918. Gets the messages within the specified range.
  55919. </remarks>
  55920. <example>
  55921. <code language="c#" source="Examples\Pop3Examples.cs" region="BatchDownloadMessages"/>
  55922. </example>
  55923. <returns>The messages.</returns>
  55924. <param name="startIndex">The index of the first message to get.</param>
  55925. <param name="count">The number of messages to get.</param>
  55926. <param name="cancellationToken">The cancellation token.</param>
  55927. <param name="progress">The progress reporting mechanism.</param>
  55928. <exception cref="T:System.ArgumentOutOfRangeException">
  55929. <paramref name="startIndex"/> and <paramref name="count"/> do not specify
  55930. a valid range of messages.
  55931. </exception>
  55932. <exception cref="T:System.ObjectDisposedException">
  55933. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  55934. </exception>
  55935. <exception cref="T:MailKit.ServiceNotConnectedException">
  55936. The <see cref="T:MailKit.MailSpool"/> is not connected.
  55937. </exception>
  55938. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  55939. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  55940. </exception>
  55941. <exception cref="T:System.OperationCanceledException">
  55942. The operation was canceled via the cancellation token.
  55943. </exception>
  55944. <exception cref="T:System.IO.IOException">
  55945. An I/O error occurred.
  55946. </exception>
  55947. <exception cref="T:MailKit.CommandException">
  55948. The command failed.
  55949. </exception>
  55950. <exception cref="T:MailKit.ProtocolException">
  55951. A protocol error occurred.
  55952. </exception>
  55953. </member>
  55954. <member name="M:MailKit.MailSpool.GetMessagesAsync(System.Int32,System.Int32,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  55955. <summary>
  55956. Asynchronously get the messages within the specified range.
  55957. </summary>
  55958. <remarks>
  55959. Asynchronously gets the messages within the specified range.
  55960. </remarks>
  55961. <returns>The messages.</returns>
  55962. <param name="startIndex">The index of the first message to get.</param>
  55963. <param name="count">The number of messages to get.</param>
  55964. <param name="cancellationToken">The cancellation token.</param>
  55965. <param name="progress">The progress reporting mechanism.</param>
  55966. <exception cref="T:System.ArgumentOutOfRangeException">
  55967. <paramref name="startIndex"/> and <paramref name="count"/> do not specify
  55968. a valid range of messages.
  55969. </exception>
  55970. <exception cref="T:System.ObjectDisposedException">
  55971. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  55972. </exception>
  55973. <exception cref="T:MailKit.ServiceNotConnectedException">
  55974. The <see cref="T:MailKit.MailSpool"/> is not connected.
  55975. </exception>
  55976. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  55977. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  55978. </exception>
  55979. <exception cref="T:System.OperationCanceledException">
  55980. The operation was canceled via the cancellation token.
  55981. </exception>
  55982. <exception cref="T:System.IO.IOException">
  55983. An I/O error occurred.
  55984. </exception>
  55985. <exception cref="T:MailKit.CommandException">
  55986. The command failed.
  55987. </exception>
  55988. <exception cref="T:MailKit.ProtocolException">
  55989. A protocol error occurred.
  55990. </exception>
  55991. </member>
  55992. <member name="M:MailKit.MailSpool.GetStream(System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  55993. <summary>
  55994. Get the message or header stream at the specified index.
  55995. </summary>
  55996. <remarks>
  55997. Gets the message or header stream at the specified index.
  55998. </remarks>
  55999. <returns>The message or header stream.</returns>
  56000. <param name="index">The index of the message.</param>
  56001. <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
  56002. <param name="cancellationToken">The cancellation token.</param>
  56003. <param name="progress">The progress reporting mechanism.</param>
  56004. <exception cref="T:System.ArgumentOutOfRangeException">
  56005. <paramref name="index"/> is not a valid message index.
  56006. </exception>
  56007. <exception cref="T:System.ObjectDisposedException">
  56008. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  56009. </exception>
  56010. <exception cref="T:MailKit.ServiceNotConnectedException">
  56011. The <see cref="T:MailKit.MailSpool"/> is not connected.
  56012. </exception>
  56013. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  56014. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  56015. </exception>
  56016. <exception cref="T:System.OperationCanceledException">
  56017. The operation was canceled via the cancellation token.
  56018. </exception>
  56019. <exception cref="T:System.IO.IOException">
  56020. An I/O error occurred.
  56021. </exception>
  56022. <exception cref="T:MailKit.CommandException">
  56023. The command failed.
  56024. </exception>
  56025. <exception cref="T:MailKit.ProtocolException">
  56026. A protocol error occurred.
  56027. </exception>
  56028. </member>
  56029. <member name="M:MailKit.MailSpool.GetStreamAsync(System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  56030. <summary>
  56031. Asynchronously get the message or header stream at the specified index.
  56032. </summary>
  56033. <remarks>
  56034. Asynchronously gets the message or header stream at the specified index.
  56035. </remarks>
  56036. <returns>The message or header stream.</returns>
  56037. <param name="index">The index of the message.</param>
  56038. <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
  56039. <param name="cancellationToken">The cancellation token.</param>
  56040. <param name="progress">The progress reporting mechanism.</param>
  56041. <exception cref="T:System.ArgumentOutOfRangeException">
  56042. <paramref name="index"/> is not a valid message index.
  56043. </exception>
  56044. <exception cref="T:System.ObjectDisposedException">
  56045. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  56046. </exception>
  56047. <exception cref="T:MailKit.ServiceNotConnectedException">
  56048. The <see cref="T:MailKit.MailSpool"/> is not connected.
  56049. </exception>
  56050. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  56051. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  56052. </exception>
  56053. <exception cref="T:System.OperationCanceledException">
  56054. The operation was canceled via the cancellation token.
  56055. </exception>
  56056. <exception cref="T:System.IO.IOException">
  56057. An I/O error occurred.
  56058. </exception>
  56059. <exception cref="T:MailKit.CommandException">
  56060. The command failed.
  56061. </exception>
  56062. <exception cref="T:MailKit.ProtocolException">
  56063. A protocol error occurred.
  56064. </exception>
  56065. </member>
  56066. <member name="M:MailKit.MailSpool.GetStreams(System.Collections.Generic.IList{System.Int32},System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  56067. <summary>
  56068. Get the message or header streams at the specified indexes.
  56069. </summary>
  56070. <remarks>
  56071. <para>Get the message or header streams at the specified indexes.</para>
  56072. <para>If the mail server supports pipelining, this method will likely be more
  56073. efficient than using <see cref="M:MailKit.MailSpool.GetStream(System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)"/> for
  56074. each message because it will batch the commands to reduce latency.</para>
  56075. </remarks>
  56076. <returns>The message or header streams.</returns>
  56077. <param name="indexes">The indexes of the messages.</param>
  56078. <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
  56079. <param name="cancellationToken">The cancellation token.</param>
  56080. <param name="progress">The progress reporting mechanism.</param>
  56081. <exception cref="T:System.ArgumentNullException">
  56082. <paramref name="indexes"/> is <c>null</c>.
  56083. </exception>
  56084. <exception cref="T:System.ArgumentException">
  56085. <para>One or more of the <paramref name="indexes"/> are invalid.</para>
  56086. <para>-or-</para>
  56087. <para>No indexes were specified.</para>
  56088. </exception>
  56089. <exception cref="T:System.ObjectDisposedException">
  56090. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  56091. </exception>
  56092. <exception cref="T:MailKit.ServiceNotConnectedException">
  56093. The <see cref="T:MailKit.MailSpool"/> is not connected.
  56094. </exception>
  56095. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  56096. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  56097. </exception>
  56098. <exception cref="T:System.OperationCanceledException">
  56099. The operation was canceled via the cancellation token.
  56100. </exception>
  56101. <exception cref="T:System.IO.IOException">
  56102. An I/O error occurred.
  56103. </exception>
  56104. <exception cref="T:MailKit.CommandException">
  56105. The command failed.
  56106. </exception>
  56107. <exception cref="T:MailKit.ProtocolException">
  56108. A protocol error occurred.
  56109. </exception>
  56110. </member>
  56111. <member name="M:MailKit.MailSpool.GetStreamsAsync(System.Collections.Generic.IList{System.Int32},System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  56112. <summary>
  56113. Asynchronously get the message or header streams at the specified indexes.
  56114. </summary>
  56115. <remarks>
  56116. Asynchronously get the message or header streams at the specified indexes.
  56117. </remarks>
  56118. <returns>The messages.</returns>
  56119. <param name="indexes">The indexes of the messages.</param>
  56120. <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
  56121. <param name="cancellationToken">The cancellation token.</param>
  56122. <param name="progress">The progress reporting mechanism.</param>
  56123. <exception cref="T:System.ArgumentNullException">
  56124. <paramref name="indexes"/> is <c>null</c>.
  56125. </exception>
  56126. <exception cref="T:System.ArgumentException">
  56127. <para>One or more of the <paramref name="indexes"/> are invalid.</para>
  56128. <para>-or-</para>
  56129. <para>No indexes were specified.</para>
  56130. </exception>
  56131. <exception cref="T:System.ObjectDisposedException">
  56132. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  56133. </exception>
  56134. <exception cref="T:MailKit.ServiceNotConnectedException">
  56135. The <see cref="T:MailKit.MailSpool"/> is not connected.
  56136. </exception>
  56137. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  56138. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  56139. </exception>
  56140. <exception cref="T:System.OperationCanceledException">
  56141. The operation was canceled via the cancellation token.
  56142. </exception>
  56143. <exception cref="T:System.IO.IOException">
  56144. An I/O error occurred.
  56145. </exception>
  56146. <exception cref="T:MailKit.CommandException">
  56147. The command failed.
  56148. </exception>
  56149. <exception cref="T:MailKit.ProtocolException">
  56150. A protocol error occurred.
  56151. </exception>
  56152. </member>
  56153. <member name="M:MailKit.MailSpool.GetStreams(System.Int32,System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  56154. <summary>
  56155. Get the message or header streams within the specified range.
  56156. </summary>
  56157. <remarks>
  56158. <para>Gets the message or header streams within the specified range.</para>
  56159. <para>If the mail server supports pipelining, this method will likely be more
  56160. efficient than using <see cref="M:MailKit.MailSpool.GetStream(System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)"/> for
  56161. each message because it will batch the commands to reduce latency.</para>
  56162. </remarks>
  56163. <returns>The message or header streams.</returns>
  56164. <param name="startIndex">The index of the first stream to get.</param>
  56165. <param name="count">The number of streams to get.</param>
  56166. <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
  56167. <param name="cancellationToken">The cancellation token.</param>
  56168. <param name="progress">The progress reporting mechanism.</param>
  56169. <exception cref="T:System.ArgumentOutOfRangeException">
  56170. <paramref name="startIndex"/> and <paramref name="count"/> do not specify
  56171. a valid range of messages.
  56172. </exception>
  56173. <exception cref="T:System.ObjectDisposedException">
  56174. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  56175. </exception>
  56176. <exception cref="T:MailKit.ServiceNotConnectedException">
  56177. The <see cref="T:MailKit.MailSpool"/> is not connected.
  56178. </exception>
  56179. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  56180. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  56181. </exception>
  56182. <exception cref="T:System.OperationCanceledException">
  56183. The operation was canceled via the cancellation token.
  56184. </exception>
  56185. <exception cref="T:System.IO.IOException">
  56186. An I/O error occurred.
  56187. </exception>
  56188. <exception cref="T:MailKit.CommandException">
  56189. The command failed.
  56190. </exception>
  56191. <exception cref="T:MailKit.ProtocolException">
  56192. A protocol error occurred.
  56193. </exception>
  56194. </member>
  56195. <member name="M:MailKit.MailSpool.GetStreamsAsync(System.Int32,System.Int32,System.Boolean,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  56196. <summary>
  56197. Asynchronously get the message or header streams within the specified range.
  56198. </summary>
  56199. <remarks>
  56200. Asynchronously gets the message or header streams within the specified range.
  56201. </remarks>
  56202. <returns>The messages.</returns>
  56203. <param name="startIndex">The index of the first stream to get.</param>
  56204. <param name="count">The number of streams to get.</param>
  56205. <param name="headersOnly"><c>true</c> if only the headers should be retrieved; otherwise, <c>false</c>.</param>
  56206. <param name="cancellationToken">The cancellation token.</param>
  56207. <param name="progress">The progress reporting mechanism.</param>
  56208. <exception cref="T:System.ArgumentOutOfRangeException">
  56209. <paramref name="startIndex"/> and <paramref name="count"/> do not specify
  56210. a valid range of messages.
  56211. </exception>
  56212. <exception cref="T:System.ObjectDisposedException">
  56213. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  56214. </exception>
  56215. <exception cref="T:MailKit.ServiceNotConnectedException">
  56216. The <see cref="T:MailKit.MailSpool"/> is not connected.
  56217. </exception>
  56218. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  56219. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  56220. </exception>
  56221. <exception cref="T:System.OperationCanceledException">
  56222. The operation was canceled via the cancellation token.
  56223. </exception>
  56224. <exception cref="T:System.IO.IOException">
  56225. An I/O error occurred.
  56226. </exception>
  56227. <exception cref="T:MailKit.CommandException">
  56228. The command failed.
  56229. </exception>
  56230. <exception cref="T:MailKit.ProtocolException">
  56231. A protocol error occurred.
  56232. </exception>
  56233. </member>
  56234. <member name="M:MailKit.MailSpool.DeleteMessage(System.Int32,System.Threading.CancellationToken)">
  56235. <summary>
  56236. Mark the specified message for deletion.
  56237. </summary>
  56238. <remarks>
  56239. Messages marked for deletion are not actually deleted until the session
  56240. is cleanly disconnected
  56241. (see <see cref="M:MailKit.MailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
  56242. </remarks>
  56243. <example>
  56244. <code language="c#" source="Examples\Pop3Examples.cs" region="DownloadMessages"/>
  56245. </example>
  56246. <param name="index">The index of the message.</param>
  56247. <param name="cancellationToken">The cancellation token.</param>
  56248. <exception cref="T:System.ArgumentOutOfRangeException">
  56249. <paramref name="index"/> is not a valid message index.
  56250. </exception>
  56251. <exception cref="T:System.ObjectDisposedException">
  56252. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  56253. </exception>
  56254. <exception cref="T:MailKit.ServiceNotConnectedException">
  56255. The <see cref="T:MailKit.MailSpool"/> is not connected.
  56256. </exception>
  56257. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  56258. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  56259. </exception>
  56260. <exception cref="T:System.OperationCanceledException">
  56261. The operation was canceled via the cancellation token.
  56262. </exception>
  56263. <exception cref="T:System.IO.IOException">
  56264. An I/O error occurred.
  56265. </exception>
  56266. <exception cref="T:MailKit.CommandException">
  56267. The command failed.
  56268. </exception>
  56269. <exception cref="T:MailKit.ProtocolException">
  56270. A protocol error occurred.
  56271. </exception>
  56272. </member>
  56273. <member name="M:MailKit.MailSpool.DeleteMessageAsync(System.Int32,System.Threading.CancellationToken)">
  56274. <summary>
  56275. Asynchronously mark the specified message for deletion.
  56276. </summary>
  56277. <remarks>
  56278. Messages marked for deletion are not actually deleted until the session
  56279. is cleanly disconnected
  56280. (see <see cref="M:MailKit.MailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
  56281. </remarks>
  56282. <returns>An asynchronous task context.</returns>
  56283. <param name="index">The index of the message.</param>
  56284. <param name="cancellationToken">The cancellation token.</param>
  56285. <exception cref="T:System.ArgumentOutOfRangeException">
  56286. <paramref name="index"/> is not a valid message index.
  56287. </exception>
  56288. <exception cref="T:System.ObjectDisposedException">
  56289. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  56290. </exception>
  56291. <exception cref="T:MailKit.ServiceNotConnectedException">
  56292. The <see cref="T:MailKit.MailSpool"/> is not connected.
  56293. </exception>
  56294. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  56295. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  56296. </exception>
  56297. <exception cref="T:System.OperationCanceledException">
  56298. The operation was canceled via the cancellation token.
  56299. </exception>
  56300. <exception cref="T:System.IO.IOException">
  56301. An I/O error occurred.
  56302. </exception>
  56303. <exception cref="T:MailKit.CommandException">
  56304. The command failed.
  56305. </exception>
  56306. <exception cref="T:MailKit.ProtocolException">
  56307. A protocol error occurred.
  56308. </exception>
  56309. </member>
  56310. <member name="M:MailKit.MailSpool.DeleteMessages(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken)">
  56311. <summary>
  56312. Mark the specified messages for deletion.
  56313. </summary>
  56314. <remarks>
  56315. Messages marked for deletion are not actually deleted until the session
  56316. is cleanly disconnected
  56317. (see <see cref="M:MailKit.MailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
  56318. </remarks>
  56319. <param name="indexes">The indexes of the messages.</param>
  56320. <param name="cancellationToken">The cancellation token.</param>
  56321. <exception cref="T:System.ArgumentNullException">
  56322. <paramref name="indexes"/> is <c>null</c>.
  56323. </exception>
  56324. <exception cref="T:System.ArgumentException">
  56325. <para>One or more of the <paramref name="indexes"/> are invalid.</para>
  56326. <para>-or-</para>
  56327. <para>No indexes were specified.</para>
  56328. </exception>
  56329. <exception cref="T:System.ObjectDisposedException">
  56330. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  56331. </exception>
  56332. <exception cref="T:MailKit.ServiceNotConnectedException">
  56333. The <see cref="T:MailKit.MailSpool"/> is not connected.
  56334. </exception>
  56335. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  56336. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  56337. </exception>
  56338. <exception cref="T:System.OperationCanceledException">
  56339. The operation was canceled via the cancellation token.
  56340. </exception>
  56341. <exception cref="T:System.IO.IOException">
  56342. An I/O error occurred.
  56343. </exception>
  56344. <exception cref="T:MailKit.CommandException">
  56345. The command failed.
  56346. </exception>
  56347. <exception cref="T:MailKit.ProtocolException">
  56348. A protocol error occurred.
  56349. </exception>
  56350. </member>
  56351. <member name="M:MailKit.MailSpool.DeleteMessagesAsync(System.Collections.Generic.IList{System.Int32},System.Threading.CancellationToken)">
  56352. <summary>
  56353. Asynchronously mark the specified messages for deletion.
  56354. </summary>
  56355. <remarks>
  56356. Messages marked for deletion are not actually deleted until the session
  56357. is cleanly disconnected
  56358. (see <see cref="M:MailKit.MailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
  56359. </remarks>
  56360. <returns>An asynchronous task context.</returns>
  56361. <param name="indexes">The indexes of the messages.</param>
  56362. <param name="cancellationToken">The cancellation token.</param>
  56363. <exception cref="T:System.ArgumentNullException">
  56364. <paramref name="indexes"/> is <c>null</c>.
  56365. </exception>
  56366. <exception cref="T:System.ArgumentException">
  56367. <para>One or more of the <paramref name="indexes"/> are invalid.</para>
  56368. <para>-or-</para>
  56369. <para>No indexes were specified.</para>
  56370. </exception>
  56371. <exception cref="T:System.ObjectDisposedException">
  56372. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  56373. </exception>
  56374. <exception cref="T:MailKit.ServiceNotConnectedException">
  56375. The <see cref="T:MailKit.MailSpool"/> is not connected.
  56376. </exception>
  56377. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  56378. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  56379. </exception>
  56380. <exception cref="T:System.OperationCanceledException">
  56381. The operation was canceled via the cancellation token.
  56382. </exception>
  56383. <exception cref="T:System.IO.IOException">
  56384. An I/O error occurred.
  56385. </exception>
  56386. <exception cref="T:MailKit.CommandException">
  56387. The command failed.
  56388. </exception>
  56389. <exception cref="T:MailKit.ProtocolException">
  56390. A protocol error occurred.
  56391. </exception>
  56392. </member>
  56393. <member name="M:MailKit.MailSpool.DeleteMessages(System.Int32,System.Int32,System.Threading.CancellationToken)">
  56394. <summary>
  56395. Mark the specified range of messages for deletion.
  56396. </summary>
  56397. <remarks>
  56398. Messages marked for deletion are not actually deleted until the session
  56399. is cleanly disconnected
  56400. (see <see cref="M:MailKit.MailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
  56401. </remarks>
  56402. <example>
  56403. <code language="c#" source="Examples\Pop3Examples.cs" region="BatchDownloadMessages"/>
  56404. </example>
  56405. <param name="startIndex">The index of the first message to mark for deletion.</param>
  56406. <param name="count">The number of messages to mark for deletion.</param>
  56407. <param name="cancellationToken">The cancellation token.</param>
  56408. <exception cref="T:System.ArgumentOutOfRangeException">
  56409. <paramref name="startIndex"/> and <paramref name="count"/> do not specify
  56410. a valid range of messages.
  56411. </exception>
  56412. <exception cref="T:System.ObjectDisposedException">
  56413. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  56414. </exception>
  56415. <exception cref="T:MailKit.ServiceNotConnectedException">
  56416. The <see cref="T:MailKit.MailSpool"/> is not connected.
  56417. </exception>
  56418. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  56419. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  56420. </exception>
  56421. <exception cref="T:System.OperationCanceledException">
  56422. The operation was canceled via the cancellation token.
  56423. </exception>
  56424. <exception cref="T:System.IO.IOException">
  56425. An I/O error occurred.
  56426. </exception>
  56427. <exception cref="T:MailKit.CommandException">
  56428. The command failed.
  56429. </exception>
  56430. <exception cref="T:MailKit.ProtocolException">
  56431. A protocol error occurred.
  56432. </exception>
  56433. </member>
  56434. <member name="M:MailKit.MailSpool.DeleteMessagesAsync(System.Int32,System.Int32,System.Threading.CancellationToken)">
  56435. <summary>
  56436. Asynchronously mark the specified range of messages for deletion.
  56437. </summary>
  56438. <remarks>
  56439. Messages marked for deletion are not actually deleted until the session
  56440. is cleanly disconnected
  56441. (see <see cref="M:MailKit.MailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
  56442. </remarks>
  56443. <returns>An asynchronous task context.</returns>
  56444. <param name="startIndex">The index of the first message to mark for deletion.</param>
  56445. <param name="count">The number of messages to mark for deletion.</param>
  56446. <param name="cancellationToken">The cancellation token.</param>
  56447. <exception cref="T:System.ArgumentOutOfRangeException">
  56448. <paramref name="startIndex"/> and <paramref name="count"/> do not specify
  56449. a valid range of messages.
  56450. </exception>
  56451. <exception cref="T:System.ObjectDisposedException">
  56452. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  56453. </exception>
  56454. <exception cref="T:MailKit.ServiceNotConnectedException">
  56455. The <see cref="T:MailKit.MailSpool"/> is not connected.
  56456. </exception>
  56457. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  56458. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  56459. </exception>
  56460. <exception cref="T:System.OperationCanceledException">
  56461. The operation was canceled via the cancellation token.
  56462. </exception>
  56463. <exception cref="T:System.IO.IOException">
  56464. An I/O error occurred.
  56465. </exception>
  56466. <exception cref="T:MailKit.CommandException">
  56467. The command failed.
  56468. </exception>
  56469. <exception cref="T:MailKit.ProtocolException">
  56470. A protocol error occurred.
  56471. </exception>
  56472. </member>
  56473. <member name="M:MailKit.MailSpool.DeleteAllMessages(System.Threading.CancellationToken)">
  56474. <summary>
  56475. Mark all messages for deletion.
  56476. </summary>
  56477. <remarks>
  56478. Messages marked for deletion are not actually deleted until the session
  56479. is cleanly disconnected
  56480. (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
  56481. </remarks>
  56482. <param name="cancellationToken">The cancellation token.</param>
  56483. <exception cref="T:System.ObjectDisposedException">
  56484. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  56485. </exception>
  56486. <exception cref="T:MailKit.ServiceNotConnectedException">
  56487. The <see cref="T:MailKit.MailSpool"/> is not connected.
  56488. </exception>
  56489. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  56490. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  56491. </exception>
  56492. <exception cref="T:System.OperationCanceledException">
  56493. The operation was canceled via the cancellation token.
  56494. </exception>
  56495. <exception cref="T:System.IO.IOException">
  56496. An I/O error occurred.
  56497. </exception>
  56498. <exception cref="T:MailKit.CommandException">
  56499. The command failed.
  56500. </exception>
  56501. <exception cref="T:MailKit.ProtocolException">
  56502. A protocol error occurred.
  56503. </exception>
  56504. </member>
  56505. <member name="M:MailKit.MailSpool.DeleteAllMessagesAsync(System.Threading.CancellationToken)">
  56506. <summary>
  56507. Asynchronously mark all messages for deletion.
  56508. </summary>
  56509. <remarks>
  56510. Messages marked for deletion are not actually deleted until the session
  56511. is cleanly disconnected
  56512. (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
  56513. </remarks>
  56514. <returns>An asynchronous task context.</returns>
  56515. <param name="cancellationToken">The cancellation token.</param>
  56516. <exception cref="T:System.ObjectDisposedException">
  56517. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  56518. </exception>
  56519. <exception cref="T:MailKit.ServiceNotConnectedException">
  56520. The <see cref="T:MailKit.MailSpool"/> is not connected.
  56521. </exception>
  56522. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  56523. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  56524. </exception>
  56525. <exception cref="T:System.OperationCanceledException">
  56526. The operation was canceled via the cancellation token.
  56527. </exception>
  56528. <exception cref="T:System.IO.IOException">
  56529. An I/O error occurred.
  56530. </exception>
  56531. <exception cref="T:MailKit.CommandException">
  56532. The command failed.
  56533. </exception>
  56534. <exception cref="T:MailKit.ProtocolException">
  56535. A protocol error occurred.
  56536. </exception>
  56537. </member>
  56538. <member name="M:MailKit.MailSpool.Reset(System.Threading.CancellationToken)">
  56539. <summary>
  56540. Reset the state of all messages marked for deletion.
  56541. </summary>
  56542. <remarks>
  56543. Messages marked for deletion are not actually deleted until the session
  56544. is cleanly disconnected
  56545. (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
  56546. </remarks>
  56547. <param name="cancellationToken">The cancellation token.</param>
  56548. <exception cref="T:System.ObjectDisposedException">
  56549. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  56550. </exception>
  56551. <exception cref="T:MailKit.ServiceNotConnectedException">
  56552. The <see cref="T:MailKit.MailSpool"/> is not connected.
  56553. </exception>
  56554. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  56555. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  56556. </exception>
  56557. <exception cref="T:System.OperationCanceledException">
  56558. The operation was canceled via the cancellation token.
  56559. </exception>
  56560. <exception cref="T:System.IO.IOException">
  56561. An I/O error occurred.
  56562. </exception>
  56563. <exception cref="T:MailKit.CommandException">
  56564. The command failed.
  56565. </exception>
  56566. <exception cref="T:MailKit.ProtocolException">
  56567. A protocol error occurred.
  56568. </exception>
  56569. </member>
  56570. <member name="M:MailKit.MailSpool.ResetAsync(System.Threading.CancellationToken)">
  56571. <summary>
  56572. Asynchronously reset the state of all messages marked for deletion.
  56573. </summary>
  56574. <remarks>
  56575. Messages marked for deletion are not actually deleted until the session
  56576. is cleanly disconnected
  56577. (see <see cref="M:MailKit.IMailService.Disconnect(System.Boolean,System.Threading.CancellationToken)"/>).
  56578. </remarks>
  56579. <returns>An asynchronous task context.</returns>
  56580. <param name="cancellationToken">The cancellation token.</param>
  56581. <exception cref="T:System.ObjectDisposedException">
  56582. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  56583. </exception>
  56584. <exception cref="T:MailKit.ServiceNotConnectedException">
  56585. The <see cref="T:MailKit.MailSpool"/> is not connected.
  56586. </exception>
  56587. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  56588. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  56589. </exception>
  56590. <exception cref="T:System.OperationCanceledException">
  56591. The operation was canceled via the cancellation token.
  56592. </exception>
  56593. <exception cref="T:System.IO.IOException">
  56594. An I/O error occurred.
  56595. </exception>
  56596. <exception cref="T:MailKit.CommandException">
  56597. The command failed.
  56598. </exception>
  56599. <exception cref="T:MailKit.ProtocolException">
  56600. A protocol error occurred.
  56601. </exception>
  56602. </member>
  56603. <member name="M:MailKit.MailSpool.GetEnumerator">
  56604. <summary>
  56605. Get an enumerator for the messages in the folder.
  56606. </summary>
  56607. <remarks>
  56608. Gets an enumerator for the messages in the folder.
  56609. </remarks>
  56610. <returns>The enumerator.</returns>
  56611. <exception cref="T:System.ObjectDisposedException">
  56612. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  56613. </exception>
  56614. <exception cref="T:MailKit.ServiceNotConnectedException">
  56615. The <see cref="T:MailKit.MailSpool"/> is not connected.
  56616. </exception>
  56617. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  56618. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  56619. </exception>
  56620. <exception cref="T:System.OperationCanceledException">
  56621. The operation was canceled via the cancellation token.
  56622. </exception>
  56623. <exception cref="T:System.IO.IOException">
  56624. An I/O error occurred.
  56625. </exception>
  56626. <exception cref="T:MailKit.CommandException">
  56627. A command failed.
  56628. </exception>
  56629. <exception cref="T:MailKit.ProtocolException">
  56630. A protocol error occurred.
  56631. </exception>
  56632. </member>
  56633. <member name="M:MailKit.MailSpool.System#Collections#IEnumerable#GetEnumerator">
  56634. <summary>
  56635. Get an enumerator for the messages in the folder.
  56636. </summary>
  56637. <remarks>
  56638. Gets an enumerator for the messages in the folder.
  56639. </remarks>
  56640. <returns>The enumerator.</returns>
  56641. <exception cref="T:System.ObjectDisposedException">
  56642. The <see cref="T:MailKit.MailSpool"/> has been disposed.
  56643. </exception>
  56644. <exception cref="T:MailKit.ServiceNotConnectedException">
  56645. The <see cref="T:MailKit.MailSpool"/> is not connected.
  56646. </exception>
  56647. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  56648. The <see cref="T:MailKit.MailSpool"/> is not authenticated.
  56649. </exception>
  56650. <exception cref="T:System.OperationCanceledException">
  56651. The operation was canceled via the cancellation token.
  56652. </exception>
  56653. <exception cref="T:System.IO.IOException">
  56654. An I/O error occurred.
  56655. </exception>
  56656. <exception cref="T:MailKit.CommandException">
  56657. A command failed.
  56658. </exception>
  56659. <exception cref="T:MailKit.ProtocolException">
  56660. A protocol error occurred.
  56661. </exception>
  56662. </member>
  56663. <member name="T:MailKit.MailStore">
  56664. <summary>
  56665. An abstract mail store implementation.
  56666. </summary>
  56667. <remarks>
  56668. An abstract mail store implementation.
  56669. </remarks>
  56670. </member>
  56671. <member name="M:MailKit.MailStore.#ctor(MailKit.IProtocolLogger)">
  56672. <summary>
  56673. Initializes a new instance of the <see cref="T:MailKit.MailStore"/> class.
  56674. </summary>
  56675. <remarks>
  56676. Initializes a new instance of the <see cref="T:MailKit.MailStore"/> class.
  56677. </remarks>
  56678. <param name="protocolLogger">The protocol logger.</param>
  56679. <exception cref="T:System.ArgumentNullException">
  56680. <paramref name="protocolLogger"/> is <c>null</c>.
  56681. </exception>
  56682. </member>
  56683. <member name="P:MailKit.MailStore.PersonalNamespaces">
  56684. <summary>
  56685. Gets the personal namespaces.
  56686. </summary>
  56687. <remarks>
  56688. The personal folder namespaces contain a user's personal mailbox folders.
  56689. </remarks>
  56690. <value>The personal namespaces.</value>
  56691. </member>
  56692. <member name="P:MailKit.MailStore.SharedNamespaces">
  56693. <summary>
  56694. Gets the shared namespaces.
  56695. </summary>
  56696. <remarks>
  56697. The shared folder namespaces contain mailbox folders that are shared with the user.
  56698. </remarks>
  56699. <value>The shared namespaces.</value>
  56700. </member>
  56701. <member name="P:MailKit.MailStore.OtherNamespaces">
  56702. <summary>
  56703. Gets the other namespaces.
  56704. </summary>
  56705. <remarks>
  56706. The other folder namespaces contain other mailbox folders.
  56707. </remarks>
  56708. <value>The other namespaces.</value>
  56709. </member>
  56710. <member name="P:MailKit.MailStore.SupportsQuotas">
  56711. <summary>
  56712. Get whether or not the mail store supports quotas.
  56713. </summary>
  56714. <remarks>
  56715. Gets whether or not the mail store supports quotas.
  56716. </remarks>
  56717. <value><c>true</c> if the mail store supports quotas; otherwise, <c>false</c>.</value>
  56718. </member>
  56719. <member name="P:MailKit.MailStore.ThreadingAlgorithms">
  56720. <summary>
  56721. Get the threading algorithms supported by the mail store.
  56722. </summary>
  56723. <remarks>
  56724. The threading algorithms are queried as part of the
  56725. <a href="Overload_MailKit_MailStore_Connect.htm">Connect</a>
  56726. and <a href="Overload_MailKit_MailStore_Authenticate.htm">Authenticate</a> methods.
  56727. </remarks>
  56728. <example>
  56729. <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
  56730. </example>
  56731. <value>The supported threading algorithms.</value>
  56732. </member>
  56733. <member name="P:MailKit.MailStore.Inbox">
  56734. <summary>
  56735. Get the Inbox folder.
  56736. </summary>
  56737. <remarks>
  56738. <para>The Inbox folder is the default folder and always exists on the mail store.</para>
  56739. <note type="note">This property will only be available after the client has been authenticated.</note>
  56740. </remarks>
  56741. <value>The Inbox folder.</value>
  56742. </member>
  56743. <member name="M:MailKit.MailStore.EnableQuickResync(System.Threading.CancellationToken)">
  56744. <summary>
  56745. Enable the quick resynchronization feature.
  56746. </summary>
  56747. <remarks>
  56748. <para>Enables quick resynchronization when a folder is opened using the
  56749. <see cref="M:MailKit.MailFolder.Open(MailKit.FolderAccess,System.UInt32,System.UInt64,System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)"/>
  56750. method.</para>
  56751. <para>If this feature is enabled, the <see cref="E:MailKit.MailFolder.MessageExpunged"/> event is replaced
  56752. with the <see cref="E:MailKit.MailFolder.MessagesVanished"/> event.</para>
  56753. <para>This method needs to be called immediately after calling one of the
  56754. <a href="Overload_MailKit_MailService_Authenticate.htm">Authenticate</a> methods, before
  56755. opening any folders.</para>
  56756. </remarks>
  56757. <param name="cancellationToken">The cancellation token.</param>
  56758. <exception cref="T:System.ObjectDisposedException">
  56759. The <see cref="T:MailKit.MailStore"/> has been disposed.
  56760. </exception>
  56761. <exception cref="T:MailKit.ServiceNotConnectedException">
  56762. The <see cref="T:MailKit.MailStore"/> is not connected.
  56763. </exception>
  56764. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  56765. The <see cref="T:MailKit.MailStore"/> is not authenticated.
  56766. </exception>
  56767. <exception cref="T:System.InvalidOperationException">
  56768. Quick resynchronization needs to be enabled before selecting a folder.
  56769. </exception>
  56770. <exception cref="T:System.NotSupportedException">
  56771. The mail store does not support quick resynchronization.
  56772. </exception>
  56773. <exception cref="T:System.OperationCanceledException">
  56774. The operation was canceled via the cancellation token.
  56775. </exception>
  56776. <exception cref="T:System.IO.IOException">
  56777. An I/O error occurred.
  56778. </exception>
  56779. <exception cref="T:MailKit.ProtocolException">
  56780. A protocol error occurred.
  56781. </exception>
  56782. <exception cref="T:MailKit.CommandException">
  56783. The command failed.
  56784. </exception>
  56785. </member>
  56786. <member name="M:MailKit.MailStore.EnableQuickResyncAsync(System.Threading.CancellationToken)">
  56787. <summary>
  56788. Asynchronously enable the quick resynchronization feature.
  56789. </summary>
  56790. <remarks>
  56791. <para>Enables quick resynchronization when a folder is opened using the
  56792. <see cref="M:MailKit.MailFolder.Open(MailKit.FolderAccess,System.UInt32,System.UInt64,System.Collections.Generic.IList{MailKit.UniqueId},System.Threading.CancellationToken)"/>
  56793. method.</para>
  56794. <para>If this feature is enabled, the <see cref="E:MailKit.MailFolder.MessageExpunged"/> event is replaced
  56795. with the <see cref="E:MailKit.MailFolder.MessagesVanished"/> event.</para>
  56796. <para>This method needs to be called immediately after calling one of the
  56797. <a href="Overload_MailKit_MailService_Authenticate.htm">Authenticate</a> methods, before
  56798. opening any folders.</para>
  56799. </remarks>
  56800. <returns>An asynchronous task context.</returns>
  56801. <param name="cancellationToken">The cancellation token.</param>
  56802. <exception cref="T:System.ObjectDisposedException">
  56803. The <see cref="T:MailKit.MailStore"/> has been disposed.
  56804. </exception>
  56805. <exception cref="T:MailKit.ServiceNotConnectedException">
  56806. The <see cref="T:MailKit.MailStore"/> is not connected.
  56807. </exception>
  56808. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  56809. The <see cref="T:MailKit.MailStore"/> is not authenticated.
  56810. </exception>
  56811. <exception cref="T:System.InvalidOperationException">
  56812. Quick resynchronization needs to be enabled before selecting a folder.
  56813. </exception>
  56814. <exception cref="T:System.NotSupportedException">
  56815. The mail store does not support quick resynchronization.
  56816. </exception>
  56817. <exception cref="T:System.OperationCanceledException">
  56818. The operation was canceled via the cancellation token.
  56819. </exception>
  56820. <exception cref="T:System.IO.IOException">
  56821. An I/O error occurred.
  56822. </exception>
  56823. <exception cref="T:MailKit.ProtocolException">
  56824. A protocol error occurred.
  56825. </exception>
  56826. <exception cref="T:MailKit.CommandException">
  56827. The command failed.
  56828. </exception>
  56829. </member>
  56830. <member name="M:MailKit.MailStore.GetFolder(MailKit.SpecialFolder)">
  56831. <summary>
  56832. Get the specified special folder.
  56833. </summary>
  56834. <remarks>
  56835. Not all mail stores support special folders. Each implementation
  56836. should provide a way to determine if special folders are supported.
  56837. </remarks>
  56838. <returns>The folder if available; otherwise <c>null</c>.</returns>
  56839. <param name="folder">The type of special folder.</param>
  56840. <exception cref="T:System.ArgumentOutOfRangeException">
  56841. <paramref name="folder"/> is out of range.
  56842. </exception>
  56843. <exception cref="T:System.ObjectDisposedException">
  56844. The <see cref="T:MailKit.MailStore"/> has been disposed.
  56845. </exception>
  56846. <exception cref="T:MailKit.ServiceNotConnectedException">
  56847. The <see cref="T:MailKit.MailStore"/> is not connected.
  56848. </exception>
  56849. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  56850. The <see cref="T:MailKit.MailStore"/> is not authenticated.
  56851. </exception>
  56852. </member>
  56853. <member name="M:MailKit.MailStore.GetFolder(MailKit.FolderNamespace)">
  56854. <summary>
  56855. Get the folder for the specified namespace.
  56856. </summary>
  56857. <remarks>
  56858. Gets the folder for the specified namespace.
  56859. </remarks>
  56860. <returns>The folder.</returns>
  56861. <param name="namespace">The namespace.</param>
  56862. <exception cref="T:System.ArgumentNullException">
  56863. <paramref name="namespace"/> is <c>null</c>.
  56864. </exception>
  56865. <exception cref="T:System.ObjectDisposedException">
  56866. The <see cref="T:MailKit.MailStore"/> has been disposed.
  56867. </exception>
  56868. <exception cref="T:MailKit.ServiceNotConnectedException">
  56869. The <see cref="T:MailKit.MailStore"/> is not connected.
  56870. </exception>
  56871. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  56872. The <see cref="T:MailKit.MailStore"/> is not authenticated.
  56873. </exception>
  56874. <exception cref="T:MailKit.FolderNotFoundException">
  56875. The folder could not be found.
  56876. </exception>
  56877. </member>
  56878. <member name="M:MailKit.MailStore.GetFolders(MailKit.FolderNamespace,System.Boolean,System.Threading.CancellationToken)">
  56879. <summary>
  56880. Get all of the folders within the specified namespace.
  56881. </summary>
  56882. <remarks>
  56883. Gets all of the folders within the specified namespace.
  56884. </remarks>
  56885. <returns>The folders.</returns>
  56886. <param name="namespace">The namespace.</param>
  56887. <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
  56888. <param name="cancellationToken">The cancellation token.</param>
  56889. <exception cref="T:System.ArgumentNullException">
  56890. <paramref name="namespace"/> is <c>null</c>.
  56891. </exception>
  56892. <exception cref="T:System.ObjectDisposedException">
  56893. The <see cref="T:MailKit.MailStore"/> has been disposed.
  56894. </exception>
  56895. <exception cref="T:MailKit.ServiceNotConnectedException">
  56896. The <see cref="T:MailKit.MailStore"/> is not connected.
  56897. </exception>
  56898. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  56899. The <see cref="T:MailKit.MailStore"/> is not authenticated.
  56900. </exception>
  56901. <exception cref="T:System.OperationCanceledException">
  56902. The operation was canceled via the cancellation token.
  56903. </exception>
  56904. <exception cref="T:System.IO.IOException">
  56905. An I/O error occurred.
  56906. </exception>
  56907. <exception cref="T:MailKit.ProtocolException">
  56908. A protocol error occurred.
  56909. </exception>
  56910. <exception cref="T:MailKit.CommandException">
  56911. The command failed.
  56912. </exception>
  56913. </member>
  56914. <member name="M:MailKit.MailStore.GetFoldersAsync(MailKit.FolderNamespace,System.Boolean,System.Threading.CancellationToken)">
  56915. <summary>
  56916. Asynchronously get all of the folders within the specified namespace.
  56917. </summary>
  56918. <remarks>
  56919. Asynchronously gets all of the folders within the specified namespace.
  56920. </remarks>
  56921. <returns>The folders.</returns>
  56922. <param name="namespace">The namespace.</param>
  56923. <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
  56924. <param name="cancellationToken">The cancellation token.</param>
  56925. <exception cref="T:System.ArgumentNullException">
  56926. <paramref name="namespace"/> is <c>null</c>.
  56927. </exception>
  56928. <exception cref="T:System.ObjectDisposedException">
  56929. The <see cref="T:MailKit.MailStore"/> has been disposed.
  56930. </exception>
  56931. <exception cref="T:MailKit.ServiceNotConnectedException">
  56932. The <see cref="T:MailKit.MailStore"/> is not connected.
  56933. </exception>
  56934. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  56935. The <see cref="T:MailKit.MailStore"/> is not authenticated.
  56936. </exception>
  56937. <exception cref="T:System.OperationCanceledException">
  56938. The operation was canceled via the cancellation token.
  56939. </exception>
  56940. <exception cref="T:System.IO.IOException">
  56941. An I/O error occurred.
  56942. </exception>
  56943. <exception cref="T:MailKit.ProtocolException">
  56944. A protocol error occurred.
  56945. </exception>
  56946. <exception cref="T:MailKit.CommandException">
  56947. The command failed.
  56948. </exception>
  56949. </member>
  56950. <member name="M:MailKit.MailStore.GetFolders(MailKit.FolderNamespace,MailKit.StatusItems,System.Boolean,System.Threading.CancellationToken)">
  56951. <summary>
  56952. Get all of the folders within the specified namespace.
  56953. </summary>
  56954. <remarks>
  56955. Gets all of the folders within the specified namespace.
  56956. </remarks>
  56957. <returns>The folders.</returns>
  56958. <param name="namespace">The namespace.</param>
  56959. <param name="items">The status items to pre-populate.</param>
  56960. <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
  56961. <param name="cancellationToken">The cancellation token.</param>
  56962. <exception cref="T:System.ArgumentNullException">
  56963. <paramref name="namespace"/> is <c>null</c>.
  56964. </exception>
  56965. <exception cref="T:System.ObjectDisposedException">
  56966. The <see cref="T:MailKit.MailStore"/> has been disposed.
  56967. </exception>
  56968. <exception cref="T:MailKit.ServiceNotConnectedException">
  56969. The <see cref="T:MailKit.MailStore"/> is not connected.
  56970. </exception>
  56971. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  56972. The <see cref="T:MailKit.MailStore"/> is not authenticated.
  56973. </exception>
  56974. <exception cref="T:System.OperationCanceledException">
  56975. The operation was canceled via the cancellation token.
  56976. </exception>
  56977. <exception cref="T:System.IO.IOException">
  56978. An I/O error occurred.
  56979. </exception>
  56980. <exception cref="T:MailKit.ProtocolException">
  56981. A protocol error occurred.
  56982. </exception>
  56983. <exception cref="T:MailKit.CommandException">
  56984. The command failed.
  56985. </exception>
  56986. </member>
  56987. <member name="M:MailKit.MailStore.GetFoldersAsync(MailKit.FolderNamespace,MailKit.StatusItems,System.Boolean,System.Threading.CancellationToken)">
  56988. <summary>
  56989. Asynchronously get all of the folders within the specified namespace.
  56990. </summary>
  56991. <remarks>
  56992. Asynchronously gets all of the folders within the specified namespace.
  56993. </remarks>
  56994. <returns>The folders.</returns>
  56995. <param name="namespace">The namespace.</param>
  56996. <param name="items">The status items to pre-populate.</param>
  56997. <param name="subscribedOnly">If set to <c>true</c>, only subscribed folders will be listed.</param>
  56998. <param name="cancellationToken">The cancellation token.</param>
  56999. <exception cref="T:System.ArgumentNullException">
  57000. <paramref name="namespace"/> is <c>null</c>.
  57001. </exception>
  57002. <exception cref="T:System.ObjectDisposedException">
  57003. The <see cref="T:MailKit.MailStore"/> has been disposed.
  57004. </exception>
  57005. <exception cref="T:MailKit.ServiceNotConnectedException">
  57006. The <see cref="T:MailKit.MailStore"/> is not connected.
  57007. </exception>
  57008. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  57009. The <see cref="T:MailKit.MailStore"/> is not authenticated.
  57010. </exception>
  57011. <exception cref="T:System.OperationCanceledException">
  57012. The operation was canceled via the cancellation token.
  57013. </exception>
  57014. <exception cref="T:System.IO.IOException">
  57015. An I/O error occurred.
  57016. </exception>
  57017. <exception cref="T:MailKit.ProtocolException">
  57018. A protocol error occurred.
  57019. </exception>
  57020. <exception cref="T:MailKit.CommandException">
  57021. The command failed.
  57022. </exception>
  57023. </member>
  57024. <member name="M:MailKit.MailStore.GetFolder(System.String,System.Threading.CancellationToken)">
  57025. <summary>
  57026. Get the folder for the specified path.
  57027. </summary>
  57028. <remarks>
  57029. Gets the folder for the specified path.
  57030. </remarks>
  57031. <returns>The folder.</returns>
  57032. <param name="path">The folder path.</param>
  57033. <param name="cancellationToken">The cancellation token.</param>
  57034. <exception cref="T:System.ArgumentNullException">
  57035. <paramref name="path"/> is <c>null</c>.
  57036. </exception>
  57037. <exception cref="T:System.ObjectDisposedException">
  57038. The <see cref="T:MailKit.MailStore"/> has been disposed.
  57039. </exception>
  57040. <exception cref="T:MailKit.ServiceNotConnectedException">
  57041. The <see cref="T:MailKit.MailStore"/> is not connected.
  57042. </exception>
  57043. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  57044. The <see cref="T:MailKit.MailStore"/> is not authenticated.
  57045. </exception>
  57046. <exception cref="T:System.OperationCanceledException">
  57047. The operation was canceled via the cancellation token.
  57048. </exception>
  57049. <exception cref="T:MailKit.FolderNotFoundException">
  57050. The folder could not be found.
  57051. </exception>
  57052. <exception cref="T:System.IO.IOException">
  57053. An I/O error occurred.
  57054. </exception>
  57055. <exception cref="T:MailKit.ProtocolException">
  57056. A protocol error occurred.
  57057. </exception>
  57058. <exception cref="T:MailKit.CommandException">
  57059. The command failed.
  57060. </exception>
  57061. </member>
  57062. <member name="M:MailKit.MailStore.GetFolderAsync(System.String,System.Threading.CancellationToken)">
  57063. <summary>
  57064. Asynchronously get the folder for the specified path.
  57065. </summary>
  57066. <remarks>
  57067. Asynchronously gets the folder for the specified path.
  57068. </remarks>
  57069. <returns>The folder.</returns>
  57070. <param name="path">The folder path.</param>
  57071. <param name="cancellationToken">The cancellation token.</param>
  57072. <exception cref="T:System.ArgumentNullException">
  57073. <paramref name="path"/> is <c>null</c>.
  57074. </exception>
  57075. <exception cref="T:System.ObjectDisposedException">
  57076. The <see cref="T:MailKit.MailStore"/> has been disposed.
  57077. </exception>
  57078. <exception cref="T:MailKit.ServiceNotConnectedException">
  57079. The <see cref="T:MailKit.MailStore"/> is not connected.
  57080. </exception>
  57081. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  57082. The <see cref="T:MailKit.MailStore"/> is not authenticated.
  57083. </exception>
  57084. <exception cref="T:System.OperationCanceledException">
  57085. The operation was canceled via the cancellation token.
  57086. </exception>
  57087. <exception cref="T:MailKit.FolderNotFoundException">
  57088. The folder could not be found.
  57089. </exception>
  57090. <exception cref="T:System.IO.IOException">
  57091. An I/O error occurred.
  57092. </exception>
  57093. <exception cref="T:MailKit.ProtocolException">
  57094. A protocol error occurred.
  57095. </exception>
  57096. <exception cref="T:MailKit.CommandException">
  57097. The command failed.
  57098. </exception>
  57099. </member>
  57100. <member name="M:MailKit.MailStore.GetMetadata(MailKit.MetadataTag,System.Threading.CancellationToken)">
  57101. <summary>
  57102. Gets the specified metadata.
  57103. </summary>
  57104. <remarks>
  57105. Gets the specified metadata.
  57106. </remarks>
  57107. <returns>The requested metadata value.</returns>
  57108. <param name="tag">The metadata tag.</param>
  57109. <param name="cancellationToken">The cancellation token.</param>
  57110. <exception cref="T:System.ObjectDisposedException">
  57111. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  57112. </exception>
  57113. <exception cref="T:MailKit.ServiceNotConnectedException">
  57114. The <see cref="T:MailKit.IMailStore"/> is not connected.
  57115. </exception>
  57116. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  57117. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  57118. </exception>
  57119. <exception cref="T:System.NotSupportedException">
  57120. The folder does not support metadata.
  57121. </exception>
  57122. <exception cref="T:System.OperationCanceledException">
  57123. The operation was canceled via the cancellation token.
  57124. </exception>
  57125. <exception cref="T:System.IO.IOException">
  57126. An I/O error occurred.
  57127. </exception>
  57128. <exception cref="T:MailKit.ProtocolException">
  57129. The server's response contained unexpected tokens.
  57130. </exception>
  57131. <exception cref="T:MailKit.CommandException">
  57132. The command failed.
  57133. </exception>
  57134. </member>
  57135. <member name="M:MailKit.MailStore.GetMetadataAsync(MailKit.MetadataTag,System.Threading.CancellationToken)">
  57136. <summary>
  57137. Asynchronously gets the specified metadata.
  57138. </summary>
  57139. <remarks>
  57140. Asynchronously gets the specified metadata.
  57141. </remarks>
  57142. <returns>The requested metadata value.</returns>
  57143. <param name="tag">The metadata tag.</param>
  57144. <param name="cancellationToken">The cancellation token.</param>
  57145. <exception cref="T:System.ObjectDisposedException">
  57146. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  57147. </exception>
  57148. <exception cref="T:MailKit.ServiceNotConnectedException">
  57149. The <see cref="T:MailKit.IMailStore"/> is not connected.
  57150. </exception>
  57151. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  57152. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  57153. </exception>
  57154. <exception cref="T:System.NotSupportedException">
  57155. The folder does not support metadata.
  57156. </exception>
  57157. <exception cref="T:System.OperationCanceledException">
  57158. The operation was canceled via the cancellation token.
  57159. </exception>
  57160. <exception cref="T:System.IO.IOException">
  57161. An I/O error occurred.
  57162. </exception>
  57163. <exception cref="T:MailKit.ProtocolException">
  57164. The server's response contained unexpected tokens.
  57165. </exception>
  57166. <exception cref="T:MailKit.CommandException">
  57167. The command failed.
  57168. </exception>
  57169. </member>
  57170. <member name="M:MailKit.MailStore.GetMetadata(System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
  57171. <summary>
  57172. Gets the specified metadata.
  57173. </summary>
  57174. <remarks>
  57175. Gets the specified metadata.
  57176. </remarks>
  57177. <returns>The requested metadata.</returns>
  57178. <param name="tags">The metadata tags.</param>
  57179. <param name="cancellationToken">The cancellation token.</param>
  57180. <exception cref="T:System.ArgumentNullException">
  57181. <paramref name="tags"/> is <c>null</c>.
  57182. </exception>
  57183. <exception cref="T:System.ObjectDisposedException">
  57184. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  57185. </exception>
  57186. <exception cref="T:MailKit.ServiceNotConnectedException">
  57187. The <see cref="T:MailKit.IMailStore"/> is not connected.
  57188. </exception>
  57189. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  57190. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  57191. </exception>
  57192. <exception cref="T:System.NotSupportedException">
  57193. The folder does not support metadata.
  57194. </exception>
  57195. <exception cref="T:System.OperationCanceledException">
  57196. The operation was canceled via the cancellation token.
  57197. </exception>
  57198. <exception cref="T:System.IO.IOException">
  57199. An I/O error occurred.
  57200. </exception>
  57201. <exception cref="T:MailKit.ProtocolException">
  57202. The server's response contained unexpected tokens.
  57203. </exception>
  57204. <exception cref="T:MailKit.CommandException">
  57205. The command failed.
  57206. </exception>
  57207. </member>
  57208. <member name="M:MailKit.MailStore.GetMetadataAsync(System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
  57209. <summary>
  57210. Asynchronously gets the specified metadata.
  57211. </summary>
  57212. <remarks>
  57213. Asynchronously gets the specified metadata.
  57214. </remarks>
  57215. <returns>The requested metadata.</returns>
  57216. <param name="tags">The metadata tags.</param>
  57217. <param name="cancellationToken">The cancellation token.</param>
  57218. <exception cref="T:System.ArgumentNullException">
  57219. <paramref name="tags"/> is <c>null</c>.
  57220. </exception>
  57221. <exception cref="T:System.ObjectDisposedException">
  57222. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  57223. </exception>
  57224. <exception cref="T:MailKit.ServiceNotConnectedException">
  57225. The <see cref="T:MailKit.IMailStore"/> is not connected.
  57226. </exception>
  57227. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  57228. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  57229. </exception>
  57230. <exception cref="T:System.NotSupportedException">
  57231. The folder does not support metadata.
  57232. </exception>
  57233. <exception cref="T:System.OperationCanceledException">
  57234. The operation was canceled via the cancellation token.
  57235. </exception>
  57236. <exception cref="T:System.IO.IOException">
  57237. An I/O error occurred.
  57238. </exception>
  57239. <exception cref="T:MailKit.ProtocolException">
  57240. The server's response contained unexpected tokens.
  57241. </exception>
  57242. <exception cref="T:MailKit.CommandException">
  57243. The command failed.
  57244. </exception>
  57245. </member>
  57246. <member name="M:MailKit.MailStore.GetMetadata(MailKit.MetadataOptions,System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
  57247. <summary>
  57248. Gets the specified metadata.
  57249. </summary>
  57250. <remarks>
  57251. Gets the specified metadata.
  57252. </remarks>
  57253. <returns>The requested metadata.</returns>
  57254. <param name="options">The metadata options.</param>
  57255. <param name="tags">The metadata tags.</param>
  57256. <param name="cancellationToken">The cancellation token.</param>
  57257. <exception cref="T:System.ArgumentNullException">
  57258. <para><paramref name="options"/> is <c>null</c>.</para>
  57259. <para>-or-</para>
  57260. <para><paramref name="tags"/> is <c>null</c>.</para>
  57261. </exception>
  57262. <exception cref="T:System.ObjectDisposedException">
  57263. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  57264. </exception>
  57265. <exception cref="T:MailKit.ServiceNotConnectedException">
  57266. The <see cref="T:MailKit.IMailStore"/> is not connected.
  57267. </exception>
  57268. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  57269. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  57270. </exception>
  57271. <exception cref="T:System.NotSupportedException">
  57272. The folder does not support metadata.
  57273. </exception>
  57274. <exception cref="T:System.OperationCanceledException">
  57275. The operation was canceled via the cancellation token.
  57276. </exception>
  57277. <exception cref="T:System.IO.IOException">
  57278. An I/O error occurred.
  57279. </exception>
  57280. <exception cref="T:MailKit.ProtocolException">
  57281. The server's response contained unexpected tokens.
  57282. </exception>
  57283. <exception cref="T:MailKit.CommandException">
  57284. The command failed.
  57285. </exception>
  57286. </member>
  57287. <member name="M:MailKit.MailStore.GetMetadataAsync(MailKit.MetadataOptions,System.Collections.Generic.IEnumerable{MailKit.MetadataTag},System.Threading.CancellationToken)">
  57288. <summary>
  57289. Asynchronously gets the specified metadata.
  57290. </summary>
  57291. <remarks>
  57292. Asynchronously gets the specified metadata.
  57293. </remarks>
  57294. <returns>The requested metadata.</returns>
  57295. <param name="options">The metadata options.</param>
  57296. <param name="tags">The metadata tags.</param>
  57297. <param name="cancellationToken">The cancellation token.</param>
  57298. <exception cref="T:System.ArgumentNullException">
  57299. <para><paramref name="options"/> is <c>null</c>.</para>
  57300. <para>-or-</para>
  57301. <para><paramref name="tags"/> is <c>null</c>.</para>
  57302. </exception>
  57303. <exception cref="T:System.ObjectDisposedException">
  57304. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  57305. </exception>
  57306. <exception cref="T:MailKit.ServiceNotConnectedException">
  57307. The <see cref="T:MailKit.IMailStore"/> is not connected.
  57308. </exception>
  57309. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  57310. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  57311. </exception>
  57312. <exception cref="T:System.NotSupportedException">
  57313. The folder does not support metadata.
  57314. </exception>
  57315. <exception cref="T:System.OperationCanceledException">
  57316. The operation was canceled via the cancellation token.
  57317. </exception>
  57318. <exception cref="T:System.IO.IOException">
  57319. An I/O error occurred.
  57320. </exception>
  57321. <exception cref="T:MailKit.ProtocolException">
  57322. The server's response contained unexpected tokens.
  57323. </exception>
  57324. <exception cref="T:MailKit.CommandException">
  57325. The command failed.
  57326. </exception>
  57327. </member>
  57328. <member name="M:MailKit.MailStore.SetMetadata(MailKit.MetadataCollection,System.Threading.CancellationToken)">
  57329. <summary>
  57330. Sets the specified metadata.
  57331. </summary>
  57332. <remarks>
  57333. Sets the specified metadata.
  57334. </remarks>
  57335. <param name="metadata">The metadata.</param>
  57336. <param name="cancellationToken">The cancellation token.</param>
  57337. <exception cref="T:System.ArgumentNullException">
  57338. <paramref name="metadata"/> is <c>null</c>.
  57339. </exception>
  57340. <exception cref="T:System.ObjectDisposedException">
  57341. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  57342. </exception>
  57343. <exception cref="T:MailKit.ServiceNotConnectedException">
  57344. The <see cref="T:MailKit.IMailStore"/> is not connected.
  57345. </exception>
  57346. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  57347. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  57348. </exception>
  57349. <exception cref="T:System.NotSupportedException">
  57350. The folder does not support metadata.
  57351. </exception>
  57352. <exception cref="T:System.OperationCanceledException">
  57353. The operation was canceled via the cancellation token.
  57354. </exception>
  57355. <exception cref="T:System.IO.IOException">
  57356. An I/O error occurred.
  57357. </exception>
  57358. <exception cref="T:MailKit.ProtocolException">
  57359. The server's response contained unexpected tokens.
  57360. </exception>
  57361. <exception cref="T:MailKit.CommandException">
  57362. The command failed.
  57363. </exception>
  57364. </member>
  57365. <member name="M:MailKit.MailStore.SetMetadataAsync(MailKit.MetadataCollection,System.Threading.CancellationToken)">
  57366. <summary>
  57367. Asynchronously sets the specified metadata.
  57368. </summary>
  57369. <remarks>
  57370. Asynchronously sets the specified metadata.
  57371. </remarks>
  57372. <returns>An asynchronous task context.</returns>
  57373. <param name="metadata">The metadata.</param>
  57374. <param name="cancellationToken">The cancellation token.</param>
  57375. <exception cref="T:System.ArgumentNullException">
  57376. <paramref name="metadata"/> is <c>null</c>.
  57377. </exception>
  57378. <exception cref="T:System.ObjectDisposedException">
  57379. The <see cref="T:MailKit.IMailStore"/> has been disposed.
  57380. </exception>
  57381. <exception cref="T:MailKit.ServiceNotConnectedException">
  57382. The <see cref="T:MailKit.IMailStore"/> is not connected.
  57383. </exception>
  57384. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  57385. The <see cref="T:MailKit.IMailStore"/> is not authenticated.
  57386. </exception>
  57387. <exception cref="T:System.NotSupportedException">
  57388. The folder does not support metadata.
  57389. </exception>
  57390. <exception cref="T:System.OperationCanceledException">
  57391. The operation was canceled via the cancellation token.
  57392. </exception>
  57393. <exception cref="T:System.IO.IOException">
  57394. An I/O error occurred.
  57395. </exception>
  57396. <exception cref="T:MailKit.ProtocolException">
  57397. The server's response contained unexpected tokens.
  57398. </exception>
  57399. <exception cref="T:MailKit.CommandException">
  57400. The command failed.
  57401. </exception>
  57402. </member>
  57403. <member name="E:MailKit.MailStore.Alert">
  57404. <summary>
  57405. Occurs when a remote message store receives an alert message from the server.
  57406. </summary>
  57407. <remarks>
  57408. The <see cref="E:MailKit.MailStore.Alert"/> event is raised whenever the mail server sends an
  57409. alert message.
  57410. </remarks>
  57411. </member>
  57412. <member name="M:MailKit.MailStore.OnAlert(System.String)">
  57413. <summary>
  57414. Raise the alert event.
  57415. </summary>
  57416. <remarks>
  57417. Raises the alert event.
  57418. </remarks>
  57419. <param name="message">The alert message.</param>
  57420. <exception cref="T:System.ArgumentNullException">
  57421. <paramref name="message"/> is <c>null</c>.
  57422. </exception>
  57423. </member>
  57424. <member name="E:MailKit.MailStore.FolderCreated">
  57425. <summary>
  57426. Occurs when a folder is created.
  57427. </summary>
  57428. <remarks>
  57429. The <see cref="E:MailKit.MailStore.FolderCreated"/> event is emitted when a new folder is created.
  57430. </remarks>
  57431. </member>
  57432. <member name="M:MailKit.MailStore.OnFolderCreated(MailKit.IMailFolder)">
  57433. <summary>
  57434. Raise the folder created event.
  57435. </summary>
  57436. <remarks>
  57437. Raises the folder created event.
  57438. </remarks>
  57439. <param name="folder">The folder that was just created.</param>
  57440. </member>
  57441. <member name="E:MailKit.MailStore.MetadataChanged">
  57442. <summary>
  57443. Occurs when metadata changes.
  57444. </summary>
  57445. <remarks>
  57446. The <see cref="E:MailKit.MailStore.MetadataChanged"/> event is emitted when metadata changes.
  57447. </remarks>
  57448. </member>
  57449. <member name="M:MailKit.MailStore.OnMetadataChanged(MailKit.Metadata)">
  57450. <summary>
  57451. Raise the metadata changed event.
  57452. </summary>
  57453. <remarks>
  57454. Raises the metadata changed event.
  57455. </remarks>
  57456. <param name="metadata">The metadata that changed.</param>
  57457. </member>
  57458. <member name="T:MailKit.MailTransport">
  57459. <summary>
  57460. An abstract mail transport implementation.
  57461. </summary>
  57462. <remarks>
  57463. An abstract mail transport implementation.
  57464. </remarks>
  57465. </member>
  57466. <member name="M:MailKit.MailTransport.#ctor(MailKit.IProtocolLogger)">
  57467. <summary>
  57468. Initializes a new instance of the <see cref="T:MailKit.MailTransport"/> class.
  57469. </summary>
  57470. <remarks>
  57471. Initializes a new instance of the <see cref="T:MailKit.MailTransport"/> class.
  57472. </remarks>
  57473. <param name="protocolLogger">The protocol logger.</param>
  57474. <exception cref="T:System.ArgumentNullException">
  57475. <paramref name="protocolLogger"/> is <c>null</c>.
  57476. </exception>
  57477. </member>
  57478. <member name="M:MailKit.MailTransport.Send(MimeKit.MimeMessage,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  57479. <summary>
  57480. Send the specified message.
  57481. </summary>
  57482. <remarks>
  57483. <para>Sends the specified message.</para>
  57484. <para>The sender address is determined by checking the following
  57485. message headers (in order of precedence): Resent-Sender,
  57486. Resent-From, Sender, and From.</para>
  57487. <para>If either the Resent-Sender or Resent-From addresses are present,
  57488. the recipients are collected from the Resent-To, Resent-Cc, and
  57489. Resent-Bcc headers, otherwise the To, Cc, and Bcc headers are used.</para>
  57490. </remarks>
  57491. <example>
  57492. <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessage"/>
  57493. </example>
  57494. <param name="message">The message.</param>
  57495. <param name="cancellationToken">The cancellation token.</param>
  57496. <param name="progress">The progress reporting mechanism.</param>
  57497. <exception cref="T:System.ArgumentNullException">
  57498. <paramref name="message"/> is <c>null</c>.
  57499. </exception>
  57500. <exception cref="T:System.ObjectDisposedException">
  57501. The <see cref="T:MailKit.MailTransport"/> has been disposed.
  57502. </exception>
  57503. <exception cref="T:MailKit.ServiceNotConnectedException">
  57504. The <see cref="T:MailKit.MailTransport"/> is not connected.
  57505. </exception>
  57506. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  57507. Authentication is required before sending a message.
  57508. </exception>
  57509. <exception cref="T:System.InvalidOperationException">
  57510. <para>A sender has not been specified.</para>
  57511. <para>-or-</para>
  57512. <para>No recipients have been specified.</para>
  57513. </exception>
  57514. <exception cref="T:System.OperationCanceledException">
  57515. The operation has been canceled.
  57516. </exception>
  57517. <exception cref="T:System.IO.IOException">
  57518. An I/O error occurred.
  57519. </exception>
  57520. <exception cref="T:MailKit.CommandException">
  57521. The send command failed.
  57522. </exception>
  57523. <exception cref="T:MailKit.ProtocolException">
  57524. A protocol exception occurred.
  57525. </exception>
  57526. </member>
  57527. <member name="M:MailKit.MailTransport.SendAsync(MimeKit.MimeMessage,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  57528. <summary>
  57529. Asynchronously send the specified message.
  57530. </summary>
  57531. <remarks>
  57532. <para>Asynchronously sends the specified message.</para>
  57533. <para>The sender address is determined by checking the following
  57534. message headers (in order of precedence): Resent-Sender,
  57535. Resent-From, Sender, and From.</para>
  57536. <para>If either the Resent-Sender or Resent-From addresses are present,
  57537. the recipients are collected from the Resent-To, Resent-Cc, and
  57538. Resent-Bcc headers, otherwise the To, Cc, and Bcc headers are used.</para>
  57539. </remarks>
  57540. <returns>An asynchronous task context.</returns>
  57541. <param name="message">The message.</param>
  57542. <param name="cancellationToken">The cancellation token.</param>
  57543. <param name="progress">The progress reporting mechanism.</param>
  57544. <exception cref="T:System.ArgumentNullException">
  57545. <paramref name="message"/> is <c>null</c>.
  57546. </exception>
  57547. <exception cref="T:System.ObjectDisposedException">
  57548. The <see cref="T:MailKit.MailTransport"/> has been disposed.
  57549. </exception>
  57550. <exception cref="T:MailKit.ServiceNotConnectedException">
  57551. The <see cref="T:MailKit.MailTransport"/> is not connected.
  57552. </exception>
  57553. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  57554. Authentication is required before sending a message.
  57555. </exception>
  57556. <exception cref="T:System.InvalidOperationException">
  57557. <para>A sender has not been specified.</para>
  57558. <para>-or-</para>
  57559. <para>No recipients have been specified.</para>
  57560. </exception>
  57561. <exception cref="T:System.OperationCanceledException">
  57562. The operation has been canceled.
  57563. </exception>
  57564. <exception cref="T:System.IO.IOException">
  57565. An I/O error occurred.
  57566. </exception>
  57567. <exception cref="T:MailKit.CommandException">
  57568. The send command failed.
  57569. </exception>
  57570. <exception cref="T:MailKit.ProtocolException">
  57571. A protocol exception occurred.
  57572. </exception>
  57573. </member>
  57574. <member name="M:MailKit.MailTransport.Send(MimeKit.MimeMessage,MimeKit.MailboxAddress,System.Collections.Generic.IEnumerable{MimeKit.MailboxAddress},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  57575. <summary>
  57576. Send the specified message using the supplied sender and recipients.
  57577. </summary>
  57578. <remarks>
  57579. Sends the specified message using the supplied sender and recipients.
  57580. </remarks>
  57581. <param name="message">The message.</param>
  57582. <param name="sender">The mailbox address to use for sending the message.</param>
  57583. <param name="recipients">The mailbox addresses that should receive the message.</param>
  57584. <param name="cancellationToken">The cancellation token.</param>
  57585. <param name="progress">The progress reporting mechanism.</param>
  57586. <exception cref="T:System.ArgumentNullException">
  57587. <para><paramref name="message"/> is <c>null</c>.</para>
  57588. <para>-or-</para>
  57589. <para><paramref name="sender"/> is <c>null</c>.</para>
  57590. <para>-or-</para>
  57591. <para><paramref name="recipients"/> is <c>null</c>.</para>
  57592. </exception>
  57593. <exception cref="T:System.ObjectDisposedException">
  57594. The <see cref="T:MailKit.MailTransport"/> has been disposed.
  57595. </exception>
  57596. <exception cref="T:MailKit.ServiceNotConnectedException">
  57597. The <see cref="T:MailKit.MailTransport"/> is not connected.
  57598. </exception>
  57599. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  57600. Authentication is required before sending a message.
  57601. </exception>
  57602. <exception cref="T:System.InvalidOperationException">
  57603. <para>A sender has not been specified.</para>
  57604. <para>-or-</para>
  57605. <para>No recipients have been specified.</para>
  57606. </exception>
  57607. <exception cref="T:System.OperationCanceledException">
  57608. The operation has been canceled.
  57609. </exception>
  57610. <exception cref="T:System.IO.IOException">
  57611. An I/O error occurred.
  57612. </exception>
  57613. <exception cref="T:MailKit.CommandException">
  57614. The send command failed.
  57615. </exception>
  57616. <exception cref="T:MailKit.ProtocolException">
  57617. A protocol exception occurred.
  57618. </exception>
  57619. </member>
  57620. <member name="M:MailKit.MailTransport.SendAsync(MimeKit.MimeMessage,MimeKit.MailboxAddress,System.Collections.Generic.IEnumerable{MimeKit.MailboxAddress},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  57621. <summary>
  57622. Asynchronously send the specified message using the supplied sender and recipients.
  57623. </summary>
  57624. <remarks>
  57625. Asynchronously sends the specified message using the supplied sender and recipients.
  57626. </remarks>
  57627. <returns>An asynchronous task context.</returns>
  57628. <param name="message">The message.</param>
  57629. <param name="sender">The mailbox address to use for sending the message.</param>
  57630. <param name="recipients">The mailbox addresses that should receive the message.</param>
  57631. <param name="cancellationToken">The cancellation token.</param>
  57632. <param name="progress">The progress reporting mechanism.</param>
  57633. <exception cref="T:System.ArgumentNullException">
  57634. <para><paramref name="message"/> is <c>null</c>.</para>
  57635. <para>-or-</para>
  57636. <para><paramref name="sender"/> is <c>null</c>.</para>
  57637. <para>-or-</para>
  57638. <para><paramref name="recipients"/> is <c>null</c>.</para>
  57639. </exception>
  57640. <exception cref="T:System.ObjectDisposedException">
  57641. The <see cref="T:MailKit.MailTransport"/> has been disposed.
  57642. </exception>
  57643. <exception cref="T:MailKit.ServiceNotConnectedException">
  57644. The <see cref="T:MailKit.MailTransport"/> is not connected.
  57645. </exception>
  57646. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  57647. Authentication is required before sending a message.
  57648. </exception>
  57649. <exception cref="T:System.InvalidOperationException">
  57650. <para>A sender has not been specified.</para>
  57651. <para>-or-</para>
  57652. <para>No recipients have been specified.</para>
  57653. </exception>
  57654. <exception cref="T:System.OperationCanceledException">
  57655. The operation has been canceled.
  57656. </exception>
  57657. <exception cref="T:System.IO.IOException">
  57658. An I/O error occurred.
  57659. </exception>
  57660. <exception cref="T:MailKit.CommandException">
  57661. The send command failed.
  57662. </exception>
  57663. <exception cref="T:MailKit.ProtocolException">
  57664. A protocol exception occurred.
  57665. </exception>
  57666. </member>
  57667. <member name="M:MailKit.MailTransport.Send(MimeKit.FormatOptions,MimeKit.MimeMessage,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  57668. <summary>
  57669. Send the specified message.
  57670. </summary>
  57671. <remarks>
  57672. <para>Sends the specified message.</para>
  57673. <para>The sender address is determined by checking the following
  57674. message headers (in order of precedence): Resent-Sender,
  57675. Resent-From, Sender, and From.</para>
  57676. <para>If either the Resent-Sender or Resent-From addresses are present,
  57677. the recipients are collected from the Resent-To, Resent-Cc, and
  57678. Resent-Bcc headers, otherwise the To, Cc, and Bcc headers are used.</para>
  57679. </remarks>
  57680. <example>
  57681. <code language="c#" source="Examples\SmtpExamples.cs" region="SendMessageWithOptions"/>
  57682. </example>
  57683. <param name="options">The formatting options.</param>
  57684. <param name="message">The message.</param>
  57685. <param name="cancellationToken">The cancellation token.</param>
  57686. <param name="progress">The progress reporting mechanism.</param>
  57687. <exception cref="T:System.ArgumentNullException">
  57688. <para><paramref name="options"/> is <c>null</c>.</para>
  57689. <para>-or-</para>
  57690. <para><paramref name="message"/> is <c>null</c>.</para>
  57691. </exception>
  57692. <exception cref="T:System.ObjectDisposedException">
  57693. The <see cref="T:MailKit.MailTransport"/> has been disposed.
  57694. </exception>
  57695. <exception cref="T:MailKit.ServiceNotConnectedException">
  57696. The <see cref="T:MailKit.MailTransport"/> is not connected.
  57697. </exception>
  57698. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  57699. Authentication is required before sending a message.
  57700. </exception>
  57701. <exception cref="T:System.InvalidOperationException">
  57702. <para>A sender has not been specified.</para>
  57703. <para>-or-</para>
  57704. <para>No recipients have been specified.</para>
  57705. </exception>
  57706. <exception cref="T:System.OperationCanceledException">
  57707. The operation has been canceled.
  57708. </exception>
  57709. <exception cref="T:System.NotSupportedException">
  57710. <para>Internationalized formatting was requested but is not supported by the transport.</para>
  57711. </exception>
  57712. <exception cref="T:System.IO.IOException">
  57713. An I/O error occurred.
  57714. </exception>
  57715. <exception cref="T:MailKit.CommandException">
  57716. The send command failed.
  57717. </exception>
  57718. <exception cref="T:MailKit.ProtocolException">
  57719. A protocol exception occurred.
  57720. </exception>
  57721. </member>
  57722. <member name="M:MailKit.MailTransport.SendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,System.Threading.CancellationToken,MailKit.ITransferProgress)">
  57723. <summary>
  57724. Asynchronously send the specified message.
  57725. </summary>
  57726. <remarks>
  57727. <para>Asynchronously sends the specified message.</para>
  57728. <para>The sender address is determined by checking the following
  57729. message headers (in order of precedence): Resent-Sender,
  57730. Resent-From, Sender, and From.</para>
  57731. <para>If either the Resent-Sender or Resent-From addresses are present,
  57732. the recipients are collected from the Resent-To, Resent-Cc, and
  57733. Resent-Bcc headers, otherwise the To, Cc, and Bcc headers are used.</para>
  57734. </remarks>
  57735. <returns>An asynchronous task context.</returns>
  57736. <param name="options">The formatting options.</param>
  57737. <param name="message">The message.</param>
  57738. <param name="cancellationToken">The cancellation token.</param>
  57739. <param name="progress">The progress reporting mechanism.</param>
  57740. <exception cref="T:System.ArgumentNullException">
  57741. <para><paramref name="options"/> is <c>null</c>.</para>
  57742. <para>-or-</para>
  57743. <para><paramref name="message"/> is <c>null</c>.</para>
  57744. </exception>
  57745. <exception cref="T:System.ObjectDisposedException">
  57746. The <see cref="T:MailKit.MailTransport"/> has been disposed.
  57747. </exception>
  57748. <exception cref="T:MailKit.ServiceNotConnectedException">
  57749. The <see cref="T:MailKit.MailTransport"/> is not connected.
  57750. </exception>
  57751. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  57752. Authentication is required before sending a message.
  57753. </exception>
  57754. <exception cref="T:System.InvalidOperationException">
  57755. <para>A sender has not been specified.</para>
  57756. <para>-or-</para>
  57757. <para>No recipients have been specified.</para>
  57758. </exception>
  57759. <exception cref="T:System.OperationCanceledException">
  57760. The operation has been canceled.
  57761. </exception>
  57762. <exception cref="T:System.NotSupportedException">
  57763. <para>Internationalized formatting was requested but is not supported by the transport.</para>
  57764. </exception>
  57765. <exception cref="T:System.IO.IOException">
  57766. An I/O error occurred.
  57767. </exception>
  57768. <exception cref="T:MailKit.CommandException">
  57769. The send command failed.
  57770. </exception>
  57771. <exception cref="T:MailKit.ProtocolException">
  57772. A protocol exception occurred.
  57773. </exception>
  57774. </member>
  57775. <member name="M:MailKit.MailTransport.Send(MimeKit.FormatOptions,MimeKit.MimeMessage,MimeKit.MailboxAddress,System.Collections.Generic.IEnumerable{MimeKit.MailboxAddress},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  57776. <summary>
  57777. Send the specified message using the supplied sender and recipients.
  57778. </summary>
  57779. <remarks>
  57780. Sends the specified message using the supplied sender and recipients.
  57781. </remarks>
  57782. <param name="options">The formatting options.</param>
  57783. <param name="message">The message.</param>
  57784. <param name="sender">The mailbox address to use for sending the message.</param>
  57785. <param name="recipients">The mailbox addresses that should receive the message.</param>
  57786. <param name="cancellationToken">The cancellation token.</param>
  57787. <param name="progress">The progress reporting mechanism.</param>
  57788. <exception cref="T:System.ArgumentNullException">
  57789. <para><paramref name="options"/> is <c>null</c>.</para>
  57790. <para>-or-</para>
  57791. <para><paramref name="message"/> is <c>null</c>.</para>
  57792. <para>-or-</para>
  57793. <para><paramref name="sender"/> is <c>null</c>.</para>
  57794. <para>-or-</para>
  57795. <para><paramref name="recipients"/> is <c>null</c>.</para>
  57796. </exception>
  57797. <exception cref="T:System.ObjectDisposedException">
  57798. The <see cref="T:MailKit.MailTransport"/> has been disposed.
  57799. </exception>
  57800. <exception cref="T:MailKit.ServiceNotConnectedException">
  57801. The <see cref="T:MailKit.MailTransport"/> is not connected.
  57802. </exception>
  57803. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  57804. Authentication is required before sending a message.
  57805. </exception>
  57806. <exception cref="T:System.InvalidOperationException">
  57807. <para>A sender has not been specified.</para>
  57808. <para>-or-</para>
  57809. <para>No recipients have been specified.</para>
  57810. </exception>
  57811. <exception cref="T:System.OperationCanceledException">
  57812. The operation has been canceled.
  57813. </exception>
  57814. <exception cref="T:System.NotSupportedException">
  57815. <para>Internationalized formatting was requested but is not supported by the transport.</para>
  57816. </exception>
  57817. <exception cref="T:System.IO.IOException">
  57818. An I/O error occurred.
  57819. </exception>
  57820. <exception cref="T:MailKit.CommandException">
  57821. The send command failed.
  57822. </exception>
  57823. <exception cref="T:MailKit.ProtocolException">
  57824. A protocol exception occurred.
  57825. </exception>
  57826. </member>
  57827. <member name="M:MailKit.MailTransport.SendAsync(MimeKit.FormatOptions,MimeKit.MimeMessage,MimeKit.MailboxAddress,System.Collections.Generic.IEnumerable{MimeKit.MailboxAddress},System.Threading.CancellationToken,MailKit.ITransferProgress)">
  57828. <summary>
  57829. Asynchronously send the specified message using the supplied sender and recipients.
  57830. </summary>
  57831. <remarks>
  57832. Asynchronously sends the specified message using the supplied sender and recipients.
  57833. </remarks>
  57834. <returns>An asynchronous task context.</returns>
  57835. <param name="options">The formatting options.</param>
  57836. <param name="message">The message.</param>
  57837. <param name="sender">The mailbox address to use for sending the message.</param>
  57838. <param name="recipients">The mailbox addresses that should receive the message.</param>
  57839. <param name="cancellationToken">The cancellation token.</param>
  57840. <param name="progress">The progress reporting mechanism.</param>
  57841. <exception cref="T:System.ArgumentNullException">
  57842. <para><paramref name="options"/> is <c>null</c>.</para>
  57843. <para>-or-</para>
  57844. <para><paramref name="message"/> is <c>null</c>.</para>
  57845. <para>-or-</para>
  57846. <para><paramref name="sender"/> is <c>null</c>.</para>
  57847. <para>-or-</para>
  57848. <para><paramref name="recipients"/> is <c>null</c>.</para>
  57849. </exception>
  57850. <exception cref="T:System.ObjectDisposedException">
  57851. The <see cref="T:MailKit.MailTransport"/> has been disposed.
  57852. </exception>
  57853. <exception cref="T:MailKit.ServiceNotConnectedException">
  57854. The <see cref="T:MailKit.MailTransport"/> is not connected.
  57855. </exception>
  57856. <exception cref="T:MailKit.ServiceNotAuthenticatedException">
  57857. Authentication is required before sending a message.
  57858. </exception>
  57859. <exception cref="T:System.InvalidOperationException">
  57860. <para>A sender has not been specified.</para>
  57861. <para>-or-</para>
  57862. <para>No recipients have been specified.</para>
  57863. </exception>
  57864. <exception cref="T:System.OperationCanceledException">
  57865. The operation has been canceled.
  57866. </exception>
  57867. <exception cref="T:System.NotSupportedException">
  57868. <para>Internationalized formatting was requested but is not supported by the transport.</para>
  57869. </exception>
  57870. <exception cref="T:System.IO.IOException">
  57871. An I/O error occurred.
  57872. </exception>
  57873. <exception cref="T:MailKit.CommandException">
  57874. The send command failed.
  57875. </exception>
  57876. <exception cref="T:MailKit.ProtocolException">
  57877. A protocol exception occurred.
  57878. </exception>
  57879. </member>
  57880. <member name="E:MailKit.MailTransport.MessageSent">
  57881. <summary>
  57882. Occurs when a message is successfully sent via the transport.
  57883. </summary>
  57884. <remarks>
  57885. The <see cref="E:MailKit.MailTransport.MessageSent"/> event will be emitted each time a message is successfully sent.
  57886. </remarks>
  57887. </member>
  57888. <member name="M:MailKit.MailTransport.OnMessageSent(MailKit.MessageSentEventArgs)">
  57889. <summary>
  57890. Raise the message sent event.
  57891. </summary>
  57892. <remarks>
  57893. Raises the message sent event.
  57894. </remarks>
  57895. <param name="e">The message sent event args.</param>
  57896. </member>
  57897. <member name="T:MailKit.MessageEventArgs">
  57898. <summary>
  57899. Event args used when the state of a message changes.
  57900. </summary>
  57901. <remarks>
  57902. Event args used when the state of a message changes.
  57903. </remarks>
  57904. </member>
  57905. <member name="M:MailKit.MessageEventArgs.#ctor(System.Int32)">
  57906. <summary>
  57907. Initializes a new instance of the <see cref="T:MailKit.MessageEventArgs"/> class.
  57908. </summary>
  57909. <remarks>
  57910. Creates a new <see cref="T:MailKit.MessageEventArgs"/>.
  57911. </remarks>
  57912. <param name="index">The message index.</param>
  57913. <exception cref="T:System.ArgumentOutOfRangeException">
  57914. <paramref name="index"/> is out of range.
  57915. </exception>
  57916. </member>
  57917. <member name="M:MailKit.MessageEventArgs.#ctor(System.Int32,MailKit.UniqueId)">
  57918. <summary>
  57919. Initializes a new instance of the <see cref="T:MailKit.MessageEventArgs"/> class.
  57920. </summary>
  57921. <remarks>
  57922. Creates a new <see cref="T:MailKit.MessageEventArgs"/>.
  57923. </remarks>
  57924. <param name="index">The message index.</param>
  57925. <param name="uid">The unique id of the message.</param>
  57926. <exception cref="T:System.ArgumentOutOfRangeException">
  57927. <paramref name="index"/> is out of range.
  57928. </exception>
  57929. </member>
  57930. <member name="P:MailKit.MessageEventArgs.Index">
  57931. <summary>
  57932. Gets the index of the message that changed.
  57933. </summary>
  57934. <remarks>
  57935. Gets the index of the message that changed.
  57936. </remarks>
  57937. <value>The index of the message.</value>
  57938. </member>
  57939. <member name="P:MailKit.MessageEventArgs.UniqueId">
  57940. <summary>
  57941. Gets the unique ID of the message that changed, if available.
  57942. </summary>
  57943. <remarks>
  57944. Gets the unique ID of the message that changed, if available.
  57945. </remarks>
  57946. <value>The unique ID of the message.</value>
  57947. </member>
  57948. <member name="T:MailKit.MessageFlags">
  57949. <summary>
  57950. An enumeration of message flags.
  57951. </summary>
  57952. <remarks>
  57953. An enumeration of message flags.
  57954. </remarks>
  57955. </member>
  57956. <member name="F:MailKit.MessageFlags.None">
  57957. <summary>
  57958. No message flags are set.
  57959. </summary>
  57960. </member>
  57961. <member name="F:MailKit.MessageFlags.Seen">
  57962. <summary>
  57963. The message has been read.
  57964. </summary>
  57965. </member>
  57966. <member name="F:MailKit.MessageFlags.Answered">
  57967. <summary>
  57968. The message has been answered (replied to).
  57969. </summary>
  57970. </member>
  57971. <member name="F:MailKit.MessageFlags.Flagged">
  57972. <summary>
  57973. The message has been flagged for importance.
  57974. </summary>
  57975. </member>
  57976. <member name="F:MailKit.MessageFlags.Deleted">
  57977. <summary>
  57978. The message has been marked for deletion.
  57979. </summary>
  57980. </member>
  57981. <member name="F:MailKit.MessageFlags.Draft">
  57982. <summary>
  57983. The message is marked as a draft.
  57984. </summary>
  57985. </member>
  57986. <member name="F:MailKit.MessageFlags.Recent">
  57987. <summary>
  57988. The message has just recently arrived in the folder.
  57989. </summary>
  57990. </member>
  57991. <member name="F:MailKit.MessageFlags.UserDefined">
  57992. <summary>
  57993. User-defined flags are allowed by the folder.
  57994. </summary>
  57995. </member>
  57996. <member name="T:MailKit.MessageFlagsChangedEventArgs">
  57997. <summary>
  57998. Event args for the <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> event.
  57999. </summary>
  58000. <remarks>
  58001. Event args for the <see cref="E:MailKit.IMailFolder.MessageFlagsChanged"/> event.
  58002. </remarks>
  58003. </member>
  58004. <member name="M:MailKit.MessageFlagsChangedEventArgs.#ctor(System.Int32)">
  58005. <summary>
  58006. Initializes a new instance of the <see cref="T:MailKit.MessageFlagsChangedEventArgs"/> class.
  58007. </summary>
  58008. <remarks>
  58009. Creates a new <see cref="T:MailKit.MessageFlagsChangedEventArgs"/>.
  58010. </remarks>
  58011. <param name="index">The message index.</param>
  58012. </member>
  58013. <member name="M:MailKit.MessageFlagsChangedEventArgs.#ctor(System.Int32,MailKit.MessageFlags)">
  58014. <summary>
  58015. Initializes a new instance of the <see cref="T:MailKit.MessageFlagsChangedEventArgs"/> class.
  58016. </summary>
  58017. <remarks>
  58018. Creates a new <see cref="T:MailKit.MessageFlagsChangedEventArgs"/>.
  58019. </remarks>
  58020. <param name="index">The message index.</param>
  58021. <param name="flags">The message flags.</param>
  58022. </member>
  58023. <member name="M:MailKit.MessageFlagsChangedEventArgs.#ctor(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String})">
  58024. <summary>
  58025. Initializes a new instance of the <see cref="T:MailKit.MessageFlagsChangedEventArgs"/> class.
  58026. </summary>
  58027. <remarks>
  58028. Creates a new <see cref="T:MailKit.MessageFlagsChangedEventArgs"/>.
  58029. </remarks>
  58030. <param name="index">The message index.</param>
  58031. <param name="flags">The message flags.</param>
  58032. <param name="keywords">The user-defined message flags.</param>
  58033. <exception cref="T:System.ArgumentNullException">
  58034. <paramref name="keywords"/> is <c>null</c>.
  58035. </exception>
  58036. <exception cref="T:System.ArgumentOutOfRangeException">
  58037. <paramref name="index"/> is out of range.
  58038. </exception>
  58039. </member>
  58040. <member name="M:MailKit.MessageFlagsChangedEventArgs.#ctor(System.Int32,MailKit.MessageFlags,System.UInt64)">
  58041. <summary>
  58042. Initializes a new instance of the <see cref="T:MailKit.MessageFlagsChangedEventArgs"/> class.
  58043. </summary>
  58044. <remarks>
  58045. Creates a new <see cref="T:MailKit.MessageFlagsChangedEventArgs"/>.
  58046. </remarks>
  58047. <param name="index">The message index.</param>
  58048. <param name="flags">The message flags.</param>
  58049. <param name="modseq">The modification sequence value.</param>
  58050. <exception cref="T:System.ArgumentOutOfRangeException">
  58051. <paramref name="index"/> is out of range.
  58052. </exception>
  58053. </member>
  58054. <member name="M:MailKit.MessageFlagsChangedEventArgs.#ctor(System.Int32,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.UInt64)">
  58055. <summary>
  58056. Initializes a new instance of the <see cref="T:MailKit.MessageFlagsChangedEventArgs"/> class.
  58057. </summary>
  58058. <remarks>
  58059. Creates a new <see cref="T:MailKit.MessageFlagsChangedEventArgs"/>.
  58060. </remarks>
  58061. <param name="index">The message index.</param>
  58062. <param name="flags">The message flags.</param>
  58063. <param name="keywords">The user-defined message flags.</param>
  58064. <param name="modseq">The modification sequence value.</param>
  58065. <exception cref="T:System.ArgumentNullException">
  58066. <paramref name="keywords"/> is <c>null</c>.
  58067. </exception>
  58068. <exception cref="T:System.ArgumentOutOfRangeException">
  58069. <paramref name="index"/> is out of range.
  58070. </exception>
  58071. </member>
  58072. <member name="M:MailKit.MessageFlagsChangedEventArgs.#ctor(System.Int32,MailKit.UniqueId,MailKit.MessageFlags)">
  58073. <summary>
  58074. Initializes a new instance of the <see cref="T:MailKit.MessageFlagsChangedEventArgs"/> class.
  58075. </summary>
  58076. <remarks>
  58077. Creates a new <see cref="T:MailKit.MessageFlagsChangedEventArgs"/>.
  58078. </remarks>
  58079. <param name="index">The message index.</param>
  58080. <param name="uid">The unique id of the message.</param>
  58081. <param name="flags">The message flags.</param>
  58082. <exception cref="T:System.ArgumentOutOfRangeException">
  58083. <paramref name="index"/> is out of range.
  58084. </exception>
  58085. </member>
  58086. <member name="M:MailKit.MessageFlagsChangedEventArgs.#ctor(System.Int32,MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String})">
  58087. <summary>
  58088. Initializes a new instance of the <see cref="T:MailKit.MessageFlagsChangedEventArgs"/> class.
  58089. </summary>
  58090. <remarks>
  58091. Creates a new <see cref="T:MailKit.MessageFlagsChangedEventArgs"/>.
  58092. </remarks>
  58093. <param name="index">The message index.</param>
  58094. <param name="uid">The unique id of the message.</param>
  58095. <param name="flags">The message flags.</param>
  58096. <param name="keywords">The user-defined message flags.</param>
  58097. <exception cref="T:System.ArgumentNullException">
  58098. <paramref name="keywords"/> is <c>null</c>.
  58099. </exception>
  58100. <exception cref="T:System.ArgumentOutOfRangeException">
  58101. <paramref name="index"/> is out of range.
  58102. </exception>
  58103. </member>
  58104. <member name="M:MailKit.MessageFlagsChangedEventArgs.#ctor(System.Int32,MailKit.UniqueId,MailKit.MessageFlags,System.UInt64)">
  58105. <summary>
  58106. Initializes a new instance of the <see cref="T:MailKit.MessageFlagsChangedEventArgs"/> class.
  58107. </summary>
  58108. <remarks>
  58109. Creates a new <see cref="T:MailKit.MessageFlagsChangedEventArgs"/>.
  58110. </remarks>
  58111. <param name="index">The message index.</param>
  58112. <param name="uid">The unique id of the message.</param>
  58113. <param name="flags">The message flags.</param>
  58114. <param name="modseq">The modification sequence value.</param>
  58115. <exception cref="T:System.ArgumentOutOfRangeException">
  58116. <paramref name="index"/> is out of range.
  58117. </exception>
  58118. </member>
  58119. <member name="M:MailKit.MessageFlagsChangedEventArgs.#ctor(System.Int32,MailKit.UniqueId,MailKit.MessageFlags,System.Collections.Generic.HashSet{System.String},System.UInt64)">
  58120. <summary>
  58121. Initializes a new instance of the <see cref="T:MailKit.MessageFlagsChangedEventArgs"/> class.
  58122. </summary>
  58123. <remarks>
  58124. Creates a new <see cref="T:MailKit.MessageFlagsChangedEventArgs"/>.
  58125. </remarks>
  58126. <param name="index">The message index.</param>
  58127. <param name="uid">The unique id of the message.</param>
  58128. <param name="flags">The message flags.</param>
  58129. <param name="keywords">The user-defined message flags.</param>
  58130. <param name="modseq">The modification sequence value.</param>
  58131. <exception cref="T:System.ArgumentNullException">
  58132. <paramref name="keywords"/> is <c>null</c>.
  58133. </exception>
  58134. <exception cref="T:System.ArgumentOutOfRangeException">
  58135. <paramref name="index"/> is out of range.
  58136. </exception>
  58137. </member>
  58138. <member name="P:MailKit.MessageFlagsChangedEventArgs.Flags">
  58139. <summary>
  58140. Gets the updated message flags.
  58141. </summary>
  58142. <remarks>
  58143. Gets the updated message flags.
  58144. </remarks>
  58145. <value>The updated message flags.</value>
  58146. </member>
  58147. <member name="P:MailKit.MessageFlagsChangedEventArgs.Keywords">
  58148. <summary>
  58149. Gets the updated user-defined message flags.
  58150. </summary>
  58151. <remarks>
  58152. Gets the updated user-defined message flags.
  58153. </remarks>
  58154. <value>The updated user-defined message flags.</value>
  58155. </member>
  58156. <member name="P:MailKit.MessageFlagsChangedEventArgs.UserFlags">
  58157. <summary>
  58158. Gets the updated user-defined message flags.
  58159. </summary>
  58160. <remarks>
  58161. Gets the updated user-defined message flags.
  58162. </remarks>
  58163. <value>The updated user-defined message flags.</value>
  58164. </member>
  58165. <member name="P:MailKit.MessageFlagsChangedEventArgs.ModSeq">
  58166. <summary>
  58167. Gets the updated mod-sequence value of the message, if available.
  58168. </summary>
  58169. <remarks>
  58170. Gets the updated mod-sequence value of the message, if available.
  58171. </remarks>
  58172. <value>The mod-sequence value.</value>
  58173. </member>
  58174. <member name="T:MailKit.MessageLabelsChangedEventArgs">
  58175. <summary>
  58176. Event args for the <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> event.
  58177. </summary>
  58178. <remarks>
  58179. Event args for the <see cref="E:MailKit.IMailFolder.MessageLabelsChanged"/> event.
  58180. </remarks>
  58181. </member>
  58182. <member name="M:MailKit.MessageLabelsChangedEventArgs.#ctor(System.Int32)">
  58183. <summary>
  58184. Initializes a new instance of the <see cref="T:MailKit.MessageLabelsChangedEventArgs"/> class.
  58185. </summary>
  58186. <remarks>
  58187. Creates a new <see cref="T:MailKit.MessageLabelsChangedEventArgs"/>.
  58188. </remarks>
  58189. <param name="index">The message index.</param>
  58190. <exception cref="T:System.ArgumentOutOfRangeException">
  58191. <paramref name="index"/> is out of range.
  58192. </exception>
  58193. </member>
  58194. <member name="M:MailKit.MessageLabelsChangedEventArgs.#ctor(System.Int32,System.Collections.Generic.IList{System.String})">
  58195. <summary>
  58196. Initializes a new instance of the <see cref="T:MailKit.MessageLabelsChangedEventArgs"/> class.
  58197. </summary>
  58198. <remarks>
  58199. Creates a new <see cref="T:MailKit.MessageLabelsChangedEventArgs"/>.
  58200. </remarks>
  58201. <param name="index">The message index.</param>
  58202. <param name="labels">The message labels.</param>
  58203. <exception cref="T:System.ArgumentNullException">
  58204. <paramref name="labels"/> is <c>null</c>.
  58205. </exception>
  58206. <exception cref="T:System.ArgumentOutOfRangeException">
  58207. <paramref name="index"/> is out of range.
  58208. </exception>
  58209. </member>
  58210. <member name="M:MailKit.MessageLabelsChangedEventArgs.#ctor(System.Int32,System.Collections.Generic.IList{System.String},System.UInt64)">
  58211. <summary>
  58212. Initializes a new instance of the <see cref="T:MailKit.MessageLabelsChangedEventArgs"/> class.
  58213. </summary>
  58214. <remarks>
  58215. Creates a new <see cref="T:MailKit.MessageLabelsChangedEventArgs"/>.
  58216. </remarks>
  58217. <param name="index">The message index.</param>
  58218. <param name="labels">The message labels.</param>
  58219. <param name="modseq">The modification sequence value.</param>
  58220. <exception cref="T:System.ArgumentNullException">
  58221. <paramref name="labels"/> is <c>null</c>.
  58222. </exception>
  58223. <exception cref="T:System.ArgumentOutOfRangeException">
  58224. <paramref name="index"/> is out of range.
  58225. </exception>
  58226. </member>
  58227. <member name="M:MailKit.MessageLabelsChangedEventArgs.#ctor(System.Int32,MailKit.UniqueId,System.Collections.Generic.IList{System.String})">
  58228. <summary>
  58229. Initializes a new instance of the <see cref="T:MailKit.MessageLabelsChangedEventArgs"/> class.
  58230. </summary>
  58231. <remarks>
  58232. Creates a new <see cref="T:MailKit.MessageLabelsChangedEventArgs"/>.
  58233. </remarks>
  58234. <param name="index">The message index.</param>
  58235. <param name="uid">The unique id of the message.</param>
  58236. <param name="labels">The message labels.</param>
  58237. <exception cref="T:System.ArgumentNullException">
  58238. <paramref name="labels"/> is <c>null</c>.
  58239. </exception>
  58240. <exception cref="T:System.ArgumentOutOfRangeException">
  58241. <paramref name="index"/> is out of range.
  58242. </exception>
  58243. </member>
  58244. <member name="M:MailKit.MessageLabelsChangedEventArgs.#ctor(System.Int32,MailKit.UniqueId,System.Collections.Generic.IList{System.String},System.UInt64)">
  58245. <summary>
  58246. Initializes a new instance of the <see cref="T:MailKit.MessageLabelsChangedEventArgs"/> class.
  58247. </summary>
  58248. <remarks>
  58249. Creates a new <see cref="T:MailKit.MessageLabelsChangedEventArgs"/>.
  58250. </remarks>
  58251. <param name="index">The message index.</param>
  58252. <param name="uid">The unique id of the message.</param>
  58253. <param name="labels">The message labels.</param>
  58254. <param name="modseq">The modification sequence value.</param>
  58255. <exception cref="T:System.ArgumentNullException">
  58256. <paramref name="labels"/> is <c>null</c>.
  58257. </exception>
  58258. <exception cref="T:System.ArgumentOutOfRangeException">
  58259. <paramref name="index"/> is out of range.
  58260. </exception>
  58261. </member>
  58262. <member name="P:MailKit.MessageLabelsChangedEventArgs.Labels">
  58263. <summary>
  58264. Gets the updated labels.
  58265. </summary>
  58266. <remarks>
  58267. Gets the updated labels.
  58268. </remarks>
  58269. <value>The updated labels.</value>
  58270. </member>
  58271. <member name="P:MailKit.MessageLabelsChangedEventArgs.ModSeq">
  58272. <summary>
  58273. Gets the updated mod-sequence value of the message, if available.
  58274. </summary>
  58275. <remarks>
  58276. Gets the updated mod-sequence value of the message, if available.
  58277. </remarks>
  58278. <value>The mod-sequence value.</value>
  58279. </member>
  58280. <member name="T:MailKit.MessageNotFoundException">
  58281. <summary>
  58282. The exception that is thrown when a message (or body part) could not be found.
  58283. </summary>
  58284. <remarks>
  58285. This exception is thrown by methods such as
  58286. <a href="Overload_MailKit_IMailFolder_GetMessage.htm">IMailFolder.GetMessage</a>,
  58287. <a href="Overload_MailKit_IMailFolder_GetBodyPart.htm">IMailFolder.GetBodyPart</a>, or
  58288. <a href="Overload_MailKit_IMailFolder_GetStream.htm">IMailFolder.GetStream</a>
  58289. when the server's response does not contain the message, body part, or stream data requested.
  58290. </remarks>
  58291. </member>
  58292. <member name="M:MailKit.MessageNotFoundException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  58293. <summary>
  58294. Initializes a new instance of the <see cref="T:MailKit.MessageNotFoundException"/> class.
  58295. </summary>
  58296. <remarks>
  58297. Deserializes a <see cref="T:MailKit.MessageNotFoundException"/>.
  58298. </remarks>
  58299. <param name="info">The serialization info.</param>
  58300. <param name="context">The streaming context.</param>
  58301. <exception cref="T:System.ArgumentNullException">
  58302. <paramref name="info"/> is <c>null</c>.
  58303. </exception>
  58304. </member>
  58305. <member name="M:MailKit.MessageNotFoundException.#ctor(System.String,System.Exception)">
  58306. <summary>
  58307. Initializes a new instance of the <see cref="T:MailKit.MessageNotFoundException"/> class.
  58308. </summary>
  58309. <remarks>
  58310. Creates a new <see cref="T:MailKit.MessageNotFoundException"/>.
  58311. </remarks>
  58312. <param name="message">The error message.</param>
  58313. <param name="innerException">The inner exception.</param>
  58314. <exception cref="T:System.ArgumentNullException">
  58315. </exception>
  58316. </member>
  58317. <member name="M:MailKit.MessageNotFoundException.#ctor(System.String)">
  58318. <summary>
  58319. Initializes a new instance of the <see cref="T:MailKit.MessageNotFoundException"/> class.
  58320. </summary>
  58321. <remarks>
  58322. Creates a new <see cref="T:MailKit.MessageNotFoundException"/>.
  58323. </remarks>
  58324. <param name="message">The error message.</param>
  58325. </member>
  58326. <member name="T:MailKit.MessageSentEventArgs">
  58327. <summary>
  58328. Event args used when a message is successfully sent.
  58329. </summary>
  58330. <remarks>
  58331. Event args used when message is successfully sent.
  58332. </remarks>
  58333. </member>
  58334. <member name="M:MailKit.MessageSentEventArgs.#ctor(MimeKit.MimeMessage,System.String)">
  58335. <summary>
  58336. Initializes a new instance of the <see cref="T:MailKit.MessageSentEventArgs"/> class.
  58337. </summary>
  58338. <remarks>
  58339. Creates a new <see cref="T:MailKit.MessageSentEventArgs"/>.
  58340. </remarks>
  58341. <param name="message">The message that was just sent.</param>
  58342. <param name="response">The response from the server.</param>
  58343. <exception cref="T:System.ArgumentNullException">
  58344. <para><paramref name="message"/> is <c>null</c>.</para>
  58345. <para>-or-</para>
  58346. <para><paramref name="response"/> is <c>null</c>.</para>
  58347. </exception>
  58348. </member>
  58349. <member name="P:MailKit.MessageSentEventArgs.Message">
  58350. <summary>
  58351. Get the message that was just sent.
  58352. </summary>
  58353. <remarks>
  58354. Gets the message that was just sent.
  58355. </remarks>
  58356. <value>The message.</value>
  58357. </member>
  58358. <member name="P:MailKit.MessageSentEventArgs.Response">
  58359. <summary>
  58360. Get the server's response.
  58361. </summary>
  58362. <remarks>
  58363. Gets the server's response.
  58364. </remarks>
  58365. <value>The response.</value>
  58366. </member>
  58367. <member name="T:MailKit.MessageSorter">
  58368. <summary>
  58369. Routines for sorting messages.
  58370. </summary>
  58371. <remarks>
  58372. Routines for sorting messages.
  58373. </remarks>
  58374. </member>
  58375. <member name="M:MailKit.MessageSorter.Sort``1(System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IList{MailKit.Search.OrderBy})">
  58376. <summary>
  58377. Sorts the messages by the specified ordering.
  58378. </summary>
  58379. <remarks>
  58380. Sorts the messages by the specified ordering.
  58381. </remarks>
  58382. <returns>The sorted messages.</returns>
  58383. <typeparam name="T">The message items must implement the <see cref="T:MailKit.IMessageSummary"/> interface.</typeparam>
  58384. <param name="messages">The messages to sort.</param>
  58385. <param name="orderBy">The sort ordering.</param>
  58386. <exception cref="T:System.ArgumentNullException">
  58387. <para><paramref name="messages"/> is <c>null</c>.</para>
  58388. <para>-or-</para>
  58389. <para><paramref name="orderBy"/> is <c>null</c>.</para>
  58390. </exception>
  58391. <exception cref="T:System.ArgumentException">
  58392. <para><paramref name="messages"/> contains one or more items that is missing information needed for sorting.</para>
  58393. <para>-or-</para>
  58394. <para><paramref name="orderBy"/> is an empty list.</para>
  58395. </exception>
  58396. </member>
  58397. <member name="M:MailKit.MessageSorter.Sort``1(System.Collections.Generic.List{``0},System.Collections.Generic.IList{MailKit.Search.OrderBy})">
  58398. <summary>
  58399. Sorts the messages by the specified ordering.
  58400. </summary>
  58401. <remarks>
  58402. Sorts the messages by the specified ordering.
  58403. </remarks>
  58404. <returns>The sorted messages.</returns>
  58405. <typeparam name="T">The message items must implement the <see cref="T:MailKit.IMessageSummary"/> interface.</typeparam>
  58406. <param name="messages">The messages to sort.</param>
  58407. <param name="orderBy">The sort ordering.</param>
  58408. <exception cref="T:System.ArgumentNullException">
  58409. <para><paramref name="messages"/> is <c>null</c>.</para>
  58410. <para>-or-</para>
  58411. <para><paramref name="orderBy"/> is <c>null</c>.</para>
  58412. </exception>
  58413. <exception cref="T:System.ArgumentException">
  58414. <para><paramref name="messages"/> contains one or more items that is missing information needed for sorting.</para>
  58415. <para>-or-</para>
  58416. <para><paramref name="orderBy"/> is an empty list.</para>
  58417. </exception>
  58418. </member>
  58419. <member name="T:MailKit.MessageSummary">
  58420. <summary>
  58421. A summary of a message.
  58422. </summary>
  58423. <remarks>
  58424. A <see cref="T:MailKit.MessageSummary"/> is returned by
  58425. <see cref="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Threading.CancellationToken)"/>.
  58426. The properties of the <see cref="T:MailKit.MessageSummary"/> that will be available
  58427. depend on the <see cref="T:MailKit.MessageSummaryItems"/> passed to the aformentioned method.
  58428. </remarks>
  58429. </member>
  58430. <member name="M:MailKit.MessageSummary.#ctor(System.Int32)">
  58431. <summary>
  58432. Initializes a new instance of the <see cref="T:MailKit.MessageSummary"/> class.
  58433. </summary>
  58434. <remarks>
  58435. Creates a new <see cref="T:MailKit.MessageSummary"/>.
  58436. </remarks>
  58437. <param name="index">The message index.</param>
  58438. <exception cref="T:System.ArgumentOutOfRangeException">
  58439. <paramref name="index"/> is negative.
  58440. </exception>
  58441. </member>
  58442. <member name="P:MailKit.MessageSummary.Fields">
  58443. <summary>
  58444. Get a bitmask of fields that have been populated.
  58445. </summary>
  58446. <remarks>
  58447. Gets a bitmask of fields that have been populated.
  58448. </remarks>
  58449. <value>The fields that have been populated.</value>
  58450. </member>
  58451. <member name="P:MailKit.MessageSummary.Body">
  58452. <summary>
  58453. Gets the body structure of the message, if available.
  58454. </summary>
  58455. <remarks>
  58456. <para>The body will be one of <see cref="T:MailKit.BodyPartText"/>,
  58457. <see cref="T:MailKit.BodyPartMessage"/>, <see cref="T:MailKit.BodyPartBasic"/>,
  58458. or <see cref="T:MailKit.BodyPartMultipart"/>.</para>
  58459. <para>This property will only be set if either the
  58460. <see cref="F:MailKit.MessageSummaryItems.Body"/> flag or the
  58461. <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag is passed to
  58462. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  58463. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  58464. methods.</para>
  58465. </remarks>
  58466. <value>The body structure of the message.</value>
  58467. </member>
  58468. <member name="P:MailKit.MessageSummary.TextBody">
  58469. <summary>
  58470. Gets the text body part of the message if it exists.
  58471. </summary>
  58472. <remarks>
  58473. <para>Gets the <c>text/plain</c> body part of the message.</para>
  58474. <para>This property will only be usable if the
  58475. <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag is passed to
  58476. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  58477. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  58478. methods.</para>
  58479. </remarks>
  58480. <example>
  58481. <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
  58482. </example>
  58483. <value>The text body if it exists; otherwise, <c>null</c>.</value>
  58484. </member>
  58485. <member name="P:MailKit.MessageSummary.HtmlBody">
  58486. <summary>
  58487. Gets the html body part of the message if it exists.
  58488. </summary>
  58489. <remarks>
  58490. <para>Gets the <c>text/html</c> body part of the message.</para>
  58491. <para>This property will only be usable if the
  58492. <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag is passed to
  58493. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  58494. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  58495. methods.</para>
  58496. </remarks>
  58497. <value>The html body if it exists; otherwise, <c>null</c>.</value>
  58498. </member>
  58499. <member name="P:MailKit.MessageSummary.BodyParts">
  58500. <summary>
  58501. Gets the body parts of the message.
  58502. </summary>
  58503. <remarks>
  58504. <para>Traverses over the <see cref="P:MailKit.MessageSummary.Body"/>, enumerating all of the
  58505. <see cref="T:MailKit.BodyPartBasic"/> objects.</para>
  58506. <para>This property will only be usable if either the
  58507. <see cref="F:MailKit.MessageSummaryItems.Body"/> flag or the
  58508. <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag is passed to
  58509. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  58510. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  58511. methods.</para>
  58512. </remarks>
  58513. <value>The body parts.</value>
  58514. </member>
  58515. <member name="P:MailKit.MessageSummary.Attachments">
  58516. <summary>
  58517. Gets the attachments.
  58518. </summary>
  58519. <remarks>
  58520. <para>Traverses over the <see cref="P:MailKit.MessageSummary.Body"/>, enumerating all of the
  58521. <see cref="T:MailKit.BodyPartBasic"/> objects that have a <c>Content-Disposition</c>
  58522. header set to <c>"attachment"</c>.</para>
  58523. <para>This property will only be usable if the
  58524. <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/> flag is passed to
  58525. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  58526. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  58527. methods.</para>
  58528. </remarks>
  58529. <example>
  58530. <code language="c#" source="Examples\ImapExamples.cs" region="DownloadBodyParts"/>
  58531. </example>
  58532. <value>The attachments.</value>
  58533. </member>
  58534. <member name="P:MailKit.MessageSummary.PreviewText">
  58535. <summary>
  58536. Gets the preview text of the message.
  58537. </summary>
  58538. <remarks>
  58539. <para>The preview text is a short snippet of the beginning of the message
  58540. text, typically shown in a mail client's message list to provide the user
  58541. with a sense of what the message is about.</para>
  58542. <para>This property will only be set if the
  58543. <see cref="F:MailKit.MessageSummaryItems.PreviewText"/> flag is passed to
  58544. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  58545. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  58546. methods.</para>
  58547. </remarks>
  58548. <value>The preview text.</value>
  58549. </member>
  58550. <member name="P:MailKit.MessageSummary.Envelope">
  58551. <summary>
  58552. Gets the envelope of the message, if available.
  58553. </summary>
  58554. <remarks>
  58555. <para>The envelope of a message contains information such as the
  58556. date the message was sent, the subject of the message,
  58557. the sender of the message, who the message was sent to,
  58558. which message(s) the message may be in reply to,
  58559. and the message id.</para>
  58560. <para>This property will only be set if the
  58561. <see cref="F:MailKit.MessageSummaryItems.Envelope"/> flag is passed to
  58562. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  58563. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  58564. methods.</para>
  58565. </remarks>
  58566. <value>The envelope of the message.</value>
  58567. </member>
  58568. <member name="P:MailKit.MessageSummary.NormalizedSubject">
  58569. <summary>
  58570. Gets the normalized subject.
  58571. </summary>
  58572. <remarks>
  58573. A normalized Subject header value where prefixes such as
  58574. "Re:", "Re[#]:", etc have been pruned.
  58575. </remarks>
  58576. <value>The normalized subject.</value>
  58577. </member>
  58578. <member name="P:MailKit.MessageSummary.IsReply">
  58579. <summary>
  58580. Gets whether or not the message is a reply.
  58581. </summary>
  58582. <remarks>
  58583. This value should be based on whether the message subject contained any "Re:" or "Fwd:" prefixes.
  58584. </remarks>
  58585. <value><c>true</c> if the message is a reply; otherwise, <c>false</c>.</value>
  58586. </member>
  58587. <member name="P:MailKit.MessageSummary.Date">
  58588. <summary>
  58589. Gets the Date header value.
  58590. </summary>
  58591. <remarks>
  58592. Gets the Date header value. If the Date header is not present, the arrival date is used.
  58593. If neither are known, <see cref="F:System.DateTimeOffset.MinValue"/> is returned.
  58594. </remarks>
  58595. <value>The date.</value>
  58596. </member>
  58597. <member name="P:MailKit.MessageSummary.Flags">
  58598. <summary>
  58599. Gets the message flags, if available.
  58600. </summary>
  58601. <remarks>
  58602. <para>Gets the message flags, if available.</para>
  58603. <para>This property will only be set if the
  58604. <see cref="F:MailKit.MessageSummaryItems.Flags"/> flag is passed to
  58605. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  58606. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  58607. methods.</para>
  58608. </remarks>
  58609. <value>The message flags.</value>
  58610. </member>
  58611. <member name="P:MailKit.MessageSummary.Keywords">
  58612. <summary>
  58613. Gets the user-defined message flags, if available.
  58614. </summary>
  58615. <remarks>
  58616. <para>Gets the user-defined message flags, if available.</para>
  58617. <para>This property will only be set if the
  58618. <see cref="F:MailKit.MessageSummaryItems.Flags"/> flag is passed to
  58619. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  58620. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  58621. methods.</para>
  58622. </remarks>
  58623. <value>The user-defined message flags.</value>
  58624. </member>
  58625. <member name="P:MailKit.MessageSummary.UserFlags">
  58626. <summary>
  58627. Gets the user-defined message flags, if available.
  58628. </summary>
  58629. <remarks>
  58630. <para>Gets the user-defined message flags, if available.</para>
  58631. <para>This property will only be set if the
  58632. <see cref="F:MailKit.MessageSummaryItems.Flags"/> flag is passed to
  58633. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  58634. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  58635. methods.</para>
  58636. </remarks>
  58637. <value>The user-defined message flags.</value>
  58638. </member>
  58639. <member name="P:MailKit.MessageSummary.Annotations">
  58640. <summary>
  58641. Gets the message annotations, if available.
  58642. </summary>
  58643. <remarks>
  58644. <para>Gets the message annotations, if available.</para>
  58645. <para>This property will only be set if the
  58646. <see cref="F:MailKit.MessageSummaryItems.Annotations"/> flag is passed to
  58647. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  58648. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  58649. methods.</para>
  58650. </remarks>
  58651. <value>The message annotations.</value>
  58652. </member>
  58653. <member name="P:MailKit.MessageSummary.Headers">
  58654. <summary>
  58655. Gets the list of headers, if available.
  58656. </summary>
  58657. <remarks>
  58658. <para>Gets the list of headers, if available.</para>
  58659. <para>This property will only be set if <see cref="F:MailKit.MessageSummaryItems.Headers"/>
  58660. is specified in a call to one of the
  58661. <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  58662. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  58663. methods or specific headers are requested via a one of the Fetch or FetchAsync methods
  58664. that accept list of specific headers to request for each message such as
  58665. <see cref="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Collections.Generic.IEnumerable{MimeKit.HeaderId},System.Threading.CancellationToken)"/>.
  58666. </para>
  58667. </remarks>
  58668. <value>The list of headers.</value>
  58669. </member>
  58670. <member name="P:MailKit.MessageSummary.InternalDate">
  58671. <summary>
  58672. Gets the internal date of the message (i.e. the "received" date), if available.
  58673. </summary>
  58674. <remarks>
  58675. <para>Gets the internal date of the message (i.e. the "received" date), if available.</para>
  58676. <para>This property will only be set if the
  58677. <see cref="F:MailKit.MessageSummaryItems.InternalDate"/> flag is passed to
  58678. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  58679. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  58680. methods.</para>
  58681. </remarks>
  58682. <value>The internal date of the message.</value>
  58683. </member>
  58684. <member name="P:MailKit.MessageSummary.Size">
  58685. <summary>
  58686. Gets the size of the message, in bytes, if available.
  58687. </summary>
  58688. <remarks>
  58689. <para>Gets the size of the message, in bytes, if available.</para>
  58690. <para>This property will only be set if the
  58691. <see cref="F:MailKit.MessageSummaryItems.Size"/> flag is passed to
  58692. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  58693. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  58694. methods.</para>
  58695. </remarks>
  58696. <value>The size of the message.</value>
  58697. </member>
  58698. <member name="P:MailKit.MessageSummary.ModSeq">
  58699. <summary>
  58700. Gets the mod-sequence value for the message, if available.
  58701. </summary>
  58702. <remarks>
  58703. <para>Gets the mod-sequence value for the message, if available.</para>
  58704. <para>This property will only be set if the
  58705. <see cref="F:MailKit.MessageSummaryItems.ModSeq"/> flag is passed to
  58706. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  58707. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  58708. methods.</para>
  58709. </remarks>
  58710. <value>The mod-sequence value.</value>
  58711. </member>
  58712. <member name="P:MailKit.MessageSummary.References">
  58713. <summary>
  58714. Gets the message-ids that the message references, if available.
  58715. </summary>
  58716. <remarks>
  58717. <para>Gets the message-ids that the message references, if available.</para>
  58718. <para>This property will only be set if the
  58719. <see cref="F:MailKit.MessageSummaryItems.References"/> flag is passed to
  58720. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  58721. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  58722. methods.</para>
  58723. </remarks>
  58724. <value>The references.</value>
  58725. </member>
  58726. <member name="P:MailKit.MessageSummary.EmailId">
  58727. <summary>
  58728. Get the globally unique identifier for the message, if available.
  58729. </summary>
  58730. <remarks>
  58731. <para>Gets the globally unique identifier of the message, if available.</para>
  58732. <para>This property will only be set if the
  58733. <see cref="F:MailKit.MessageSummaryItems.EmailId"/> flag is passed to
  58734. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  58735. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  58736. methods.</para>
  58737. <note type="info">This property maps to the <c>EMAILID</c> value defined in the
  58738. <a href="https://tools.ietf.org/html/rfc8474">OBJECTID</a> extension.</note>
  58739. </remarks>
  58740. <value>The globally unique message identifier.</value>
  58741. </member>
  58742. <member name="P:MailKit.MessageSummary.Id">
  58743. <summary>
  58744. Get the globally unique identifier for the message, if available.
  58745. </summary>
  58746. <remarks>
  58747. <para>Gets the globally unique identifier of the message, if available.</para>
  58748. <para>This property will only be set if the
  58749. <see cref="F:MailKit.MessageSummaryItems.EmailId"/> flag is passed to
  58750. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  58751. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  58752. methods.</para>
  58753. <note type="info">This property maps to the <c>EMAILID</c> value defined in the
  58754. <a href="https://tools.ietf.org/html/rfc8474">OBJECTID</a> extension.</note>
  58755. </remarks>
  58756. <value>The globally unique message identifier.</value>
  58757. </member>
  58758. <member name="P:MailKit.MessageSummary.ThreadId">
  58759. <summary>
  58760. Get the globally unique thread identifier for the message, if available.
  58761. </summary>
  58762. <remarks>
  58763. <para>Gets the globally unique thread identifier for the message, if available.</para>
  58764. <para>This property will only be set if the
  58765. <see cref="F:MailKit.MessageSummaryItems.ThreadId"/> flag is passed to
  58766. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  58767. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  58768. methods.</para>
  58769. <note type="info">This property maps to the <c>THREADID</c> value defined in the
  58770. <a href="https://tools.ietf.org/html/rfc8474">OBJECTID</a> extension.</note>
  58771. </remarks>
  58772. <value>The globally unique thread identifier.</value>
  58773. </member>
  58774. <member name="P:MailKit.MessageSummary.UniqueId">
  58775. <summary>
  58776. Gets the unique identifier of the message, if available.
  58777. </summary>
  58778. <remarks>
  58779. <para>Gets the unique identifier of the message, if available.</para>
  58780. <para>This property will only be set if the
  58781. <see cref="F:MailKit.MessageSummaryItems.UniqueId"/> flag is passed to
  58782. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  58783. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  58784. methods.</para>
  58785. </remarks>
  58786. <value>The uid of the message.</value>
  58787. </member>
  58788. <member name="P:MailKit.MessageSummary.Index">
  58789. <summary>
  58790. Gets the index of the message.
  58791. </summary>
  58792. <remarks>
  58793. <para>Gets the index of the message.</para>
  58794. <para>This property is always set.</para>
  58795. </remarks>
  58796. <value>The index of the message.</value>
  58797. </member>
  58798. <member name="P:MailKit.MessageSummary.GMailMessageId">
  58799. <summary>
  58800. Gets the GMail message identifier, if available.
  58801. </summary>
  58802. <remarks>
  58803. <para>Gets the GMail message identifier, if available.</para>
  58804. <para>This property will only be set if the
  58805. <see cref="F:MailKit.MessageSummaryItems.GMailMessageId"/> flag is passed to
  58806. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  58807. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  58808. methods.</para>
  58809. </remarks>
  58810. <value>The GMail message identifier.</value>
  58811. </member>
  58812. <member name="P:MailKit.MessageSummary.GMailThreadId">
  58813. <summary>
  58814. Gets the GMail thread identifier, if available.
  58815. </summary>
  58816. <remarks>
  58817. <para>Gets the GMail thread identifier, if available.</para>
  58818. <para>This property will only be set if the
  58819. <see cref="F:MailKit.MessageSummaryItems.GMailThreadId"/> flag is passed to
  58820. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  58821. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  58822. methods.</para>
  58823. </remarks>
  58824. <value>The GMail thread identifier.</value>
  58825. </member>
  58826. <member name="P:MailKit.MessageSummary.GMailLabels">
  58827. <summary>
  58828. Gets the list of GMail labels, if available.
  58829. </summary>
  58830. <remarks>
  58831. <para>Gets the list of GMail labels, if available.</para>
  58832. <para>This property will only be set if the
  58833. <see cref="F:MailKit.MessageSummaryItems.GMailLabels"/> flag is passed to
  58834. one of the <a href="Overload_MailKit_IMailFolder_Fetch.htm">Fetch</a>
  58835. or <a href="Overload_MailKit_IMailFolder_FetchAsync.htm">FetchAsync</a>
  58836. methods.</para>
  58837. </remarks>
  58838. <value>The GMail labels.</value>
  58839. </member>
  58840. <member name="T:MailKit.MessageSummaryFetchedEventArgs">
  58841. <summary>
  58842. Event args used when a message summary has been fetched from a folder.
  58843. </summary>
  58844. <remarks>
  58845. Event args used when a message summary has been fetched from a folder.
  58846. </remarks>
  58847. </member>
  58848. <member name="M:MailKit.MessageSummaryFetchedEventArgs.#ctor(MailKit.IMessageSummary)">
  58849. <summary>
  58850. Initializes a new instance of the <see cref="T:MailKit.MessageSummaryFetchedEventArgs"/> class.
  58851. </summary>
  58852. <remarks>
  58853. Creates a new <see cref="T:MailKit.MessageSummaryFetchedEventArgs"/>
  58854. </remarks>
  58855. <param name="message">The message summary.</param>
  58856. <exception cref="T:System.ArgumentNullException">
  58857. <paramref name="message"/> is <c>null</c>.
  58858. </exception>
  58859. </member>
  58860. <member name="P:MailKit.MessageSummaryFetchedEventArgs.Message">
  58861. <summary>
  58862. Get the message summary.
  58863. </summary>
  58864. <remarks>
  58865. Gets the message summary.
  58866. </remarks>
  58867. <value>The message summary.</value>
  58868. </member>
  58869. <member name="T:MailKit.MessageSummaryItems">
  58870. <summary>
  58871. A bitfield of <see cref="T:MailKit.MessageSummary"/> fields.
  58872. </summary>
  58873. <remarks>
  58874. <see cref="T:MailKit.MessageSummaryItems"/> are used to specify which properties
  58875. of <see cref="T:MailKit.MessageSummary"/> should be populated by calls to
  58876. <see cref="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{MailKit.UniqueId},MailKit.MessageSummaryItems,System.Threading.CancellationToken)"/>,
  58877. <see cref="M:MailKit.IMailFolder.Fetch(System.Collections.Generic.IList{System.Int32},MailKit.MessageSummaryItems,System.Threading.CancellationToken)"/>, or
  58878. <see cref="M:MailKit.IMailFolder.Fetch(System.Int32,System.Int32,MailKit.MessageSummaryItems,System.Threading.CancellationToken)"/>.
  58879. </remarks>
  58880. </member>
  58881. <member name="F:MailKit.MessageSummaryItems.None">
  58882. <summary>
  58883. Don't fetch any summary items.
  58884. </summary>
  58885. </member>
  58886. <member name="F:MailKit.MessageSummaryItems.Annotations">
  58887. <summary>
  58888. <para>Fetch the <see cref="P:MailKit.IMessageSummary.Annotations"/>.</para>
  58889. <para>Fetches all <c>ANNOATION</c> values as defined in
  58890. <a href="https://tools.ietf.org/html/rfc5257">rfc5257</a>.</para>
  58891. </summary>
  58892. </member>
  58893. <member name="F:MailKit.MessageSummaryItems.Body">
  58894. <summary>
  58895. <para>Fetch the <see cref="P:MailKit.IMessageSummary.Body"/>.</para>
  58896. <para>Fetches the <c>BODY</c> value as defined in
  58897. <a href="https://tools.ietf.org/html/rfc3501">rfc3501</a>.</para>
  58898. <note type="note">Unlike <see cref="F:MailKit.MessageSummaryItems.BodyStructure"/>, <c>Body</c> will not populate the
  58899. <see cref="P:MailKit.BodyPart.ContentType"/> parameters nor will it populate the
  58900. <see cref="P:MailKit.BodyPartBasic.ContentDisposition"/>, <see cref="P:MailKit.BodyPartBasic.ContentLanguage"/>
  58901. or <see cref="P:MailKit.BodyPartBasic.ContentLocation"/> properties of each <see cref="T:MailKit.BodyPartBasic"/>
  58902. body part. This makes <c>Body</c> far less useful than <c>BodyStructure</c> especially when
  58903. it is desirable to determine whether or not a body part is an attachment.</note>
  58904. </summary>
  58905. </member>
  58906. <member name="F:MailKit.MessageSummaryItems.BodyStructure">
  58907. <summary>
  58908. <para>Fetch the <see cref="P:MailKit.IMessageSummary.Body"/> (but with more details than <see cref="F:MailKit.MessageSummaryItems.Body"/>).</para>
  58909. <para>Fetches the <c>BODYSTRUCTURE</c> value as defined in
  58910. <a href="https://tools.ietf.org/html/rfc3501">rfc3501</a>.</para>
  58911. <note type="note">Unlike <see cref="F:MailKit.MessageSummaryItems.Body"/>, <c>BodyStructure</c> will also populate the
  58912. <see cref="P:MailKit.BodyPart.ContentType"/> parameters as well as the
  58913. <see cref="P:MailKit.BodyPartBasic.ContentDisposition"/>, <see cref="P:MailKit.BodyPartBasic.ContentLanguage"/>
  58914. and <see cref="P:MailKit.BodyPartBasic.ContentLocation"/> properties of each <see cref="T:MailKit.BodyPartBasic"/>
  58915. body part. The <c>Content-Disposition</c> information is especially important when trying to
  58916. determine whether or not a body part is an attachment, for example.</note>
  58917. </summary>
  58918. </member>
  58919. <member name="F:MailKit.MessageSummaryItems.Envelope">
  58920. <summary>
  58921. <para>Fetch the <see cref="P:MailKit.IMessageSummary.Envelope"/>.</para>
  58922. <para>Fetches the <c>ENVELOPE</c> value as defined in
  58923. <a href="https://tools.ietf.org/html/rfc3501">rfc3501</a>.</para>
  58924. </summary>
  58925. </member>
  58926. <member name="F:MailKit.MessageSummaryItems.Flags">
  58927. <summary>
  58928. <para>Fetch the <see cref="P:MailKit.IMessageSummary.Flags"/>.</para>
  58929. <para>Fetches the <c>FLAGS</c> value as defined in
  58930. <a href="https://tools.ietf.org/html/rfc3501">rfc3501</a>.</para>
  58931. </summary>
  58932. </member>
  58933. <member name="F:MailKit.MessageSummaryItems.InternalDate">
  58934. <summary>
  58935. <para>Fetch the <see cref="P:MailKit.IMessageSummary.InternalDate"/>.</para>
  58936. <para>Fetches the <c>INTERNALDATE</c> value as defined in
  58937. <a href="https://tools.ietf.org/html/rfc3501">rfc3501</a>.</para>
  58938. </summary>
  58939. </member>
  58940. <member name="F:MailKit.MessageSummaryItems.Size">
  58941. <summary>
  58942. <para>Fetch the <see cref="P:MailKit.IMessageSummary.Size"/>.</para>
  58943. <para>Fetches the <c>RFC822.SIZE</c> value as defined in
  58944. <a href="https://tools.ietf.org/html/rfc3501">rfc3501</a>.</para>
  58945. </summary>
  58946. </member>
  58947. <member name="F:MailKit.MessageSummaryItems.ModSeq">
  58948. <summary>
  58949. <para>Fetch the <see cref="P:MailKit.IMessageSummary.ModSeq"/>.</para>
  58950. <para>Fetches the <c>MODSEQ</c> value as defined in
  58951. <a href="https://tools.ietf.org/html/rfc4551">rfc4551</a>.</para>
  58952. </summary>
  58953. </member>
  58954. <member name="F:MailKit.MessageSummaryItems.References">
  58955. <summary>
  58956. Fetch the <see cref="P:MailKit.IMessageSummary.References"/>.
  58957. </summary>
  58958. </member>
  58959. <member name="F:MailKit.MessageSummaryItems.UniqueId">
  58960. <summary>
  58961. <para>Fetch the <see cref="P:MailKit.IMessageSummary.UniqueId"/>.</para>
  58962. <para>Fetches the <c>UID</c> value as defined in
  58963. <a href="https://tools.ietf.org/html/rfc3501">rfc3501</a>.</para>
  58964. </summary>
  58965. </member>
  58966. <member name="F:MailKit.MessageSummaryItems.EmailId">
  58967. <summary>
  58968. <para></para>Fetch the <see cref="P:MailKit.IMessageSummary.EmailId"/>.
  58969. <para>Fetches the <c>EMAILID</c> value as defined in
  58970. <a href="https://tools.ietf.org/html/rfc8474">rfc8474</a>.</para>
  58971. </summary>
  58972. </member>
  58973. <member name="F:MailKit.MessageSummaryItems.Id">
  58974. <summary>
  58975. <para></para>Fetch the <see cref="P:MailKit.IMessageSummary.EmailId"/>.
  58976. <para>Fetches the <c>EMAILID</c> value as defined in
  58977. <a href="https://tools.ietf.org/html/rfc8474">rfc8474</a>.</para>
  58978. </summary>
  58979. </member>
  58980. <member name="F:MailKit.MessageSummaryItems.ThreadId">
  58981. <summary>
  58982. <para>Fetch the <see cref="P:MailKit.IMessageSummary.ThreadId"/>.</para>
  58983. <para>Fetches the <c>THREADID</c> value as defined in
  58984. <a href="https://tools.ietf.org/html/rfc8474">rfc8474</a>.</para>
  58985. </summary>
  58986. </member>
  58987. <member name="F:MailKit.MessageSummaryItems.GMailMessageId">
  58988. <summary>
  58989. <para>Fetch the <see cref="P:MailKit.IMessageSummary.GMailMessageId"/>.</para>
  58990. <para>Fetches the <c>X-GM-MSGID</c> value as defined in Google's
  58991. <a href="https://developers.google.com/gmail/imap/imap-extensions">IMAP extensions</a>
  58992. documentation.</para>
  58993. </summary>
  58994. </member>
  58995. <member name="F:MailKit.MessageSummaryItems.GMailThreadId">
  58996. <summary>
  58997. <para>Fetch the <see cref="P:MailKit.IMessageSummary.GMailThreadId"/>.</para>
  58998. <para>Fetches the <c>X-GM-THRID</c> value as defined in Google's
  58999. <a href="https://developers.google.com/gmail/imap/imap-extensions">IMAP extensions</a>
  59000. documentation.</para>
  59001. </summary>
  59002. </member>
  59003. <member name="F:MailKit.MessageSummaryItems.GMailLabels">
  59004. <summary>
  59005. <para>Fetch the <see cref="P:MailKit.IMessageSummary.GMailLabels"/>.</para>
  59006. <para>Fetches the <c>X-GM-LABELS</c> value as defined in Google's
  59007. <a href="https://developers.google.com/gmail/imap/imap-extensions">IMAP extensions</a>
  59008. documentation.</para>
  59009. </summary>
  59010. </member>
  59011. <member name="F:MailKit.MessageSummaryItems.Headers">
  59012. <summary>
  59013. <para>Fetch the the complete list of <see cref="P:MailKit.IMessageSummary.Headers"/> for each message.</para>
  59014. </summary>
  59015. </member>
  59016. <member name="F:MailKit.MessageSummaryItems.PreviewText">
  59017. <summary>
  59018. <para>Fetch the <see cref="P:MailKit.IMessageSummary.PreviewText"/>.</para>
  59019. <note type="note">This property is quite expensive to calculate because it is not an
  59020. item that is cached on the IMAP server. Instead, MailKit must download a hunk of the
  59021. message body so that it can decode and parse it in order to generate a meaningful
  59022. text snippet. This usually involves downloading the first 512 bytes for <c>text/plain</c>
  59023. message bodies and the first 16 kilobytes for <c>text/html</c> message bodies. If a
  59024. message contains both a <c>text/plain</c> body and a <c>text/html</c> body, then the
  59025. <c>text/plain</c> content is used in order to reduce network traffic.</note>
  59026. </summary>
  59027. </member>
  59028. <member name="F:MailKit.MessageSummaryItems.All">
  59029. <summary>
  59030. <para>A macro for fetching the <see cref="F:MailKit.MessageSummaryItems.Envelope"/>, <see cref="F:MailKit.MessageSummaryItems.Flags"/>,
  59031. <see cref="F:MailKit.MessageSummaryItems.InternalDate"/>, and <see cref="F:MailKit.MessageSummaryItems.Size"/> values.</para>
  59032. <para>This macro maps to the equivalent <c>ALL</c> macro as defined in
  59033. <a href="https://tools.ietf.org/html/rfc3501">rfc3501</a>.</para>
  59034. </summary>
  59035. </member>
  59036. <member name="F:MailKit.MessageSummaryItems.Fast">
  59037. <summary>
  59038. <para>A macro for fetching the <see cref="F:MailKit.MessageSummaryItems.Flags"/>, <see cref="F:MailKit.MessageSummaryItems.InternalDate"/>, and
  59039. <see cref="F:MailKit.MessageSummaryItems.Size"/> values.</para>
  59040. <para>This macro maps to the equivalent <c>FAST</c> macro as defined in
  59041. <a href="https://tools.ietf.org/html/rfc3501">rfc3501</a>.</para>
  59042. </summary>
  59043. </member>
  59044. <member name="F:MailKit.MessageSummaryItems.Full">
  59045. <summary>
  59046. <para>A macro for fetching the <see cref="F:MailKit.MessageSummaryItems.Body"/>, <see cref="F:MailKit.MessageSummaryItems.Envelope"/>,
  59047. <see cref="F:MailKit.MessageSummaryItems.Flags"/>, <see cref="F:MailKit.MessageSummaryItems.InternalDate"/>, and <see cref="F:MailKit.MessageSummaryItems.Size"/> values.</para>
  59048. <para>This macro maps to the equivalent <c>FULL</c> macro as defined in
  59049. <a href="https://tools.ietf.org/html/rfc3501">rfc3501</a>.</para>
  59050. </summary>
  59051. </member>
  59052. <member name="T:MailKit.MessagesVanishedEventArgs">
  59053. <summary>
  59054. Event args used when a message vanishes from a folder.
  59055. </summary>
  59056. <remarks>
  59057. Event args used when a message vanishes from a folder.
  59058. </remarks>
  59059. </member>
  59060. <member name="M:MailKit.MessagesVanishedEventArgs.#ctor(System.Collections.Generic.IList{MailKit.UniqueId},System.Boolean)">
  59061. <summary>
  59062. Initializes a new instance of the <see cref="T:MailKit.MessagesVanishedEventArgs"/> class.
  59063. </summary>
  59064. <remarks>
  59065. Creates a new <see cref="T:MailKit.MessagesVanishedEventArgs"/>.
  59066. </remarks>
  59067. <param name="uids">The list of unique identifiers.</param>
  59068. <param name="earlier">If set to <c>true</c>, the messages vanished in the past as opposed to just now.</param>
  59069. <exception cref="T:System.ArgumentNullException">
  59070. <paramref name="uids"/> is <c>null</c>.
  59071. </exception>
  59072. </member>
  59073. <member name="P:MailKit.MessagesVanishedEventArgs.UniqueIds">
  59074. <summary>
  59075. Gets the unique identifiers of the messages that vanished.
  59076. </summary>
  59077. <remarks>
  59078. Gets the unique identifiers of the messages that vanished.
  59079. </remarks>
  59080. <value>The unique identifiers.</value>
  59081. </member>
  59082. <member name="P:MailKit.MessagesVanishedEventArgs.Earlier">
  59083. <summary>
  59084. Gets whether the messages vanished inthe past as opposed to just now.
  59085. </summary>
  59086. <remarks>
  59087. Gets whether the messages vanished inthe past as opposed to just now.
  59088. </remarks>
  59089. <value><c>true</c> if the messages vanished earlier; otherwise, <c>false</c>.</value>
  59090. </member>
  59091. <member name="T:MailKit.MessageThread">
  59092. <summary>
  59093. A message thread.
  59094. </summary>
  59095. <remarks>
  59096. A message thread.
  59097. </remarks>
  59098. </member>
  59099. <member name="M:MailKit.MessageThread.#ctor(System.Nullable{MailKit.UniqueId})">
  59100. <summary>
  59101. Initializes a new instance of the <see cref="T:MailKit.MessageThread"/> class.
  59102. </summary>
  59103. <remarks>
  59104. Creates a new message thread node.
  59105. </remarks>
  59106. <param name="uid">The unique identifier of the message.</param>
  59107. </member>
  59108. <member name="P:MailKit.MessageThread.UniqueId">
  59109. <summary>
  59110. Gets the unique identifier of the message.
  59111. </summary>
  59112. <remarks>
  59113. The unique identifier may be <c>null</c> if the message is missing
  59114. from the <see cref="T:MailKit.IMailFolder"/> or did not match the
  59115. <see cref="T:MailKit.Search.SearchQuery"/>.
  59116. </remarks>
  59117. <value>The unique identifier.</value>
  59118. </member>
  59119. <member name="P:MailKit.MessageThread.Children">
  59120. <summary>
  59121. Gets the children.
  59122. </summary>
  59123. <remarks>
  59124. Each child represents a reply to the message referenced by <see cref="P:MailKit.MessageThread.UniqueId"/>.
  59125. </remarks>
  59126. <value>The children.</value>
  59127. </member>
  59128. <member name="T:MailKit.MessageThreader">
  59129. <summary>
  59130. Threads messages according to the algorithms defined in rfc5256.
  59131. </summary>
  59132. <remarks>
  59133. Threads messages according to the algorithms defined in rfc5256.
  59134. </remarks>
  59135. </member>
  59136. <member name="M:MailKit.MessageThreader.Thread(System.Collections.Generic.IEnumerable{MailKit.IMessageSummary},MailKit.ThreadingAlgorithm)">
  59137. <summary>
  59138. Thread the messages according to the specified threading algorithm.
  59139. </summary>
  59140. <remarks>
  59141. Thread the messages according to the specified threading algorithm.
  59142. </remarks>
  59143. <returns>The threaded messages.</returns>
  59144. <param name="messages">The messages.</param>
  59145. <param name="algorithm">The threading algorithm.</param>
  59146. <exception cref="T:System.ArgumentNullException">
  59147. <paramref name="messages"/> is <c>null</c>.
  59148. </exception>
  59149. <exception cref="T:System.ArgumentOutOfRangeException">
  59150. <paramref name="algorithm"/> is not a valid threading algorithm.
  59151. </exception>
  59152. <exception cref="T:System.ArgumentException">
  59153. <paramref name="messages"/> contains one or more items that is missing information needed for threading.
  59154. </exception>
  59155. </member>
  59156. <member name="M:MailKit.MessageThreader.Thread(System.Collections.Generic.IEnumerable{MailKit.IMessageSummary},MailKit.ThreadingAlgorithm,System.Collections.Generic.IList{MailKit.Search.OrderBy})">
  59157. <summary>
  59158. Threads the messages according to the specified threading algorithm
  59159. and sorts the resulting threads by the specified ordering.
  59160. </summary>
  59161. <remarks>
  59162. Threads the messages according to the specified threading algorithm
  59163. and sorts the resulting threads by the specified ordering.
  59164. </remarks>
  59165. <returns>The threaded messages.</returns>
  59166. <param name="messages">The messages.</param>
  59167. <param name="algorithm">The threading algorithm.</param>
  59168. <param name="orderBy">The requested sort ordering.</param>
  59169. <exception cref="T:System.ArgumentNullException">
  59170. <para><paramref name="messages"/> is <c>null</c>.</para>
  59171. <para>-or-</para>
  59172. <para><paramref name="orderBy"/> is <c>null</c>.</para>
  59173. </exception>
  59174. <exception cref="T:System.ArgumentOutOfRangeException">
  59175. <paramref name="algorithm"/> is not a valid threading algorithm.
  59176. </exception>
  59177. <exception cref="T:System.ArgumentException">
  59178. <para><paramref name="messages"/> contains one or more items that is missing information needed for threading or sorting.</para>
  59179. <para>-or-</para>
  59180. <para><paramref name="orderBy"/> is an empty list.</para>
  59181. </exception>
  59182. </member>
  59183. <member name="M:MailKit.MessageThreader.GetThreadableSubject(System.String,System.Int32@)">
  59184. <summary>
  59185. Gets the threadable subject.
  59186. </summary>
  59187. <remarks>
  59188. Gets the threadable subject.
  59189. </remarks>
  59190. <returns>The threadable subject.</returns>
  59191. <param name="subject">The Subject header value.</param>
  59192. <param name="replyDepth">The reply depth.</param>
  59193. <exception cref="T:System.ArgumentNullException">
  59194. <paramref name="subject"/> is <c>null</c>.
  59195. </exception>
  59196. </member>
  59197. <member name="T:MailKit.Metadata">
  59198. <summary>
  59199. A metadata tag and value.
  59200. </summary>
  59201. <remarks>
  59202. A metadata tag and value.
  59203. </remarks>
  59204. </member>
  59205. <member name="M:MailKit.Metadata.#ctor(MailKit.MetadataTag,System.String)">
  59206. <summary>
  59207. Initializes a new instance of the <see cref="T:MailKit.Metadata"/> class.
  59208. </summary>
  59209. <remarks>
  59210. Creates a new <see cref="T:MailKit.Metadata"/>.
  59211. </remarks>
  59212. <param name="tag">The metadata tag.</param>
  59213. <param name="value">The metadata value.</param>
  59214. </member>
  59215. <member name="P:MailKit.Metadata.Tag">
  59216. <summary>
  59217. Gets the metadata tag.
  59218. </summary>
  59219. <remarks>
  59220. Gets the metadata tag.
  59221. </remarks>
  59222. <value>The metadata tag.</value>
  59223. </member>
  59224. <member name="P:MailKit.Metadata.Value">
  59225. <summary>
  59226. Gets the metadata value.
  59227. </summary>
  59228. <remarks>
  59229. Gets the metadata value.
  59230. </remarks>
  59231. <value>The metadata value.</value>
  59232. </member>
  59233. <member name="T:MailKit.MetadataChangedEventArgs">
  59234. <summary>
  59235. Event args used when a metadata changes.
  59236. </summary>
  59237. <remarks>
  59238. Event args used when a metadata changes.
  59239. </remarks>
  59240. </member>
  59241. <member name="M:MailKit.MetadataChangedEventArgs.#ctor(MailKit.Metadata)">
  59242. <summary>
  59243. Initializes a new instance of the <see cref="T:MailKit.MetadataChangedEventArgs"/> class.
  59244. </summary>
  59245. <remarks>
  59246. Creates a new <see cref="T:MailKit.MetadataChangedEventArgs"/>.
  59247. </remarks>
  59248. <param name="metadata">The metadata that changed.</param>
  59249. <exception cref="T:System.ArgumentNullException">
  59250. <paramref name="metadata"/> is <c>null</c>.
  59251. </exception>
  59252. </member>
  59253. <member name="P:MailKit.MetadataChangedEventArgs.Metadata">
  59254. <summary>
  59255. Get the metadata that changed.
  59256. </summary>
  59257. <remarks>
  59258. Gets the metadata that changed.
  59259. </remarks>
  59260. <value>The metadata.</value>
  59261. </member>
  59262. <member name="T:MailKit.MetadataCollection">
  59263. <summary>
  59264. A collection of metadata.
  59265. </summary>
  59266. <remarks>
  59267. A collection of metadata.
  59268. </remarks>
  59269. </member>
  59270. <member name="M:MailKit.MetadataCollection.#ctor">
  59271. <summary>
  59272. Initializes a new instance of the <see cref="T:MailKit.MetadataCollection"/> class.
  59273. </summary>
  59274. <remarks>
  59275. Creates a new <see cref="T:MailKit.MetadataCollection"/>
  59276. </remarks>
  59277. </member>
  59278. <member name="M:MailKit.MetadataCollection.#ctor(System.Collections.Generic.IEnumerable{MailKit.Metadata})">
  59279. <summary>
  59280. Initializes a new instance of the <see cref="T:MailKit.MetadataCollection"/> class.
  59281. </summary>
  59282. <remarks>
  59283. Creates a new <see cref="T:MailKit.MetadataCollection"/>.
  59284. </remarks>
  59285. <param name="collection">A collection of metadata.</param>
  59286. </member>
  59287. <member name="T:MailKit.MetadataOptions">
  59288. <summary>
  59289. A set of options to use when requesting metadata.
  59290. </summary>
  59291. <remarks>
  59292. A set of options to use when requesting metadata.
  59293. </remarks>
  59294. </member>
  59295. <member name="M:MailKit.MetadataOptions.#ctor">
  59296. <summary>
  59297. Initializes a new instance of the <see cref="T:MailKit.MetadataOptions"/> class.
  59298. </summary>
  59299. <remarks>
  59300. Creates a new set of options to use when requesting metadata.
  59301. </remarks>
  59302. </member>
  59303. <member name="P:MailKit.MetadataOptions.Depth">
  59304. <summary>
  59305. Get or set the depth.
  59306. </summary>
  59307. <remarks>
  59308. <para>When the <see cref="P:MailKit.MetadataOptions.Depth"/> option is specified, it extends the list of metadata tag
  59309. values returned by the GetMetadata() call. For each <see cref="T:MailKit.MetadataTag"/> specified in the
  59310. the GetMetadata() call, the method returns the value of the specified metadata tag (if it exists),
  59311. plus all metadata tags below the specified entry up to the specified depth.</para>
  59312. <para>Three values are allowed for <see cref="P:MailKit.MetadataOptions.Depth"/>:</para>
  59313. <para><c>0</c> - no entries below the specified metadata tag are returned.</para>
  59314. <para><c>1</c> - only entries immediately below the specified metadata tag are returned.</para>
  59315. <para><see cref="F:System.Int32.MaxValue"/> - all entries below the specified metadata tag are returned.</para>
  59316. <para>Thus, a depth of <c>1</c> for a tag entry of <c>"/a"</c> will match <c>"/a"</c> as well as its children
  59317. entries (e.g., <c>"/a/b"</c>), but will not match grandchildren entries (e.g., <c>"/a/b/c"</c>).</para>
  59318. <para>If the Depth option is not specified, this is the same as specifying <c>0</c>.</para>
  59319. </remarks>
  59320. <value>The depth.</value>
  59321. <exception cref="T:System.ArgumentOutOfRangeException">
  59322. <paramref name="value"/> is out of range.
  59323. </exception>
  59324. </member>
  59325. <member name="P:MailKit.MetadataOptions.MaxSize">
  59326. <summary>
  59327. Get or set the max size of the metadata tags to request.
  59328. </summary>
  59329. <remarks>
  59330. When specified, the <see cref="P:MailKit.MetadataOptions.MaxSize"/> property is used to filter the metadata tags
  59331. returned by the GetMetadata() call to only those with a value shorter than the max size
  59332. specified.
  59333. </remarks>
  59334. <value>The size of the max.</value>
  59335. </member>
  59336. <member name="P:MailKit.MetadataOptions.LongEntries">
  59337. <summary>
  59338. Get the length of the longest metadata value.
  59339. </summary>
  59340. <remarks>
  59341. If the <see cref="P:MailKit.MetadataOptions.MaxSize"/> property is specified, once the GetMetadata() call returns,
  59342. the <see cref="P:MailKit.MetadataOptions.LongEntries"/> property will be set to the length of the longest metadata
  59343. value that exceeded the <see cref="P:MailKit.MetadataOptions.MaxSize"/> limit, otherwise a value of <c>0</c> will
  59344. be set.
  59345. </remarks>
  59346. <value>The length of the longest metadata value that exceeded the max size.</value>
  59347. </member>
  59348. <member name="T:MailKit.MetadataTag">
  59349. <summary>
  59350. A metadata tag.
  59351. </summary>
  59352. <remarks>
  59353. A metadata tag.
  59354. </remarks>
  59355. </member>
  59356. <member name="F:MailKit.MetadataTag.SharedAdmin">
  59357. <summary>
  59358. A metadata tag for specifying the contact information for the server administrator.
  59359. </summary>
  59360. <remarks>
  59361. Used to get the contact information of the administrator on a
  59362. <see cref="T:MailKit.IMailStore"/>.
  59363. </remarks>
  59364. </member>
  59365. <member name="F:MailKit.MetadataTag.PrivateComment">
  59366. <summary>
  59367. A metadata tag for private comments.
  59368. </summary>
  59369. <remarks>
  59370. Used to get or set a private comment on a <see cref="T:MailKit.IMailFolder"/>.
  59371. </remarks>
  59372. </member>
  59373. <member name="F:MailKit.MetadataTag.SharedComment">
  59374. <summary>
  59375. A metadata tag for shared comments.
  59376. </summary>
  59377. <remarks>
  59378. Used to get or set a shared comment on a <see cref="T:MailKit.IMailStore"/>
  59379. or <see cref="T:MailKit.IMailFolder"/>.
  59380. </remarks>
  59381. </member>
  59382. <member name="F:MailKit.MetadataTag.PrivateSpecialUse">
  59383. <summary>
  59384. A metadata tag for specifying the special use of a folder.
  59385. </summary>
  59386. <remarks>
  59387. Used to get or set the special use of a <see cref="T:MailKit.IMailFolder"/>.
  59388. </remarks>
  59389. </member>
  59390. <member name="M:MailKit.MetadataTag.#ctor(System.String)">
  59391. <summary>
  59392. Initializes a new instance of the <see cref="T:MailKit.MetadataTag"/> struct.
  59393. </summary>
  59394. <remarks>
  59395. Creates a new <see cref="T:MailKit.MetadataTag"/>.
  59396. </remarks>
  59397. <param name="id">The metadata tag identifier.</param>
  59398. <exception cref="T:System.ArgumentNullException">
  59399. <paramref name="id"/> is <c>null</c>.
  59400. </exception>
  59401. <exception cref="T:System.ArgumentException">
  59402. <paramref name="id"/> is an empty string.
  59403. </exception>
  59404. </member>
  59405. <member name="P:MailKit.MetadataTag.Id">
  59406. <summary>
  59407. Get the metadata tag identifier.
  59408. </summary>
  59409. <remarks>
  59410. Gets the metadata tag identifier.
  59411. </remarks>
  59412. <value>The metadata tag identifier.</value>
  59413. </member>
  59414. <member name="M:MailKit.MetadataTag.Equals(System.Object)">
  59415. <summary>
  59416. Determine whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:MailKit.MetadataTag"/>.
  59417. </summary>
  59418. <remarks>
  59419. Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:MailKit.MetadataTag"/>.
  59420. </remarks>
  59421. <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:MailKit.MetadataTag"/>.</param>
  59422. <returns><c>true</c> if the specified <see cref="T:System.Object"/> is equal to the current
  59423. <see cref="T:MailKit.MetadataTag"/>; otherwise, <c>false</c>.</returns>
  59424. </member>
  59425. <member name="M:MailKit.MetadataTag.GetHashCode">
  59426. <summary>
  59427. Serves as a hash function for a <see cref="T:MailKit.MetadataTag"/> object.
  59428. </summary>
  59429. <remarks>
  59430. Serves as a hash function for a <see cref="T:MailKit.MetadataTag"/> object.
  59431. </remarks>
  59432. <returns>A hash code for this instance that is suitable for use in hashing algorithms and data structures such as a hash table.</returns>
  59433. </member>
  59434. <member name="M:MailKit.MetadataTag.ToString">
  59435. <summary>
  59436. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.MetadataTag"/>.
  59437. </summary>
  59438. <remarks>
  59439. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.MetadataTag"/>.
  59440. </remarks>
  59441. <returns>A <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.MetadataTag"/>.</returns>
  59442. </member>
  59443. <member name="T:MailKit.ModSeqChangedEventArgs">
  59444. <summary>
  59445. Event args for the <see cref="E:MailKit.IMailFolder.ModSeqChanged"/> event.
  59446. </summary>
  59447. <remarks>
  59448. Event args for the <see cref="E:MailKit.IMailFolder.ModSeqChanged"/> event.
  59449. </remarks>
  59450. </member>
  59451. <member name="M:MailKit.ModSeqChangedEventArgs.#ctor(System.Int32)">
  59452. <summary>
  59453. Initializes a new instance of the <see cref="T:MailKit.ModSeqChangedEventArgs"/> class.
  59454. </summary>
  59455. <remarks>
  59456. Creates a new <see cref="T:MailKit.ModSeqChangedEventArgs"/>.
  59457. </remarks>
  59458. <param name="index">The message index.</param>
  59459. </member>
  59460. <member name="M:MailKit.ModSeqChangedEventArgs.#ctor(System.Int32,System.UInt64)">
  59461. <summary>
  59462. Initializes a new instance of the <see cref="T:MailKit.MessageFlagsChangedEventArgs"/> class.
  59463. </summary>
  59464. <remarks>
  59465. Creates a new <see cref="T:MailKit.MessageFlagsChangedEventArgs"/>.
  59466. </remarks>
  59467. <param name="index">The message index.</param>
  59468. <param name="modseq">The modification sequence value.</param>
  59469. </member>
  59470. <member name="M:MailKit.ModSeqChangedEventArgs.#ctor(System.Int32,MailKit.UniqueId,System.UInt64)">
  59471. <summary>
  59472. Initializes a new instance of the <see cref="T:MailKit.ModSeqChangedEventArgs"/> class.
  59473. </summary>
  59474. <remarks>
  59475. Creates a new <see cref="T:MailKit.ModSeqChangedEventArgs"/>.
  59476. </remarks>
  59477. <param name="index">The message index.</param>
  59478. <param name="uid">The unique id of the message.</param>
  59479. <param name="modseq">The modification sequence value.</param>
  59480. </member>
  59481. <member name="P:MailKit.ModSeqChangedEventArgs.ModSeq">
  59482. <summary>
  59483. Gets the updated mod-sequence value of the message.
  59484. </summary>
  59485. <remarks>
  59486. Gets the updated mod-sequence value of the message.
  59487. </remarks>
  59488. <value>The mod-sequence value.</value>
  59489. </member>
  59490. <member name="T:MailKit.NullProtocolLogger">
  59491. <summary>
  59492. A protocol logger that does not log to anywhere.
  59493. </summary>
  59494. <remarks>
  59495. By default, the <see cref="T:MailKit.Net.Smtp.SmtpClient"/>,
  59496. <see cref="T:MailKit.Net.Pop3.Pop3Client"/>, and
  59497. <see cref="T:MailKit.Net.Imap.ImapClient"/> all use a
  59498. <see cref="T:MailKit.NullProtocolLogger"/>.
  59499. </remarks>
  59500. </member>
  59501. <member name="M:MailKit.NullProtocolLogger.#ctor">
  59502. <summary>
  59503. Initializes a new instance of the <see cref="T:MailKit.NullProtocolLogger"/> class.
  59504. </summary>
  59505. <remarks>
  59506. Creates a new <see cref="T:MailKit.NullProtocolLogger"/>.
  59507. </remarks>
  59508. </member>
  59509. <member name="M:MailKit.NullProtocolLogger.LogConnect(System.Uri)">
  59510. <summary>
  59511. Logs a connection to the specified URI.
  59512. </summary>
  59513. <remarks>
  59514. This method does nothing.
  59515. </remarks>
  59516. <param name="uri">The URI.</param>
  59517. </member>
  59518. <member name="M:MailKit.NullProtocolLogger.LogClient(System.Byte[],System.Int32,System.Int32)">
  59519. <summary>
  59520. Logs a sequence of bytes sent by the client.
  59521. </summary>
  59522. <remarks>
  59523. This method does nothing.
  59524. </remarks>
  59525. <param name='buffer'>The buffer to log.</param>
  59526. <param name='offset'>The offset of the first byte to log.</param>
  59527. <param name='count'>The number of bytes to log.</param>
  59528. <exception cref="T:System.ArgumentNullException">
  59529. <paramref name="buffer"/> is <c>null</c>.
  59530. </exception>
  59531. </member>
  59532. <member name="M:MailKit.NullProtocolLogger.LogServer(System.Byte[],System.Int32,System.Int32)">
  59533. <summary>
  59534. Logs a sequence of bytes sent by the server.
  59535. </summary>
  59536. <remarks>
  59537. This method does nothing.
  59538. </remarks>
  59539. <param name='buffer'>The buffer to log.</param>
  59540. <param name='offset'>The offset of the first byte to log.</param>
  59541. <param name='count'>The number of bytes to log.</param>
  59542. <exception cref="T:System.ArgumentNullException">
  59543. <paramref name="buffer"/> is <c>null</c>.
  59544. </exception>
  59545. </member>
  59546. <member name="M:MailKit.NullProtocolLogger.Dispose">
  59547. <summary>
  59548. Releases all resource used by the <see cref="T:MailKit.NullProtocolLogger"/> object.
  59549. </summary>
  59550. <remarks>Call <see cref="M:MailKit.NullProtocolLogger.Dispose"/> when you are finished using the <see cref="T:MailKit.NullProtocolLogger"/>. The
  59551. <see cref="M:MailKit.NullProtocolLogger.Dispose"/> method leaves the <see cref="T:MailKit.NullProtocolLogger"/> in an unusable state. After
  59552. calling <see cref="M:MailKit.NullProtocolLogger.Dispose"/>, you must release all references to the <see cref="T:MailKit.NullProtocolLogger"/> so
  59553. the garbage collector can reclaim the memory that the <see cref="T:MailKit.NullProtocolLogger"/> was occupying.</remarks>
  59554. </member>
  59555. <member name="T:MailKit.ProtocolException">
  59556. <summary>
  59557. The exception that is thrown when there is a protocol error.
  59558. </summary>
  59559. <remarks>
  59560. <para>A <see cref="T:MailKit.ProtocolException"/> can be thrown by any of the various client
  59561. methods in MailKit.</para>
  59562. <para>Since many protocol exceptions are fatal, it is important to check whether
  59563. or not the client is still connected using the <see cref="P:MailKit.IMailService.IsConnected"/>
  59564. property when this exception is thrown.</para>
  59565. </remarks>
  59566. </member>
  59567. <member name="M:MailKit.ProtocolException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  59568. <summary>
  59569. Initializes a new instance of the <see cref="T:MailKit.ProtocolException"/> class.
  59570. </summary>
  59571. <remarks>
  59572. Creates a new <see cref="T:MailKit.ProtocolException"/>.
  59573. </remarks>
  59574. <param name="info">The serialization info.</param>
  59575. <param name="context">The streaming context.</param>
  59576. </member>
  59577. <member name="M:MailKit.ProtocolException.#ctor(System.String,System.Exception)">
  59578. <summary>
  59579. Initializes a new instance of the <see cref="T:MailKit.ProtocolException"/> class.
  59580. </summary>
  59581. <remarks>
  59582. Creates a new <see cref="T:MailKit.ProtocolException"/>.
  59583. </remarks>
  59584. <param name="message">The error message.</param>
  59585. <param name="innerException">An inner exception.</param>
  59586. </member>
  59587. <member name="M:MailKit.ProtocolException.#ctor(System.String)">
  59588. <summary>
  59589. Initializes a new instance of the <see cref="T:MailKit.ProtocolException"/> class.
  59590. </summary>
  59591. <remarks>
  59592. Creates a new <see cref="T:MailKit.ProtocolException"/>.
  59593. </remarks>
  59594. <param name="message">The error message.</param>
  59595. </member>
  59596. <member name="M:MailKit.ProtocolException.#ctor">
  59597. <summary>
  59598. Initializes a new instance of the <see cref="T:MailKit.ProtocolException"/> class.
  59599. </summary>
  59600. <remarks>
  59601. Creates a new <see cref="T:MailKit.ProtocolException"/>.
  59602. </remarks>
  59603. </member>
  59604. <member name="T:MailKit.ProtocolLogger">
  59605. <summary>
  59606. A default protocol logger for logging the communication between a client and server.
  59607. </summary>
  59608. <remarks>
  59609. A default protocol logger for logging the communication between a client and server.
  59610. </remarks>
  59611. <example>
  59612. <code language="c#" source="Examples\SmtpExamples.cs" region="ProtocolLogger" />
  59613. </example>
  59614. </member>
  59615. <member name="M:MailKit.ProtocolLogger.#ctor(System.String,System.Boolean)">
  59616. <summary>
  59617. Initializes a new instance of the <see cref="T:MailKit.ProtocolLogger"/> class.
  59618. </summary>
  59619. <remarks>
  59620. Creates a new <see cref="T:MailKit.ProtocolLogger"/> to log to a specified file. The file is created if it does not exist.
  59621. </remarks>
  59622. <example>
  59623. <code language="c#" source="Examples\SmtpExamples.cs" region="ProtocolLogger" />
  59624. </example>
  59625. <param name="fileName">The file name.</param>
  59626. <param name="append"><c>true</c> if the file should be appended to; otherwise, <c>false</c>. Defaults to <c>true</c>.</param>
  59627. </member>
  59628. <member name="M:MailKit.ProtocolLogger.#ctor(System.IO.Stream,System.Boolean)">
  59629. <summary>
  59630. Initializes a new instance of the <see cref="T:MailKit.ProtocolLogger"/> class.
  59631. </summary>
  59632. <remarks>
  59633. Creates a new <see cref="T:MailKit.ProtocolLogger"/> to log to a specified stream.
  59634. </remarks>
  59635. <param name="stream">The stream.</param>
  59636. <param name="leaveOpen"><c>true</c> if the stream should be left open after the protocol logger is disposed.</param>
  59637. </member>
  59638. <member name="M:MailKit.ProtocolLogger.Finalize">
  59639. <summary>
  59640. Releases unmanaged resources and performs other cleanup operations before the <see cref="T:MailKit.ProtocolLogger"/>
  59641. is reclaimed by garbage collection.
  59642. </summary>
  59643. <remarks>
  59644. Releases unmanaged resources and performs other cleanup operations before the <see cref="T:MailKit.ProtocolLogger"/>
  59645. is reclaimed by garbage collection.
  59646. </remarks>
  59647. </member>
  59648. <member name="P:MailKit.ProtocolLogger.Stream">
  59649. <summary>
  59650. Get the log stream.
  59651. </summary>
  59652. <remarks>
  59653. Gets the log stream.
  59654. </remarks>
  59655. <value>The log sstream.</value>
  59656. </member>
  59657. <member name="M:MailKit.ProtocolLogger.LogConnect(System.Uri)">
  59658. <summary>
  59659. Logs a connection to the specified URI.
  59660. </summary>
  59661. <remarks>
  59662. Logs a connection to the specified URI.
  59663. </remarks>
  59664. <param name="uri">The URI.</param>
  59665. <exception cref="T:System.ArgumentNullException">
  59666. <paramref name="uri"/> is <c>null</c>.
  59667. </exception>
  59668. <exception cref="T:System.ObjectDisposedException">
  59669. The logger has been disposed.
  59670. </exception>
  59671. <exception cref="T:System.IO.IOException">
  59672. An I/O error occurred.
  59673. </exception>
  59674. </member>
  59675. <member name="M:MailKit.ProtocolLogger.LogClient(System.Byte[],System.Int32,System.Int32)">
  59676. <summary>
  59677. Logs a sequence of bytes sent by the client.
  59678. </summary>
  59679. <remarks>
  59680. <para>Logs a sequence of bytes sent by the client.</para>
  59681. <para><see cref="M:MailKit.ProtocolLogger.LogClient(System.Byte[],System.Int32,System.Int32)"/> is called by the <see cref="T:MailKit.IMailService"/> upon every successful
  59682. write operation to its underlying network stream, passing the exact same <paramref name="buffer"/>,
  59683. <paramref name="offset"/>, and <paramref name="count"/> arguments to the logging function.</para>
  59684. </remarks>
  59685. <param name='buffer'>The buffer to log.</param>
  59686. <param name='offset'>The offset of the first byte to log.</param>
  59687. <param name='count'>The number of bytes to log.</param>
  59688. <exception cref="T:System.ArgumentNullException">
  59689. <paramref name="buffer"/> is <c>null</c>.
  59690. </exception>
  59691. <exception cref="T:System.ArgumentOutOfRangeException">
  59692. <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
  59693. <para>-or-</para>
  59694. <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
  59695. at the specified <paramref name="offset"/>.</para>
  59696. </exception>
  59697. <exception cref="T:System.ObjectDisposedException">
  59698. The logger has been disposed.
  59699. </exception>
  59700. <exception cref="T:System.IO.IOException">
  59701. An I/O error occurred.
  59702. </exception>
  59703. </member>
  59704. <member name="M:MailKit.ProtocolLogger.LogServer(System.Byte[],System.Int32,System.Int32)">
  59705. <summary>
  59706. Logs a sequence of bytes sent by the server.
  59707. </summary>
  59708. <remarks>
  59709. <para>Logs a sequence of bytes sent by the server.</para>
  59710. <para><see cref="M:MailKit.ProtocolLogger.LogServer(System.Byte[],System.Int32,System.Int32)"/> is called by the <see cref="T:MailKit.IMailService"/> upon every successful
  59711. read of its underlying network stream with the exact buffer that was read.</para>
  59712. </remarks>
  59713. <param name='buffer'>The buffer to log.</param>
  59714. <param name='offset'>The offset of the first byte to log.</param>
  59715. <param name='count'>The number of bytes to log.</param>
  59716. <exception cref="T:System.ArgumentNullException">
  59717. <paramref name="buffer"/> is <c>null</c>.
  59718. </exception>
  59719. <exception cref="T:System.ArgumentOutOfRangeException">
  59720. <para><paramref name="offset"/> is less than zero or greater than the length of <paramref name="buffer"/>.</para>
  59721. <para>-or-</para>
  59722. <para>The <paramref name="buffer"/> is not large enough to contain <paramref name="count"/> bytes strting
  59723. at the specified <paramref name="offset"/>.</para>
  59724. </exception>
  59725. <exception cref="T:System.ObjectDisposedException">
  59726. The logger has been disposed.
  59727. </exception>
  59728. <exception cref="T:System.IO.IOException">
  59729. An I/O error occurred.
  59730. </exception>
  59731. </member>
  59732. <member name="M:MailKit.ProtocolLogger.Dispose(System.Boolean)">
  59733. <summary>
  59734. Releases the unmanaged resources used by the <see cref="T:MailKit.ProtocolLogger"/> and
  59735. optionally releases the managed resources.
  59736. </summary>
  59737. <remarks>
  59738. Releases the unmanaged resources used by the <see cref="T:MailKit.ProtocolLogger"/> and
  59739. optionally releases the managed resources.
  59740. </remarks>
  59741. <param name="disposing"><c>true</c> to release both managed and unmanaged resources;
  59742. <c>false</c> to release only the unmanaged resources.</param>
  59743. </member>
  59744. <member name="M:MailKit.ProtocolLogger.Dispose">
  59745. <summary>
  59746. Releases all resource used by the <see cref="T:MailKit.ProtocolLogger"/> object.
  59747. </summary>
  59748. <remarks>Call <see cref="M:MailKit.ProtocolLogger.Dispose"/> when you are finished using the <see cref="T:MailKit.ProtocolLogger"/>. The
  59749. <see cref="M:MailKit.ProtocolLogger.Dispose"/> method leaves the <see cref="T:MailKit.ProtocolLogger"/> in an unusable state. After calling
  59750. <see cref="M:MailKit.ProtocolLogger.Dispose"/>, you must release all references to the <see cref="T:MailKit.ProtocolLogger"/> so the garbage
  59751. collector can reclaim the memory that the <see cref="T:MailKit.ProtocolLogger"/> was occupying.</remarks>
  59752. </member>
  59753. <member name="T:MailKit.ServiceNotAuthenticatedException">
  59754. <summary>
  59755. The exception that is thrown when the <see cref="T:MailKit.IMailService"/> is not authenticated.
  59756. </summary>
  59757. <remarks>
  59758. This exception is thrown when an operation on a service could not be completed
  59759. due to the service not being authenticated.
  59760. </remarks>
  59761. </member>
  59762. <member name="M:MailKit.ServiceNotAuthenticatedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  59763. <summary>
  59764. Initializes a new instance of the <see cref="T:MailKit.ServiceNotAuthenticatedException"/> class.
  59765. </summary>
  59766. <remarks>
  59767. Deserializes a <see cref="T:MailKit.ServiceNotAuthenticatedException"/>.
  59768. </remarks>
  59769. <param name="info">The serialization info.</param>
  59770. <param name="context">The streaming context.</param>
  59771. <exception cref="T:System.ArgumentNullException">
  59772. <paramref name="info"/> is <c>null</c>.
  59773. </exception>
  59774. </member>
  59775. <member name="M:MailKit.ServiceNotAuthenticatedException.#ctor(System.String,System.Exception)">
  59776. <summary>
  59777. Initializes a new instance of the <see cref="T:MailKit.ServiceNotAuthenticatedException"/> class.
  59778. </summary>
  59779. <remarks>
  59780. Creates a new <see cref="T:MailKit.ServiceNotAuthenticatedException"/>.
  59781. </remarks>
  59782. <param name="message">The error message.</param>
  59783. <param name="innerException">The inner exception.</param>
  59784. </member>
  59785. <member name="M:MailKit.ServiceNotAuthenticatedException.#ctor(System.String)">
  59786. <summary>
  59787. Initializes a new instance of the <see cref="T:MailKit.ServiceNotAuthenticatedException"/> class.
  59788. </summary>
  59789. <remarks>
  59790. Creates a new <see cref="T:MailKit.ServiceNotAuthenticatedException"/>.
  59791. </remarks>
  59792. <param name="message">The error message.</param>
  59793. </member>
  59794. <member name="M:MailKit.ServiceNotAuthenticatedException.#ctor">
  59795. <summary>
  59796. Initializes a new instance of the <see cref="T:MailKit.ServiceNotAuthenticatedException"/> class.
  59797. </summary>
  59798. <remarks>
  59799. Creates a new <see cref="T:MailKit.ServiceNotAuthenticatedException"/>.
  59800. </remarks>
  59801. </member>
  59802. <member name="T:MailKit.ServiceNotConnectedException">
  59803. <summary>
  59804. The exception that is thrown when the <see cref="T:MailKit.IMailService"/> is not connected.
  59805. </summary>
  59806. <remarks>
  59807. This exception is thrown when an operation on a service could not be completed
  59808. due to the service not being connected.
  59809. </remarks>
  59810. </member>
  59811. <member name="M:MailKit.ServiceNotConnectedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  59812. <summary>
  59813. Initializes a new instance of the <see cref="T:MailKit.ServiceNotConnectedException"/> class.
  59814. </summary>
  59815. <remarks>
  59816. Deserializes a <see cref="T:MailKit.ServiceNotConnectedException"/>.
  59817. </remarks>
  59818. <param name="info">The serialization info.</param>
  59819. <param name="context">The streaming context.</param>
  59820. <exception cref="T:System.ArgumentNullException">
  59821. <paramref name="info"/> is <c>null</c>.
  59822. </exception>
  59823. </member>
  59824. <member name="M:MailKit.ServiceNotConnectedException.#ctor(System.String,System.Exception)">
  59825. <summary>
  59826. Initializes a new instance of the <see cref="T:MailKit.ServiceNotConnectedException"/> class.
  59827. </summary>
  59828. <remarks>
  59829. Creates a new <see cref="T:MailKit.ServiceNotConnectedException"/>.
  59830. </remarks>
  59831. <param name="message">The error message.</param>
  59832. <param name="innerException">The inner exception.</param>
  59833. </member>
  59834. <member name="M:MailKit.ServiceNotConnectedException.#ctor(System.String)">
  59835. <summary>
  59836. Initializes a new instance of the <see cref="T:MailKit.ServiceNotConnectedException"/> class.
  59837. </summary>
  59838. <remarks>
  59839. Creates a new <see cref="T:MailKit.ServiceNotConnectedException"/>.
  59840. </remarks>
  59841. <param name="message">The error message.</param>
  59842. </member>
  59843. <member name="M:MailKit.ServiceNotConnectedException.#ctor">
  59844. <summary>
  59845. Initializes a new instance of the <see cref="T:MailKit.ServiceNotConnectedException"/> class.
  59846. </summary>
  59847. <remarks>
  59848. Creates a new <see cref="T:MailKit.ServiceNotConnectedException"/>.
  59849. </remarks>
  59850. </member>
  59851. <member name="T:MailKit.SpecialFolder">
  59852. <summary>
  59853. An enumeration of special folders.
  59854. </summary>
  59855. <remarks>
  59856. An enumeration of special folders.
  59857. </remarks>
  59858. </member>
  59859. <member name="F:MailKit.SpecialFolder.All">
  59860. <summary>
  59861. The special folder containing an aggregate of all messages.
  59862. </summary>
  59863. </member>
  59864. <member name="F:MailKit.SpecialFolder.Archive">
  59865. <summary>
  59866. The special folder that contains archived messages.
  59867. </summary>
  59868. </member>
  59869. <member name="F:MailKit.SpecialFolder.Drafts">
  59870. <summary>
  59871. The special folder that contains message drafts.
  59872. </summary>
  59873. </member>
  59874. <member name="F:MailKit.SpecialFolder.Flagged">
  59875. <summary>
  59876. The special folder that contains important messages.
  59877. </summary>
  59878. </member>
  59879. <member name="F:MailKit.SpecialFolder.Junk">
  59880. <summary>
  59881. The special folder that contains spam messages.
  59882. </summary>
  59883. </member>
  59884. <member name="F:MailKit.SpecialFolder.Sent">
  59885. <summary>
  59886. The special folder that contains sent messages.
  59887. </summary>
  59888. </member>
  59889. <member name="F:MailKit.SpecialFolder.Trash">
  59890. <summary>
  59891. The special folder that contains deleted messages.
  59892. </summary>
  59893. </member>
  59894. <member name="T:MailKit.StatusItems">
  59895. <summary>
  59896. Status items.
  59897. </summary>
  59898. <remarks>
  59899. Used with <see cref="M:MailKit.IMailFolder.Status(MailKit.StatusItems,System.Threading.CancellationToken)"/>
  59900. </remarks>
  59901. </member>
  59902. <member name="F:MailKit.StatusItems.None">
  59903. <summary>
  59904. No status requested.
  59905. </summary>
  59906. </member>
  59907. <member name="F:MailKit.StatusItems.Count">
  59908. <summary>
  59909. Updates <see cref="P:MailKit.IMailFolder.Count"/>.
  59910. </summary>
  59911. </member>
  59912. <member name="F:MailKit.StatusItems.Recent">
  59913. <summary>
  59914. Updates <see cref="P:MailKit.IMailFolder.Recent"/>.
  59915. </summary>
  59916. </member>
  59917. <member name="F:MailKit.StatusItems.UidNext">
  59918. <summary>
  59919. Updates <see cref="P:MailKit.IMailFolder.UidNext"/>.
  59920. </summary>
  59921. </member>
  59922. <member name="F:MailKit.StatusItems.UidValidity">
  59923. <summary>
  59924. Updates <see cref="P:MailKit.IMailFolder.UidValidity"/>.
  59925. </summary>
  59926. </member>
  59927. <member name="F:MailKit.StatusItems.Unread">
  59928. <summary>
  59929. Updates <see cref="P:MailKit.IMailFolder.Unread"/>.
  59930. </summary>
  59931. </member>
  59932. <member name="F:MailKit.StatusItems.HighestModSeq">
  59933. <summary>
  59934. Updates <see cref="P:MailKit.IMailFolder.HighestModSeq"/>.
  59935. </summary>
  59936. </member>
  59937. <member name="F:MailKit.StatusItems.AppendLimit">
  59938. <summary>
  59939. Updates <see cref="P:MailKit.IMailFolder.AppendLimit"/>.
  59940. </summary>
  59941. </member>
  59942. <member name="F:MailKit.StatusItems.Size">
  59943. <summary>
  59944. Updates <see cref="P:MailKit.IMailFolder.Size"/>.
  59945. </summary>
  59946. </member>
  59947. <member name="F:MailKit.StatusItems.MailboxId">
  59948. <summary>
  59949. Updates <see cref="P:MailKit.IMailFolder.Id"/>.
  59950. </summary>
  59951. </member>
  59952. <member name="T:MailKit.ThreadingAlgorithm">
  59953. <summary>
  59954. An enumeration of threading algorithms.
  59955. </summary>
  59956. <remarks>
  59957. A threading algorithm is used to group messages and their
  59958. replies together.
  59959. </remarks>
  59960. </member>
  59961. <member name="F:MailKit.ThreadingAlgorithm.OrderedSubject">
  59962. <summary>
  59963. Thread messages based on their Subject headers.
  59964. </summary>
  59965. </member>
  59966. <member name="F:MailKit.ThreadingAlgorithm.References">
  59967. <summary>
  59968. Threads messages based on their References, In-Reply-To, and Message-Id headers.
  59969. This algorithm is far better than <see cref="F:MailKit.ThreadingAlgorithm.OrderedSubject"/> but is also more
  59970. expensive to calculate.
  59971. </summary>
  59972. </member>
  59973. <member name="T:MailKit.UniqueId">
  59974. <summary>
  59975. A unique identifier.
  59976. </summary>
  59977. <remarks>
  59978. Represents a unique identifier for messages in a <see cref="T:MailKit.IMailFolder"/>.
  59979. </remarks>
  59980. </member>
  59981. <member name="F:MailKit.UniqueId.Invalid">
  59982. <summary>
  59983. The invalid <see cref="T:MailKit.UniqueId"/> value.
  59984. </summary>
  59985. <remarks>
  59986. The invalid <see cref="T:MailKit.UniqueId"/> value.
  59987. </remarks>
  59988. </member>
  59989. <member name="F:MailKit.UniqueId.MinValue">
  59990. <summary>
  59991. The minimum <see cref="T:MailKit.UniqueId"/> value.
  59992. </summary>
  59993. <remarks>
  59994. The minimum <see cref="T:MailKit.UniqueId"/> value.
  59995. </remarks>
  59996. </member>
  59997. <member name="F:MailKit.UniqueId.MaxValue">
  59998. <summary>
  59999. The maximum <see cref="T:MailKit.UniqueId"/> value.
  60000. </summary>
  60001. <remarks>
  60002. The maximum <see cref="T:MailKit.UniqueId"/> value.
  60003. </remarks>
  60004. </member>
  60005. <member name="M:MailKit.UniqueId.#ctor(System.UInt32,System.UInt32)">
  60006. <summary>
  60007. Initializes a new instance of the <see cref="T:MailKit.UniqueId"/> struct.
  60008. </summary>
  60009. <remarks>
  60010. Creates a new <see cref="T:MailKit.UniqueId"/> with the specified validity and value.
  60011. </remarks>
  60012. <param name="validity">The uid validity.</param>
  60013. <param name="id">The unique identifier.</param>
  60014. <exception cref="T:System.ArgumentOutOfRangeException">
  60015. <paramref name="id"/> is <c>0</c>.
  60016. </exception>
  60017. </member>
  60018. <member name="M:MailKit.UniqueId.#ctor(System.UInt32)">
  60019. <summary>
  60020. Initializes a new instance of the <see cref="T:MailKit.UniqueId"/> struct.
  60021. </summary>
  60022. <remarks>
  60023. Creates a new <see cref="T:MailKit.UniqueId"/> with the specified value.
  60024. </remarks>
  60025. <param name="id">The unique identifier.</param>
  60026. <exception cref="T:System.ArgumentOutOfRangeException">
  60027. <paramref name="id"/> is <c>0</c>.
  60028. </exception>
  60029. </member>
  60030. <member name="P:MailKit.UniqueId.Id">
  60031. <summary>
  60032. Gets the identifier.
  60033. </summary>
  60034. <remarks>
  60035. The identifier.
  60036. </remarks>
  60037. <value>The identifier.</value>
  60038. </member>
  60039. <member name="P:MailKit.UniqueId.Validity">
  60040. <summary>
  60041. Gets the validity, if non-zero.
  60042. </summary>
  60043. <remarks>
  60044. Gets the UidValidity of the containing folder.
  60045. </remarks>
  60046. <value>The UidValidity of the containing folder.</value>
  60047. </member>
  60048. <member name="P:MailKit.UniqueId.IsValid">
  60049. <summary>
  60050. Gets whether or not the unique identifier is valid.
  60051. </summary>
  60052. <remarks>
  60053. Gets whether or not the unique identifier is valid.
  60054. </remarks>
  60055. <value><c>true</c> if the unique identifier is valid; otherwise, <c>false</c>.</value>
  60056. </member>
  60057. <member name="M:MailKit.UniqueId.CompareTo(MailKit.UniqueId)">
  60058. <summary>
  60059. Compares two <see cref="T:MailKit.UniqueId"/> objects.
  60060. </summary>
  60061. <remarks>
  60062. Compares two <see cref="T:MailKit.UniqueId"/> objects.
  60063. </remarks>
  60064. <returns>
  60065. A value less than <c>0</c> if this <see cref="T:MailKit.UniqueId"/> is less than <paramref name="other"/>,
  60066. a value of <c>0</c> if this <see cref="T:MailKit.UniqueId"/> is equal to <paramref name="other"/>, or
  60067. a value greater than <c>0</c> if this <see cref="T:MailKit.UniqueId"/> is greater than <paramref name="other"/>.
  60068. </returns>
  60069. <param name="other">The other unique identifier.</param>
  60070. </member>
  60071. <member name="M:MailKit.UniqueId.Equals(MailKit.UniqueId)">
  60072. <summary>
  60073. Determines whether the specified <see cref="T:MailKit.UniqueId"/> is equal to the current <see cref="T:MailKit.UniqueId"/>.
  60074. </summary>
  60075. <remarks>
  60076. Determines whether the specified <see cref="T:MailKit.UniqueId"/> is equal to the current <see cref="T:MailKit.UniqueId"/>.
  60077. </remarks>
  60078. <param name="other">The <see cref="T:MailKit.UniqueId"/> to compare with the current <see cref="T:MailKit.UniqueId"/>.</param>
  60079. <returns><c>true</c> if the specified <see cref="T:MailKit.UniqueId"/> is equal to the current
  60080. <see cref="T:MailKit.UniqueId"/>; otherwise, <c>false</c>.</returns>
  60081. </member>
  60082. <member name="M:MailKit.UniqueId.op_Equality(MailKit.UniqueId,MailKit.UniqueId)">
  60083. <summary>
  60084. Determines whether two unique identifiers are equal.
  60085. </summary>
  60086. <remarks>
  60087. Determines whether two unique identifiers are equal.
  60088. </remarks>
  60089. <returns><c>true</c> if <paramref name="uid1"/> and <paramref name="uid2"/> are equal; otherwise, <c>false</c>.</returns>
  60090. <param name="uid1">The first unique id to compare.</param>
  60091. <param name="uid2">The second unique id to compare.</param>
  60092. </member>
  60093. <member name="M:MailKit.UniqueId.op_GreaterThan(MailKit.UniqueId,MailKit.UniqueId)">
  60094. <summary>
  60095. Determines whether one unique identifier is greater than another unique identifier.
  60096. </summary>
  60097. <remarks>
  60098. Determines whether one unique identifier is greater than another unique identifier.
  60099. </remarks>
  60100. <returns><c>true</c> if <paramref name="uid1"/> is greater than <paramref name="uid2"/>; otherwise, <c>false</c>.</returns>
  60101. <param name="uid1">The first unique id to compare.</param>
  60102. <param name="uid2">The second unique id to compare.</param>
  60103. </member>
  60104. <member name="M:MailKit.UniqueId.op_GreaterThanOrEqual(MailKit.UniqueId,MailKit.UniqueId)">
  60105. <summary>
  60106. Determines whether one unique identifier is greater than or equal to another unique identifier.
  60107. </summary>
  60108. <remarks>
  60109. Determines whether one unique identifier is greater than or equal to another unique identifier.
  60110. </remarks>
  60111. <returns><c>true</c> if <paramref name="uid1"/> is greater than or equal to <paramref name="uid2"/>; otherwise, <c>false</c>.</returns>
  60112. <param name="uid1">The first unique id to compare.</param>
  60113. <param name="uid2">The second unique id to compare.</param>
  60114. </member>
  60115. <member name="M:MailKit.UniqueId.op_Inequality(MailKit.UniqueId,MailKit.UniqueId)">
  60116. <summary>
  60117. Determines whether two unique identifiers are not equal.
  60118. </summary>
  60119. <remarks>
  60120. Determines whether two unique identifiers are not equal.
  60121. </remarks>
  60122. <returns><c>true</c> if <paramref name="uid1"/> and <paramref name="uid2"/> are not equal; otherwise, <c>false</c>.</returns>
  60123. <param name="uid1">The first unique id to compare.</param>
  60124. <param name="uid2">The second unique id to compare.</param>
  60125. </member>
  60126. <member name="M:MailKit.UniqueId.op_LessThan(MailKit.UniqueId,MailKit.UniqueId)">
  60127. <summary>
  60128. Determines whether one unique identifier is less than another unique identifier.
  60129. </summary>
  60130. <remarks>
  60131. Determines whether one unique identifier is less than another unique identifier.
  60132. </remarks>
  60133. <returns><c>true</c> if <paramref name="uid1"/> is less than <paramref name="uid2"/>; otherwise, <c>false</c>.</returns>
  60134. <param name="uid1">The first unique id to compare.</param>
  60135. <param name="uid2">The second unique id to compare.</param>
  60136. </member>
  60137. <member name="M:MailKit.UniqueId.op_LessThanOrEqual(MailKit.UniqueId,MailKit.UniqueId)">
  60138. <summary>
  60139. Determines whether one unique identifier is less than or equal to another unique identifier.
  60140. </summary>
  60141. <remarks>
  60142. Determines whether one unique identifier is less than or equal to another unique identifier.
  60143. </remarks>
  60144. <returns><c>true</c> if <paramref name="uid1"/> is less than or equal to <paramref name="uid2"/>; otherwise, <c>false</c>.</returns>
  60145. <param name="uid1">The first unique id to compare.</param>
  60146. <param name="uid2">The second unique id to compare.</param>
  60147. </member>
  60148. <member name="M:MailKit.UniqueId.Equals(System.Object)">
  60149. <summary>
  60150. Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:MailKit.UniqueId"/>.
  60151. </summary>
  60152. <remarks>
  60153. Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:MailKit.UniqueId"/>.
  60154. </remarks>
  60155. <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:MailKit.UniqueId"/>.</param>
  60156. <returns><c>true</c> if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:MailKit.UniqueId"/>;
  60157. otherwise, <c>false</c>.</returns>
  60158. </member>
  60159. <member name="M:MailKit.UniqueId.GetHashCode">
  60160. <summary>
  60161. Serves as a hash function for a <see cref="T:MailKit.UniqueId"/> object.
  60162. </summary>
  60163. <remarks>
  60164. Serves as a hash function for a <see cref="T:MailKit.UniqueId"/> object.
  60165. </remarks>
  60166. <returns>A hash code for this instance that is suitable for use in hashing algorithms and data structures such as a hash table.</returns>
  60167. </member>
  60168. <member name="M:MailKit.UniqueId.ToString">
  60169. <summary>
  60170. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.UniqueId"/>.
  60171. </summary>
  60172. <remarks>
  60173. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.UniqueId"/>.
  60174. </remarks>
  60175. <returns>A <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.UniqueId"/>.</returns>
  60176. </member>
  60177. <member name="M:MailKit.UniqueId.TryParse(System.String,System.Int32@,System.UInt32@)">
  60178. <summary>
  60179. Attempt to parse a unique identifier.
  60180. </summary>
  60181. <remarks>
  60182. Attempts to parse a unique identifier.
  60183. </remarks>
  60184. <returns><c>true</c> if the unique identifier was successfully parsed; otherwise, <c>false.</c>.</returns>
  60185. <param name="token">The token to parse.</param>
  60186. <param name="index">The index to start parsing.</param>
  60187. <param name="uid">The unique identifier.</param>
  60188. </member>
  60189. <member name="M:MailKit.UniqueId.TryParse(System.String,System.UInt32,MailKit.UniqueId@)">
  60190. <summary>
  60191. Attempt to parse a unique identifier.
  60192. </summary>
  60193. <remarks>
  60194. Attempts to parse a unique identifier.
  60195. </remarks>
  60196. <returns><c>true</c> if the unique identifier was successfully parsed; otherwise, <c>false.</c>.</returns>
  60197. <param name="token">The token to parse.</param>
  60198. <param name="validity">The UIDVALIDITY value.</param>
  60199. <param name="uid">The unique identifier.</param>
  60200. <exception cref="T:System.ArgumentNullException">
  60201. <paramref name="token"/> is <c>null</c>.
  60202. </exception>
  60203. </member>
  60204. <member name="M:MailKit.UniqueId.TryParse(System.String,MailKit.UniqueId@)">
  60205. <summary>
  60206. Attempt to parse a unique identifier.
  60207. </summary>
  60208. <remarks>
  60209. Attempts to parse a unique identifier.
  60210. </remarks>
  60211. <returns><c>true</c> if the unique identifier was successfully parsed; otherwise, <c>false.</c>.</returns>
  60212. <param name="token">The token to parse.</param>
  60213. <param name="uid">The unique identifier.</param>
  60214. <exception cref="T:System.ArgumentNullException">
  60215. <paramref name="token"/> is <c>null</c>.
  60216. </exception>
  60217. </member>
  60218. <member name="M:MailKit.UniqueId.Parse(System.String,System.UInt32)">
  60219. <summary>
  60220. Parse a unique identifier.
  60221. </summary>
  60222. <remarks>
  60223. Parses a unique identifier.
  60224. </remarks>
  60225. <returns>The unique identifier.</returns>
  60226. <param name="token">A string containing the unique identifier.</param>
  60227. <param name="validity">The UIDVALIDITY.</param>
  60228. <exception cref="T:System.ArgumentNullException">
  60229. <paramref name="token"/> is <c>null</c>.
  60230. </exception>
  60231. <exception cref="T:System.FormatException">
  60232. <paramref name="token"/> is not in the correct format.
  60233. </exception>
  60234. <exception cref="T:System.OverflowException">
  60235. The unique identifier is greater than <see cref="F:MailKit.UniqueId.MaxValue"/>.
  60236. </exception>
  60237. </member>
  60238. <member name="M:MailKit.UniqueId.Parse(System.String)">
  60239. <summary>
  60240. Parse a unique identifier.
  60241. </summary>
  60242. <remarks>
  60243. Parses a unique identifier.
  60244. </remarks>
  60245. <returns>The unique identifier.</returns>
  60246. <param name="token">A string containing the unique identifier.</param>
  60247. <exception cref="T:System.ArgumentNullException">
  60248. <paramref name="token"/> is <c>null</c>.
  60249. </exception>
  60250. <exception cref="T:System.FormatException">
  60251. <paramref name="token"/> is not in the correct format.
  60252. </exception>
  60253. <exception cref="T:System.OverflowException">
  60254. The unique identifier is greater than <see cref="F:MailKit.UniqueId.MaxValue"/>.
  60255. </exception>
  60256. </member>
  60257. <member name="T:MailKit.UniqueIdMap">
  60258. <summary>
  60259. A mapping of unique identifiers.
  60260. </summary>
  60261. <remarks>
  60262. <para>A <see cref="T:MailKit.UniqueIdMap"/> can be used to discover the mapping of one set of unique identifiers
  60263. to another.</para>
  60264. <para>For example, when copying or moving messages from one folder to another, it is often desirable
  60265. to know what the unique identifiers are for each of the messages in the destination folder.</para>
  60266. </remarks>
  60267. </member>
  60268. <member name="F:MailKit.UniqueIdMap.Empty">
  60269. <summary>
  60270. Any empty mapping of unique identifiers.
  60271. </summary>
  60272. <remarks>
  60273. Any empty mapping of unique identifiers.
  60274. </remarks>
  60275. </member>
  60276. <member name="M:MailKit.UniqueIdMap.#ctor(System.Collections.Generic.IList{MailKit.UniqueId},System.Collections.Generic.IList{MailKit.UniqueId})">
  60277. <summary>
  60278. Initializes a new instance of the <see cref="T:MailKit.UniqueIdMap"/> class.
  60279. </summary>
  60280. <remarks>
  60281. Creates a new <see cref="T:MailKit.UniqueIdMap"/>.
  60282. </remarks>
  60283. <param name="source">The unique identifiers used in the source folder.</param>
  60284. <param name="destination">The unique identifiers used in the destination folder.</param>
  60285. <exception cref="T:System.ArgumentNullException">
  60286. <para><paramref name="source"/> is <c>null</c>.</para>
  60287. <para>-or-</para>
  60288. <para><paramref name="destination"/> is <c>null</c>.</para>
  60289. </exception>
  60290. </member>
  60291. <member name="P:MailKit.UniqueIdMap.Source">
  60292. <summary>
  60293. Gets the list of unique identifiers used in the source folder.
  60294. </summary>
  60295. <remarks>
  60296. Gets the list of unique identifiers used in the source folder.
  60297. </remarks>
  60298. <value>The unique identifiers used in the source folder.</value>
  60299. </member>
  60300. <member name="P:MailKit.UniqueIdMap.Destination">
  60301. <summary>
  60302. Gets the list of unique identifiers used in the destination folder.
  60303. </summary>
  60304. <remarks>
  60305. Gets the list of unique identifiers used in the destination folder.
  60306. </remarks>
  60307. <value>The unique identifiers used in the destination folder.</value>
  60308. </member>
  60309. <member name="P:MailKit.UniqueIdMap.Count">
  60310. <summary>
  60311. Gets the number of unique identifiers that have been remapped.
  60312. </summary>
  60313. <remarks>
  60314. Gets the number of unique identifiers that have been remapped.
  60315. </remarks>
  60316. <value>The count.</value>
  60317. </member>
  60318. <member name="P:MailKit.UniqueIdMap.Keys">
  60319. <summary>
  60320. Gets the keys.
  60321. </summary>
  60322. <remarks>
  60323. Gets the keys.
  60324. </remarks>
  60325. <value>The keys.</value>
  60326. </member>
  60327. <member name="P:MailKit.UniqueIdMap.Values">
  60328. <summary>
  60329. Gets the values.
  60330. </summary>
  60331. <remarks>
  60332. Gets the values.
  60333. </remarks>
  60334. <value>The values.</value>
  60335. </member>
  60336. <member name="M:MailKit.UniqueIdMap.ContainsKey(MailKit.UniqueId)">
  60337. <summary>
  60338. Checks if the specified unique identifier has been remapped.
  60339. </summary>
  60340. <remarks>
  60341. Checks if the specified unique identifier has been remapped.
  60342. </remarks>
  60343. <returns><c>true</c> if the unique identifier has been remapped; otherwise, <c>false</c>.</returns>
  60344. <param name="key">The unique identifier.</param>
  60345. </member>
  60346. <member name="M:MailKit.UniqueIdMap.TryGetValue(MailKit.UniqueId,MailKit.UniqueId@)">
  60347. <summary>
  60348. Tries to get the remapped unique identifier.
  60349. </summary>
  60350. <remarks>
  60351. Attempts to get the remapped unique identifier.
  60352. </remarks>
  60353. <returns><c>true</c> on success; otherwise, <c>false</c>.</returns>
  60354. <param name="key">The unique identifier of the message in the source folder.</param>
  60355. <param name="value">The unique identifier of the message in the destination folder.</param>
  60356. </member>
  60357. <member name="P:MailKit.UniqueIdMap.Item(MailKit.UniqueId)">
  60358. <summary>
  60359. Gets the remapped unique identifier.
  60360. </summary>
  60361. <remarks>
  60362. Gets the remapped unique identifier.
  60363. </remarks>
  60364. <param name="index">The unique identifier of the message in the source folder.</param>
  60365. <exception cref="T:System.ArgumentOutOfRangeException">
  60366. <paramref name="index"/> is out of range.
  60367. </exception>
  60368. </member>
  60369. <member name="M:MailKit.UniqueIdMap.GetEnumerator">
  60370. <summary>
  60371. Gets the enumerator for the remapped unique identifiers.
  60372. </summary>
  60373. <remarks>
  60374. Gets the enumerator for the remapped unique identifiers.
  60375. </remarks>
  60376. <returns>The enumerator.</returns>
  60377. </member>
  60378. <member name="M:MailKit.UniqueIdMap.System#Collections#IEnumerable#GetEnumerator">
  60379. <summary>
  60380. Gets the enumerator for the remapped unique identifiers.
  60381. </summary>
  60382. <remarks>
  60383. Gets the enumerator for the remapped unique identifiers.
  60384. </remarks>
  60385. <returns>The enumerator.</returns>
  60386. </member>
  60387. <member name="T:MailKit.UniqueIdRange">
  60388. <summary>
  60389. A range of <see cref="T:MailKit.UniqueId"/> items.
  60390. </summary>
  60391. <remarks>
  60392. When dealing with a large range, it is more efficient to use a
  60393. <see cref="T:MailKit.UniqueIdRange"/> than a typical
  60394. IList&lt;<see cref="T:MailKit.UniqueId"/>&gt;.
  60395. </remarks>
  60396. </member>
  60397. <member name="F:MailKit.UniqueIdRange.All">
  60398. <summary>
  60399. A <see cref="T:MailKit.UniqueIdRange"/> that encompases all messages in the folder.
  60400. </summary>
  60401. <remarks>
  60402. Represents the range of messages from <see cref="F:MailKit.UniqueId.MinValue"/> to
  60403. <see cref="F:MailKit.UniqueId.MaxValue"/>.
  60404. </remarks>
  60405. </member>
  60406. <member name="M:MailKit.UniqueIdRange.#ctor">
  60407. <summary>
  60408. Initializes a new instance of the <see cref="T:MailKit.UniqueIdRange"/> class.
  60409. </summary>
  60410. <remarks>
  60411. Creates a new (invalid) range of unique identifiers.
  60412. </remarks>
  60413. </member>
  60414. <member name="M:MailKit.UniqueIdRange.#ctor(System.UInt32,System.UInt32,System.UInt32)">
  60415. <summary>
  60416. Initializes a new instance of the <see cref="T:MailKit.UniqueIdRange"/> class.
  60417. </summary>
  60418. <remarks>
  60419. Creates a new range of unique identifiers.
  60420. </remarks>
  60421. <param name="validity">The uid validity.</param>
  60422. <param name="start">The first unique identifier in the range.</param>
  60423. <param name="end">The last unique identifier in the range.</param>
  60424. </member>
  60425. <member name="M:MailKit.UniqueIdRange.#ctor(MailKit.UniqueId,MailKit.UniqueId)">
  60426. <summary>
  60427. Initializes a new instance of the <see cref="T:MailKit.UniqueIdRange"/> class.
  60428. </summary>
  60429. <remarks>
  60430. Creates a new range of unique identifiers.
  60431. </remarks>
  60432. <param name="start">The first <see cref="T:MailKit.UniqueId"/> in the range.</param>
  60433. <param name="end">The last <see cref="T:MailKit.UniqueId"/> in the range.</param>
  60434. <exception cref="T:System.ArgumentOutOfRangeException">
  60435. <para><paramref name="start"/> is invalid.</para>
  60436. <para>-or-</para>
  60437. <para><paramref name="end"/> is invalid.</para>
  60438. </exception>
  60439. </member>
  60440. <member name="P:MailKit.UniqueIdRange.Validity">
  60441. <summary>
  60442. Gets the validity, if non-zero.
  60443. </summary>
  60444. <remarks>
  60445. Gets the UidValidity of the containing folder.
  60446. </remarks>
  60447. <value>The UidValidity of the containing folder.</value>
  60448. </member>
  60449. <member name="P:MailKit.UniqueIdRange.Min">
  60450. <summary>
  60451. Gets the minimum unique identifier in the range.
  60452. </summary>
  60453. <remarks>
  60454. Gets the minimum unique identifier in the range.
  60455. </remarks>
  60456. <value>The minimum unique identifier.</value>
  60457. </member>
  60458. <member name="P:MailKit.UniqueIdRange.Max">
  60459. <summary>
  60460. Gets the maximum unique identifier in the range.
  60461. </summary>
  60462. <remarks>
  60463. Gets the maximum unique identifier in the range.
  60464. </remarks>
  60465. <value>The maximum unique identifier.</value>
  60466. </member>
  60467. <member name="P:MailKit.UniqueIdRange.Start">
  60468. <summary>
  60469. Get the start of the unique identifier range.
  60470. </summary>
  60471. <remarks>
  60472. Gets the start of the unique identifier range.
  60473. </remarks>
  60474. <value>The start of the range.</value>
  60475. </member>
  60476. <member name="P:MailKit.UniqueIdRange.End">
  60477. <summary>
  60478. Get the end of the unique identifier range.
  60479. </summary>
  60480. <remarks>
  60481. Gets the end of the unique identifier range.
  60482. </remarks>
  60483. <value>The end of the range.</value>
  60484. </member>
  60485. <member name="P:MailKit.UniqueIdRange.Count">
  60486. <summary>
  60487. Get the number of unique identifiers in the range.
  60488. </summary>
  60489. <remarks>
  60490. Gets the number of unique identifiers in the range.
  60491. </remarks>
  60492. <value>The count.</value>
  60493. </member>
  60494. <member name="P:MailKit.UniqueIdRange.IsReadOnly">
  60495. <summary>
  60496. Get whether or not the range is read only.
  60497. </summary>
  60498. <remarks>
  60499. A <see cref="T:MailKit.UniqueIdRange"/> is always read-only.
  60500. </remarks>
  60501. <value><c>true</c> if the range is read only; otherwise, <c>false</c>.</value>
  60502. </member>
  60503. <member name="M:MailKit.UniqueIdRange.Add(MailKit.UniqueId)">
  60504. <summary>
  60505. Adds the unique identifier to the range.
  60506. </summary>
  60507. <remarks>
  60508. Since a <see cref="T:MailKit.UniqueIdRange"/> is read-only, unique ids cannot
  60509. be added to the range.
  60510. </remarks>
  60511. <param name="uid">The unique identifier to add.</param>
  60512. <exception cref="T:System.NotSupportedException">
  60513. The list does not support adding items.
  60514. </exception>
  60515. </member>
  60516. <member name="M:MailKit.UniqueIdRange.Clear">
  60517. <summary>
  60518. Clears the list.
  60519. </summary>
  60520. <remarks>
  60521. Since a <see cref="T:MailKit.UniqueIdRange"/> is read-only, the range cannot be cleared.
  60522. </remarks>
  60523. <exception cref="T:System.NotSupportedException">
  60524. The list does not support being cleared.
  60525. </exception>
  60526. </member>
  60527. <member name="M:MailKit.UniqueIdRange.Contains(MailKit.UniqueId)">
  60528. <summary>
  60529. Checks if the range contains the specified unique id.
  60530. </summary>
  60531. <remarks>
  60532. Determines whether or not the range contains the specified unique id.
  60533. </remarks>
  60534. <returns><value>true</value> if the specified unique identifier is in the range; otherwise <value>false</value>.</returns>
  60535. <param name="uid">The unique id.</param>
  60536. </member>
  60537. <member name="M:MailKit.UniqueIdRange.CopyTo(MailKit.UniqueId[],System.Int32)">
  60538. <summary>
  60539. Copies all of the unique ids in the range to the specified array.
  60540. </summary>
  60541. <remarks>
  60542. Copies all of the unique ids within the range into the array,
  60543. starting at the specified array index.
  60544. </remarks>
  60545. <param name="array">The array to copy the unique ids to.</param>
  60546. <param name="arrayIndex">The index into the array.</param>
  60547. <exception cref="T:System.ArgumentNullException">
  60548. <paramref name="array"/> is <c>null</c>.
  60549. </exception>
  60550. <exception cref="T:System.ArgumentOutOfRangeException">
  60551. <paramref name="arrayIndex"/> is out of range.
  60552. </exception>
  60553. </member>
  60554. <member name="M:MailKit.UniqueIdRange.Remove(MailKit.UniqueId)">
  60555. <summary>
  60556. Removes the unique identifier from the range.
  60557. </summary>
  60558. <remarks>
  60559. Since a <see cref="T:MailKit.UniqueIdRange"/> is read-only, unique ids cannot be removed.
  60560. </remarks>
  60561. <returns><value>true</value> if the unique identifier was removed; otherwise <value>false</value>.</returns>
  60562. <param name="uid">The unique identifier to remove.</param>
  60563. <exception cref="T:System.NotSupportedException">
  60564. The list does not support removing items.
  60565. </exception>
  60566. </member>
  60567. <member name="M:MailKit.UniqueIdRange.IndexOf(MailKit.UniqueId)">
  60568. <summary>
  60569. Gets the index of the specified unique id, if it exists.
  60570. </summary>
  60571. <remarks>
  60572. Finds the index of the specified unique id, if it exists.
  60573. </remarks>
  60574. <returns>The index of the specified unique id; otherwise <value>-1</value>.</returns>
  60575. <param name="uid">The unique id.</param>
  60576. </member>
  60577. <member name="M:MailKit.UniqueIdRange.Insert(System.Int32,MailKit.UniqueId)">
  60578. <summary>
  60579. Inserts the specified unique identifier at the given index.
  60580. </summary>
  60581. <remarks>
  60582. Inserts the unique identifier at the specified index in the range.
  60583. </remarks>
  60584. <param name="index">The index to insert the unique id.</param>
  60585. <param name="uid">The unique id.</param>
  60586. <exception cref="T:System.NotSupportedException">
  60587. The list does not support inserting items.
  60588. </exception>
  60589. </member>
  60590. <member name="M:MailKit.UniqueIdRange.RemoveAt(System.Int32)">
  60591. <summary>
  60592. Removes the unique identifier at the specified index.
  60593. </summary>
  60594. <remarks>
  60595. Removes the unique identifier at the specified index.
  60596. </remarks>
  60597. <param name="index">The index.</param>
  60598. <exception cref="T:System.NotSupportedException">
  60599. The list does not support removing items.
  60600. </exception>
  60601. </member>
  60602. <member name="P:MailKit.UniqueIdRange.Item(System.Int32)">
  60603. <summary>
  60604. Gets or sets the unique identifier at the specified index.
  60605. </summary>
  60606. <remarks>
  60607. Gets or sets the unique identifier at the specified index.
  60608. </remarks>
  60609. <value>The unique identifier at the specified index.</value>
  60610. <param name="index">The index.</param>
  60611. <exception cref="T:System.ArgumentOutOfRangeException">
  60612. <paramref name="index"/> is out of range.
  60613. </exception>
  60614. <exception cref="T:System.NotSupportedException">
  60615. The list does not support setting items.
  60616. </exception>
  60617. </member>
  60618. <member name="M:MailKit.UniqueIdRange.GetEnumerator">
  60619. <summary>
  60620. Gets an enumerator for the range of unique ids.
  60621. </summary>
  60622. <remarks>
  60623. Gets an enumerator for the range of unique ids.
  60624. </remarks>
  60625. <returns>The enumerator.</returns>
  60626. </member>
  60627. <member name="M:MailKit.UniqueIdRange.System#Collections#IEnumerable#GetEnumerator">
  60628. <summary>
  60629. Gets an enumerator for the range of unique ids.
  60630. </summary>
  60631. <remarks>
  60632. Gets an enumerator for the range of unique ids.
  60633. </remarks>
  60634. <returns>The enumerator.</returns>
  60635. </member>
  60636. <member name="M:MailKit.UniqueIdRange.ToString">
  60637. <summary>
  60638. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.UniqueIdRange"/>.
  60639. </summary>
  60640. <remarks>
  60641. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.UniqueIdRange"/>.
  60642. </remarks>
  60643. <returns>A <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.UniqueIdRange"/>.</returns>
  60644. </member>
  60645. <member name="M:MailKit.UniqueIdRange.TryParse(System.String,System.UInt32,MailKit.UniqueIdRange@)">
  60646. <summary>
  60647. Attempt to parse a unique identifier range.
  60648. </summary>
  60649. <remarks>
  60650. Attempts to parse a unique identifier range.
  60651. </remarks>
  60652. <returns><c>true</c> if the unique identifier range was successfully parsed; otherwise, <c>false.</c>.</returns>
  60653. <param name="token">The token to parse.</param>
  60654. <param name="validity">The UIDVALIDITY value.</param>
  60655. <param name="range">The unique identifier range.</param>
  60656. <exception cref="T:System.ArgumentNullException">
  60657. <paramref name="token"/> is <c>null</c>.
  60658. </exception>
  60659. </member>
  60660. <member name="M:MailKit.UniqueIdRange.TryParse(System.String,MailKit.UniqueIdRange@)">
  60661. <summary>
  60662. Attempt to parse a unique identifier range.
  60663. </summary>
  60664. <remarks>
  60665. Attempts to parse a unique identifier range.
  60666. </remarks>
  60667. <returns><c>true</c> if the unique identifier range was successfully parsed; otherwise, <c>false.</c>.</returns>
  60668. <param name="token">The token to parse.</param>
  60669. <param name="range">The unique identifier range.</param>
  60670. <exception cref="T:System.ArgumentNullException">
  60671. <paramref name="token"/> is <c>null</c>.
  60672. </exception>
  60673. </member>
  60674. <member name="T:MailKit.UniqueIdSet">
  60675. <summary>
  60676. A set of unique identifiers.
  60677. </summary>
  60678. <remarks>
  60679. When dealing with a large number of unique identifiers, it may be more efficient to use a
  60680. <see cref="T:MailKit.UniqueIdSet"/> than a typical IList&lt;<see cref="T:MailKit.UniqueId"/>&gt;.
  60681. </remarks>
  60682. </member>
  60683. <member name="M:MailKit.UniqueIdSet.#ctor(System.UInt32,MailKit.Search.SortOrder)">
  60684. <summary>
  60685. Initializes a new instance of the <see cref="T:MailKit.UniqueIdSet"/> class.
  60686. </summary>
  60687. <remarks>
  60688. Creates a new unique identifier set.
  60689. </remarks>
  60690. <param name="validity">The uid validity.</param>
  60691. <param name="order">The sorting order to use for the unique identifiers.</param>
  60692. <exception cref="T:System.ArgumentOutOfRangeException">
  60693. <paramref name="order"/> is invalid.
  60694. </exception>
  60695. </member>
  60696. <member name="M:MailKit.UniqueIdSet.#ctor(MailKit.Search.SortOrder)">
  60697. <summary>
  60698. Initializes a new instance of the <see cref="T:MailKit.UniqueIdSet"/> class.
  60699. </summary>
  60700. <remarks>
  60701. Creates a new unique identifier set.
  60702. </remarks>
  60703. <param name="order">The sorting order to use for the unique identifiers.</param>
  60704. <exception cref="T:System.ArgumentOutOfRangeException">
  60705. <paramref name="order"/> is invalid.
  60706. </exception>
  60707. </member>
  60708. <member name="M:MailKit.UniqueIdSet.#ctor(System.Collections.Generic.IEnumerable{MailKit.UniqueId},MailKit.Search.SortOrder)">
  60709. <summary>
  60710. Initializes a new instance of the <see cref="T:MailKit.UniqueIdSet"/> class.
  60711. </summary>
  60712. <remarks>
  60713. Creates a new set of unique identifier set containing the specified uids.
  60714. </remarks>
  60715. <param name="uids">An initial set of unique ids.</param>
  60716. <param name="order">The sorting order to use for the unique identifiers.</param>
  60717. <exception cref="T:System.ArgumentOutOfRangeException">
  60718. <paramref name="order"/> is invalid.
  60719. </exception>
  60720. </member>
  60721. <member name="P:MailKit.UniqueIdSet.SortOrder">
  60722. <summary>
  60723. Gets the sort order of the unique identifiers.
  60724. </summary>
  60725. <remarks>
  60726. Gets the sort order of the unique identifiers.
  60727. </remarks>
  60728. <value>The sort order.</value>
  60729. </member>
  60730. <member name="P:MailKit.UniqueIdSet.Validity">
  60731. <summary>
  60732. Gets the validity, if non-zero.
  60733. </summary>
  60734. <remarks>
  60735. Gets the UidValidity of the containing folder.
  60736. </remarks>
  60737. <value>The UidValidity of the containing folder.</value>
  60738. </member>
  60739. <member name="P:MailKit.UniqueIdSet.Count">
  60740. <summary>
  60741. Get the number of unique ids in the set.
  60742. </summary>
  60743. <remarks>
  60744. Gets the number of unique ids in the set.
  60745. </remarks>
  60746. <value>The count.</value>
  60747. </member>
  60748. <member name="P:MailKit.UniqueIdSet.IsReadOnly">
  60749. <summary>
  60750. Get whether or not the set is read only.
  60751. </summary>
  60752. <remarks>
  60753. Gets whether or not the set is read-only.
  60754. </remarks>
  60755. <value><c>true</c> if the set is read only; otherwise, <c>false</c>.</value>
  60756. </member>
  60757. <member name="M:MailKit.UniqueIdSet.Add(MailKit.UniqueId)">
  60758. <summary>
  60759. Adds the unique identifier to the set.
  60760. </summary>
  60761. <remarks>
  60762. Adds the unique identifier to the set.
  60763. </remarks>
  60764. <param name="uid">The unique identifier to add.</param>
  60765. <exception cref="T:System.ArgumentException">
  60766. <paramref name="uid"/> is invalid.
  60767. </exception>
  60768. </member>
  60769. <member name="M:MailKit.UniqueIdSet.AddRange(System.Collections.Generic.IEnumerable{MailKit.UniqueId})">
  60770. <summary>
  60771. Adds all of the uids to the set.
  60772. </summary>
  60773. <remarks>
  60774. Adds all of the uids to the set.
  60775. </remarks>
  60776. <param name="uids">The collection of uids.</param>
  60777. </member>
  60778. <member name="M:MailKit.UniqueIdSet.Clear">
  60779. <summary>
  60780. Clears the list.
  60781. </summary>
  60782. <remarks>
  60783. Clears the list.
  60784. </remarks>
  60785. <exception cref="T:System.InvalidOperationException">
  60786. The collection is readonly.
  60787. </exception>
  60788. </member>
  60789. <member name="M:MailKit.UniqueIdSet.Contains(MailKit.UniqueId)">
  60790. <summary>
  60791. Checks if the set contains the specified unique id.
  60792. </summary>
  60793. <remarks>
  60794. Determines whether or not the set contains the specified unique id.
  60795. </remarks>
  60796. <returns><value>true</value> if the specified unique identifier is in the set; otherwise <value>false</value>.</returns>
  60797. <param name="uid">The unique id.</param>
  60798. </member>
  60799. <member name="M:MailKit.UniqueIdSet.CopyTo(MailKit.UniqueId[],System.Int32)">
  60800. <summary>
  60801. Copies all of the unique ids in the set to the specified array.
  60802. </summary>
  60803. <remarks>
  60804. Copies all of the unique ids within the set into the array,
  60805. starting at the specified array index.
  60806. </remarks>
  60807. <param name="array">The array to copy the unique ids to.</param>
  60808. <param name="arrayIndex">The index into the array.</param>
  60809. <exception cref="T:System.ArgumentNullException">
  60810. <paramref name="array"/> is <c>null</c>.
  60811. </exception>
  60812. <exception cref="T:System.ArgumentOutOfRangeException">
  60813. <paramref name="arrayIndex"/> is out of set.
  60814. </exception>
  60815. </member>
  60816. <member name="M:MailKit.UniqueIdSet.Remove(MailKit.UniqueId)">
  60817. <summary>
  60818. Removes the unique identifier from the set.
  60819. </summary>
  60820. <remarks>
  60821. Removes the unique identifier from the set.
  60822. </remarks>
  60823. <returns><value>true</value> if the unique identifier was removed; otherwise <value>false</value>.</returns>
  60824. <param name="uid">The unique identifier to remove.</param>
  60825. </member>
  60826. <member name="M:MailKit.UniqueIdSet.IndexOf(MailKit.UniqueId)">
  60827. <summary>
  60828. Gets the index of the specified unique id, if it exists.
  60829. </summary>
  60830. <remarks>
  60831. Finds the index of the specified unique id, if it exists.
  60832. </remarks>
  60833. <returns>The index of the specified unique id; otherwise <value>-1</value>.</returns>
  60834. <param name="uid">The unique id.</param>
  60835. </member>
  60836. <member name="M:MailKit.UniqueIdSet.Insert(System.Int32,MailKit.UniqueId)">
  60837. <summary>
  60838. Inserts the specified unique identifier at the given index.
  60839. </summary>
  60840. <remarks>
  60841. Inserts the unique identifier at the specified index in the set.
  60842. </remarks>
  60843. <param name="index">The index to insert the unique id.</param>
  60844. <param name="uid">The unique id.</param>
  60845. <exception cref="T:System.NotSupportedException">
  60846. The list does not support inserting items.
  60847. </exception>
  60848. </member>
  60849. <member name="M:MailKit.UniqueIdSet.RemoveAt(System.Int32)">
  60850. <summary>
  60851. Removes the unique identifier at the specified index.
  60852. </summary>
  60853. <remarks>
  60854. Removes the unique identifier at the specified index.
  60855. </remarks>
  60856. <param name="index">The index.</param>
  60857. <exception cref="T:System.ArgumentOutOfRangeException">
  60858. <paramref name="index"/> is out of range.
  60859. </exception>
  60860. </member>
  60861. <member name="P:MailKit.UniqueIdSet.Item(System.Int32)">
  60862. <summary>
  60863. Gets or sets the unique identifier at the specified index.
  60864. </summary>
  60865. <remarks>
  60866. Gets or sets the unique identifier at the specified index.
  60867. </remarks>
  60868. <value>The unique identifier at the specified index.</value>
  60869. <param name="index">The index.</param>
  60870. <exception cref="T:System.ArgumentOutOfRangeException">
  60871. <paramref name="index"/> is out of range.
  60872. </exception>
  60873. <exception cref="T:System.NotSupportedException">
  60874. The list does not support setting items.
  60875. </exception>
  60876. </member>
  60877. <member name="M:MailKit.UniqueIdSet.GetEnumerator">
  60878. <summary>
  60879. Gets an enumerator for the set of unique ids.
  60880. </summary>
  60881. <remarks>
  60882. Gets an enumerator for the set of unique ids.
  60883. </remarks>
  60884. <returns>The enumerator.</returns>
  60885. </member>
  60886. <member name="M:MailKit.UniqueIdSet.System#Collections#IEnumerable#GetEnumerator">
  60887. <summary>
  60888. Gets an enumerator for the set of unique ids.
  60889. </summary>
  60890. <remarks>
  60891. Gets an enumerator for the set of unique ids.
  60892. </remarks>
  60893. <returns>The enumerator.</returns>
  60894. </member>
  60895. <member name="M:MailKit.UniqueIdSet.ToString">
  60896. <summary>
  60897. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.UniqueIdSet"/>.
  60898. </summary>
  60899. <remarks>
  60900. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.UniqueIdSet"/>.
  60901. </remarks>
  60902. <returns>A <see cref="T:System.String"/> that represents the current <see cref="T:MailKit.UniqueIdSet"/>.</returns>
  60903. </member>
  60904. <member name="M:MailKit.UniqueIdSet.ToString(System.Collections.Generic.IList{MailKit.UniqueId})">
  60905. <summary>
  60906. Format a generic list of unique identifiers as a string.
  60907. </summary>
  60908. <remarks>
  60909. Formats a generic list of unique identifiers as a string.
  60910. </remarks>
  60911. <returns>The string representation of the collection of unique identifiers.</returns>
  60912. <param name="uids">The unique identifiers.</param>
  60913. <exception cref="T:System.ArgumentNullException">
  60914. <paramref name="uids"/> is <c>null</c>.
  60915. </exception>
  60916. <exception cref="T:System.ArgumentException">
  60917. One or more of the unique identifiers is invalid (has a value of <c>0</c>).
  60918. </exception>
  60919. </member>
  60920. <member name="M:MailKit.UniqueIdSet.EnumerateSerializedSubsets(System.Int32)">
  60921. <summary>
  60922. Format the set of unique identifiers as multiple strings that fit within the maximum defined character length.
  60923. </summary>
  60924. <remarks>
  60925. Formats the set of unique identifiers as multiple strings that fit within the maximum defined character length.
  60926. </remarks>
  60927. <returns>A list of strings representing the collection of unique identifiers.</returns>
  60928. <param name="maxLength">The maximum length of any returned string of UIDs.</param>
  60929. <exception cref="T:System.ArgumentOutOfRangeException">
  60930. <paramref name="maxLength"/> is negative.
  60931. </exception>
  60932. </member>
  60933. <member name="M:MailKit.UniqueIdSet.EnumerateSerializedSubsets(System.Collections.Generic.IList{MailKit.UniqueId},System.Int32)">
  60934. <summary>
  60935. Format a generic list of unique identifiers as multiple strings that fit within the maximum defined character length.
  60936. </summary>
  60937. <remarks>
  60938. Formats a generic list of unique identifiers as multiple strings that fit within the maximum defined character length.
  60939. </remarks>
  60940. <returns>A list of strings representing the collection of unique identifiers.</returns>
  60941. <param name="uids">The unique identifiers.</param>
  60942. <param name="maxLength">The maximum length of any returned string of UIDs.</param>
  60943. <exception cref="T:System.ArgumentNullException">
  60944. <paramref name="uids"/> is <c>null</c>.
  60945. </exception>
  60946. <exception cref="T:System.ArgumentException">
  60947. One or more of the unique identifiers is invalid (has a value of <c>0</c>).
  60948. </exception>
  60949. <exception cref="T:System.ArgumentOutOfRangeException">
  60950. <paramref name="maxLength"/> is negative.
  60951. </exception>
  60952. </member>
  60953. <member name="M:MailKit.UniqueIdSet.TryParse(System.String,System.UInt32,MailKit.UniqueIdSet@)">
  60954. <summary>
  60955. Attempt to parse the specified token as a set of unique identifiers.
  60956. </summary>
  60957. <remarks>
  60958. Attempts to parse the specified token as a set of unique identifiers.
  60959. </remarks>
  60960. <returns><c>true</c> if the set of unique identifiers were successfully parsed; otherwise, <c>false</c>.</returns>
  60961. <param name="token">The token containing the set of unique identifiers.</param>
  60962. <param name="validity">The UIDVALIDITY value.</param>
  60963. <param name="uids">The set of unique identifiers.</param>
  60964. <exception cref="T:System.ArgumentNullException">
  60965. <paramref name="token"/> is <c>null</c>.
  60966. </exception>
  60967. </member>
  60968. <member name="M:MailKit.UniqueIdSet.TryParse(System.String,MailKit.UniqueIdSet@)">
  60969. <summary>
  60970. Attempt to parse the specified token as a set of unique identifiers.
  60971. </summary>
  60972. <remarks>
  60973. Attempts to parse the specified token as a set of unique identifiers.
  60974. </remarks>
  60975. <returns><c>true</c> if the set of unique identifiers were successfully parsed; otherwise, <c>false</c>.</returns>
  60976. <param name="token">The token containing the set of unique identifiers.</param>
  60977. <param name="uids">The set of unique identifiers.</param>
  60978. <exception cref="T:System.ArgumentNullException">
  60979. <paramref name="token"/> is <c>null</c>.
  60980. </exception>
  60981. </member>
  60982. </members>
  60983. </doc>